Public Member Functions | Protected Member Functions

MFnCircleSweepManip 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

CircleSweepManip function set.

The CircleSweepManip allows the user to manipulate a point constrained to move around a circle, in order to specify a sweep angle. This manipulator generates a single floating point value corresponding to the sweep angle.

Examples:

swissArmyManip.cpp.

#include <MFnCircleSweepManip.h>

Inheritance diagram for MFnCircleSweepManip:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnCircleSweepManip ()
 Destructor.
 MFnCircleSweepManip ()
 Default constructor.
 MFnCircleSweepManip (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
 MFnCircleSweepManip (const MDagPath &object, MStatus *ret=NULL)
 Constructor.
MObject create (MStatus *ReturnStatus=NULL)
 Creates a new CircleSweepManip.
MObject create (const MString &manipName, const MString &angleName, MStatus *ReturnStatus=NULL)
 Creates a new CircleSweepManip.
MStatus connectToAnglePlug (MPlug &anglePlug)
 Connect to the angle plug.
MStatus setCenterPoint (const MPoint &centerPoint)
 Sets the center point of the CircleSweepManip.
MStatus setStartPoint (const MPoint &startPoint)
 Sets the start point of the CircleSweepManip.
MStatus setEndPoint (const MPoint &endPoint)
 Sets the end point of the CircleSweepManip.
MStatus setNormal (const MVector &normal)
 Sets the normal of the CircleSweepManip.
MStatus setRadius (double radius)
 Sets the radius of the CircleSweepManip.
MStatus setAngle (MAngle angle)
 Sets the angle of the CircleSweepManip.
MStatus setDrawAsArc (bool state)
 Sets whether or not to draw as arc.
MPoint startPoint (MStatus *ReturnStatus=NULL) const
 Returns the start point.
MPoint endPoint (MStatus *ReturnStatus=NULL) const
 Returns the end point.
unsigned int centerIndex (MStatus *ReturnStatus=NULL) const
 Returns the index for the center of the CircleSweepManip.
unsigned int axisIndex (MStatus *ReturnStatus=NULL) const
 Returns the index for the axis of CircleSweepManip.
unsigned int angleIndex (MStatus *ReturnStatus=NULL) const
 Returns the index for the angle of CircleSweepManip.
unsigned int startCircleIndex (MStatus *ReturnStatus=NULL) const
 Returns the index for the start of the circle of CircleSweepManip.
unsigned int endCircleIndex (MStatus *ReturnStatus=NULL) const
 Returns the index for the end of the circle of CircleSweepManip.
 MFnCircleSweepManip (const MObject &object, MStatus *ret=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

~MFnCircleSweepManip ( ) [virtual]

Destructor.

Class destructor.

MFnCircleSweepManip ( 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:
MFnCircleSweepManip ( 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:
MFnCircleSweepManip ( 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::kCircleSweepManip.

Reimplemented from MFnManip3D.

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

Class name.

Return the class name : "MFnCircleSweepManip".

Reimplemented from MFnManip3D.

MObject create ( MStatus ReturnStatus = NULL)

Creates a new CircleSweepManip.

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

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

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

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

Creates a new CircleSweepManip.

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

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

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 CircleSweepManip.
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 CircleSweepManip.

Parameters:
[in]centerPointthe center point of the CircleSweepManip
Returns:
MStatus setStartPoint ( const MPoint startPoint)

Sets the start point of the CircleSweepManip.

Parameters:
[in]startPointthe start point of the CircleSweepManip
Returns:
MStatus setEndPoint ( const MPoint endPoint)

Sets the end point of the CircleSweepManip.

Parameters:
[in]endPointthe end point of the CircleSweepManip
Returns:
MStatus setNormal ( const MVector normal)

Sets the normal of the CircleSweepManip.

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

Sets the radius of the CircleSweepManip.

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

Sets the angle of the CircleSweepManip.

Parameters:
[in]anglethe angle of the CircleSweepManip
Returns:
MStatus setDrawAsArc ( bool  state)

Sets whether or not to draw as arc.

Parameters:
[in]statewhether or not to draw as arc
Returns:
MPoint startPoint ( MStatus ReturnStatus = NULL) const

Returns the start point.

Parameters:
[out]ReturnStatusreturn status
Returns:
The start point
Status Codes:
MPoint endPoint ( MStatus ReturnStatus = NULL) const

Returns the end point.

Parameters:
[out]ReturnStatusreturn status
Returns:
The end point
Status Codes:
unsigned int centerIndex ( MStatus ReturnStatus = NULL) const

Returns the index for the center of the CircleSweepManip.

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

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

Returns the index for the axis of CircleSweepManip.

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

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

Returns the index for the angle of CircleSweepManip.

The data type corresponding to this index is a double.

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

Returns the index for the start of the circle of CircleSweepManip.

The data type corresponding to this index is a double.

Parameters:
[out]ReturnStatusreturn status
Returns:
The circle start index
Status Codes:
unsigned int endCircleIndex ( MStatus ReturnStatus = NULL) const

Returns the index for the end of the circle of CircleSweepManip.

The data type corresponding to this index is a double.

Parameters:
[out]ReturnStatusreturn status
Returns:
The circle end index
Status Codes:

MFnCircleSweepManip MFnCircleSweepManip MFnCircleSweepManip MFnCircleSweepManip MFnCircleSweepManip MFnCircleSweepManip MFnCircleSweepManip MFnCircleSweepManip MFnCircleSweepManip MFnCircleSweepManip
MFnCircleSweepManip MFnCircleSweepManip MFnCircleSweepManip MFnCircleSweepManip MFnCircleSweepManip MFnCircleSweepManip MFnCircleSweepManip MFnCircleSweepManip MFnCircleSweepManip MFnCircleSweepManip