Public Member Functions | Protected Member Functions

MFnPointOnCurveManip 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

PointOnCurveManip function set.

The PointOnCurveManip allows the user to manipulate a point constrained to move along a curve, in order to specify the "u" curve parameter value. This manipulator generates a single floating point value corresponding to the curve parameter.

#include <MFnPointOnCurveManip.h>

Inheritance diagram for MFnPointOnCurveManip:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnPointOnCurveManip ()
 Destructor.
 MFnPointOnCurveManip ()
 Default constructor.
 MFnPointOnCurveManip (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
 MFnPointOnCurveManip (const MDagPath &object, MStatus *ret=NULL)
 Constructor.
MObject create (MStatus *ReturnStatus=NULL)
 Creates a new PointOnCurveManip.
MObject create (const MString &manipName, const MString &paramName, MStatus *ReturnStatus=NULL)
 Creates a new PointOnCurveManip.
MStatus connectToCurvePlug (MPlug &curvePlug)
 Connect to the curve plug.
MStatus connectToParamPlug (MPlug &paramPlug)
 Connect to the param plug.
MStatus setDrawCurve (bool state)
 Sets whether or not the curve is drawn.
MStatus setParameter (double parameter)
 Sets the parameter.
bool isDrawCurveOn (MStatus *ReturnStatus=NULL) const
 Returns whether or not the curve is drawn.
double parameter (MStatus *ReturnStatus=NULL) const
 Returns the parameter.
MPoint curvePoint (MStatus *ReturnStatus=NULL) const
 Returns the curve point.
unsigned int curveIndex (MStatus *ReturnStatus=NULL) const
 Returns the index of the curve.
unsigned int paramIndex (MStatus *ReturnStatus=NULL) const
 Returns the index of the parameter of the PointOnCurveManip.
 MFnPointOnCurveManip (const MObject &object, MStatus *ret=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

~MFnPointOnCurveManip ( ) [virtual]

Destructor.

Class destructor.

MFnPointOnCurveManip ( 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:
MFnPointOnCurveManip ( 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:
MFnPointOnCurveManip ( 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::kPointOnCurveManip.

Reimplemented from MFnManip3D.

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

Class name.

Return the class name : "MFnPointOnCurveManip".

Reimplemented from MFnManip3D.

MObject create ( MStatus ReturnStatus = NULL)

Creates a new PointOnCurveManip.

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

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

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

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

Creates a new PointOnCurveManip.

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

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

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

Parameters:
[in]manipNameName of the manip for UI purposes.
[in]paramNameLabel for the parameter value that appears in the feedback line.
[out]ReturnStatusStatus code.
Returns:
Newly created PointOnCurveManip.
Status Codes:

Reimplemented from MFnDependencyNode.

MStatus connectToCurvePlug ( MPlug curvePlug)

Connect to the curve plug.

The data type corresponding to the curvePlug is MFnData::kNurbsCurve.

Parameters:
[in]curvePlugthe curve plug
Returns:
MStatus connectToParamPlug ( MPlug paramPlug)

Connect to the param plug.

The data type corresponding to the paramPlug is a double.

Parameters:
[in]paramPlugthe param plug
Returns:
MStatus setDrawCurve ( bool  state)

Sets whether or not the curve is drawn.

Parameters:
[in]statewhether or not the curve should be drawn
Returns:
MStatus setParameter ( double  parameter)

Sets the parameter.

Parameters:
[in]parameterthe parameter
Returns:
bool isDrawCurveOn ( MStatus ReturnStatus = NULL) const

Returns whether or not the curve is drawn.

Parameters:
[out]ReturnStatusreturn status
Returns:
  • true the curve is being drawn
  • false the curve is not being drawn
Status Codes:
double parameter ( MStatus ReturnStatus = NULL) const

Returns the parameter.

Parameters:
[out]ReturnStatusreturn status
Returns:
Parameter
Status Codes:
MPoint curvePoint ( MStatus ReturnStatus = NULL) const

Returns the curve point.

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

Returns the index of the curve.

The data type corresponding to this index is MFnData::kNurbsCurve.

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

Returns the index of the parameter of the PointOnCurveManip.

The data type corresponding to this index is a double.

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

MFnPointOnCurveManip MFnPointOnCurveManip MFnPointOnCurveManip MFnPointOnCurveManip MFnPointOnCurveManip MFnPointOnCurveManip MFnPointOnCurveManip MFnPointOnCurveManip MFnPointOnCurveManip MFnPointOnCurveManip
MFnPointOnCurveManip MFnPointOnCurveManip MFnPointOnCurveManip MFnPointOnCurveManip MFnPointOnCurveManip MFnPointOnCurveManip MFnPointOnCurveManip MFnPointOnCurveManip MFnPointOnCurveManip MFnPointOnCurveManip