Class SpringBoneCollision3D

A base class of the collision that interacts with SpringBoneSimulator3D.

Inheritance

Node3D

Node

Object

SpringBoneCollision3D

Derived

SpringBoneCollisionCapsule3D

SpringBoneCollisionPlane3D

SpringBoneCollisionSphere3D

Remarks

A collision can be a child of SpringBoneSimulator3D. If it is not a child of SpringBoneSimulator3D, it has no effect.

The colliding and sliding are done in the SpringBoneSimulator3D's modification process in order of its collision list which is set by SpringBoneSimulator3D.set_collision_path. If SpringBoneSimulator3D.are_all_child_collisions_enabled is true, the order matches SceneTree.

If bone is set, it synchronizes with the bone pose of the ancestor Skeleton3D, which is done in before the SpringBoneSimulator3D's modification process as the pre-process.

Warning: A scaled SpringBoneCollision3D will likely not behave as expected. Make sure that the parent Skeleton3D and its bones are not scaled.

Properties

bone

The index of the attached bone.

var bone : int = -1

Property Value

int

Remarks

• void set_bone(int value)
• int get_bone

bone_name

The name of the attached bone.

var bone_name : String = ""

Property Value

String

Remarks

• void set_bone_name(String value)
• String get_bone_name

position_offset

The offset of the position from Skeleton3D's bone pose position.

var position_offset : Vector3

Property Value

Vector3

Remarks

• void set_position_offset(Vector3 value)
• Vector3 get_position_offset

rotation_offset

The offset of the rotation from Skeleton3D's bone pose rotation.

var rotation_offset : Quaternion

Property Value

Quaternion

Remarks

• void set_rotation_offset(Quaternion value)
• Quaternion get_rotation_offset

Methods

get_skeleton

Qualifiers: const

Get parent Skeleton3D node of the parent SpringBoneSimulator3D if found.

Skeleton3D get_skeleton