RenderableGlobe

Inherits Renderable

Members

Name	Documentation	Type	Description	Optional
Layers	A list of layers that should be added to the globe.	Table	Table parameters	No
Labels	Specifies information about planetary labels that can be rendered on the object’s surface.	Table	GlobeLabelsComponent	Yes
LightSourceNode	The identifier of a scene graph node that should be used as the source of illumination for the globe. If not specified, the solar system’s Sun is used.	String	Value of type ‘String’	Yes
PerformShading	Specifies whether the planet should be shaded by the primary light source or not. If disabled, all parts of the planet are illuminated. Note that if the globe has a corresponding atmosphere, there is a separate setting to control the shadowing induced by the atmosphere.	Boolean	Value of type ‘Boolean’	Yes
Radii	The radii for this planet. If only one value is given, all three radii are set to that value.	Vector3<double>, or Double	Value of type ‘Vector3’, or Value of type ‘Double’	Yes
RenderAtDistance	Tells the rendering engine not to perform distance based performance culling for this globe. Turning this property on will let the globe to be seen at far away distances when normally it would be hidden.	Boolean	Value of type ‘Boolean’	Yes
Rings	Details about the rings of the globe, if it has any.	Table	RingsComponent	Yes
ShadowGroup	Information about any object that might cause shadows to appear on the globe.	Table	Table parameters	Yes
Shadows		Table	ShadowComponent	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, PostDeferredTransparent, Overlay }	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 Layers

A list of layers that should be added to the globe.

• Optional: No

Name	Documentation	Type	Description	Optional
*		Table	LayerManager	No

Table parameters for ShadowGroup

Information about any object that might cause shadows to appear on the globe.

• Optional: Yes

Name	Documentation	Type	Description	Optional
Casters	A list of potential shadow casters.	Table	Table parameters	No
Sources	A list of objects (light sources) that may cause shadows from the provided list of shadow casting objects.	Table	Table parameters	No

Table parameters for Casters

A list of potential shadow casters.

• Optional: No

Name	Documentation	Type	Description	Optional
*		Table	Table parameters	Yes

Table parameters for *

• Optional: Yes

Name	Documentation	Type	Description	Optional
Name		String	Value of type ‘String’	No
Radius		Double	Value of type ‘Double’	No

Table parameters for Sources

A list of objects (light sources) that may cause shadows from the provided list of shadow casting objects.

• Optional: No

Name	Documentation	Type	Description	Optional
*		Table	Table parameters	Yes

Table parameters for *

• Optional: Yes

Name	Documentation	Type	Description	Optional
Name		String	Value of type ‘String’	No
Radius		Double	Value of type ‘Double’	No

Asset Examples

-- Basic
-- This asset creates a rotation that places a coordinate axes on the surface of a
-- planetary body. The rotation causes the coordinate axes to remain fixed to the surface
-- of the globe.
--
-- In order for this feature to work properly, the coordinate axes need to be located at
-- the same place as well, so this example also needs a `GlobeTranslation` applied.

-- The example needs a `RenderableGlobe` as a parent to function
local Globe = {
  Identifier = "GlobeRotation_Example_Globe",
  Renderable = {
    Type = "RenderableGlobe"
  },
  GUI = {
    Name = "GlobeRotation - Basic (Globe)",
    Path = "/Examples"
  }
}

local Node = {
  Identifier = "GlobeRotation_Example",
  Parent = "GlobeRotation_Example_Globe",
  Transform = {
    Translation = {
      Type = "GlobeTranslation",
      Globe = "GlobeRotation_Example_Globe",
      Latitude = 20.0,
      Longitude = -45.0
    },
    Rotation = {
      Type = "GlobeRotation",
      Globe = "GlobeRotation_Example_Globe",
      Latitude = 20.0,
      Longitude = -45.0
    }
  },
  Renderable = {
    Type = "RenderableCartesianAxes"
  },
  GUI = {
    Name = "GlobeRotation - Basic",
    Path = "/Examples"
  }
}

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

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