SpringBoneCollision3D
A base class of the collision that interacts with SpringBoneSimulator3D.
A base class of the collision that interacts with SpringBoneSimulator3D.
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.SetCollisionPath. If SpringBoneSimulator3D.AreAllChildCollisionsEnabled is true, the order matches EntityTree.
If SpringBoneCollision3D.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.
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Constructors1
SpringBoneCollision3DConstructor
public SpringBoneCollision3D();Properties4
BoneProperty
public int Bone { get; set; }The index of the attached bone.
BoneNameProperty
public string BoneName { get; set; }The name of the attached bone.
PositionOffsetProperty
public Vector3 PositionOffset { get; set; }The offset of the position from Skeleton3D's SpringBoneCollision3D.Bone pose position.
RotationOffsetProperty
public Quaternion RotationOffset { get; set; }The offset of the rotation from Skeleton3D's SpringBoneCollision3D.Bone pose rotation.
Methods9
GetBoneint
public int GetBone();intGetBoneNamestring
public string GetBoneName();stringGetPositionOffsetVector3
public Vector3 GetPositionOffset();Vector3GetRotationOffsetQuaternion
public Quaternion GetRotationOffset();QuaternionGetSkeletonSkeleton3D
public Skeleton3D GetSkeleton();Get parent Skeleton3D node of the parent SpringBoneSimulator3D if found.
Skeleton3DSetBonevoid
public void SetBone(int bone);| Name | Type | Default |
|---|---|---|
bone | int | — |
SetBoneNamevoid
public void SetBoneName(string boneName);| Name | Type | Default |
|---|---|---|
boneName | string | — |
SetPositionOffsetvoid
public void SetPositionOffset(Vector3 offset);| Name | Type | Default |
|---|---|---|
offset | Vector3 | — |
SetRotationOffsetvoid
public void SetRotationOffset(Quaternion offset);| Name | Type | Default |
|---|---|---|
offset | Quaternion | — |