Public Member Functions | Protected Member Functions

MFnDirectionManip 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

DirectionManip function set.

The DirectionManip allows the user to specify a direction, as defined by the vector from the start point to the manipulator position. It uses a FreePointTriadManip to specify the end point of a vector relative to a given start point. This manipulator generates a vector from the start point to the end point.

Examples:

swissArmyManip.cpp.

#include <MFnDirectionManip.h>

Inheritance diagram for MFnDirectionManip:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnDirectionManip ()
 Destructor.
 MFnDirectionManip ()
 Default constructor.
 MFnDirectionManip (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
 MFnDirectionManip (const MDagPath &object, MStatus *ret=NULL)
 Constructor.
MObject create (MStatus *ReturnStatus=NULL)
 Creates a new DirectionManip.
MObject create (const MString &manipName, const MString &directionName, MStatus *ReturnStatus=NULL)
 Creates a new DirectionManip.
MStatus connectToDirectionPlug (MPlug &directionPlug)
 Connect to the direction plug.
MStatus setNormalizeDirection (bool state)
 Sets whether or not to the direction should be normalized.
MStatus setDrawStart (bool state)
 Sets whether or not to draw the start of the DirectionManip.
MStatus setStartPoint (MPoint &startPoint)
 Sets the start point of the DirectionManip.
MStatus setDirection (MVector &direction)
 Sets the direction of the DirectionManip.
unsigned int startPointIndex (MStatus *ReturnStatus=NULL) const
 Returns the index of the start point of the DirectionManip.
unsigned int endPointIndex (MStatus *ReturnStatus=NULL) const
 Returns the index of the end point of the DirectionManip.
unsigned int directionIndex (MStatus *ReturnStatus=NULL) const
 Returns the index of the direction.
 MFnDirectionManip (const MObject &object, MStatus *ret=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

~MFnDirectionManip ( ) [virtual]

Destructor.

Class destructor.

MFnDirectionManip ( 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:
MFnDirectionManip ( 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:
MFnDirectionManip ( 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::kDirectionManip.

Reimplemented from MFnManip3D.

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

Class name.

Return the class name : "MFnDirectionManip".

Reimplemented from MFnManip3D.

MObject create ( MStatus ReturnStatus = NULL)

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

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

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.

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

Reimplemented from MFnDependencyNode.

MStatus connectToDirectionPlug ( MPlug directionPlug)

Connect to the direction plug.

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

Parameters:
[in]directionPlugthe direction plug
Returns:
Examples:
swissArmyManip.cpp.
MStatus setNormalizeDirection ( bool  state)

Sets whether or not to the direction should be normalized.

By default the direction is normalized.

Parameters:
[in]statewhether or not the direction should be normalized
Returns:
MStatus setDrawStart ( bool  state)

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.

Parameters:
[in]statewhether or not the start should be drawn
Returns:
MStatus setStartPoint ( MPoint startPoint)

Sets the start point of the DirectionManip.

Parameters:
[in]startPointthe start point of the DirectionManip
Returns:
MStatus setDirection ( MVector direction)

Sets the direction of the DirectionManip.

Parameters:
[in]directionthe direction of the DirectionManip
Returns:
unsigned int startPointIndex ( MStatus ReturnStatus = NULL) const

Returns the index of the start point of the DirectionManip.

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

Parameters:
[out]ReturnStatusreturn status
Returns:
Start point index
Status Codes:
Examples:
swissArmyManip.cpp.
unsigned int endPointIndex ( MStatus ReturnStatus = NULL) const

Returns the index of the end point of the DirectionManip.

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

Parameters:
[out]ReturnStatusreturn status
Returns:
End point index
Status Codes:
unsigned int directionIndex ( MStatus ReturnStatus = NULL) const

Returns the index of the direction.

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

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

MFnDirectionManip MFnDirectionManip MFnDirectionManip MFnDirectionManip MFnDirectionManip MFnDirectionManip MFnDirectionManip MFnDirectionManip MFnDirectionManip MFnDirectionManip
MFnDirectionManip MFnDirectionManip MFnDirectionManip MFnDirectionManip MFnDirectionManip MFnDirectionManip MFnDirectionManip MFnDirectionManip MFnDirectionManip MFnDirectionManip