Direction (Cloudburst 0.0.1-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<Direction>
- - org.cloudburstmc.server.math.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>
```
public enum Direction
extends Enum<Direction>
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Direction.Axis

static class Direction.AxisDirection

static class Direction.Plane

Nested Classes
Modifier and Type	Class and Description
`static class`	`Direction.Axis`
`static class`	`Direction.AxisDirection`
`static class`	`Direction.Plane`

Enum Constant Summary

Enum Constants
Enum Constant and Description

DOWN

EAST

NORTH

SOUTH

UP

WEST

Enum Constants
Enum Constant and Description
`DOWN`
`EAST`
`NORTH`
`SOUTH`
`UP`
`WEST`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Direction`	`fromAxis(Direction.AxisDirection axisDirection, Direction.Axis axis)`
`static Direction`	`fromHorizontalAngle(double angle)` Get the BlockFace corresponding to the given angle (0-360).
`static Direction`	`fromHorizontalIndex(int index)` Get a BlockFace by it's horizontal index (0-3).
`static Direction`	`fromIndex(int index)` Get a BlockFace by it's index (0-5).
`Direction.Axis`	`getAxis()` Get the Axis of this BlockFace
`Direction.AxisDirection`	`getAxisDirection()` Get the AxisDirection of this BlockFace
`CardinalDirection`	`getCardinalDirection()`
`float`	`getHorizontalAngle()` Get the angle of this BlockFace (0-360)
`int`	`getHorizontalIndex()` Get the horizontal index of this BlockFace (0-3).
`int`	`getIndex()` Get the index of this BlockFace (0-5).
`String`	`getName()` Get the name of this BlockFace (up, down, north, etc.)
`com.nukkitx.math.vector.Vector3i`	`getOffset(com.nukkitx.math.vector.Vector3i pos)`
`com.nukkitx.math.vector.Vector3i`	`getOffset(com.nukkitx.math.vector.Vector3i pos, int step)`
`Direction`	`getOpposite()` Get the opposite BlockFace (e.g.
`com.nukkitx.math.vector.Vector3i`	`getUnitVector()` Get the unit vector of this BlockFace
`int`	`getXOffset()` Returns an offset that addresses the block in front of this BlockFace
`int`	`getYOffset()` Returns an offset that addresses the block in front of this BlockFace
`int`	`getZOffset()` Returns an offset that addresses the block in front of this BlockFace
`static Direction`	`random(Random rand)` Choose a random BlockFace using the given Random
`Direction`	`rotateY()` Rotate this BlockFace around the Y axis clockwise (NORTH => EAST => SOUTH => WEST => BB_NORTH)
`Direction`	`rotateYCCW()` Rotate this BlockFace around the Y axis counter-clockwise (NORTH => WEST => SOUTH => EAST => BB_NORTH)
`String`	`toString()`
`static Direction`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Direction[]`	`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, valueOf

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

- Enum Constant Detail
  - DOWN
```
public static final Direction DOWN
```
  - UP
```
public static final Direction UP
```
  - NORTH
```
public static final Direction NORTH
```
  - SOUTH
```
public static final Direction SOUTH
```
  - WEST
```
public static final Direction WEST
```
  - EAST
```
public static final Direction EAST
```
- Method Detail
  - values
```
public static Direction[] 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 (Direction c : Direction.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Direction 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
  - fromIndex
```
public static Direction fromIndex(int index)
```
    Get a BlockFace by it's index (0-5). The order is D-U-N-S-W-E
    
    Parameters:
    
    index - BlockFace index
    
    Returns:
    
    block face
  - fromHorizontalIndex
```
public static Direction fromHorizontalIndex(int index)
```
    Get a BlockFace by it's horizontal index (0-3). The order is S-W-N-E
    
    Parameters:
    
    index - BlockFace index
    
    Returns:
    
    block face
  - fromHorizontalAngle
```
public static Direction fromHorizontalAngle(double angle)
```
    Get the BlockFace corresponding to the given angle (0-360). An angle of 0 is SOUTH, an angle of 90 would be WEST
    
    Parameters:
    
    angle - horizontal angle
    
    Returns:
    
    block face
  - fromAxis
```
public static Direction fromAxis(Direction.AxisDirection axisDirection,
                                 Direction.Axis axis)
```
  - random
```
public static Direction random(Random rand)
```
    Choose a random BlockFace using the given Random
    
    Parameters:
    
    rand - random number generator
    
    Returns:
    
    block face
  - getIndex
```
public int getIndex()
```
    Get the index of this BlockFace (0-5). The order is D-U-N-S-W-E
    
    Returns:
    
    index
  - getHorizontalIndex
```
public int getHorizontalIndex()
```
    Get the horizontal index of this BlockFace (0-3). The order is S-W-N-E
    
    Returns:
    
    horizontal index
  - getCardinalDirection
```
public CardinalDirection getCardinalDirection()
```
  - getHorizontalAngle
```
public float getHorizontalAngle()
```
    Get the angle of this BlockFace (0-360)
    
    Returns:
    
    horizontal angle
  - getName
```
public String getName()
```
    Get the name of this BlockFace (up, down, north, etc.)
    
    Returns:
    
    name
  - getAxis
```
public Direction.Axis getAxis()
```
    Get the Axis of this BlockFace
    
    Returns:
    
    axis
  - getAxisDirection
```
public Direction.AxisDirection getAxisDirection()
```
    Get the AxisDirection of this BlockFace
    
    Returns:
    
    axis direction
  - getUnitVector
```
public com.nukkitx.math.vector.Vector3i getUnitVector()
```
    Get the unit vector of this BlockFace
    
    Returns:
    
    vector
  - getOffset
```
public com.nukkitx.math.vector.Vector3i getOffset(com.nukkitx.math.vector.Vector3i pos)
```
  - getOffset
```
public com.nukkitx.math.vector.Vector3i getOffset(com.nukkitx.math.vector.Vector3i pos,
                                                  int step)
```
  - getXOffset
```
public int getXOffset()
```
    Returns an offset that addresses the block in front of this BlockFace
    
    Returns:
    
    x offset
  - getYOffset
```
public int getYOffset()
```
    Returns an offset that addresses the block in front of this BlockFace
    
    Returns:
    
    y offset
  - getZOffset
```
public int getZOffset()
```
    Returns an offset that addresses the block in front of this BlockFace
    
    Returns:
    
    x offset
  - getOpposite
```
public Direction getOpposite()
```
    Get the opposite BlockFace (e.g. DOWN ==> UP)
    
    Returns:
    
    block face
  - rotateY
```
public Direction rotateY()
```
    Rotate this BlockFace around the Y axis clockwise (NORTH => EAST => SOUTH => WEST => BB_NORTH)
    
    Returns:
    
    block face
  - rotateYCCW
```
public Direction rotateYCCW()
```
    Rotate this BlockFace around the Y axis counter-clockwise (NORTH => WEST => SOUTH => EAST => BB_NORTH)
    
    Returns:
    
    block face
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<Direction>

Enum Direction

Nested Class Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

DOWN

UP

NORTH

SOUTH

WEST

EAST

Method Detail

values

valueOf

fromIndex

fromHorizontalIndex

fromHorizontalAngle

fromAxis

random

getIndex

getHorizontalIndex

getCardinalDirection

getHorizontalAngle

getName

getAxis

getAxisDirection

getUnitVector

getOffset

getOffset

getXOffset

getYOffset

getZOffset

getOpposite

rotateY

rotateYCCW

toString