Applied-Energistics-2-tilera-Edition/src/main/java/appeng/parts/reporting/AbstractPartReporting.java

/*
 * This file is part of Applied Energistics 2.
 * Copyright (c) 2013 - 2014, AlgorithmX2, All rights reserved.
 *
 * Applied Energistics 2 is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Applied Energistics 2 is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Applied Energistics 2.  If not, see <http://www.gnu.org/licenses/lgpl>.
 */

package appeng.parts.reporting;


import java.io.IOException;

import io.netty.buffer.ByteBuf;

import net.minecraft.entity.player.EntityPlayer;
import net.minecraft.item.ItemStack;
import net.minecraft.nbt.NBTTagCompound;
import net.minecraft.tileentity.TileEntity;
import net.minecraft.util.MathHelper;
import net.minecraft.util.Vec3;

import appeng.api.implementations.IPowerChannelState;
import appeng.api.implementations.parts.IPartMonitor;
import appeng.api.networking.GridFlags;
import appeng.api.networking.events.MENetworkBootingStatusChange;
import appeng.api.networking.events.MENetworkEventSubscribe;
import appeng.api.networking.events.MENetworkPowerStatusChange;
import appeng.api.parts.IPartCollisionHelper;
import appeng.api.util.AEPartLocation;
import appeng.client.texture.CableBusTextures;
import appeng.me.GridAccessException;
import appeng.parts.AEBasePart;
import appeng.util.Platform;


/**
 * The most basic class for any part reporting information, like terminals or monitors. This can also include basic
 * panels which just provide light.
 *
 * It deals with the most basic functionalities like network data, grid registration or the rotation of the actual part.
 *
 * The direct abstract subclasses are usually a better entry point for adding new concrete ones.
 * But this might be an ideal starting point to completely new type, which does not resemble any existing one.
 *
 * @author AlgorithmX2
 * @author yueh
 * @version rv3
 * @since rv3
 */
public abstract class AbstractPartReporting extends AEBasePart implements IPartMonitor, IPowerChannelState
{

	protected static final int POWERED_FLAG = 4;
	protected static final int CHANNEL_FLAG = 16;
	private static final int BOOTING_FLAG = 8;

	private byte spin = 0; // 0-3
	private int clientFlags = 0; // sent as byte.
	private float opacity = -1;

	public AbstractPartReporting( ItemStack is )
	{
		this( is, false );
	}

	protected AbstractPartReporting( ItemStack is, boolean requireChannel )
	{
		super( is );

		if( requireChannel )
		{
			this.proxy.setFlags( GridFlags.REQUIRE_CHANNEL );
			this.proxy.setIdlePowerUsage( 1.0 / 2.0 );
		}
		else
		{
			this.proxy.setIdlePowerUsage( 1.0 / 16.0 ); // lights drain a little bit.
		}
	}

	@MENetworkEventSubscribe
	public final void bootingRender( MENetworkBootingStatusChange c )
	{
		if( !this.isLightSource() )
		{
			this.getHost().markForUpdate();
		}
	}

	@MENetworkEventSubscribe
	public final void powerRender( MENetworkPowerStatusChange c )
	{
		this.getHost().markForUpdate();
	}

	@Override
	public final void getBoxes( IPartCollisionHelper bch )
	{
		bch.addBox( 2, 2, 14, 14, 14, 16 );
		bch.addBox( 4, 4, 13, 12, 12, 14 );
	}

	@Override
	public void onNeighborChanged()
	{
		this.opacity = -1;
		this.getHost().markForUpdate();
	}

	@Override
	public void readFromNBT( NBTTagCompound data )
	{
		super.readFromNBT( data );
		if( data.hasKey( "opacity" ) )
		{
			this.opacity = data.getFloat( "opacity" );
		}
		this.spin = data.getByte( "spin" );
	}

	@Override
	public void writeToNBT( NBTTagCompound data )
	{
		super.writeToNBT( data );
		data.setFloat( "opacity", this.opacity );
		data.setByte( "spin", this.getSpin() );
	}

	@Override
	public void writeToStream( ByteBuf data ) throws IOException
	{
		super.writeToStream( data );
		this.clientFlags = this.getSpin() & 3;

		try
		{
			if( this.proxy.getEnergy().isNetworkPowered() )
			{
				this.clientFlags = this.getClientFlags() | AbstractPartReporting.POWERED_FLAG;
			}

			if( this.proxy.getPath().isNetworkBooting() )
			{
				this.clientFlags = this.getClientFlags() | AbstractPartReporting.BOOTING_FLAG;
			}

			if( this.proxy.getNode().meetsChannelRequirements() )
			{
				this.clientFlags = this.getClientFlags() | AbstractPartReporting.CHANNEL_FLAG;
			}
		}
		catch( final GridAccessException e )
		{
			// um.. nothing.
		}

		data.writeByte( (byte) this.getClientFlags() );
	}

	@Override
	public boolean readFromStream( ByteBuf data ) throws IOException
	{
		super.readFromStream( data );
		final int oldFlags = this.getClientFlags();
		this.clientFlags = data.readByte();
		this.spin = (byte) ( this.getClientFlags() & 3 );
		if( this.getClientFlags() == oldFlags )
		{
			return false;
		}
		return true;
	}

	@Override
	public final int getLightLevel()
	{
		return this.blockLight( this.isPowered() ? ( this.isLightSource() ? 15 : 9 ) : 0 );
	}

	@Override
	public boolean onPartActivate( EntityPlayer player, Vec3 pos )
	{
		final TileEntity te = this.getTile();

		if( !player.isSneaking() && Platform.isWrench( player, player.inventory.getCurrentItem(), te.getPos() ) )
		{
			if( Platform.isServer() )
			{
				if( this.getSpin() > 3 )
				{
					this.spin = 0;
				}

				switch( this.getSpin() )
				{
					case 0:
						this.spin = 1;
						break;
					case 1:
						this.spin = 3;
						break;
					case 2:
						this.spin = 0;
						break;
					case 3:
						this.spin = 2;
						break;
				}

				this.host.markForUpdate();
				this.saveChanges();
			}
			return true;
		}
		else
		{
			return super.onPartActivate( player, pos );
		}
	}

	@Override
	public final void onPlacement( EntityPlayer player, ItemStack held, AEPartLocation side )
	{
		super.onPlacement( player, held, side );

		final byte rotation = (byte) ( MathHelper.floor_double( ( player.rotationYaw * 4F ) / 360F + 2.5D ) & 3 );
		if( side == AEPartLocation.UP )
		{
			this.spin = rotation;
		}
		else if( side == AEPartLocation.DOWN )
		{
			this.spin = rotation;
		}
	}

	private final int blockLight( int emit )
	{
		if( this.opacity < 0 )
		{
			final TileEntity te = this.getTile();
			this.opacity = 255 - te.getWorld().getBlockLightOpacity( te.getPos().offset( side.getFacing() ) );
		}

		return (int) ( emit * ( this.opacity / 255.0f ) );
	}

	@Override
	public final boolean isPowered()
	{
		try
		{
			if( Platform.isServer() )
			{
				return this.proxy.getEnergy().isNetworkPowered();
			}
			else
			{
				return( ( this.getClientFlags() & PartPanel.POWERED_FLAG ) == PartPanel.POWERED_FLAG );
			}
		}
		catch( final GridAccessException e )
		{
			return false;
		}
	}

	@Override
	public final boolean isActive()
	{
		if( !this.isLightSource() )
		{
			return( ( this.getClientFlags() & ( PartPanel.CHANNEL_FLAG | PartPanel.POWERED_FLAG ) ) == ( PartPanel.CHANNEL_FLAG | PartPanel.POWERED_FLAG ) );
		}
		else
		{
			return this.isPowered();
		}
	}

	public final int getClientFlags()
	{
		return this.clientFlags;
	}

	public final byte getSpin()
	{
		return this.spin;
	}

	/**
	 * The texture used for the bright front layer.
	 *
	 * The final texture can overlap any of the the texture in no particular order.
	 */
	public abstract CableBusTextures getFrontBright();

	/**
	 * The texture used for the colored (medium) front layer.
	 *
	 * The final texture can overlap any of the the texture in no particular order.
	 */
	public abstract CableBusTextures getFrontColored();

	/**
	 * The texture used for the dark front layer.
	 *
	 * The final texture can overlap any of the the texture in no particular order.
	 */
	public abstract CableBusTextures getFrontDark();

	/**
	 * Should the part emit light. This actually only affects the light level, light source use a level of 15 and non
	 * light source 9.
	 */
	public abstract boolean isLightSource();

}