Public Member Functions | Protected Member Functions

MFnVortexField Class Reference

Search for all occurrences

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.

#include <MFnVortexField.h>

Inheritance diagram for MFnVortexField:
Inheritance graph
[legend]

List of all members.

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
 Returns the axis around which the vortex field exerts it's force.
MStatus setAxis (const MVector &axisVector)
 Sets the axis around which the vortex field exerts it's force.
 MFnVortexField (const MObject &object, MStatus *ret=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

~MFnVortexField ( ) [virtual]

Destructor.

Class destructor.

MFnVortexField ( 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:
MFnVortexField ( const MDagPath object,
MStatus ReturnStatus = NULL 
)

Constructor.

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

Parameters:
[in]objectThe const MDagPath to attach the function set to
[out]ReturnStatusThe return status
Status Codes:
MFnVortexField ( 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:

Member Function Documentation

MFn::Type type ( ) const [virtual]

Function set type.

Return the class type : MFn::kVortex.

Reimplemented from MFnField.

MVector axis ( MStatus ReturnStatus = NULL) const

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

Parameters:
[out]ReturnStatusStatus code
Returns:
A vector representing an axis.
Status Codes:
MStatus setAxis ( const MVector axisVector)

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

Parameters:
[in]axisVectorA vector representing an axis.
Returns:
Status code
Status Codes:

MFnVortexField MFnVortexField MFnVortexField MFnVortexField MFnVortexField MFnVortexField MFnVortexField MFnVortexField MFnVortexField MFnVortexField
MFnVortexField MFnVortexField MFnVortexField MFnVortexField MFnVortexField MFnVortexField MFnVortexField MFnVortexField MFnVortexField MFnVortexField