MFnInstancer Class Reference
[OpenMayaFX - API module for effects, FunctionSet classes]

#include <MFnInstancer.h>

Inheritance diagram for MFnInstancer:

[legend]

Collaboration diagram for MFnInstancer:

[legend]

List of all members.

---

Detailed Description

Particle Instancer object access class.

Class for obtaining information about a particle instancer node.

Examples:

instancerListCmd.cpp.

Public Member Functions
virtual MFn::Type	type () const
	Function set type.
virtual	~MFnInstancer ()
	Destructor.
	MFnInstancer ()
	Default constructor.
	MFnInstancer (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor.
	MFnInstancer (const MDagPath &object, MStatus *ret=NULL)
	Constructor.
int	particleCount () const
int	instancesForParticle (int p, MDagPathArray &paths, MMatrix &instancerMatrix, MStatus *ReturnStatus=NULL) const
	MFnInstancer (const MObject &object, MStatus *ret=NULL)
	Constructor.
Protected Member Functions
virtual const char *	className () const
	Class name.

---

Constructor & Destructor Documentation

MFnInstancer::~MFnInstancer

(

)

[virtual]

Destructor.

Class destructor.

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

MFnInstancer::MFnInstancer	(	const MDagPath &	object,
		MStatus *	ReturnStatus = NULL
	)

Constructor.

Class constructor that initializes the function set to the given constant MDagPath object.

Parameters:

[in]	object	The const MDagPath 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

MFnInstancer::MFnInstancer	(	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 MFnInstancer::type

(

)

const [virtual]

Function set type.

Return the class type : MFn::kInstancer

Reimplemented from MFnDagNode.

int MFnInstancer::particleCount

(

)

const

Returns the number of particles feeding the active instancer

Returns:

See description.

int MFnInstancer::instancesForParticle	(	int	p,
		MDagPathArray &	paths,
		MMatrix &	instancerMatrix,
		MStatus *	ReturnStatus = NULL
	)			const

Returns (via reference) the DAG paths and instancer matrix for all instances generated by a specified particle

Parameters:

[in]	p	The index of the particle being queried.
[in]	paths	Visible DAG paths generated by particle p
[in]	instancerMatrix	The transformation matrix that the instancer applies to the instanced paths to produce the final particle-instanced geometry. The final world matrix of each instance can be constructed by premultiplying the path's inclusive world matrix by this matrix.
[out]	ReturnStatus	status code

Returns:

The number of visible paths instanced for the given particle. It is possible for no paths to be instanced for a particular particle.

Status Codes:

• MS::kSuccess Success
• MS::kInvalidParameter Invalid particle index or program state