Side (JavaSCAD 0.9.2.2 API)

java.lang.Object
- eu.printingin3d.javascad.enums.Side

```
public class Side
extends Object
```
This class is used by the #align(Side, eu.printingin3d.javascad.models.Abstract3dModel, boolean) Abstract3dModel.align(Side, Abstract3dModel, boolean) method to set the side where the other model should be aligned.

Author:

ivivan

Field Summary

Fields
Modifier and Type	Field and Description
`static Side`	`BACK` Deprecated. Use `BACK_IN` or `BACK_OUT` instead.
`static Side`	`BACK_IN` The back side of the model inside.
`static Side`	`BACK_IN_CENTER` The inside back and center of the model.
`static Side`	`BACK_OUT` The back side of the model outside.
`static Side`	`BACK_OUT_CENTER` The outside back and center of the model.
`static Side`	`BOTTOM` Deprecated. Use `BOTTOM_IN` or `BOTTOM_OUT` instead.
`static Side`	`BOTTOM_IN` The bottom of the model inside.
`static Side`	`BOTTOM_IN_CENTER` The inside bottom and center of the model.
`static Side`	`BOTTOM_OUT` The bottom of the model outside.
`static Side`	`BOTTOM_OUT_CENTER` The outside bottom and center of the model.
`static Side`	`CENTER` The center of the model.
`static Side`	`FRONT` Deprecated. Use `FRONT_IN` or `FRONT_OUT` instead.
`static Side`	`FRONT_IN` The front side of the model.
`static Side`	`FRONT_IN_CENTER` The inside front and center of the model.
`static Side`	`FRONT_OUT` The front side of the model.
`static Side`	`FRONT_OUT_CENTER` The outside front and center of the model.
`static Side`	`LEFT` Deprecated. Use `LEFT_IN` or `LEFT_OUT` instead.
`static Side`	`LEFT_IN` The left side of the model.
`static Side`	`LEFT_IN_CENTER` The inside left and center of the model.
`static Side`	`LEFT_OUT` The left side of the model.
`static Side`	`LEFT_OUT_CENTER` The outside left and center of the model.
`static Side`	`RIGHT` Deprecated. Use `RIGHT_IN` or `RIGHT_OUT` instead
`static Side`	`RIGHT_IN` The right side of the model.
`static Side`	`RIGHT_IN_CENTER` The inside right and center of the model.
`static Side`	`RIGHT_OUT` The right side of the model.
`static Side`	`RIGHT_OUT_CENTER` The outside right and center of the model.
`static Side`	`TOP` Deprecated. Use `TOP_IN` or `TOP_OUT` instead.
`static Side`	`TOP_IN` The top of the model inside.
`static Side`	`TOP_IN_CENTER` The inside top and center of the model.
`static Side`	`TOP_OUT` The top of the model outside.
`static Side`	`TOP_OUT_CENTER` The outside top and center of the model.

Constructor Summary

Constructors
Constructor and Description

Side(AlignType alignX, AlignType alignY, AlignType alignZ)
Constructs a side object with the given aligns on the X, Y and Z axis.

Constructors
Constructor and Description
`Side(AlignType alignX, AlignType alignY, AlignType alignZ)` Constructs a side object with the given aligns on the X, Y and Z axis.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Coords3d`	`calculateCoords(Boundaries3d model, Boundaries3d relateTo)` This method is used internally by the `#align(Side, eu.printingin3d.javascad.models.Abstract3dModel, boolean) Abstract3dModel.align(Side, Abstract3dModel, boolean)`.
`Coords3d`	`calculateCoords(Boundaries3d model, Boundaries3d relateTo, boolean inside)` Deprecated. Use `calculateCoords(Boundaries3d, Boundaries3d)` instead
`Coords3d`	`calculateCoords(Boundaries3d model, Coords3d relateTo)` This method is used internally by the `Abstract3dModel.align(Side, Coords3d)`.
`AlignType`	`getAlignX()` Returns with the alignment on the x axis.
`AlignType`	`getAlignY()` Returns with the alignment on the y axis.
`AlignType`	`getAlignZ()` Returns with the alignment on the z axis.

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

- Field Detail
  - TOP
```
@Deprecated
public static final Side TOP
```
    Deprecated. Use TOP_IN or TOP_OUT instead.
    
    The top of the model.
    This behaves exactly the same as TOP_OUT for backward compatibility reasons.
  - TOP_IN
```
public static final Side TOP_IN
```
    The top of the model inside. Only the Z coordinate will changed during the alignment.
  - TOP_OUT
```
public static final Side TOP_OUT
```
    The top of the model outside. Only the Z coordinate will changed during the alignment.
  - TOP_IN_CENTER
```
public static final Side TOP_IN_CENTER
```
    The inside top and center of the model. The model will be aligned to the center on the X and Y axis, and inside top on the Z axis.
  - TOP_OUT_CENTER
```
public static final Side TOP_OUT_CENTER
```
    The outside top and center of the model. The model will be aligned to the center on the X and Y axis, and outside top on the Z axis.
  - BOTTOM
```
@Deprecated
public static final Side BOTTOM
```
    Deprecated. Use BOTTOM_IN or BOTTOM_OUT instead.
    
    The bottom of the model.
    This behaves exactly the same as BOTTOM_OUT for backward compatibility reasons.
  - BOTTOM_IN
```
public static final Side BOTTOM_IN
```
    The bottom of the model inside. Only the Z coordinate will changed during the alignment.
  - BOTTOM_OUT
```
public static final Side BOTTOM_OUT
```
    The bottom of the model outside. Only the Z coordinate will changed during the alignment.
  - BOTTOM_IN_CENTER
```
public static final Side BOTTOM_IN_CENTER
```
    The inside bottom and center of the model. The model will be aligned to the center on the X and Y axis, and inside bottom on the Z axis.
  - BOTTOM_OUT_CENTER
```
public static final Side BOTTOM_OUT_CENTER
```
    The outside bottom and center of the model. The model will be aligned to the center on the X and Y axis, and outside bottom on the Z axis.
  - LEFT
```
@Deprecated
public static final Side LEFT
```
    Deprecated. Use LEFT_IN or LEFT_OUT instead.
    
    The left side of the model.
    This behaves exactly the same as LEFT_OUT for backward compatibility reasons.
  - LEFT_IN
```
public static final Side LEFT_IN
```
    The left side of the model. Only the X coordinate will changed during the alignment.
  - LEFT_OUT
```
public static final Side LEFT_OUT
```
    The left side of the model. Only the X coordinate will changed during the alignment.
  - LEFT_IN_CENTER
```
public static final Side LEFT_IN_CENTER
```
    The inside left and center of the model. The model will be aligned to the center on the Y and Z axis, and inside left on the X axis.
  - LEFT_OUT_CENTER
```
public static final Side LEFT_OUT_CENTER
```
    The outside left and center of the model. The model will be aligned to the center on the Y and Z axis, and outside left on the X axis.
  - RIGHT
```
@Deprecated
public static final Side RIGHT
```
    Deprecated. Use RIGHT_IN or RIGHT_OUT instead
    
    The right side of the model.
    This behaves exactly the same as RIGHT_OUT for backward compatibility reasons.
  - RIGHT_IN
```
public static final Side RIGHT_IN
```
    The right side of the model. Only the X coordinate will changed during the alignment.
  - RIGHT_OUT
```
public static final Side RIGHT_OUT
```
    The right side of the model. Only the X coordinate will changed during the alignment.
  - RIGHT_IN_CENTER
```
public static final Side RIGHT_IN_CENTER
```
    The inside right and center of the model. The model will be aligned to the center on the Y and Z axis, and inside right on the X axis.
  - RIGHT_OUT_CENTER
```
public static final Side RIGHT_OUT_CENTER
```
    The outside right and center of the model. The model will be aligned to the center on the Y and Z axis, and outside right on the X axis.
  - FRONT
```
@Deprecated
public static final Side FRONT
```
    Deprecated. Use FRONT_IN or FRONT_OUT instead.
    
    The front side of the model.
    This behaves exactly the same as FRONT_OUT for backward compatibility reasons.
  - FRONT_IN
```
public static final Side FRONT_IN
```
    The front side of the model. Only the Y coordinate will changed during the alignment.
  - FRONT_OUT
```
public static final Side FRONT_OUT
```
    The front side of the model. Only the Y coordinate will changed during the alignment.
  - FRONT_IN_CENTER
```
public static final Side FRONT_IN_CENTER
```
    The inside front and center of the model. The model will be aligned to the center on the X and Z axis, and inside front on the Y axis.
  - FRONT_OUT_CENTER
```
public static final Side FRONT_OUT_CENTER
```
    The outside front and center of the model. The model will be aligned to the center on the X and Z axis, and outside front on the Y axis.
  - BACK
```
@Deprecated
public static final Side BACK
```
    Deprecated. Use BACK_IN or BACK_OUT instead.
    
    The back side of the model.
    This behaves exactly the same as BACK_OUT for backward compatibility reasons.
  - BACK_IN
```
public static final Side BACK_IN
```
    The back side of the model inside. Only the Y coordinate will changed during the alignment.
  - BACK_OUT
```
public static final Side BACK_OUT
```
    The back side of the model outside. Only the Y coordinate will changed during the alignment.
  - BACK_IN_CENTER
```
public static final Side BACK_IN_CENTER
```
    The inside back and center of the model. The model will be aligned to the center on the X and Z axis, and inside back on the Y axis.
  - BACK_OUT_CENTER
```
public static final Side BACK_OUT_CENTER
```
    The outside back and center of the model. The model will be aligned to the center on the X and Z axis, and outside back on the Y axis.
  - CENTER
```
public static final Side CENTER
```
    The center of the model.
- Constructor Detail
  - Side
```
public Side(AlignType alignX,
            AlignType alignY,
            AlignType alignZ)
```
    Constructs a side object with the given aligns on the X, Y and Z axis.
    
    Parameters:
    
    alignX - the alignment on the X axis
    
    alignY - the alignment on the Y axis
    
    alignZ - the alignment on the Z axis
- Method Detail
  - calculateCoords
```
@Deprecated
public Coords3d calculateCoords(Boundaries3d model,
                                             Boundaries3d relateTo,
                                             boolean inside)
```
    Deprecated. Use calculateCoords(Boundaries3d, Boundaries3d) instead
    
    This method is used internally by the #align(Side, eu.printingin3d.javascad.models.Abstract3dModel, boolean) Abstract3dModel.align(Side, Abstract3dModel, boolean). It calculates the coordinates of the position the first model should be placed to be in the desired position.
    
    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 coordinates we should use in a move operation
  - calculateCoords
```
public Coords3d calculateCoords(Boundaries3d model,
                                Boundaries3d relateTo)
```
    This method is used internally by the #align(Side, eu.printingin3d.javascad.models.Abstract3dModel, boolean) Abstract3dModel.align(Side, Abstract3dModel, boolean). It calculates the coordinates of the position the first model should be placed to be in the desired position.
    
    Parameters:
    
    model - the model we want to move
    
    relateTo - the model we use as a reference
    
    Returns:
    
    the coordinates we should use in a move operation
  - calculateCoords
```
public Coords3d calculateCoords(Boundaries3d model,
                                Coords3d relateTo)
```
    This method is used internally by the Abstract3dModel.align(Side, Coords3d). It calculates the coordinates of the position the first model should be placed to be in the desired position.
    
    Parameters:
    
    model - the model we want to move
    
    relateTo - the coordinate we use as a reference
    
    Returns:
    
    the coordinates we should use in a move operation
  - getAlignX
```
public AlignType getAlignX()
```
    Returns with the alignment on the x axis.
    
    Returns:
    
    the alignment on the x axis
  - getAlignY
```
public AlignType getAlignY()
```
    Returns with the alignment on the y axis.
    
    Returns:
    
    the alignment on the y axis
  - getAlignZ
```
public AlignType getAlignZ()
```
    Returns with the alignment on the z axis.
    
    Returns:
    
    the alignment on the z axis

Class Side

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TOP

TOP_IN

TOP_OUT

TOP_IN_CENTER

TOP_OUT_CENTER

BOTTOM

BOTTOM_IN

BOTTOM_OUT

BOTTOM_IN_CENTER

BOTTOM_OUT_CENTER

LEFT

LEFT_IN

LEFT_OUT

LEFT_IN_CENTER

LEFT_OUT_CENTER

RIGHT

RIGHT_IN

RIGHT_OUT

RIGHT_IN_CENTER

RIGHT_OUT_CENTER

FRONT

FRONT_IN

FRONT_OUT

FRONT_IN_CENTER

FRONT_OUT_CENTER

BACK

BACK_IN

BACK_OUT

BACK_IN_CENTER

BACK_OUT_CENTER

CENTER

Constructor Detail

Side

Method Detail

calculateCoords

calculateCoords

calculateCoords

getAlignX

getAlignY

getAlignZ