#include
<MFnCircleSweepManip.h>
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.
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] |
const char *
MFnCircleSweepManip::className |
( |
|
) |
const [protected, virtual] |
Class name.
Return the class name : "MFnCircleSweepManip"
Reimplemented from MFnManip3D.
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:
-
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:
-
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:
-
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:
-