net.malisis.core.renderer.icon

Class Icon

java.lang.Object

net.minecraft.client.renderer.texture.TextureAtlasSprite

net.malisis.core.renderer.icon.Icon

Direct Known Subclasses:

ClippedIcon, GuiIcon, VanillaIcon

public class Icon
extends net.minecraft.client.renderer.texture.TextureAtlasSprite

Extension of TextureAtlasSprite to allow common operations like clipping and offset.
Icons should be acquired by using the from(String) method so that multiple call with the same name return the same Icon instance.
For non registered Icon, use Icon(String, boolean) constructor.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BLOCK_TEXTURE_HEIGHT Height of the block's texture atlas.
static int	BLOCK_TEXTURE_WIDTH Width of the block's texture atlas.
protected java.util.Set<Icon>	dependants Lists of Icon depending on this one.
protected boolean	flippedU Is the icon flipped on the horizontal axis.
protected boolean	flippedV Is the icon flipped on the vertical axis.
static Icon	missing Icon version of the missing texture
protected int	rotation Rotation value (clockwise).
protected int	sheetHeight Height of the global texture sheet.
protected int	sheetWidth Width of the global texture sheet.

Fields inherited from class net.minecraft.client.renderer.texture.TextureAtlasSprite

frameCounter, framesTextureData, height, interpolatedFrameData, maxU, maxV, minU, minV, originX, originY, rotated, tickCounter, width

Constructor Summary

Constructors

Constructor and Description
Icon() Instantiates a new Icon.
Icon(Icon baseIcon) Instantiates a new Icon.
Icon(java.lang.String name)
Icon(java.lang.String name, boolean register) Instantiates a new Icon.
Icon(java.lang.String name, float u, float v, float U, float V) Instantiates a new Icon.
Icon(net.minecraft.client.renderer.texture.TextureAtlasSprite icon)

Method Summary

Modifier and Type	Method and Description
void	addDependant(Icon icon) Adds a Icon to be dependant on this one.
Icon	clip(float offsetXFactor, float offsetYFactor, float widthFactor, float heightFactor) Clips this Icon.
Icon	clip(int offsetX, int offsetY, int width, int height) Clips this Icon.
Icon	copy() Creates a new Icon from this Icon.
void	copyFrom(net.minecraft.client.renderer.texture.TextureAtlasSprite base) Copies the values from base to this Icon.
Icon	flip(boolean horizontal, boolean vertical) Sets this Icon to be flipped.
static Icon	from(net.minecraft.block.Block block) Gets a Icon for the texture used for the Block default IBlockState.
static Icon	from(net.minecraft.block.state.IBlockState state) Gets a Icon for the texture used for the IBlockState
static Icon	from(net.minecraft.item.Item item) Gets a Icon for the texture used for the Item
static Icon	from(java.lang.String name) Gets a Icon with the specified name.
float	getMaxU() Gets the max u.
float	getMaxV() Gets the max v.
float	getMinU() Gets the min u.
float	getMinV() Gets the min v.
static Icon	getRegistered(java.lang.String name) Gets the Icon registered with specified name.
int	getRotation() Gets the rotation.
protected void	initIcon(Icon baseIcon, int width, int height, int x, int y, boolean rotated) Initializes this Icon.
void	initSprite(int width, int height, int x, int y, boolean rotated) Called when the part represented by this Icon is stiched to the texture.
boolean	isFlippedU() Checks if is flipped u.
boolean	isFlippedV() Checks if is flipped v.
boolean	isRotated() Checks if is rotated.
Icon	offset(int offsetX, int offsetY) Offsets this Icon by a specified amount.
static void	registerIcons(net.minecraft.client.renderer.texture.TextureMap map) Registers all the Icon into the TextureMap.
void	setRotation(int rotation) Sets the rotation for this Icon.
void	setSize(int width, int height) Sets the size in pixel of this Icon.
void	setUVs(float u, float v, float U, float V) Sets the u vs.

Methods inherited from class net.minecraft.client.renderer.texture.TextureAtlasSprite

clearFramesTextureData, generateMipmaps, getFrameCount, getFrameTextureData, getIconHeight, getIconName, getIconWidth, getInterpolatedU, getInterpolatedV, getOriginX, getOriginY, getUnInterpolatedU, getUnInterpolatedV, hasAnimationMetadata, hasCustomLoader, load, loadSprite, loadSpriteFrames, makeAtlasSprite, setFramesTextureData, setIconHeight, setIconWidth, toString, updateAnimation

Methods inherited from class java.lang.Object

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

Field Detail

missing

public static Icon missing

Icon version of the missing texture

BLOCK_TEXTURE_WIDTH

public static int BLOCK_TEXTURE_WIDTH

Width of the block's texture atlas.

BLOCK_TEXTURE_HEIGHT

public static int BLOCK_TEXTURE_HEIGHT

Height of the block's texture atlas.

sheetWidth

protected int sheetWidth

Width of the global texture sheet.

sheetHeight

protected int sheetHeight

Height of the global texture sheet.

flippedU

protected boolean flippedU

Is the icon flipped on the horizontal axis.

flippedV

protected boolean flippedV

Is the icon flipped on the vertical axis.

rotation

protected int rotation

Rotation value (clockwise).

dependants

protected java.util.Set<Icon> dependants

Lists of Icon depending on this one.

Constructor Detail

Icon

public Icon(java.lang.String name,
            boolean register)

Instantiates a new Icon.

Parameters:

name - the name

Icon

public Icon(java.lang.String name)

Icon

public Icon()

Instantiates a new Icon.

Icon

public Icon(Icon baseIcon)

Instantiates a new Icon.

Parameters:

baseIcon - the base icon

Icon

public Icon(java.lang.String name,
            float u,
            float v,
            float U,
            float V)

Instantiates a new Icon.

Parameters:

name - the name

u - the u

v - the v

U - the u

V - the v

Icon

public Icon(net.minecraft.client.renderer.texture.TextureAtlasSprite icon)

Method Detail

addDependant

public void addDependant(Icon icon)

Adds a Icon to be dependant on this one. Will call initIcon(Icon, int, int, int, int, boolean) when stiched to the sheet.

Parameters:

icon - the icon

setSize

public void setSize(int width,
                    int height)

Sets the size in pixel of this Icon.

Parameters:

width - the width

height - the height

setUVs

public void setUVs(float u,
                   float v,
                   float U,
                   float V)

Sets the u vs.

Parameters:

u - the u

v - the v

U - the u

V - the v

getMinU

public float getMinU()

Gets the min u.

Overrides:

getMinU in class net.minecraft.client.renderer.texture.TextureAtlasSprite

Returns:

the min u

getMaxU

public float getMaxU()

Gets the max u.

Overrides:

getMaxU in class net.minecraft.client.renderer.texture.TextureAtlasSprite

Returns:

the max u

getMinV

public float getMinV()

Gets the min v.

Overrides:

getMinV in class net.minecraft.client.renderer.texture.TextureAtlasSprite

Returns:

the min v

getMaxV

public float getMaxV()

Gets the max v.

Overrides:

getMaxV in class net.minecraft.client.renderer.texture.TextureAtlasSprite

Returns:

the max v

flip

public Icon flip(boolean horizontal,
                 boolean vertical)

Sets this Icon to be flipped.

Parameters:

horizontal - whether to flip horizontally

vertical - whether to flip vertically

Returns:

this Icon

isFlippedU

public boolean isFlippedU()

Checks if is flipped u.

Returns:

true if this Icon is flipped horizontally.

isFlippedV

public boolean isFlippedV()

Checks if is flipped v.

Returns:

true if this Icon is flipped vertically.

isRotated

public boolean isRotated()

Checks if is rotated.

Returns:

true fi this Icon is rotated.

setRotation

public void setRotation(int rotation)

Sets the rotation for this Icon. The icon will be rotated rotation x 90 degrees clockwise.

Parameters:

rotation - the rotation

getRotation

public int getRotation()

Gets the rotation.

Returns:

the rotation for this Icon.

initIcon

protected void initIcon(Icon baseIcon,
                        int width,
                        int height,
                        int x,
                        int y,
                        boolean rotated)

Initializes this Icon. Called from the icon this one depends on, copying the baseIcon values.

Parameters:

baseIcon - the base icon

width - the width

height - the height

x - the x

y - the y

rotated - the rotated

offset

public Icon offset(int offsetX,
                   int offsetY)

Offsets this Icon by a specified amount. offsetX and offsetY are specified in pixels.

Parameters:

offsetX - the x offset

offsetY - the y offset

Returns:

this Icon

clip

public Icon clip(int offsetX,
                 int offsetY,
                 int width,
                 int height)

Clips this Icon. offsetX, offsetY, width and height are specified in pixels.

Parameters:

offsetX - the x offset

offsetY - the y offset

width - the width

height - the height

Returns:

this Icon

clip

public Icon clip(float offsetXFactor,
                 float offsetYFactor,
                 float widthFactor,
                 float heightFactor)

Clips this Icon. offsetXFactor, offsetYFactor, widthFactor and heightFactor are values from zero to one.

Parameters:

offsetXFactor - the x factor for offset

offsetYFactor - the y factor for offset

widthFactor - the width factor

heightFactor - the height factor

Returns:

this Icon

initSprite

public void initSprite(int width,
                       int height,
                       int x,
                       int y,
                       boolean rotated)

Called when the part represented by this Icon is stiched to the texture. Sets most of the icon fields.

Overrides:

initSprite in class net.minecraft.client.renderer.texture.TextureAtlasSprite

Parameters:

width - the width

height - the height

x - the x

y - the y

rotated - the rotated

copyFrom

public void copyFrom(net.minecraft.client.renderer.texture.TextureAtlasSprite base)

Copies the values from base to this Icon.

Overrides:

copyFrom in class net.minecraft.client.renderer.texture.TextureAtlasSprite

Parameters:

base - the icon to copy from

copy

public Icon copy()

Creates a new Icon from this Icon.

Returns:

the new Icon

registerIcons

public static void registerIcons(net.minecraft.client.renderer.texture.TextureMap map)

Registers all the Icon into the TextureMap.

Parameters:

map - the map

from

public static Icon from(java.lang.String name)

Gets a Icon with the specified name.
This method ensures the same instance is return when called multiple time with the same string.

Parameters:

name - the name

Returns:

the malisis icon

from

public static Icon from(net.minecraft.block.Block block)

Gets a Icon for the texture used for the Block default IBlockState.

Parameters:

block - the block

Returns:

the malisis icon

from

public static Icon from(net.minecraft.block.state.IBlockState state)

Gets a Icon for the texture used for the IBlockState

Parameters:

state - the state

Returns:

the malisis icon

from

public static Icon from(net.minecraft.item.Item item)

Gets a Icon for the texture used for the Item

Parameters:

item - the item

Returns:

the malisis icon

getRegistered

public static Icon getRegistered(java.lang.String name)

Gets the Icon registered with specified name.

Parameters:

name - the name

Returns:

the registered