pymel.core.nodetypes.TurbulenceField

class TurbulenceField(*args, **kwargs)

class counterpart of mel function turbulence

A turbulence field causes irregularities (also called ‘noise’ or ‘jitter’) in the motion of affected objects. 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.

getFrequency()

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

Return type:float

Derived from api method maya.OpenMayaFX.MFnTurbulenceField.frequency

getNoiseLevel(**kwargs)

If the noiseLevel parameter is greater than zero, the field will do multiple lookups in the table. Each additional lookup is weighted using noiseRatio (which see). The noiseLevel is the number of additional lookups, so if noiseLevel is 0, there is just one lookup. A value of 0 (the default) corresponds to the way the field behaved prior to Maya 3.0.

Derived from mel command maya.cmds.turbulence

getNoiseRatio(**kwargs)

If noiseLevel is greater than zero, then noiseRatio is the relative magnitude for each consecutive noise evaluation. These are cumulative: for example, if noiseRatio is 0.5, then the first evaluation is weighted 0.5, the second 0.25, and so on. Has no effect if noiseLevel is zero.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.turbulence

getPhase()

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.

Return type:float

Derived from api method maya.OpenMayaFX.MFnTurbulenceField.phase

getPhaseX(**kwargs)

X component of phase shift of turbulence field. This influences the direction of the disruption.

Derived from mel command maya.cmds.turbulence

getPhaseY(**kwargs)

Y component of phase shift of turbulence field. This influences the direction of the disruption.

Derived from mel command maya.cmds.turbulence

getPhaseZ(**kwargs)

Z component of phase shift of turbulence field. This influences the direction of the disruption.

Derived from mel command maya.cmds.turbulence

getTorusSectionRadius(**kwargs)

Derived from mel command maya.cmds.turbulence

getVolumeExclusion(**kwargs)

Derived from mel command maya.cmds.turbulence

getVolumeOffset(**kwargs)

Derived from mel command maya.cmds.turbulence

getVolumeShape(**kwargs)

Derived from mel command maya.cmds.turbulence

getVolumeSweep(**kwargs)

Derived from mel command maya.cmds.turbulence

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

value : float

A value representing a noise generation parameter.

Derived from api method maya.OpenMayaFX.MFnTurbulenceField.setFrequency

setNoiseLevel(val=True, **kwargs)

If the noiseLevel parameter is greater than zero, the field will do multiple lookups in the table. Each additional lookup is weighted using noiseRatio (which see). The noiseLevel is the number of additional lookups, so if noiseLevel is 0, there is just one lookup. A value of 0 (the default) corresponds to the way the field behaved prior to Maya 3.0.

Derived from mel command maya.cmds.turbulence

setNoiseRatio(val=True, **kwargs)

If noiseLevel is greater than zero, then noiseRatio is the relative magnitude for each consecutive noise evaluation. These are cumulative: for example, if noiseRatio is 0.5, then the first evaluation is weighted 0.5, the second 0.25, and so on. Has no effect if noiseLevel is zero.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.turbulence

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

value : float

A value representing a noise generation parameter.

Derived from api method maya.OpenMayaFX.MFnTurbulenceField.setPhase

setPhaseX(val=True, **kwargs)

X component of phase shift of turbulence field. This influences the direction of the disruption.

Derived from mel command maya.cmds.turbulence

setPhaseY(val=True, **kwargs)

Y component of phase shift of turbulence field. This influences the direction of the disruption.

Derived from mel command maya.cmds.turbulence

setPhaseZ(val=True, **kwargs)

Z component of phase shift of turbulence field. This influences the direction of the disruption.

Derived from mel command maya.cmds.turbulence

setTorusSectionRadius(val=True, **kwargs)

Derived from mel command maya.cmds.turbulence

setVolumeExclusion(val=True, **kwargs)

Derived from mel command maya.cmds.turbulence

setVolumeOffset(val=True, **kwargs)

Derived from mel command maya.cmds.turbulence

setVolumeShape(val=True, **kwargs)

Derived from mel command maya.cmds.turbulence

setVolumeSweep(val=True, **kwargs)

Derived from mel command maya.cmds.turbulence