Class SupportPrimitives

Namespace

Jitter2.Collision

Assembly

Jitter2.dll

Provides built-in primitive support-mapped query types and helper methods for constructing them.

public static class SupportPrimitives

Inheritance

object

SupportPrimitives

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

CreateBox(JVector)

Creates a box support primitive.

public static SupportPrimitives.Box CreateBox(JVector halfExtents)

Parameters

halfExtents JVector

The positive half-extents of the box.

Returns

SupportPrimitives.Box

Exceptions

ArgumentOutOfRangeException

Thrown when any component of halfExtents is less than or equal to zero or not finite.

CreateCapsule(float, float)

Creates a capsule support primitive whose symmetry axis is the Y-axis.

public static SupportPrimitives.Capsule CreateCapsule(float radius, float halfLength)

Parameters

radius float

The capsule radius.

halfLength float

The non-negative half-length of the capsule segment.

Returns

SupportPrimitives.Capsule

Exceptions

ArgumentOutOfRangeException

Thrown when radius is less than or equal to zero, when halfLength is negative, or when either value is not finite.

CreateCone(float, float)

Creates a cone support primitive whose symmetry axis is the Y-axis.

public static SupportPrimitives.Cone CreateCone(float radius, float height)

Parameters

radius float

The cone radius.

height float

The cone height.

Returns

SupportPrimitives.Cone

Exceptions

ArgumentOutOfRangeException

Thrown when radius or height is less than or equal to zero or not finite.

CreateCylinder(float, float)

Creates a cylinder support primitive whose symmetry axis is the Y-axis.

public static SupportPrimitives.Cylinder CreateCylinder(float radius, float halfHeight)

Parameters

radius float

The cylinder radius.

halfHeight float

The positive half-height of the cylinder.

Returns

SupportPrimitives.Cylinder

Exceptions

ArgumentOutOfRangeException

Thrown when radius or halfHeight is less than or equal to zero or not finite.

CreatePoint()

Creates a point support primitive at the origin.

public static SupportPrimitives.Point CreatePoint()

Returns

SupportPrimitives.Point

CreateSphere(float)

Creates a sphere support primitive.

public static SupportPrimitives.Sphere CreateSphere(float radius)

Parameters

radius float

The sphere radius.

Returns

SupportPrimitives.Sphere

Exceptions

ArgumentOutOfRangeException

Thrown when radius is less than or equal to zero or not finite.