#include
<MFnSphereData.h>
List of all
members.
Detailed Description
Sphere function set for dependency node data .
MFnSphereData
allows the creation and manipulation of sphere (represented as
MObjects) data objects for use in the dependency graph.
If a user written dependency node either accepts or produces
MObjects containing spheres, then this class is used to extract or
create the data that comes from or goes to other dependency graph
nodes. The MDataHandle::type
method will return kSphere when data of this type is present. To
access it, the MDataHandle::data
method is used to get an MObject for the data and this should then
be used to initialize an instance of MFnNurbsSurface.
Constructor & Destructor Documentation
MFnSphereData::MFnSphereData |
( |
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:
-
MFnSphereData::MFnSphereData |
( |
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
MFnSphereData::type |
( |
|
) |
const [virtual] |
const char * MFnSphereData::className |
( |
|
) |
const [protected, virtual] |
Class name.
Return the class name : "MFnSphereData"
Reimplemented from MFnData.
MObject MFnSphereData::create |
( |
double |
rad = 1 , |
|
|
MStatus * |
ReturnStatus =
NULL |
|
|
) |
|
|
|
Create a new sphere of the given radius, and attach it to this
instance as an MObject.
- Parameters:
-
[in] |
rad |
the radius of the new sphere |
[out] |
ReturnStatus |
kSuccess |
- Returns:
- The new MObject
double MFnSphereData::radius |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Return the radius of the sphere attached to this instance.
- Parameters:
-
[out] |
ReturnStatus |
kSuccess if the instance has a sphere attached to it, and
kFailure otherwise. |
- Returns:
- The radius
MStatus MFnSphereData::setRadius |
( |
double |
rad |
) |
|
Change the radius of the sphere attached to this instance
instance as an MObject.
- Parameters:
-
- Returns:
- kSuccess if the instance has a sphere attached to it, and
kFailure otherwise.