[Contents] [Index] [Books]

CoCreate OneSpace Designer - Commands Reference Manual


Introduction to Using Command Syntax

This introductory section explains how to interpret the syntax diagrams, and the types of actions available. It contains the following topics:

If you are using the on-line Help facility, you can get information on any of the commands supported by PE/OneSpace Designer, by either clicking the [Commands] button at the bottom of this window, or the [Commands] button in the PE/OneSpace Designer Help menu.

Understanding the Actions

OneSpace Designer provides three types of system actions:

  1. Interrupt actions

    can be executed any time during an operation, without disturbing the main operation. The following are examples of Interrupt actions:

    • REDRAW
    • FIT
    • CENTER_VP
    • POSITION_WID

  2. Terminate actions

    end all other active actions, and then terminate when their operation is complete. The following are examples of Terminate actions:

    • ANNOTATION
    • ARC
    • SET_TOOLBOX_MAX_HEIGHT
    • CHANGE_WP_OWNER

  3. Subactions

    are usually invisible to the user, and are called by Interrupt actions and Terminate actions to do common groups of operations.

You can enter commands in either upper or lower case text.

Interpreting the Syntax Diagrams

Syntax diagrams graphically illustrate each action, and the qualifiers which help you carry out sequences of operations. Using OneSpace Designer in this way can dramatically reduce the user interaction needed to do complex or repetitive actions.

Each diagram uses the following elements:

  • Actions are shown in upper case text, enclosed by parentheses, for example, (BODY_CHECK). Do not enter the parentheses, they are only used to indicate a top level command.
  • Options are prefixed by a colon, for example (:ADD). A colon must be entered before each option you use in your command string.
  • Command parameters are in lower case text, enclosed by vertical bars. For example, |select assembly|. Where these appear you must specify the appropriate characters, values, or text string, omitting the vertical bars.

    If you are entering the name of a file, part, assembly, viewport, workplane, or widget, it must be enclosed by double quotes (" "), for example "vport1".

  • Where syntax diagrams reference a subactions, the name of that tool is enclosed by vertical bars, for example, |MEASURE_DIST_SA|, the "See also" section will list the tool referenced, and any other related commands.

    Note
    The name of the subactions MUST NOT be entered. To do so displays an error message.

  • Directional arrows connect each stage of the syntax diagram. In the following example, they show:

    • The correct path to follow.
    • Options available at the current stage.
    • Command parameters you can supply. These parameters are either mandatory or optional, depending on the command you are using, and the point you are at in the syntax diagram.
    • Loop operations.
    • Exit point to the next command, or command options. PE/OneSpace Designer lets you use many combinations of command elements.

                +-----------------<------------------+
                |                                    |
---->(EXTRUDE)--+--(:PART)--|part|----------------->-+---->
                |                                    |
                +--(:WORKPLANE)--|wp|-------------->-+
                |                                    |
                +--(:DISTANCE)---|distance|-------->-+
                |                                    |
                +--(:TO_PART)--|face|-------------->-+
                |                                    |
                +--(:REVERSE_DIR)--------------------+
                |                                    |
                +--(:KEEP_WP)---------------------->-+

  • Lines (- - - -), represent one-way roads along which you are directed by arrows.
  • Command elements separated by a line (- - - -), must have as a minimum, a single white space between them. For example, when using :MATCH_THREE_PTS to position an element, it can be moved from coordinate 50,50 to coordinate 150,150 by entering 50,50 150,150 or 50,50 [Return] 150,150 [Return].
  • Plus symbols show corners, or junctions of two or more lines.

Completing Actions

An action can be either canceled or completed. You cancel an action by interrupting its operation with a Terminate action, or by using the :CANCEL option. The way you complete an action depends on whether it requires a fixed or variable number of inputs.

  • Commands which require a fixed number of inputs, are complete when the last piece of data is entered.

  • Commands which require a variable number of inputs are complete when you enter a conclusive command, such as COMPLETE, OK, DO_IT, or CANCEL.

Many actions give you the opportunity to perform the operation several times before completing the task. An active command allows reentry of certain elements without reentering the complete command string. An example of this is seen when creating polygons and rectangles.

Using the Examples

Throughout the manual, where appropriate, commands are accompanied by simple examples of how the command could be used. For example, to create a single horizontal line you could enter:

LINE :HORIZONTAL 100,72.4 257,72.4

where 100,72.4 and 257,72.4 give the two end point coordinates.

If the command requires you to specify, for example, a part or workplane, this action is enclosed by square brackets, as in:

SET_PART_COLOR [specify a part] :RGB 0.2,0.5,1.0

Usually, there are 3 ways of specifying your item. You can:

  • Use the WP-Browser, P-Browser, or Layout Browser.
  • Use the mouse to position the cursor, and select the item on the screen, or
  • Enter the item name into the user input area, enclosed by double quotes (" ").

You can use any of these methods.


Note
Remember to COMPLETE the action whenever necessary, and to press [Return] at the end of each command string.

[Contents] [Index] [Books]