pymel.core.nodetypes.Spring

class Spring(*args, **kwargs)

class counterpart of mel function spring

The spring command can do any of the following:* create a new spring object (shape plus transform). The shape contains springs between the points (particles, cvs, etc.) of the objects selected or listed on the command line.* create new springs and add them to an existing spring object* edit or query certain attributes of an existing spring objectOne “spring object” may have hundreds or even thousands of individual springs. Certain attributes of the spring object specify exactly where the springs are attached to which other objects.Springs may be attached to the following: particles, vertices of soft bodies, CVs or edit points of curves or surfaces, vertices of polygonal objects, and points of lattices. In the case where one endpoint of a spring is non-dynamic (a CV, edit point, etc.), the spring does not affect its motion, but the motion of the point affects the spring. A spring will be created only if at least one of the endpoints is dynamic: for example, a spring will never be created between two CVs. A single spring object can hold springs which are incident to any number of other objects.The spring has creation-only flags and editable flags. Creation-only flags (minDistance, maxDistance, add, exclusive, all, wireframe, walklength, checkExisting) can be used only when creating new springs (including adding springs to existing spring object). Editable flags modify attributes of an existing spring object.If a spring object is created, this command returns the names of the shape and transform. If a spring object is queried, the command returns the results of the query.

allPoints(val=True, **kwargs)

If True, sets the mode of spring application to All. This will add springs between all points selected. (Default is False.)

Derived from mel command maya.cmds.spring

getCount(**kwargs)

Return the number of springs in the shape. Query-only. We maintain this flag only for compatibility with earlier versions of Maya. To get the count of springs, it is much faster and simpler to use the spring shape’s count attribute: getAttr shapeName.count.

Derived from mel command maya.cmds.spring

getDamping(**kwargs)

Damping factor for the springs created in the spring object. (Default = 0.2 )

Derived from mel command maya.cmds.spring

getDampingPS(**kwargs)

Damping factor for the springs created in the spring object. This will initialize all the entries in dampingPS to the specified value. In both the flag and the attribute name, “PS” stands for “per-spring.” (Default = 0.2 )

Derived from mel command maya.cmds.spring

getEndForceWeight(**kwargs)

Amount of the force of the spring that gets applied to the point to which the spring ends. Valid range is from 0.0 to 1.0. (Default = 1.0 )

Derived from mel command maya.cmds.spring

getLength(**kwargs)

Vestigial form of “restLength.” Please use “restLength” instead.

Derived from mel command maya.cmds.spring

getName(**kwargs)

Name of spring object.

Derived from mel command maya.cmds.spring

getRestLength(**kwargs)

Per-object rest length for the new springs. Springs can use either their per-object or per-spring rest length. See the -lPS and -ulp flags.

Derived from mel command maya.cmds.spring

getRestLengthPS(**kwargs)

Per-spring rest length for the new springs. This will initialize all the entries in restLengthPS to the specified value. If this flag is not thrown, each rest length will be initialized to the distance between the two points at the time the spring is created (i.e., the initial length of the spring). When playing back, springs can use either their per-spring or per-object rest length. See the -rl and -urp flags. In both the flag and the attribute name, “PS” stands for “per-spring.”

Derived from mel command maya.cmds.spring

getStartForceWeight(**kwargs)

Amount of the force of the spring that gets applied to the point from which the spring starts. Valid range is from 0.0 to 1.0. (Default = 1.0 )

Derived from mel command maya.cmds.spring

getStiffness(**kwargs)

Stiffness of the springs created in the spring object. (Default = 1.0 ) -damp float Vestigial form of “damping.” Please use “damping” instead.

Derived from mel command maya.cmds.spring

getStiffnessPS(**kwargs)

Stiffness of the springs created in the spring object. This will initialize all the entries in stiffnessPS to the specified value. In both the flag and the attribute name, “PS” stands for “per-spring.” (Default = 1.0 )

Derived from mel command maya.cmds.spring

getUseDampingPS(**kwargs)

Specifies whether to use dampingPS (per spring damping). If set to false, the per object damping attribute value will be used. This flag simply sets the useDampingPS attribute of the spring shape. In both the flag and the attribute name, “PS” stands for “per-spring.” (Default = false )

Derived from mel command maya.cmds.spring

getUseRestLengthPS(**kwargs)

Specifies whether to use restLengthPS (per spring restLength). If set to false, the per object restLength attribute value will be used. This flag simply sets the useRestLengthPS attribute of the spring shape. In both the flag and the attribute name, “PS” stands for “per-spring.” (Default = false )

Derived from mel command maya.cmds.spring

getUseStiffnessPS(**kwargs)

Specifies whether to use stiffnessPS (per spring stiffness). If set to false, the per object stiffness attribute value will be used. This flag simply sets the useStiffnessPS attribute of the spring shape. In both the flag and the attribute name, “PS” stands for “per-spring.” (Default = false )

Derived from mel command maya.cmds.spring

maxDistance(val=True, **kwargs)

Maximum distance between two points that a spring would be considered.

Derived from mel command maya.cmds.spring

setDamping(val=True, **kwargs)

Damping factor for the springs created in the spring object. (Default = 0.2 )

Derived from mel command maya.cmds.spring

setDampingPS(val=True, **kwargs)

Damping factor for the springs created in the spring object. This will initialize all the entries in dampingPS to the specified value. In both the flag and the attribute name, “PS” stands for “per-spring.” (Default = 0.2 )

Derived from mel command maya.cmds.spring

setEndForceWeight(val=True, **kwargs)

Amount of the force of the spring that gets applied to the point to which the spring ends. Valid range is from 0.0 to 1.0. (Default = 1.0 )

Derived from mel command maya.cmds.spring

setLength(val=True, **kwargs)

Vestigial form of “restLength.” Please use “restLength” instead.

Derived from mel command maya.cmds.spring

setRestLength(val=True, **kwargs)

Per-object rest length for the new springs. Springs can use either their per-object or per-spring rest length. See the -lPS and -ulp flags.

Derived from mel command maya.cmds.spring

setRestLengthPS(val=True, **kwargs)

Per-spring rest length for the new springs. This will initialize all the entries in restLengthPS to the specified value. If this flag is not thrown, each rest length will be initialized to the distance between the two points at the time the spring is created (i.e., the initial length of the spring). When playing back, springs can use either their per-spring or per-object rest length. See the -rl and -urp flags. In both the flag and the attribute name, “PS” stands for “per-spring.”

Derived from mel command maya.cmds.spring

setStartForceWeight(val=True, **kwargs)

Amount of the force of the spring that gets applied to the point from which the spring starts. Valid range is from 0.0 to 1.0. (Default = 1.0 )

Derived from mel command maya.cmds.spring

setStiffness(val=True, **kwargs)

Stiffness of the springs created in the spring object. (Default = 1.0 ) -damp float Vestigial form of “damping.” Please use “damping” instead.

Derived from mel command maya.cmds.spring

setStiffnessPS(val=True, **kwargs)

Stiffness of the springs created in the spring object. This will initialize all the entries in stiffnessPS to the specified value. In both the flag and the attribute name, “PS” stands for “per-spring.” (Default = 1.0 )

Derived from mel command maya.cmds.spring

setUseDampingPS(val=True, **kwargs)

Specifies whether to use dampingPS (per spring damping). If set to false, the per object damping attribute value will be used. This flag simply sets the useDampingPS attribute of the spring shape. In both the flag and the attribute name, “PS” stands for “per-spring.” (Default = false )

Derived from mel command maya.cmds.spring

setUseRestLengthPS(val=True, **kwargs)

Specifies whether to use restLengthPS (per spring restLength). If set to false, the per object restLength attribute value will be used. This flag simply sets the useRestLengthPS attribute of the spring shape. In both the flag and the attribute name, “PS” stands for “per-spring.” (Default = false )

Derived from mel command maya.cmds.spring

setUseStiffnessPS(val=True, **kwargs)

Specifies whether to use stiffnessPS (per spring stiffness). If set to false, the per object stiffness attribute value will be used. This flag simply sets the useStiffnessPS attribute of the spring shape. In both the flag and the attribute name, “PS” stands for “per-spring.” (Default = false )

Derived from mel command maya.cmds.spring