reckfellENGINE

SpringBoneCollision3D

A base class of the collision that interacts with SpringBoneSimulator3D.

On this page
class SpringBoneCollision3DReckfellSharpInherits Entity3D

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
# SpringBoneCollision3D
C#
public SpringBoneCollision3D();

Properties4

BoneProperty
# Bone
C#
public int Bone { get; set; }

The index of the attached bone.

BoneNameProperty
# BoneName
C#
public string BoneName { get; set; }

The name of the attached bone.

PositionOffsetProperty
# PositionOffset
C#
public Vector3 PositionOffset { get; set; }

The offset of the position from Skeleton3D's SpringBoneCollision3D.Bone pose position.

RotationOffsetProperty
# RotationOffset
C#
public Quaternion RotationOffset { get; set; }

The offset of the rotation from Skeleton3D's SpringBoneCollision3D.Bone pose rotation.

Methods9

GetBoneint
# GetBone
C#
public int GetBone();
Returns int
GetBoneNamestring
# GetBoneName
C#
public string GetBoneName();
Returns string
GetPositionOffsetVector3
# GetPositionOffset
C#
public Vector3 GetPositionOffset();
Returns Vector3
GetRotationOffsetQuaternion
# GetRotationOffset
C#
public Quaternion GetRotationOffset();
Returns Quaternion
GetSkeletonSkeleton3D
# GetSkeleton
C#
public Skeleton3D GetSkeleton();

Get parent Skeleton3D node of the parent SpringBoneSimulator3D if found.

Returns Skeleton3D
SetBonevoid
# SetBone
C#
public void SetBone(int bone);
Parameters
NameTypeDefault
boneint—
SetBoneNamevoid
# SetBoneName
C#
public void SetBoneName(string boneName);
Parameters
NameTypeDefault
boneNamestring—
SetPositionOffsetvoid
# SetPositionOffset
C#
public void SetPositionOffset(Vector3 offset);
Parameters
NameTypeDefault
offsetVector3—
SetRotationOffsetvoid
# SetRotationOffset
C#
public void SetRotationOffset(Quaternion offset);
Parameters
NameTypeDefault
offsetQuaternion—
Reckfell Engine documentationBack to top ↑
QUICK LINKSGetting startedEntity hierarchyC# & .NET 10Scenes and prefabs
Reckfell guides and full API K
reckfellENGINE
RECKFELL ACCOUNT

Sign in

Sign in to your Reckfell account.

One account for the entire Reckfell platform.