OpenMayaUI.MFnFreePointTriadManip Class Reference

OpenMayaUI.MFnFreePointTriadManip Class Reference
+ Related help topics:

Class Description

The FreePointTriadManip provides a moveable point, which can be moved anywhere, and has axes for constrained x, y, and z movement and obeys grid snapping, point snapping, and curve snapping. The FreePointTriadManip generates the 3D position of the moveable point. It is useful for specifying the position of an object in space.

Note that only the MFnNumericData::k3Double data type is supportedwhen connecting to a pointPlug via connectToPointPlug.

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

Public Member Functions

__init__ ()
 
connectToPointPlug ()
 
create ()
 
pointIndex ()
 
setDirection ()
 
setDrawArrowHead ()
 
setGlobalTriadPlane ()
 
setPoint ()
 
- 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 kViewPlane = 3
 
int kXYPlane = 2
 
int kXZPlane = 1
 
int kYZPlane = 0
 
- 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

 isDrawAxesOn
 
 isKeyframeAllOn
 
 isSnapModeOn
 
- 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.MFnFreePointTriadManip.__init__ ( )
x.__init__(...) initializes x; see help(type(x)) for signature

Member Function Documentation

OpenMayaUI.MFnFreePointTriadManip.connectToPointPlug ( )
connectToPointPlug(pointPlug) -> self

Connect to the point plug. The data type corresponding to the pointPlug is MFnNumericData.k3Double.

* pointPlug (MPlug) - the point plug
OpenMayaUI.MFnFreePointTriadManip.create ( )
create(manipName=None, pointName=None) -> MObject

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

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

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

* manipName (string) - Name of the manip for UI purposes.
* pointName (string) - Label for the position value which appears in the feedback line.
OpenMayaUI.MFnFreePointTriadManip.pointIndex ( )
pointIndex() -> int

Returns the index of the point of the FreePointTriadManip. The data type corresponding to this index is MFnNumericData.k3Double.
OpenMayaUI.MFnFreePointTriadManip.setDirection ( )
setDirection(direction) -> self

Sets the orientation of the FreePointTriadManip.

* direction (MVector) - the new direction for freePointTriadManip.
OpenMayaUI.MFnFreePointTriadManip.setDrawArrowHead ( )
setDrawArrowHead(state) -> self

Sets whether or not drawArrowHead is on.

* state (bool) - whether or not drawArrowHead is on
OpenMayaUI.MFnFreePointTriadManip.setGlobalTriadPlane ( )
setGlobalTriadPlane(whichPlane) -> self

Sets which plane to use as the global triad plane. The global triad plane does not change until the context switches.

* whichPlane (int) - which plane to use as the global triad plane

Valid plane values:
  kYZPlane       Y-Z Plane
  kXZPlane       X-Z Plane
  kXYPlane       X-Y Plane
  kViewPlane     View Plane
OpenMayaUI.MFnFreePointTriadManip.setPoint ( )
setPoint(pointValue) -> self

Set the point manipulator value to the given vector.  This method can be called in the MPxManipContainer.connectToDependNode() method to set the initial position for the manipulator.

* pointValue (MPoint) - The new value of the point manipValue

Property Documentation

OpenMayaUI.MFnFreePointTriadManip.isDrawAxesOn
static
 Whether or not the axes of the FreePointTriadManip are being drawn. By default the axes are drawn.
OpenMayaUI.MFnFreePointTriadManip.isKeyframeAllOn
static
 Whether or not the FreePointTriadManip is in keyframeAll mode.
OpenMayaUI.MFnFreePointTriadManip.isSnapModeOn
static
 Whether or not the FreePointTriadManip is in snap mode.

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