DynamicsChainProperties

Class Documentation

Edit documentation

The physical parameters of a group of joint trees of a dynamics chain. Every parameter is a CurveScaledFloat: a number, and an optional curve that scales the number along the tree, from the root (0) to the tip of the longest branch (1). So a tail can be stiff at its base and loose at its end.

A group simulates in one of two ways, set by UseRodPhysics:

• Off, the default. Each joint is a point. Its rotation is not simulated: it is turned so the joint points at its simulated child, and the twist stays as animated. Stretch sets how much the length of a segment can change.
• On. Each segment is a rod that also has a simulated rotation. The four Rod parameters set how much the rod resists stretching, shearing, bending and twisting. Stretch is not used.

Notes

• If the length of the longest branch is zero, the client sets none of the parameters, and the tree keeps a damping of 0, a radius of 0, no angle limit, no stretch and no attraction.

Properties

AnimPoseAttraction

Embed<CurveScaledFloat> = { "value": 0.5, "Curve": null, "UseCurve": true }

16.14

Documentation Edit documentation

How fast a joint is pulled back to its animated pose, from 0 to 1. The target is the place the joint has in the animation relative to its parent, taken from where the parent is in the simulation. On each frame the joint moves toward the target by the share 1 - (1 - AnimPoseAttraction) ^ time, with the frame time in seconds. So the value is the share of the way that is covered in one second: 0 never pulls, 0.5 covers half of the way per second, 1 holds the joint in the animated pose.

Notes

• With UseRodPhysics, the time is multiplied by the value of the settings class 0xf7c4193e, and the rotation of the rod is pulled to the animated rotation the same way.

AnimPoseStiffnessEnd

F32 = 0.5

Removed in 16.14 16.9

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

AnimPoseStiffnessStart

F32 = 0.5

Removed in 16.14 16.9

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

Damping

Embed<CurveScaledFloat> = { "value": 0.5, "Curve": null, "UseCurve": true }

16.14

Documentation Edit documentation

How much of its velocity a joint loses on each frame, from 0 to 1. The joint keeps 1 - Damping of the distance it moved in the last frame. 0 swings for a long time, 1 removes all momentum, so the joint only moves by gravity and by the attraction.

Notes

• The loss is per frame and not per second, so the same value damps more at a higher frame rate.

DampingEnd

F32 = 0.5

Removed in 16.14

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

DampingStart

F32 = 0.5

Removed in 16.14

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

Envelope

Embed<CurveScaledFloat> = { "value": 1, "Curve": null, "UseCurve": true }

16.14

Documentation Edit documentation

How much of the simulation shows on the joint, from 0 to 1. The joint is blended between its animated and its simulated transform by this value, times GlobalEnvelope, times the weight of the modifier. The simulation runs in full whatever the value is. Only the result on screen is blended.

EnvelopeEnd

F32 = 1

Removed in 16.14 16.9

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

EnvelopeStart

F32 = 1

Removed in 16.14 16.9

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

JointRadius

Embed<CurveScaledFloat> = { "value": 5, "Curve": null, "UseCurve": true }

16.14

Documentation Edit documentation

The radius of the joint for collision, in world units. A joint is pushed out of a collision shape until it is this far from the surface. 0 or less turns collision off for the joint.

JointRadiusEnd

F32 = 5

Removed in 16.14

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

JointRadiusStart

F32 = 5

Removed in 16.14

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

LimitAngle

Embed<CurveScaledFloat> = { "value": 180, "Curve": null, "UseCurve": true }

16.14

Documentation Edit documentation

The largest angle, in degrees, between the direction of a simulated segment and its direction in the animated pose. A joint that swings further is put back on the edge of that cone. 180 or more, which is the default, sets no limit.

LimitAngleEnd

F32 = 180

Removed in 16.14 16.9

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

LimitAngleStart

F32 = 180

Removed in 16.14 16.9

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

RodBendStiffness

Embed<CurveScaledFloat> = { "value": 1, "Curve": null, "UseCurve": true }

16.14

Documentation Edit documentation

With UseRodPhysics: how much two rods in a row resist bending away from the angle they have in the animated pose, from 0 to 1. 1, which is the default, keeps the animated angle. The scale is logarithmic, and a longer segment bends more easily at the same value.

RodBendStiffnessEnd

F32 = 1

Removed in 16.14 16.13

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

RodBendStiffnessStart

F32 = 1

Removed in 16.14 16.13

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

RodShearStiffness

Embed<CurveScaledFloat> = { "value": 1, "Curve": null, "UseCurve": true }

16.14

Documentation Edit documentation

With UseRodPhysics: how much a rod resists pointing away from the line between its two joints, from 0 to 1. 1, which is the default, keeps the rotation of the rod on that line. The scale is the same as for RodStretchStiffness.

RodShearStiffnessEnd

F32 = 1

Removed in 16.14 16.13

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

RodShearStiffnessStart

F32 = 1

Removed in 16.14 16.13

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

RodStretchStiffness

Embed<CurveScaledFloat> = { "value": 1, "Curve": null, "UseCurve": true }

16.14

Documentation Edit documentation

With UseRodPhysics: how much a rod resists a change of its length, from 0 to 1. 1, which is the default, keeps the length fixed. The scale is logarithmic: each step of 0.11 makes the rod ten times softer.

RodStretchStiffnessEnd

F32 = 1

Removed in 16.14 16.13

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

RodStretchStiffnessStart

F32 = 1

Removed in 16.14 16.13

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

RodTwistStiffness

Embed<CurveScaledFloat> = { "value": 1, "Curve": null, "UseCurve": true }

16.14

Documentation Edit documentation

With UseRodPhysics: how much two rods in a row resist twisting around their length away from the animated pose, from 0 to 1. The scale is the same as for RodBendStiffness.

RodTwistStiffnessEnd

F32 = 1

Removed in 16.14 16.13

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

RodTwistStiffnessStart

F32 = 1

Removed in 16.14 16.13

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

StiffnessEnd

F32 = 0.5

Removed in 16.9

Documentation Edit documentation

Removed from current builds. The value of the pose attraction at the tips. See AnimPoseAttraction.

StiffnessStart

F32 = 0.5

Removed in 16.9

Documentation Edit documentation

Removed from current builds. The value of the pose attraction at the root, before the parameter had a curve. See AnimPoseAttraction.

Stretch

Embed<CurveScaledFloat> = { "value": 0, "Curve": null, "UseCurve": true }

16.14

Documentation Edit documentation

How much the length of a segment can change, from 0 to 1. After each step the length is set to (1 - Stretch) of its rest length plus Stretch of the length it has in the simulation. 0, which is the default, keeps the length fixed. 1 lets the joint go any distance from its parent.

Notes

• Not used with UseRodPhysics.

StretchEnd

F32 = 0

Removed in 16.14 16.9

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

StretchStart

F32 = 0

Removed in 16.14 16.9

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

UseRodPhysics

Bool = false

16.13

Documentation Edit documentation

Simulates the segments of the group as rods with a rotation, in place of points. See the class description. The rod constraints are added only on joints with exactly one simulated child, so a joint where the tree branches and the tips of the tree get none.

Referenced by 1 class · 1 property

• DynamicsJointTreeGroupData ChainProperties Embed<DynamicsChainProperties>

AnimPoseAttraction

AnimPoseStiffnessEnd

AnimPoseStiffnessStart

Damping

DampingEnd

DampingStart

Envelope

EnvelopeEnd

EnvelopeStart

JointRadius

JointRadiusEnd

JointRadiusStart

LimitAngle

LimitAngleEnd

LimitAngleStart

RodBendStiffness

RodBendStiffnessEnd

RodBendStiffnessStart

RodShearStiffness

RodShearStiffnessEnd

RodShearStiffnessStart

RodStretchStiffness

RodStretchStiffnessEnd

RodStretchStiffnessStart

RodTwistStiffness

RodTwistStiffnessEnd

RodTwistStiffnessStart

StiffnessEnd

StiffnessStart

Stretch

StretchEnd

StretchStart

UseRodPhysics