net.risingworld.api.utils

Class BoundingInformation

java.lang.Object

net.risingworld.api.utils.BoundingInformation

public class BoundingInformation
extends java.lang.Object

Describes a bounding volume of an element, i.e. the extends of the object along the x, y and z axis as well as the position of the center of the object.

Constructor Summary

Constructors

Constructor and Description
BoundingInformation() Creates an "empty" bounding information.
BoundingInformation(ModelInformation model) Creates a new bounding information and calculates the center position and extent based on the provided model information object.
BoundingInformation(Vector3f center, float xExtent, float yExtent, float zExtent) Creates a new bounding information.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
Vector3f	getCenter() Gets the center of this bounding information.
float	getXExtent() Gets the (half) extent along the x axis.
float	getYExtent() Gets the (half) extent along the y axis.
float	getZExtent() Gets the (half) extent along the z axis.
int	hashCode()
boolean	isPointInVolume(Vector3f point) Checks if the given point (represented as a Vector3f) is inside this bounding volume.
java.lang.String	toString() Gets a String representation of this area.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BoundingInformation

public BoundingInformation()

Creates an "empty" bounding information.

BoundingInformation

public BoundingInformation(Vector3f center,
                           float xExtent,
                           float yExtent,
                           float zExtent)

Creates a new bounding information.

Parameters:

center - the center of the bounding information.

xExtent - the half extent along the x axis.

yExtent - the half extent along the y axis.

zExtent - the half extent along the z axis.

BoundingInformation

public BoundingInformation(ModelInformation model)

Creates a new bounding information and calculates the center position and extent based on the provided model information object.

Parameters:

model - the ModelInformation to calculate the center/extent from.

Method Detail

getXExtent

public float getXExtent()

Gets the (half) extent along the x axis.

Returns:

the extent along the x axis.

getYExtent

public float getYExtent()

Gets the (half) extent along the y axis.

Returns:

the extent along the y axis.

getZExtent

public float getZExtent()

Gets the (half) extent along the z axis.

Returns:

the extent along the z axis.

getCenter

public Vector3f getCenter()

Gets the center of this bounding information.

Returns:

the position of the center.

isPointInVolume

public boolean isPointInVolume(Vector3f point)

Checks if the given point (represented as a Vector3f) is inside this bounding volume.

Parameters:

point - the point in 3d space (i.e. world position).

Returns:

true if the point is inside this bounding volume, false if not.

toString

public java.lang.String toString()

Gets a String representation of this area.

Overrides:

toString in class java.lang.Object

Returns:

a string representing the values of this area.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object