Transform Messages

Action Messages

• ALIGN_TO_FLOOR - Translates and rotates the given objects, positioning them as a group such that the three lowest ones are at the environment ground height. If no objects are specified, the currently selected objects are transformed. If the environment has no ground, position the objects at 0. This message is undoable and broadcastable.

  Parameters:

  • target1, ..., targetN (tuple) - The IDs of objects to transform.

• GEOMETRY_PASTE_TRANSFORM - Applies the transformation matrix from the last GEOMETRY_COPY_TRANSFORM message onto the given targets. The amount that each target has moved from its original position (where the target was when it was first imported from file), will be replaced by the pasted transformation matrix. This message is undoable and broadcastable. This message will trigger the following response messages: GEOMETRY_TRANSFORM_CHANGED. This default maximum wait time for this message is 10.

  Parameters:

  • targetIds (tuple) - The nodes whose transformation matrix will be affected.

• GEOMETRY_RESET_TRANSFORM - Resets the transform of the given nodes to their original values (the transform on the node when it was first imported from file). This message is undoable and broadcastable.

  Parameters:

  • targetIds (tuple) - The nodes whose transform will be reset.

• GEOMETRY_SCALE - Scales the geometry This message will trigger the following response messages: GEOMETRY_SCALED. This default maximum wait time for this message is 10.

  Parameters:

  • targetIds (tuple) - The IDs of the objects to scale.

  • factor (float) - The scaling multiplier. Note: Scaling by 0.0 is considered bad input, and ignored.

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

  Parameters:

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

  • transform (tuple) - The 12 float values of an affine transformation matrix. The first three values are the first row of the affine matrix. The next three values are the second row of the matrix, and so on. A typical transformation matrix has 4x4 values, where the first three rows of the matrix represent any rotation and scaling, and the last row represents any translation. An affine matrix represents the same with 4x3 values, and the 4th column is assumed to be (0,0,0,1).

• ROTATE_WORLDSPACE - Rotates the given objects by the rotation angle amount, about the given axis and pivot point. If no objects are specified, then the currently selected objects are rotated. This message is undoable and broadcastable. This message will trigger the following response messages: 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 objects to rotate.

• SCALE_AXIS_WORLDSPACE - Scales the given objects by factors in XYZ with a fixed pivot point and with respect to a given basis. If no objects are specified, the currently selected objects are scaled. This message is undoable and broadcastable.

  Parameters:

  • scaleFactors (tuple) - Scale factor as three values for X, Y and Z. 1 means no change. 0 is disallowed.

  • pivotPoint (tuple) - The fixed point for scaling.

  • axis (tuple) - The axis that form the reference basis.

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

  • target1, ..., targetN (tuple) - The IDs of objects to scale.

• SCALE_WORLDSPACE - Scales the given objects by factors in XYZ with a fixed pivot point. If no objects are specified, the currently selected objects are scaled. This message is undoable and broadcastable. This message will trigger the following response messages: SCALE_WORLDSPACE_DONE. This default maximum wait time for this message is 10.

  Parameters:

  • scaleFactors (tuple) - Scale factor as three values for X, Y and Z. 1 means no change. 0 is disallowed.

  • pivotPoint (tuple) - The fixed point for scaling.

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

  • target1, ..., targetN (tuple) - The IDs of objects to scale.

• TRANSLATE_WORLDSPACE - Translates the given objects by x, y, z (given in worldspace). If no objects are specified, then the currently selected objects are translated. This message is undoable and broadcastable. This message will trigger the following response messages: 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 objects to translate.

Response Messages

• GEOMETRY_SCALED - Indicates the the geometry has been scaled.

  Parameters:

  • targetIds (tuple) - The IDs of objects that were affected.

• GEOMETRY_TRANSFORM_CHANGED - Indicates that node transforms have changed.

  Parameters:

  • targetIds (tuple) - The IDs of nodes whose transforms have changed.

• GEOMETRY_TRANSFORM_COPIED - Indicates that a transformation matrix has been copied from a target into a buffer.

  Parameters:

  • targetId (unicode) - The ID of the single node whose transformation matrix was copied.

• ROTATE_WORLDSPACE_DONE - Indicates which objects were rotated by the ROTATE_WORLDSPACE message.

  Parameters:

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

• SCALE_WORLDSPACE_DONE - Indicates which objects were scaled by the SCALE_WORLDSPACE message.

  Parameters:

  • target1, ..., targetN (tuple) - The IDs of objects that were scaled.

• TRANSLATE_WORLDSPACE_DONE - Indicates which objects were translated by the TRANSLATE_WORLDSPACE message.

  Parameters:

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