Package gaiasky.scenegraph

Class CosmicRuler

java.lang.Object

gaiasky.scenegraph.SceneGraphNode

gaiasky.scenegraph.CosmicRuler

All Implemented Interfaces:

com.badlogic.gdx.utils.Disposable, IObserver, I3DTextRenderable, ILineRenderable, IRenderable, IStarContainer, IVisibilitySwitch, IPosition

public class CosmicRuler
extends SceneGraphNode
implements I3DTextRenderable, ILineRenderable, IObserver

Cosmic ruler that shows the distance between two objects.

Field Summary

Fields inherited from class gaiasky.scenegraph.SceneGraphNode

B31, B32, B33, B34, cc, children, computed, coordinates, copy, ct, D31, D32, D33, D34, distToCamera, F31, F32, F33, F34, forceLabel, id, labelcolor, lastStateChangeTimeMs, localizedNameIndex, localTransform, names, numChildren, octant, octantId, opacity, orientation, parent, parentName, pos, posSph, ROOT_NAME, size, translation, viewAngle, viewAngleApparent, visible

Constructor Summary

Constructors

Constructor	Description
CosmicRuler()
CosmicRuler(String name0, String name1)

Method Summary

Modifier and Type	Method	Description
protected void	addToRenderLists(ICamera camera)	Adds this entity to the necessary render lists after the distance to the camera and the view angle have been determined.
int	getGlPrimitive()
float	getLineWidth()
String	getName0()
String	getName1()
float	getTextOpacity()	Gets the text opacity
boolean	hasAttached()	Returns true if the ruler is attached to at least one object.
boolean	hasObject0()
boolean	hasObject1()
boolean	isLabel()	Is it a label or another kind of text?
void	notify(Event event, Object source, Object... data)	Event notification call.
void	render(LineRenderSystem renderer, ICamera camera, float alpha)
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
boolean	rulerOk()
void	setName0(String name0)
void	setName1(String name1)
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
void	updateLocalValues(ITimeFrameProvider time, ICamera camera)	This function updates all the local values before the localTransform is updated.

Methods inherited from class gaiasky.scenegraph.SceneGraphNode

add, add, addChild, addChild, addFocusableObjects, addName, addNodes, addToIndex, addToRender, computeFuturePosition, dispose, doneLoading, getAbsoluteOrientation, getAbsolutePosition, getAbsolutePosition, getAggregatedChildren, getAlpha, getChildByName, getChildByNameAndType, getChildrenByComponentType, getChildrenByType, getColor, getComponentType, getCoordinates, getCt, getDelta, getDescription, getDistToCamera, getFirstStarAncestor, getHeight, getHeight, getHeight, getHeightScale, getId, getLabelcolor, getLineCopy, getLocalizedName, getName, getNames, getNext, getNode, getNode, getOctant, getOpacity, getOrientation, getPos, getPosition, getPosition, getPosSph, getPredictedPosition, getRadius, getRoot, getSceneGraphDepth, getSimpleCopy, getSize, getStarCount, getUnrotatedPos, getVelocity, getViewAngle, getViewAngleApparent, getVisibilityOpacityFactor, hasCt, hasName, hasName, initialize, insert, isCopy, isForceLabel, isForceLabel, isInRender, isInRender, isValidPosition, isVisibilityOn, isVisible, isVisible, isVisible, isVisibleGroup, isVisibleGroup, msSinceStateChange, mustAddToIndex, mustUpdatePosition, namesConcat, removeChild, removeFromIndex, removeFromRender, render2DLabel, render2DLabel, render2DLabel, render2DLabel, render3DLabel, render3DLabel, returnToPool, setColor, setColor, setComputedFlag, setCoordinates, setCt, setCt, setDescription, setForcelabel, setForceLabel, setForceLabel, setId, setLabelcolor, setLabelcolor, setLabelcolor, setName, setName, setNames, setParent, setPos, setSize, setSize, setUp, setVisible, setVisible, setVisibleGroup, shouldRender, toString, update, update, updateLocal, updateLocalizedName, updateLocalizedNameRecursive

Methods inherited from class java.lang.Object

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

Methods inherited from interface gaiasky.render.IRenderable

getComponentType, getDistToCamera, getOpacity

Constructor Details

CosmicRuler

public CosmicRuler()

CosmicRuler

public CosmicRuler(String name0,
 String name1)

Method Details

getLineWidth

public float getLineWidth()

Specified by:

getLineWidth in interface ILineRenderable

render

public void render(LineRenderSystem renderer,
 ICamera camera,
 float alpha)

Specified by:

render in interface ILineRenderable

render

public void render(ExtSpriteBatch batch,
 ExtShaderProgram shader,
 FontRenderSystem 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 font render system

rc - The render context

camera - The camera

addToRenderLists

protected void addToRenderLists(ICamera camera)

Description copied from class: SceneGraphNode

Adds this entity to the necessary render lists after the distance to the camera and the view angle have been determined.

Overrides:

addToRenderLists in class SceneGraphNode

updateLocalValues

public void updateLocalValues(ITimeFrameProvider time,
 ICamera camera)

Description copied from class: SceneGraphNode

This function updates all the local values before the localTransform is updated. Position, rotations and scale must be updated in here.

Overrides:

updateLocalValues in class SceneGraphNode

getName0

public String getName0()

setName0

public void setName0(String name0)

getName1

public String getName1()

setName1

public void setName1(String name1)

rulerOk

public boolean rulerOk()

hasAttached

public boolean hasAttached()

Returns true if the ruler is attached to at least one object.

Returns:

Ture if the ruler is attached.

hasObject0

public boolean hasObject0()

hasObject1

public boolean hasObject1()

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

textColour

public float[] textColour()

Description copied from interface: I3DTextRenderable

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

Specified by:

textColour in interface I3DTextRenderable

Returns:

Array with the colour

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)

Description copied from interface: I3DTextRenderable

Sets the position of this text in the out vector

Specified by:

textPosition in interface I3DTextRenderable

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

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

getTextOpacity

public float getTextOpacity()

Description copied from interface: I3DTextRenderable

Gets the text opacity

Specified by:

getTextOpacity in interface I3DTextRenderable

Returns:

Text opacity

notify

public void notify(Event event,
 Object source,
 Object... data)

Description copied from interface: IObserver

Event notification call.

Specified by:

notify in interface IObserver

Parameters:

event - The event type.

source - The source object, if any.

data - The data associated with this event.

getGlPrimitive

public int getGlPrimitive()

Specified by:

getGlPrimitive in interface ILineRenderable