AlignType (JavaSCAD 0.9.2.2 API)

java.lang.Object
- java.lang.Enum<AlignType>
- - eu.printingin3d.javascad.enums.AlignType

All Implemented Interfaces:

Serializable, Comparable<AlignType>
```
public enum AlignType
extends Enum<AlignType>
```
Denotes the alignment on one axis.

Author:

ivivan

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CENTER` Aligns to the middle of the models.
`MAX` Deprecated. use `MAX_IN` or `MAX_OUT` instead
`MAX_IN` Aligns to the higher parts on the axis, means the right, back and top.
`MAX_OUT` Aligns to the higher parts on the axis, means the right, back and top.
`MIN` Deprecated. use `MIN_IN` or `MIN_OUT` instead
`MIN_IN` Aligns to the lower parts on the axis, means the left, front and bottom.
`MIN_OUT` Aligns to the lower parts on the axis, means the left, front and bottom.
`NONE` Don't change anything.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected double`	`calculateCoordinate(Boundary model, Boundary relateTo)` Used internally to calculate the coordinate on the given axis.
`protected double`	`calculateCoordinate(Boundary model, double relateTo)` Used internally to calculate the coordinate on the given axis.
`AlignType`	`convertTo(boolean inside)` Return with the corresponding inside or outside alignment of this alignment type based on the given parameter.
`AlignType`	`convertToInside()` Return with the corresponding inside alignment of this alignment type.
`AlignType`	`convertToOutside()` Return with the corresponding outside alignment of this alignment type.
`double`	`getAlignedValue(Boundary boundary)` Returns with the side of the given boundary denoted by this align.
`static AlignType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static AlignType[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - MIN_IN
```
public static final AlignType MIN_IN
```
    Aligns to the lower parts on the axis, means the left, front and bottom. If we align to another object we align to be inside of it.
  - MIN_OUT
```
public static final AlignType MIN_OUT
```
    Aligns to the lower parts on the axis, means the left, front and bottom. If we align to another object we align to be outside of it.
  - MIN
```
public static final AlignType MIN
```
    Deprecated. use MIN_IN or MIN_OUT instead
    
    Aligns to the lower parts on the axis, means the left, front and bottom.
    
    This behaves exactly the same as MIN_OUT for backward compatibility reasons.
  - MAX_IN
```
public static final AlignType MAX_IN
```
    Aligns to the higher parts on the axis, means the right, back and top. If we align to another object we align to be inside of it.
  - MAX_OUT
```
public static final AlignType MAX_OUT
```
    Aligns to the higher parts on the axis, means the right, back and top. If we align to another object we align to be outside of it.
  - MAX
```
public static final AlignType MAX
```
    Deprecated. use MAX_IN or MAX_OUT instead
    
    Aligns to the higher parts on the axis, means the right, back and top.
    
    This behaves exactly the same as MAX_OUT for backward compatibility reasons.
  - CENTER
```
public static final AlignType CENTER
```
    Aligns to the middle of the models.
  - NONE
```
public static final AlignType NONE
```
    Don't change anything.
- Method Detail
  - values
```
public static AlignType[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (AlignType c : AlignType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static AlignType valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - convertToInside
```
public AlignType convertToInside()
```
    Return with the corresponding inside alignment of this alignment type.
    
    Returns:
    
    the corresponding inside alignment of this alignment type
  - convertToOutside
```
public AlignType convertToOutside()
```
    Return with the corresponding outside alignment of this alignment type.
    
    Returns:
    
    the corresponding outside alignment of this alignment type
  - convertTo
```
public AlignType convertTo(boolean inside)
```
    Return with the corresponding inside or outside alignment of this alignment type based on the given parameter.
    
    Parameters:
    
    inside - determine if we want to get the inside or outside version of this aligment
    
    Returns:
    
    the corresponding outside alignment of this alignment type
  - getAlignedValue
```
public double getAlignedValue(Boundary boundary)
```
    Returns with the side of the given boundary denoted by this align.
    
    Parameters:
    
    boundary - the boundary we want to get
    
    Returns:
    
    the minimum, maximum or middle value of the given boundary - or zero if the alignment is NONE
  - calculateCoordinate
```
protected double calculateCoordinate(Boundary model,
                                     Boundary relateTo)
```
    Used internally to calculate the coordinate on the given axis. The result is the necessary movement on that axis to reach the wanted alignment.
    
    Parameters:
    
    model - the model we want to move
    
    relateTo - the model we use as a reference
    
    inside - controls which side of the aligned model will be aligned
    
    Returns:
    
    the necessary movement on that axis to reach the wanted alignment
  - calculateCoordinate
```
protected double calculateCoordinate(Boundary model,
                                     double relateTo)
```
    Used internally to calculate the coordinate on the given axis. The result is the necessary movement on that axis to reach the wanted alignment.
    
    Parameters:
    
    model - the model we want to move
    
    relateTo - the coordinate we want to use as a reference in the alignment process
    
    Returns:
    
    the necessary movement on that axis to reach the wanted alignment

Enum AlignType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

MIN_IN

MIN_OUT

MIN

MAX_IN

MAX_OUT

MAX

CENTER

NONE

Method Detail

values

valueOf

convertToInside

convertToOutside

convertTo

getAlignedValue

calculateCoordinate

calculateCoordinate