SpringBoneCollisionCapsule3D

A capsule shape collision that interacts with SpringBoneSimulator3D.

1.0.0

class SpringBoneCollisionCapsule3DReckfellSharpInherits SpringBoneCollision3D

A capsule shape collision that interacts with SpringBoneSimulator3D.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

SpringBoneCollisionCapsule3DConstructor

C#
public SpringBoneCollisionCapsule3D();

Properties4

HeightProperty

# Height

C#
public float Height { get; set; }

The capsule's full height, including the hemispheres. Note: The SpringBoneCollisionCapsule3D.Height of a capsule must be at least twice its SpringBoneCollisionCapsule3D.Radius. Otherwise, the capsule becomes a sphere. If the SpringBoneCollisionCapsule3D.Height is less than twice the SpringBoneCollisionCapsule3D.Radius, the properties adjust to a valid value.

InsideProperty

# Inside

C#
public bool Inside { get; set; }

If true, the collision acts to trap the joint within the collision.

MidHeightProperty

# MidHeight

C#
public float MidHeight { get; set; }

The capsule's height, excluding the hemispheres. This is the height of the central cylindrical part in the middle of the capsule, and is the distance between the centers of the two hemispheres. This is a wrapper for SpringBoneCollisionCapsule3D.Height.

RadiusProperty

# Radius

C#
public float Radius { get; set; }

The capsule's radius. Note: The SpringBoneCollisionCapsule3D.Radius of a capsule cannot be greater than half of its SpringBoneCollisionCapsule3D.Height. Otherwise, the capsule becomes a sphere. If the SpringBoneCollisionCapsule3D.Radius is greater than half of the SpringBoneCollisionCapsule3D.Height, the properties adjust to a valid value.

Methods8

GetHeightfloat

# GetHeight

C#
public float GetHeight();

Returns float

GetMidHeightfloat

# GetMidHeight

C#
public float GetMidHeight();

Returns float

GetRadiusfloat

# GetRadius

C#
public float GetRadius();

Returns float

IsInsidebool

# IsInside

C#
public bool IsInside();

Returns bool

SetHeightvoid

# SetHeight

C#
public void SetHeight(float height);

Parameters
Name	Type	Default
`height`	`float`	—

SetInsidevoid

# SetInside

C#
public void SetInside(bool enabled);

Parameters
Name	Type	Default
`enabled`	`bool`	—

SetMidHeightvoid

# SetMidHeight

C#
public void SetMidHeight(float midHeight);

Parameters
Name	Type	Default
`midHeight`	`float`	—

SetRadiusvoid

# SetRadius

C#
public void SetRadius(float radius);

Parameters
Name	Type	Default
`radius`	`float`	—

Reckfell Engine documentationBack to top ↑