com.bonzaiengine.visibility

Interface IVolume<T extends IVolume<T>>

All Superinterfaces:

java.lang.Cloneable, IData<T>, IInterpolable<T>, IValueCopy<T>

All Known Implementing Classes:

Box, Capsule, Cylinder, MOrientedVolume, OrientedVolume, Sphere

public interface IVolume<T extends IVolume<T>>
extends IData<T>

Method Summary

Modifier and Type	Method and Description
T	addScale(T bv1, T bv2, float t)
T	clone()
IVolume<?>	concatenate(T other) Concatenate this volume with other in a new IVolume object
float	distanceToPlane(Plane plane, boolean min)
float	getVolume()
boolean	insideFrustum(Frustum frustum)
T	interpolate(T bv1, T bv2, float t) Interpolate current and next and store result in this.
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.
IntersectTest	intersectTest(T volume)
Vec3	limitInVolume(Vec3 dst, Vec3 src) Limit a point in this volume.
T	subtract(T bv1, T bv2)
T	transform(T volume, Mat4x4 matrix)

Methods inherited from interface com.bonzaiengine.util.IValueCopy

set

Method Detail

clone

T clone()

Specified by:

clone in interface IData<T extends IVolume<T>>

Specified by:

clone in interface IValueCopy<T extends IVolume<T>>

transform

T transform(T volume,
            Mat4x4 matrix)

Parameters:

volume - a IVolume

matrix - a Mat4x4

Returns:

this = matrix * bv

concatenate

IVolume<?> concatenate(T other)

Concatenate this volume with other in a new IVolume object

Parameters:

other - a IVolume

Returns:

new concatenated volume

See Also:

Volumes.concatenate(IVolume, IVolume)

interpolate

T interpolate(T bv1,
              T bv2,
              float t)

Description copied from interface: IInterpolable

Interpolate current and next and store result in this.

Specified by:

interpolate in interface IData<T extends IVolume<T>>

Specified by:

interpolate in interface IInterpolable<T extends IVolume<T>>

Parameters:

bv1 - a IVolume

bv2 - a IVolume

t - value in range [0;1]

Returns:

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

addScale

T addScale(T bv1,
           T bv2,
           float t)

Parameters:

bv1 - a IVolume

bv2 - a IVolume

t -

Returns:

this = bv1 + bv2 * t

subtract

T subtract(T bv1,
           T bv2)

Parameters:

bv1 - a IVolume

bv2 - a IVolume

Returns:

this = bv1 - bv2

limitInVolume

Vec3 limitInVolume(Vec3 dst,
                   Vec3 src)

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

Parameters:

src - source point

dst - destination vector to store the result

Returns:

dst

getVolume

float getVolume()

Returns:

the volume of this IBoundable, in unit^3

intersectTest

IntersectTest intersectTest(T volume)

Parameters:

volume - another volume

Returns:

true if this and the specified volume collides

insideFrustum

boolean insideFrustum(Frustum frustum)

Returns:

true if the volume is inside the specified Frustum.

intersectTest

IntersectTest intersectTest(Plane plane)

Test the intersection between this IVolume and the specified Frustum.

Returns:

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

See Also:

IntersectTest, insideFrustum(Frustum)

intersectTest

IntersectTest intersectTest(Frustum frustum)

Test the intersection between this IVolume and the specified Frustum.

Returns:

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

See Also:

IntersectTest, insideFrustum(Frustum)

distanceToPlane

float distanceToPlane(Plane plane,
                      boolean min)

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