Public Member Functions | Protected Member Functions

MFnPointOnSurfaceManip 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

PointOnSurfaceManip function set.

The PointOnSurfaceManip allows the user to manipulate a point constrained to move along a surface, in order to specify the (u, v) surface parameter values. This manipulator generates two floating point values corresponding to the surface (u, v) parameters.

Examples:

surfaceBumpManip.cpp.

#include <MFnPointOnSurfaceManip.h>

Inheritance diagram for MFnPointOnSurfaceManip:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnPointOnSurfaceManip ()
 Destructor.
 MFnPointOnSurfaceManip ()
 Default constructor.
 MFnPointOnSurfaceManip (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
 MFnPointOnSurfaceManip (const MDagPath &object, MStatus *ret=NULL)
 Constructor.
MObject create (MStatus *ReturnStatus=NULL)
 Creates a new PointOnSurfaceManip.
MObject create (const MString &manipName, const MString &paramName, MStatus *ReturnStatus=NULL)
 Creates a new PointOnSurfaceManip.
MStatus connectToSurfacePlug (MPlug &surfacePlug)
 Connect to the surface plug.
MStatus connectToParamPlug (MPlug &paramPlug)
 Connect to the param plug.
MStatus setDrawSurface (bool state)
 Sets whether or not the surface is drawn.
MStatus setDrawArrows (bool state)
 Sets whether or not the arrows should be drawn.
MStatus setParameters (double u, double v)
 Sets the u and v parameters.
MStatus getParameters (double &u, double &v)
 Returns the parameter.
bool isDrawSurfaceOn (MStatus *ReturnStatus=NULL) const
 Returns whether or not the surface is drawn.
unsigned int surfaceIndex (MStatus *ReturnStatus=NULL) const
 Returns the index of the surface.
unsigned int paramIndex (MStatus *ReturnStatus=NULL) const
 Returns the index of the parameter of the PointOnSurfaceManip.
 MFnPointOnSurfaceManip (const MObject &object, MStatus *ret=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

~MFnPointOnSurfaceManip ( ) [virtual]

Destructor.

Class destructor.

MFnPointOnSurfaceManip ( 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:
MFnPointOnSurfaceManip ( 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:
MFnPointOnSurfaceManip ( 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::kPointOnSurfaceManip.

Reimplemented from MFnManip3D.

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

Class name.

Return the class name : "MFnPointOnSurfaceManip".

Reimplemented from MFnManip3D.

MObject create ( MStatus ReturnStatus = NULL)

Creates a new PointOnSurfaceManip.

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

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

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

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

Creates a new PointOnSurfaceManip.

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

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

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 which appears in the feedback line
[out]ReturnStatusStatus code.
Returns:
Newly created PointOnSurfaceManip.
Status Codes:

Reimplemented from MFnDependencyNode.

MStatus connectToSurfacePlug ( MPlug surfacePlug)

Connect to the surface plug.

The data type corresponding to the surfacePlug is MFnData::kNurbsSurface.

Parameters:
[in]surfacePlugthe surface plug
Returns:
MStatus connectToParamPlug ( MPlug paramPlug)

Connect to the param plug.

The data type corresponding to the paramPlug is MFnNumericData::k2Double.

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

Sets whether or not the surface is drawn.

Parameters:
[in]statewhether or not the surface should be drawn
Returns:
MStatus setDrawArrows ( bool  state)

Sets whether or not the arrows should be drawn.

Parameters:
[in]statewhether or not the arrows should be drawn
Returns:
MStatus setParameters ( double  u,
double  v 
)

Sets the u and v parameters.

Parameters:
[in]uu parameter
[in]vv parameter
Returns:
MStatus getParameters ( double &  u,
double &  v 
)

Returns the parameter.

Parameters:
[out]uu parameter
[out]vv parameter
Returns:
bool isDrawSurfaceOn ( MStatus ReturnStatus = NULL) const

Returns whether or not the surface is drawn.

Parameters:
[out]ReturnStatusreturn status
Returns:
  • true the surface is being drawn
  • false the surface is not being drawn
Status Codes:
unsigned int surfaceIndex ( MStatus ReturnStatus = NULL) const

Returns the index of the surface.

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

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

Returns the index of the parameter of the PointOnSurfaceManip.

The data type corresponding to this index is MFnNumericData::k2Double.

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

MFnPointOnSurfaceManip MFnPointOnSurfaceManip MFnPointOnSurfaceManip MFnPointOnSurfaceManip MFnPointOnSurfaceManip MFnPointOnSurfaceManip MFnPointOnSurfaceManip MFnPointOnSurfaceManip MFnPointOnSurfaceManip MFnPointOnSurfaceManip
MFnPointOnSurfaceManip MFnPointOnSurfaceManip MFnPointOnSurfaceManip MFnPointOnSurfaceManip MFnPointOnSurfaceManip MFnPointOnSurfaceManip MFnPointOnSurfaceManip MFnPointOnSurfaceManip MFnPointOnSurfaceManip MFnPointOnSurfaceManip