class counterpart of mel function xform
This command can be used query/set any element in a transformation node. It can also be used to query some values that cannot be set directly such as the transformation matrix or the bounding box. It can also set both pivot points to convenient values. All values are specified in transformation coordinates. (attribute-space) In addition, the attributes are applied/returned in the order in which they appear in the flags section. (which corresponds to the order they appear in the transformation matrix as given below) See also:move, rotate, scale In query mode, return type is based on queried flag.
when checkShape is enabled, if the attribute does not exist the transform but does on the shape, then the shape’s attribute will be returned.
Return type: | Attribute |
---|
Set pivot points to the center of the object’s bounding box. (see -p flag)
preserve overall transformation. used to prevent object from “jumping” when changing pivots or rotation order. the default value is true. (used with -sp, -rp, -roo, -cp, -ra)
Derived from mel command maya.cmds.xform
Clear the saved rest position of this transform. Derived from api method maya.OpenMaya.MFnTransform.clearRestPosition
Undo is not currently supported for this method
xform -boundingBox and xform -boundingBoxInvisible
Return type: | BoundingBox |
---|
Returns the bounding box of an object. This includes the bounding boxes of all invisible children which are not included using the boundingBox flag. The values returned are in following order: xmin ymin zmin xmax ymax zmax.
treat values as object-space transformation values (only works for pivots, translations, rotation, rotation axis, matrix, and bounding box flags)
treat values as world-space transformation values (only works for pivots, translations, rotation, rotation axis, matrix, and bounding box flags)
Derived from mel command maya.cmds.xform
Return type: | Vector |
---|
Return type: | Vector |
---|
Determine the current value of the specified limit.
Parameters : |
|
---|---|
Return type: | float |
Derived from api method maya.OpenMaya.MFnTransform.limitValue
Sets/returns the composite transformation matrix. *Note* the matrix is represented by 16 double arguments that are specified in row order.
treat values as object-space transformation values (only works for pivots, translations, rotation, rotation axis, matrix, and bounding box flags)
treat values as world-space transformation values (only works for pivots, translations, rotation, rotation axis, matrix, and bounding box flags)
Derived from mel command maya.cmds.xform
convenience method that changes both the rotate and scale pivots simultaneously. (see -rp -sp flags for more info)
treat values as object-space transformation values (only works for pivots, translations, rotation, rotation axis, matrix, and bounding box flags)
treat values as world-space transformation values (only works for pivots, translations, rotation, rotation axis, matrix, and bounding box flags)
Values for -sp, -rp, -st, -rt, -t, -piv flags are treated as world space distances to move along the local axis. (where the local axis depends on whether the command is operating in local-space or object-space. This flag has no effect for world space.
Derived from mel command maya.cmds.xform
Retrieve the saved rest position of this transform.
Return type: | TransformationMatrix |
---|
Derived from api method maya.OpenMaya.MFnTransform.restPosition
rotation axis orientation (when used with the -p flag the overall rotation is preserved by modifying the rotation to compensate for the axis rotation)
treat values as object-space transformation values (only works for pivots, translations, rotation, rotation axis, matrix, and bounding box flags)
treat values as world-space transformation values (only works for pivots, translations, rotation, rotation axis, matrix, and bounding box flags)
preserve overall transformation. used to prevent object from “jumping” when changing pivots or rotation order. the default value is true. (used with -sp, -rp, -roo, -cp, -ra)
Derived from mel command maya.cmds.xform
Returns the pivot about which the rotation is applied.
Parameters : |
|
---|---|
Return type: | Point |
Derived from api method maya.OpenMaya.MSpace.rotatePivot
Return the rotate pivot translation in linear units. This component is used internally by maya when the user moves the rotate pivot, or when the balance flag is set to true in the MfnTransform::setRotatePivot method. It serves as a compensation that allows existing transformations to be preserved. For the precise mathematics, refer to the transformation matrix details in the description section of MFnTransform .
Parameters : |
|
---|---|
Return type: | Vector |
Derived from api method maya.OpenMaya.MSpace.rotatePivotTranslation
Retrieve the rotation component of this transformation. The rotation is retrieved in MSpace::kTransform space.
Return type: | EulerRotation |
---|
Derived from api method maya.OpenMaya.MFnTransform.getRotation
Returns the rotation order for the transform matrix - the order in which the Euler angles are applied to create the end rotation.
Return type: | TransformationMatrix.RotationOrder |
---|
Derived from api method maya.OpenMaya.MFnTransform.rotationOrder
Retrieve the scaling component of this transformation.
Return type: | (float, float, float) |
---|
Derived from api method maya.OpenMaya.MFnTransform.getScale
Returns the pivot around which the scale is applied. The pivot will be in linear units.
Parameters : |
|
---|---|
Return type: | Point |
Derived from api method maya.OpenMaya.MSpace.scalePivot
Returns the scale pivot translation in linear units. This component is used as a compensation by maya when the user moves the scale pivot, or when the balance flag is set to true in the MfnTransform::setScalePivot method. The scale pivot translation serves as a compensation that allows existing transformations to be preserved when the scale pivot is modified. For the precise mathematics, refer to the transformation matrix details in the description section of MFnTransform .
Parameters : |
|
---|---|
Return type: | Vector |
Derived from api method maya.OpenMaya.MSpace.scalePivotTranslation
Retrieve the shearing component of this transformation.
Return type: | (float, float, float) |
---|
Derived from api method maya.OpenMaya.MFnTransform.getShear
Retrieve the transformation matrix represented by this transform.
Return type: | TransformationMatrix |
---|
Derived from api method maya.OpenMaya.MFnTransform.transformation
Retrieve the translation component of this transformation in linear units.
Parameters : |
|
---|---|
Return type: | Vector |
Derived from api method maya.OpenMaya.MSpace.getTranslation
Determine if the specified limit attribute is enabled or disabled.
Parameters : |
|
---|---|
Return type: | bool |
Derived from api method maya.OpenMaya.MFnTransform.isLimited
Reset the transform to its rest position. Derived from api method maya.OpenMaya.MFnTransform.resetFromRestPosition
Undo is not currently supported for this method
Relatively change the rotation of this transformation using a quaternion.
Parameters : |
|
---|
Derived from api method maya.OpenMaya.MSpace.rotateBy
Relatively scale this transformation.
Parameters : |
|
---|
Derived from api method maya.OpenMaya.MFnTransform.scaleBy
Change the limit value for the specified limit type, and automatically enable the limit to be true.
Parameters : |
|
---|
Derived from api method maya.OpenMaya.MFnTransform.setLimit
Enable or disable the limit value for the specified limit type.
Parameters : |
|
---|
Derived from api method maya.OpenMaya.MFnTransform.enableLimit
rotation axis orientation (when used with the -p flag the overall rotation is preserved by modifying the rotation to compensate for the axis rotation)
treat values as object-space transformation values (only works for pivots, translations, rotation, rotation axis, matrix, and bounding box flags)
treat values as world-space transformation values (only works for pivots, translations, rotation, rotation axis, matrix, and bounding box flags)
preserve overall transformation. used to prevent object from “jumping” when changing pivots or rotation order. the default value is true. (used with -sp, -rp, -roo, -cp, -ra)
Derived from mel command maya.cmds.xform
convenience method that changes both the rotate and scale pivots simultaneously. (see -rp -sp flags for more info)
treat values as object-space transformation values (only works for pivots, translations, rotation, rotation axis, matrix, and bounding box flags)
treat values as world-space transformation values (only works for pivots, translations, rotation, rotation axis, matrix, and bounding box flags)
Values for -sp, -rp, -st, -rt, -t, -piv flags are treated as world space distances to move along the local axis. (where the local axis depends on whether the command is operating in local-space or object-space. This flag has no effect for world space.
Derived from mel command maya.cmds.xform
Change the saved rest position of this transform. The rest position is not used internally by Maya. It is exclusively for use from the API as a temporary cache, which can be set and restored within a single Maya session. Note that the rest position is not saved with the scene.
Parameters : |
|
---|
Derived from api method maya.OpenMaya.MFnTransform.setRestPosition
rotation axis orientation (when used with the -p flag the overall rotation is preserved by modifying the rotation to compensate for the axis rotation)
treat values as object-space transformation values (only works for pivots, translations, rotation, rotation axis, matrix, and bounding box flags)
treat values as world-space transformation values (only works for pivots, translations, rotation, rotation axis, matrix, and bounding box flags)
preserve overall transformation. used to prevent object from “jumping” when changing pivots or rotation order. the default value is true. (used with -sp, -rp, -roo, -cp, -ra)
Derived from mel command maya.cmds.xform
Set the rotate pivot in linear units about which rotation is applied.
Parameters : |
|
---|
Derived from api method maya.OpenMaya.MSpace.setRotatePivot
Set the rotate pivot translation in linear units. This component is used internally by maya when the user moves the rotate pivot, or when the balance flag is true in the MFnTransform::setRotatePivot method. It serves as a compensation that allows existing transformations to be preserved when the rotate pivot is modified. For the precise mathematics, refer to the transformation matrix details in the description section of MFnTransform .
Parameters : |
|
---|
Derived from api method maya.OpenMaya.MSpace.setRotatePivotTranslation
Change the rotation component of this transformation using a quaternion. The only valid transformation spaces for this method are MSpace::kTransform and MSpace::kWorld . All other spaces are treated as being equivalent to MSpace::kTransform .
Parameters : |
|
---|
Derived from api method maya.OpenMaya.MSpace.setRotation
Change the rotation order for the transform - the order in which the Euler angles are applied to create the end rotation.
Parameters : |
|
---|
Derived from api method maya.OpenMaya.MTransformationMatrix.setRotationOrder
Set the scaling component of this transformation.
Parameters : |
|
---|
Derived from api method maya.OpenMaya.MFnTransform.setScale
Set the pivot around which the scale is applied in linear units.
Parameters : |
|
---|
Derived from api method maya.OpenMaya.MSpace.setScalePivot
Set the scale pivot translation in linear units. This component is used internally by maya when the user moves the scale pivot, or when the balance flag is set to true in the MfnTransform::setScalePivot method. It serves as a compensation that allows existing transformations to be preserved when the scale pivot is modified. For the precise mathematics, refer to the transformation matrix details in the description section of MFnTransform .
Parameters : |
|
---|
Derived from api method maya.OpenMaya.MSpace.setScalePivotTranslation
Set the shearing component of this transformation.
Parameters : |
|
---|
Derived from api method maya.OpenMaya.MFnTransform.setShear
Change this transform to equal the given matrix.
Parameters : |
|
---|
Derived from api method maya.OpenMaya.MFnTransform.set
Change the translation component of this transformation.
Parameters : |
|
---|
Derived from api method maya.OpenMaya.MSpace.setTranslation
Relatively shear this transformation.
Parameters : |
|
---|
Derived from api method maya.OpenMaya.MFnTransform.shearBy
Relatively change the translation component of this transformation.
Parameters : |
|
---|
Derived from api method maya.OpenMaya.MSpace.translateBy
reset pivot points and pivot translations without changing the overall matrix by applying these values into the translation channel.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command maya.cmds.xform