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

#include <MFnNewtonField.h>

Inheritance diagram for MFnNewtonField:

Inheritance graph
[legend]
Collaboration diagram for MFnNewtonField:

Collaboration graph
[legend]

List of all members.


Detailed Description

Function set for Newton Fields.

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

A newton field pulls an object toward another with a force that is dependent on the mass of the object exerting the field. It follows Newton's Law of Universal Gravitation.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnNewtonField ()
 Destructor.
 MFnNewtonField ()
 Default constructor.
 MFnNewtonField (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
 MFnNewtonField (const MDagPath &object, MStatus *ret=NULL)
 Constructor.
double minDistance (MStatus *ReturnStatus=NULL) const
MStatus setMinDistance (double distance)
 MFnNewtonField (const MObject &object, MStatus *ret=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.


Constructor & Destructor Documentation

MFnNewtonField::~MFnNewtonField (  )  [virtual]

Destructor.

Class destructor.

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

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

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

Function set type.

Return the class type : MFn::kNewton

Reimplemented from MFnField.

double MFnNewtonField::minDistance ( MStatus ReturnStatus = NULL  )  const

Returns the minimum distance from the newton field at which the force of the field is exerted.

Parameters:
[out] ReturnStatus Status code
Returns:
A value representing distance in internal linear units.
Status Codes:

MStatus MFnNewtonField::setMinDistance ( double  distance  ) 

Sets the minimum distance from the newton field at which the force of the field is exerted.

Parameters:
[in] distance A value representing distance in internal linear units.
Returns:
Status code
Status Codes:


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