Package com.simsilica.lemur.component

Class TbtQuadBackgroundComponent

java.lang.Object

com.simsilica.lemur.component.AbstractGuiComponent

com.simsilica.lemur.component.TbtQuadBackgroundComponent

All Implemented Interfaces:

ColoredComponent, GuiComponent, Cloneable

public class TbtQuadBackgroundComponent
extends AbstractGuiComponent
implements Cloneable, ColoredComponent

A texture-covered background quad.

The texture is split up into a three-by-three grid in this fashion:

    +---+--------------+-------+
    |   |    <----->   |       |
 y2 +---+--------------+-------+
    |   |              |       |
    | ^ |       ^      |   ^   |
    | | |       |      |   |   |
    | | |    <----->   |   |   |
    | | |       |      |   |   |
    | v |       v      |   v   |
    |   |              |       |
 y1 +---+--------------+-------+
    |   |    <----->   |       |
    +---+--------------+-------+
       x1             x2
 

Arrows indicate the direction in which each grid cell will stretch to fill the area given by the component.
All coordinates are relative to the lower-left border.

Common pitfalls

• Placing controls on a fractional coordinate. This usually happens when centering controls.
• Having a contrast at the border between stretched and unstretched texture zone (e.g. a black border and a white center). Stretching involves interpolating colors with the neighbouring pixels (i.e. you'll get a black-to-white color gradient).
  The easiest workaround is to make the border one pixel wider so that the contrast will be safely inside the unstretched area.
• Using a texture that is larger than the quad.

Constructor Summary

Constructors

Constructor	Description
TbtQuadBackgroundComponent(TbtQuad quad)
TbtQuadBackgroundComponent(TbtQuad quad, Texture texture)
TbtQuadBackgroundComponent(TbtQuad quad, Texture texture, float xMargin, float yMargin)
TbtQuadBackgroundComponent(TbtQuad quad, Texture texture, float xMargin, float yMargin, float zOffset, boolean lit)

Method Summary

Modifier and Type	Method	Description
void	attach(GuiControl parent)
void	calculatePreferredSize(Vector3f size)
TbtQuadBackgroundComponent	clone()
static TbtQuadBackgroundComponent	create(Texture t, float imageScale, int x1, int y1, int x2, int y2, float zOffset, boolean lit)
static TbtQuadBackgroundComponent	create(String texture, float imageScale, int x1, int y1, int x2, int y2, float zOffset, boolean lit)
protected void	createGeometry()
protected void	createMaterial()
void	detach(GuiControl parent)
float	getAlpha()	Returns the current alpha multiplier that is applied to the color when set to the actual visuals.
ColorRGBA	getColor()	Returns the current color of this component.
Vector2f	getMargin()
GuiMaterial	getMaterial()
Texture	getTexture()
float	getZOffset()
protected void	refreshBackground(Vector3f size)
protected void	resetColor()
void	reshape(Vector3f pos, Vector3f size)
void	setAlpha(float f)	Sets an alpha multiplier that will be applied to the color when set to the actual visuals.
void	setColor(ColorRGBA c)	Sets the color for this component.
void	setMargin(float x, float y)
void	setMargin(Vector2f margin)
void	setTexture(Texture t)
void	setZOffset(float z)
String	toString()

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, wait, wait, wait

Constructor Details

TbtQuadBackgroundComponent

public TbtQuadBackgroundComponent(TbtQuad quad)

TbtQuadBackgroundComponent

public TbtQuadBackgroundComponent(TbtQuad quad,
 Texture texture)

TbtQuadBackgroundComponent

public TbtQuadBackgroundComponent(TbtQuad quad,
 Texture texture,
 float xMargin,
 float yMargin)

TbtQuadBackgroundComponent

public TbtQuadBackgroundComponent(TbtQuad quad,
 Texture texture,
 float xMargin,
 float yMargin,
 float zOffset,
 boolean lit)

Method Details

create

public static TbtQuadBackgroundComponent create(String texture,
 float imageScale,
 int x1,
 int y1,
 int x2,
 int y2,
 float zOffset,
 boolean lit)

create

public static TbtQuadBackgroundComponent create(Texture t,
 float imageScale,
 int x1,
 int y1,
 int x2,
 int y2,
 float zOffset,
 boolean lit)

clone

public TbtQuadBackgroundComponent 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

setColor

public void setColor(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 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

setTexture

public void setTexture(Texture t)

getTexture

public Texture getTexture()

setMargin

public void setMargin(float x,
 float y)

setMargin

public void setMargin(Vector2f margin)

getMargin

public Vector2f getMargin()

setZOffset

public void setZOffset(float z)

getZOffset

public float getZOffset()

getMaterial

public GuiMaterial getMaterial()

calculatePreferredSize

public void calculatePreferredSize(Vector3f size)

Specified by:

calculatePreferredSize in interface GuiComponent

reshape

public void reshape(Vector3f pos,
 Vector3f size)

Specified by:

reshape in interface GuiComponent

createMaterial

protected void createMaterial()

createGeometry

protected void createGeometry()

refreshBackground

protected void refreshBackground(Vector3f size)

toString

public String toString()

Overrides:

toString in class Object