SpiceRotation

Inherits Rotation

This Rotation type uses SPICE kernels to provide rotation information for the attached scene graph node. SPICE is a library used by scientists and engineers to, among other tasks, plan space missions. If you are unfamiliar with SPICE, their webpage has both extensive Tutorials as well as Lessions that explain the system deeper. This class provides access to the pxform_c function of the Spice library.

Members

Name	Documentation	Type	Description	Optional
SourceFrame	This value specifies the source frame that is used as the basis for the coordinate transformation. This has to be a valid SPICE name.	String	A valid SPICE NAIF name or integer	No
DestinationFrame	This value specifies the destination frame that is used for the coordinate transformation. This has to be a valid SPICE name. If this value is not specified, a reference frame of ‘GALACTIC’ is used instead	String	Value of type ‘String’	Yes
FixedDate	A time to lock the rotation to. Setting this to an empty string will unlock the time and return to rotation based on current simulation time.	Date and time	Value of type ‘Date and time’	Yes
TimeOffset	A time offset, in seconds, added to the simulation time (or Fixed Date if any), at which to compute the rotation.	Double	Value of type ‘Double’	Yes

Inherited members from Rotation

Name	Documentation	Type	Description	Optional
Type	The type of the rotation that is described in this element. The available types of rotations depend on the configuration of the application and can be written to disk on application startup into the FactoryDocumentation	String	Must name a valid Rotation type	No
TimeFrame	The time frame in which this Rotation is applied. If the in-game time is outside this range, no rotation will be applied.	Table	TimeFrame	Yes

Asset Examples

Basic

This asset creates a rotation provided by a SPICE kernel and applies it to a scene graph node that only displays coordinate axes. The rotation of the coordinate axes are determined by SPICE, in this case pretending that the coordinate axes are rotating at the same rate as Earth. For more information about SPICE see: https://naif.jpl.nasa.gov/naif/

-- Load the default SPICE kernels, which are the planetary constants and the DE430 kernel
asset.require("spice/core")

local Node = {
  Identifier = "SpiceRotation_Example",
  Transform = {
    Rotation = {
      Type = "SpiceRotation",
      SourceFrame = "IAU_EARTH",
      DestinationFrame = "GALACTIC"
    }
  },
  Renderable = {
    Type = "RenderableCartesianAxes"
  },
  GUI = {
    Name = "SpiceRotation - Basic",
    Path = "/Examples"
  }
}

asset.onInitialize(function()
  openspace.addSceneGraphNode(Node)
end)

asset.onDeinitialize(function()
  openspace.removeSceneGraphNode(Node)
end)

Time offset

This asset creates a rotation provided by a SPICE kernel and applies it to a scene graph node that only displays coordinate axes. The rotation of the coordinate axes are determined by SPICE, in this case pretending that the coordinate axes are rotating at the same rate as Earth. In this specific example, the orientation is offset 8h back compared to the actual in-game time in OpenSpace.

-- Load the default SPICE kernels, which is the planetary constants and the DE430 kernel
asset.require("spice/core")

local Node = {
  Identifier = "SpiceRotation_Example_TimeOffset",
  Transform = {
    Rotation = {
      Type = "SpiceRotation",
      SourceFrame = "IAU_EARTH",
      DestinationFrame = "GALACTIC",
      TimeOffset = -8 * 60 * 60
    }
  },
  Renderable = {
    Type = "RenderableCartesianAxes"
  },
  GUI = {
    Name = "SpiceRotation - Time Offset",
    Path = "/Examples"
  }
}

asset.onInitialize(function()
  openspace.addSceneGraphNode(Node)
end)

asset.onDeinitialize(function()
  openspace.removeSceneGraphNode(Node)
end)

TimeFrame

This asset creates a rotation provided by a SPICE kernel and applies it to a scene graph node that only displays coordinate axes. The rotation of the coordinate axes are determined by SPICE, in this case pretending that the coordinate axes are rotating at the same rate as Earth. In this example, the rotation is only calculated between 2000 JAN 01 and 2002 JAN 01 to exemplify a use-case in which the data from the SPICE kernel is not available for the whole duration.

-- Load the default SPICE kernels, which is the planetary constants and the DE430 kernel
asset.require("spice/core")

local Node = {
  Identifier = "SpiceRotation_Example_TimeFrame",
  Transform = {
    Rotation = {
      Type = "SpiceRotation",
      SourceFrame = "IAU_EARTH",
      DestinationFrame = "GALACTIC",
      TimeFrame = {
        Type = "TimeFrameInterval",
        Start = "2000 JAN 01",
        End = "2002 JAN 01"
      }
    }
  },
  Renderable = {
    Type = "RenderableCartesianAxes"
  },
  GUI = {
    Name = "SpiceRotation - TimeFrame",
    Path = "/Examples"
  }
}

asset.onInitialize(function()
  openspace.addSceneGraphNode(Node)
end)

asset.onDeinitialize(function()
  openspace.removeSceneGraphNode(Node)
end)

Fixed Date

This asset creates a rotation provided by a SPICE kernel and applies it to a scene graph node that only displays coordinate axes. The rotation of the coordinate axes are determined by SPICE, in this case pretending that the coordinate axes are rotating at the same rate as Earth. In this specific example, the orientation is independent of the actual in-game time in OpenSpace and only uses a fixed date of 2000 JAN 01 instead.

-- Load the default SPICE kernels, which is the planetary constants and the DE430 kernel
asset.require("spice/core")

local Node = {
  Identifier = "SpiceRotation_Example_FixedDate",
  Transform = {
    Rotation = {
      Type = "SpiceRotation",
      SourceFrame = "IAU_EARTH",
      DestinationFrame = "GALACTIC",
      FixedDate = "2000 JAN 01 00:00:00.000"
    }
  },
  Renderable = {
    Type = "RenderableCartesianAxes"
  },
  GUI = {
    Name = "SpiceRotation - Fixed Date",
    Path = "/Examples"
  }
}

asset.onInitialize(function()
  openspace.addSceneGraphNode(Node)
end)

asset.onDeinitialize(function()
  openspace.removeSceneGraphNode(Node)
end)