Package gaiasky.scenegraph

Class SceneGraphNode

java.lang.Object
gaiasky.scenegraph.SceneGraphNode
All Implemented Interfaces:
com.badlogic.gdx.utils.Disposable, IStarContainer, IVisibilitySwitch, IPosition
Direct Known Subclasses:
Area, Axes, CelestialBody, ConstellationBoundaries, CosmicRuler, FadeNode, Loc, MilkyWay, StarCluster, StubModel, VertsObject
public class SceneGraphNode
extends java.lang.Object
implements IStarContainer, IPosition, IVisibilitySwitch
An object in the scene graph. Serves as a top class which provides the basic functionality.

  • Field Details

    • ROOT_NAME

      public static final java.lang.String ROOT_NAME
      See Also:
      Constant Field Values

    • aux3d1

      protected static TLV3D aux3d1

    • aux3d2

      protected static TLV3D aux3d2

    • aux3d3

      protected static TLV3D aux3d3

    • aux3d4

      protected static TLV3D aux3d4

    • aux3b1

      protected static TLV3B aux3b1

    • aux3b2

      protected static TLV3B aux3b2

    • aux3b3

      protected static TLV3B aux3b3

    • aux3b4

      protected static TLV3B aux3b4

    • aux3f1

      protected static TLV3 aux3f1

    • aux3f2

      protected static TLV3 aux3f2

    • aux3f3

      protected static TLV3 aux3f3

    • aux3f4

      protected static TLV3 aux3f4

    • sg

      public static ISceneGraph sg
      Reference to scene graph

    • id

      public long id
      The internal identifier

    • parent

      public SceneGraphNode parent
      The parent entity.

    • children

      public com.badlogic.gdx.utils.Array<SceneGraphNode> children
      List of children entities.

    • translation

      public Vector3b translation
      Cumulative translation object. In contrast with the position, which contains the position relative to the parent, this contains the absolute position in the internal reference system.

    • localTransform

      public com.badlogic.gdx.math.Matrix4 localTransform
      Local transform matrix. Contains the transform matrix and the transformations that will be applied to this object and not to its children.

    • orientation

      public Matrix4d orientation
      This transform stores only the orientation of the object. For example in planets, it stores their orientation with respect to their equatorial plane, but not other transformations applied to the object such as the size or the rotation angle at the time.

    • names

      public java.lang.String[] names
      The name(s) of the node, if any.

    • namekey

      protected java.lang.String namekey
      The key to the name in the i18n system.

    • parentName

      public java.lang.String parentName
      The first name of the parent object.

    • parentkey

      protected java.lang.String parentkey
      The key of the parent

    • numChildren

      public int numChildren
      The total number of descendants under this node.

    • computed

      public boolean computed
      Flag indicating whether the object has been computed in this step.

    • visible

      protected boolean visible
      Is this node visible?

    • lastStateChangeTimeMs

      protected long lastStateChangeTimeMs
      Time of last visibility change in milliseconds

    • opacity

      public float opacity
      The ownOpacity value (alpha)

    • ct

      public ComponentTypes ct
      Component types, for managing visibility

    • pos

      public Vector3b pos
      Position of this entity in the local reference system. The units are Constants.U_TO_KM by default.

    • coordinates

      protected IBodyCoordinates coordinates
      Coordinates provider. Helps updating the position at each time step.

    • posSph

      public Vector2d posSph
      Position in the equatorial system; ra, dec.

    • size

      public float size
      Size factor in internal units.

    • distToCamera

      public double distToCamera
      The distance to the camera from the focus center.

    • viewAngle

      public double viewAngle
      The view angle, in radians.

    • viewAngleApparent

      public double viewAngleApparent
      The view angle corrected with the field of view angle, in radians.

    • cc

      public float[] cc
      Base RGB color

    • copy

      public boolean copy
      Is this just a copy?

    • octantId

      public java.lang.Long octantId
      The id of the octant it belongs to, if any

    • octant

      public OctreeNode octant
      Its page

  • Constructor Details

    • SceneGraphNode

      public SceneGraphNode()

    • SceneGraphNode

      public SceneGraphNode​(int id)

    • SceneGraphNode

      public SceneGraphNode​(ComponentTypes.ComponentType ct)

    • SceneGraphNode

      public SceneGraphNode​(java.lang.String[] names, SceneGraphNode parent)

    • SceneGraphNode

      public SceneGraphNode​(java.lang.String name, SceneGraphNode parent)

    • SceneGraphNode

      public SceneGraphNode​(java.lang.String name)

    • SceneGraphNode

      public SceneGraphNode​(SceneGraphNode parent)

  • Method Details

    • insert

      public static boolean insert​(SceneGraphNode node, boolean addToIndex)
      Inserts the given node into the default scene graph, if it exists.
      Parameters:
      node - The node to insert
      addToIndex - Whether to add to the index
      Returns:
      True if it was inserted, false otherwise

    • add

      public final void add​(SceneGraphNode... children)
      Adds the given SceneGraphNode list as children to this node.
      Parameters:
      children -

    • addChild

      public final void addChild​(SceneGraphNode child, boolean updateAncestorCount)
      Adds a child to the given node and updates the number of children in this node and in all ancestors.
      Parameters:
      child - The child node to add.
      updateAncestorCount - Whether to update the ancestors number of children.

    • removeChild

      public final void removeChild​(SceneGraphNode child, boolean updateAncestorCount)
      Removes the given child from this node, if it exists.
      Parameters:
      child -
      updateAncestorCount -

    • addChild

      public final void addChild​(SceneGraphNode child, boolean updateAncestorCount, int numChildren)
      Adds a child to the given node and updates the number of children in this node and in all ancestors.
      Parameters:
      child - The child node to add.
      updateAncestorCount - Whether to update the ancestors number of children.
      numChildren - The number of children this will hold.

    • add

      public void add​(java.util.List<? extends SceneGraphNode> children)
      Adds the given list of children as child nodes.
      Parameters:
      children -

    • insert

      public final void insert​(java.util.List<? extends SceneGraphNode> nodes)
      Inserts the list of nodes under the parents that match each node's name.
      Parameters:
      nodes -

    • getChildByNameAndType

      public SceneGraphNode getChildByNameAndType​(java.lang.String name, java.lang.Class<? extends SceneGraphNode> clazz)

    • getChildByName

      public SceneGraphNode getChildByName​(java.lang.String name)

    • getChildrenByType

      public com.badlogic.gdx.utils.Array<SceneGraphNode> getChildrenByType​(java.lang.Class<? extends SceneGraphNode> clazz, com.badlogic.gdx.utils.Array<SceneGraphNode> list)

    • getChildrenByComponentType

      public com.badlogic.gdx.utils.Array<SceneGraphNode> getChildrenByComponentType​(ComponentTypes.ComponentType ct, com.badlogic.gdx.utils.Array<SceneGraphNode> list)

    • getNode

      public SceneGraphNode getNode​(java.lang.String name)

    • getNode

      public SceneGraphNode getNode​(int id)

    • update

      public void update​(ITimeFrameProvider time, Vector3b parentTransform, ICamera camera)

    • update

      public void update​(ITimeFrameProvider time, Vector3b parentTransform, ICamera camera, float opacity)

    • updateLocal

      public void updateLocal​(ITimeFrameProvider time, ICamera camera)
      Updates the transform matrix with the transformations that will apply to the children and the local transform matrix with the transformations that will apply only to this object.
      Parameters:
      time -

    • addToRenderLists

      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.

    • updateLocalValues

      public void updateLocalValues​(ITimeFrameProvider time, ICamera camera)
      This function updates all the local values before the localTransform is updated. Position, rotations and scale must be updated in here.
      Parameters:
      time -
      camera -

    • initialize

      public void initialize()

    • doneLoading

      public void doneLoading​(com.badlogic.gdx.assets.AssetManager manager)

    • getPos

      public Vector3b getPos()

    • isCopy

      public boolean isCopy()

    • getPosition

      public Vector3d getPosition​(Vector3d aux)
      Returns the position of this entity in the internal reference system.
      Parameters:
      aux - The vector where the result will be put
      Returns:
      The aux vector with the position

    • setNames

      public void setNames​(java.lang.String... names)

    • setName

      public void setName​(java.lang.String name)
      Specified by:
      setName in interface IVisibilitySwitch

    • getDescription

      public java.lang.String getDescription()
      Specified by:
      getDescription in interface IVisibilitySwitch

    • setDescription

      public void setDescription​(java.lang.String description)
      Specified by:
      setDescription in interface IVisibilitySwitch

    • addName

      public void addName​(java.lang.String name)
      Adds a name to the list of names
      Parameters:
      name - The name

    • getNames

      public java.lang.String[] getNames()

    • getName

      public java.lang.String getName()
      Specified by:
      getName in interface IVisibilitySwitch

    • namesConcat

      public java.lang.String namesConcat()

    • hasName

      public boolean hasName​(java.lang.String candidate)

    • hasName

      public boolean hasName​(java.lang.String candidate, boolean matchCase)

    • setNamekey

      public void setNamekey​(java.lang.String namekey)

    • updateNames

      public void updateNames()
      Updates the name using the key. This must be called when the language changes.

    • updateNamesRec

      public void updateNamesRec()
      Recursively updates the name using the key. This must be called when the language changes.

    • setId

      public void setId​(java.lang.Long id)

    • getId

      public long getId()

    • setParent

      public void setParent​(java.lang.String parentName)

    • setParentkey

      public void setParentkey​(java.lang.String parentkey)

    • dispose

      public void dispose()
      Specified by:
      dispose in interface com.badlogic.gdx.utils.Disposable

    • addFocusableObjects

      public void addFocusableObjects​(com.badlogic.gdx.utils.Array<IFocus> list)
      Adds all the children that are focusable objects to the list.
      Parameters:
      list -

    • addNodes

      public void addNodes​(com.badlogic.gdx.utils.Array<SceneGraphNode> nodes)

    • setUp

      public void setUp()

    • setCt

      public void setCt​(java.lang.String ct)

    • setCt

      public void setCt​(java.lang.String[] cts)

    • getCt

      public ComponentTypes getCt()

    • getComponentType

      public ComponentTypes getComponentType()

    • hasCt

      public boolean hasCt​(ComponentTypes.ComponentType ct)
      Specified by:
      hasCt in interface IVisibilitySwitch

    • getAggregatedChildren

      public int getAggregatedChildren()
      Gets the number of nodes contained in this node, including itself
      Returns:
      The number of children of this node and its descendents

    • getLineCopy

      public <T extends SceneGraphNode> T getLineCopy()

    • getSimpleCopy

      public <T extends SceneGraphNode> T getSimpleCopy()
      Gets a copy of this object but does not copy its parent or children
      Returns:
      The copied object

    • getRoot

      public SceneGraphNode getRoot()

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object

    • returnToPool

      public void returnToPool()

    • setComputedFlag

      public void setComputedFlag​(com.badlogic.gdx.utils.Array<SceneGraphNode> nodes, boolean computed)
      Sets the computed flag of the list of nodes and their children to the given value.
      Parameters:
      nodes - List of nodes to set the flag to. May be null.
      computed - The computed value.

    • addToRender

      protected boolean addToRender​(IRenderable renderable, SceneGraphRenderer.RenderGroup rg)
      Adds the given renderable to the given render group list
      Parameters:
      renderable - The renderable to add
      rg - The render group that identifies the renderable list
      Returns:
      True if added, false otherwise

    • removeFromRender

      protected boolean removeFromRender​(IRenderable renderable, SceneGraphRenderer.RenderGroup rg)
      Removes the given renderable from the given render group list.
      Parameters:
      renderable - The renderable to remove
      rg - The render group to remove from
      Returns:
      True if removed, false otherwise

    • isInRender

      protected boolean isInRender​(IRenderable renderable, SceneGraphRenderer.RenderGroup rg)

    • isInRender

      protected boolean isInRender​(IRenderable renderable, SceneGraphRenderer.RenderGroup... rgs)

    • getFirstStarAncestor

      public SceneGraphNode getFirstStarAncestor()
      Gets the first ancestor of this node that is of type Star
      Returns:
      The first ancestor of type Star

    • getStarCount

      public int getStarCount()
      Specified by:
      getStarCount in interface IStarContainer

    • getVelocity

      public Vector3d getVelocity()
      Specified by:
      getVelocity in interface IPosition

    • getOrientation

      public Matrix4d getOrientation()

    • isVisibilityOn

      public boolean isVisibilityOn()

    • getOpacity

      public float getOpacity()

    • getSceneGraphDepth

      public int getSceneGraphDepth()

    • addToIndex

      protected void addToIndex​(com.badlogic.gdx.utils.ObjectMap<java.lang.String,​SceneGraphNode> map)
      Special actions to be taken for this object when adding to the index.
      Parameters:
      map - The index

    • removeFromIndex

      protected void removeFromIndex​(com.badlogic.gdx.utils.ObjectMap<java.lang.String,​SceneGraphNode> map)
      Special actions to be taken for this object when removing from the index. Must implement if addToIndex is implemented
      Parameters:
      map - The index

    • mustAddToIndex

      public boolean mustAddToIndex()
      Whether to add this node to the index
      Returns:
      True if the node needs to be added to the index.

    • isValidPosition

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

    • getNext

      public IFocus getNext​(ITimeFrameProvider time, ICamera camera, boolean force)
      Gets a copy of this entity which mimics its state in the next time step with position, orientation, etc.
      Returns:
      A copy of this entity in the next time step

    • getPredictedPosition

      public Vector3b getPredictedPosition​(Vector3b aux, ITimeFrameProvider time, ICamera camera, boolean force)
      Gets the position of this entity in the next time step in the internal reference system using the given time provider and the given camera.
      Parameters:
      aux - The out vector where the result will be stored.
      time - The time frame provider.
      camera - The camera.
      force - Whether to force the computation if time is off.
      Returns:
      The aux vector for chaining.

    • mustUpdatePosition

      protected boolean mustUpdatePosition​(ITimeFrameProvider time)
      Whether position must be recomputed for this entity. By default, only when time is on
      Parameters:
      time - The current time
      Returns:
      True if position should be recomputed for this entity

    • getAbsolutePosition

      public Vector3b getAbsolutePosition​(Vector3b out)
      Returns the absolute position of this entity in the native coordinates (equatorial system) and internal units
      Parameters:
      out - Auxiliary vector to put the result in
      Returns:
      The vector with the position

    • getAbsolutePosition

      public Vector3b getAbsolutePosition​(java.lang.String name, Vector3b aux)

    • getAbsoluteOrientation

      public Matrix4d getAbsoluteOrientation​(Matrix4d aux)

    • getRadius

      public double getRadius()
      Returns the radius in internal units
      Returns:
      The radius of the object, in internal units

    • getHeight

      public double getHeight​(Vector3b camPos)

    • getHeight

      public double getHeight​(Vector3b camPos, boolean useFuturePosition)

    • getHeight

      public double getHeight​(Vector3b camPos, Vector3b nextPos)

    • getHeightScale

      public double getHeightScale()

    • getSize

      public double getSize()
      Returns the size (diameter) of this entity in internal units.
      Returns:
      The size in internal units.

    • setSize

      public void setSize​(java.lang.Double size)
      Sets the absolute size (diameter) of this entity
      Parameters:
      size - The diameter in internal units

    • setSize

      public void setSize​(java.lang.Long size)
      Sets the absolute size (diameter) of this entity
      Parameters:
      size - The diameter in internal units

    • getPosSph

      public Vector2d getPosSph()

    • getAlpha

      public double getAlpha()

    • getDelta

      public double getDelta()

    • setColor

      public void setColor​(double[] color)

    • setColor

      public void setColor​(float[] color)

    • getOctant

      public OctreeNode getOctant()

    • computeFuturePosition

      public Vector3d computeFuturePosition()

    • getDistToCamera

      public double getDistToCamera()
      Returns the current distance to the camera in internal units.
      Returns:
      The current distance to the camera, in internal units.

    • getViewAngle

      public double getViewAngle()
      Returns the current view angle of this entity, in radians.
      Returns:
      The view angle in radians.

    • getViewAngleApparent

      public double getViewAngleApparent()
      Returns the current apparent view angle (view angle corrected with the field of view) of this entity, in radians.
      Returns:
      The apparent view angle in radians.

    • render2DLabel

      protected void render2DLabel​(ExtSpriteBatch batch, ExtShaderProgram shader, RenderingContext rc, BitmapFont font, ICamera camera, java.lang.String label, Vector3d pos3d)

    • render2DLabel

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

    • render2DLabel

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

    • render2DLabel

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

    • render3DLabel

      protected void render3DLabel​(ExtSpriteBatch batch, ExtShaderProgram shader, BitmapFont font, ICamera camera, RenderingContext rc, java.lang.String label, Vector3d pos, double distToCamera, float scale, double size)

    • render3DLabel

      protected void render3DLabel​(ExtSpriteBatch batch, ExtShaderProgram shader, BitmapFont font, ICamera camera, RenderingContext rc, java.lang.String label, Vector3d pos, double distToCamera, float scale, double size, float minSizeDegrees, float maxSizeDegrees)

    • setCoordinates

      public void setCoordinates​(IBodyCoordinates coord)

    • getPosition

      public Vector3b getPosition()
      Specified by:
      getPosition in interface IPosition

    • getUnrotatedPos

      public Vector3d getUnrotatedPos()

    • setLabelcolor

      public void setLabelcolor​(float[] labelColor)

    • setLabelcolor

      public void setLabelcolor​(double[] labelColor)

    • setVisible

      public void setVisible​(boolean visible)
      Specified by:
      setVisible in interface IVisibilitySwitch

    • isVisible

      public boolean isVisible()
      Specified by:
      isVisible in interface IVisibilitySwitch

    • isVisible

      public boolean isVisible​(boolean attributeValue)
      Specified by:
      isVisible in interface IVisibilitySwitch

    • isVisibleGroup

      public boolean isVisibleGroup()

    • setVisibleGroup

      public void setVisibleGroup​(boolean visibility)

    • msSinceStateChange

      protected long msSinceStateChange()

    • getVisibilityOpacityFactor

      protected float getVisibilityOpacityFactor()

    • shouldRender

      protected boolean shouldRender()

    • getColor

      public float[] getColor()