nova.core.component.transform

Class Orientation

java.lang.Object

nova.core.component.Component

nova.core.component.transform.Orientation

All Implemented Interfaces:

Stateful, Syncable, Storable, Identifiable

public class Orientation
extends Component
implements Storable, Stateful, Syncable

A component that is applied to providers with discrete orientations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Orientation.OrientationChangeEvent

Nested classes/interfaces inherited from interface nova.core.block.Stateful

Stateful.LoadEvent, Stateful.UnloadEvent

Field Summary

Fields

Modifier and Type	Field and Description
boolean	isFlip
protected Direction	orientation The direction the block is facing.
ComponentProvider<? extends ComponentMap>	provider
java.util.function.Predicate<Direction>	rotationFilter The allowed rotation directions the block can face.

Constructor Summary

Constructors

Constructor and Description
Orientation(ComponentProvider provider)

Method Summary

Modifier and Type	Method and Description
Direction	calculateDirection(Entity entity) Calculates the direction using raytracing
Direction	calculateDirectionFromEntity(Entity entity) Determines the direction the block is facing based on the entity's facing
boolean	canRotate(Direction side)
boolean	canRotate(int side)
Orientation	flipPlacement(boolean flip) Set to true to use the oposite direction
int	getSideToRotate(int hitSide, org.apache.commons.math3.geometry.euclidean.threed.Vector3D hit) Determines the side to rotate based on the hit vector on the block.
Orientation	hookBasedOnEntity() Hooks the needed events intro the block to rotate based on the Entity's rotation when placing the block
Orientation	hookBasedOnHitSide() Hooks the needed events intro the block to rotate based on the side that is hit when placing the block
Orientation	hookRightClickRotate() Hooks the needed events intro the block to rotate when the block is right clicked.
void	load(Data data) Loads all the data for this object.
Direction	orientation()
void	read(Packet packet) Reads a packet.
boolean	rotate(int side, org.apache.commons.math3.geometry.euclidean.threed.Vector3D hit) Rotatable Block
void	save(Data data) Saves all the data of this object.
Orientation	setMask(Direction... rotationFilter) Set's the rotation mask
Orientation	setMask(int rotationFilter) Set's the rotation mask
Orientation	setMask(java.util.function.Predicate<Direction> rotationFilter) Set's the rotation mask
Orientation	setOrientation(Direction orientation) Changes the orientation
void	write(Packet packet) Writes a packet based on the arguments.

Methods inherited from class nova.core.component.Component

getID, getProvider, onProviderChange

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface nova.core.util.Identifiable

sameType

Field Detail

provider

public final ComponentProvider<? extends ComponentMap> provider

rotationFilter

public java.util.function.Predicate<Direction> rotationFilter

The allowed rotation directions the block can face.

isFlip

public boolean isFlip

orientation

protected Direction orientation

The direction the block is facing.

Constructor Detail

Orientation

public Orientation(ComponentProvider provider)

Parameters:

provider - The block to apply discrete orientations to

Method Detail

hookBasedOnHitSide

public Orientation hookBasedOnHitSide()

Hooks the needed events intro the block to rotate based on the side that is hit when placing the block

Returns:

The Orientation instance

hookBasedOnEntity

public Orientation hookBasedOnEntity()

Hooks the needed events intro the block to rotate based on the Entity's rotation when placing the block

Returns:

The Orientation instance

hookRightClickRotate

public Orientation hookRightClickRotate()

Hooks the needed events intro the block to rotate when the block is right clicked.

Returns:

The Orientation instance

orientation

public Direction orientation()

Returns:

The current orientation

setOrientation

public Orientation setOrientation(Direction orientation)

Changes the orientation

Parameters:

orientation - New orientation

Returns:

The Orientation instance

setMask

public Orientation setMask(java.util.function.Predicate<Direction> rotationFilter)

Set's the rotation mask

Parameters:

rotationFilter - New rotation mask

Returns:

The Orientation instance

See Also:

setMask(Direction...), setMask(int)

setMask

public Orientation setMask(Direction... rotationFilter)

Set's the rotation mask

Parameters:

rotationFilter - New rotation mask

Returns:

The Orientation instance

See Also:

setMask(Predicate), setMask(int)

setMask

public Orientation setMask(int rotationFilter)

Set's the rotation mask

Parameters:

rotationFilter - New rotation mask Each bit corresponds to a direction. E.g: 000011 will allow only up and down

Returns:

The Orientation instance

See Also:

setMask(Predicate), setMask(Direction...)

flipPlacement

public Orientation flipPlacement(boolean flip)

Set to true to use the oposite direction

Parameters:

flip - should flip rotation or not

Returns:

The Orientation instance

calculateDirection

public Direction calculateDirection(Entity entity)

Calculates the direction using raytracing

Parameters:

entity - The entity to start raytracing from

Returns:

The side of the block that is hit with the raytracing

calculateDirectionFromEntity

public Direction calculateDirectionFromEntity(Entity entity)

Determines the direction the block is facing based on the entity's facing

Parameters:

entity - The entity used to determine rotation

Returns:

The direction the block is facing

canRotate

public boolean canRotate(int side)

canRotate

public boolean canRotate(Direction side)

rotate

public boolean rotate(int side,
                      org.apache.commons.math3.geometry.euclidean.threed.Vector3D hit)

Rotatable Block

Parameters:

side - The hit side

hit - The hit vector

Returns:

If rotation is possible from this side

getSideToRotate

public int getSideToRotate(int hitSide,
                           org.apache.commons.math3.geometry.euclidean.threed.Vector3D hit)

Determines the side to rotate based on the hit vector on the block.

Parameters:

hitSide - The hit side

hit - The hit vector

Returns:

The rotation axis

save

public void save(Data data)

Description copied from interface: Storable

Saves all the data of this object. See Data for what data is storable. The default implementation saves all fields tagged with @Store.

Specified by:

save in interface Storable

Parameters:

data - The data object to put values in.

load

public void load(Data data)

Description copied from interface: Storable

Loads all the data for this object. See Data for what data is storable. The default implementation loads all fields tagged with @Store.

Specified by:

load in interface Storable

Parameters:

data - The data object to load values from.

read

public void read(Packet packet)

Description copied from interface: Syncable

Reads a packet.

Specified by:

read in interface Syncable

Parameters:

packet - - data encoded into the packet.

write

public void write(Packet packet)

Description copied from interface: Syncable

Writes a packet based on the arguments.

Specified by:

write in interface Syncable

Parameters:

packet - - data encoded into the packet