Locator Messages

Action Messages

• LOCATOR_HIGHLIGHT - Highlights the named targets and the corresponding model nodes. This message is broadcastable.

  Parameters:

  • target1, ..., targetN (tuple) - The IDs of target objects to highlight. Specifying no IDs will unhighlight any highlighted objects.

• LOCATOR_ROTATE_WORLDSPACE - Rotates the given decal locators by the rotation angle amount, about the given axis and pivot point. If no locator is specified, then the currently selected locators are rotated. This message is undoable and broadcastable. This message will trigger the following response messages: LOCATOR_ROTATE_WORLDSPACE_DONE. This default maximum wait time for this message is 10.

  Parameters:

  • rotationAngle (float) - Amount to rotate in radians.

  • rotationAxis (tuple) - The rotation axis.

  • pivotPoint (tuple) - The pivot point.

  • relative (bool) - True to make the rotation relative, False to make it absolute.

  • target1, ..., targetN (tuple) - The IDs of decal locators to rotate.

• LOCATOR_SELECT - Select a given locators. This message is undoable and broadcastable. This message will trigger the following response messages: LOCATOR_SELECTION_CHANGED. This default maximum wait time for this message is 10.

  Parameters:

  • nodeIds (tuple) - Ids of locators to select

  • mode (unicode) - One of 'Replace', 'Add', 'Subtract' or 'All'.

  • siblings (bool) - If true, the sibling nodes are selected as well.

• LOCATOR_SET_ROOT - Sets a new locator root node. All locator nodes are attached to this root. This message is undoable.

  Parameters:

  • nodeId ('RTFapi.GroupRef) -

• LOCATOR_SET_TRANSFORM - Applies the given transform to the decal locator nodes specified by targetIds. This message is undoable and broadcastable.

  Parameters:

  • targetIds (tuple) - The nodes to be affected.

  • oldTransform (tuple) - Current affine transform matrix.

  • newTransform (tuple) - New affine transform matrix.

• LOCATOR_SHOW_DECAL_GRIPS - Shows the decal grips. This message will trigger the following response messages: LOCATOR_DECAL_GRIPS_SHOWN. This default maximum wait time for this message is 10.

  Parameters:

  • showGrips (bool) - True to display decal grips, False to hide them.

• LOCATOR_TRANSLATE_WORLDSPACE - Translates the given decal locators by x, y, z (given in worldspace). If no objects are specified, then the currently selected locators are translated. This message is undoable and broadcastable. This message will trigger the following response messages: LOCATOR_TRANSLATE_WORLDSPACE_DONE. This default maximum wait time for this message is 10.

  Parameters:

  • x (float) - Amount to translate by in the x direction.

  • y (float) - Amount to translate by in the y direction.

  • z (float) - Amount to translate by in the z direction.

  • relative (bool) - True to translate the targets relatively, False to translate them absolutely.

  • target1, ..., targetN (tuple) - The IDs of the decal locators to translate.

Information Messages

• LOCATOR_VISIBILITY_CHANGED - Indicates that some locators changed their visibility state.

Response Messages

• LOCATOR_DECAL_GRIPS_SHOWN - Indicates the locator decal grips have been shown.

  Parameters:

  • gripsShown (bool) - True to display decal grips, False to hide them.

• LOCATOR_ROTATE_WORLDSPACE_DONE - Indicates which locators were rotated by the LOCATOR_ROTATE_WORLDSPACE message.

  Parameters:

  • target1, ..., targetN (tuple) - The IDs of locators that were rotated.

• LOCATOR_SELECTION_CHANGED - Indicates that some locators changed their selection state.

• LOCATOR_TRANSLATE_WORLDSPACE_DONE - Indicates which locators were translated by the LOCATOR_TRANSLATE_WORLDSPACE message.

  Parameters:

  • target1, ..., targetN (tuple) - The IDs of locators that were translated.