Public Member Functions | Protected Member Functions

MFnVolumeAxisField Class Reference

Search for all occurrences

Detailed Description

Function set for VolumeAxis Fields.

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

A volume axis field provides in field form some of the speed controls of volume emitters.

#include <MFnVolumeAxisField.h>

Inheritance diagram for MFnVolumeAxisField:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnVolumeAxisField ()
 Destructor.
 MFnVolumeAxisField ()
 Default constructor.
 MFnVolumeAxisField (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
 MFnVolumeAxisField (const MDagPath &object, MStatus *ret=NULL)
 Constructor.
bool invertAttenuation (MStatus *ReturnStatus=NULL) const
 Returns the value of the invertAttenuation attribute for the field force.
MVector direction (MStatus *ReturnStatus=NULL) const
 Returns the direction attribute for the field force.
double speedAlongAxis (MStatus *ReturnStatus=NULL) const
 Returns the alongAxis attribute of the field.
double speedAroundAxis (MStatus *ReturnStatus=NULL) const
 Returns the aroundAxis attribute of the field.
double speedAwayFromAxis (MStatus *ReturnStatus=NULL) const
 Returns the awayFromAxis attribute of the field.
double speedAwayFromCenter (MStatus *ReturnStatus=NULL) const
 Returns the awayFromCenter attribute of the field.
double directionalSpeed (MStatus *ReturnStatus=NULL) const
 Returns the directionalSpeed attribute of the field.
double turbulence (MStatus *ReturnStatus=NULL) const
 Returns the turbulence intensity of the field.
double turbulenceSpeed (MStatus *ReturnStatus=NULL) const
 Returns the rate of change of the turbulence over time.
MVector turbulenceFrequency (MStatus *ReturnStatus=NULL) const
 Returns the turbulenceFrequency attribute for the field force.
MVector turbulenceOffset (MStatus *ReturnStatus=NULL) const
 Returns the turbulenceOffset attribute for the field force.
double detailTurbulence (MStatus *ReturnStatus=NULL) const
 Returns the intensity of a second higher frequency turbulence.
MStatus setInvertAttenuation (bool enable)
 Enables the field will be stronger the closer to the edge of the volume a point is.
MStatus setDirection (const MVector &direction)
 Sets the direction attribute for the field force.
MStatus setSpeedAlongAxis (double value)
 Sets the speed along axis attribute for the field force.
MStatus setSpeedAroundAxis (double value)
 Sets the speed around axis attribute for the field force.
MStatus setSpeedAwayFromAxis (double value)
 Sets the speed away from axis attribute for the field force.
MStatus setSpeedAwayFromCenter (double value)
 Sets the speed away from center attribute for the field force.
MStatus setDirectionalSpeed (double value)
 Sets the directional speed attribute for the field force.
MStatus setTurbulence (double value)
 Sets the turbulence attribute for the field force.
MStatus setTurbulenceSpeed (double value)
 Sets the turbulence speed attribute for the field force.
MStatus setTurbulenceFrequency (const MVector &value)
 Sets the turbulenceFrequency attribute for the field force.
MStatus setTurbulenceOffset (const MVector &value)
 Sets the turbulenceOffset attribute for the field force.
MStatus detailTurbulence (double value)
 Sets the detailTurbulence attribute for the field force.
 MFnVolumeAxisField (const MObject &object, MStatus *ret=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

~MFnVolumeAxisField ( ) [virtual]

Destructor.

Class destructor.

MFnVolumeAxisField ( 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:
MFnVolumeAxisField ( 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:
MFnVolumeAxisField ( 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::kVolumeAxis.

Reimplemented from MFnField.

bool invertAttenuation ( MStatus ReturnStatus = NULL) const

Returns the value of the invertAttenuation attribute for the field force.

Parameters:
[out]ReturnStatusStatus code
Returns:
  • true Field is strongest close to volume outer boundary.
  • false Field is strongest close to volume center.
Status Codes:
MVector direction ( MStatus ReturnStatus = NULL) const

Returns the direction attribute for the field force.

Parameters:
[out]ReturnStatusStatus code
Returns:
A vector representing direction.
Status Codes:
double speedAlongAxis ( MStatus ReturnStatus = NULL) const

Returns the alongAxis attribute of the field.

Parameters:
[out]ReturnStatusStatus code
Returns:
A double value representing the speed along axis.
Status Codes:
double speedAroundAxis ( MStatus ReturnStatus = NULL) const

Returns the aroundAxis attribute of the field.

Parameters:
[out]ReturnStatusStatus code
Returns:
A double value representing the speed around axis.
Status Codes:
double speedAwayFromAxis ( MStatus ReturnStatus = NULL) const

Returns the awayFromAxis attribute of the field.

Parameters:
[out]ReturnStatusStatus code
Returns:
A double value representing the speed away from axis.
Status Codes:
double speedAwayFromCenter ( MStatus ReturnStatus = NULL) const

Returns the awayFromCenter attribute of the field.

Parameters:
[out]ReturnStatusStatus code
Returns:
A double value representing the speed away from center.
Status Codes:
double directionalSpeed ( MStatus ReturnStatus = NULL) const

Returns the directionalSpeed attribute of the field.

Parameters:
[out]ReturnStatusStatus code
Returns:
A double value representing the directional speed.
Status Codes:
double turbulence ( MStatus ReturnStatus = NULL) const

Returns the turbulence intensity of the field.

Parameters:
[out]ReturnStatusStatus code
Returns:
A double value representing the turbulence intensity.
Status Codes:
double turbulenceSpeed ( MStatus ReturnStatus = NULL) const

Returns the rate of change of the turbulence over time.

Parameters:
[out]ReturnStatusStatus code
Returns:
A double value representing the turbulence speed.
Status Codes:
MVector turbulenceFrequency ( MStatus ReturnStatus = NULL) const

Returns the turbulenceFrequency attribute for the field force.

Parameters:
[out]ReturnStatusStatus code
Returns:
A vector representing frequency or scale of the turbulence.
Status Codes:
MVector turbulenceOffset ( MStatus ReturnStatus = NULL) const

Returns the turbulenceOffset attribute for the field force.

Parameters:
[out]ReturnStatusStatus code
Returns:
A vector representing an offset or translation of the turbulence.
Status Codes:
double detailTurbulence ( MStatus ReturnStatus = NULL) const

Returns the intensity of a second higher frequency turbulence.

Parameters:
[out]ReturnStatusStatus code
Returns:
A double value for the intensity of fine scale turbulence.
Status Codes:
MStatus setInvertAttenuation ( bool  enable)

Enables the field will be stronger the closer to the edge of the volume a point is.

Parameters:
[in]enableFlag to invert falloff of intensity.
Returns:
Status code
Status Codes:
MStatus setDirection ( const MVector direction)

Sets the direction attribute for the field force.

Parameters:
[in]directionA vector representing direction.
Returns:
Status code
Status Codes:
MStatus setSpeedAlongAxis ( double  speed)

Sets the speed along axis attribute for the field force.

Parameters:
[in]speedA double representing the speed along axis.
Returns:
Status code
Status Codes:
MStatus setSpeedAroundAxis ( double  speed)

Sets the speed around axis attribute for the field force.

Parameters:
[in]speedA double representing the speed around axis.
Returns:
Status code
Status Codes:
MStatus setSpeedAwayFromAxis ( double  speed)

Sets the speed away from axis attribute for the field force.

Parameters:
[in]speedA double representing the speed away from axis.
Returns:
Status code
Status Codes:
MStatus setSpeedAwayFromCenter ( double  speed)

Sets the speed away from center attribute for the field force.

Parameters:
[in]speedA double representing the speed away from center.
Returns:
Status code
Status Codes:
MStatus setDirectionalSpeed ( double  speed)

Sets the directional speed attribute for the field force.

Parameters:
[in]speedA double representing the directional speed.
Returns:
Status code
Status Codes:
MStatus setTurbulence ( double  value)

Sets the turbulence attribute for the field force.

Parameters:
[in]valueA double representing the turbulence intensity.
Returns:
Status code
Status Codes:
MStatus setTurbulenceSpeed ( double  value)

Sets the turbulence speed attribute for the field force.

Parameters:
[in]valueA double representing the rate of change of the turbulence.
Returns:
Status code
Status Codes:
MStatus setTurbulenceFrequency ( const MVector value)

Sets the turbulenceFrequency attribute for the field force.

Parameters:
[in]valueA vector representing the frequency of turbulence.
Returns:
Status code
Status Codes:
MStatus setTurbulenceOffset ( const MVector value)

Sets the turbulenceOffset attribute for the field force.

Parameters:
[in]valueA vector representing the translation of turbulence.
Returns:
Status code
Status Codes:
MStatus detailTurbulence ( double  value)

Sets the detailTurbulence attribute for the field force.

Parameters:
[in]valueA double representing the intensity of a second higher frequency turbulence.
Returns:
Status code
Status Codes:

MFnVolumeAxisField MFnVolumeAxisField MFnVolumeAxisField MFnVolumeAxisField MFnVolumeAxisField MFnVolumeAxisField MFnVolumeAxisField MFnVolumeAxisField MFnVolumeAxisField MFnVolumeAxisField
MFnVolumeAxisField MFnVolumeAxisField MFnVolumeAxisField MFnVolumeAxisField MFnVolumeAxisField MFnVolumeAxisField MFnVolumeAxisField MFnVolumeAxisField MFnVolumeAxisField MFnVolumeAxisField