Public Member Functions | Protected Member Functions

MFnCurveSegmentManip 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

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.

#include <MFnCurveSegmentManip.h>

Inheritance diagram for MFnCurveSegmentManip:
Inheritance graph
[legend]

List of all members.

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)
 Creates a new CurveSegmentManip.
MObject create (const MString &manipName, const MString &startParamName, const MString &endParamName, MStatus *ReturnStatus=NULL)
 Creates a new CurveSegmentManip.
MStatus connectToCurvePlug (MPlug &curvePlug)
 Connect to the curve plug.
MStatus connectToStartParamPlug (MPlug &startParamPlug)
 Connect to the startParam plug.
MStatus connectToEndParamPlug (MPlug &endParamPlug)
 Connect to the endParam plug.
MStatus setStartParameter (double startParameter)
 Sets the start parameter.
MStatus setEndParameter (double endParameter)
 Sets the end parameter.
double startParameter (MStatus *ReturnStatus=NULL) const
 Returns the start parameter.
double endParameter (MStatus *ReturnStatus=NULL) const
 Returns the end parameter.
unsigned int curveIndex (MStatus *ReturnStatus=NULL) const
 Returns the index of the curve.
unsigned int startParamIndex (MStatus *ReturnStatus=NULL) const
 Returns the index of the start parameter of the CurveSegmentManip.
unsigned int endParamIndex (MStatus *ReturnStatus=NULL) const
 Returns the index of the end parameter of the CurveSegmentManip.
 MFnCurveSegmentManip (const MObject &object, MStatus *ret=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

~MFnCurveSegmentManip ( ) [virtual]

Destructor.

Class destructor.

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

Reimplemented from MFnManip3D.

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

Class name.

Return the class name : "MFnCurveSegmentManip".

Reimplemented from MFnManip3D.

MObject 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]ReturnStatusreturn status
Returns:
Newly created CurveSegmentManip
Status Codes:
MObject 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]manipNameName of the manip for UI purposes.
[in]startParamNameLabel for the startParam value which appears in the feedback line.
[in]endParamNameLabel for the endParam value which appears in the feedback line.
[out]ReturnStatusStatus code.
Returns:
Newly created CurveSegmentManip.
Status Codes:
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 connectToStartParamPlug ( MPlug startParamPlug)

Connect to the startParam plug.

The data type corresponding to the startParamPlug is a double.

Parameters:
[in]startParamPlugthe startParam plug
Returns:
MStatus connectToEndParamPlug ( MPlug endParamPlug)

Connect to the endParam plug.

The data type corresponding to the endParamPlug is a double.

Parameters:
[in]endParamPlugthe endParam plug
Returns:
MStatus setStartParameter ( double  startParameter)

Sets the start parameter.

Parameters:
[in]startParameterthe start parameter
Returns:
MStatus setEndParameter ( double  endParameter)

Sets the end parameter.

Parameters:
[in]endParameterthe end parameter
Returns:
double startParameter ( MStatus ReturnStatus = NULL) const

Returns the start parameter.

Parameters:
[out]ReturnStatusreturn status
Returns:
  • start parameter
Status Codes:
double endParameter ( MStatus ReturnStatus = NULL) const

Returns the end parameter.

Parameters:
[out]ReturnStatusreturn status
Returns:
End parameter
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 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]ReturnStatusreturn status
Returns:
Start parameter index
Status Codes:
unsigned int 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]ReturnStatusreturn status
Returns:
End parameter index
Status Codes:

MFnCurveSegmentManip MFnCurveSegmentManip MFnCurveSegmentManip MFnCurveSegmentManip MFnCurveSegmentManip MFnCurveSegmentManip MFnCurveSegmentManip MFnCurveSegmentManip MFnCurveSegmentManip MFnCurveSegmentManip
MFnCurveSegmentManip MFnCurveSegmentManip MFnCurveSegmentManip MFnCurveSegmentManip MFnCurveSegmentManip MFnCurveSegmentManip MFnCurveSegmentManip MFnCurveSegmentManip MFnCurveSegmentManip MFnCurveSegmentManip