Matrix function set for dependency node data. More...

#include <MFnFalloffData.h>

Inheritance diagram for MFnFalloffData:

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

virtual	~MFnFalloffData ()
	Destructor.

	MFnFalloffData ()
	Default constructor.

	MFnFalloffData (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

MFalloffFunction::ReturnValue	call (MFalloffContext &accessor)
	Call falloff function set in the current held MObject. More...

MObject	create (MSharedPtr< MFalloffFunction >, MStatus *ReturnStatus=NULL)
	Create a new MObject, attach it to this instance and initialize it to the given falloff function. More...

	MFnFalloffData (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

Matrix function set for dependency node data.

MFnFalloffData allows the creation and manipulation of falloff data function. Falloff data are created to define or call a falloff function. User can create its own falloff by subclassing MFalloffFunction

Examples:: exampleFalloff/smoothFalloffNode.cpp.

Constructor & Destructor Documentation

MFnFalloffData	(	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

MFnFalloffData	(	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::kWeightFunctionData.

Returns: the class type.

Reimplemented from MFnData.

OPENMAYA_MAJOR_NAMESPACE_OPEN const char * className ( )

static

Returns the name of this class.

Return the class name : "MFnFalloffData".

Returns: Name of this class.

MFalloffFunction::ReturnValue call ( MFalloffContext & apiAccessor )

Call falloff function set in the current held MObject.

MFalloffContext object can be obtain within a falloff function.

Parameters

[in]	apiAccessor	give access to buffer and geometry infromation in the current evaluation context.
[out]	ReturnValue	will tell wich buffer it has written along the geometry requirment and caching status.

Returns: The new MObject

MObject create	(	MSharedPtr< MFalloffFunction >	fun,
		MStatus *	ReturnStatus = `NULL`
	)

Create a new MObject, attach it to this instance and initialize it to the given falloff function.

Parameters

[in]	fun	Falloff function to set the in the data
[out]	ReturnStatus	kSuccess

Returns: The new MObject

Examples:: exampleFalloff/smoothFalloffNode.cpp.

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

MFnFalloffData.h
MFnFalloffData.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation