Public Member Functions | Protected Member Functions

MFnNObjectData Class Reference

Search for all occurrences

Detailed Description

function set for nCloth object data

Class for transferring N object data between connections

Examples:

testNobjectNode.cpp, and testNucleusNode.cpp.

#include <MFnNObjectData.h>

Inheritance diagram for MFnNObjectData:
Inheritance graph
[legend]

List of all members.

Public Member Functions

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

Protected Member Functions

virtual const char * className () const
 Class name.

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:
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:

Member Function Documentation

MFn::Type type ( ) const [virtual]

Function set type.

Return the class type : MFn::kNObjectData.

Reimplemented from MFnData.

const char * className ( ) const [protected, virtual]

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:
testNobjectNode.cpp.
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:
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:
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:
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:
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:
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:
MStatus setObjectPtr ( MnCloth ptr)

Set the nCloth pointer.

Parameters:
[in]ptrpointer to the N cloth
Returns:
Status Code
Status Codes:
Examples:
testNobjectNode.cpp.
MStatus setObjectPtr ( MnRigid ptr)

Set the nRigid pointer.

Parameters:
[in]ptrpointer to the nRigid
Returns:
Status Code
Status Codes:
MStatus setObjectPtr ( MnParticle ptr)

Set the nParticle pointer.

Parameters:
[in]ptrpointer to the nParticle
Returns:
Status Code
Status Codes:
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:
MStatus getCached ( bool &  cached) const

NO SCRIPT SUPPORT.

Get whether the nObject is cached.

Parameters:
[out]cachedthe cache state
Returns:
Status Code
Status Codes:
bool isCached ( MStatus status = NULL) const

Get whether the nObject is cached.

Parameters:
[out]statusStatus Code
Returns:
the cache state
Status Codes:
MStatus setCached ( bool  cached)

Set wether the nObject is cached.

Parameters:
[in]cachedthe cache state
Returns:
Status Code
Status Codes:
Examples:
testNobjectNode.cpp.

MFnNObjectData MFnNObjectData MFnNObjectData MFnNObjectData MFnNObjectData MFnNObjectData MFnNObjectData MFnNObjectData MFnNObjectData MFnNObjectData
MFnNObjectData MFnNObjectData MFnNObjectData MFnNObjectData MFnNObjectData MFnNObjectData MFnNObjectData MFnNObjectData MFnNObjectData MFnNObjectData