Public Member Functions | Protected Member Functions

MFnDiscManip 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

DiscManip function set.

The DiscManip allows the user to rotate a disc in order to specify a rotation about an axis. This manipulator generates a single floating point value corresponding to the rotation.

Examples:

swissArmyManip.cpp.

#include <MFnDiscManip.h>

Inheritance diagram for MFnDiscManip:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnDiscManip ()
 Destructor.
 MFnDiscManip ()
 Default constructor.
 MFnDiscManip (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
 MFnDiscManip (const MDagPath &object, MStatus *ret=NULL)
 Constructor.
MObject create (MStatus *ReturnStatus=NULL)
 Creates a new DiscManip.
MObject create (const MString &manipName, const MString &angleName, MStatus *ReturnStatus=NULL)
 Creates a new DiscManip.
MStatus connectToAnglePlug (MPlug &anglePlug)
 Connect to the angle plug.
MStatus setCenterPoint (const MPoint &centerPoint)
 Sets the center point of the DiscManip.
MStatus setNormal (const MVector &normal)
 Sets the normal of the DiscManip.
MStatus setRadius (double radius)
 Sets the radius of the DiscManip.
MStatus setAngle (MAngle angle)
 Sets the angle of the DiscManip.
unsigned int centerIndex (MStatus *ReturnStatus=NULL) const
 Returns the index of the center of the DiscManip.
unsigned int axisIndex (MStatus *ReturnStatus=NULL) const
 Returns the index of the axis of the DiscManip.
unsigned int angleIndex (MStatus *ReturnStatus=NULL) const
 Returns the index of the angle.
 MFnDiscManip (const MObject &object, MStatus *ret=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

~MFnDiscManip ( ) [virtual]

Destructor.

Class destructor.

MFnDiscManip ( 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:
MFnDiscManip ( 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:
MFnDiscManip ( 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::kDiscManip.

Reimplemented from MFnManip3D.

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

Class name.

Return the class name : "MFnDiscManip".

Reimplemented from MFnManip3D.

MObject create ( MStatus ReturnStatus = NULL)

Creates a new DiscManip.

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

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

The name that appears in the feedback line is "Disc"

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

Creates a new DiscManip.

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

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

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

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

Reimplemented from MFnDependencyNode.

MStatus connectToAnglePlug ( MPlug anglePlug)

Connect to the angle plug.

The data type corresponding to the anglePlug is a double. (Note that MFnUnitAttribute::kAngle is used to specify an angle attribute.)

Parameters:
[in]anglePlugthe angle plug
Returns:
MStatus setCenterPoint ( const MPoint centerPoint)

Sets the center point of the DiscManip.

Parameters:
[in]centerPointthe center point of the DiscManip
Returns:
MStatus setNormal ( const MVector normal)

Sets the normal of the DiscManip.

Parameters:
[in]normalthe normal of the DiscManip
Returns:
MStatus setRadius ( double  radius)

Sets the radius of the DiscManip.

Parameters:
[in]radiusthe radius of the DiscManip
Returns:
MStatus setAngle ( MAngle  angle)

Sets the angle of the DiscManip.

Parameters:
[in]anglethe angle of the DiscManip
Returns:
unsigned int centerIndex ( MStatus ReturnStatus = NULL) const

Returns the index of the center of the DiscManip.

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

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

Returns the index of the axis of the DiscManip.

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

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

Returns the index of the angle.

The data type corresponding to this index is a double.

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

MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip
MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip MFnDiscManip