pymel.core.nodetypes.DragField¶
digraph inheritancec57bef0e45 { 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)"]; "DragField" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="#pymel.core.nodetypes.DragField",style="setlinewidth(0.5)",tooltip="class counterpart of mel function `drag`",height=0.25,shape=box,fontsize=8]; "Field" -> "DragField" [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)"]; }
- class DragField(*args, **kwargs)¶
class counterpart of mel function drag
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. Drag exerts a friction, or braking force proportional to the speed of a moving object. If direction is not enabled, the drag acts opposite to the current velocity of the object. If direction is enabled, it acts opposite to the component of the velocity in the specified direction. The force is independent of the position of the affected object. 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.
- getDirection()¶
Returns the direction of the drag force’s influence along the x, y, and z axes. You must have the Use Direction setting turned on for this attribute to take effect.
Return type: Vector Derived from api method maya.OpenMayaFX.MFnDragField.direction
- getDirectionX(**kwargs)¶
X-component of direction.
Derived from mel command maya.cmds.drag
- getDirectionY(**kwargs)¶
Y-component of direction.
Derived from mel command maya.cmds.drag
- getDirectionZ(**kwargs)¶
Z-component of direction
Derived from mel command maya.cmds.drag
- 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.drag
- getUseDirection()¶
Returns true if the braking force is exerted only against the component of the object’s velocity that lies along the direction of the drag force.
Return type: bool Derived from api method maya.OpenMayaFX.MFnDragField.useDirection
- 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.drag
- 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.drag
- 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.drag
- 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.drag
- setDirection(dragDirection)¶
Sets the direction of the drag force’s influence along the x, y, and z axes. You must have the Use Direction setting turned on for this attribute to take effect.
Parameters: - dragDirection : Vector
A vector representing direction.
Derived from api method maya.OpenMayaFX.MFnDragField.setDirection
- setDirectionX(val=True, **kwargs)¶
X-component of direction.
Derived from mel command maya.cmds.drag
- setDirectionY(val=True, **kwargs)¶
Y-component of direction.
Derived from mel command maya.cmds.drag
- setDirectionZ(val=True, **kwargs)¶
Z-component of direction
Derived from mel command maya.cmds.drag
- 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.drag
- setUseDirection(enable)¶
Enables the braking force to be exerted only against the component of the object’s velocity that lies along the direction setting of the drag force.
Parameters: - enable : bool
Flag to enable or disable direction setting.
Derived from api method maya.OpenMayaFX.MFnDragField.setUseDirection
- 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.drag
- 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.drag
- 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.drag
- 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.drag