OpenMayaUI.MFnDistanceManip Class Reference

OpenMayaUI.MFnDistanceManip Class Reference

Class Description

The DistanceManip allows the user to manipulate a point that is constrained to move along a line. This manipulator generates a single floating point value. Scaling factors can be used to determine how the manipulator appears when it is drawn.

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

Public Member Functions

__init__ ()
 
connectToDistancePlug ()
 
create ()
 
currentPointIndex ()
 
directionIndex ()
 
distanceIndex ()
 
setDirection ()
 
setStartPoint ()
 
startPointIndex ()
 
- 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 ()
 

Properties

 isDrawLineOn
 
 isDrawStartOn
 
 scalingFactor
 
- 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 ()
 
- 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
 

Constructor & Destructor Documentation

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

Member Function Documentation

OpenMayaUI.MFnDistanceManip.connectToDistancePlug ( )
connectToDistancePlug(directionPlug) -> self

Connect to the distance plug. The data type corresponding to the distancePlug is a double. (Note that MFnUnitAttribute.kDistance is used to specify a distance attribute.)

* distancePlug (MPlug) - the distance plug
OpenMayaUI.MFnDistanceManip.create ( )
create(manipName=None, distanceName=None) -> MObject

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

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

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

* manipName (string) - Name of the manip for UI purposes.
* distanceName (string) - Label for the distance value which appears in the feedback line.
OpenMayaUI.MFnDistanceManip.currentPointIndex ( )
currentPointIndex() -> int

Returns the index of the current point of the DistanceManip. The data type corresponding to this index is MFnNumericData.k3Double.
OpenMayaUI.MFnDistanceManip.directionIndex ( )
directionIndex() -> int

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

Returns the index of the distance. The data type corresponding to this index is a double.
OpenMayaUI.MFnDistanceManip.setDirection ( )
setDirection(direction) -> self

Sets the direction of the DistanceManip.

* direction (MVector) - the direction of the DistanceManip
OpenMayaUI.MFnDistanceManip.setStartPoint ( )
setStartPoint(startPoint) -> self

Sets the start point of the DistanceManip.

* startPoint (MPoint) - the start point of the DistanceManip
OpenMayaUI.MFnDistanceManip.startPointIndex ( )
startPointIndex() -> int

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

Property Documentation

OpenMayaUI.MFnDistanceManip.isDrawLineOn
static
 Whether or not to draw a line from the start to the end of the DistanceManip.
 By default the line is drawn.
OpenMayaUI.MFnDistanceManip.isDrawStartOn
static
 Whether or not the start of the DistanceManip is being drawn.
 By default the start is not drawn.
OpenMayaUI.MFnDistanceManip.scalingFactor
static
 The scaling factor is used to determine how int the DistanceManip appears when it is drawn.
 The default scaling factor is 1.0.

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