Python API 2.0 Reference
OpenMayaUI.MFnDirectionManip Class Reference
+ Inheritance diagram for OpenMayaUI.MFnDirectionManip:

Public Member Functions

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

Static Public Member Functions

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

Additional Inherited Members

- 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 inherited from OpenMayaUI.MFnManip3D
 isOptimizePlaybackOn = property(...)
 
 isVisible = property(...)
 
 manipScale = property(...)
 
- Properties inherited from OpenMaya.MFnDagNode
 boundingBox = property(...)
 
 inModel = property(...)
 
 inUnderWorld = property(...)
 
 isInstanceable = property(...)
 
 isIntermediateObject = property(...)
 
 objectColor = property(...)
 
 objectColorRGB = property(...)
 
 objectColorType = property(...)
 
 useObjectColor = property(...)
 
- Properties inherited from OpenMaya.MFnDependencyNode
 isDefaultNode = property(...)
 
 isFromReferencedFile = property(...)
 
 isLocked = property(...)
 
 isShared = property(...)
 
 namespace = property(...)
 
 pluginName = property(...)
 
 typeId = property(...)
 
 typeName = property(...)
 

Detailed Description

The DirectionManip allows the user to specify a direction, as defined by the vector from the start point to the manipulator position.

Method resolution order:
-   MFnDirectionManip
-   MFnManip3D
-   OpenMaya.MFnTransform
-   OpenMaya.MFnDagNode
-   OpenMaya.MFnDependencyNode
-   OpenMaya.MFnBase
-   builtins.object

Constructor & Destructor Documentation

def OpenMayaUI.MFnDirectionManip.__init__ ( )
Initialize self.  See help(type(self)) for accurate signature.

Member Function Documentation

def OpenMayaUI.MFnDirectionManip.__new__ ( )
static
Create and return a new object.  See help(type) for accurate signature.
def OpenMayaUI.MFnDirectionManip.connectToDirectionPlug ( )
connectToDirectionPlug(directionPlug) -> self

Connect to the direction plug. The data type corresponding to the directionPlug is MFnNumericData.k3Double.

* directionPlug (MPlug) - the direction plug
def OpenMayaUI.MFnDirectionManip.create ( )
create(manipName=None, directionName=None) -> MObject

Creates a new DirectionManip.
This function set's object is set to be the new manipulator.

This method should only be used to create a non-composite DirectionManip.

The name that appears in the feedback line is specified by the directionName argument.

* manipName (string) - Name of the manip for UI purposes.
* directionName (string) - Label for the direction value which appears in the feedback line.
def OpenMayaUI.MFnDirectionManip.directionIndex ( )
directionIndex() -> int

Returns the index of the direction. The data type corresponding to this index is MFnNumericData.k3Double.
def OpenMayaUI.MFnDirectionManip.endPointIndex ( )
endPointIndex() -> int

Returns the index of the end point of the DirectionManip. The data type corresponding to this index is MFnNumericData.k3Double.
def OpenMayaUI.MFnDirectionManip.setDirection ( )
setDirection(direction) -> self

Sets the direction of the DirectionManip.

* direction (MVector) - the direction of the DirectionManip
def OpenMayaUI.MFnDirectionManip.setDrawStart ( )
setDrawStart(bool) -> self

Sets whether or not to draw the start of the DirectionManip.
The start of the DirectionManip is indicated by a grey dot.
By default the start is not drawn.
def OpenMayaUI.MFnDirectionManip.setNormalizeDirection ( )
setNormalizeDirection(bool) -> self

Sets whether or not to the direction should be normalized.
By default the direction is normalized.
def OpenMayaUI.MFnDirectionManip.setStartPoint ( )
setStartPoint(startPoint) -> self

Sets the start point of the DirectionManip.

* startPoint (MPoint) - the start point of the DirectionManip
def OpenMayaUI.MFnDirectionManip.startPointIndex ( )
startPointIndex() -> int

Returns the index of the start point of the DirectionManip. The data type corresponding to this index is MFnNumericData.k3Double.