li.cil.tis3d.api.prefab.module

Class AbstractModuleRotatable

java.lang.Object

li.cil.tis3d.api.prefab.module.AbstractModule

li.cil.tis3d.api.prefab.module.AbstractModuleRotatable

All Implemented Interfaces:

Module, Rotatable

Direct Known Subclasses:

ModuleBundledRedstone, ModuleDisplay, ModuleExecution, ModuleKeypad, ModuleQueue, ModuleRandomAccessMemory, ModuleRedstone, ModuleStack, ModuleTerminal, ModuleTimer

public abstract class AbstractModuleRotatable
extends AbstractModule
implements Rotatable

This is a utility implementation of a rotatable module.

Rotatable modules can face one of four directions, the default being Port.UP. Most modules will either not need this at all, or only use this when installed in the top or bottom faces of casings. In some cases you may also merely want to use this for graphical purposes (e.g. the built-in redstone and stack modules do this).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractModuleRotatable(Casing casing, Face face)

Method Summary

Modifier and Type	Method and Description
Port	getFacing() Get the current orientation of the module.
protected net.minecraft.util.math.Vec3d	hitToUV(net.minecraft.util.math.Vec3d hitPos) Project a hit position on the surface of a casing to a UV coordinate on the face of this module.
void	readFromNBT(net.minecraft.nbt.NBTTagCompound nbt) Restore the state of the module from the specified NBT compound.
protected void	rotateForRendering() Apply the module's rotation to the OpenGL state.
void	setFacing(Port facing) Set the orientation of the module.
void	writeToNBT(net.minecraft.nbt.NBTTagCompound nbt) Save the state of the module to the specified NBT compound.

Methods inherited from class li.cil.tis3d.api.prefab.module.AbstractModule

cancelRead, cancelWrite, getCasing, getFace, getPlayerLookAt, isPlayerLookingAt, isVisible, onActivate, onData, onData, onDisabled, onDisposed, onEnabled, onInstalled, onUninstalled, onWriteComplete, render, step

Methods inherited from class java.lang.Object

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

Methods inherited from interface li.cil.tis3d.api.module.Module

getCasing, getFace, onActivate, onData, onData, onDisabled, onDisposed, onEnabled, onInstalled, onUninstalled, onWriteComplete, render, step

Constructor Detail

AbstractModuleRotatable

protected AbstractModuleRotatable(Casing casing,
                                  Face face)

Method Detail

rotateForRendering

protected void rotateForRendering()

Apply the module's rotation to the OpenGL state.

hitToUV

protected net.minecraft.util.math.Vec3d hitToUV(net.minecraft.util.math.Vec3d hitPos)

Description copied from class: AbstractModule

Project a hit position on the surface of a casing to a UV coordinate on the face of this module.

Note that this is also overridden in AbstractModuleRotatable to take into account the module's rotation.

Overrides:

hitToUV in class AbstractModule

Parameters:

hitPos - the hit position to project.

Returns:

the projected UV coordinate, with the Z component being 0.

See Also:

AbstractModule.getPlayerLookAt(), Module.onActivate(EntityPlayer, EnumHand, ItemStack, float, float, float)

readFromNBT

public void readFromNBT(net.minecraft.nbt.NBTTagCompound nbt)

Description copied from interface: Module

Restore the state of the module from the specified NBT compound.

Specified by:

readFromNBT in interface Module

Overrides:

readFromNBT in class AbstractModule

Parameters:

nbt - the tag to load the state from.

writeToNBT

public void writeToNBT(net.minecraft.nbt.NBTTagCompound nbt)

Description copied from interface: Module

Save the state of the module to the specified NBT compound.

Specified by:

writeToNBT in interface Module

Overrides:

writeToNBT in class AbstractModule

Parameters:

nbt - the tag to save the state to.

getFacing

public Port getFacing()

Description copied from interface: Rotatable

Get the current orientation of the module.

Specified by:

getFacing in interface Rotatable

Returns:

the current orientation.

setFacing

public void setFacing(Port facing)

Description copied from interface: Rotatable

Set the orientation of the module.

Specified by:

setFacing in interface Rotatable

Parameters:

facing - the orientation to set.