ExposeTm : Helper

ExposeTm - Superclass:Helper; super-superclass:node - classID: #(-2071764533, -1858289533)

This Helper object can be used to extract position and rotation data from any scene nodes to be used as input for scripted controllers, wire controllers etc. It simplifies significantly the creation of custom animation rigs.

Constructor:

exposeTM ...

ExposeTransform ...

Properties:

Display

.size : world units

Get/Set the size of the helper in world units.

.centermarker (Center_Marker) : boolean

When set to true, displays a small X marker at the center of the helper.

.axistripod (Axis_Tripod) : boolean

When set to true, displays a tripod axis indicating the position and orientation of the helper. The axis remains visible when the helper is no longer selected.

.cross : boolean

When set to true, displays an axis-aligned cross.

.box : boolean

When set to true, displays a small box at the center of the helper.

.constantscreensize (Constant_Screen_Size) : boolean

When set to true, keeps the size of the helper constant, regardless of how much you zoom in or out.

.drawontop (Draw_On_Top) : boolean

When set to true, the helper object draws lines with the Z buffer turned off (which usually causes it to appear in front of other objects).

.displayExposedVals (Display_Exposed) : boolean

When set to true, the exposed values will be displayed.

Exposed Nodes

.exposeNode (Expose_Node) : node

Get/Set the node whose Transformations should be exposed.

.localReferenceNode (Local_Reference_Node) : node

Get/Set the local reference node to be used for relative values calculation.

.useParent (Use_Parent_Ref) : boolean

When set to true, the parent node of the .exposeNode will be used as the reference node. If there is no parent node, the World is the parent of the .exposeNode.

When set to false, the explicitly specified .localReferenceNode will be used as the reference node.

Rotation Options

.eulerXOrder (Euler_X_Order) : integer

.eulerYOrder (Euler_Y_Order) : integer

.eulerZOrder (Euler_Z_Order) : integer

.stripNUScale (Strip_Non_Uniform_Scale) : boolean

When set to true, non-uniform scale values will be stripped from the transformation matrix before the values are calculated. When set to false, non-uniform scaling will affect the exposed values.

Local and World Euler Rotation

.localEuler (Local_Euler_Rotation) : point3

Returns the local rotation as Point3 Euler Angles value.

.localEulerX (Local_Euler_X) : angle

Returns the local Euler X rotation value.

.localEulerY (Local_Euler_Y) : angle

Returns the local Euler Y rotation value.

.localEulerZ (Local_Euler_Z) : angle

Returns the local Euler Z rotation value.

.worldEuler (World_Euler_Rotation) : point3

Returns the world rotation as Point3 Euler Angles value.

.worldEulerX (World_Euler_X) : angle

Returns the world Euler X rotation value.

.worldEulerY (World_Euler_Y) : angle

Returns the world Euler Y rotation value.

.worldEulerZ (World_Euler_Z) : angle

Returns the world Euler Z rotation value.

Local and World Position

.localPosition (Local_Position) : point3

Returns the local position as Point3 value.

.localPositionX (Local_Position_X) : world units

Returns the X component of the local position.

.localpositionY (Local_Position_Y) : world units

Returns the Y component of the local position.

.localPositionZ (Local_Position_Z) : world units

Returns the Z component of the local position.

.worldPosition (World_Position) : point3

Returns the world position as Point3 value.

.worldPositionX (World_Position_X) : world units

Returns the X component of the world position.

.worldPositionY (World_Position_Y) : world units

Returns the Y component of the world position.

.worldPositionZ (World_Position_Z) : world units

Returns the Z component of the world position.

Bounding Box

.worldBoundingBoxSize (World_Bounding_Box_Size) : point3

Returns the size of the world-oriented bounding box as a Point3 value.

.worldBoundingBoxWidth (World_Bounding_Box_Width) : float

Returns the X component of the size of the world-oriented bounding box.

.worldBoundingBoxLength (World_Bounding_Box_Length) : float

Returns the Y component of the size of the world-oriented bounding box.

.worldBoundingBoxHeight (World_Bounding_Box_Height) : float

Returns the Z component of the size of the world-oriented bounding box.

Timing

.timeOffset (Time_Offset) : time

Get/Set the time offset value. When the .useTimeOffset property is set to true, the values returned by the ExposeTM Helper will be calculated at a time which is offset from the current time by the .timeOffset value.

.useTimeOffset (Use_Time_Offset) : boolean

Enable/Disable the use of the .timeOffset value.

Distance and Angle

.distance : float

Returns the distance to the Reference node. If the reference node is set to Parent and there is no parent, this effectively returns the distance to the World origin.

.angle : angle

Returns the angle.

See also

Point : Helper

Parameter Wiring