net.risingworld.api.gui

Class GuiImage

java.lang.Object

net.risingworld.api.gui.GuiElement

net.risingworld.api.gui.GuiImage

public class GuiImage
extends GuiElement

An image gui element (which can display custom images).

Constructor Summary

Constructors

Constructor and Description
GuiImage(float x, float y, boolean relativeposition, float width, float height, boolean relativesize) Creates a new image object at the given screen position with the given size which does not hold an actual image yet.
GuiImage(ImageInformation image, float x, float y, boolean relativeposition, float width, float height, boolean relativesize) Creates a new image object at the given screen position with the given size.

Method Summary

Modifier and Type	Method and Description
ImageInformation	getImage() Gets the image object that is currently set for this element.
float	getProportionalHeight()
float	getProportionalWidth()
boolean	isClickable()
boolean	isMipMappingEnabled() Gets whether or not mip mapping is enabled for this image.
boolean	isProportionalSize()
boolean	isRelativeProportionalSize()
void	refresh() Refreshes this element, i.e. synchronizes it between the client and the server.
void	setClickable(boolean set)
void	setColor(float r, float g, float b, float a) Sets the color of this element.
void	setColor(int color) Sets the color of this element.
void	setHeightProportional(float newwidth, boolean relative) Sets a new width and calculates a proportional height for this image.
void	setImage(ImageInformation image)
void	setMipMappingEnabled(boolean mipmapping) Sets mip mapping for this image (default true).
void	setSize(float width, float height, boolean relative) Sets the size of this element.
void	setWidthProportional(float newheight, boolean relative) Sets a new height and calculates a proportional width for this image.

Methods inherited from class net.risingworld.api.gui.GuiElement

addChild, destroy, equals, getAlpha, getBorderColor, getBorderThickness, getChildren, getColor, getHeight, getHoverColor, getID, getParent, getParentID, getPivot, getPositionX, getPositionY, getWidth, hashCode, isAlwaysInBackground, isAlwaysOnTop, isRelativeBorderThickness, isRelativePosition, isRelativeSize, isVisible, onClick, removeAllChildren, removeChild, removeFromParent, setAlpha, setAlwaysInBackground, setAlwaysOnTop, setBorderColor, setBorderColor, setBorderThickness, setPivot, setPosition, setVisible

Methods inherited from class java.lang.Object

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

Constructor Detail

GuiImage

public GuiImage(float x,
                float y,
                boolean relativeposition,
                float width,
                float height,
                boolean relativesize)

Creates a new image object at the given screen position with the given size which does not hold an actual image yet.

Parameters:

x - the x screen position (horizontally).

y - the y screen position (vertically).

relativeposition - set to false to use absolute coordinates (i.e. pixel coordinates), or true to use relative coordinates (range between 0 and 1).

width - the width of this element.

height - the height of this element.

relativesize - set to false to use absolute coordinates (i.e. pixel coordinates), or true to use relative coordinates (range between 0 and 1).

GuiImage

public GuiImage(ImageInformation image,
                float x,
                float y,
                boolean relativeposition,
                float width,
                float height,
                boolean relativesize)

Creates a new image object at the given screen position with the given size.

Parameters:

image - the actual image.

x - the x screen position (horizontally).

y - the y screen position (vertically).

relativeposition - set to false to use absolute coordinates (i.e. pixel coordinates), or true to use relative coordinates (range between 0 and 1).

width - the width of this element.

height - the height of this element.

relativesize - set to false to use absolute coordinates (i.e. pixel coordinates), or true to use relative coordinates (range between 0 and 1).

Method Detail

setImage

public void setImage(ImageInformation image)

getImage

public ImageInformation getImage()

Gets the image object that is currently set for this element.

Returns:

the current image object, or null if no image was set yet.

setHeightProportional

public void setHeightProportional(float newwidth,
                                  boolean relative)

Sets a new width and calculates a proportional height for this image. This can be used to avoid image stretching.

Parameters:

newwidth - the new width you want to set.

relative - true if the provided width is a relative value, false if it is absolute.

setWidthProportional

public void setWidthProportional(float newheight,
                                 boolean relative)

Sets a new height and calculates a proportional width for this image. This can be used to avoid image stretching.

Parameters:

newheight - the new height you want to set.

relative - true if the provided height is a relative value, false if it is absolute.

isProportionalSize

public boolean isProportionalSize()

isRelativeProportionalSize

public boolean isRelativeProportionalSize()

getProportionalWidth

public float getProportionalWidth()

getProportionalHeight

public float getProportionalHeight()

setMipMappingEnabled

public void setMipMappingEnabled(boolean mipmapping)

Sets mip mapping for this image (default true). Set to false to get a sharper, but possibly a more pixelated image when using different resolutions.

Parameters:

mipmapping - set to true to enable mip mapping, false to disable it.

isMipMappingEnabled

public boolean isMipMappingEnabled()

Gets whether or not mip mapping is enabled for this image.

Returns:

true if mip mapping is enabled, false if not.

setClickable

public void setClickable(boolean set)

isClickable

public boolean isClickable()

Overrides:

isClickable in class GuiElement

setColor

public void setColor(int color)

Sets the color of this element. If an image is set, the color will be multiplied with the image. Otherwise the color serves as background color.

Overrides:

setColor in class GuiElement

Parameters:

color - an RGBA integer value which specifies the color.

setColor

public void setColor(float r,
                     float g,
                     float b,
                     float a)

Sets the color of this element. If an image is set, the color will be multiplied with the image. Otherwise the color serves as background color.

Overrides:

setColor in class GuiElement

Parameters:

r - the red color value (0-1)

g - the green color value (0-1)

b - the blue color value (0-1)

a - the alpha value (0-1), 0 makes the element invisible, 1 fully opaque.

setSize

public void setSize(float width,
                    float height,
                    boolean relative)

Description copied from class: GuiElement

Sets the size of this element.

Overrides:

setSize in class GuiElement

Parameters:

width - the width of this element.

height - the height of this element.

relative - set to false to use absolute coordinates (i.e. pixel coordinates), or true to use relative coordinates (range between 0 and 1).

refresh

public void refresh()

Description copied from class: GuiElement

Refreshes this element, i.e. synchronizes it between the client and the server. There is no need to call this method manually.

Overrides:

refresh in class GuiElement