#include
<MFnPointOnSurfaceManip.h>
List of
all members.
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.
Constructor & Destructor Documentation
MFnPointOnSurfaceManip::~MFnPointOnSurfaceManip |
( |
|
) |
[virtual] |
Destructor.
Class destructor.
MFnPointOnSurfaceManip::MFnPointOnSurfaceManip |
( |
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:
-
MFnPointOnSurfaceManip::MFnPointOnSurfaceManip |
( |
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:
-
MFnPointOnSurfaceManip::MFnPointOnSurfaceManip |
( |
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:
-
Member Function Documentation
MFn::Type
MFnPointOnSurfaceManip::type |
( |
|
) |
const [virtual] |
const char *
MFnPointOnSurfaceManip::className |
( |
|
) |
const [protected, virtual] |
Class name.
Return the class name : "MFnPointOnSurfaceManip"
Reimplemented from MFnManip3D.
MObject
MFnPointOnSurfaceManip::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] |
ReturnStatus |
return status |
- Returns:
- Newly created PointOnSurfaceManip
- Status Codes:
-
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] |
paramName |
the name that appears in the feedback line |
[out] |
ReturnStatus |
return status |
- Returns:
- Newly created PointOnSurfaceManip
- Status Codes:
-
Reimplemented from MFnDependencyNode.
MStatus
MFnPointOnSurfaceManip::connectToSurfacePlug |
( |
MPlug & |
surfacePlug |
) |
|
Connect to the surface plug. The data type corresponding to the
surfacePlug is MFnData::kNurbsSurface.
- Parameters:
-
[in] |
surfacePlug |
the surface plug |
- Returns:
-
MStatus
MFnPointOnSurfaceManip::connectToParamPlug |
( |
MPlug & |
paramPlug |
) |
|
Connect to the param plug. The data type corresponding to the
paramPlug is MFnNumericData::k2Double.
- Parameters:
-
[in] |
paramPlug |
the param plug |
- Returns:
-
MStatus
MFnPointOnSurfaceManip::setDrawSurface |
( |
bool |
state |
) |
|
Sets whether or not the surface is drawn.
- Parameters:
-
[in] |
state |
whether or not the surface should be drawn |
- Returns:
-
MStatus
MFnPointOnSurfaceManip::setDrawArrows |
( |
bool |
state |
) |
|
Sets whether or not the arrows should be drawn.
- Parameters:
-
[in] |
state |
whether or not the arrows should be drawn |
- Returns:
-
MStatus
MFnPointOnSurfaceManip::setParameters |
( |
double |
u, |
|
|
double |
v |
|
|
) |
|
|
|
Sets the u and v parameters.
- Parameters:
-
[in] |
u |
u parameter |
[in] |
v |
v parameter |
- Returns:
-
MStatus
MFnPointOnSurfaceManip::getParameters |
( |
double & |
u, |
|
|
double & |
v |
|
|
) |
|
|
|
Returns the parameter.
- Parameters:
-
[out] |
u |
u parameter |
[out] |
v |
v parameter |
- Returns:
-
bool
MFnPointOnSurfaceManip::isDrawSurfaceOn |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Returns whether or not the surface is drawn.
- Parameters:
-
[out] |
ReturnStatus |
return status |
- Returns:
-
- true the surface is being drawn
- false the surface is not being drawn
- Status Codes:
-
unsigned int
MFnPointOnSurfaceManip::surfaceIndex |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Returns the index of the surface. The data type corresponding to
this index is MFnData::kNurbsSurface.
- Parameters:
-
[out] |
ReturnStatus |
return status |
- Returns:
- Surface index
- Status Codes:
-
unsigned int
MFnPointOnSurfaceManip::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] |
ReturnStatus |
return status |
- Returns:
- Parameter index
- Status Codes:
-