MFnVortexField Class Reference
[OpenMayaFX - API module for effectsFunctionSet classes]

#include <MFnVortexField.h>

Inheritance diagram for MFnVortexField:

Inheritance graph
[legend]
Collaboration diagram for MFnVortexField:

Collaboration graph
[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:

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:

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:


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:

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:


Autodesk® Maya® 2009 © 1997-2008 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6