#include
<MFnVolumeAxisField.h>
List of all
members.
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.
Constructor & Destructor Documentation
MFnVolumeAxisField::~MFnVolumeAxisField |
( |
|
) |
[virtual] |
Destructor.
Class destructor.
MFnVolumeAxisField::MFnVolumeAxisField |
( |
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:
-
MFnVolumeAxisField::MFnVolumeAxisField |
( |
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:
-
MFnVolumeAxisField::MFnVolumeAxisField |
( |
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
MFnVolumeAxisField::type |
( |
|
) |
const [virtual] |
bool MFnVolumeAxisField::invertAttenuation |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Returns the value of the invertAttenuation attribute for the
field force.
- Parameters:
-
[out] |
ReturnStatus |
Status code |
- Returns:
-
- true Field is strongest close to volume outer
boundary.
- false Field is strongest close to volume center.
- Status Codes:
-
MVector
MFnVolumeAxisField::direction |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Returns the direction attribute for the field force.
- Parameters:
-
[out] |
ReturnStatus |
Status code |
- Returns:
- A vector representing direction.
- Status Codes:
-
double MFnVolumeAxisField::speedAlongAxis |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Returns the alongAxis attribute of the field.
- Parameters:
-
[out] |
ReturnStatus |
Status code |
- Returns:
- A double value representing the speed along axis.
- Status Codes:
-
double MFnVolumeAxisField::speedAroundAxis |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Returns the aroundAxis attribute of the field.
- Parameters:
-
[out] |
ReturnStatus |
Status code |
- Returns:
- A double value representing the speed around axis.
- Status Codes:
-
double
MFnVolumeAxisField::speedAwayFromAxis |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Returns the awayFromAxis attribute of the field.
- Parameters:
-
[out] |
ReturnStatus |
Status code |
- Returns:
- A double value representing the speed away from axis.
- Status Codes:
-
double
MFnVolumeAxisField::speedAwayFromCenter |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Returns the awayFromCenter attribute of the field.
- Parameters:
-
[out] |
ReturnStatus |
Status code |
- Returns:
- A double value representing the speed away from center.
- Status Codes:
-
double
MFnVolumeAxisField::directionalSpeed |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Returns the directionalSpeed attribute of the field.
- Parameters:
-
[out] |
ReturnStatus |
Status code |
- Returns:
- A double value representing the directional speed.
- Status Codes:
-
double MFnVolumeAxisField::turbulence |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Returns the turbulence intensity of the field.
- Parameters:
-
[out] |
ReturnStatus |
Status code |
- Returns:
- A double value representing the turbulence intensity.
- Status Codes:
-
double MFnVolumeAxisField::turbulenceSpeed |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Returns the rate of change of the turbulence over time.
- Parameters:
-
[out] |
ReturnStatus |
Status code |
- Returns:
- A double value representing the turbulence speed.
- Status Codes:
-
MVector
MFnVolumeAxisField::turbulenceFrequency |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Returns the turbulenceFrequency attribute for the field
force.
- Parameters:
-
[out] |
ReturnStatus |
Status code |
- Returns:
- A vector representing frequency or scale of the
turbulence.
- Status Codes:
-
MVector
MFnVolumeAxisField::turbulenceOffset |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Returns the turbulenceOffset attribute for the field force.
- Parameters:
-
[out] |
ReturnStatus |
Status code |
- Returns:
- A vector representing an offset or translation of the
turbulence.
- Status Codes:
-
double
MFnVolumeAxisField::detailTurbulence |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Returns the intensity of a second higher frequency
turbulence.
- Parameters:
-
[out] |
ReturnStatus |
Status code |
- Returns:
- A double value for the intensity of fine scale turbulence.
- Status Codes:
-
MStatus
MFnVolumeAxisField::setInvertAttenuation |
( |
bool |
enable |
) |
|
Enables the field will be stronger the closer to the edge of the
volume a point is.
- Parameters:
-
[in] |
enable |
Flag to invert falloff of intensity. |
- Returns:
- Status code
- Status Codes:
-
MStatus
MFnVolumeAxisField::setDirection |
( |
const MVector & |
direction |
) |
|
Sets the direction attribute for the field force.
- Parameters:
-
[in] |
direction |
A vector representing direction. |
- Returns:
- Status code
- Status Codes:
-
MStatus
MFnVolumeAxisField::setSpeedAlongAxis |
( |
double |
speed |
) |
|
Sets the speed along axis attribute for the field force.
- Parameters:
-
[in] |
speed |
A double representing the speed along axis. |
- Returns:
- Status code
- Status Codes:
-
MStatus
MFnVolumeAxisField::setSpeedAroundAxis |
( |
double |
speed |
) |
|
Sets the speed around axis attribute for the field force.
- Parameters:
-
[in] |
speed |
A double representing the speed around axis. |
- Returns:
- Status code
- Status Codes:
-
MStatus
MFnVolumeAxisField::setSpeedAwayFromAxis |
( |
double |
speed |
) |
|
Sets the speed away from axis attribute for the field force.
- Parameters:
-
[in] |
speed |
A double representing the speed away from axis. |
- Returns:
- Status code
- Status Codes:
-
MStatus
MFnVolumeAxisField::setSpeedAwayFromCenter |
( |
double |
speed |
) |
|
Sets the speed away from center attribute for the field
force.
- Parameters:
-
[in] |
speed |
A double representing the speed away from center. |
- Returns:
- Status code
- Status Codes:
-
MStatus
MFnVolumeAxisField::setDirectionalSpeed |
( |
double |
speed |
) |
|
Sets the directional speed attribute for the field force.
- Parameters:
-
[in] |
speed |
A double representing the directional speed. |
- Returns:
- Status code
- Status Codes:
-
MStatus
MFnVolumeAxisField::setTurbulence |
( |
double |
value |
) |
|
Sets the turbulence attribute for the field force.
- Parameters:
-
[in] |
value |
A double representing the turbulence intensity. |
- Returns:
- Status code
- Status Codes:
-
MStatus
MFnVolumeAxisField::setTurbulenceSpeed |
( |
double |
value |
) |
|
Sets the turbulence speed attribute for the field force.
- Parameters:
-
[in] |
value |
A double representing the rate of change of the
turbulence. |
- Returns:
- Status code
- Status Codes:
-
MStatus
MFnVolumeAxisField::setTurbulenceFrequency |
( |
const MVector & |
value |
) |
|
Sets the turbulenceFrequency attribute for the field force.
- Parameters:
-
[in] |
value |
A vector representing the frequency of turbulence. |
- Returns:
- Status code
- Status Codes:
-
MStatus
MFnVolumeAxisField::setTurbulenceOffset |
( |
const MVector & |
value |
) |
|
Sets the turbulenceOffset attribute for the field force.
- Parameters:
-
[in] |
value |
A vector representing the translation of turbulence. |
- Returns:
- Status code
- Status Codes:
-
MStatus
MFnVolumeAxisField::detailTurbulence |
( |
double |
value |
) |
|
Sets the detailTurbulence attribute for the field force.
- Parameters:
-
[in] |
value |
A double representing the intensity of a second higher
frequency turbulence. |
- Returns:
- Status code
- Status Codes:
-