Houdini 20.5 Nodes Dynamics nodes

Soft Body (SBD) Spring Constraint dynamics node

Constrains a point on a soft body to a certain position, with a set amount of springiness.

On this page

This involves constraining some point on the soft body object (wire or cloth) to a “goal” location derived from animation on the object’s geometry, another simulation object or from a position in world space.

SBD Spring Constraint is a digital asset.

Parameters

Constraint

Constrained Object

The soft body object to be constrained.

Constrained Points

The points in the soft body object to be constrained.

Constrain To Animation

Constrains points to animation present on the input geometry.

The Use Animated Geometry parameter on the constrained object’s node should be enabled to make the animation available to the DOP simulation.

Goal Object

A soft body object used to determine the goal position.

If this parameter is left blank then the objects will be constrained to a world space position.

Goal Points

The points in the goal object to use for the goal location. The constrained points are paired with the goal points in the order in which they are given.

If there are more constrained points than goal points, the “leftover” points are constrained to the last specified goal point. “Leftover” goal points will not be used.

If no point is specified, the initial position of the constrained point should be used.

Goal Location

A location in world space to which the soft body object will be constrained.

Mirror Constraint

If enabled, all objects involved in the constraint will be made mutual affectors.

Spring

Strength

Controls how strongly the spring constraint acts on the constrained object to return the anchors to the rest length separation.

Rest Length

Sets the rest length of the spring relationship.

The force applied on a constrained object by a solver will tend to keep the object this distance away from the goal.

Damping

Controls the amount of damping in the spring relationship. As damping increases, the spring constraint acts more slowly and oscillates less.

Limit Force

If this is set, the constraint will be disabled if the force applied to satisfy this constraint exceeds the maximum specified by the Maximum Force parameter.

Maximum Force

Sets a threshold for disabling the constraint.

If the force applied to satisfy this constraint exceeds this threshold, the constraint will be disabled.

Limit Length

If this is set, the constraint will be disabled if the distance between the two ends of this constraint exceeds the maximum specified by the Maximum Length parameter.

Maximum Length

Sets a threshold for disabling the constraint.

If the distance between the two ends of this constraint exceeds this threshold, the constraint will be disabled.

Guide Options

Show Guide Geometry

Turning on this option causes guide geometry to be displayed in the viewport representing this constraint.

Radius

Controls the radius of the spheres drawn in the viewport as guide geometry for this constraint.

Color

This parameter controls the color of the guide geometry.

Activation

Determines if this node should do anything on a given timestep and for a particular object. If this parameter is an expression, it is evaluated for each object (even if data sharing is turned on).

If it evaluates to a non-zero value, then the data is attached to that object. If it evaluates to zero, no data is attached, and data previously attached by this node is removed.

Inputs

First Input

This optional input can be used to control which simulation objects are modified by this node. Any objects connected through this input and which match the Group parameter field will be modified.

If this input is not connected, this node can be used in conjunction with an Apply Data node, or can be used as an input to another data node.

All Other Inputs

If this node has more input connectors, other data nodes can be attached to act as modifiers for the data created by this node.

The specific types of subdata that are meaningful vary from node to node. Click an input connector to see a list of available data nodes that can be meaningfully attached.

Outputs

First Output

The operation of this output depends on what inputs are connected to this node. If an object stream is input to this node, the output is also an object stream containing the same objects as the input (but with the data from this node attached).

If no object stream is connected to this node, the output is a data output. This data output can be connected to an Apply Data DOP, or connected directly to a data input of another data node, to attach the data from this node to an object or another piece of data.

Locals

ST

The simulation time for which the node is being evaluated.

Depending on the settings of the DOP Network Offset Time and Scale Time parameters, this value may not be equal to the current Houdini time represented by the variable T.

ST is guaranteed to have a value of zero at the start of a simulation, so when testing for the first timestep of a simulation, it is best to use a test like $ST == 0, rather than $T == 0 or $FF == 1.

SF

The simulation frame (or more accurately, the simulation time step number) for which the node is being evaluated.

Depending on the settings of the DOP Network parameters, this value may not be equal to the current Houdini frame number represented by the variable F. Instead, it is equal to the simulation time (ST) divided by the simulation timestep size (TIMESTEP).

TIMESTEP

The size of a simulation timestep. This value is useful for scaling values that are expressed in units per second, but are applied on each timestep.

SFPS

The inverse of the TIMESTEP value. It is the number of timesteps per second of simulation time.

SNOBJ

The number of objects in the simulation. For nodes that create objects such as the Empty Object DOP, SNOBJ increases for each object that is evaluated.

A good way to guarantee unique object names is to use an expression like object_$SNOBJ.

NOBJ

The number of objects that are evaluated by the current node during this timestep. This value is often different from SNOBJ, as many nodes do not process all the objects in a simulation.

NOBJ may return 0 if the node does not process each object sequentially (such as the Group DOP).

OBJ

The index of the specific object being processed by the node. This value always runs from zero to NOBJ-1 in a given timestep. It does not identify the current object within the simulation like OBJID or OBJNAME; it only identifies the object’s position in the current order of processing.

This value is useful for generating a random number for each object, or simply splitting the objects into two or more groups to be processed in different ways. This value is -1 if the node does not process objects sequentially (such as the Group DOP).

OBJID

The unique identifier for the object being processed. Every object is assigned an integer value that is unique among all objects in the simulation for all time. Even if an object is deleted, its identifier is never reused. This is very useful in situations where each object needs to be treated differently, for example, to produce a unique random number for each object.

This value is also the best way to look up information on an object using the dopfield expression function.

OBJID is -1 if the node does not process objects sequentially (such as the Group DOP).

ALLOBJIDS

This string contains a space-separated list of the unique object identifiers for every object being processed by the current node.

ALLOBJNAMES

This string contains a space-separated list of the names of every object being processed by the current node.

OBJCT

The simulation time (see variable ST) at which the current object was created.

To check if an object was created on the current timestep, the expression $ST == $OBJCT should always be used.

This value is zero if the node does not process objects sequentially (such as the Group DOP).

OBJCF

The simulation frame (see variable SF) at which the current object was created. It is equivalent to using the dopsttoframe expression on the OBJCT variable.

This value is zero if the node does not process objects sequentially (such as the Group DOP).

OBJNAME

A string value containing the name of the object being processed.

Object names are not guaranteed to be unique within a simulation. However, if you name your objects carefully so that they are unique, the object name can be a much easier way to identify an object than the unique object identifier, OBJID.

The object name can also be used to treat a number of similar objects (with the same name) as a virtual group. If there are 20 objects named “myobject”, specifying strcmp($OBJNAME, "myobject") == 0 in the activation field of a DOP will cause that DOP to operate on only those 20 objects.

This value is the empty string if the node does not process objects sequentially (such as the Group DOP).

DOPNET

A string value containing the full path of the current DOP network. This value is most useful in DOP subnet digital assets where you want to know the path to the DOP network that contains the node.

Note

Most dynamics nodes have local variables with the same names as the node’s parameters. For example, in a Position DOP, you could write the expression:

$tx + 0.1

…to make the object move 0.1 units along the X axis at each timestep.

See also

Dynamics nodes