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

#include <MFnTurbulenceField.h>

Inheritance diagram for MFnTurbulenceField:

Inheritance graph
[legend]
Collaboration diagram for MFnTurbulenceField:

Collaboration graph
[legend]

List of all members.


Detailed Description

Function set for Turbulence Fields.

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

A turbulence field causes irregularities in the motion of affected objects. These irregularities are also called noise or jitter.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnTurbulenceField ()
 Destructor.
 MFnTurbulenceField ()
 Default constructor.
 MFnTurbulenceField (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
 MFnTurbulenceField (const MDagPath &object, MStatus *ret=NULL)
 Constructor.
double frequency (MStatus *ReturnStatus=NULL) const
MStatus setFrequency (double value)
double phase (MStatus *ReturnStatus=NULL) const
MStatus setPhase (double value)
 MFnTurbulenceField (const MObject &object, MStatus *ret=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.


Constructor & Destructor Documentation

MFnTurbulenceField::~MFnTurbulenceField (  )  [virtual]

Destructor.

Class destructor.

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

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

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

Function set type.

Return the class type : MFn::kTurbulence

Reimplemented from MFnField.

double MFnTurbulenceField::frequency ( MStatus ReturnStatus = NULL  )  const

Returns the frequency parameter that generates irregularities in the fields motion.

Parameters:
[out] ReturnStatus Status code
Returns:
A value representing a noise generation parameter.
Status Codes:

MStatus MFnTurbulenceField::setFrequency ( double  value  ) 

Sets the frequency parameter of the Perlin noise function used by the turbulence field. Values are positive, with larger values causing more frequent irregularities in the motion.

Parameters:
[in] value A value representing a noise generation parameter.
Returns:
Status code
Status Codes:

double MFnTurbulenceField::phase ( MStatus ReturnStatus = NULL  )  const

Returns the phase shift parameter that influences the direction of the turbulence field disruption. Currently this returns the phaseZ attribute, which was called simply phase in versions of Maya prior to 3.0.

Parameters:
[out] ReturnStatus Status code
Returns:
A value representing a noise generation parameter.
Status Codes:

MStatus MFnTurbulenceField::setPhase ( double  value  ) 

Sets the phase shift parameter of the Perlin noise function used by the turbulence field. Both positive and negative values are legal and influence the direction of the disruption. Sets the phaseZ parameter, which was called simply phase in versions of Maya prior to 3.0.

Parameters:
[in] value A value representing a noise generation parameter.
Returns:
Status code
Status Codes:


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