com.simsilica.lemur.component

Class IconComponent

java.lang.Object

com.simsilica.lemur.component.AbstractGuiComponent

com.simsilica.lemur.component.IconComponent

All Implemented Interfaces:

ColoredComponent, GuiComponent, java.lang.Cloneable

public class IconComponent
extends AbstractGuiComponent
implements java.lang.Cloneable, ColoredComponent

Presents an image as a stackable component that can either by anchored to the sides and take up component space or treated as an overlay. If it is used as an overlay then it will not affect the preferred size of the overall component stack.

Constructor Summary

Constructors

Constructor and Description
IconComponent(java.lang.String imagePath)
IconComponent(java.lang.String imagePath, float iconScale, float xMargin, float yMargin, float zOffset, boolean lit)
IconComponent(java.lang.String imagePath, com.jme3.math.Vector2f iconScale, float xMargin, float yMargin, float zOffset, boolean lit)
IconComponent(com.jme3.texture.Texture image, com.jme3.math.Vector2f iconScale, float xMargin, float yMargin, float zOffset, boolean lit)

Method Summary

Modifier and Type	Method and Description
void	attach(GuiControl parent)
void	calculatePreferredSize(com.jme3.math.Vector3f size)
IconComponent	clone()
protected void	createIcon()
void	detach(GuiControl parent)
float	getAlpha() Returns the current alpha multiplier that is applied to the color when set to the actual visuals.
float	getAlphaDiscard()
com.jme3.math.ColorRGBA	getColor() Returns the current color of this component.
protected com.jme3.math.Vector2f	getEffectiveIconSize()
HAlignment	getHAlignment()
com.jme3.math.Vector2f	getIconScale()
com.jme3.math.Vector2f	getIconSize()
com.jme3.texture.Texture	getImageTexture()
com.jme3.math.Vector2f	getMargin()
GuiMaterial	getMaterial()
com.jme3.math.Vector3f	getOffset()
VAlignment	getVAlignment()
float	getZOffset()
boolean	isOverlay()
protected void	resetAlignment()
protected void	resetColor()
void	reshape(com.jme3.math.Vector3f pos, com.jme3.math.Vector3f size)
void	setAlpha(float f) Sets an alpha multiplier that will be applied to the color when set to the actual visuals.
void	setAlphaDiscard(float alphaDiscard) Sets the alphaDiscardThreshold for the image material.
void	setColor(com.jme3.math.ColorRGBA c) Sets the color for this component.
void	setHAlignment(HAlignment a)
void	setIconScale(float scale)
void	setIconScale(com.jme3.math.Vector2f scale)
void	setIconSize(com.jme3.math.Vector2f iconSize) Forces the size of the icon to be the size specified regardless of it's actual pixel size.
void	setImageTexture(com.jme3.texture.Texture t)
void	setMargin(float x, float y)
void	setMargin(com.jme3.math.Vector2f margin)
void	setOffset(com.jme3.math.Vector3f v)
void	setOverlay(boolean f)
void	setVAlignment(VAlignment a)
void	setZOffset(float z)

Methods inherited from class com.simsilica.lemur.component.AbstractGuiComponent

getGuiControl, getNode, invalidate, isAttached

Methods inherited from class java.lang.Object

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

Constructor Detail

IconComponent

public IconComponent(java.lang.String imagePath)

IconComponent

public IconComponent(java.lang.String imagePath,
                     float iconScale,
                     float xMargin,
                     float yMargin,
                     float zOffset,
                     boolean lit)

IconComponent

public IconComponent(java.lang.String imagePath,
                     com.jme3.math.Vector2f iconScale,
                     float xMargin,
                     float yMargin,
                     float zOffset,
                     boolean lit)

IconComponent

public IconComponent(com.jme3.texture.Texture image,
                     com.jme3.math.Vector2f iconScale,
                     float xMargin,
                     float yMargin,
                     float zOffset,
                     boolean lit)

Method Detail

clone

public IconComponent clone()

Specified by:

clone in interface GuiComponent

Overrides:

clone in class AbstractGuiComponent

attach

public void attach(GuiControl parent)

Specified by:

attach in interface GuiComponent

Overrides:

attach in class AbstractGuiComponent

detach

public void detach(GuiControl parent)

Specified by:

detach in interface GuiComponent

Overrides:

detach in class AbstractGuiComponent

setImageTexture

public void setImageTexture(com.jme3.texture.Texture t)

getImageTexture

public com.jme3.texture.Texture getImageTexture()

setColor

public void setColor(com.jme3.math.ColorRGBA c)

Description copied from interface: ColoredComponent

Sets the color for this component.

Specified by:

setColor in interface ColoredComponent

resetColor

protected void resetColor()

getColor

public com.jme3.math.ColorRGBA getColor()

Description copied from interface: ColoredComponent

Returns the current color of this component.

Specified by:

getColor in interface ColoredComponent

setAlpha

public void setAlpha(float f)

Description copied from interface: ColoredComponent

Sets an alpha multiplier that will be applied to the color when set to the actual visuals.

Specified by:

setAlpha in interface ColoredComponent

getAlpha

public float getAlpha()

Description copied from interface: ColoredComponent

Returns the current alpha multiplier that is applied to the color when set to the actual visuals.

Specified by:

getAlpha in interface ColoredComponent

setIconScale

public void setIconScale(float scale)

setIconScale

public void setIconScale(com.jme3.math.Vector2f scale)

getIconScale

public com.jme3.math.Vector2f getIconScale()

setIconSize

public void setIconSize(com.jme3.math.Vector2f iconSize)

Forces the size of the icon to be the size specified regardless of it's actual pixel size. So if setIconSize(new Vector2f(64, 64)) is used for an icon that is actually 32x32, it will be doubled in size. The iconScale is applied after this scaling. Set iconSize to null to go back to the actual image size.

getIconSize

public com.jme3.math.Vector2f getIconSize()

setHAlignment

public void setHAlignment(HAlignment a)

getHAlignment

public HAlignment getHAlignment()

setVAlignment

public void setVAlignment(VAlignment a)

getVAlignment

public VAlignment getVAlignment()

setMargin

public void setMargin(float x,
                      float y)

setMargin

public void setMargin(com.jme3.math.Vector2f margin)

getMargin

public com.jme3.math.Vector2f getMargin()

setZOffset

public void setZOffset(float z)

getZOffset

public float getZOffset()

setOffset

public void setOffset(com.jme3.math.Vector3f v)

getOffset

public com.jme3.math.Vector3f getOffset()

setOverlay

public void setOverlay(boolean f)

isOverlay

public boolean isOverlay()

setAlphaDiscard

public void setAlphaDiscard(float alphaDiscard)

Sets the alphaDiscardThreshold for the image material. If an alpha value is below this threshold then it will be discarded rather than being written to the color and zbuffers. Set to 0 to disable. Defaults to 0.

Note: for 2D UIs this threshold is not necessary as 2D GUIs will always sort purely back-to-front on Z. For 3D UIs, this setting may prevent visual artifacts from certain directions for very transparent pixels (background showing through, etc.))

getAlphaDiscard

public float getAlphaDiscard()

getMaterial

public GuiMaterial getMaterial()

calculatePreferredSize

public void calculatePreferredSize(com.jme3.math.Vector3f size)

Specified by:

calculatePreferredSize in interface GuiComponent

reshape

public void reshape(com.jme3.math.Vector3f pos,
                    com.jme3.math.Vector3f size)

Specified by:

reshape in interface GuiComponent

resetAlignment

protected void resetAlignment()

createIcon

protected void createIcon()

getEffectiveIconSize

protected com.jme3.math.Vector2f getEffectiveIconSize()