SpringBoneSimulator3D

public Vector3 ExternalForce { get; set; }

The constant force that always affected bones. It is equal to the result when the parent Skeleton3D moves at this speed in the opposite direction. This is useful for effects such as wind and anti-gravity.

public bool MutableBoneAxes { get; set; }

If true, the solver retrieves the bone axis from the bone pose every frame. If false, the solver retrieves the bone axis from the bone rest and caches it, which increases performance slightly, but position changes in the bone pose made before processing this SpringBoneSimulator3D are ignored.

public int SettingCount { get; set; }

The number of settings.

public bool AreAllChildCollisionsEnabled(int index);

Returns true if all child SpringBoneCollision3Ds are contained in the collision list at index in the settings.

public void ClearCollisions(int index);

Clears all collisions from the collision list at index in the settings when SpringBoneSimulator3D.AreAllChildCollisionsEnabled is false.

public void ClearExcludeCollisions(int index);

Clears all exclude collisions from the collision list at index in the settings when SpringBoneSimulator3D.AreAllChildCollisionsEnabled is true.

public void ClearSettings();

Clears all settings.

public int GetCenterBone(int index);

Returns the center bone index of the bone chain.

public string GetCenterBoneName(int index);

Returns the center bone name of the bone chain.

public EntityPath GetCenterEntity(int index);

Returns the center node path of the bone chain.

public SpringBoneSimulator3D.CenterFrom GetCenterFrom(int index);

Returns what the center originates from in the bone chain.

public int GetCollisionCount(int index);

Returns the collision count of the bone chain's collision list when SpringBoneSimulator3D.AreAllChildCollisionsEnabled is false.

public EntityPath GetCollisionPath(int index, int collision);

Returns the node path of the SpringBoneCollision3D at collision in the bone chain's collision list when SpringBoneSimulator3D.AreAllChildCollisionsEnabled is false.

public float GetDrag(int index);

Returns the drag force damping curve of the bone chain.

public Curve GetDragDampingCurve(int index);

Returns the drag force damping curve of the bone chain.

public int GetEndBone(int index);

Returns the end bone index of the bone chain.

public SkeletonModifier3D.BoneDirection GetEndBoneDirection(int index);

Returns the tail direction of the end bone of the bone chain when SpringBoneSimulator3D.IsEndBoneExtended is true.

public float GetEndBoneLength(int index);

Returns the end bone tail length of the bone chain when SpringBoneSimulator3D.IsEndBoneExtended is true.

public string GetEndBoneName(int index);

Returns the end bone name of the bone chain.

public int GetExcludeCollisionCount(int index);

Returns the exclude collision count of the bone chain's exclude collision list when SpringBoneSimulator3D.AreAllChildCollisionsEnabled is true.

public EntityPath GetExcludeCollisionPath(int index, int collision);

Returns the node path of the SpringBoneCollision3D at collision in the bone chain's exclude collision list when SpringBoneSimulator3D.AreAllChildCollisionsEnabled is true.

public float GetGravity(int index);

Returns the gravity amount of the bone chain.

public Curve GetGravityDampingCurve(int index);

Returns the gravity amount damping curve of the bone chain.

public Vector3 GetGravityDirection(int index);

Returns the gravity direction of the bone chain.

public int GetJointBone(int index, int joint);

Returns the bone index at joint in the bone chain's joint list.

public string GetJointBoneName(int index, int joint);

Returns the bone name at joint in the bone chain's joint list.

public int GetJointCount(int index);

Returns the joint count of the bone chain's joint list.

public float GetJointDrag(int index, int joint);

Returns the drag force at joint in the bone chain's joint list.

public float GetJointGravity(int index, int joint);

Returns the gravity amount at joint in the bone chain's joint list.

public Vector3 GetJointGravityDirection(int index, int joint);

Returns the gravity direction at joint in the bone chain's joint list.

public float GetJointRadius(int index, int joint);

Returns the radius at joint in the bone chain's joint list.

public SkeletonModifier3D.RotationAxis GetJointRotationAxis(int index, int joint);

Returns the rotation axis at joint in the bone chain's joint list.

public Vector3 GetJointRotationAxisVector(int index, int joint);

Returns the rotation axis vector for the specified joint in the bone chain. This vector represents the axis around which the joint can rotate. It is determined based on the rotation axis set for the joint. If SpringBoneSimulator3D.GetJointRotationAxis is SkeletonModifier3D.RotationAxis.All, this method returns Vector3(0, 0, 0).

public float GetJointStiffness(int index, int joint);

Returns the stiffness force at joint in the bone chain's joint list.

public float GetRadius(int index);

Returns the joint radius of the bone chain.

public Curve GetRadiusDampingCurve(int index);

Returns the joint radius damping curve of the bone chain.

public int GetRootBone(int index);

Returns the root bone index of the bone chain.

public string GetRootBoneName(int index);

Returns the root bone name of the bone chain.

public SkeletonModifier3D.RotationAxis GetRotationAxis(int index);

Returns the rotation axis of the bone chain.

public Vector3 GetRotationAxisVector(int index);

Returns the rotation axis vector of the bone chain. This vector represents the axis around which the bone chain can rotate. It is determined based on the rotation axis set for the bone chain. If SpringBoneSimulator3D.GetRotationAxis is SkeletonModifier3D.RotationAxis.All, this method returns Vector3(0, 0, 0).

public float GetStiffness(int index);

Returns the stiffness force of the bone chain.

public Curve GetStiffnessDampingCurve(int index);

Returns the stiffness force damping curve of the bone chain.

public bool IsConfigIndividual(int index);

Returns true if the config can be edited individually for each joint.

public bool IsEndBoneExtended(int index);

Returns true if the end bone is extended to have a tail.

public void Reset();

Resets a simulating state with respect to the current bone pose. It is useful to prevent the simulation result getting violent. For example, calling this immediately after a call to AnimationPlayer.Play without a fading, or within the previous SkeletonModifier3D.ModificationProcessed signal if its condition changes significantly.

public void SetCenterBone(int index, int bone);

Sets the center bone index of the bone chain.

public void SetCenterBoneName(int index, string boneName);

Sets the center bone name of the bone chain.

public void SetCenterEntity(int index, EntityPath entityPath);

Sets the center node path of the bone chain.

public void SetCenterFrom(int index, SpringBoneSimulator3D.CenterFrom centerFrom);

Sets what the center originates from in the bone chain. Bone movement is calculated based on the difference in relative distance between center and bone in the previous and next frames. For example, if the parent Skeleton3D is used as the center, the bones are considered to have not moved if the Skeleton3D moves in the world. In this case, only a change in the bone pose is considered to be a bone movement.

public void SetCollisionCount(int index, int count);

Sets the number of collisions in the collision list at index in the settings when SpringBoneSimulator3D.AreAllChildCollisionsEnabled is false.

public void SetCollisionPath(int index, int collision, EntityPath entityPath);

Sets the node path of the SpringBoneCollision3D at collision in the bone chain's collision list when SpringBoneSimulator3D.AreAllChildCollisionsEnabled is false.

public void SetDrag(int index, float drag);

Sets the drag force of the bone chain. The greater the value, the more suppressed the wiggling. The value is scaled by SpringBoneSimulator3D.SetDragDampingCurve and cached in each joint setting in the joint list.

public void SetDragDampingCurve(int index, Curve curve);

Sets the drag force damping curve of the bone chain.

public void SetEnableAllChildCollisions(int index, bool enabled);

If enabled is true, all child SpringBoneCollision3Ds are colliding and SpringBoneSimulator3D.SetExcludeCollisionPath is enabled as an exclusion list at index in the settings. If enabled is false, you need to manually register all valid collisions with SpringBoneSimulator3D.SetCollisionPath.

public void SetEndBone(int index, int bone);

Sets the end bone index of the bone chain.

public void SetEndBoneDirection(int index, SkeletonModifier3D.BoneDirection boneDirection);

Sets the end bone tail direction of the bone chain when SpringBoneSimulator3D.IsEndBoneExtended is true.

public void SetEndBoneDirection(int index, int boneDirection);

Sets the end bone tail direction of the bone chain when SpringBoneSimulator3D.IsEndBoneExtended is true.

public void SetEndBoneLength(int index, float length);

Sets the end bone tail length of the bone chain when SpringBoneSimulator3D.IsEndBoneExtended is true.

public void SetEndBoneName(int index, string boneName);

Sets the end bone name of the bone chain. Note: End bone must be the root bone or a child of the root bone. If they are the same, the tail must be extended by SpringBoneSimulator3D.SetExtendEndBone to jiggle the bone.

public void SetExcludeCollisionCount(int index, int count);

Sets the number of exclude collisions in the exclude collision list at index in the settings when SpringBoneSimulator3D.AreAllChildCollisionsEnabled is true.

public void SetExcludeCollisionPath(int index, int collision, EntityPath entityPath);

Sets the node path of the SpringBoneCollision3D at collision in the bone chain's exclude collision list when SpringBoneSimulator3D.AreAllChildCollisionsEnabled is true.

public void SetExtendEndBone(int index, bool enabled);

If enabled is true, the end bone is extended to have a tail. The extended tail config is allocated to the last element in the joint list. In other words, if you set enabled to false, the config of the last element in the joint list has no effect in the simulated result.

public void SetGravity(int index, float gravity);

Sets the gravity amount of the bone chain. This value is not an acceleration, but a constant velocity of movement in SpringBoneSimulator3D.SetGravityDirection. If gravity is not 0, the modified pose will not return to the original pose since it is always affected by gravity. The value is scaled by SpringBoneSimulator3D.SetGravityDampingCurve and cached in each joint setting in the joint list.

public void SetGravityDampingCurve(int index, Curve curve);

Sets the gravity amount damping curve of the bone chain.

public void SetGravityDirection(int index, Vector3 gravityDirection);

Sets the gravity direction of the bone chain. This value is internally normalized and then multiplied by SpringBoneSimulator3D.SetGravity. The value is cached in each joint setting in the joint list.

public void SetIndividualConfig(int index, bool enabled);

If enabled is true, the config can be edited individually for each joint.

public void SetJointDrag(int index, int joint, float drag);

Sets the drag force at joint in the bone chain's joint list when SpringBoneSimulator3D.IsConfigIndividual is true.

public void SetJointGravity(int index, int joint, float gravity);

Sets the gravity amount at joint in the bone chain's joint list when SpringBoneSimulator3D.IsConfigIndividual is true.

public void SetJointGravityDirection(int index, int joint, Vector3 gravityDirection);

Sets the gravity direction at joint in the bone chain's joint list when SpringBoneSimulator3D.IsConfigIndividual is true.

public void SetJointRadius(int index, int joint, float radius);

Sets the joint radius at joint in the bone chain's joint list when SpringBoneSimulator3D.IsConfigIndividual is true.

public void SetJointRotationAxis(int index, int joint, SkeletonModifier3D.RotationAxis axis);

Sets the rotation axis at joint in the bone chain's joint list when SpringBoneSimulator3D.IsConfigIndividual is true. The axes are based on the reference pose's space, if axis is SkeletonModifier3D.RotationAxis.Custom, you can specify any axis. In here, the reference pose is the bone pose immediately before the simulation. Note: The rotation axis and the forward vector shouldn't be colinear to avoid unintended rotation since SpringBoneSimulator3D does not factor in twisting forces.

public void SetJointRotationAxis(int index, int joint, int axis);

Sets the rotation axis at joint in the bone chain's joint list when SpringBoneSimulator3D.IsConfigIndividual is true. The axes are based on the reference pose's space, if axis is SkeletonModifier3D.RotationAxis.Custom, you can specify any axis. In here, the reference pose is the bone pose immediately before the simulation. Note: The rotation axis and the forward vector shouldn't be colinear to avoid unintended rotation since SpringBoneSimulator3D does not factor in twisting forces.

public void SetJointRotationAxisVector(int index, int joint, Vector3 vector);

Sets the rotation axis vector for the specified joint in the bone chain. This vector is normalized by an internal process and represents the axis around which the bone chain can rotate. If the vector length is 0, it is considered synonymous with SkeletonModifier3D.RotationAxis.All.

public void SetJointStiffness(int index, int joint, float stiffness);

Sets the stiffness force at joint in the bone chain's joint list when SpringBoneSimulator3D.IsConfigIndividual is true.

public void SetRadius(int index, float radius);

Sets the joint radius of the bone chain. It is used to move and slide with the SpringBoneCollision3D in the collision list. The value is scaled by SpringBoneSimulator3D.SetRadiusDampingCurve and cached in each joint setting in the joint list.

public void SetRadiusDampingCurve(int index, Curve curve);

Sets the joint radius damping curve of the bone chain.

public void SetRootBone(int index, int bone);

Sets the root bone index of the bone chain.

public void SetRootBoneName(int index, string boneName);

Sets the root bone name of the bone chain.

public void SetRotationAxis(int index, SkeletonModifier3D.RotationAxis axis);

Sets the rotation axis of the bone chain. If set to a specific axis, it acts like a hinge joint. The value is cached in each joint setting in the joint list. The axes are based on the reference pose's space, if axis is SkeletonModifier3D.RotationAxis.Custom, you can specify any axis. In here, the reference pose is the bone pose immediately before the simulation. Note: The rotation axis vector and the forward vector shouldn't be colinear to avoid unintended rotation since SpringBoneSimulator3D does not factor in twisting forces.

public void SetRotationAxis(int index, int axis);

Sets the rotation axis of the bone chain. If set to a specific axis, it acts like a hinge joint. The value is cached in each joint setting in the joint list. The axes are based on the reference pose's space, if axis is SkeletonModifier3D.RotationAxis.Custom, you can specify any axis. In here, the reference pose is the bone pose immediately before the simulation. Note: The rotation axis vector and the forward vector shouldn't be colinear to avoid unintended rotation since SpringBoneSimulator3D does not factor in twisting forces.

public void SetRotationAxisVector(int index, Vector3 vector);

Sets the rotation axis vector of the bone chain. The value is cached in each joint setting in the joint list. This vector is normalized by an internal process and represents the axis around which the bone chain can rotate. If the vector length is 0, it is considered synonymous with SkeletonModifier3D.RotationAxis.All.

public void SetStiffness(int index, float stiffness);

Sets the stiffness force of the bone chain. The greater the value, the faster it recovers to its initial pose. If stiffness is 0, the modified pose will not return to the original pose. The value is scaled by SpringBoneSimulator3D.SetStiffnessDampingCurve and cached in each joint setting in the joint list.

public void SetStiffnessDampingCurve(int index, Curve curve);

Sets the stiffness force damping curve of the bone chain.