Public Types | Public Member Functions | Protected Member Functions

MFnFreePointTriadManip Class Reference

This reference page is linked to from the following overview topics: Base Manipulators, Communication Between Manipulators and Nodes.


Search for all occurrences

Detailed Description

FreePointTriadManip function set.

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.

Examples:

moveManip.cpp, and swissArmyManip.cpp.

#include <MFnFreePointTriadManip.h>

Inheritance diagram for MFnFreePointTriadManip:
Inheritance graph
[legend]

List of all members.

Public Types

enum  ManipPlane { kYZPlane = 0, kXZPlane, kXYPlane, kViewPlane }
 

Interaction plane for the manip center.

More...

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnFreePointTriadManip ()
 Destructor.
 MFnFreePointTriadManip ()
 Default constructor.
 MFnFreePointTriadManip (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
 MFnFreePointTriadManip (const MDagPath &object, MStatus *ret=NULL)
 Constructor.
MObject create (MStatus *ReturnStatus=NULL)
 Creates a new FreePointTriadManip.
MObject create (const MString &manipName, const MString &pointName, MStatus *ReturnStatus=NULL)
 Creates a new FreePointTriadManip.
MStatus connectToPointPlug (MPlug &pointPlug)
 Connect to the point plug.
MStatus setDrawAxes (bool state)
 Sets whether or not to draw the axes of the FreePointTriadManip.
MStatus setSnapMode (bool state)
 Sets whether or not to the FreePointTriadManip should be in snap mode.
MStatus setKeyframeAll (bool state)
 Sets whether or not keyframeAll is on.
MStatus setDrawArrowHead (bool state)
 Sets whether or not drawArrowHead is on.
MStatus setGlobalTriadPlane (ManipPlane whichPlane)
 Sets which plane to use as the global triad plane.
MStatus setPoint (const MPoint &pointValue)
 Set the point manipulator value to the given vector.
MStatus setDirection (const MVector &direction)
 Sets the orientation of the FreePointTriadManip.
bool isDrawAxesOn (MStatus *ReturnStatus=NULL) const
 Returns whether or not the axes of the FreePointTriadManip are being drawn.
bool isSnapModeOn (MStatus *ReturnStatus=NULL) const
 Returns whether or not the FreePointTriadManip is in snap mode.
bool isKeyframeAllOn (MStatus *ReturnStatus=NULL) const
 Returns whether or not the FreePointTriadManip is in keyframeAll mode.
unsigned int pointIndex (MStatus *ReturnStatus=NULL) const
 Returns the index of the point of the FreePointTriadManip.
 MFnFreePointTriadManip (const MObject &object, MStatus *ret=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Member Enumeration Documentation

enum ManipPlane

Interaction plane for the manip center.

Enumerator:
kYZPlane 

Y-Z Plane.

kXZPlane 

X-Z Plane.

kXYPlane 

X-Y Plane.

kViewPlane 

View Plane.


Constructor & Destructor Documentation

~MFnFreePointTriadManip ( ) [virtual]

Destructor.

Class destructor.

MFnFreePointTriadManip ( MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

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

Parameters:
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:
MFnFreePointTriadManip ( const MDagPath object,
MStatus ReturnStatus = NULL 
)

Constructor.

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

Parameters:
[in]objectThe const MDagPath to attach the function set to
[out]ReturnStatusThe return status
Status Codes:
MFnFreePointTriadManip ( const MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

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

Parameters:
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:

Member Function Documentation

MFn::Type type ( ) const [virtual]

Function set type.

Return the class type : MFn::kFreePointTriadManip.

Reimplemented from MFnManip3D.

const char * className ( ) const [protected, virtual]

Class name.

Return the class name : "MFnFreePointTriadManip".

Reimplemented from MFnManip3D.

MObject create ( MStatus ReturnStatus = NULL)

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"

Parameters:
[out]ReturnStatusreturn status
Returns:
Newly created FreePointTriadManip
Status Codes:
MObject create ( const MString manipName,
const MString pointName,
MStatus ReturnStatus = NULL 
)

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.

Parameters:
[in]manipNameName of the manip for UI purposes.
[in]pointNameLabel for the position value which appears in the feedback line.
[out]ReturnStatusStatus code.
Returns:
Newly created FreePointTriadManip.
Status Codes:

Reimplemented from MFnDependencyNode.

MStatus connectToPointPlug ( MPlug pointPlug)

Connect to the point plug.

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

Parameters:
[in]pointPlugthe point plug
Returns:
MStatus setDrawAxes ( bool  state)

Sets whether or not to draw the axes of the FreePointTriadManip.

By default the axes are drawn.

Parameters:
[in]statewhether or not the axes should be drawn
Returns:
MStatus setSnapMode ( bool  state)

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

Parameters:
[in]statewhether or not the FreePointTriadManip should be in snap mode
Returns:
MStatus setKeyframeAll ( bool  state)

Sets whether or not keyframeAll is on.

Parameters:
[in]statewhether or not keyframeAll is on
Returns:
MStatus setDrawArrowHead ( bool  state)

Sets whether or not drawArrowHead is on.

Parameters:
[in]statewhether or not drawArrowHead is on
Returns:
MStatus setGlobalTriadPlane ( ManipPlane  whichPlane)

Sets which plane to use as the global triad plane.

The global triad plane does not change until the context switches.

Parameters:
[in]whichPlanewhich plane to use as the global triad plane
Returns:
MStatus setPoint ( const MPoint pointValue)

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.

Parameters:
[in]pointValueThe new value of the point manipValue
Returns:
MStatus setDirection ( const MVector direction)

Sets the orientation of the FreePointTriadManip.

Parameters:
[in]directionthe new direction for freePointTriadManip.
Returns:

call the methods from attr class to set the orientation

bool isDrawAxesOn ( MStatus ReturnStatus = NULL) const

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

By default the axes are drawn.

Parameters:
[out]ReturnStatusreturn status
Returns:
  • true the axes of the FreePointTriadManip are being drawn
  • false the axes of the FreePointTriadManip are not being drawn
Status Codes:
bool isSnapModeOn ( MStatus ReturnStatus = NULL) const

Returns whether or not the FreePointTriadManip is in snap mode.

Parameters:
[out]ReturnStatusreturn status
Returns:
  • true the FreePointTriadManip is in snap mode
  • false the FreePointTriadManip is not in snap mode
Status Codes:
bool isKeyframeAllOn ( MStatus ReturnStatus = NULL) const

Returns whether or not the FreePointTriadManip is in keyframeAll mode.

Parameters:
[out]ReturnStatusreturn status
Returns:
  • true the FreePointTriadManip is in keyframeAll mode
  • false the FreePointTriadManip is not in keyframeAll mode
Status Codes:
unsigned int pointIndex ( MStatus ReturnStatus = NULL) const

Returns the index of the point of the FreePointTriadManip.

The data type corresponding to this index is MFnNumericData::k3Double.

Parameters:
[out]ReturnStatusreturn status
Returns:
Point index
Status Codes:

MFnFreePointTriadManip MFnFreePointTriadManip MFnFreePointTriadManip MFnFreePointTriadManip MFnFreePointTriadManip MFnFreePointTriadManip MFnFreePointTriadManip MFnFreePointTriadManip MFnFreePointTriadManip MFnFreePointTriadManip
MFnFreePointTriadManip MFnFreePointTriadManip MFnFreePointTriadManip MFnFreePointTriadManip MFnFreePointTriadManip MFnFreePointTriadManip MFnFreePointTriadManip MFnFreePointTriadManip MFnFreePointTriadManip MFnFreePointTriadManip