OpenMayaUI.MFnRotateManip Class Reference

OpenMayaUI.MFnRotateManip Class Reference
+ Related help topics:

Class Description

This class provides access to the built-in Maya rotate manipulator.

Method resolution order:
-   MFnRotateManip
-   MFnManip3D
-   OpenMaya.MFnTransform
-   OpenMaya.MFnDagNode
-   OpenMaya.MFnDependencyNode
-   OpenMaya.MFnBase
-   __builtin__.object
+ Inheritance diagram for OpenMayaUI.MFnRotateManip:

Public Member Functions

__init__ ()
 
connectToRotationCenterPlug ()
 
connectToRotationPlug ()
 
create ()
 
displayWithNode ()
 
rotationCenterIndex ()
 
rotationIndex ()
 
setInitialRotation ()
 
setRotationCenter ()
 
- Public Member Functions inherited from OpenMayaUI.MFnManip3D
__init__ ()
 
rotateXYZValue ()
 
- Public Member Functions inherited from OpenMaya.MFnTransform
__init__ ()
 
clearRestPosition ()
 
create ()
 
enableLimit ()
 
isLimited ()
 
limitValue ()
 
resetFromRestPosition ()
 
restPosition ()
 
rotateBy ()
 
rotateByComponents ()
 
rotateOrientation ()
 
rotatePivot ()
 
rotatePivotTranslation ()
 
rotation ()
 
rotationComponents ()
 
rotationOrder ()
 
scale ()
 
scaleBy ()
 
scalePivot ()
 
scalePivotTranslation ()
 
setLimit ()
 
setRestPosition ()
 
setRotateOrientation ()
 
setRotatePivot ()
 
setRotatePivotTranslation ()
 
setRotation ()
 
setRotationComponents ()
 
setRotationOrder ()
 
setScale ()
 
setScalePivot ()
 
setScalePivotTranslation ()
 
setShear ()
 
setTransformation ()
 
setTranslation ()
 
shear ()
 
shearBy ()
 
transformation ()
 
translateBy ()
 
translation ()
 
- Public Member Functions inherited from OpenMaya.MFnDagNode
__init__ ()
 
addChild ()
 
child ()
 
childCount ()
 
create ()
 
dagPath ()
 
dagRoot ()
 
duplicate ()
 
fullPathName ()
 
getAllPaths ()
 
getConnectedSetsAndMembers ()
 
getPath ()
 
hasChild ()
 
hasParent ()
 
instanceCount ()
 
isChildOf ()
 
isInstanced ()
 
isInstancedAttribute ()
 
isParentOf ()
 
parent ()
 
parentCount ()
 
partialPathName ()
 
removeChild ()
 
removeChildAt ()
 
setObject ()
 
transformationMatrix ()
 
- Public Member Functions inherited from OpenMaya.MFnDependencyNode
__init__ ()
 
absoluteName ()
 
addAttribute ()
 
addExternalContentForFileAttr ()
 
affectsAnimation ()
 
attribute ()
 
attributeClass ()
 
attributeCount ()
 
canBeWritten ()
 
create ()
 
dgCallbackIds ()
 
dgCallbacks ()
 
dgTimer ()
 
dgTimerOff ()
 
dgTimerOn ()
 
dgTimerQueryState ()
 
dgTimerReset ()
 
findAlias ()
 
findPlug ()
 
getAffectedAttributes ()
 
getAffectingAttributes ()
 
getAliasAttr ()
 
getAliasList ()
 
getConnections ()
 
getExternalContent ()
 
hasAttribute ()
 
hasUniqueName ()
 
isFlagSet ()
 
isNewAttribute ()
 
isTrackingEdits ()
 
name ()
 
plugsAlias ()
 
removeAttribute ()
 
reorderedAttribute ()
 
setAffectsAnimation ()
 
setAlias ()
 
setDoNotWrite ()
 
setExternalContent ()
 
setExternalContentForFileAttr ()
 
setFlag ()
 
setName ()
 
setUuid ()
 
userNode ()
 
uuid ()
 
- Public Member Functions inherited from OpenMaya.MFnBase
__init__ ()
 
hasObj ()
 
object ()
 
setObject ()
 
type ()
 

Static Public Attributes

int kGimbal = 2
 
int kObjectSpace = 0
 
int kWorldSpace = 1
 
- Static Public Attributes inherited from OpenMaya.MFnTransform
int kRotateMaxX = 13
 
int kRotateMaxY = 15
 
int kRotateMaxZ = 17
 
int kRotateMinX = 12
 
int kRotateMinY = 14
 
int kRotateMinZ = 16
 
int kScaleMaxX = 1
 
int kScaleMaxY = 3
 
int kScaleMaxZ = 5
 
int kScaleMinX = 0
 
int kScaleMinY = 2
 
int kScaleMinZ = 4
 
int kShearMaxXY = 7
 
int kShearMaxXZ = 9
 
int kShearMaxYZ = 11
 
int kShearMinXY = 6
 
int kShearMinXZ = 8
 
int kShearMinYZ = 10
 
int kTranslateMaxX = 19
 
int kTranslateMaxY = 21
 
int kTranslateMaxZ = 23
 
int kTranslateMinX = 18
 
int kTranslateMinY = 20
 
int kTranslateMinZ = 22
 
- Static Public Attributes inherited from OpenMaya.MFnDagNode
int kNextPos = 255
 
- Static Public Attributes inherited from OpenMaya.MFnDependencyNode
int kTimerMetrics = 9
 
int kTimerTypes = 3
 
int kExtensionAttr = 3
 
int kInvalidAttr = 4
 
int kLocalDynamicAttr = 1
 
int kNormalAttr = 2
 
int kTimerInvalidState = 3
 
int kTimerOff = 0
 
int kTimerOn = 1
 
int kTimerUninitialized = 2
 
int kTimerMetric_callback = 0
 
int kTimerMetric_callbackNotViaAPI = 6
 
int kTimerMetric_callbackViaAPI = 5
 
int kTimerMetric_compute = 1
 
int kTimerMetric_computeDuringCallback = 7
 
int kTimerMetric_computeNotDuringCallback = 8
 
int kTimerMetric_dirty = 2
 
int kTimerMetric_draw = 3
 
int kTimerMetric_fetch = 4
 
int kTimerType_count = 2
 
int kTimerType_inclusive = 1
 
int kTimerType_self = 0
 

Properties

 isSnapModeOn
 
 rotateMode
 
 snapIncrement
 
- Properties inherited from OpenMayaUI.MFnManip3D
 isOptimizePlaybackOn
 
 isVisible
 
 manipScale
 
- Properties inherited from OpenMaya.MFnDagNode
 boundingBox
 
 inModel
 
 inUnderWorld
 
 isInstanceable
 
 isIntermediateObject
 
 objectColor
 
 objectColorRGB
 
 objectColorType
 
 useObjectColor
 
- Properties inherited from OpenMaya.MFnDependencyNode
 isDefaultNode
 
 isFromReferencedFile
 
 isLocked
 
 isShared
 
 namespace
 
 pluginName
 
 typeId
 
 typeName
 

Additional Inherited Members

- Static Public Member Functions inherited from OpenMayaUI.MFnManip3D
deleteManipulator ()
 
drawPlaneHandles ()
 
globalSize ()
 
handleSize ()
 
lineSize ()
 
setDrawPlaneHandles ()
 
setGlobalSize ()
 
setHandleSize ()
 
setLineSize ()
 
- Static Public Member Functions inherited from OpenMaya.MFnDependencyNode
allocateFlag ()
 
classification ()
 
deallocateAllFlags ()
 
deallocateFlag ()
 

Constructor & Destructor Documentation

OpenMayaUI.MFnRotateManip.__init__ ( )
x.__init__(...) initializes x; see help(type(x)) for signature

Member Function Documentation

OpenMayaUI.MFnRotateManip.connectToRotationCenterPlug ( )
connectToRotationCenterPlug(rotationCenterPlug) -> self

Create a 1-1 association of the rotation center on the manipulator and the rotationCenterPlug parameter.  When both the rotation center is attached to a plug and the displayWithNode() method has been called, the manipulator will display with the node regardless of the connection made to the rotation center.

The plug must have a data type of MFnNumericData.k3Double.

* rotationCenterPlug (MPlug) - The plug to connect the rotation center to
OpenMayaUI.MFnRotateManip.connectToRotationPlug ( )
connectToRotationPlug(rotationPlug) -> self

Create a 1-1 connection from the rotation manipVal to the rotationPlug parameter.  Any changes to the rotation manipVal will be immediately reflected in the connected plug.  Connecting to the "rotation" plug on a transform node will produce similar behavior to the built-in rotation manipulator.

The plug must have a data type of MFnNumericData.k3Double.

* rotationPlug (MPlug) - The plug to connect the rotation value to
OpenMayaUI.MFnRotateManip.create ( )
create(manipName=None, rotationName=None) -> MObject

Creates a new RotateManip, and attaches this function set to the new manipulator.

This method should only be used to create a non-composite manipulator, meaning that the manipulator is standalone and not part of a container.

When the manipulator is being used, the feedback line will display a string including rotationName, indicating that this manipulator is in use.

* manipName (string) - Name of the manip for UI purposes.
* rotationName (string) - Label for the rotation value displayed in the feedback line.
OpenMayaUI.MFnRotateManip.displayWithNode ( )
displayWithNode(node) -> self

Configures the manipulator to display with the node, causing the position of the manipulator to follow the position of the node whenever the node is moved.  The node must be a DAG object.

* node (MObject) - The node the manipulator should display with
OpenMayaUI.MFnRotateManip.rotationCenterIndex ( )
rotationCenterIndex() -> int

Returns the index of the rotation center for this manipulator.

Note that the rotation center is only used for positioning the display of the manipulator, and has no effect on the rotation values generated by the manipulator.
OpenMayaUI.MFnRotateManip.rotationIndex ( )
rotationIndex() -> int

Returns the index of the rotation manipVal for the manipulator.  When plugToManip conversion functions are used to produce the rotation manipVal, the manipulator data must be of the type MFnNumericData.k3Double, with X,Y, and Z rotations given in radians.  This is easily accomplished by using the MEulerRotation class to manage the rotations.
OpenMayaUI.MFnRotateManip.setInitialRotation ( )
setInitialRotation(rotation) -> self

Sets the initial rotation for the rotate manipulator.  Setting the initial rotation will prevent the manipulator from jumping back to the default rotation when there is already an existing rotation on the target plug.

* rotation (MEulerRotation) - The initial rotation
OpenMayaUI.MFnRotateManip.setRotationCenter ( )
setRotationCenter(rotationCenter) -> self

Sets the position of the rotation center for the manipulator.

The value set by this method is ignored if a plug has been connected to the rotationCenterPlug. This value is only relevant when there is no plug connection to rotationCenterPlug nor node associated with the manip (see connectToRotationCenterPlug and displayWithNode, respectively).

Note that the rotation center is only used for positioning the display of the manipulator, and has no effect on the rotation values generated by the manipulator.

* rotationCenter (MPoint) - The world space position of the rotation center.

Property Documentation

OpenMayaUI.MFnRotateManip.isSnapModeOn
static
 Whether or not the snap mode is on. When snap mode is on, rotation manip values will snap to the values within some increment apart.
OpenMayaUI.MFnRotateManip.rotateMode
static
 The mode for the rotation manipulator.  The manipulator mode controls the appearance of the manipulator when is it used.
 
 The following modes are supported for the rotation manipulator:
 
 * kObjectSpace In object space mode, the manipulator is displayed as three perpendicular manipulator discs, as well as a view disc enclosing the manipulator.  The manipulator will rotate whenever the manip value is changed.
 * kWorldSpace This mode forces the manipulator to display in the default orientation regardless of the manipulator value.  The manipulator is displayed the same as in object space mode, except it does not rotate when the manip value is changed.
 * kGimbal In gimbal mode, only the constrained axis rotation discs are allowed to be manipulated.  Gimbal mode treats the X,Y, and Z axis rotations as a sequence of operations on the default manipulator display.  First, the X rotation is applied.  Then, the Y rotation is applied, causing the X rotation disc to become transformed.  Finally, the Z rotation is applied, transforming both the X and Y rotation discs.  The Z rotation disc remains fixed during the operation.  No view disc can be manipulated in gimbal mode.
OpenMayaUI.MFnRotateManip.snapIncrement
static
 The snap increment is specified in degrees. Manipulator values will snap to the next rotation at an angle of snapIncrement from the original rotation.  Note that snap rotate does not apply to the trackball rotations (when dragging between the rotate discs).

The documentation for this class was generated from the following file:
  • D:/Maya-MD-Merge/input/python/2.0/OpenMayaUI.py