net.malisis.core.renderer.icon

Class MalisisIcon

java.lang.Object

net.minecraft.client.renderer.texture.TextureAtlasSprite

net.malisis.core.renderer.icon.MalisisIcon

Direct Known Subclasses:

ClippedIcon, GuiIcon, VanillaIcon

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

Extension of TextureAtlasSprite to allow common operations like clipping and offset.
Allows to have an IIcon that is not registered, but depending on a registered one.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<MalisisIcon>	dependants Lists of MalisisIcon 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 MalisisIcon	missing Missing texture MalisisIcon
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
MalisisIcon() Instantiates a new MalisisIcon.
MalisisIcon(MalisisIcon baseIcon) Instantiates a new MalisisIcon.
MalisisIcon(java.lang.String name) Instantiates a new MalisisIcon.
MalisisIcon(java.lang.String name, float u, float v, float U, float V) Instantiates a new MalisisIcon.
MalisisIcon(net.minecraft.client.renderer.texture.TextureAtlasSprite icon)

Method Summary

Modifier and Type	Method and Description
void	addDependant(MalisisIcon icon) Adds a MalisisIcon to be dependant on this one.
MalisisIcon	clip(float offsetXFactor, float offsetYFactor, float widthFactor, float heightFactor) Clips this MalisisIcon.
MalisisIcon	clip(int offsetX, int offsetY, int width, int height) Clips this MalisisIcon.
MalisisIcon	copy() Creates a new MalisisIcon from this MalisisIcon.
void	copyFrom(net.minecraft.client.renderer.texture.TextureAtlasSprite base) Copies the values from base to this MalisisIcon.
MalisisIcon	flip(boolean horizontal, boolean vertical) Sets this MalisisIcon to be flipped.
float	getMaxU() Gets the max u.
float	getMaxV() Gets the max v.
float	getMinU() Gets the min u.
float	getMinV() Gets the min v.
int	getRotation() Gets the rotation.
protected void	initIcon(MalisisIcon baseIcon, int width, int height, int x, int y, boolean rotated) Initializes this MalisisIcon.
void	initSprite(int width, int height, int x, int y, boolean rotated) Called when the part represented by this MalisisIcon 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.
MalisisIcon	offset(int offsetX, int offsetY) Offsets this MalisisIcon by a specified amount.
MalisisIcon	register(net.minecraft.client.renderer.texture.TextureMap textureMap) Attempts to register this MalisisIcon to the TextureMap.
void	setRotation(int rotation) Sets the rotation for this MalisisIcon.
void	setSize(int width, int height) Sets the size in pixel of this MalisisIcon.
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, hasAnimationMetadata, hasCustomLoader, load, loadSprite, makeAtlasSprite, setFramesTextureData, setIconHeight, setIconWidth, setLocationNameClock, setLocationNameCompass, toString, updateAnimation

Methods inherited from class java.lang.Object

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

Field Detail

missing

public static MalisisIcon missing

Missing texture MalisisIcon

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<MalisisIcon> dependants

Lists of MalisisIcon depending on this one.

Constructor Detail

MalisisIcon

public MalisisIcon()

Instantiates a new MalisisIcon.

MalisisIcon

public MalisisIcon(java.lang.String name)

Instantiates a new MalisisIcon.

Parameters:

name - the name

MalisisIcon

public MalisisIcon(MalisisIcon baseIcon)

Instantiates a new MalisisIcon.

Parameters:

baseIcon - the base icon

MalisisIcon

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

Instantiates a new MalisisIcon.

Parameters:

name - the name

u - the u

v - the v

U - the u

V - the v

MalisisIcon

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

Method Detail

addDependant

public void addDependant(MalisisIcon icon)

Adds a MalisisIcon to be dependant on this one. Will call initIcon(MalisisIcon, 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 MalisisIcon.

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 MalisisIcon flip(boolean horizontal,
                        boolean vertical)

Sets this MalisisIcon to be flipped.

Parameters:

horizontal - whether to flip horizontally

vertical - whether to flip vertically

Returns:

this MalisisIcon

isFlippedU

public boolean isFlippedU()

Checks if is flipped u.

Returns:

true if this MalisisIcon is flipped horizontally.

isFlippedV

public boolean isFlippedV()

Checks if is flipped v.

Returns:

true if this MalisisIcon is flipped vertically.

isRotated

public boolean isRotated()

Checks if is rotated.

Returns:

true fi this MalisisIcon is rotated.

setRotation

public void setRotation(int rotation)

Sets the rotation for this MalisisIcon. 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 MalisisIcon.

initIcon

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

Initializes this MalisisIcon. 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 MalisisIcon offset(int offsetX,
                          int offsetY)

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

Parameters:

offsetX - the x offset

offsetY - the y offset

Returns:

this MalisisIcon

clip

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

Clips this MalisisIcon. 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 MalisisIcon

clip

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

Clips this MalisisIcon. 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 MalisisIcon

initSprite

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

Called when the part represented by this MalisisIcon 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 MalisisIcon.

Overrides:

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

Parameters:

base - the icon to copy from

copy

public MalisisIcon copy()

Creates a new MalisisIcon from this MalisisIcon.

Returns:

the new MalisisIcon

register

public MalisisIcon register(net.minecraft.client.renderer.texture.TextureMap textureMap)

Attempts to register this MalisisIcon to the TextureMap. If a MalisisIcon is already registered with this name, that registered icon will be returned instead.

Parameters:

textureMap - the TextureMap

Returns:

this MalisisIcon if not already registered, otherwise, the MalisisIcon already inside the registry.