Public Member Functions | Protected Member Functions

MFnGravityField Class Reference

Search for all occurrences

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.

#include <MFnGravityField.h>

Inheritance diagram for MFnGravityField:
Inheritance graph
[legend]

List of all members.

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
 Returns the direction of the gravitational force.
MStatus setDirection (const MVector &gravityDirection)
 Sets the direction vector of the gravitational force.
 MFnGravityField (const MObject &object, MStatus *ret=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

~MFnGravityField ( ) [virtual]

Destructor.

Class destructor.

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

Reimplemented from MFnField.

MVector direction ( MStatus ReturnStatus = NULL) const

Returns the direction of the gravitational force.

Parameters:
[out]ReturnStatusStatus code
Returns:
A vector representing direction.
Status Codes:
MStatus setDirection ( const MVector gravityDirection)

Sets the direction vector of the gravitational force.

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

MFnGravityField MFnGravityField MFnGravityField MFnGravityField MFnGravityField MFnGravityField MFnGravityField MFnGravityField MFnGravityField MFnGravityField
MFnGravityField MFnGravityField MFnGravityField MFnGravityField MFnGravityField MFnGravityField MFnGravityField MFnGravityField MFnGravityField MFnGravityField