Package gaiasky.render

Interface I3DTextRenderable

All Superinterfaces:

IRenderable

All Known Implementing Classes:

BackgroundModel, Billboard, BillboardGalaxy, CelestialBody, Constellation, CosmicRuler, Gaia, GenericSpacecraft, Invisible, KeyframesPathObject, LightBeam, Loc, MeshObject, MilkyWay, ModelBody, NBGalaxy, Particle, ParticleGroup, Planet, Satellite, Spacecraft, SphericalGrid, Star, StarCluster, StarGroup, Text2D

public interface I3DTextRenderable
extends IRenderable

Interface to be implemented by all entities that can render a text in 3d space

Method Summary

Modifier and Type	Method	Description
float	getTextOpacity()	Gets the text opacity
boolean	isLabel()	Is it a label or another kind of text?
void	render(ExtSpriteBatch batch, ExtShaderProgram shader, FontRenderSystem sys, RenderingContext rc, ICamera camera)	Renders the text
boolean	renderText()	Tells whether the text must be rendered or not for this entity
java.lang.String	text()	Returns the text
float[]	textColour()	Returns an array with the text colour in the fashion [r, g, b, a]
void	textDepthBuffer()	Executes the blending for the text
void	textPosition(ICamera cam, Vector3d out)	Sets the position of this text in the out vector
float	textScale()	Returns the text scale for the scale varying in the shader
float	textSize()	Returns the text size

Methods inherited from interface gaiasky.render.IRenderable

getComponentType, getDistToCamera, getOpacity

Method Detail

renderText

boolean renderText()

Tells whether the text must be rendered or not for this entity

Returns:

True if text must be rendered

render

void render(ExtSpriteBatch batch,
            ExtShaderProgram shader,
            FontRenderSystem sys,
            RenderingContext rc,
            ICamera camera)

Renders the text

Parameters:

batch - The sprite batch

shader - The shader

sys - The font render system

rc - The render context

camera - The camera

textColour

float[] textColour()

Returns an array with the text colour in the fashion [r, g, b, a]

Returns:

Array with the colour

textSize

float textSize()

Returns the text size

Returns:

The text size

textScale

float textScale()

Returns the text scale for the scale varying in the shader

Returns:

The scale

textPosition

void textPosition(ICamera cam,
                  Vector3d out)

Sets the position of this text in the out vector

Parameters:

out - The out parameter with the result

text

java.lang.String text()

Returns the text

Returns:

The text

textDepthBuffer

void textDepthBuffer()

Executes the blending for the text

isLabel

boolean isLabel()

Is it a label or another kind of text?

Returns:

Whether this is a label

getTextOpacity

float getTextOpacity()

Gets the text opacity

Returns:

Text opacity