com.bonzaiengine.visibility

Class OrientedVolume

java.lang.Object

com.bonzaiengine.visibility.OrientedVolume

All Implemented Interfaces:

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

public final class OrientedVolume
extends java.lang.Object
implements IVolume<OrientedVolume>

A bounding volume oriented by a matrix

Method Summary

Modifier and Type	Method and Description
OrientedVolume	addScale(OrientedVolume current, OrientedVolume next, float t)
OrientedVolume	clone()
IVolume<?>	concatenate(OrientedVolume other) Concatenate this volume with other in a new IVolume object
float	distanceToPlane(Plane plane, boolean min)
IVolume	getAxisAlignedVolume()
float	getVolume()
boolean	insideFrustum(Frustum frustum)
OrientedVolume	interpolate(OrientedVolume current, OrientedVolume next, float t) Interpolate current and next and store result in this.
IntersectTest	intersectTest(Frustum frustum) Test the intersection between this IBoundingVolume and the specified Frustum.
IntersectTest	intersectTest(OrientedVolume other)
Vec3	limitInVolume(Vec3 dst, Vec3 src) Limit a point in this volume.
static IVolume	of(IVolume volume, ITransformable transformable)
static IVolume	of(IVolume volume, Mat4x4 matrix)
static IVolume	of(IVolume volume, Transform t)
OrientedVolume	set(OrientedVolume src)
OrientedVolume	subtract(OrientedVolume bv1, OrientedVolume bv2)
java.lang.String	toString()
OrientedVolume	transform(OrientedVolume volume, Mat4x4 matrix)

Methods inherited from class java.lang.Object

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

Method Detail

of

public static IVolume of(IVolume volume,
                         ITransformable transformable)

of

public static IVolume of(IVolume volume,
                         Transform t)

of

public static IVolume of(IVolume volume,
                         Mat4x4 matrix)

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

public final OrientedVolume clone()

Specified by:

clone in interface IData<OrientedVolume>

Specified by:

clone in interface IValueCopy<OrientedVolume>

Specified by:

clone in interface IVolume<OrientedVolume>

Overrides:

clone in class java.lang.Object

set

public final OrientedVolume set(OrientedVolume src)

Specified by:

set in interface IValueCopy<OrientedVolume>

getVolume

public final float getVolume()

Specified by:

getVolume in interface IVolume<OrientedVolume>

Returns:

the volume of this OrientedVolume

transform

public final OrientedVolume transform(OrientedVolume volume,
                                      Mat4x4 matrix)

Specified by:

transform in interface IVolume<OrientedVolume>

Parameters:

volume - a IBoundingVolume

matrix - a Mat4x4

Returns:

this = matrix * bv

concatenate

public final IVolume<?> concatenate(OrientedVolume other)

Description copied from interface: IVolume

Concatenate this volume with other in a new IVolume object

Specified by:

concatenate in interface IVolume<OrientedVolume>

Parameters:

other - a IBoundingVolume

Returns:

new concatenated volume

See Also:

Volumes.concatenate(IVolume, IVolume)

limitInVolume

public final Vec3 limitInVolume(Vec3 dst,
                                Vec3 src)

Description copied from interface: IVolume

Limit a point in this volume. The point is displaced to the closest position (volume boundary) if it exceed this volume.

Specified by:

limitInVolume in interface IVolume<OrientedVolume>

Parameters:

dst - destination vector to store the result

src - source point

Returns:

dst

intersectTest

public IntersectTest intersectTest(OrientedVolume other)

Specified by:

intersectTest in interface IVolume<OrientedVolume>

Parameters:

other - another volume

Returns:

true if this and the specified volume collides

interpolate

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

Description copied from interface: IInterpolable

Interpolate current and next and store result in this.

Specified by:

interpolate in interface IInterpolable<OrientedVolume>

Specified by:

interpolate in interface IData<OrientedVolume>

Specified by:

interpolate in interface IVolume<OrientedVolume>

Parameters:

current - a IBoundingVolume

next - a IBoundingVolume

t - value in range [0;1]

Returns:

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

addScale

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

Specified by:

addScale in interface IVolume<OrientedVolume>

Parameters:

current - a IBoundingVolume

next - a IBoundingVolume

Returns:

this = bv1 + bv2 * t

subtract

public OrientedVolume subtract(OrientedVolume bv1,
                               OrientedVolume bv2)

Specified by:

subtract in interface IVolume<OrientedVolume>

Parameters:

bv1 - a IBoundingVolume

bv2 - a IBoundingVolume

Returns:

this = bv1 - bv2

intersectTest

public final IntersectTest intersectTest(Frustum frustum)

Description copied from interface: IVolume

Test the intersection between this IBoundingVolume and the specified Frustum.

Specified by:

intersectTest in interface IVolume<OrientedVolume>

Returns:

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

See Also:

IntersectTest, IVolume.insideFrustum(Frustum)

insideFrustum

public final boolean insideFrustum(Frustum frustum)

Specified by:

insideFrustum in interface IVolume<OrientedVolume>

Returns:

true if the volume is inside the specified Frustum.

distanceToPlane

public final float distanceToPlane(Plane plane,
                                   boolean min)

Specified by:

distanceToPlane in interface IVolume<OrientedVolume>

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

getAxisAlignedVolume

public IVolume getAxisAlignedVolume()