Package gaiasky.scenegraph

Class CelestialBody

java.lang.Object

gaiasky.scenegraph.SceneGraphNode

gaiasky.scenegraph.AbstractPositionEntity

gaiasky.scenegraph.CelestialBody

All Implemented Interfaces:

com.badlogic.gdx.utils.Disposable, I3DTextRenderable, IModelRenderable, IQuadRenderable, IRenderable, IFocus, IStarContainer, IPosition

Direct Known Subclasses:

Invisible, ModelBody, Particle

public abstract class CelestialBody
extends AbstractPositionEntity
implements I3DTextRenderable, IQuadRenderable, IModelRenderable, IFocus

Represents any celestial body.

Nested Class Summary

Nested classes/interfaces inherited from class gaiasky.scenegraph.SceneGraphNode

SceneGraphNode.RenderGroup, SceneGraphNode.TLV3, SceneGraphNode.TLV3D

Field Summary

Fields

Modifier and Type	Field	Description
float	absmag	Absolute magnitude, m = -2.5 log10(flux), with the flux at 10 pc
float	appmag	Apparent magnitude, m = -2.5 log10(flux)
float[]	ccPale	Red, green and blue colors and their revamped cousins
float[]	ccTransit	Colour for stars that have been observed by Gaia
float	colorbv	The B-V color index, calculated as the magnitude in B minus the magnitude in V
float	compalpha	Component alpha mirror
protected boolean	coordinatesTimeOverflow	Whether we are out of the time baseline range in the algorithm that works out the coordinates of this body
long	lastTransitIncrease	Last observations increase in ms
RotationComponent	rc	Holds information about the rotation of the body
float	TH_OVER_FACTOR
int	transits	Number of times this body has been observed by Gaia

Fields inherited from class gaiasky.scenegraph.AbstractPositionEntity

cc, coordinates, copy, distToCamera, octant, octantId, pos, posSph, size, viewAngle, viewAngleApparent

Fields inherited from class gaiasky.scenegraph.SceneGraphNode

aux3d1, aux3d2, aux3d3, aux3d4, aux3f1, aux3f2, aux3f3, aux3f4, children, computed, ct, id, localTransform, namekey, names, numChildren, opacity, orientation, parent, parentkey, parentName, ROOT_NAME, sg, translation

Constructor Summary

Constructors

Constructor	Description
CelestialBody()	Simple constructor

Method Summary

Modifier and Type	Method	Description
void	addFocusableObjects(com.badlogic.gdx.utils.Array<IFocus> list)	Adds all the children that are focusable objects to the list.
void	addHit(int screenX, int screenY, int w, int h, int minPixDist, NaturalCamera camera, com.badlogic.gdx.utils.Array<IFocus> hits)	Adds this focus to the hits list if it is hit by the [screenX, screenY] position
void	addHit(Vector3d p0, Vector3d p1, NaturalCamera camera, com.badlogic.gdx.utils.Array<IFocus> hits)	Adds this focus to the hits list if it is hit by the given ray
protected boolean	checkClickDistance(int screenX, int screenY, com.badlogic.gdx.math.Vector3 pos, NaturalCamera camera, com.badlogic.gdx.graphics.PerspectiveCamera pcamera, double pixelSize)
protected boolean	checkHitCondition()
protected double	computeViewAngle(float fovFactor)
float	getAbsmag()	Gets the absolute magnitude
float	getAppmag()	Gets the apparent magnitude
long	getCandidateId()	Returns the id of the focus candidate of this object.
java.lang.String	getCandidateName()	Returns the name of the focus candidate of this object.
double	getCandidateViewAngleApparent()	Returns the candidate apparent view angle (view angle corrected with the field of view) of this entity, in radians
Vector3d	getClosestAbsolutePos(Vector3d out)	Same as IFocus.getAbsolutePosition(Vector3d)
double	getClosestDistToCamera()	Same as IFocus.getDistToCamera()
java.lang.String	getClosestName()	Same as IFocus.getName()
IFocus	getFocus(java.lang.String name)	Prepares the candidate with the given name
float	getFuzzyRenderSize(ICamera camera)
abstract float	getInnerRad()
Quaterniond	getOrientationQuaternion()	Returns the orientation quaternion of this focus
double	getPmX()
double	getPmY()
double	getPmZ()
RotationComponent	getRotationComponent()	Returns the rotation component of this focus
<T extends SceneGraphNode> T	getSimpleCopy()	Gets a copy of this object but does not copy its parent or children
float	getTextOpacity()	Gets the text opacity
protected float	getThOverFactor(ICamera camera)
protected float	getThOverFactorScl()
double	getViewAngle()	Returns the current view angle of this entity, in radians.
protected float	getViewAnglePow()
boolean	hasAtmosphere()
boolean	isActive()	Returns whether this focus object is active or not.
boolean	isCoordinatesTimeOverflow()	Checks whether this foucs is within its valid time range, so that it can be used as a focus
boolean	isLabel()	Is it a label or another kind of text?
boolean	isStar()
boolean	isValidPosition()	Returns whether the current position is valid (usually, when there is no coordinates overflow)
protected abstract float	labelFactor()
protected abstract float	labelMax()
protected float	labelSizeConcrete()
void	makeFocus()	Hook that runs when the candidate is actually made focus
void	render(ExtSpriteBatch batch, ExtShaderProgram shader, FontRenderSystem sys, RenderingContext rc, ICamera camera)	Label rendering.
void	render(ExtShaderProgram shader, float alpha, IntMesh mesh, ICamera camera)	Billboard quad render, for planets and stars.
boolean	renderText()	Tells whether the text must be rendered or not for this entity
void	setAbsmag(java.lang.Double absmag)
void	setAltname(java.lang.String altname)
void	setAppmag(java.lang.Double appmag)
protected void	setColor2Data()
void	setMag(java.lang.Double mag)
void	setRotation(RotationComponent rc)	Sets the rotation period in hours
void	setSize(java.lang.Double size)	Sets the size of this entity in kilometers
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
abstract double	THRESHOLD_NONE()	radius/distance limit for rendering at all.
abstract double	THRESHOLD_POINT()	radius/distance limit for rendering as point.
abstract double	THRESHOLD_QUAD()	radius/distance limit for rendering as shader.
protected boolean	timeCondition(ITimeFrameProvider time)
void	update(ITimeFrameProvider time, Vector3d parentTransform, ICamera camera)	Overrides the update adding the magnitude limit thingy.
void	updateTransitNumber(boolean visible, ITimeFrameProvider time, FovCamera fcamera)	Updates the transit number of this body if visible is true and it is a new transit.
boolean	withinMagLimit()	Returns true if the focus is within the magnitude limit defined in GlobalConf

Methods inherited from class gaiasky.scenegraph.AbstractPositionEntity

addToRenderLists, computeFuturePosition, doneLoading, getAbsoluteOrientation, getAbsolutePosition, getAbsolutePosition, getAlpha, getDelta, getDistToCamera, getHeight, getHeight, getHeight, getHeightScale, getNext, getOctant, getPos, getPosition, getPosition, getPosSph, getPredictedPosition, getRadius, getSize, getUnrotatedPos, getViewAngleApparent, isCopy, mustUpdatePosition, render2DLabel, render2DLabel, render2DLabel, render2DLabel, render3DLabel, setColor, setColor, setCoordinates, setLabelcolor, setLabelcolor, setSize, updateLocal, updateLocalValues

Methods inherited from class gaiasky.scenegraph.SceneGraphNode

add, add, addChild, addChild, addName, addNodes, addToIndex, addToRender, dispose, getAggregatedChildren, getChildByName, getChildByNameAndType, getChildrenByType, getComponentType, getCt, getFirstStarAncestor, getId, getLineCopy, getName, getNames, getNode, getNode, getOpacity, getOrientation, getRoot, getSceneGraphDepth, getStarCount, getVelocity, hasName, hasName, initialize, insert, insert, isInRender, isInRender, isVisibilityOn, mustAddToIndex, namesConcat, removeChild, removeFromIndex, removeFromRender, returnToPool, setComputedFlag, setCt, setCt, setId, setName, setNamekey, setNames, setParent, setParentkey, setUp, toString, update, updateNames, updateNamesRec

Methods inherited from class java.lang.Object

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

Methods inherited from interface gaiasky.scenegraph.IFocus

getAbsolutePosition, getAbsolutePosition, getAlpha, getCt, getDelta, getDistToCamera, getFirstStarAncestor, getHeight, getHeight, getHeight, getHeightScale, getId, getName, getNames, getNext, getOctant, getOrientation, getPos, getPosSph, getPredictedPosition, getRadius, getSceneGraphDepth, getSize, getViewAngleApparent, hasName, hasName, isCopy

Methods inherited from interface gaiasky.render.IModelRenderable

render

Methods inherited from interface gaiasky.render.IRenderable

getComponentType, getDistToCamera, getOpacity

Field Detail

TH_OVER_FACTOR

public float TH_OVER_FACTOR

absmag

public float absmag

Absolute magnitude, m = -2.5 log10(flux), with the flux at 10 pc

appmag

public float appmag

Apparent magnitude, m = -2.5 log10(flux)

ccPale

public float[] ccPale

Red, green and blue colors and their revamped cousins

ccTransit

public float[] ccTransit

Colour for stars that have been observed by Gaia

colorbv

public float colorbv

The B-V color index, calculated as the magnitude in B minus the magnitude in V

rc

public RotationComponent rc

Holds information about the rotation of the body

transits

public int transits

Number of times this body has been observed by Gaia

lastTransitIncrease

public long lastTransitIncrease

Last observations increase in ms

compalpha

public float compalpha

Component alpha mirror

coordinatesTimeOverflow

protected boolean coordinatesTimeOverflow

Whether we are out of the time baseline range in the algorithm that works out the coordinates of this body

Constructor Detail

CelestialBody

public CelestialBody()

Simple constructor

Method Detail

THRESHOLD_NONE

public abstract double THRESHOLD_NONE()

radius/distance limit for rendering at all. If angle is smaller than this quantity, no rendering happens.

THRESHOLD_QUAD

public abstract double THRESHOLD_QUAD()

radius/distance limit for rendering as shader. If angle is any bigger, we render as a model.

THRESHOLD_POINT

public abstract double THRESHOLD_POINT()

radius/distance limit for rendering as point. If angle is any bigger, we render with shader.

update

public void update(ITimeFrameProvider time,
                   Vector3d parentTransform,
                   ICamera camera)

Overrides the update adding the magnitude limit thingy.

Overrides:

update in class SceneGraphNode

render

public void render(ExtShaderProgram shader,
                   float alpha,
                   IntMesh mesh,
                   ICamera camera)

Billboard quad render, for planets and stars.

Specified by:

render in interface IQuadRenderable

getFuzzyRenderSize

public float getFuzzyRenderSize(ICamera camera)

render

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

Label rendering.

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

getViewAnglePow

protected float getViewAnglePow()

getThOverFactorScl

protected float getThOverFactorScl()

getThOverFactor

protected float getThOverFactor(ICamera camera)

setColor2Data

protected void setColor2Data()

getInnerRad

public abstract float getInnerRad()

setMag

public void setMag(java.lang.Double mag)

setAbsmag

public void setAbsmag(java.lang.Double absmag)

setAppmag

public void setAppmag(java.lang.Double appmag)

getAppmag

public float getAppmag()

Description copied from interface: IFocus

Gets the apparent magnitude

Specified by:

getAppmag in interface IFocus

Returns:

The apparent magnitude

getAbsmag

public float getAbsmag()

Description copied from interface: IFocus

Gets the absolute magnitude

Specified by:

getAbsmag in interface IFocus

Returns:

The absolute magnitude

isActive

public boolean isActive()

Description copied from interface: IFocus

Returns whether this focus object is active or not. Useful for particle groups

Specified by:

isActive in interface IFocus

Returns:

The active status

addFocusableObjects

public void addFocusableObjects(com.badlogic.gdx.utils.Array<IFocus> list)

Adds all the children that are focusable objects to the list.

Overrides:

addFocusableObjects in class SceneGraphNode

Parameters:

list -

getViewAngle

public double getViewAngle()

Description copied from class: AbstractPositionEntity

Returns the current view angle of this entity, in radians.

Specified by:

getViewAngle in interface IFocus

Overrides:

getViewAngle in class AbstractPositionEntity

Returns:

The view angle in radians.

setSize

public void setSize(java.lang.Double size)

Sets the size of this entity in kilometers

Overrides:

setSize in class AbstractPositionEntity

Parameters:

size - The size in km

isStar

public boolean isStar()

setRotation

public void setRotation(RotationComponent rc)

Sets the rotation period in hours

withinMagLimit

public boolean withinMagLimit()

Description copied from interface: IFocus

Returns true if the focus is within the magnitude limit defined in GlobalConf

Specified by:

withinMagLimit in interface IFocus

Returns:

True if focus within magnitude limit

getSimpleCopy

public <T extends SceneGraphNode> T getSimpleCopy()

Description copied from class: AbstractPositionEntity

Gets a copy of this object but does not copy its parent or children

Overrides:

getSimpleCopy in class AbstractPositionEntity

Returns:

The copied object

updateTransitNumber

public void updateTransitNumber(boolean visible,
                                ITimeFrameProvider time,
                                FovCamera fcamera)

Updates the transit number of this body if visible is true and it is a new transit. It also updates the colour if needed.

Parameters:

visible -

time -

timeCondition

protected boolean timeCondition(ITimeFrameProvider time)

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

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

textSize

public float textSize()

Description copied from interface: I3DTextRenderable

Returns the text size

Specified by:

textSize in interface I3DTextRenderable

Returns:

The text size

labelSizeConcrete

protected float labelSizeConcrete()

labelFactor

protected abstract float labelFactor()

labelMax

protected abstract float labelMax()

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 java.lang.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

hasAtmosphere

public boolean hasAtmosphere()

Specified by:

hasAtmosphere in interface IModelRenderable

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

getPmX

public double getPmX()

getPmY

public double getPmY()

getPmZ

public double getPmZ()

getRotationComponent

public RotationComponent getRotationComponent()

Description copied from interface: IFocus

Returns the rotation component of this focus

Specified by:

getRotationComponent in interface IFocus

Returns:

The rotation component. Can be null

getOrientationQuaternion

public Quaterniond getOrientationQuaternion()

Description copied from interface: IFocus

Returns the orientation quaternion of this focus

Specified by:

getOrientationQuaternion in interface IFocus

Returns:

The orientation quaternion. Can be null

addHit

public void addHit(int screenX,
                   int screenY,
                   int w,
                   int h,
                   int minPixDist,
                   NaturalCamera camera,
                   com.badlogic.gdx.utils.Array<IFocus> hits)

Description copied from interface: IFocus

Adds this focus to the hits list if it is hit by the [screenX, screenY] position

Specified by:

addHit in interface IFocus

Parameters:

screenX - The x position of the hit

screenY - The y position of the hit

w - The viewport width

h - The viewport height

minPixDist - The minimum pixel distance to consider as hit

camera - The camera

hits - The list where to add the element

addHit

public void addHit(Vector3d p0,
                   Vector3d p1,
                   NaturalCamera camera,
                   com.badlogic.gdx.utils.Array<IFocus> hits)

Description copied from interface: IFocus

Adds this focus to the hits list if it is hit by the given ray

Specified by:

addHit in interface IFocus

Parameters:

p0 - Start point of the ray

p1 - End point of the ray

camera - The camera

hits - The list where the focus is to be added

checkClickDistance

protected boolean checkClickDistance(int screenX,
                                     int screenY,
                                     com.badlogic.gdx.math.Vector3 pos,
                                     NaturalCamera camera,
                                     com.badlogic.gdx.graphics.PerspectiveCamera pcamera,
                                     double pixelSize)

computeViewAngle

protected double computeViewAngle(float fovFactor)

checkHitCondition

protected boolean checkHitCondition()

makeFocus

public void makeFocus()

Description copied from interface: IFocus

Hook that runs when the candidate is actually made focus

Specified by:

makeFocus in interface IFocus

getCandidateId

public long getCandidateId()

Description copied from interface: IFocus

Returns the id of the focus candidate of this object. Defaults to IFocus.getId()

Specified by:

getCandidateId in interface IFocus

Returns:

The id of the candidate

getCandidateName

public java.lang.String getCandidateName()

Description copied from interface: IFocus

Returns the name of the focus candidate of this object. Defaults to IFocus.getName()

Specified by:

getCandidateName in interface IFocus

Returns:

The name of the candidate

getCandidateViewAngleApparent

public double getCandidateViewAngleApparent()

Description copied from interface: IFocus

Returns the candidate apparent view angle (view angle corrected with the field of view) of this entity, in radians

Specified by:

getCandidateViewAngleApparent in interface IFocus

Returns:

The apparent view angle in radians

isCoordinatesTimeOverflow

public boolean isCoordinatesTimeOverflow()

Description copied from interface: IFocus

Checks whether this foucs is within its valid time range, so that it can be used as a focus

Specified by:

isCoordinatesTimeOverflow in interface IFocus

Returns:

Whether the focus object is within its valid time range

getTextOpacity

public float getTextOpacity()

Description copied from interface: I3DTextRenderable

Gets the text opacity

Specified by:

getTextOpacity in interface I3DTextRenderable

Returns:

Text opacity

setAltname

public void setAltname(java.lang.String altname)

getFocus

public IFocus getFocus(java.lang.String name)

Description copied from interface: IFocus

Prepares the candidate with the given name

Specified by:

getFocus in interface IFocus

Parameters:

name - The name in lower case

isValidPosition

public boolean isValidPosition()

Description copied from class: SceneGraphNode

Returns whether the current position is valid (usually, when there is no coordinates overflow)

Overrides:

isValidPosition in class SceneGraphNode

Returns:

getClosestName

public java.lang.String getClosestName()

Description copied from interface: IFocus

Same as IFocus.getName()

Specified by:

getClosestName in interface IFocus

Returns:

The name

getClosestDistToCamera

public double getClosestDistToCamera()

Description copied from interface: IFocus

Same as IFocus.getDistToCamera()

Specified by:

getClosestDistToCamera in interface IFocus

Returns:

The distance to the camera in internal units

getClosestAbsolutePos

public Vector3d getClosestAbsolutePos(Vector3d out)

Description copied from interface: IFocus

Same as IFocus.getAbsolutePosition(Vector3d)

Specified by:

getClosestAbsolutePos in interface IFocus

Parameters:

out - Vector3d where to put the return value

Returns:

The absolute position, same as aux