C++ API Reference

function set for nId object data More...

#include <MFnNIdData.h>

+ Inheritance diagram for MFnNIdData:

Public Member Functions

virtual MFn::Type type () const
 Function set type. More...
 
virtual ~MFnNIdData ()
 Destructor.
 
 MFnNIdData ()
 Default constructor.
 
 MFnNIdData (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
MObject create () const
 Creates an underlying Maya nId data object and return it as an MObject. More...
 
MStatus getObjectPtr (MnObject *&ptr) const
 NO SCRIPT SUPPORT. More...
 
MnObjectgetObjectPtr (MStatus *status=NULL) const
 Get the nObject pointer. More...
 
 MFnNIdData (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=nullptr) 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, kFalloffFunction
}
 Types of dependency graph data. More...
 

Detailed Description

function set for nId object data

Class for transferring N id data between connections

Constructor & Destructor Documentation

MFnNIdData ( 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
MFnNIdData ( 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::kNIdData.

Returns
the class type.

Reimplemented from MFnData.

const char * className ( )
static

Returns the name of this class.

Return the class name : "MFnNIdData".

Returns
Name of this class.
MObject create ( ) const

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

Returns
The newly object.
MStatus getObjectPtr ( MnObject *&  ptr) const

NO SCRIPT SUPPORT.

Get the nObject pointer.

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

Get the nObject pointer.

Parameters
[out]statusStatus Code
Returns
the pointer to the N constraint
Status Codes:
  • MS::kSuccess operation successful
  • MS::kFailure this function set does not have a valid object

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