pymel.core.nodetypes.VolumeAxisField

class VolumeAxisField(*args, **kwargs)

class counterpart of mel function volumeAxis

A volume axis field can push particles in four directions, defined with respect to a volume: along the axis, away from the axis or center, around the axis, and in a user-specified direction. These are analogous to the emission speed controls of volume emitters. The volume axis field also contains a wind turbulence model (different from the turbulence field) that simulates an evolving flow of liquid or gas. The turbulence has a build in animation that is driven by a connection to a time node. The transform is the associated dependency node. Use connectDynamic to cause the field to affect a dynamic object. If fields are created, this command returns the names of each of the fields. If a field was queried, the results of the query are returned. If a field was edited, the field name is returned. If object names are provided or the active selection list is non-empty, the command creates a field for every object in the list and calls addDynamic to add it to the object. If the list is empty, the command defaults to -pos 0 0 0. Setting the -pos flag with objects named on the command line is an error.

detailTurbulence()

Returns the intensity of a second higher frequency turbulence.

Return type:float

Derived from api method maya.OpenMayaFX.MFnVolumeAxisField.detailTurbulence

getDetailTurbulence(**kwargs)

The relative intensity of a second higher frequency turbulence. This can be used to create fine features in large scale flows. Both the speed and the frequency on this second turbulence are higher than the primary turbulence. When the detailTurbulence is non-zero the simulation may run a bit slower, due to the computation of a second turbulence.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.volumeAxis

getDirection()

Returns the direction attribute for the field force.

Return type:Vector

Derived from api method maya.OpenMayaFX.MFnVolumeAxisField.direction

getDirectionX(**kwargs)

x-component of force direction. Used with directional speed.

Derived from mel command maya.cmds.volumeAxis

getDirectionY(**kwargs)

y-component of force direction. Used with directional speed.

Derived from mel command maya.cmds.volumeAxis

getDirectionZ(**kwargs)

z-component of force direction. Used with directional speed.

Derived from mel command maya.cmds.volumeAxis

getDirectionalSpeed()

Returns the directionalSpeed attribute of the field.

Return type:float

Derived from api method maya.OpenMayaFX.MFnVolumeAxisField.directionalSpeed

getInvertAttenuation()

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

Return type:bool

Derived from api method maya.OpenMayaFX.MFnVolumeAxisField.invertAttenuation

getSpeedAlongAxis()

Returns the alongAxis attribute of the field.

Return type:float

Derived from api method maya.OpenMayaFX.MFnVolumeAxisField.speedAlongAxis

getSpeedAroundAxis()

Returns the aroundAxis attribute of the field.

Return type:float

Derived from api method maya.OpenMayaFX.MFnVolumeAxisField.speedAroundAxis

getSpeedAwayFromAxis()

Returns the awayFromAxis attribute of the field.

Return type:float

Derived from api method maya.OpenMayaFX.MFnVolumeAxisField.speedAwayFromAxis

getSpeedAwayFromCenter()

Returns the awayFromCenter attribute of the field.

Return type:float

Derived from api method maya.OpenMayaFX.MFnVolumeAxisField.speedAwayFromCenter

getTorusSectionRadius(**kwargs)

Derived from mel command maya.cmds.volumeAxis

getTurbulence()

Returns the turbulence intensity of the field.

Return type:float

Derived from api method maya.OpenMayaFX.MFnVolumeAxisField.turbulence

getTurbulenceFrequency()

Returns the turbulenceFrequency attribute for the field force.

Return type:Vector

Derived from api method maya.OpenMayaFX.MFnVolumeAxisField.turbulenceFrequency

getTurbulenceFrequencyX(**kwargs)

The repeats of the turbulence function in X.

Derived from mel command maya.cmds.volumeAxis

getTurbulenceFrequencyY(**kwargs)

The repeats of the turbulence function in Y.

Derived from mel command maya.cmds.volumeAxis

getTurbulenceFrequencyZ(**kwargs)

The repeats of the turbulence function in Z.

Derived from mel command maya.cmds.volumeAxis

getTurbulenceOffset()

Returns the turbulenceOffset attribute for the field force.

Return type:Vector

Derived from api method maya.OpenMayaFX.MFnVolumeAxisField.turbulenceOffset

getTurbulenceOffsetX(**kwargs)

The translation of the turbulence function in X.

Derived from mel command maya.cmds.volumeAxis

getTurbulenceOffsetY(**kwargs)

The translation of the turbulence function in Y.

Derived from mel command maya.cmds.volumeAxis

getTurbulenceOffsetZ(**kwargs)

The translation of the turbulence function in Z.

Derived from mel command maya.cmds.volumeAxis

getTurbulenceSpeed()

Returns the rate of change of the turbulence over time.

Return type:float

Derived from api method maya.OpenMayaFX.MFnVolumeAxisField.turbulenceSpeed

getVolumeExclusion(**kwargs)

Derived from mel command maya.cmds.volumeAxis

getVolumeOffset(**kwargs)

Derived from mel command maya.cmds.volumeAxis

getVolumeShape(**kwargs)

Derived from mel command maya.cmds.volumeAxis

getVolumeSweep(**kwargs)

Derived from mel command maya.cmds.volumeAxis

setDetailTurbulence(val=True, **kwargs)

The relative intensity of a second higher frequency turbulence. This can be used to create fine features in large scale flows. Both the speed and the frequency on this second turbulence are higher than the primary turbulence. When the detailTurbulence is non-zero the simulation may run a bit slower, due to the computation of a second turbulence.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.volumeAxis

setDirection(direction)

Sets the direction attribute for the field force.

Parameters :

direction : Vector

A vector representing direction.

Derived from api method maya.OpenMayaFX.MFnVolumeAxisField.setDirection

setDirectionX(val=True, **kwargs)

x-component of force direction. Used with directional speed.

Derived from mel command maya.cmds.volumeAxis

setDirectionY(val=True, **kwargs)

y-component of force direction. Used with directional speed.

Derived from mel command maya.cmds.volumeAxis

setDirectionZ(val=True, **kwargs)

z-component of force direction. Used with directional speed.

Derived from mel command maya.cmds.volumeAxis

setDirectionalSpeed(speed)

Sets the directional speed attribute for the field force.

Parameters :

speed : float

A double representing the directional speed.

Derived from api method maya.OpenMayaFX.MFnVolumeAxisField.setDirectionalSpeed

setInvertAttenuation(enable)

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

Parameters :

enable : bool

Flag to invert falloff of intensity.

Derived from api method maya.OpenMayaFX.MFnVolumeAxisField.setInvertAttenuation

setSpeedAlongAxis(speed)

Sets the speed along axis attribute for the field force.

Parameters :

speed : float

A double representing the speed along axis.

Derived from api method maya.OpenMayaFX.MFnVolumeAxisField.setSpeedAlongAxis

setSpeedAroundAxis(speed)

Sets the speed around axis attribute for the field force.

Parameters :

speed : float

A double representing the speed around axis.

Derived from api method maya.OpenMayaFX.MFnVolumeAxisField.setSpeedAroundAxis

setSpeedAwayFromAxis(speed)

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

Parameters :

speed : float

A double representing the speed away from axis.

Derived from api method maya.OpenMayaFX.MFnVolumeAxisField.setSpeedAwayFromAxis

setSpeedAwayFromCenter(speed)

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

Parameters :

speed : float

A double representing the speed away from center.

Derived from api method maya.OpenMayaFX.MFnVolumeAxisField.setSpeedAwayFromCenter

setTorusSectionRadius(val=True, **kwargs)

Derived from mel command maya.cmds.volumeAxis

setTurbulence(value)

Sets the turbulence attribute for the field force.

Parameters :

value : float

A double representing the turbulence intensity.

Derived from api method maya.OpenMayaFX.MFnVolumeAxisField.setTurbulence

setTurbulenceFrequency(value)

Sets the turbulenceFrequency attribute for the field force.

Parameters :

value : Vector

A vector representing the frequency of turbulence.

Derived from api method maya.OpenMayaFX.MFnVolumeAxisField.setTurbulenceFrequency

setTurbulenceFrequencyX(val=True, **kwargs)

The repeats of the turbulence function in X.

Derived from mel command maya.cmds.volumeAxis

setTurbulenceFrequencyY(val=True, **kwargs)

The repeats of the turbulence function in Y.

Derived from mel command maya.cmds.volumeAxis

setTurbulenceFrequencyZ(val=True, **kwargs)

The repeats of the turbulence function in Z.

Derived from mel command maya.cmds.volumeAxis

setTurbulenceOffset(value)

Sets the turbulenceOffset attribute for the field force.

Parameters :

value : Vector

A vector representing the translation of turbulence.

Derived from api method maya.OpenMayaFX.MFnVolumeAxisField.setTurbulenceOffset

setTurbulenceOffsetX(val=True, **kwargs)

The translation of the turbulence function in X.

Derived from mel command maya.cmds.volumeAxis

setTurbulenceOffsetY(val=True, **kwargs)

The translation of the turbulence function in Y.

Derived from mel command maya.cmds.volumeAxis

setTurbulenceOffsetZ(val=True, **kwargs)

The translation of the turbulence function in Z.

Derived from mel command maya.cmds.volumeAxis

setTurbulenceSpeed(value)

Sets the turbulence speed attribute for the field force.

Parameters :

value : float

A double representing the rate of change of the turbulence.

Derived from api method maya.OpenMayaFX.MFnVolumeAxisField.setTurbulenceSpeed

setVolumeExclusion(val=True, **kwargs)

Derived from mel command maya.cmds.volumeAxis

setVolumeOffset(val=True, **kwargs)

Derived from mel command maya.cmds.volumeAxis

setVolumeShape(val=True, **kwargs)

Derived from mel command maya.cmds.volumeAxis

setVolumeSweep(val=True, **kwargs)

Derived from mel command maya.cmds.volumeAxis