class MFnVolumeAxisField

Jump to documentation

Inheritance:

MFnVolumeAxisField < MFnField < MFnDagNode < MFnDependencyNode < MFnBase

public members:

	MFnVolumeAxisField ( const MObject & object, MStatus * ReturnStatus = NULL )
bool	invertAttenuation ( MStatus *ReturnStatus = NULL ) const
MVector	direction ( MStatus *ReturnStatus = NULL ) const
double	speedAlongAxis ( MStatus *ReturnStatus = NULL ) const
double	speedAroundAxis ( MStatus *ReturnStatus = NULL ) const
double	speedAwayFromAxis ( MStatus *ReturnStatus = NULL ) const
double	speedAwayFromCenter ( MStatus *ReturnStatus = NULL ) const
double	directionalSpeed ( MStatus *ReturnStatus = NULL ) const
double	turbulence ( MStatus *ReturnStatus = NULL ) const
double	turbulenceSpeed ( MStatus *ReturnStatus = NULL ) const
MVector	turbulenceFrequency ( MStatus *ReturnStatus = NULL ) const
MVector	turbulenceOffset ( MStatus *ReturnStatus = NULL ) const
double	detailTurbulence ( MStatus *ReturnStatus = NULL ) const
MStatus	setInvertAttenuation ( bool enable )
MStatus	setDirection ( const MVector & direction )
MStatus	setSpeedAlongAxis ( double value )
MStatus	setSpeedAroundAxis ( double value )
MStatus	setSpeedAwayFromAxis ( double value )
MStatus	setSpeedAwayFromCenter ( double value )
MStatus	setDirectionalSpeed ( double value )
MStatus	setTurbulence ( double value )
MStatus	setTurbulenceSpeed ( double value )
MStatus	setTurbulenceFrequency ( const MVector &value )
MStatus	setTurbulenceOffset ( const MVector &value )
MStatus	detailTurbulence ( double value )

Inherited from MFnField:

public members:

MStatus	getForceAtPoint (const MPointArray & point, const MVectorArray & velocity, const MDoubleArray & mass, MVectorArray & force, double deltaTime = 1.0 / 24.0 )
MStatus	getForceAtPoint (const MVectorArray & point, const MVectorArray & velocity, const MDoubleArray & mass, MVectorArray & force, double deltaTime = 1.0 / 24.0 )
double	magnitude ( MStatus *ReturnStatus = NULL ) const
MStatus	setMagnitude ( double mag )
double	attenuation ( MStatus *ReturnStatus = NULL ) const
MStatus	setAttenuation ( double atten )
double	maxDistance ( MStatus *ReturnStatus = NULL ) const
MStatus	setMaxDistance ( double maxDist )
bool	perVertex ( MStatus *ReturnStatus = NULL ) const
MStatus	setPerVertex ( bool enable )
bool	useMaxDistance ( MStatus *ReturnStatus = NULL ) const
MStatus	setUseMaxDistance ( bool enable )
double	falloffCurve ( const double param, MStatus *ReturnStatus = NULL )
bool	isFalloffCurveConstantOne ( MStatus *ReturnStatus = NULL)

Inherited from MFnDagNode:

public members:

	kNextPos
MObject	create ( const MTypeId &typeId, MObject & parent = MObject::kNullObj , MStatus * ReturnStatus = NULL )
MObject	create ( const MTypeId &typeId, const MString &name, MObject & parent = MObject::kNullObj , MStatus * ReturnStatus = NULL )
MObject	create ( const MString &type, MObject & parent = MObject::kNullObj , MStatus * ReturnStatus = NULL )
MObject	create ( const MString &type, const MString &name, MObject & parent = MObject::kNullObj , MStatus * ReturnStatus = NULL )
unsigned int	parentCount ( MStatus * ReturnStatus = NULL ) const
MObject	parent ( unsigned int i, MStatus * ReturnStatus = NULL ) const
MStatus	addChild ( MObject & child , unsigned int index = kNextPos , bool keepExistingParents = false )
MStatus	removeChild ( MObject & child )
MStatus	removeChildAt ( unsigned int index )
unsigned int	childCount ( MStatus * ReturnStatus = NULL ) const
MObject	child ( unsigned int i, MStatus * ReturnStatus = NULL ) const
MObject	dagRoot ( MStatus * ReturnStatus = NULL )
bool	hasParent ( const MObject & node, MStatus * ReturnStatus = NULL ) const
bool	hasChild (const MObject & node, MStatus * ReturnStatus = NULL ) const
bool	isChildOf (const MObject & node, MStatus * ReturnStatus = NULL ) const
bool	isParentOf (const MObject & node, MStatus * ReturnStatus = NULL ) const
bool	inUnderWorld ( MStatus * ReturnStatus = NULL ) const
bool	inModel ( MStatus * ReturnStatus = NULL ) const
bool	isInstanceable ( MStatus * ReturnStatus=NULL ) const
MStatus	setInstanceable ( const bool how )
bool	isInstanced ( bool indirect = true, MStatus * ReturnStatus = NULL ) const
bool	isInstancedAttribute ( const MObject & attr, MStatus * ReturnStatus = NULL ) const
unsigned int	instanceCount ( bool total, MStatus * ReturnStatus = NULL ) const
MObject	duplicate ( bool instance = false, bool instanceLeaf = false, MStatus * ReturnStatus = NULL ) const
MStatus	getPath ( MDagPath & path )
MStatus	getAllPaths ( MDagPathArray & paths )
MString	fullPathName ( MStatus *ReturnStatus = NULL)
MString	partialPathName ( MStatus *ReturnStatus = NULL)
MMatrix	transformationMatrix ( MStatus * ReturnStatus = NULL ) const
bool	isIntermediateObject ( MStatus * ReturnStatus = NULL ) const
MStatus	setIntermediateObject ( bool isIntermediate )
int	objectColor ( MStatus * ReturnStatus = NULL ) const
MStatus	setObjectColor ( int color )
bool	usingObjectColor ( MStatus * ReturnStatus = NULL ) const
MStatus	setUseObjectColor ( bool useObjectColor )
MBoundingBox	boundingBox ( MStatus * ReturnStatus = NULL ) const
MDagPath	dagPath ( MStatus * ReturnStatus = NULL ) const
virtual MStatus	setObject ( const MDagPath & path )
virtual MStatus	setObject ( MObject & object )
MObject	model ( MStatus * ReturnStatus = NULL ) const
virtual MStatus	setObject ( const MObject & object )

Inherited from MFnDependencyNode:

public members:

virtual MFn::Type	type () const
enum	MAttrClass kGlobalDynamicAttr kLocalDynamicAttr
MObject	create ( const MTypeId & typeId , MStatus * ReturnStatus = NULL )
MObject	create ( const MTypeId & typeId , const MString & name , MStatus * ReturnStatus = NULL )
MObject	create ( const MString & type , MStatus * ReturnStatus = NULL )
MObject	create ( const MString & type , const MString & name , MStatus * ReturnStatus = NULL )
MTypeId	typeId ( MStatus * ReturnStatus = NULL ) const
MString	typeName ( MStatus * ReturnStatus = NULL ) const
MString	name ( MStatus * ReturnStatus = NULL ) const
MString	setName ( const MString & name , MStatus * ReturnStatus = NULL )
MStatus	getConnections ( MPlugArray & array ) const
unsigned int	attributeCount ( MStatus * ReturnStatus=NULL) const
MObject	attribute ( unsigned int index, MStatus * ReturnStatus=NULL) const
MObject	reorderedAttribute ( unsigned int index, MStatus * ReturnStatus=NULL) const
MObject	attribute ( const MString & attrName, MStatus * ReturnStatus=NULL) const
MAttrClass	attributeClass ( const MObject & attr, MStatus * ReturnStatus=NULL) const
MStatus	getAffectedAttributes ( const MObject & attr, MObjectArray & affectedAttributes ) const
MStatus	getAffectedByAttributes ( const MObject & attr, MObjectArray & affectedByAttributes ) const
MPlug	findPlug ( const MObject & attr, bool wantNetworkedPlug, MStatus * ReturnStatus=NULL) const
MPlug	findPlug ( const MString & attrName, bool wantNetworkedPlug, MStatus * ReturnStatus=NULL) const
MPlug	findPlug ( const MObject & attr, MStatus * ReturnStatus=NULL) const
MPlug	findPlug ( const MString & attrName, MStatus * ReturnStatus=NULL) const
MStatus	addAttribute ( const MObject & attr, MAttrClass type = kLocalDynamicAttr )
MStatus	removeAttribute ( const MObject & attr, MAttrClass type = kLocalDynamicAttr )
MPxNode *	userNode ( MStatus * ReturnStatus=NULL ) const
bool	isFromReferencedFile ( MStatus * ReturnStatus=NULL) const
bool	isShared ( MStatus * ReturnStatus=NULL) const
bool	hasUniqueName ( MStatus * ReturnStatus=NULL) const
MString	parentNamespace ( MStatus * ReturnStatus=NULL) const
bool	isLocked ( MStatus * ReturnStatus=NULL) const
MStatus	setLocked ( bool locked )
static MString	classification ( const MString & nodeTypeName )
bool	isNewAttribute ( const MObject & attr, MStatus * ReturnStatus=NULL) const
static unsigned int	allocateFlag ( const MString pluginName, MStatus * ReturnStatus=NULL )
static MStatus	deallocateFlag (const MString pluginName, unsigned int flag)
static MStatus	deallocateAllFlags (const MString pluginName)
MStatus	setFlag (unsigned int flag, bool state)
bool	isFlagSet (unsigned int flag, MStatus * ReturnStatus=NULL) const
bool	isDefaultNode ( MStatus * ReturnStatus=NULL) const
MStatus	setDoNotWrite ( bool flag )
bool	canBeWritten ( MStatus * ReturnStatus=NULL) const
bool	hasAttribute (const MString & name , MStatus * ReturnStatus=NULL) const
MObject	getAliasAttr (bool force, MStatus * ReturnStatus=NULL)
bool	setAlias (const MString & alias,const MString & name , const MPlug & plug, bool add=true, MStatus * ReturnStatus=NULL)
bool	findAlias (const MString & alias, MObject & attrObj, MStatus * ReturnStatus=NULL) const
bool	getAliasList ( MStringArray & strArray, MStatus * ReturnStatus=NULL)
MString	plugsAlias (const MPlug & plug, MStatus * ReturnStatus=NULL)
	public
bool	getPlugsAlias (const MPlug & plug, MString & aliasName, MStatus * ReturnStatus=NULL)

Inherited from MFnBase:

public members:

virtual MFn::Type	type () const
bool	hasObj ( MFn::Type ) const
bool	hasObj ( const MObject & ) const
MObject	object ( MStatus * ReturnStatus = NULL ) const
virtual MStatus	setObject ( MObject & object )
virtual MStatus	setObject ( const MObject & object )

Documentation

Description

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.

Functions

MFnVolumeAxisField:: MFnVolumeAxisField ()

Description

Default class constructor. The function set is not attached to an MObject.

MFnVolumeAxisField:: MFnVolumeAxisField ( MObject & object, MStatus * ReturnStatus )

Description

Class constructor that initializes the function set to the given MObject.

Arguments

• object the MObject to attach the function set to
• ReturnStatus the return status
  • MS::kSuccess if the function set is successfully attached
  • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

MFnVolumeAxisField:: MFnVolumeAxisField ( const MObject & object, MStatus * ReturnStatus )

Description

Class constructor that initializes the function set to the given constant MObject.

Arguments

• object the const MObject to attach the function set to
• ReturnStatus the return status
  • MS::kSuccess if the function set is successfully attached
  • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

MFnVolumeAxisField:: MFnVolumeAxisField ( const MDagPath & object, MStatus * ReturnStatus )

Description

Class constructor that initializes the function set to the given constant MDagPath object.

Arguments

• object the const MDagPath to attach the function set to
• ReturnStatus the return status
  • MS::kSuccess if the function set is successfully attached
  • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

MFn::Type MFnVolumeAxisField:: type () const

Description

Return the type of this function set.

Return Value

• the constant MFn::kVolumeAxis

MFnVolumeAxisField:: ~MFnVolumeAxisField ()

Description

Class destructor.

bool MFnVolumeAxisField:: invertAttenuation ( MStatus * ReturnStatus ) const

Description

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

Arguments

• ReturnStatus Status code

Return Value

• true Field is strongest close to volume outer boundary.
• false Field is strongest close to volume center.

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

MVector MFnVolumeAxisField:: direction ( MStatus * ReturnStatus ) const

Description

Returns the direction attribute for the field force.

Arguments

• ReturnStatus Status code

Return Value

• A vector representing direction.

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

double MFnVolumeAxisField:: speedAlongAxis ( MStatus * ReturnStatus ) const

Description

Returns the alongAxis attribute of the field.

Arguments

• ReturnStatus Status code

Return Value

• A double value representing the speed along axis.

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

double MFnVolumeAxisField:: speedAroundAxis ( MStatus * ReturnStatus ) const

Description

Returns the aroundAxis attribute of the field.

Arguments

• ReturnStatus Status code

Return Value

• A double value representing the speed around axis.

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

double MFnVolumeAxisField:: speedAwayFromAxis ( MStatus * ReturnStatus ) const

Description

Returns the awayFromAxis attribute of the field.

Arguments

• ReturnStatus Status code

Return Value

• A double value representing the speed away from axis.

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

double MFnVolumeAxisField:: speedAwayFromCenter ( MStatus * ReturnStatus ) const

Description

Returns the awayFromCenter attribute of the field.

Arguments

• ReturnStatus Status code

Return Value

• A double value representing the speed away from center.

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

double MFnVolumeAxisField:: directionalSpeed ( MStatus * ReturnStatus ) const

Description

Returns the directionalSpeed attribute of the field.

Arguments

• ReturnStatus Status code

Return Value

• A double value representing the directional speed.

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

double MFnVolumeAxisField:: turbulence ( MStatus * ReturnStatus ) const

Description

Returns the turbulence intensity of the field.

Arguments

• ReturnStatus Status code

Return Value

• A double value representing the turbulence intensity.

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

double MFnVolumeAxisField:: turbulenceSpeed ( MStatus * ReturnStatus ) const

Description

Returns the rate of change of the turbulence over time.

Arguments

• ReturnStatus Status code

Return Value

• A double value representing the turbulence speed.

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

MVector MFnVolumeAxisField:: turbulenceFrequency ( MStatus * ReturnStatus ) const

Description

Returns the turbulenceFrequency attribute for the field force.

Arguments

• ReturnStatus Status code

Return Value

• A vector representing frequency or scale of the turbulence.

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

MVector MFnVolumeAxisField:: turbulenceOffset ( MStatus * ReturnStatus ) const

Description

Returns the turbulenceOffset attribute for the field force.

Arguments

• ReturnStatus Status code

Return Value

• A vector representing an offset or translation of the turbulence.

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

double MFnVolumeAxisField:: detailTurbulence ( MStatus * ReturnStatus ) const

Description

Returns the intensity of a second higher frequency turbulence.

Arguments

• ReturnStatus Status code

Return Value

• A double value for the intensity of fine scale turbulence.

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

MStatus MFnVolumeAxisField:: setInvertAttenuation ( bool enable )

Description

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

Arguments

• enable Flag to invert falloff of intensity.

Return Value

• Status code

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

MStatus MFnVolumeAxisField:: setDirection ( const MVector & direction )

Description

Sets the direction attribute for the field force.

Arguments

• direction A vector representing direction.

Return Value

• Status code

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

MStatus MFnVolumeAxisField:: setSpeedAlongAxis ( double speed )

Description

Sets the speed along axis attribute for the field force.

Arguments

• direction A double representing the speed along axis.

Return Value

• Status code

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

MStatus MFnVolumeAxisField:: setSpeedAroundAxis ( double speed )

Description

Sets the speed around axis attribute for the field force.

Arguments

• direction A double representing the speed around axis.

Return Value

• Status code

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

MStatus MFnVolumeAxisField:: setSpeedAwayFromAxis ( double speed )

Description

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

Arguments

• direction A double representing the speed away from axis.

Return Value

• Status code

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

MStatus MFnVolumeAxisField:: setSpeedAwayFromCenter ( double speed )

Description

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

Arguments

• direction A double representing the speed away from center.

Return Value

• Status code

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

MStatus MFnVolumeAxisField:: setDirectionalSpeed ( double speed )

Description

Sets the directional speed attribute for the field force.

Arguments

• direction A double representing the directional speed.

Return Value

• Status code

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

MStatus MFnVolumeAxisField:: setTurbulence ( double value )

Description

Sets the turbulence attribute for the field force.

Arguments

• direction A double representing the turbulence intensity.

Return Value

• Status code

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

MStatus MFnVolumeAxisField:: setTurbulenceSpeed ( double value )

Description

Sets the turbulence speed attribute for the field force.

Arguments

• direction A double representing the rate of change of the turbulence.

Return Value

• Status code

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

MStatus MFnVolumeAxisField:: setTurbulenceFrequency ( const MVector & value )

Description

Sets the turbulenceFrequency attribute for the field force.

Arguments

• direction A vector representing the frequency of turbulence.

Return Value

• Status code

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

MStatus MFnVolumeAxisField:: setTurbulenceOffset ( const MVector & value )

Description

Sets the turbulenceOffset attribute for the field force.

Arguments

• direction A vector representing the translation of turbulence.

Return Value

• Status code

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

MStatus MFnVolumeAxisField:: detailTurbulence ( double value )

Description

Sets the detailTurbulence attribute for the field force.

Arguments

• direction A double representing the intensity of a second higher frequency turbulence.

Return Value

• Status code

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

This class has no child classes.