Manipulator Messages

Action Messages

• MANIPULATOR_CHANGE_ENABLE_STATUS - Enables or disables the manipulator with the given name. This message will trigger the following response messages: MANIPULATOR_ENABLE_STATUS_CHANGED. This default maximum wait time for this message is 20.

  Parameters:

  • manipulatorName (unicode) - The name of the manipulator: 'MoveManipulator', 'PlanarTextureManipulator', 'TriPlanarTextureManipulator', 'CylindricalTextureManipulator','TurntableManipulator', 'ViewCubeManipulator'.

  • enable (bool) - True to enable the manipulator, False to disable it.

• MANIPULATOR_CHANGE_MODE - Changes the mode of a manipulator.

  Parameters:

  • manipulatorName (unicode) - The name of the manipulator whose mode you are changing: 'MoveManipulator', 'PlanarTextureManipulator', 'TriPlanarTextureManipulator', 'CylindricalTextureManipulator'. Note that 'TurntableManipulator' and 'ViewCubeManipulator' have no modes.

  • modeName (unicode) - The name of the mode to give to the manipulator: 'pivot', 'transform', 'texture'. Valid modes for 'MoveManipulator' are 'pivot' and 'transform'. Valid modes for 'PlanarTextureManipulator', 'TriPlanarTextureManipulator' and 'CylindricalTextureManipulator' are 'texture' and 'pivot'.

• MANIPULATOR_FIT_TO_VIEW - Moves the camera so that all the selected objects and the manipulator fit into the viewport. If nothing is selected then it fits the whole scene to the viewport.

  Parameters:

  • createTransition (bool) - True to do the fit to view with the animated transition, False to fit to view instantly.

Information Messages

• MANIPULATOR_MODE_CHANGED - Indicates that the mode of a manipulator has changed.

  Parameters:

  • manipulatorName (unicode) - The name of the manipulator whose mode has changed.

  • modeName (unicode) - The new mode of the manipulator.

• MANIPULATOR_POSITION_CHANGED - Indicates that the position of a manipulator has changed.

  Parameters:

  • manipulatorName (unicode) - The name of the manipulator whose position has changed.

Response Messages

• MANIPULATOR_ENABLE_STATUS_CHANGED - Indicates that the enable status of a manipulator has changed.

  Parameters:

  • manipulatorName (unicode) - The name of the manipulator whose enable status has changed.

  • enableStatus (bool) - The new enable status of the manipulator.