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

#include <MFnCurveSegmentManip.h>

Inheritance diagram for MFnCurveSegmentManip:

[legend]

Collaboration diagram for MFnCurveSegmentManip:

[legend]

List of all members.

---

Detailed Description

CurveSegmentManip function set.

The CurveSegmentManip allows the user to manipulate two points on a curve, in order to specify a curve segment. This manipulator generates two floating point values, which correspond to the parameters of the start and end of the curve segment.

Public Member Functions
virtual MFn::Type	type () const
	Function set type.
virtual	~MFnCurveSegmentManip ()
	Destructor.
	MFnCurveSegmentManip ()
	Default constructor.
	MFnCurveSegmentManip (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor.
	MFnCurveSegmentManip (const MDagPath &object, MStatus *ret=NULL)
	Constructor.
MObject	create (MStatus *ReturnStatus=NULL)
MObject	create (const MString &manipName, const MString &startParamName, const MString &endParamName, MStatus *ReturnStatus=NULL)
MStatus	connectToCurvePlug (MPlug &curvePlug)
MStatus	connectToStartParamPlug (MPlug &startParamPlug)
MStatus	connectToEndParamPlug (MPlug &endParamPlug)
MStatus	setStartParameter (double startParameter)
MStatus	setEndParameter (double endParameter)
double	startParameter (MStatus *ReturnStatus=NULL) const
double	endParameter (MStatus *ReturnStatus=NULL) const
unsigned int	curveIndex (MStatus *ReturnStatus=NULL) const
unsigned int	startParamIndex (MStatus *ReturnStatus=NULL) const
unsigned int	endParamIndex (MStatus *ReturnStatus=NULL) const
	MFnCurveSegmentManip (const MObject &object, MStatus *ret=NULL)
	Constructor.
Protected Member Functions
virtual const char *	className () const
	Class name.

---

Constructor & Destructor Documentation

MFnCurveSegmentManip::~MFnCurveSegmentManip

(

)

[virtual]

Destructor.

Class destructor.

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

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

MFnCurveSegmentManip::MFnCurveSegmentManip	(	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 MFnCurveSegmentManip::type

(

)

const [virtual]

Function set type.

Return the class type : MFn::kCurveSegmentManip

Reimplemented from MFnManip3D.

const char * MFnCurveSegmentManip::className

(

)

const [protected, virtual]

Class name.

Return the class name : "MFnCurveSegmentManip"

Reimplemented from MFnManip3D.

MObject MFnCurveSegmentManip::create

(

MStatus *

ReturnStatus = NULL

)

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

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

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

Parameters:

[out]

ReturnStatus

return status

Returns:

Newly created CurveSegmentManip

Status Codes:

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

MObject MFnCurveSegmentManip::create	(	const MString &	manipName,
		const MString &	startParamName,
		const MString &	endParamName,
		MStatus *	ReturnStatus = NULL
	)

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

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

The names that appears in the feedback line are specified by the startParamName and endParamName arguments.

Parameters:

[in]	manipName	Name of the manip for UI purposes.
[in]	startParamName	Label for the startParam value which appears in the feedback line.
[in]	endParamName	Label for the endParam value which appears in the feedback line.
[out]	ReturnStatus	Status code.

Returns:

Newly created CurveSegmentManip.

Status Codes:

• MS::kSuccess Operation successful.
• MS::kFailure Operation failed.

MStatus MFnCurveSegmentManip::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 MFnCurveSegmentManip::connectToStartParamPlug

(

MPlug &

startParamPlug

)

Connect to the startParam plug. The data type corresponding to the startParamPlug is a double.

Parameters:

[in]

startParamPlug

the startParam plug

Returns:

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

MStatus MFnCurveSegmentManip::connectToEndParamPlug

(

MPlug &

endParamPlug

)

Connect to the endParam plug. The data type corresponding to the endParamPlug is a double.

Parameters:

[in]

endParamPlug

the endParam plug

Returns:

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

MStatus MFnCurveSegmentManip::setStartParameter

(

double

startParameter

)

Sets the start parameter.

Parameters:

[in]

startParameter

the start parameter

Returns:

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

MStatus MFnCurveSegmentManip::setEndParameter

(

double

endParameter

)

Sets the end parameter.

Parameters:

[in]

endParameter

the end parameter

Returns:

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

double MFnCurveSegmentManip::startParameter

(

MStatus *

ReturnStatus = NULL

)

const

Returns the start parameter.

Parameters:

[out]

ReturnStatus

return status

Returns:

• start parameter

Status Codes:

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

double MFnCurveSegmentManip::endParameter

(

MStatus *

ReturnStatus = NULL

)

const

Returns the end parameter.

Parameters:

[out]

ReturnStatus

return status

Returns:

End parameter

Status Codes:

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

unsigned int MFnCurveSegmentManip::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 MFnCurveSegmentManip::startParamIndex

(

MStatus *

ReturnStatus = NULL

)

const

Returns the index of the start parameter of the CurveSegmentManip. The data type corresponding to this index is a double.

Parameters:

[out]

ReturnStatus

return status

Returns:

Start parameter index

Status Codes:

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

unsigned int MFnCurveSegmentManip::endParamIndex

(

MStatus *

ReturnStatus = NULL

)

const

Returns the index of the end parameter of the CurveSegmentManip. The data type corresponding this index is a double.

Parameters:

[out]

ReturnStatus

return status

Returns:

End parameter index

Status Codes:

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