Class LabelView

java.lang.Object

gaiasky.scene.view.AbstractView

gaiasky.scene.view.BaseView

gaiasky.scene.view.RenderView

gaiasky.scene.view.LabelView

All Implemented Interfaces:

I3DTextRenderable, IRenderable

public class LabelView
extends RenderView
implements I3DTextRenderable

Contains the actual implementation of label rendering for different object types.

Field Summary

Fields

Modifier and Type	Field	Description
BillboardSet	bbSet
Cluster	cluster
Constel	constel
GraphNode	graph
Label	label
LocationMark	loc
Mesh	mesh
Ruler	ruler
SolidAngle	sa

Fields inherited from class RenderView

extra, particleSet, starSet

Modifier and Type	Field	Description
ParticleExtra	extra	Particle component, maybe.
ParticleSet	particleSet	Particle set component
StarSet	starSet	Star set component

Fields inherited from class BaseView

base, body, render

Modifier and Type	Field	Description
Base	base	The base component.
Body	body	The body component.
Render	render	The render component.

Fields inherited from class AbstractView

entity

Modifier and Type	Field	Description
protected com.badlogic.ashley.core.Entity	entity	A reference to the entity.

Constructor Summary

Constructors

Constructor	Description
LabelView()

Method Summary

Modifier and Type	Method	Description
void	defaultTextDepthBuffer()
void	emptyTextDepthBuffer()
protected void	entityChanged()	Contains actions to take after a new entity has been set.
protected void	entityCheck(com.badlogic.ashley.core.Entity entity)	Checks whether the given entity is suitable for this view.
protected void	entityCleared()	This method is called when the entity of this view is cleared.
float	getTextOpacity()	Gets the text opacity
boolean	isLabel()	Is it a label or another kind of text?
boolean	isLocation()
void	noTextDepthBuffer()
void	render(ExtSpriteBatch batch, ExtShaderProgram shader, TextRenderer sys, RenderingContext rc, ICamera camera)	Renders the text
protected void	render2DLabel(ExtSpriteBatch batch, ExtShaderProgram shader, RenderingContext rc, BitmapFont font, ICamera camera, String label, float x, float y)
protected void	render2DLabel(ExtSpriteBatch batch, ExtShaderProgram shader, RenderingContext rc, BitmapFont font, ICamera camera, String label, float x, float y, float scale)
protected void	render2DLabel(ExtSpriteBatch batch, ExtShaderProgram shader, RenderingContext rc, BitmapFont font, ICamera camera, String label, float x, float y, float scale, int align)
protected void	render2DLabel(ExtSpriteBatch batch, ExtShaderProgram shader, RenderingContext rc, BitmapFont font, ICamera camera, String label, Vector3D pos3d)
protected void	render3DLabel(ExtSpriteBatch batch, ExtShaderProgram shader, BitmapFont font, ICamera camera, RenderingContext rc, String label, Vector3D pos, double distToCamera, float scale, double size, double radius, boolean forceLabel)
protected void	render3DLabel(ExtSpriteBatch batch, ExtShaderProgram shader, BitmapFont font, ICamera camera, RenderingContext rc, String label, Vector3D pos, double distToCamera, float scale, double size, double radius, float minSizeDegrees, float maxSizeDegrees, boolean forceLabel)
boolean	renderText()	Tells whether the text must be rendered or not for this entity
boolean	renderTextBackgroundModel()
boolean	renderTextBase()
boolean	renderTextCelestial()
boolean	renderTextEssential()
boolean	renderTextGridRec()
boolean	renderTextKeyframe()
boolean	renderTextLocation()
boolean	renderTextParticle()
boolean	renderTextRuler()
boolean	renderTextTitle()
boolean	renderTextTrajectory()
String	text()	Returns the text
void	textDepthBuffer()	Executes the blending for the text
void	textPosition(ICamera cam, Vector3D out)	Text position for single objects (models, single stars, etc.).
float	textScale()	Returns the text scale for the scale varying in the shader
float	textSize()	Returns the text size

Methods inherited from class RenderView

getDistToCamera, getOpacity, getRadius, textColour, textColour

Modifier and Type	Method	Description
double	getDistToCamera()	Gets the last distance to the camera calculated for this entity
float	getOpacity()	Returns the opacity of this renderable
double	getRadius()
float[]	textColour()	Text color for single objects
float[]	textColour(String name)	Text color for the star with the given name in a star set.

Methods inherited from class BaseView

componentsCheck, getBase, getBody, getComponent, getComponentType, getRender, hasCt, isHalfResolutionBuffer, isVisible, isVisible, setColor, setVisible, setVisible

Modifier and Type	Method	Description
protected boolean	componentsCheck(com.badlogic.ashley.core.Entity entity)	Check whether the current components are the same as the components of the given entity.
Base	getBase()
Body	getBody()
<T extends com.badlogic.ashley.core.Component> T	getComponent(Class<T> c)
ComponentTypes	getComponentType()
Render	getRender()
boolean	hasCt(ComponentTypes.ComponentType ct)
boolean	isHalfResolutionBuffer()
boolean	isVisible()
boolean	isVisible(boolean attributeValue)
void	setColor(float[] color)
void	setVisible(boolean visible)
void	setVisible(boolean visible, String name)

Methods inherited from class AbstractView

check, clearEntity, getEntity, isEmpty, isValid, setEntity

Modifier and Type	Method	Description
protected void	check(com.badlogic.ashley.core.Entity entity, com.badlogic.ashley.core.ComponentMapper mapper, Class<? extends com.badlogic.ashley.core.Component> componentClass)	Checks whether an entity has a component, and throws a RuntimeException if it does not.
void	clearEntity()	Removes the entity (if any) of this view and sets all component references to null.
com.badlogic.ashley.core.Entity	getEntity()	Returns the current entity under this view.
boolean	isEmpty()	Checks whether an entity is set in this view.
boolean	isValid()	Checks whether the entity is valid, i.e., it is not null and has at least one component.
void	setEntity(com.badlogic.ashley.core.Entity entity)	Sets the entity behind this view.

Methods inherited from class Object

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

Methods inherited from interface I3DTextRenderable

textColour

Modifier and Type	Method	Description
float[]	textColour()	Returns an array with the text colour in the fashion [r, g, b, a]

Methods inherited from interface IRenderable

getComponentType, isHalfResolutionBuffer

Modifier and Type	Method	Description
ComponentTypes	getComponentType()	Gets the component types of this entity
boolean	isHalfResolutionBuffer()	Is this renderable flagged to be rendered in a half-resolution buffer?

Field Details

label

public Label label

graph

public GraphNode graph

sa

public SolidAngle sa

cluster

public Cluster cluster

bbSet

public BillboardSet bbSet

constel

public Constel constel

mesh

public Mesh mesh

ruler

public Ruler ruler

loc

public LocationMark loc

Constructor Details

LabelView

public LabelView()

Method Details

entityCheck

protected void entityCheck(com.badlogic.ashley.core.Entity entity)

Description copied from class: AbstractView

Checks whether the given entity is suitable for this view. This method should throw a RuntimeException if the entity is not suitable.

Overrides:

entityCheck in class BaseView

Parameters:

entity - The entity.

entityChanged

protected void entityChanged()

Description copied from class: AbstractView

Contains actions to take after a new entity has been set. This method is typically used to initialize the view components.

Overrides:

entityChanged in class RenderView

entityCleared

protected void entityCleared()

Description copied from class: AbstractView

This method is called when the entity of this view is cleared. It should set all component references to null.

Overrides:

entityCleared in class RenderView

renderTextCelestial

public boolean renderTextCelestial()

renderTextParticle

public boolean renderTextParticle()

renderTextLocation

public boolean renderTextLocation()

renderTextKeyframe

public boolean renderTextKeyframe()

renderTextRuler

public boolean renderTextRuler()

renderTextBackgroundModel

public boolean renderTextBackgroundModel()

renderTextTitle

public boolean renderTextTitle()

renderTextTrajectory

public boolean renderTextTrajectory()

renderTextGridRec

public boolean renderTextGridRec()

renderTextEssential

public boolean renderTextEssential()

renderTextBase

public boolean renderTextBase()

renderText

public boolean renderText()

Description copied from interface: I3DTextRenderable

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

Specified by:

renderText in interface I3DTextRenderable

Returns:

True if text must be rendered

render

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

Description copied from interface: I3DTextRenderable

Renders the text

Specified by:

render in interface I3DTextRenderable

Parameters:

batch - The sprite batch

shader - The shader

sys - The text renderer

rc - The render context

camera - The camera

textSize

public float textSize()

Description copied from interface: I3DTextRenderable

Returns the text size

Specified by:

textSize in interface I3DTextRenderable

Returns:

The text size

textScale

public float textScale()

Description copied from interface: I3DTextRenderable

Returns the text scale for the scale varying in the shader

Specified by:

textScale in interface I3DTextRenderable

Returns:

The scale

textPosition

public void textPosition(ICamera cam,
 Vector3D out)

Text position for single objects (models, single stars, etc.).

Specified by:

textPosition in interface I3DTextRenderable

Parameters:

cam - The camera.

out - The out parameter with the result.

text

public String text()

Description copied from interface: I3DTextRenderable

Returns the text

Specified by:

text in interface I3DTextRenderable

Returns:

The text

textDepthBuffer

public void textDepthBuffer()

Description copied from interface: I3DTextRenderable

Executes the blending for the text

Specified by:

textDepthBuffer in interface I3DTextRenderable

defaultTextDepthBuffer

public void defaultTextDepthBuffer()

noTextDepthBuffer

public void noTextDepthBuffer()

emptyTextDepthBuffer

public void emptyTextDepthBuffer()

isLabel

public boolean isLabel()

Description copied from interface: I3DTextRenderable

Is it a label or another kind of text?

Specified by:

isLabel in interface I3DTextRenderable

Returns:

Whether this is a label

isLocation

public boolean isLocation()

getTextOpacity

public float getTextOpacity()

Description copied from interface: I3DTextRenderable

Gets the text opacity

Specified by:

getTextOpacity in interface I3DTextRenderable

Returns:

Text opacity

render2DLabel

protected void render2DLabel(ExtSpriteBatch batch,
 ExtShaderProgram shader,
 RenderingContext rc,
 BitmapFont font,
 ICamera camera,
 String label,
 Vector3D pos3d)

render2DLabel

protected void render2DLabel(ExtSpriteBatch batch,
 ExtShaderProgram shader,
 RenderingContext rc,
 BitmapFont font,
 ICamera camera,
 String label,
 float x,
 float y,
 float scale,
 int align)

render2DLabel

protected void render2DLabel(ExtSpriteBatch batch,
 ExtShaderProgram shader,
 RenderingContext rc,
 BitmapFont font,
 ICamera camera,
 String label,
 float x,
 float y)

render2DLabel

protected void render2DLabel(ExtSpriteBatch batch,
 ExtShaderProgram shader,
 RenderingContext rc,
 BitmapFont font,
 ICamera camera,
 String label,
 float x,
 float y,
 float scale)

render3DLabel

protected void render3DLabel(ExtSpriteBatch batch,
 ExtShaderProgram shader,
 BitmapFont font,
 ICamera camera,
 RenderingContext rc,
 String label,
 Vector3D pos,
 double distToCamera,
 float scale,
 double size,
 double radius,
 boolean forceLabel)

render3DLabel

protected void render3DLabel(ExtSpriteBatch batch,
 ExtShaderProgram shader,
 BitmapFont font,
 ICamera camera,
 RenderingContext rc,
 String label,
 Vector3D pos,
 double distToCamera,
 float scale,
 double size,
 double radius,
 float minSizeDegrees,
 float maxSizeDegrees,
 boolean forceLabel)