Parent class for dependency graph data function sets. More...

#include <MFnData.h>

Inheritance diagram for MFnData:

Public Types
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...

Public Member Functions
virtual MFn::Type	type () const
	Function set type. More...

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

Detailed Description

Parent class for dependency graph data function sets.

MFnData is the parent class for all dependency graph data function sets. Conceptually, data objects are what flow through the connections in the dependency graph.

Each node in the dependency graph has a data block associated with it. The data block holds the data objects for all of the node's attributes (see MDataBlock). The data block is only available during the compute method of a node. A data handle (MDataHandle) can be created to access a particular attribute's data inside of the data block.

Once a data handle is obtained, it is possible to get the data object from it. This is only necessary for heavier data structures such as geometry or strings. Simple numeric data can be manipulated straight through the data handle.

Note: using kDynSweptGeometry data requires that a plug-in or stand alone API application be linked with the OpenMayaFX library.

Member Enumeration Documentation

enum Type

Types of dependency graph data.

Enumerator
kInvalid	Invalid value.
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.
kFloatArray	Float Array, use MFnFloatArrayData 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.
kMatrixArray	Matrix Array, use MFnMatrixArrayData 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. This data node is in OpenMayaFX which must be linked to.
kSubdSurface	Subdivision Surface, use MFnSubdData to extract the node data.
kNObject	nObject data, use MFnNObjectData to extract node data
kNId	nId data, use MFnNIdData to extract node data
kAny	Typically used when the data can be one of several types.
kFalloffFunction	Last value. It does not represent real data, but can be used to loop on all possible types

Constructor & Destructor Documentation

MFnData	(	MObject &	object,
		MStatus *	ReturnStatus = `NULL`
	)

Constructor.

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

Parameters

[in]	object	The MObject to attach the function set to
[out]	ReturnStatus	the 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

MFnData	(	const MObject &	object,
		MStatus *	ReturnStatus = `NULL`
	)

Constructor.

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

Parameters

[in]	object	The MObject to attach the function set to
[out]	ReturnStatus	the 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::kData.

Returns: the class type.

Reimplemented from MFnBase.

Reimplemented in MFnFalloffData, MFnPluginData, MFnNurbsSurfaceData, MFnDynSweptGeometryData, MFnNurbsCurveData, MFnSubdData, MFnMeshData, MFnNumericData, MFnArrayAttrsData, MFnDoubleArrayData, MFnFloatArrayData, MFnSphereData, MFnGeometryData, MFnNIdData, MFnComponentListData, MFnFloatVectorArrayData, MFnIntArrayData, MFnMatrixArrayData, MFnMatrixData, MFnPointArrayData, MFnStringArrayData, MFnStringData, MFnUInt64ArrayData, MFnUintArrayData, MFnVectorArrayData, MFnLatticeData, and MFnNObjectData.

OPENMAYA_MAJOR_NAMESPACE_OPEN const char * className ( )

static

Returns the name of this class.

Return the class name : "MFnData".

Returns: Name of this class.

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

MFnData.h
MFnData.cpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation