class MFnFreePointTriadManip

Jump to documentation

: public MFnManip3D FreePointTriadManip function set (OpenMayaUI) (OpenMayaUI.py)

Inheritance:

MFnFreePointTriadManip < MFnManip3D < MFnTransform < MFnDagNode < MFnDependencyNode < MFnBase

public members:

MFnFreePointTriadManip ( const MObject & object, MStatus * ReturnStatus = NULL )
enum ManipPlane
kYZPlane
Y-Z Plane
kXZPlane
X-Z Plane
kXYPlane
X-Y Plane
kViewPlane
View Plane
MObject create ( MStatus *ReturnStatus = NULL)
MObject create (const MString &manipName, const MString &pointName, MStatus *ReturnStatus = NULL)
MStatus connectToPointPlug ( MPlug &pointPlug)
MStatus setDrawAxes (bool state)
MStatus setSnapMode (bool state)
MStatus setKeyframeAll (bool state)
MStatus setDrawArrowHead (bool state)
MStatus setGlobalTriadPlane ( ManipPlane whichPlane)
MStatus setPoint (const MPoint & pointValue)
MStatus setDirection (const MVector & direction)
bool isDrawAxesOn ( MStatus *ReturnStatus = NULL) const
bool isSnapModeOn ( MStatus *ReturnStatus = NULL) const
bool isKeyframeAllOn ( MStatus *ReturnStatus = NULL) const
unsigned int pointIndex ( MStatus *ReturnStatus = NULL) const

Inherited from MFnManip3D:

public members:

bool isVisible ( MStatus *ReturnStatus) const
MStatus setVisible (bool isVisible )
float manipScale ( MStatus *ReturnStatus) const
MStatus setManipScale (float size)
bool isOptimizePlaybackOn ( MStatus *ReturnStatus) const
MStatus setOptimizePlayback (bool optimizePlayback)
static float globalSize ()
static void setGlobalSize (float size)
static float handleSize ()
static void setHandleSize (float size)
static float lineSize ()
static void setLineSize (float size)
static MStatus deleteManipulator ( MObject & manip)
MEulerRotation rotateXYZValue (const unsigned int valIndex, MStatus *ReturnStatus = NULL)

Inherited from MFnTransform:

public members:

MObject create ( MObject parent = MObject::kNullObj , MStatus * ReturnStatus = NULL )
MTransformationMatrix transformation ( MStatus * ReturnStatus = NULL ) const
MStatus set ( const MTransformationMatrix & transform )
MStatus getScale ( double scale[3] ) const
MStatus setScale ( const double scale[3] )
MStatus scaleBy ( const double scale[3] )
MStatus getShear ( double scale[3] ) const
MStatus setShear ( const double shear[3] )
MStatus shearBy ( const double shear[3] )
MStatus getRotation ( MQuaternion &quaternion, MSpace::Space = MSpace::kTransform ) const
MStatus setRotation ( const MQuaternion &quaternion, MSpace::Space = MSpace::kTransform )
MStatus rotateBy ( const MQuaternion &quaternion, MSpace::Space = MSpace::kTransform )
MStatus getRotation ( MEulerRotation &rotation ) const
MStatus setRotation ( const MEulerRotation &rotation )
MStatus rotateBy ( const MEulerRotation &rotation, MSpace::Space = MSpace::kTransform )
MStatus getRotationQuaternion ( double &x, double &y, double &z, double &w, MSpace::Space = MSpace::kTransform ) const
MStatus setRotationQuaternion ( double x, double y, double z, double w, MSpace::Space = MSpace::kTransform )
MStatus rotateByQuaternion ( double x, double y, double z, double w, MSpace::Space = MSpace::kTransform )
MStatus getRotation ( double rotation[3], MTransformationMatrix::RotationOrder & order ) const
MStatus setRotation ( const double rotation[3], MTransformationMatrix::RotationOrder order )
MStatus rotateBy ( const double rotation[3], MTransformationMatrix::RotationOrder order, MSpace::Space = MSpace::kTransform )
MVector getTranslation ( MSpace::Space space, MStatus * ReturnStatus = NULL ) const
MStatus setTranslation ( const MVector & vec, MSpace::Space space )
MStatus translateBy ( const MVector & vec, MSpace::Space space )
MPoint scalePivot ( MSpace::Space space, MStatus * ReturnStatus = NULL ) const
MStatus setScalePivot ( const MPoint & point, MSpace::Space space, bool balance )
MVector scalePivotTranslation ( MSpace::Space space , MStatus * ReturnStatus = NULL ) const
MStatus setScalePivotTranslation ( const MVector & vec, MSpace::Space space )
MPoint rotatePivot ( MSpace::Space space , MStatus * ReturnStatus = NULL ) const
MStatus setRotatePivot ( const MPoint & point, MSpace::Space space, bool balance )
MVector rotatePivotTranslation ( MSpace::Space space, MStatus * ReturnStatus = NULL ) const
MStatus setRotatePivotTranslation ( const MVector & vec, MSpace::Space space )
MQuaternion rotateOrientation ( MSpace::Space space , MStatus * ReturnStatus = NULL ) const
MStatus setRotateOrientation ( const MQuaternion & quat, MSpace::Space space, bool balance )
MTransformationMatrix::RotationOrder rotationOrder ( MStatus * ReturnStatus = NULL ) const
MStatus setRotationOrder ( MTransformationMatrix::RotationOrder order, bool reorder )
MTransformationMatrix restPosition ( MStatus * ReturnStatus) const
MStatus setRestPosition ( const MTransformationMatrix & matrix )
MStatus resetFromRestPosition ()
MStatus clearRestPosition ()
MStatus getRotation ( double rotation[3], MTransformationMatrix::RotationOrder & order, MSpace::Space ) const
MStatus setRotation (const double rotation[3], MTransformationMatrix::RotationOrder order, MSpace::Space )
MVector translation ( MSpace::Space space, MStatus * ReturnStatus = NULL ) const
enum LimitType
kScaleMinX
kScaleMaxX
kScaleMinY
kScaleMaxY
kScaleMinZ
kScaleMaxZ
kShearMinXY
kShearMaxXY
kShearMinXZ
kShearMaxXZ
kShearMinYZ
kShearMaxYZ
kRotateMinX
kRotateMaxX
kRotateMinY
kRotateMaxY
kRotateMinZ
kRotateMaxZ
kTranslateMinX
kTranslateMaxX
kTranslateMinY
kTranslateMaxY
kTranslateMinZ
kTranslateMaxZ
bool isLimited ( MFnTransform::LimitType type , MStatus * ReturnStatus = NULL ) const
double limitValue ( MFnTransform::LimitType type , MStatus * ReturnStatus = NULL ) const
MStatus setLimit ( MFnTransform::LimitType type , double value)
MStatus enableLimit ( MFnTransform::LimitType type , bool flag)

Inherited from MFnDagNode:

public members:

kNextPos
MObject create ( const MTypeId &typeId, MObject & parent = MObject::kNullObj , MStatus * ReturnStatus = NULL )
MObject create ( const MTypeId &typeId, const MString &name, MObject & parent = MObject::kNullObj , MStatus * ReturnStatus = NULL )
MObject create ( const MString &type, MObject & parent = MObject::kNullObj , MStatus * ReturnStatus = NULL )
MObject create ( const MString &type, const MString &name, MObject & parent = MObject::kNullObj , MStatus * ReturnStatus = NULL )
unsigned int parentCount ( MStatus * ReturnStatus = NULL ) const
MObject parent ( unsigned int i, MStatus * ReturnStatus = NULL ) const
MStatus addChild ( MObject & child , unsigned int index = kNextPos , bool keepExistingParents = false )
MStatus removeChild ( MObject & child )
MStatus removeChildAt ( unsigned int index )
unsigned int childCount ( MStatus * ReturnStatus = NULL ) const
MObject child ( unsigned int i, MStatus * ReturnStatus = NULL ) const
MObject dagRoot ( MStatus * ReturnStatus = NULL )
bool hasParent ( const MObject & node, MStatus * ReturnStatus = NULL ) const
bool hasChild (const MObject & node, MStatus * ReturnStatus = NULL ) const
bool isChildOf (const MObject & node, MStatus * ReturnStatus = NULL ) const
bool isParentOf (const MObject & node, MStatus * ReturnStatus = NULL ) const
bool inUnderWorld ( MStatus * ReturnStatus = NULL ) const
bool inModel ( MStatus * ReturnStatus = NULL ) const
bool isInstanceable ( MStatus * ReturnStatus=NULL ) const
MStatus setInstanceable ( const bool how )
bool isInstanced ( bool indirect = true, MStatus * ReturnStatus = NULL ) const
bool isInstancedAttribute ( const MObject & attr, MStatus * ReturnStatus = NULL ) const
unsigned int instanceCount ( bool total, MStatus * ReturnStatus = NULL ) const
MObject duplicate ( bool instance = false, bool instanceLeaf = false, MStatus * ReturnStatus = NULL ) const
MStatus getPath ( MDagPath & path )
MStatus getAllPaths ( MDagPathArray & paths )
MString fullPathName ( MStatus *ReturnStatus = NULL)
MString partialPathName ( MStatus *ReturnStatus = NULL)
MMatrix transformationMatrix ( MStatus * ReturnStatus = NULL ) const
bool isIntermediateObject ( MStatus * ReturnStatus = NULL ) const
MStatus setIntermediateObject ( bool isIntermediate )
int objectColor ( MStatus * ReturnStatus = NULL ) const
MStatus setObjectColor ( int color )
bool usingObjectColor ( MStatus * ReturnStatus = NULL ) const
MStatus setUseObjectColor ( bool useObjectColor )
MBoundingBox boundingBox ( MStatus * ReturnStatus = NULL ) const
MDagPath dagPath ( MStatus * ReturnStatus = NULL ) const
virtual MStatus setObject ( const MDagPath & path )
virtual MStatus setObject ( MObject & object )
MObject model ( MStatus * ReturnStatus = NULL ) const
virtual MStatus setObject ( const MObject & object )

Inherited from MFnDependencyNode:

public members:

virtual MFn::Type type () const
enum MAttrClass
kGlobalDynamicAttr
kLocalDynamicAttr
MObject create ( const MTypeId & typeId , MStatus * ReturnStatus = NULL )
MObject create ( const MTypeId & typeId , const MString & name , MStatus * ReturnStatus = NULL )
MObject create ( const MString & type , MStatus * ReturnStatus = NULL )
MObject create ( const MString & type , const MString & name , MStatus * ReturnStatus = NULL )
MTypeId typeId ( MStatus * ReturnStatus = NULL ) const
MString typeName ( MStatus * ReturnStatus = NULL ) const
MString name ( MStatus * ReturnStatus = NULL ) const
MString setName ( const MString & name , MStatus * ReturnStatus = NULL )
MStatus getConnections ( MPlugArray & array ) const
unsigned int attributeCount ( MStatus * ReturnStatus=NULL) const
MObject attribute ( unsigned int index, MStatus * ReturnStatus=NULL) const
MObject reorderedAttribute ( unsigned int index, MStatus * ReturnStatus=NULL) const
MObject attribute ( const MString & attrName, MStatus * ReturnStatus=NULL) const
MAttrClass attributeClass ( const MObject & attr, MStatus * ReturnStatus=NULL) const
MStatus getAffectedAttributes ( const MObject & attr, MObjectArray & affectedAttributes ) const
MStatus getAffectedByAttributes ( const MObject & attr, MObjectArray & affectedByAttributes ) const
MPlug findPlug ( const MObject & attr, bool wantNetworkedPlug, MStatus * ReturnStatus=NULL) const
MPlug findPlug ( const MString & attrName, bool wantNetworkedPlug, MStatus * ReturnStatus=NULL) const
MPlug findPlug ( const MObject & attr, MStatus * ReturnStatus=NULL) const
MPlug findPlug ( const MString & attrName, MStatus * ReturnStatus=NULL) const
MStatus addAttribute ( const MObject & attr, MAttrClass type = kLocalDynamicAttr )
MStatus removeAttribute ( const MObject & attr, MAttrClass type = kLocalDynamicAttr )
MPxNode * userNode ( MStatus * ReturnStatus=NULL ) const
bool isFromReferencedFile ( MStatus * ReturnStatus=NULL) const
bool isShared ( MStatus * ReturnStatus=NULL) const
bool hasUniqueName ( MStatus * ReturnStatus=NULL) const
MString parentNamespace ( MStatus * ReturnStatus=NULL) const
bool isLocked ( MStatus * ReturnStatus=NULL) const
MStatus setLocked ( bool locked )
static MString classification ( const MString & nodeTypeName )
bool isNewAttribute ( const MObject & attr, MStatus * ReturnStatus=NULL) const
static unsigned int allocateFlag ( const MString pluginName, MStatus * ReturnStatus=NULL )
static MStatus deallocateFlag (const MString pluginName, unsigned int flag)
static MStatus deallocateAllFlags (const MString pluginName)
MStatus setFlag (unsigned int flag, bool state)
bool isFlagSet (unsigned int flag, MStatus * ReturnStatus=NULL) const
bool isDefaultNode ( MStatus * ReturnStatus=NULL) const
MStatus setDoNotWrite ( bool flag )
bool canBeWritten ( MStatus * ReturnStatus=NULL) const
bool hasAttribute (const MString & name , MStatus * ReturnStatus=NULL) const
MObject getAliasAttr (bool force, MStatus * ReturnStatus=NULL)
bool setAlias (const MString & alias,const MString & name , const MPlug & plug, bool add=true, MStatus * ReturnStatus=NULL)
bool findAlias (const MString & alias, MObject & attrObj, MStatus * ReturnStatus=NULL) const
bool getAliasList ( MStringArray & strArray, MStatus * ReturnStatus=NULL)
MString plugsAlias (const MPlug & plug, MStatus * ReturnStatus=NULL)
public
bool getPlugsAlias (const MPlug & plug, MString & aliasName, MStatus * ReturnStatus=NULL)

Inherited from MFnBase:

public members:

virtual MFn::Type type () const
bool hasObj ( MFn::Type ) const
bool hasObj ( const MObject & ) const
MObject object ( MStatus * ReturnStatus = NULL ) const
virtual MStatus setObject ( MObject & object )
virtual MStatus setObject ( const MObject & object )

Documentation

MFnFreePointTriadManip is the function set for free point triad manipulators.
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.

Functions

MFnFreePointTriadManip:: MFnFreePointTriadManip ()

Description

Default class constructor. The function set is not attached to an MObject.

MFnFreePointTriadManip:: MFnFreePointTriadManip ( MObject & object, MStatus * ReturnStatus )

Description

Class constructor that initializes the function set to the given MObject.

Arguments

  • object the MObject to attach the function set to
  • ReturnStatus the return status
    • MS::kSuccess if the function set is successfully attached
    • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

MFnFreePointTriadManip:: MFnFreePointTriadManip ( const MObject & object, MStatus * ReturnStatus )

Description

Class constructor that initializes the function set to the given constant MObject.

Arguments

  • object the const MObject to attach the function set to
  • ReturnStatus the return status
    • MS::kSuccess if the function set is successfully attached
    • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

MFnFreePointTriadManip:: MFnFreePointTriadManip ( const MDagPath & object, MStatus * ReturnStatus )

Description

Class constructor that initializes the function set to the given constant MDagPath object.

Arguments

  • object the const MDagPath to attach the function set to
  • ReturnStatus the return status
    • MS::kSuccess if the function set is successfully attached
    • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

MFn::Type MFnFreePointTriadManip:: type () const

Description

Return the type of this function set.

Return Value

  • the constant MFn::kFreePointTriadManip

MFnFreePointTriadManip:: ~MFnFreePointTriadManip ()

Description

Class destructor.

MObject MFnFreePointTriadManip:: create ( MStatus *ReturnStatus)

Description

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 "point"

Arguments

  • ReturnStatus return status

Return Value

  • newly created FreePointTriadManip

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure operation failed

MObject MFnFreePointTriadManip:: create (const MString &manipName, const MString &pointName, MStatus *ReturnStatus)

Description

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.

Arguments

  • pointName the name that appears in the feedback line
  • ReturnStatus return status

Return Value

  • newly created FreePointTriadManip

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure operation failed

MStatus MFnFreePointTriadManip:: connectToPointPlug ( MPlug &pointPlug)

Description

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

Arguments

  • pointPlug the point plug

Return Value

  • MS::kSuccess operation successful
  • MS::kFailure operation failed

MStatus MFnFreePointTriadManip:: setDrawAxes (bool state)

Description

Sets whether or not to draw the axes of the FreePointTriadManip. By default the axes are drawn.

Arguments

  • state whether or not the axes should be drawn

Return Value

  • MS::kSuccess operation successful
  • MS::kFailure operation failed

bool MFnFreePointTriadManip:: isDrawAxesOn ( MStatus *ReturnStatus) const

Description

Returns whether or not the axes of the FreePointTriadManip are being drawn. By default the axes are drawn.

Arguments

  • ReturnStatus return status

Return Value

  • true the axes of the FreePointTriadManip are being drawn
  • false the axes of the FreePointTriadManip are not being drawn

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure operation failed

MStatus MFnFreePointTriadManip:: setSnapMode (bool state)

Description

Sets whether or not to the FreePointTriadManip should be in snap mode.

Arguments

  • state whether or not the FreePointTriadManip should be in snap mode

Return Value

  • MS::kSuccess operation successful
  • MS::kFailure operation failed

bool MFnFreePointTriadManip:: isSnapModeOn ( MStatus *ReturnStatus) const

Description

Returns whether or not the FreePointTriadManip is in snap mode.

Arguments

  • ReturnStatus return status

Return Value

  • true the FreePointTriadManip is in snap mode
  • false the FreePointTriadManip is not in snap mode

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure operation failed

MStatus MFnFreePointTriadManip:: setKeyframeAll (bool state)

Description

Sets whether or not keyframeAll is on.

Arguments

  • state whether or not keyframeAll is on

Return Value

  • MS::kSuccess operation successful
  • MS::kFailure operation failed

bool MFnFreePointTriadManip:: isKeyframeAllOn ( MStatus *ReturnStatus) const

Description

Returns whether or not the FreePointTriadManip is in keyframeAll mode.

Arguments

  • ReturnStatus return status

Return Value

  • true the FreePointTriadManip is in keyframeAll mode
  • false the FreePointTriadManip is not in keyframeAll mode

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure operation failed

MStatus MFnFreePointTriadManip:: setDrawArrowHead (bool state)

Description

Sets whether or not drawArrowHead is on.

Arguments

  • state whether or not drawArrowHead is on

Return Value

  • MS::kSuccess operation successful
  • MS::kFailure operation failed

MStatus MFnFreePointTriadManip:: setGlobalTriadPlane ( ManipPlane whichPlane)

Description

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

Arguments

  • state which plane to use as the global triad plane

Return Value

  • MS::kSuccess operation successful
  • MS::kFailure operation failed

MStatus MFnFreePointTriadManip:: setPoint (const MPoint & pointValue)

Description

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.

Arguments

  • pointValue The new value of the point manipValue

Return Value

  • MS::kSuccess operation successful
  • MS::kFailure operation failed

unsigned int MFnFreePointTriadManip:: pointIndex ( MStatus *ReturnStatus) const

Description

Returns the index of the point of the FreePointTriadManip. The data type corresponding to this index is MFnNumericData::k3Double.

Arguments

  • ReturnStatus return status

Return Value

  • point index

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure operation failed

MStatus MFnFreePointTriadManip:: setDirection (const MVector & direction)

Description

Sets the orientation of the FreePointTriadManip.

Arguments

  • direction the new direction for freePointTriadManip.

Return Value

  • MS::kSuccess operation successful
  • MS::kFailure operation failed

This class has no child classes.

Autodesk® Maya® 2008 © 1997-2007 Autodesk, Inc. All rights reserved. doc++ Copyright