MFnDiscManip Class Reference
[OpenMayaUI - API module for user interfaceFunctionSet classes]

#include <MFnDiscManip.h>

Inheritance diagram for MFnDiscManip:

Inheritance graph
[legend]
Collaboration diagram for MFnDiscManip:

Collaboration graph
[legend]

List of all members.


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.


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)
MObject create (const MString &manipName, const MString &angleName, MStatus *ReturnStatus=NULL)
MStatus connectToAnglePlug (MPlug &anglePlug)
MStatus setCenterPoint (const MPoint &centerPoint)
MStatus setNormal (const MVector &normal)
MStatus setRadius (double radius)
MStatus setAngle (MAngle angle)
unsigned int centerIndex (MStatus *ReturnStatus=NULL) const
unsigned int axisIndex (MStatus *ReturnStatus=NULL) const
unsigned int angleIndex (MStatus *ReturnStatus=NULL) const
 MFnDiscManip (const MObject &object, MStatus *ret=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

MFnDiscManip::~MFnDiscManip (  )  [virtual]

Destructor.

Class destructor.

MFnDiscManip::MFnDiscManip ( MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

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

Parameters:
[in] object The MObject to attach the function set to
[out] ReturnStatus the return status
Status Codes:

MFnDiscManip::MFnDiscManip ( const MDagPath object,
MStatus ReturnStatus = NULL 
)

Constructor.

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

Parameters:
[in] object The const MDagPath to attach the function set to
[out] ReturnStatus The return status
Status Codes:

MFnDiscManip::MFnDiscManip ( const MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

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

Parameters:
[in] object The MObject to attach the function set to
[out] ReturnStatus the return status
Status Codes:


Member Function Documentation

MFn::Type MFnDiscManip::type (  )  const [virtual]

Function set type.

Return the class type : MFn::kDiscManip

Reimplemented from MFnManip3D.

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

Class name.

Return the class name : "MFnDiscManip"

Reimplemented from MFnManip3D.

MObject MFnDiscManip::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] ReturnStatus return status
Returns:
Newly created DiscManip
Status Codes:

MObject MFnDiscManip::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] angleName the name that appears in the feedback line
[out] ReturnStatus return status
Returns:
Newly created DiscManip
Status Codes:

Reimplemented from MFnDependencyNode.

MStatus MFnDiscManip::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] anglePlug the angle plug
Returns:

MStatus MFnDiscManip::setCenterPoint ( const MPoint centerPoint  ) 

Sets the center point of the DiscManip.

Parameters:
[in] centerPoint the center point of the DiscManip
Returns:

MStatus MFnDiscManip::setNormal ( const MVector normal  ) 

Sets the normal of the DiscManip.

Parameters:
[in] normal the normal of the DiscManip
Returns:

MStatus MFnDiscManip::setRadius ( double  radius  ) 

Sets the radius of the DiscManip.

Parameters:
[in] radius the radius of the DiscManip
Returns:

MStatus MFnDiscManip::setAngle ( MAngle  angle  ) 

Sets the angle of the DiscManip.

Parameters:
[in] angle the angle of the DiscManip
Returns:

unsigned int MFnDiscManip::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] ReturnStatus return status
Returns:
Center index
Status Codes:

unsigned int MFnDiscManip::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] ReturnStatus return status
Returns:
Axis index
Status Codes:

unsigned int MFnDiscManip::angleIndex ( MStatus ReturnStatus = NULL  )  const

Returns the index of the angle. The data type corresponding to this index is a double.

Parameters:
[out] ReturnStatus return status
Returns:
Angle index
Status Codes:


Autodesk® Maya® 2009 © 1997-2008 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6