RenderablePlanetProjection

Inherits Renderable

Serves as a potential target for images projected from a spacecraft’s instrument, when the observed object is a planetary body. The images first have to be loaded into an image sequence and when it is then time to project an image onto the world from the point of view of the instrument, the field-of-view will be checked against the extent of this planetary body. If the field-of-view intersects, the image gets correctly projected onto the surface.

Members

Name	Documentation	Type	Description	Optional
ColorTexturePaths	The texture path selected in this property is used as the base texture that is applied to the planet prior to any image projections. This menu always contains an empty option for not using a color map. If this value is specified in an asset, the last texture is used.	Table	Table parameters	No
HeightTexturePaths	The texture path selected in this property is used as the height map on the planet. This menu always contains an empty option for not using a heightmap. If this value is specified in an asset, the last texture is used.	Table	Table parameters	No
Projection	Contains information about projecting onto this planet.	Table	ProjectionComponent	No
Radius	This value specifies the radius of this sphere in meters.	Double, or Vector3<double>	Value of type ‘Double’, or Value of type ‘Vector3’	No
Segments	This value specifies the number of segments that this sphere is split into.	Integer	Value of type ‘Integer’	No
AmbientBrightness	This value determines the ambient brightness of the dark side of the planet.	Double	Value of type ‘Double’	Yes
DimInAtmosphere	Decides if the object should be dimmed (i.e. faded out) when the camera is in the sunny part of an atmosphere.	Boolean	Value of type ‘Boolean’	Yes
Enabled	Determines whether this object will be visible or not.	Boolean	Value of type ‘Boolean’	Yes
HeightExaggeration	This value determines the level of height exaggeration that is applied to a potential height field. A value of ‘0’ inhibits the height field, whereas a value of ‘1’ uses the measured height field.	Double	Value of type ‘Double’	Yes
MaxProjectionsPerFrame	The maximum number of image projections to perform per frame. Useful to avoid freezing the system for large delta times.	Integer	Value of type ‘Integer’	Yes
MeridianShift	If this value is enabled, a shift of the meridian by 180 degrees is performed. This is a fix especially for Pluto height maps, where the definition of the meridian has changed through the New Horizons mission and this requires this shift.	Boolean	Value of type ‘Boolean’	Yes
Opacity	This value determines the opacity of this renderable. A value of 0 means completely transparent.	Double	In range: ( 0, 1)	Yes
RenderBinMode	A value that specifies if the renderable should be rendered in the Background, Opaque, Pre-/PostDeferredTransparency, Overlay, or Sticker rendering step.	String	In list { Background, Opaque, PreDeferredTransparent, Overlay, PostDeferredTransparent, Sticker }	Yes
Tag	A single tag or a list of tags that this renderable will respond to when setting properties.	Table, or String	Value of type ‘Table’, or Value of type ‘String’	Yes
Type	The type of the renderable.	String	Value of type ‘String’	Yes

Inherited members from Renderable

Name	Documentation	Type	Description	Optional
DimInAtmosphere	Decides if the object should be dimmed (i.e. faded out) when the camera is in the sunny part of an atmosphere.	Boolean	Value of type ‘Boolean’	Yes
Enabled	Determines whether this object will be visible or not.	Boolean	Value of type ‘Boolean’	Yes
Opacity	This value determines the opacity of this renderable. A value of 0 means completely transparent.	Double	In range: ( 0, 1)	Yes
RenderBinMode	A value that specifies if the renderable should be rendered in the Background, Opaque, Pre-/PostDeferredTransparency, Overlay, or Sticker rendering step.	String	In list { Background, Opaque, PreDeferredTransparent, Overlay, PostDeferredTransparent, Sticker }	Yes
Tag	A single tag or a list of tags that this renderable will respond to when setting properties.	Table, or String	Value of type ‘Table’, or Value of type ‘String’	Yes
Type	The type of the renderable.	String	Value of type ‘String’	Yes

Table parameters for ColorTexturePaths

The texture path selected in this property is used as the base texture that is applied to the planet prior to any image projections. This menu always contains an empty option for not using a color map. If this value is specified in an asset, the last texture is used.

• Optional: No

Name	Documentation	Type	Description	Optional
*		String	Value of type ‘String’	Yes

Table parameters for HeightTexturePaths

The texture path selected in this property is used as the height map on the planet. This menu always contains an empty option for not using a heightmap. If this value is specified in an asset, the last texture is used.

• Optional: No

Name	Documentation	Type	Description	Optional
*		String	Value of type ‘String’	Yes

Asset Examples

local transforms = asset.require("./transforms")
local kernels = asset.require("./kernels")
local coreKernels = asset.require("spice/core")



local textures = asset.resource({
  Name = "Charon Textures",
  Type = "HttpSynchronization",
  Identifier = "charon_textures",
  Version = 3
})


local CharonRadius = 603500

local CharonProjection = {
  Identifier = "CharonProjection",
  Parent = transforms.PlutoBarycenterAccurate.Identifier,
  Transform = {
    Translation = {
      Type = "SpiceTranslation",
      Target = kernels.ID.Charon,
      Observer = kernels.ID.PlutoBarycenter
    },
    Rotation = {
      Type = "SpiceRotation",
      SourceFrame = kernels.Frame.Charon,
      DestinationFrame = coreKernels.Frame.Galactic
    }
  },
  Renderable = {
    Type = "RenderablePlanetProjection",
    Radius = CharonRadius,
    Segments = 350,
    ColorTexturePaths = {
      textures .. "NH_Charon_mosaic.png",
      textures .. "NH_Charon_mosaic_8192.png"
    },
    HeightTexturePaths = {
      textures .. "NH_Charon_DTM.png",
      textures .. "NH_Charon_DTM_8192.png"
    },
    MeridianShift = true,
    Projection = {
      Observer = kernels.ID.NewHorizons,
      Target = kernels.ID.Charon,
      Aberration = "NONE",
      AspectRatio = 2,
      Instrument = {
        Name = kernels.Frame.Lorri,
        Method = "ELLIPSOID",
        Aberration = "NONE",
        Fovy = 0.2907,
        Aspect = 1,
        Near = 0.2,
        Far = 10000
      },
      PotentialTargets = {
        kernels.ID.Pluto,
        kernels.ID.Charon
      }
    }
  },
  GUI = {
    Path = "/Solar System/Dwarf Planets/Pluto",
    Name = "Charon Projection"
  }
}

local CharonText = {
  Identifier = "CharonText",
  Parent = CharonProjection.Identifier,
  Transform = {
    Translation = {
      Type = "StaticTranslation",
      Position = { 0, -1000000.0, 0 }
    }
  },
  Renderable = {
    Type = "RenderablePlaneImageLocal",
    Size = 19952623.15,
    Origin = "Center",
    Billboard = true,
    Texture = textures .. "Charon-Text.png",
    BlendMode = "Additive"
  },
  GUI = {
    Name = "Charon Text",
    Path = "/Solar System/Dwarf Planets/Pluto",
    Focusable = false
  }
}

local CharonShadow = {
  Identifier = "CharonShadow",
  Parent = CharonProjection.Identifier,
  Renderable = {
    Type = "RenderableShadowCylinder",
    Opacity = 0.25,
    TerminatorType = "PENUMBRAL",
    LightSource = coreKernels.ID.Sun,
    Observer = kernels.ID.NewHorizons,
    Body = kernels.ID.Charon,
    BodyFrame = kernels.Frame.Charon,
    Aberration = "NONE"
  },
  GUI = {
    Name = "Charon Shadow",
    Path = "/Solar System/Dwarf Planets/Pluto",
    Focusable = false
  }
}


asset.onInitialize(function()
  openspace.addSceneGraphNode(CharonProjection)
  openspace.addSceneGraphNode(CharonText)
  openspace.addSceneGraphNode(CharonShadow)
end)

asset.onDeinitialize(function()
  openspace.removeSceneGraphNode(CharonShadow)
  openspace.removeSceneGraphNode(CharonText)
  openspace.removeSceneGraphNode(CharonProjection)
end)

asset.export(CharonProjection)
asset.export(CharonText)
asset.export(CharonShadow)