org.xmlcml.euclid

Class Real3Range

java.lang.Object

org.xmlcml.euclid.Real3Range

All Implemented Interfaces:

EuclidConstants

public class Real3Range
extends Object
implements EuclidConstants

3-D double limits Contains 3 RealRanges. Can therefore be used to describe 3-dimensional limits (for example axes of 3-D graphs, boxes in graphics, limits of a molecule, etc.)

Default is three invalid RealRange components.

Author:

(C) P. Murray-Rust, 1996

Field Summary

Fields inherited from interface org.xmlcml.euclid.EuclidConstants

C_AMP, C_APOS, C_ATSIGN, C_BACKSLASH, C_BACKSPACE, C_CARET, C_COLON, C_COMMA, C_DEL, C_DOLLAR, C_EQUALS, C_FORMFEED, C_HASH, C_LANGLE, C_LBRAK, C_LCURLY, C_LSQUARE, C_MINUS, C_NBSP, C_NEWLINE, C_NL, C_PERCENT, C_PERIOD, C_PIPE, C_PLUS, C_POUND, C_QUERY, C_QUOT, C_RANGLE, C_RBRAK, C_RCURLY, C_RETURN, C_RSQUARE, C_SEMICOLON, C_SHRIEK, C_SLASH, C_SPACE, C_STAR, C_TAB, C_TILDE, C_UNDER, EPS, F_S, NONWHITEPUNC, NONWHITEPUNC0, NONWHITEPUNC0REGEX, ONE_THIRD, PUNC, S_AMP, S_APOS, S_ATSIGN, S_BACKSLASH, S_CARET, S_COLON, S_COMMA, S_DOLLAR, S_EMPTY, S_EQUALS, S_FORMFEED, S_HASH, S_LANGLE, S_LBRAK, S_LCURLY, S_LSQUARE, S_MINUS, S_NEWLINE, S_NL, S_PERCENT, S_PERIOD, S_PIPE, S_PLUS, S_POUND, S_QUERY, S_QUOT, S_RANGLE, S_RBRAK, S_RCURLY, S_RETURN, S_RSQUARE, S_SEMICOLON, S_SHRIEK, S_SLASH, S_SPACE, S_STAR, S_TAB, S_TILDE, S_UNDER, S_WHITEREGEX, TWO_THIRDS, U_S, WHITESPACE

Constructor Summary

Constructors

Constructor and Description
Real3Range() default is three default RealRanges
Real3Range(Real3Range r) copy constructor
Real3Range(RealRange xr, RealRange yr, RealRange zr) initialise with min and max values; takes COPIES

Method Summary

Modifier and Type	Method and Description
void	add(Axis.Axis3 ax, double value) add a single value
void	add(Axis.Axis3 ax, RealRange range) add a single value
protected void	add(int axis, double value) add a single value - not for general use
void	add(Point3 p) add a Point3 to a range
Point3	getMaxPoint3() get point with max x, y, z.
Point3	getMinPoint3() get point with min x, y, z.
RealRange	getXRange() get xrange
RealRange	getYRange() get yrange
RealRange	getZRange() get zrange
boolean	includes(Point3 p) is a Point3 within a Real3Range
boolean	isEqualTo(Real3Range r3) Deprecated.
boolean	isEqualTo(Real3Range r3, double eps) is equal to.
Real3Range	plus(Real3Range r3) add two ranges.
void	setRanges(RealRange xr, RealRange yr, RealRange zr) reset ranges.
String	toString() to string.
void	transformEquals(Transform3 transform) transforms range.

Methods inherited from class java.lang.Object

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

Constructor Detail

Real3Range

public Real3Range()

default is three default RealRanges

Real3Range

public Real3Range(RealRange xr,
                  RealRange yr,
                  RealRange zr)

initialise with min and max values; takes COPIES

Parameters:

xr -

yr -

zr -

Real3Range

public Real3Range(Real3Range r)

copy constructor

Parameters:

r -

Method Detail

setRanges

public void setRanges(RealRange xr,
                      RealRange yr,
                      RealRange zr)

reset ranges. clears any existing content

Parameters:

xr -

yr -

zr -

isEqualTo

public boolean isEqualTo(Real3Range r3,
                         double eps)

is equal to.

Parameters:

r3 -

Returns:

tru if equals

isEqualTo

@Deprecated
public boolean isEqualTo(Real3Range r3)

Deprecated.

is equal to.

Parameters:

r3 -

Returns:

tru if equals

plus

public Real3Range plus(Real3Range r3)

add two ranges. applies plus to each of x, y, z. creates minima and maxima of this, r3

Parameters:

r3 -

Returns:

new range

getXRange

public RealRange getXRange()

get xrange

Returns:

range

getYRange

public RealRange getYRange()

get yrange

Returns:

range

getZRange

public RealRange getZRange()

get zrange

Returns:

range

add

public void add(Axis.Axis3 ax,
                double value)

add a single value

Parameters:

ax -

value -

add

public void add(Axis.Axis3 ax,
                RealRange range)

add a single value

Parameters:

ax -

range -

add

protected void add(int axis,
                   double value)

add a single value - not for general use

Parameters:

axis -

value -

includes

public boolean includes(Point3 p)

is a Point3 within a Real3Range

Parameters:

p -

Returns:

includes

add

public void add(Point3 p)

add a Point3 to a range

Parameters:

p -

getMinPoint3

public Point3 getMinPoint3()

get point with min x, y, z.

Returns:

the point.

getMaxPoint3

public Point3 getMaxPoint3()

get point with max x, y, z.

Returns:

the point.

transformEquals

public void transformEquals(Transform3 transform)

transforms range. modifies this

Parameters:

transform -

toString

public String toString()

to string.

Overrides:

toString in class Object

Returns:

string