C++ API Reference

Sphere function set for dependency node data . More...

#include <MFnSphereData.h>

+ Inheritance diagram for MFnSphereData:

Public Member Functions

virtual MFn::Type type () const
 Function set type. More...
 
virtual ~MFnSphereData ()
 Destructor.
 
 MFnSphereData ()
 Default constructor.
 
 MFnSphereData (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
MObject create (double rad=1, MStatus *ReturnStatus=NULL)
 Create a new sphere of the given radius, and attach it to this instance as an MObject. More...
 
double radius (MStatus *ReturnStatus=NULL) const
 Return the radius of the sphere attached to this instance. More...
 
MStatus setRadius (double rad)
 Change the radius of the sphere attached to this instance instance as an MObject. More...
 
 MFnSphereData (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
- Public Member Functions inherited from MFnData
virtual ~MFnData ()
 Destructor.
 
 MFnData (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
 MFnData ()
 Default class constructor.
 
 MFnData (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
- Public Member Functions inherited from MFnBase
virtual ~MFnBase ()
 Class Destructor. More...
 
bool hasObj (MFn::Type) const
 Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More...
 
bool hasObj (const MObject &) const
 Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More...
 
MObject object (MStatus *ReturnStatus=NULL) const
 Returns the MObject that is attached to the Function Set. More...
 
virtual MStatus setObject (MObject &object)
 Attaches the Function Set to the specified Maya Object. More...
 
virtual MStatus setObject (const MObject &object)
 NO SCRIPT SUPPORT. More...
 

Static Public Member Functions

static const char * className ()
 Returns the name of this class. More...
 
- Static Public Member Functions inherited from MFnData
static const char * className ()
 Returns the name of this class. More...
 
- Static Public Member Functions inherited from MFnBase
static const char * className ()
 Returns the name of this class. More...
 
static const char * typeString (MFn::Type)
 Returns the type string for a given type. More...
 
static bool isValid (MFn::Type)
 Returns true if type is in the range of valid types. More...
 

Additional Inherited Members

- Public Types inherited from MFnData
enum  Type {
  kInvalid, kNumeric, kPlugin, kPluginGeometry,
  kString, kMatrix, kStringArray, kDoubleArray,
  kFloatArray, kIntArray, kPointArray, kVectorArray,
  kMatrixArray, kComponentList, kMesh, kLattice,
  kNurbsCurve, kNurbsSurface, kSphere, kDynArrayAttrs,
  kDynSweptGeometry, kSubdSurface, kNObject, kNId,
  kAny, kLast
}
 Types of dependency graph data. More...
 

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 ( 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:
  • 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
MFnSphereData ( 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:
  • 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 type ( ) const
virtual

Function set type.

Return the class type : MFn::kSphereData.

Returns
the class type.

Reimplemented from MFnData.

OPENMAYA_MAJOR_NAMESPACE_OPEN const char * className ( )
static

Returns the name of this class.

Return the class name : "MFnSphereData".

Returns
Name of this class.
MObject 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]radthe radius of the new sphere
[out]ReturnStatuskSuccess
Returns
The new MObject
double radius ( MStatus ReturnStatus = NULL) const

Return the radius of the sphere attached to this instance.

Parameters
[out]ReturnStatuskSuccess if the instance has a sphere attached to it, and kFailure otherwise.
Returns
The radius
MStatus setRadius ( double  rad)

Change the radius of the sphere attached to this instance instance as an MObject.

Parameters
[in]radthe new radius
Returns
kSuccess if the instance has a sphere attached to it, and kFailure otherwise.

The documentation for this class was generated from the following files: