Package org.anchoranalysis.mpp.mark.points

Class RotatableBoundingBox

Object

org.anchoranalysis.mpp.mark.Mark

org.anchoranalysis.mpp.mark.MarkWithPosition

org.anchoranalysis.mpp.mark.points.RotatableBoundingBox

All Implemented Interfaces:

Serializable

public class RotatableBoundingBox
extends MarkWithPosition

A two-dimensional bounding-box rotated at arbitrary angle in XY plane around a point.

Axis-aligned bounding boxes are also supported by fixing orientation.

Author:

Owen Feehan

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
RotatableBoundingBox()	Creates a new RotatableBoundingBox with default values.

Method Summary

Modifier and Type	Method	Description
org.anchoranalysis.spatial.box.BoundingBox	box(Dimensions dimensions, int regionID)	Calculates the bounding box for a specific region of the mark.
org.anchoranalysis.spatial.box.BoundingBox	boxAllRegions(Dimensions dimensions)	Calculates the bounding box for all regions of the mark.
Mark	duplicate()	Creates a duplicate of this mark.
String	getName()	Returns the name of this mark type.
byte	isPointInside(org.anchoranalysis.spatial.point.Point3i point)	Determines if a point is inside the mark.
int	numberDimensions()	Returns the number of dimensions of this mark.
int	numberRegions()	Returns the number of regions in this mark.
void	scale(org.anchoranalysis.spatial.scale.ScaleFactor scaleFactor)	Scales the mark in X and Y dimensions.
String	toString()
void	update(org.anchoranalysis.spatial.point.Point2d distanceToLeftBottom, org.anchoranalysis.spatial.point.Point2d distanceToRightTop, org.anchoranalysis.spatial.orientation.Orientation orientation)	Updates the bounding box with new dimensions and orientation.
double	volume(int regionID)	Calculates the volume of a specific region of the mark.

Methods inherited from class org.anchoranalysis.mpp.mark.MarkWithPosition

centerPoint, equalsDeep, getPosition, positionString, setPosition

Methods inherited from class org.anchoranalysis.mpp.mark.Mark

deriveObject, equalsID, getIdentifier, identifier, quickOverlap, setId

Methods inherited from class java.lang.Object

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

Constructor Details

RotatableBoundingBox

public RotatableBoundingBox()

Creates a new RotatableBoundingBox with default values.

Method Details

isPointInside

public byte isPointInside(org.anchoranalysis.spatial.point.Point3i point)

Description copied from class: Mark

Determines if a point is inside the mark.

Specified by:

isPointInside in class Mark

Parameters:

point - the point to check

Returns:

a byte representing the region membership of the point

update

public void update(org.anchoranalysis.spatial.point.Point2d distanceToLeftBottom, org.anchoranalysis.spatial.point.Point2d distanceToRightTop, org.anchoranalysis.spatial.orientation.Orientation orientation)

Updates the bounding box with new dimensions and orientation.

Parameters:

distanceToLeftBottom - the distance to the left-bottom corner

distanceToRightTop - the distance to the right-top corner

orientation - the orientation of the bounding box

boxAllRegions

public org.anchoranalysis.spatial.box.BoundingBox boxAllRegions(Dimensions dimensions)

Description copied from class: Mark

Calculates the bounding box for all regions of the mark.

Specified by:

boxAllRegions in class Mark

Parameters:

dimensions - the dimensions of the space

Returns:

the bounding box

box

public org.anchoranalysis.spatial.box.BoundingBox box(Dimensions dimensions, int regionID)

Description copied from class: Mark

Calculates the bounding box for a specific region of the mark.

Specified by:

box in class Mark

Parameters:

dimensions - the dimensions of the space

regionID - the ID of the region

Returns:

the bounding box

volume

public double volume(int regionID)

Description copied from class: Mark

Calculates the volume of a specific region of the mark.

Specified by:

volume in class Mark

Parameters:

regionID - the ID of the region

Returns:

the volume of the region

duplicate

public Mark duplicate()

Description copied from class: Mark

Creates a duplicate of this mark.

Specified by:

duplicate in class Mark

Returns:

a new Mark instance that is a copy of this one

numberRegions

public int numberRegions()

Description copied from class: Mark

Returns the number of regions in this mark.

Specified by:

numberRegions in class Mark

Returns:

the number of regions

getName

public String getName()

Description copied from class: Mark

Returns the name of this mark type.

Specified by:

getName in class Mark

Returns:

the name of the mark

toString

public String toString()

Overrides:

toString in class Object

numberDimensions

public int numberDimensions()

Description copied from class: Mark

Returns the number of dimensions of this mark.

Specified by:

numberDimensions in class Mark

Returns:

the number of dimensions

scale

public void scale(org.anchoranalysis.spatial.scale.ScaleFactor scaleFactor) throws CheckedUnsupportedOperationException

Description copied from class: Mark

Scales the mark in X and Y dimensions.

Overrides:

scale in class MarkWithPosition

Parameters:

scaleFactor - how much to scale by

Throws:

CheckedUnsupportedOperationException - if scaling is not supported for this mark type