org.eclipse.january.geometry

Interface BoundingBox

All Superinterfaces:

org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:

BoundingBoxImpl

public interface BoundingBox
extends org.eclipse.emf.ecore.EObject

A representation of the model object ' Bounding Box'. A bounding box describes the minimally sized rectangular prism box to contain some region. The box is defined by two points on opposite sides of the prism, one formed from (minX, minY, minZ) and the other from (maxX, maxY, maxZ). These points are chosen such that minX is the smallest the x coordinate can be in any point within the prism, maxX is the maximal x coordinate value, minY is the minal y coordinate value, etc.

The following features are supported:

• Max X
• Max Y
• Max Z
• Min X
• Min Y
• Min Z

See Also:

GeometryPackage.getBoundingBox()

Method Summary

Modifier and Type	Method and Description
void	addArea(BoundingBox area) Adds the given bounding box's area to the area represented by this one.
static BoundingBox	getBounds(Shape shape) Describes the bounds of the specified Shape object as the smallest box, orthogonal to the axes, that can contain the specified shape.
static BoundingBox	getBounds(Union union) Gets the smallest possible bounding box containing the entire Union object
static Vertex	getCenter(BoundingBox bounds) Gets the center of the specified bounding box
double	getMaxX() Returns the value of the 'Max X' attribute.
double	getMaxY() Returns the value of the 'Max Y' attribute.
double	getMaxZ() Returns the value of the 'Max Z' attribute.
double	getMinX() Returns the value of the 'Min X' attribute.
double	getMinY() Returns the value of the 'Min Y' attribute.
double	getMinZ() Returns the value of the 'Min Z' attribute.
void	setMaxX(double value) Sets the value of the 'Max X' attribute.
void	setMaxY(double value) Sets the value of the 'Max Y' attribute.
void	setMaxZ(double value) Sets the value of the 'Max Z' attribute.
void	setMinX(double value) Sets the value of the 'Min X' attribute.
void	setMinY(double value) Sets the value of the 'Min Y' attribute.
void	setMinZ(double value) Sets the value of the 'Min Z' attribute.

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

getMaxX

double getMaxX()

Returns the value of the 'Max X' attribute. The maximal x value in the bounding box.

Returns:

the value of the 'Max X' attribute.

See Also:

setMaxX(double), GeometryPackage.getBoundingBox_MaxX()

setMaxX

void setMaxX(double value)

Sets the value of the 'Max X' attribute.

Parameters:

value - the new value of the 'Max X' attribute.

See Also:

getMaxX()

getMaxY

double getMaxY()

Returns the value of the 'Max Y' attribute. The default value is "0.0". The maximal y value in the bounding box.

Returns:

the value of the 'Max Y' attribute.

See Also:

setMaxY(double), GeometryPackage.getBoundingBox_MaxY()

setMaxY

void setMaxY(double value)

Sets the value of the 'Max Y' attribute.

Parameters:

value - the new value of the 'Max Y' attribute.

See Also:

getMaxY()

getMaxZ

double getMaxZ()

Returns the value of the 'Max Z' attribute. The default value is "0.0". The maximal z value in the bounding box.

Returns:

the value of the 'Max Z' attribute.

See Also:

setMaxZ(double), GeometryPackage.getBoundingBox_MaxZ()

setMaxZ

void setMaxZ(double value)

Sets the value of the 'Max Z' attribute.

Parameters:

value - the new value of the 'Max Z' attribute.

See Also:

getMaxZ()

getMinX

double getMinX()

Returns the value of the 'Min X' attribute. The default value is "0.0". The minimal x value in the bounding box.

Returns:

the value of the 'Min X' attribute.

See Also:

setMinX(double), GeometryPackage.getBoundingBox_MinX()

setMinX

void setMinX(double value)

Sets the value of the 'Min X' attribute.

Parameters:

value - the new value of the 'Min X' attribute.

See Also:

getMinX()

getMinY

double getMinY()

Returns the value of the 'Min Y' attribute. The default value is "0.0". The minimal y value in the bounding box.

Returns:

the value of the 'Min Y' attribute.

See Also:

setMinY(double), GeometryPackage.getBoundingBox_MinY()

setMinY

void setMinY(double value)

Sets the value of the 'Min Y' attribute.

Parameters:

value - the new value of the 'Min Y' attribute.

See Also:

getMinY()

getMinZ

double getMinZ()

Returns the value of the 'Min Z' attribute. The default value is "0.0". The minimal z value in the bounding box.

Returns:

the value of the 'Min Z' attribute.

See Also:

setMinZ(double), GeometryPackage.getBoundingBox_MinZ()

setMinZ

void setMinZ(double value)

Sets the value of the 'Min Z' attribute.

Parameters:

value - the new value of the 'Min Z' attribute.

See Also:

getMinZ()

addArea

void addArea(BoundingBox area)

Adds the given bounding box's area to the area represented by this one. If the bounding box is contained within this one, there will be no change. If it is partially or wholly outside, this bounding box will be enlargened by the minimal amount required to contain it.

getBounds

static BoundingBox getBounds(Shape shape)

Describes the bounds of the specified Shape object as the smallest box, orthogonal to the axes, that can contain the specified shape.

Parameters:

shape - The shape to determine the bounds of

Returns:

Returns the bounding box giving the bounds of the specified shape

getBounds

static BoundingBox getBounds(Union union)

Gets the smallest possible bounding box containing the entire Union object

Parameters:

union - The union to find the bounds of

Returns:

Returns a BoundingBox, describing the bounds of the union

getCenter

static Vertex getCenter(BoundingBox bounds)

Gets the center of the specified bounding box

Parameters:

bounds - The BoundingBox to find the center point of

Returns:

Returns a Vertex located at the center of the specified bounding box