Direction | Kernel Extension v5.0 API

Class containing different useful operations to apply to coordinates set with a side

since: 5.0

Hierarchy

Object
- Direction

Constructors

Private constructor

new Direction(index: number, opposite: number, horizontalIndex: number, name: any_string, axisDirection: AxisDirection, axis: Axis, directionVec: Vec3i): Direction

Overrides java.lang.Object.constructor
- Defined in kex.d.ts:7129
Since Direction is originally a Java enum, new instances cannot be constructed

since
5.0

Parameters
- index: number
- opposite: number
- horizontalIndex: number
- name: any_string
- axisDirection: AxisDirection
- axis: Axis
- directionVec: Vec3i
Returns Direction

Properties

Static Readonly DOWN

DOWN: Direction

new Direction(0, 1, -1, "down", AxisDirection.NEGATIVE, Axis.Y, new Vec3i(0, -1, 0));

since: 5.0

Static Readonly EAST

EAST: Direction

new Direction(5, 4, 3, "east", AxisDirection.POSITIVE, Axis.X, new Vec3i(1, 0, 0));

since: 5.0

Static Readonly NORTH

NORTH: Direction

new Direction(2, 3, 2, "north", AxisDirection.NEGATIVE, Axis.Z, new Vec3i(0, 0, -1));

since: 5.0

Static Readonly SOUTH

SOUTH: Direction

new Direction(3, 2, 0, "south", AxisDirection.POSITIVE, Axis.Z, new Vec3i(0, 0, 1));

since: 5.0

Static Readonly UP

UP: Direction

new Direction(1, 0, -1, "up", AxisDirection.POSITIVE, Axis.Y, new Vec3i(0, 1, 0));

since: 5.0

Static Readonly WEST

WEST: Direction

new Direction(4, 5, 1, "west", AxisDirection.NEGATIVE, Axis.X, new Vec3i(-1, 0, 0));

since: 5.0

Static class

class: Class<Object>

Methods

clone

clone(): any

Inherited from java.lang.Object.clone
- Defined in android.d.ts:81147
Returns any

equals

equals(param0: any): boolean

Inherited from java.lang.Object.equals
- Defined in android.d.ts:81145
Parameters
- param0: any
Returns boolean

finalize

finalize(): void

Inherited from java.lang.Object.finalize
- Defined in android.d.ts:81153
Returns void

getAxis

getAxis(): Axis

- Defined in kex.d.ts:7214
since
5.0

Returns Axis

getAxisDirection

getAxisDirection(): AxisDirection

- Defined in kex.d.ts:7141
since
5.0

Returns AxisDirection

getClass

getClass(): Class<any>

Inherited from java.lang.Object.getClass
- Defined in android.d.ts:81150
Returns Class<any>

getClockWise

getClockWise(axis: Axis): Direction
getClockWise(): Direction

- Defined in kex.d.ts:7277
Same as rotateAround, but just returns the following Direction unchanged instead of throwing a java.lang.IllegalStateException for the Directions incompatible for rotation around the given axis. However, throws java.lang.IncompatibleClassChangeError if the given axis is invalid.

since
5.0

Parameters
- axis: Axis
Returns Direction
- Defined in kex.d.ts:7289
Same as rotateY

since
5.0

Returns Direction

getClockWiseX

getClockWiseX(): Direction

- Defined in kex.d.ts:7301
Same as rotateX

since
5.0

Returns Direction

getClockWiseZ

getClockWiseZ(): Direction

- Defined in kex.d.ts:7313
Same as rotateZ

since
5.0

Returns Direction

getCounterClockWise

getCounterClockWise(axis: Axis): Direction
getCounterClockWise(): Direction

- Defined in kex.d.ts:7283
Same as getClockWise, but counterclockwise (unexpected?)

since
5.0

Parameters
- axis: Axis
Returns Direction
- Defined in kex.d.ts:7295
Counterclockwise variant of getClockWise / rotateY

since
5.0

Returns Direction

getCounterClockWiseX

getCounterClockWiseX(): Direction

- Defined in kex.d.ts:7307
Counterclockwise variant of getClockWiseX / rotateX

since
5.0

Returns Direction

getCounterClockWiseZ

getCounterClockWiseZ(): Direction

- Defined in kex.d.ts:7319
Counterclockwise variant of getClockWiseZ / rotateZ

since
5.0

Returns Direction

getDirectionVec

getDirectionVec(): Vec3i

- Defined in kex.d.ts:7268
since
5.0

Returns Vec3i

getFrontOffsetX

getFrontOffsetX(): number

- Defined in kex.d.ts:7195
since
5.0

Returns number
value added to the X coordinate of a vector, if the offset with the following Direction is applied to it. Can be 0 or 1.

getFrontOffsetY

getFrontOffsetY(): number

- Defined in kex.d.ts:7202
since
5.0

Returns number
value added to the Y coordinate of a vector, if the offset with the following Direction is applied to it. Can be 0 or 1.

getFrontOffsetZ

getFrontOffsetZ(): number

- Defined in kex.d.ts:7209
since
5.0

Returns number
value added to the Z coordinate of a vector, if the offset with the following Direction is applied to it. Can be 0 or 1.

getHorizontalAngle

getHorizontalAngle(): number

- Defined in kex.d.ts:7243
since
5.0

Returns number

getIndex

getIndex(): number

- Defined in kex.d.ts:7136
since
5.0

Returns number
following Direction's index from 0 to 5, which matches with the values of the side field in Callback.ItemUseCoordinates

getOpposite

getOpposite(): Direction

- Defined in kex.d.ts:7148
since
5.0

Returns Direction
Direction opposite to the following one (north <=> south, east <=> west, up <=> down)

hashCode

hashCode(): number

Inherited from java.lang.Object.hashCode
- Defined in android.d.ts:81154
Returns number

notify

notify(): void

Inherited from java.lang.Object.notify
- Defined in android.d.ts:81149
Returns void

notifyAll

notifyAll(): void

Inherited from java.lang.Object.notifyAll
- Defined in android.d.ts:81155
Returns void

rotateAround

rotateAround(axis: Axis): Direction

- Defined in kex.d.ts:7156
since
5.0

Parameters
- axis: Axis
Returns Direction
Direction obtained after rotating the following Direction clockwise around the given axis. Throws java.lang.IllegalStateException if axis is invalid.

rotateX

rotateX(): Direction

- Defined in kex.d.ts:7172
since
5.0

Returns Direction
Direction obtained after rotating the following Direction clockwise around the X axis. Throws java.lang.IllegalStateException for EAST and WEST or invalid Directions.

rotateY

rotateY(): Direction

- Defined in kex.d.ts:7164
since
5.0

Returns Direction
Direction obtained after rotating the following Direction clockwise around the Y axis. Throws java.lang.IllegalStateException for UP and DOWN or invalid Directions.

rotateYCCW

rotateYCCW(): Direction

- Defined in kex.d.ts:7188
since
5.0

Returns Direction
Direction obtained after rotating the following Direction counterclockwise around the Y axis. Throws java.lang.IllegalStateException for UP and DOWN or invalid Directions.

rotateZ

rotateZ(): Direction

- Defined in kex.d.ts:7180
since
5.0

Returns Direction
Direction obtained after rotating the following Direction clockwise around the Z axis. Throws java.lang.IllegalStateException for NORTH and SOUTH or invalid Directions.

toString

toString(): string

Inherited from java.lang.Object.toString
- Defined in android.d.ts:81148
Returns string

wait

wait(): void
wait(param0: number): void
wait(param0: number, param1: number): void

Inherited from java.lang.Object.wait
- Defined in android.d.ts:81144
Returns void
Inherited from java.lang.Object.wait
- Defined in android.d.ts:81146
Parameters
- param0: number
Returns void
Inherited from java.lang.Object.wait
- Defined in android.d.ts:81152
Parameters
- param0: number
- param1: number
Returns void

Static byName

byName(name: any_string): Direction

- Defined in kex.d.ts:7221
since
5.0

Parameters
- name: any_string
Returns Direction
Direction instance by given name or null if a Direction with given name does not exist

Static fromAngle

fromAngle(angle: number): Direction

- Defined in kex.d.ts:7238
since
5.0

Parameters
- angle: number
Returns Direction
one of four horizontal Directions best matching to the given angle in degrees

Static getFacingFromAxis

getFacingFromAxis(axisDir: AxisDirection, axis: Axis): Direction

- Defined in kex.d.ts:7263
since
5.0

Parameters
- axisDir: AxisDirection
- axis: Axis
Returns Direction
Direction with matching axis and axis direction. Throws java.lang.IllegalArgumentException if given axis and axis direction don't have a corresponding Direction instance.

Static getFacingFromVector

getFacingFromVector(x: number, y: number, z: number): Direction

- Defined in kex.d.ts:7255
since
5.0

Parameters
- x: number
- y: number
- z: number
Returns Direction

Static getFront

getFront(index: number): Direction

- Defined in kex.d.ts:7226
since
5.0

Parameters
- index: number
Returns Direction

Static getHorizontal

getHorizontal(index: number): Direction

- Defined in kex.d.ts:7231
since
5.0

Parameters
- index: number
Returns Direction

Static random

random(rand: Random): Direction

- Defined in kex.d.ts:7250
since
5.0

Parameters
- rand: Random
Returns Direction
one of six Directions randomly chosen using given java.util.Random object

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

index: number

opposite: number

horizontalIndex: number

name: any_string

axisDirection: AxisDirection

axis: Axis

directionVec: Vec3i

Returns Direction

Properties

Static Readonly DOWN

Static Readonly EAST

Static Readonly NORTH

Static Readonly SOUTH

Static Readonly UP

Static Readonly WEST

Static class

Methods

clone

Returns any

equals

Parameters

param0: any

Returns boolean

finalize

Returns void

getAxis

Returns Axis

getAxisDirection

Returns AxisDirection

getClass

Returns Class<any>

getClockWise

Parameters

axis: Axis

Returns Direction

Returns Direction

getClockWiseX

Returns Direction

getClockWiseZ

Returns Direction

getCounterClockWise

Parameters

axis: Axis

Returns Direction

Returns Direction

getCounterClockWiseX

Returns Direction

getCounterClockWiseZ

Returns Direction

getDirectionVec

Returns Vec3i

getFrontOffsetX

Returns number

getFrontOffsetY

Returns number

getFrontOffsetZ

Returns number

getHorizontalAngle

Returns number

getIndex

Returns number

getOpposite

Returns Direction

hashCode

Returns number

notify

Returns void

notifyAll

Returns void

rotateAround

Parameters

axis: Axis