pymel.core.nodetypes.TurbulenceField¶
digraph inheritanceae0ca6c9ca { rankdir=TB; ranksep=0.15; nodesep=0.15; size="8.0, 12.0"; "ContainerBase" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.ContainerBase.html#pymel.core.nodetypes.ContainerBase",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "DependNode" -> "ContainerBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "DagNode" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.DagNode.html#pymel.core.nodetypes.DagNode",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "Entity" -> "DagNode" [arrowsize=0.5,style="setlinewidth(0.5)"]; "DependNode" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.DependNode.html#pymel.core.nodetypes.DependNode",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "PyNode" -> "DependNode" [arrowsize=0.5,style="setlinewidth(0.5)"]; "DynBase" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.DynBase.html#pymel.core.nodetypes.DynBase",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "Transform" -> "DynBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Entity" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.Entity.html#pymel.core.nodetypes.Entity",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "ContainerBase" -> "Entity" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Field" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.Field.html#pymel.core.nodetypes.Field",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "DynBase" -> "Field" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ProxyUnicode" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="../pymel.util.utilitytypes/pymel.util.utilitytypes.ProxyUnicode.html#pymel.util.utilitytypes.ProxyUnicode",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "PyNode" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="../pymel.core.general/pymel.core.general.PyNode.html#pymel.core.general.PyNode",style="setlinewidth(0.5)",tooltip="Abstract class that is base for all pymel nodes classes.",height=0.25,shape=box,fontsize=8]; "ProxyUnicode" -> "PyNode" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Transform" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.Transform.html#pymel.core.nodetypes.Transform",style="setlinewidth(0.5)",tooltip="class counterpart of mel function `xform`",height=0.25,shape=box,fontsize=8]; "DagNode" -> "Transform" [arrowsize=0.5,style="setlinewidth(0.5)"]; "TurbulenceField" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="#pymel.core.nodetypes.TurbulenceField",style="setlinewidth(0.5)",tooltip="class counterpart of mel function `turbulence`",height=0.25,shape=box,fontsize=8]; "Field" -> "TurbulenceField" [arrowsize=0.5,style="setlinewidth(0.5)"]; }
- class TurbulenceField(*args, **kwargs)¶
class counterpart of mel function turbulence
For each listed object, the command creates a new field. The field has a shape which lives in the DAG and it has an associated dependency node. The field is added to the list of fields owned by the object. Use connectDynamic to cause the field to affect a dynamic object. Note that if more than one object is listed, a separate field is created for each object. If fields are created, this command returns the names of each owning shape and of the field shapes themselves. If a field was queried, the results of the query are returned. If a field was edited, the field name is returned. If no object names are provided but the active selection list is non-empty, the command creates a field for every object in the list. If the list is empty, the command defaults to -pos 0 0 0. 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.
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)¶
Section radius for a torus volume. Applies only to torus. Similar to the section radius in the torus modelling primitive.
Derived from mel command maya.cmds.turbulence
- getVolumeExclusion(**kwargs)¶
Volume exclusion of the field. If true, points outside the volume (defined by the volume shape attribute) are affected, If false, points inside the volume are affected. Has no effect if volumeShape is set to none.
Derived from mel command maya.cmds.turbulence
- getVolumeOffset(**kwargs)¶
Volume offset of the field. Volume offset translates the field’s volume by the specified amount from the actual field location. This is in the field’s local space.
Derived from mel command maya.cmds.turbulence
- getVolumeShape(**kwargs)¶
Volume shape of the field. Sets/edits/queries the field’s volume shape attribute. If set to any value other than none, determines a 3-D volume within which the field has effect. Values are: none,cube,sphere,cylinder,cone,torus.
Derived from mel command maya.cmds.turbulence
- getVolumeSweep(**kwargs)¶
Volume sweep of the field. Applies only to sphere, cone, cylinder, and torus. Similar effect to the sweep attribute in modelling. Flag can have multiple arguments, passed either as a tuple or a list.
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.
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)¶
Section radius for a torus volume. Applies only to torus. Similar to the section radius in the torus modelling primitive.
Derived from mel command maya.cmds.turbulence
- setVolumeExclusion(val=True, **kwargs)¶
Volume exclusion of the field. If true, points outside the volume (defined by the volume shape attribute) are affected, If false, points inside the volume are affected. Has no effect if volumeShape is set to none.
Derived from mel command maya.cmds.turbulence
- setVolumeOffset(val=True, **kwargs)¶
Volume offset of the field. Volume offset translates the field’s volume by the specified amount from the actual field location. This is in the field’s local space.
Derived from mel command maya.cmds.turbulence
- setVolumeShape(val=True, **kwargs)¶
Volume shape of the field. Sets/edits/queries the field’s volume shape attribute. If set to any value other than none, determines a 3-D volume within which the field has effect. Values are: none,cube,sphere,cylinder,cone,torus.
Derived from mel command maya.cmds.turbulence
- setVolumeSweep(val=True, **kwargs)¶
Volume sweep of the field. Applies only to sphere, cone, cylinder, and torus. Similar effect to the sweep attribute in modelling. Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command maya.cmds.turbulence