Public Member Functions | Protected Member Functions

MFnNewtonField Class Reference

Search for all occurrences

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.

#include <MFnNewtonField.h>

Inheritance diagram for MFnNewtonField:
Inheritance graph
[legend]

List of all members.

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
 Returns the minimum distance from the newton field at which the force of the field is exerted.
MStatus setMinDistance (double distance)
 Sets the minimum distance from the newton field at which the force of the field is exerted.
 MFnNewtonField (const MObject &object, MStatus *ret=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

~MFnNewtonField ( ) [virtual]

Destructor.

Class destructor.

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

Reimplemented from MFnField.

double minDistance ( MStatus ReturnStatus = NULL) const

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

Parameters:
[out]ReturnStatusStatus code
Returns:
A value representing distance in internal linear units.
Status Codes:
MStatus setMinDistance ( double  distance)

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

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

MFnNewtonField MFnNewtonField MFnNewtonField MFnNewtonField MFnNewtonField MFnNewtonField MFnNewtonField MFnNewtonField MFnNewtonField MFnNewtonField
MFnNewtonField MFnNewtonField MFnNewtonField MFnNewtonField MFnNewtonField MFnNewtonField MFnNewtonField MFnNewtonField MFnNewtonField MFnNewtonField