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

#include <MFnGravityField.h>
Inheritance diagram for MFnGravityField:
Inheritance graph
[legend]
Collaboration diagram for MFnGravityField:
Collaboration graph
[legend]

List of all members.


Detailed Description

Function set for Gravity Fields.

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

A gravity field simulates the Earth's gravitational force. It pulls objects in a fixed direction entirely independent of their position or mass.


Public Member Functions

virtual MFn::Type  type () const
  Function set type.
virtual  ~MFnGravityField ()
  Destructor.
  MFnGravityField ()
  Default constructor.
  MFnGravityField (MObject &object, MStatus *ReturnStatus=NULL)
  Constructor.
  MFnGravityField (const MDagPath &object, MStatus *ret=NULL)
  Constructor.
MVector  direction (MStatus *ReturnStatus=NULL) const
MStatus  setDirection (const MVector &gravityDirection)
  MFnGravityField (const MObject &object, MStatus *ret=NULL)
  Constructor.

Protected Member Functions

virtual const char *  className () const
  Class name.

Constructor & Destructor Documentation

MFnGravityField::~MFnGravityField (  )  [virtual]

Destructor.

Class destructor.

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

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

MFnGravityField::MFnGravityField ( 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 MFnGravityField::type (  )  const [virtual]

Function set type.

Return the class type : MFn::kGravity

Reimplemented from MFnField.

MVector MFnGravityField::direction ( MStatus ReturnStatus = NULL  )  const

Returns the direction of the gravitational force.

Parameters:
[out]  ReturnStatus  Status code
Returns:
A vector representing direction.
Status Codes:

MStatus MFnGravityField::setDirection ( const MVector gravityDirection  ) 

Sets the direction vector of the gravitational force.

Parameters:
[in]  gravityDirection  A vector representing direction.
Returns:
Status code
Status Codes:

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