MFnNObjectData Class Reference

#include <MFnNObjectData.h>

Class Description

function set for nCloth object data

Class for transferring N object data between connections

+ Examples:
+ Inheritance diagram for MFnNObjectData:

Public Member Functions

virtual MFn::Type type () const
 Function set type. More...
 
virtual ~MFnNObjectData ()
 Destructor.
 
 MFnNObjectData ()
 Default constructor.
 
 MFnNObjectData (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
MObject create () const
 Creates an underlying Maya N data object and return it as an MObject. More...
 
MStatus getObjectPtr (MnCloth *&ptr) const
 NO SCRIPT SUPPORT. More...
 
MStatus getObjectPtr (MnRigid *&ptr) const
 NO SCRIPT SUPPORT. More...
 
MStatus getObjectPtr (MnParticle *&ptr) const
 NO SCRIPT SUPPORT. More...
 
MnClothgetClothObjectPtr (MStatus *status=NULL) const
 Get the nObject pointer for an nCloth. More...
 
MnRigidgetRigidObjectPtr (MStatus *status=NULL) const
 Get the nObject pointer for an nRigid. More...
 
MnParticlegetParticleObjectPtr (MStatus *status=NULL) const
 Get the nObject pointer for an nParticle. More...
 
MStatus setObjectPtr (MnCloth *ptr)
 Set the nCloth pointer. More...
 
MStatus setObjectPtr (MnRigid *ptr)
 Set the nRigid pointer. More...
 
MStatus setObjectPtr (MnParticle *ptr)
 Set the nParticle pointer. More...
 
MStatus getCollide (bool &) const
 Get wether the nObject is allowed to participate in collisions. More...
 
MStatus getCached (bool &cached) const
 NO SCRIPT SUPPORT. More...
 
bool isCached (MStatus *status=NULL) const
 Get whether the nObject is cached. More...
 
MStatus setCached (bool cached)
 Set wether the nObject is cached. More...
 
 MFnNObjectData (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...
 

Protected Member Functions

virtual const char * className () const
 Class name. 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...
 
- Static Public Member Functions inherited from MFnBase
static const char * className ()
 Returns the name of this class. More...
 

Constructor & Destructor Documentation

MFnNObjectData ( 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
MFnNObjectData ( 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::kNObjectData.

Reimplemented from MFnData.

const char * className ( ) const
protectedvirtual

Class name.

Return the class name : "MFnNObjectData".

Reimplemented from MFnData.

MObject create ( ) const

Creates an underlying Maya N data object and return it as an MObject.

Returns
The newly object.
+ Examples:
MStatus getObjectPtr ( MnCloth *&  ptr) const

NO SCRIPT SUPPORT.

Get the nObject pointer for an nCloth.

Parameters
[in]ptrStorage to return the pointer to the N cloth.
Returns
Status Code
Status Codes:
  • MS::kSuccess operation successful
  • MS::kFailure this function set does not have a valid object
MStatus getObjectPtr ( MnRigid *&  ptr) const

NO SCRIPT SUPPORT.

Get the nObject pointer for an nRigid.

Parameters
[in]ptrStorage to return the pointer to the N rigid
Returns
Status Code
Status Codes:
  • MS::kSuccess operation successful
  • MS::kFailure this function set does not have a valid object
MStatus getObjectPtr ( MnParticle *&  ptr) const

NO SCRIPT SUPPORT.

Get the nObject pointer for an nParticle.

Parameters
[in]ptrStorage to return the pointer to the N particle.
Returns
Status Code
Status Codes:
  • MS::kSuccess operation successful
  • MS::kFailure this function set does not have a valid object
MnCloth * getClothObjectPtr ( MStatus status = NULL) const

Get the nObject pointer for an nCloth.

Parameters
[out]statusStatus Code
Returns
the pointer to the N cloth
Status Codes:
  • MS::kSuccess operation successful
  • MS::kFailure this function set does not have a valid object
MnRigid * getRigidObjectPtr ( MStatus status = NULL) const

Get the nObject pointer for an nRigid.

Parameters
[out]statusStatus Code
Returns
the pointer to the N rigid
Status Codes:
  • MS::kSuccess operation successful
  • MS::kFailure this function set does not have a valid object
MnParticle * getParticleObjectPtr ( MStatus status = NULL) const

Get the nObject pointer for an nParticle.

Parameters
[out]statusStatus Code
Returns
the pointer to the N particle
Status Codes:
  • MS::kSuccess operation successful
  • MS::kFailure this function set does not have a valid object
MStatus setObjectPtr ( MnCloth ptr)

Set the nCloth pointer.

Parameters
[in]ptrpointer to the N cloth
Returns
Status Code
Status Codes:
  • MS::kSuccess operation successful
  • MS::kFailure this function set does not have a valid object
+ Examples:
MStatus setObjectPtr ( MnRigid ptr)

Set the nRigid pointer.

Parameters
[in]ptrpointer to the nRigid
Returns
Status Code
Status Codes:
  • MS::kSuccess operation successful
  • MS::kFailure this function set does not have a valid object
MStatus setObjectPtr ( MnParticle ptr)

Set the nParticle pointer.

Parameters
[in]ptrpointer to the nParticle
Returns
Status Code
Status Codes:
  • MS::kSuccess operation successful
  • MS::kFailure this function set does not have a valid object
MStatus getCollide ( bool &  collide) const

Get wether the nObject is allowed to participate in collisions.

Parameters
[out]collidethe collision state
Returns
Status Code
Status Codes:
  • MS::kSuccess operation successful
  • MS::kFailure this function set does not have a valid object
MStatus getCached ( bool &  cached) const

NO SCRIPT SUPPORT.

Get whether the nObject is cached.

Parameters
[out]cachedthe cache state
Returns
Status Code
Status Codes:
  • MS::kSuccess operation successful
  • MS::kFailure this function set does not have a valid object
bool isCached ( MStatus status = NULL) const

Get whether the nObject is cached.

Parameters
[out]statusStatus Code
Returns
the cache state
Status Codes:
  • MS::kSuccess operation successful
  • MS::kFailure this function set does not have a valid object
MStatus setCached ( bool  cached)

Set wether the nObject is cached.

Parameters
[in]cachedthe cache state
Returns
Status Code
Status Codes:
  • MS::kSuccess operation successful
  • MS::kFailure this function set does not have a valid object
+ Examples:

The documentation for this class was generated from the following files:
  • MFnNObjectData.h
  • MFnNObjectData.cpp