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

#include <MFnCircleSweepManip.h>
Inheritance diagram for MFnCircleSweepManip:
Inheritance graph
[legend]
Collaboration diagram for MFnCircleSweepManip:
Collaboration graph
[legend]

List of all members.


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.


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

Protected Member Functions

virtual const char *  className () const
  Class name.

Constructor & Destructor Documentation

MFnCircleSweepManip::~MFnCircleSweepManip (  )  [virtual]

Destructor.

Class destructor.

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

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

MFnCircleSweepManip::MFnCircleSweepManip ( 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 MFnCircleSweepManip::type (  )  const [virtual]

Function set type.

Return the class type : MFn::kCircleSweepManip

Reimplemented from MFnManip3D.

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

Class name.

Return the class name : "MFnCircleSweepManip"

Reimplemented from MFnManip3D.

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

MObject MFnCircleSweepManip::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]  manipName  Name of the manip for UI purposes.
[in]  angleName  Label for the angle value which appears in the feedback line.
[out]  ReturnStatus  Status code.
Returns:
Newly created CircleSweepManip.
Status Codes:

Reimplemented from MFnDependencyNode.

MStatus MFnCircleSweepManip::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 MFnCircleSweepManip::setCenterPoint ( const MPoint centerPoint  ) 

Sets the center point of the CircleSweepManip.

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

MStatus MFnCircleSweepManip::setStartPoint ( const MPoint startPoint  ) 

Sets the start point of the CircleSweepManip.

Parameters:
[in]  startPoint  the start point of the CircleSweepManip
Returns:

MStatus MFnCircleSweepManip::setEndPoint ( const MPoint endPoint  ) 

Sets the end point of the CircleSweepManip.

Parameters:
[in]  endPoint  the end point of the CircleSweepManip
Returns:

MStatus MFnCircleSweepManip::setNormal ( const MVector normal  ) 

Sets the normal of the CircleSweepManip.

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

MStatus MFnCircleSweepManip::setRadius ( double  radius  ) 

Sets the radius of the CircleSweepManip.

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

MStatus MFnCircleSweepManip::setAngle ( MAngle  angle  ) 

Sets the angle of the CircleSweepManip.

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

MStatus MFnCircleSweepManip::setDrawAsArc ( bool  state  ) 

Sets whether or not to draw as arc.

Parameters:
[in]  state  whether or not to draw as arc
Returns:

MPoint MFnCircleSweepManip::startPoint ( MStatus ReturnStatus = NULL  )  const

Returns the start point.

Parameters:
[out]  ReturnStatus  return status
Returns:
The start point
Status Codes:

MPoint MFnCircleSweepManip::endPoint ( MStatus ReturnStatus = NULL  )  const

Returns the end point.

Parameters:
[out]  ReturnStatus  return status
Returns:
The end point
Status Codes:

unsigned int MFnCircleSweepManip::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]  ReturnStatus  return status
Returns:
The center index
Status Codes:

unsigned int MFnCircleSweepManip::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]  ReturnStatus  return status
Returns:
The axis index
Status Codes:

unsigned int MFnCircleSweepManip::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]  ReturnStatus  return status
Returns:
The angle index
Status Codes:

unsigned int MFnCircleSweepManip::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]  ReturnStatus  return status
Returns:
The circle start index
Status Codes:

unsigned int MFnCircleSweepManip::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]  ReturnStatus  return status
Returns:
The circle end index
Status Codes:

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