Boundary (JavaSCAD 0.9.2.2 API)

java.lang.Object
- eu.printingin3d.javascad.coords.Boundary

```
public class Boundary
extends Object
```
This object calculates the boundary of a series of values. It represents an interval which includes all of the values and all methods will use this interval for any later calculation.

Author:

ivivan

Field Summary

Fields
Modifier and Type Field and Description

static Boundary EMPTY
Represents an empty 1D boundary object.

Fields
Modifier and Type	Field and Description
`static Boundary`	`EMPTY` Represents an empty 1D boundary object.

Constructor Summary

Constructors
Constructor and Description

Boundary(double... values)
Constructs an object using given values to calculate the minimum and maximum values.

Constructors
Constructor and Description
`Boundary(double... values)` Constructs an object using given values to calculate the minimum and maximum values.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boundary`	`add(Boundary delta)` Adding the given value to the interval and creates a new Boundary object with the new values.
`Boundary`	`add(double delta)` Adding the given value to the interval and creates a new Boundary object with the new values.
`static Boundary`	`combine(Collection<Boundary> boundaries)` Creates a Boundary object which will hold the minimum and maximum values from the given collection.
`static Boundary`	`createSymmetricBoundary(double value)` Creates a Boundary object which has the given maximum value and the middle is zero.
`double`	`getMax()` Returns with the calculated maximum value.
`double`	`getMiddle()` Returns the middle point of the interval.
`double`	`getMin()` Returns with the calculated minimum value.
`double`	`getSize()` Returns with the size of the interval.
`static Boundary`	`intersect(Collection<Boundary> boundaries)` Creates a Boundary object which will hold the minimum and maximum values from the given collection.
`boolean`	`isInside(double value)` Returns true if and only if the given value is within this boundaries limits.
`boolean`	`isInsideOf(Boundary b)` Returns true if and only if this boundary is inside of the given boundary.
`Boundary`	`negate(boolean doNegate)` Negate the current object if the parameter is true, but this object will be unchanged: a new one will be created with the new values.
`Boundary`	`remove(Boundary b)` Removes the values of the given boundary from this boundary and returns with the remaining values.
`Boundary`	`scale(double delta)` Multiplying the interval with the given value, basically scaling it.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EMPTY
```
public static final Boundary EMPTY
```
    Represents an empty 1D boundary object.
- Constructor Detail
  - Boundary
```
public Boundary(double... values)
```
    Constructs an object using given values to calculate the minimum and maximum values.
    
    Parameters:
    
    values - the values used by the calculation
- Method Detail
  - combine
```
public static Boundary combine(Collection<Boundary> boundaries)
```
    Creates a Boundary object which will hold the minimum and maximum values from the given collection.
    
    Parameters:
    
    boundaries - the collections which should be considered
    
    Returns:
    
    the Boundary object which will represent the collection
  - intersect
```
public static Boundary intersect(Collection<Boundary> boundaries)
                          throws IllegalValueException
```
    Creates a Boundary object which will hold the minimum and maximum values from the given collection.
    
    Parameters:
    
    boundaries - the collections which should be considered
    
    Returns:
    
    the Boundary object which will represent the collection
    
    Throws:
    
    IllegalValueException - if the given boundaries does not have a common interval or if the given list is empty
  - createSymmetricBoundary
```
public static Boundary createSymmetricBoundary(double value)
```
    Creates a Boundary object which has the given maximum value and the middle is zero.
    
    Parameters:
    
    value - the maximum value of the Boundary
    
    Returns:
    
    the new symmetric Boundary object
  - negate
```
public Boundary negate(boolean doNegate)
```
    Negate the current object if the parameter is true, but this object will be unchanged: a new one will be created with the new values. This means the new objects maximum value will be equals this object's minimum value negated - the same is true for the minimum value.
    
    If the parameter is false this method returns with this object and does nothing.
    
    Parameters:
    
    doNegate - this is the controlling parameter
    
    Returns:
    
    this object negated if the parameter true, the object unchanged otherwise
  - getMin
```
public double getMin()
```
    Returns with the calculated minimum value.
    
    Returns:
    
    the calculated minimum value
  - getMax
```
public double getMax()
```
    Returns with the calculated maximum value.
    
    Returns:
    
    the calculated maximum value
  - getMiddle
```
public double getMiddle()
```
    Returns the middle point of the interval.
    
    Returns:
    
    the arithmetic mean of the minimum and maximum value
  - getSize
```
public double getSize()
```
    Returns with the size of the interval.
    
    Returns:
    
    the difference of the maximum and minimum value
  - add
```
public Boundary add(double delta)
```
    Adding the given value to the interval and creates a new Boundary object with the new values.
    
    Parameters:
    
    delta - the value to move this interval
    
    Returns:
    
    a new object representing the new calculated interval
  - add
```
public Boundary add(Boundary delta)
```
    Adding the given value to the interval and creates a new Boundary object with the new values.
    
    Parameters:
    
    delta - the value to add to this interval
    
    Returns:
    
    a new object representing the new calculated interval
  - remove
```
public Boundary remove(Boundary b)
                throws IllegalValueException
```
    Removes the values of the given boundary from this boundary and returns with the remaining values.
    
    Parameters:
    
    b - the boundary to be removed
    
    Returns:
    
    the remaining values
    
    Throws:
    
    IllegalValueException - if there is nothing left
  - scale
```
public Boundary scale(double delta)
```
    Multiplying the interval with the given value, basically scaling it. The method will create a new object and the current object will be unchanged.
    
    Parameters:
    
    delta - the value used by the multiplication
    
    Returns:
    
    a new object representing the new calculated interval
  - isInsideOf
```
public boolean isInsideOf(Boundary b)
```
    Returns true if and only if this boundary is inside of the given boundary. It means it gives true if the given boundary's minimum value is not greater then this boundary's minimum value and the given boundary's maximum value is not less then this boundary's maximum value.
    
    Parameters:
    
    b - the given boundary
    
    Returns:
    
    true if and only if this boundary is inside of the given boundary
  - isInside
```
public boolean isInside(double value)
```
    Returns true if and only if the given value is within this boundaries limits.
    
    Parameters:
    
    value - the given value
    
    Returns:
    
    true if and only if the given value is inside of this boundary

Class Boundary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY

Constructor Detail

Boundary

Method Detail

combine

intersect

createSymmetricBoundary

negate

getMin

getMax

getMiddle

getSize

add

add

remove

scale

isInsideOf

isInside