class MFnSphereData

Jump to documentation

: public MFnData Sphere function set for dependency node data . (OpenMaya) (OpenMaya.py)

Inheritance:

MFnSphereData < MFnData < MFnBase

public members:

MFnSphereData ()
MFnSphereData ( MObject & object, MStatus * ReturnStatus = NULL )
virtual ~MFnSphereData ()
virtual MFn::Type type () const
MObject create ( double rad=1, MStatus * ReturnStatus = NULL )
double radius ( MStatus * ReturnStatus = NULL ) const
MStatus setRadius ( double rad )
MFnSphereData ( const MObject & object, MStatus * ReturnStatus = NULL )

Inherited from MFnData:

public members:

enum Type
kInvalid
kNumeric
Numeric, use MFnNumericData extract the node data.
kPlugin
Plugin Blind Data, use MFnPluginData to extract the node data.
kPluginGeometry
Plugin Geometry, use MFnGeometryData to extract the node data.
kString
String, use MFnStringData to extract the node data.
kMatrix
Matrix, use MFnMatrixData to extract the node data.
kStringArray
String Array, use MFnStringArrayData to extract the node data.
kDoubleArray
Double Array, use MFnDoubleArrayData to extract the node data.
kIntArray
Int Array, use MFnIntArrayData to extract the node data.
kPointArray
Point Array, use MFnPointArrayData to extract the node data.
kVectorArray
Vector Array, use MFnVectorArrayData to extract the node data.
kComponentList
Component List, use MFnComponentListData to extract the node data.
kMesh
Mesh, use MFnMeshData to extract the node data.
kLattice
Lattice, use MFnLatticeData to extract the node data.
kNurbsCurve
Nurbs Curve, use MFnNurbsCurveData to extract the node data.
kNurbsSurface
Nurbs Surface, use MFnNurbsSurfaceData to extract the node data.
kSphere
Sphere, use MFnSphereData to extract the node data.
kDynArrayAttrs
ArrayAttrs, use MFnArrayAttrsData to extract the node data.
kDynSweptGeometry
SweptGeometry, use MFnDynSweptGeometryData to extract the node data.
kSubdSurface
Subdivision Surface, use MFnSubdData to extract the node data.
kNObject
nObject data, use MFnNObjectData to extract node data
kLast

Inherited from MFnBase:

public members:

virtual MFn::Type type () const
bool hasObj ( MFn::Type ) const
bool hasObj ( const MObject & ) const
MObject object ( MStatus * ReturnStatus = NULL ) const
virtual MStatus setObject ( MObject & object )
virtual MStatus setObject ( const MObject & object )

Documentation

Create and manipulate Sphere dependency node data
Description

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.

Functions

MFnSphereData:: MFnSphereData ()

Description

Default class constructor. The function set is not attached to an MObject.

MFnSphereData:: MFnSphereData ( MObject & object, MStatus * ReturnStatus )

Description

Class constructor that initializes the function set to the given MObject.

Arguments

  • object the MObject to attach the function set to
  • ReturnStatus the return status
    • 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:: MFnSphereData ( const MObject & object, MStatus * ReturnStatus )

Description

Class constructor that initializes the function set to the given constant MObject.

Arguments

  • object the const MObject to attach the function set to
  • ReturnStatus the return status
    • 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:: ~MFnSphereData ()

Description

The class destructor.

MFn::Type MFnSphereData:: type () const

Description

Return the type of this function set.

Return Value

  • the constant MFn::kSphereData

MObject MFnSphereData:: create ( double rad, MStatus * ReturnStatus )

Description

Create a new sphere of the given radius, and attach it to this instance as an MObject.

Arguments

  • rad the radius of the new sphere
  • ReturnStatus kSuccess

Return Value

  • the new MObject

double MFnSphereData:: radius ( MStatus * ReturnStatus ) const

Description

Return the radius of the sphere attached to this instance.

Arguments

  • ReturnStatus kSuccess if the instance has a sphere attached to it, and kFailure otherwise.

Return Value

  • the radius

MStatus MFnSphereData:: setRadius ( double rad )

Description

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

Arguments

  • rad the new radius

Return Value

  • kSuccess if the instance has a sphere attached to it, and kFailure otherwise.

This class has no child classes.


Autodesk® Maya® 2008 © 1997-2007 Autodesk, Inc. All rights reserved. doc++ Copyright