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

#include <MFnVortexField.h>

Inheritance diagram for MFnVortexField:

[legend]

Collaboration diagram for MFnVortexField:

[legend]

List of all members.

---

Detailed Description

Function set for Vortex Fields.

Function set for creation, edit, and query of Vortex Fields.

A vortex field pulls objects in a circular direction, like a whirlpool or tornado.

Public Member Functions
virtual MFn::Type	type () const
	Function set type.
virtual	~MFnVortexField ()
	Destructor.
	MFnVortexField ()
	Default constructor.
	MFnVortexField (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor.
	MFnVortexField (const MDagPath &object, MStatus *ret=NULL)
	Constructor.
MVector	axis (MStatus *ReturnStatus=NULL) const
MStatus	setAxis (const MVector &axisVector)
	MFnVortexField (const MObject &object, MStatus *ret=NULL)
	Constructor.
Protected Member Functions
virtual const char *	className () const
	Class name.

---

Constructor & Destructor Documentation

MFnVortexField::~MFnVortexField

(

)

[virtual]

Destructor.

Class destructor.

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

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

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

(

)

const [virtual]

Function set type.

Return the class type : MFn::kVortex

Reimplemented from MFnField.

MVector MFnVortexField::axis

(

MStatus *

ReturnStatus = NULL

)

const

Returns the axis around which the vortex field exerts it's force.

Parameters:

[out]

ReturnStatus

Status code

Returns:

A vector representing an axis.

Status Codes:

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

MStatus MFnVortexField::setAxis

(

const MVector &

axisVector

)

Sets the axis around which the vortex field exerts it's force.

Parameters:

[in]

axisVector

A vector representing an axis.

Returns:

Status code

Status Codes:

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.