com.bonzaiengine.visibility

Class Capsule

java.lang.Object

com.bonzaiengine.visibility.Capsule

All Implemented Interfaces:

IInterpolable<Capsule>, IData<Capsule>, IValueCopy<Capsule>, IVolume<Capsule>, java.lang.Cloneable

public class Capsule
extends java.lang.Object
implements IVolume<Capsule>

The total height of the capsule is height + 2 * radius.
The height is therefore the distance between the capsule's two spheres.

Constructor Summary

Constructors

Constructor and Description
Capsule(Vec3 bottom, float radius, float height)

Method Summary

Modifier and Type	Method and Description
Capsule	addScale(Capsule current, Capsule next, float t)
Capsule	clone()
float	closestDistance(Capsule c)
Capsule	concatenate(Capsule other) Concatenate this volume with other in a new IVolume object
float	distanceToPlane(Plane plane, boolean min)
static Capsule	empty()
Vec3	getBottom(Vec3 dst)
Vec3	getCenter(Vec3 dst)
float	getHeight()
float	getRadius()
Vec3	getTop(Vec3 dst)
float	getTotalHeight()
float	getVolume()
boolean	insideFrustum(Frustum frustum)
Capsule	interpolate(Capsule current, Capsule next, float t) Interpolate current and next and store result in this.
IntersectTest	intersectTest(Capsule c) Collision test for sphere.
IntersectTest	intersectTest(Frustum frustum) Test the intersection between this IVolume and the specified Frustum.
IntersectTest	intersectTest(Plane plane) Test the intersection between this IVolume and the specified Frustum.
Vec3	limitInVolume(Vec3 dst, Vec3 src) Limit a point location in this volume.
Capsule	set(Capsule s)
void	set(Vec3 center, float radius, float height)
void	setBottom(Vec3 src)
void	setHeight(float height)
void	setRadius(float radius)
Capsule	subtract(Capsule bv1, Capsule bv2)
java.lang.String	toString()
Capsule	transform(Capsule bc, Mat4x4 matrix)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Capsule

public Capsule(Vec3 bottom,
               float radius,
               float height)

Method Detail

empty

public static Capsule empty()

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

public final Capsule clone()

Specified by:

clone in interface IData<Capsule>

Specified by:

clone in interface IValueCopy<Capsule>

Specified by:

clone in interface IVolume<Capsule>

Overrides:

clone in class java.lang.Object

set

public final Capsule set(Capsule s)

Specified by:

set in interface IValueCopy<Capsule>

getVolume

public final float getVolume()

Specified by:

getVolume in interface IVolume<Capsule>

Returns:

the volume of this Capsule

transform

public final Capsule transform(Capsule bc,
                               Mat4x4 matrix)

Specified by:

transform in interface IVolume<Capsule>

Parameters:

bc - a IVolume

matrix - a Mat4x4

Returns:

this = matrix * bv

concatenate

public final Capsule concatenate(Capsule other)

Description copied from interface: IVolume

Concatenate this volume with other in a new IVolume object

Specified by:

concatenate in interface IVolume<Capsule>

Parameters:

other - a IVolume

Returns:

new concatenated volume

See Also:

Volumes.concatenate(IVolume, IVolume)

limitInVolume

public final Vec3 limitInVolume(Vec3 dst,
                                Vec3 src)

Limit a point location in this volume. The point is displaced to the closest location if outside the volume.

Specified by:

limitInVolume in interface IVolume<Capsule>

Parameters:

src - source point

dst - destination vector to store the result

Returns:

dst

intersectTest

public IntersectTest intersectTest(Capsule c)

Collision test for sphere.

Specified by:

intersectTest in interface IVolume<Capsule>

Parameters:

c - a Capsule to test with

Returns:

true if the bounding sphere collide

closestDistance

public final float closestDistance(Capsule c)

interpolate

public final Capsule interpolate(Capsule current,
                                 Capsule next,
                                 float t)

Description copied from interface: IInterpolable

Interpolate current and next and store result in this.

Specified by:

interpolate in interface IInterpolable<Capsule>

Specified by:

interpolate in interface IData<Capsule>

Specified by:

interpolate in interface IVolume<Capsule>

Parameters:

current - a IVolume

next - a IVolume

t - value in range [0;1]

Returns:

this = bv1 * (1 - t) + bv2 * t

addScale

public final Capsule addScale(Capsule current,
                              Capsule next,
                              float t)

Specified by:

addScale in interface IVolume<Capsule>

Parameters:

current - a IVolume

next - a IVolume

Returns:

this = bv1 + bv2 * t

subtract

public Capsule subtract(Capsule bv1,
                        Capsule bv2)

Specified by:

subtract in interface IVolume<Capsule>

Parameters:

bv1 - a IVolume

bv2 - a IVolume

Returns:

this = bv1 - bv2

insideFrustum

public final boolean insideFrustum(Frustum frustum)

Specified by:

insideFrustum in interface IVolume<Capsule>

Returns:

true if the volume is inside the specified Frustum.

intersectTest

public final IntersectTest intersectTest(Frustum frustum)

Description copied from interface: IVolume

Test the intersection between this IVolume and the specified Frustum.

Specified by:

intersectTest in interface IVolume<Capsule>

Returns:

VolumeIntersection.Intersect if inside and intersect.
VolumeIntersection.Inside if inside but not intersect.
VolumeIntersection.Outisde if outside.

See Also:

IntersectTest, IVolume.insideFrustum(Frustum)

intersectTest

public final IntersectTest intersectTest(Plane plane)

Description copied from interface: IVolume

Test the intersection between this IVolume and the specified Frustum.

Specified by:

intersectTest in interface IVolume<Capsule>

Returns:

VolumeIntersection.Intersect if inside and intersect.
VolumeIntersection.Inside if inside but not intersect.
VolumeIntersection.Outisde if outside.

See Also:

IntersectTest, IVolume.insideFrustum(Frustum)

distanceToPlane

public final float distanceToPlane(Plane plane,
                                   boolean min)

Specified by:

distanceToPlane in interface IVolume<Capsule>

Parameters:

plane - a Plane

min - true: minimum distance
false: maximum distance

Returns:

negative value: volume intersect of is outside.
positive value: distance of the closest point

set

public final void set(Vec3 center,
                      float radius,
                      float height)

getBottom

public final Vec3 getBottom(Vec3 dst)

setBottom

public final void setBottom(Vec3 src)

getTop

public final Vec3 getTop(Vec3 dst)

getCenter

public final Vec3 getCenter(Vec3 dst)

getRadius

public final float getRadius()

setRadius

public final void setRadius(float radius)

getHeight

public final float getHeight()

setHeight

public final void setHeight(float height)

getTotalHeight

public final float getTotalHeight()