MFnPointOnCurveManip Class Reference
[OpenMayaUI - API module for user interface, FunctionSet classes]

#include <MFnPointOnCurveManip.h>

Inheritance diagram for MFnPointOnCurveManip:

[legend]

Collaboration diagram for MFnPointOnCurveManip:

[legend]

List of all members.

---

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.

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)
MObject	create (const MString &manipName, const MString &paramName, MStatus *ReturnStatus=NULL)
MStatus	connectToCurvePlug (MPlug &curvePlug)
MStatus	connectToParamPlug (MPlug &paramPlug)
MStatus	setDrawCurve (bool state)
MStatus	setParameter (double parameter)
bool	isDrawCurveOn (MStatus *ReturnStatus=NULL) const
double	parameter (MStatus *ReturnStatus=NULL) const
MPoint	curvePoint (MStatus *ReturnStatus=NULL) const
unsigned int	curveIndex (MStatus *ReturnStatus=NULL) const
unsigned int	paramIndex (MStatus *ReturnStatus=NULL) const
	MFnPointOnCurveManip (const MObject &object, MStatus *ret=NULL)
	Constructor.
Protected Member Functions
virtual const char *	className () const
	Class name.

---

Constructor & Destructor Documentation

MFnPointOnCurveManip::~MFnPointOnCurveManip

(

)

[virtual]

Destructor.

Class destructor.

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

• MS::kSuccess if the function set is successfully attached
• MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

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

• MS::kSuccess if the function set is successfully attached
• MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

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

• MS::kSuccess if the function set is successfully attached
• MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

---

Member Function Documentation

MFn::Type MFnPointOnCurveManip::type

(

)

const [virtual]

Function set type.

Return the class type : MFn::kPointOnCurveManip

Reimplemented from MFnManip3D.

const char * MFnPointOnCurveManip::className

(

)

const [protected, virtual]

Class name.

Return the class name : "MFnPointOnCurveManip"

Reimplemented from MFnManip3D.

MObject MFnPointOnCurveManip::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]

ReturnStatus

return status

Returns:

Newly created PointOnCurveManip

Status Codes:

• MS::kSuccess operation successful
• MS::kFailure operation failed

MObject MFnPointOnCurveManip::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]	paramName	the name that appears in the feedback line
[out]	ReturnStatus	return status

Returns:

Newly created PointOnCurveManip

Status Codes:

• MS::kSuccess operation successful
• MS::kFailure operation failed

Reimplemented from MFnDependencyNode.

MStatus MFnPointOnCurveManip::connectToCurvePlug

(

MPlug &

curvePlug

)

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

Parameters:

[in]

curvePlug

the curve plug

Returns:

• MS::kSuccess operation successful
• MS::kFailure operation failed

MStatus MFnPointOnCurveManip::connectToParamPlug

(

MPlug &

paramPlug

)

Connect to the param plug. The data type corresponding to the paramPlug is a double.

Parameters:

[in]

paramPlug

the param plug

Returns:

• MS::kSuccess operation successful
• MS::kFailure operation failed

MStatus MFnPointOnCurveManip::setDrawCurve

(

bool

state

)

Sets whether or not the curve is drawn.

Parameters:

[in]

state

whether or not the curve should be drawn

Returns:

• MS::kSuccess operation successful
• MS::kFailure operation failed

MStatus MFnPointOnCurveManip::setParameter

(

double

parameter

)

Sets the parameter.

Parameters:

[in]

parameter

the parameter

Returns:

• MS::kSuccess operation successful
• MS::kFailure operation failed

bool MFnPointOnCurveManip::isDrawCurveOn

(

MStatus *

ReturnStatus = NULL

)

const

Returns whether or not the curve is drawn.

Parameters:

[out]

ReturnStatus

return status

Returns:

• true the curve is being drawn
• false the curve is not being drawn

Status Codes:

• MS::kSuccess operation successful
• MS::kFailure operation failed

double MFnPointOnCurveManip::parameter

(

MStatus *

ReturnStatus = NULL

)

const

Returns the parameter.

Parameters:

[out]

ReturnStatus

return status

Returns:

Parameter

Status Codes:

• MS::kSuccess operation successful
• MS::kFailure operation failed

MPoint MFnPointOnCurveManip::curvePoint

(

MStatus *

ReturnStatus = NULL

)

const

Returns the curve point.

Parameters:

[out]

ReturnStatus

return status

Returns:

The curve point

Status Codes:

• MS::kSuccess operation successful
• MS::kFailure operation failed

unsigned int MFnPointOnCurveManip::curveIndex

(

MStatus *

ReturnStatus = NULL

)

const

Returns the index of the curve. The data type corresponding to this index is MFnData::kNurbsCurve.

Parameters:

[out]

ReturnStatus

return status

Returns:

Curve index

Status Codes:

• MS::kSuccess operation successful
• MS::kFailure operation failed

unsigned int MFnPointOnCurveManip::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]

ReturnStatus

return status

Returns:

Parameter index

Status Codes:

• MS::kSuccess operation successful
• MS::kFailure operation failed