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

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

List of all members.


Detailed Description

Function set for Radial Fields.

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

A radial field pushes objects directly away or pulls them directly toward itself, like a magnet.


Public Member Functions

virtual MFn::Type  type () const
  Function set type.
virtual  ~MFnRadialField ()
  Destructor.
  MFnRadialField ()
  Default constructor.
  MFnRadialField (MObject &object, MStatus *ReturnStatus=NULL)
  Constructor.
  MFnRadialField (const MDagPath &object, MStatus *ret=NULL)
  Constructor.
double  radialType (MStatus *ReturnStatus=NULL) const
MStatus  setType (double value)
  MFnRadialField (const MObject &object, MStatus *ret=NULL)
  Constructor.

Protected Member Functions

virtual const char *  className () const
  Class name.

Constructor & Destructor Documentation

MFnRadialField::~MFnRadialField (  )  [virtual]

Destructor.

Class destructor.

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

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

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

Function set type.

Return the class type : MFn::kRadial

Reimplemented from MFnField.

double MFnRadialField::radialType ( MStatus ReturnStatus = NULL  )  const

Returns a type that controls the way the radial field is attenuated.

Parameters:
[out]  ReturnStatus  Status code
Returns:
  • A value representing a type of radial field attenuation.
  • A value of 1 uses the magnitude, attenuation, and distance settings from the field to determine the net force of the radial field.
  • A value of 0 will use the ratio of the absolute distance and the maximum distance setting.
  • A value between 0 and 1 will create a linear blend between the two types.
Status Codes:

MStatus MFnRadialField::setType ( double  value  ) 

Sets a radial field type that controls the way the field is attenuated.

Parameters:
[in]  value  A value representing a type of radial field attenuation.
  • A value of 1 uses the magnitude, attenuation, and distance settings from the field to determine the net force of the radial field.
  • A value of 0 will use the ratio of the absolute distance and the maximum distance setting.
  • A value between 0 and 1 will create a linear blend between the two types.
Returns:
Status code
Status Codes:

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