A soft constraint is a class that allows you to manipulate the different type of soft body constraint and access their properties. A soft constraint can simulate any type of physical limitation or restriction that can be applied to the movements of a specific node or point on a SoftBody or between two masses (either another SoftBody or an existing RigidBody).

A soft constraint can simulate anything from a pin on a cloth, the string of a balloon to the angular and rotational constraint of an inflated wheel. They are particularly useful in the process of making your worlds more realistic and are a great addition to use with your existing SoftBody.

Static Variables

Name	Description
`softbodyA`	Reference to the parent SoftBody attached to the active SoftConstraint.
Declaration SoftBody *softbodyA
`data`	Access the properties and settings for the active SoftConstraintType.
Declaration SoftConstraintData data
`pivotA`	First pivot of the constraint which is relative to `softbodyA`.
Declaration vec3 pivotA
`axisA`	Rotation in Euler angles relative to `softbodyA`.
Declaration vec3 axisA
`uid`	Unique id to globally identify the SoftConstraint.
Declaration unsigned int uid

Variables

Name	Description
`name`	A name to identify the SoftConstraint within its parent SoftBody.
Declaration char *name
`enabled`	Control wheter or not the active SoftConstraint is enabled or disabled.
Declaration bool enabled
`draw_size`	Specify the debug draw scale for visual debugging in the 3d viewport (editor only).
Declaration float draw_size

Functions

Name Description

Build Build the SoftConstraint.

Declaration

void Build( void )

SoftConstraintType

Available type of SoftBody constraints.

kPin: Pin the closest node to a static location by setting its mass to 0.
kAnchor: Create a point to point constraint either in SoftBody local space or relative to an existing RigidBody.
kLinearJoint: This type of joint will restrict the movement of the soft body. It is available only when a SoftBody is using clusters; this type of constraint creates a linear (movement only) joint between either a soft or a rigid body.
kAngularJoint: This type of joint will restrict the rotational movements of the soft body to a specific axis. It is only available when a SoftBody is using clusters; this type of constraint creates an angular joint (rotation only) between either a soft body or a rigid body.

SoftConstraintData

Access the properties available to the SoftConstraint based on its current SoftConstraintType.

Static Variables

Name	Description
`type`	The SoftConstraintType of the active SoftConstraint.
Declaration SoftConstraintType type
`pinconstraint`	Access the properties and settings of a PinConstraint.
Declaration PinConstraint *pinconstraint Warning The reference will return `nil` if the type of the active SoftConstraint is not `kPin`.
`anchorconstraint`	Access the properties and settings of a AnchorConstraint.
Declaration AnchorConstraint *anchorconstraint Warning The reference will return `nil` if the type of the active SoftConstraint is not `kAnchor`.
`linearjointconstraint`	Access the properties and settings of a LinearJointConstraint.
Declaration LinearJointConstraint *linearjointconstraint Warning The reference will return `nil` if the type of the active SoftConstraint is not `kLinearJoint`.
`angularjointconstraint`	Access the properties and settings of a AngularJointConstraint.
Declaration AngularJointConstraint *angularjointconstraint Warning The reference will return `nil` if the type of the active SoftConstraint is not `kANgularJoint`.