CoCreate OneSpace Designer - Commands Reference Manual

SET_RELATIONS terminate action

SET_RELATIONS sets the Relation Settings.

Syntax


    -->--SET_RELATIONS-+-------------------------<-------------------------+
                       |                                                   |
                       +-(:AUTO)---+->(:CREATE)----------------------------+
                       |           |                                       |
                       |           +->(:BOTH)------------------------------+
                       |           |                                       |
                       |           +->(:OFF)-------------------------------+
                       |                                                   |
                       +-(:FOCUS)--+->(:FACE_3D)---------------------------+
                       |           |                                       |
                       |           +--(:OFF)-------------------------------+
                       |                                                   |
                       |                                                   |
                       +-(:LABEL)--+->(:COLOR)-+->(:BASIC)---+----|rgb|----+
                       |           |           |             |             |
                       |           |           +->(:SOLVED)--+             |
                       |           |           |             |             |
                       |           |           +->(:ERROR)---+             |
                       |           |                                       |
                       |           +--(:SHOW)--+->(:DIS)-----+--+->(:ON)---+
                       |           |           |             |  |          |
                       |           |           +->(:ANG)-----+  +->(:OFF)--+
                       |           |           |             |             |
                       |           |           +->(:PAR)-----+             |
                       |           |           |             |             |
                       |           |           +->(:PRP)-----+             |
                       |           |           |             |             |
                       |           |           +->(:COI)-----+             |
                       |           |           |             |             |
                       |           |           +->(:TAN)-----+             |
                       |           |           |             |             |
                       |           |           +->(:FXD)-----+             |
                       |           |           |             |             |
                       |           |           +->(:RGD)-----+             |
                       |           |           |             |             |
                       |           |           +->(:ALL)-----+             |
                       |           |                                       |
                       |           +--(:FORMAT)+->(:ICON)----+--+->(:ON)---+
                       |           |           |             |  |          |
                       |           |           +->(:NAME)----+  +->(:OFF)--+
                       |           |                                       |
                       |           +--(:FONT)------(:NAME)------|string|---+
                       |           |                                       |
                       |           +--(:METRIC)----(:SIZE)------|length|---+
                       |           |                                       |
                       |           +--(:SCREEN)----(:MODE)-----+->(:WORLD)-+
                       |                                       |           |
                       |                                       +->(:VIEW)--+
                       |                                                   |
                       +-(:ANIMATE)-+-(:DIS)----+->(:N_CYCLES)--|integer|--+
                                    |           |                          |
                                    |           +->(:N_STEPS)---|integer|--+
                                    |           |                          |
                                    |           +->(:STEP)------|length|---+
                                    |                                      |
                                    +-(:ANG)----+->(:N_CYCLES)--|integer|--+
                                    |           |                          |
                                    |           +->(:N_STEPS)---|integer|--+
                                    |           |                          |
                                    |           +->(:STEP)------|angle|----+
                                    |                                      |
                                    +-(:DIR)----+->(:FORWRDS)--------------+
                                                |                          |
                                                +->(:BACKWARDS)------------+

Options

:AUTO - specifies the default setting of the :AUTO_SOLVE option in the CREATE_RELATION action, using the following sub-options:
- :CREATE - :AUTO_SOLVE is set to :YES for Relation creation and :NO for Relation modification.
- :MODIFY - :AUTO_SOLVE is set to :YES on for Relation modification and :NO for Relation creation.
- :BOTH - :AUTO_SOLVE is set to :YES for both Relation creation and Relation modification.
- :OFF - :AUTO_SOLVE is set to :NO for both Relation creation and Relation modification.
:FOCUS - sets the Select mode focus for specifying Reference Elements when creating Relations. The following sub-options are available:
- :FACE_3D - this specifies that only part faces will be selected and other features such as points, lines or edges will be ignored.
- :OFF - all types of elements are selectable.
:LABEL - sets the label global display settings using the following options:
- :COLOR - This allows you to specify the label colors used to indicate the statuses of the Relations. Red, green, and blue values must be as specified as in the OneSpace Designer Color Editor. The following sub-options are used:
  - :BASIC - This specifies the color used for all leader lines and label boxes, unsolved Relation symbols and names.
  - :SOLVED - This specifies the color used for Solved Relation icons and names.
  - :ERROR - This specifies the color used for the icons and names of Relations that have failed to be solved when the Relation Set was last solved, i.e over-constrained, inconsistent, etc.
- :SHOW - This is used to specify the types of Relations for which you want labels displayed. The following sub-options are used to specify the Relation types. Each can be set :ON or :OFF individually:
  - :DIS - Distance.
  - :ANG - Angle.
  - :PAR - Parallel.
  - :PRP - Perpendicular.
  - :COI - Coincident.
  - :TAN - Tangent.
  - :FXD - Fixed.
  - :RGD - Rigid.
  - :ALL - All types of Relation.
- :FORMAT - specifies the format of the labels by setting the following sub-options :ON or :OFF:
  - :ICON - when set to :ON, the Relation type icon is displayed.
  - :NAME - when set to :ON, the Relation name is displayed.
- :FONT :NAME - specifies the font to be used within Relation labels. You can specify any of the fonts available on your system.
- :METRIC :SIZE - specifies the default text size for the labels.
- :SCREEN :MODE - specifies the default label orientation using the following sub-options:
  - :WORLD - The label orientation is as set in the Edit Relations/Orientation menu.
  - :VIEW - The label orientation is always in the plane of the viewport.
:ANIMATE - specifies the animation control settings using the following options:
- :DIS - The following sub-options apply to Distance relations:
  - :N_CYCLES - The number of times that the step sequence should be repeated.
  - :N_STEPS - The number of times the step increment is to be added to the Relation value during animation.
  - :STEP - The step increment that you want to be added to the Animated Distance Relation at each solve.
- :ANG - The following sub-options apply to Angle relations:
  - :N_CYCLES - The number of times that the step sequence should be repeated.
  - :N_STEPS - The number of times the step increment is to be added to the Relation value during animation.
  - :STEP - The step increment that you want to be added to the Animated Angle Relation at each solve.
- :DIR - The following sub-options specify the direction of animation:
  - :FORWRDS - The direction of animation is to be forward, i.e. the step increment is to be added to the Relation value.
  - :BACKWARDS - The direction of the animation is to be backwards, i.e. the step increment is to be subtracted from the Relation value.

When to use

Use this when you want to change the global Relation settings, modify the Relation label global display settings or specify animation settings.

Example

The following parameter sequence causes the labels for Distance and Angle Relations only to be displayed, with only the name, but no icons, and always in the plane of the viewport: