SpringPositionController interfaces:

Interface: Spring

Methods

<float>getMass()

Returns the mass.

<void>setMass <float>mass

Sets the mass. The mass of the object to which the Spring controller is applied. Increasing the mass causes the "bouncing" spring motion to become more exaggerated.

<float>getDrag()

Returns the drag.

<void>setDrag <float>drag

Sets the drag. Acts as air friction on the spring motion. A low Drag setting results in a greater "bouncing" effect, while a high Drag results in subdued bouncing. Default=1. Range=0 to 10.

<float>getTension <index>springIndex

Gets the tension for the spring corresponding to the index.

<void>setTension <index>springIndex <float>tension

Sets the tension for the spring corresponding to the index. The "stiffness" of the virtual spring between the controlled object and the highlighted spring object(s).

<float>getDampening <index>springIndex

Gets the dampening for the spring corresponding to the index.

<void>setDampening <index>springIndex <float>dampening

Sets the dampening for the spring corresponding to the index. Acts as a multiplier of an internal factor that determines how quickly the object comes to rest. With the Self Influence spring, changing Dampening has the same effect as changing Drag. With other springs, Dampening affects only the movement caused by that spring. Internally, the dampening value is proportional to the tension, so as you increase the tension and make the solution more stiff, the dampening is increased to maintain system stability.

<boolean>addSpring <node>node

Adds the node to the spring list. Returns true if successful, false otherwise

<integer>getSpringCount()

Returns the number of springs in the spring system.

<void>removeSpringByIndex <index>springIndex

Removes the spring corresponding to the index.

<void>removeSpring <node>node

Removes the spring if the node is in the spring list.

See also