Package gaiasky.scene.api

Interface IFocus

All Known Subinterfaces:
IStarFocus
All Known Implementing Classes:
FocusView, Proximity.NearbyRecord
public interface IFocus
Contract that all focus objects must implement.

  • Method Details

    • isEmpty

      boolean isEmpty()
      Whether this focus object actually contains a focus.
      Returns:
      True if the focus is not set, false otherwise.

    • isValid

      boolean isValid()

    • getId

      long getId()
      Returns the unique id of this focus.
      Returns:
      The id.

    • getCandidateId

      long getCandidateId()
      Returns the id of the focus candidate of this object. Defaults to getId().
      Returns:
      The id of the candidate.

    • getLocalizedName

      String getLocalizedName()
      Returns the localized name of this focus. If it has no localized name, it returns the default name.
      Returns:
      The localized name.

    • getName

      String getName()
      Returns the first name of this focus.
      Returns:
      The first name.

    • getNames

      String[] getNames()
      Returns all names of this focus.
      Returns:
      All names of this focus.

    • hasName

      boolean hasName(String name)
      Checks whether the focus has the given name.
      Parameters:
      name - The name.
      Returns:
      True if there is a match.

    • hasName

      boolean hasName(String name, boolean matchCase)
      Checks whether the focus has the given name.
      Parameters:
      name - The name.
      matchCase - Whether to match the case when comparing.
      Returns:
      True if there is a match.

    • getClosestName

      String getClosestName()
      Same as getName().
      Returns:
      The name.

    • getCandidateName

      String getCandidateName()
      Returns the name of the focus candidate of this object. Defaults to getName().
      Returns:
      The name of the candidate.

    • getCt

      ComponentTypes getCt()
      Returns the component types of this focus.
      Returns:
      The component types.

    • isFocusActive

      boolean isFocusActive()
      Returns whether this focus object is active or not. The active status determines whether the object can be focussed or not.
      Returns:
      The active status.

    • getPos

      Vector3b getPos()
      Returns the position.
      Returns:
      The position.

    • getFirstStarAncestorEntity

      com.badlogic.ashley.core.Entity getFirstStarAncestorEntity()
      Gets the first ancestor of this node that is a star.
      Returns:
      The first star ancestor.

    • getFirstStarAncestor

      IFocus getFirstStarAncestor()

    • getAbsolutePosition

      Vector3b getAbsolutePosition(Vector3b out)
      Returns the absolute position of this entity in the native coordinates (equatorial system).
      Parameters:
      out - The out vector.
      Returns:
      The absolute position, same as aux.

    • getAbsolutePosition

      Vector3b getAbsolutePosition(String name, Vector3b out)
      Returns the absolute position of the entity identified by name within this entity in the native reference system.
      Parameters:
      name - The name (lowercase) of the entity to get the position from (useful in case of star groups).
      out - Vector3d to put the return value.
      Returns:
      The absolute position of the entity if it exists, null otherwise.

    • getClosestAbsolutePos

      Vector3b getClosestAbsolutePos(Vector3b out)
      Same as getAbsolutePosition(Vector3b).
      Parameters:
      out - Vector3d where to put the return value.
      Returns:
      The absolute position, same as aux.

    • getPosSph

      Vector2d getPosSph()
      Gets the position in equatorial spherical coordinates.
      Returns:
      The position in alpha, delta.

    • getPredictedPosition

      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.

    • getDistToCamera

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

    • getClosestDistToCamera

      double getClosestDistToCamera()
      Same as getDistToCamera().
      Returns:
      The distance to the camera in internal units.

    • getSolidAngle

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

    • getSolidAngleApparent

      double getSolidAngleApparent()
      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.

    • getCandidateSolidAngleApparent

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

    • getAlpha

      double getAlpha()
      Returns the right ascension angle of this focus object.
      Returns:
      The right ascension angle in degrees.

    • getDelta

      double getDelta()
      Returns the declination angle of this focus object.
      Returns:
      The declination angle in degrees.

    • getSize

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

    • getRadius

      double getRadius()
      Returns the radius of this focus object in internal units.
      Returns:
      The radius of the focus, in internal units.

    • getHeight

      double getHeight(Vector3b camPos)
      Returns the height of the projected position of the current camera on this focus object, which is usually the radius plus a value lookup in the height texture (if exists).
      Parameters:
      camPos - The camera position.
      Returns:
      The height of the projected position of the current camera.

    • getHeight

      double getHeight(Vector3b camPos, boolean useFuturePosition)
      Same as getHeight(Vector3b) but with the option to use the future position of the body instead of the current one.
      Parameters:
      camPos - The camera position.
      useFuturePosition - Whether to use the future position or the current one.
      Returns:
      The height of the projected position of the current camera on the surface.

    • getHeight

      double getHeight(Vector3b camPos, Vector3b nextPos)
      Same as getHeight(Vector3b) but with the option to use the given future position of the body instead of the current one.
      Parameters:
      camPos - The camera position.
      nextPos - The future position of this body to use.
      Returns:
      The height of the projected position of the current camera on the surface.

    • getHeightScale

      double getHeightScale()
      Returns the height scale of this focus, or 0 if it has no height info.
      Returns:
      The height scale in internal units.

    • getAppmag

      float getAppmag()
      Gets the apparent magnitude.
      Returns:
      The apparent magnitude.

    • getAbsmag

      float getAbsmag()
      Gets the absolute magnitude.
      Returns:
      The absolute magnitude.

    • getOrientation

      Matrix4d getOrientation()
      Returns the orientation matrix of this focus.
      Returns:
      The orientation matrix. Can be null.

    • getRotationComponent

      RotationComponent getRotationComponent()
      Returns the rotation component of this focus.
      Returns:
      The rotation component. Can be null.

    • getOrientationQuaternion

      Quaterniond getOrientationQuaternion()
      Returns the orientation quaternion of this focus.
      Returns:
      The orientation quaternion. Can be null.

    • addHitCoordinate

      void addHitCoordinate(int screenX, int screenY, int w, int h, int pixelDist, 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.
      Parameters:
      screenX - The x position of the hit.
      screenY - The y position of the hit.
      w - The viewport width.
      h - The viewport height.
      pixelDist - The minimum pixel distance to consider as hit.
      camera - The camera.
      hits - The list where to add the element.

    • addEntityHitCoordinate

      void addEntityHitCoordinate(int screenX, int screenY, int w, int h, int pixelDist, NaturalCamera camera, com.badlogic.gdx.utils.Array<com.badlogic.ashley.core.Entity> hits)

    • addHitRay

      void addHitRay(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.
      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.

    • addEntityHitRay

      void addEntityHitRay(Vector3d p0, Vector3d p1, NaturalCamera camera, com.badlogic.gdx.utils.Array<com.badlogic.ashley.core.Entity> hits)

    • makeFocus

      void makeFocus()
      Hook that runs when the candidate is actually made focus.

    • getFocus

      IFocus getFocus(String name)
      Prepares the candidate with the given name.
      Parameters:
      name - The name in lower case.

    • isCoordinatesTimeOverflow

      boolean isCoordinatesTimeOverflow()
      Checks whether this foucs is within its valid time range, so that it can be used as a focus.
      Returns:
      Whether the focus object is within its valid time range.

    • getSceneGraphDepth

      int getSceneGraphDepth()
      Gets the depth of this focus object in the scene graph.
      Returns:
      The depth of the scene graph.

    • getOctant

      OctreeNode getOctant()
      Gets the octant this focus belongs to, if any. This will return null if this focus is not part of an octree.
      Returns:
      The octant this focus belongs to. Null if it is not part of an octree.

    • isCopy

      boolean isCopy()
      Whether this is a copy or not.
      Returns:
      Whether the object is a copy or not.

    • getColor

      float[] getColor()
      Gets the color of this object.
      Returns:
      The color as an RGBA float array.

    • isForceLabel

      boolean isForceLabel()

    • isForceLabel

      boolean isForceLabel(String name)