GlobeTranslation

Inherits Translation

Places the scene graph node at a specific location relative to another scene graph node. The position is identified via the longitude, latitude, and altitude parameters. If the provided scene graph node is a globe, the positions correspond to the native coordinate frame of that object. If it is a node without a renderable or a non-globe renderable, the latitude/longitude grid used is the node’s interaction sphere.

This class is useful in conjunction with the GlobeRotation rotation to orient a scene graph node away from the center of the body.

If the UseCamera value is set, the object’s position automatically updates based on the current camera location.

Members

Name	Documentation	Type	Description	Optional
Globe	The node on which the longitude/latitude is specified. If the node is a globe, the correct height information for the globe is used. Otherwise, the position is specified based on the longitude and latitude on the node’s interaction sphere	Identifier	An identifier string. May not contain ‘.’, spaces, newlines, or tabs	No
Type	The type of translation that is described in this element. The available types of translations depend on the configuration of the application and can be written to disk on application startup into the FactoryDocumentation.	String	Must name a valid Translation type	No
Altitude	The altitude in meters. If the ‘UseHeightmap’ property is ‘true’, this is an offset from the actual surface of the globe. If not, this is an offset from the reference ellipsoid. The default value is 0.0.	Double	Value of type ‘Double’	Yes
Latitude	The latitude of the location on the globe’s surface. The value can range from -90 to 90, with negative values representing the southern hemisphere of the globe. The default value is 0.0.	Double	In range: ( -90, 90)	Yes
Longitude	The longitude of the location on the globe’s surface. The value can range from -180 to 180, with negative values representing the western hemisphere of the globe. The default value is 0.0.	Double	In range: ( -180, 180)	Yes
TimeFrame	The time frame in which this Translation is applied. If the in-game time is outside this range, no translation will be applied.	Table	TimeFrame	Yes
UseCamera	If this value is ‘true’, the lat and lon are updated to match the camera.	Boolean	Value of type ‘Boolean’	Yes
UseCameraAltitude	If this value is ‘true’, the altitude is updated to match the camera.	Boolean	Value of type ‘Boolean’	Yes
UseHeightmap	If this value is ‘true’, the altitude specified in ‘Altitude’ will be treated as an offset from the heightmap. Otherwise, it will be an offset from the globe’s reference ellipsoid. The default value is ‘false’.	Boolean	Value of type ‘Boolean’	Yes

Inherited members from Translation

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

Asset Examples

Fixed Height

This asset creates a translation that places coordinate axes on the surface of a planetary body with a fixed height to the reference surface of the globe. Note that this examples only the position of the coordinate axes, but leaves the orientation unchanged, causing their rotation to be inherited from the parent node.

-- The example needs a `RenderableGlobe` with a height map as a parent to function
local Globe = {
  Identifier = "GlobeTranslation_Example_FixedHeight_Globe",
  Renderable = {
    Type = "RenderableGlobe"
  },
  GUI = {
    Name = "GlobeTranslation - Fixed Height (Globe)",
    Path = "/Examples"
  }
}

local Node = {
  Identifier = "GlobeTranslation_Example_FixedHeight",
  Parent = "GlobeTranslation_Example_FixedHeight_Globe",
  Transform = {
    Translation = {
      Type = "GlobeTranslation",
      Globe = "GlobeTranslation_Example_FixedHeight_Globe",
      Latitude = 20.0,
      Longitude = -45.0,
      Altitude = 2.0
    }
  },
  Renderable = {
    Type = "RenderableCartesianAxes"
  },
  GUI = {
    Name = "GlobeTranslation - Fixed Height",
    Path = "/Examples"
  }
}


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

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

Adaptive Height

This asset creates a translation that places coordinate axes on the surface of a planetary body while adjusting to the existing height map on the globe. Note that this examples only the position of the coordinate axes, but leaves the orientation unchanged, causing their rotation to be inherited from the parent node.

-- The example needs a `RenderableGlobe` with a height map as a parent to function
local layer = asset.require("scene/solarsystem/planets/earth/layers/heightlayers/blue_marble_height")
local Globe = {
  Identifier = "GlobeTranslation_Example_AdaptiveHeight_Globe",
  Renderable = {
    Type = "RenderableGlobe",
    Layers = {
      HeightLayers = { layer.layer }
    }
  },
  GUI = {
    Name = "GlobeTranslation - Adaptive Height (Globe)",
    Path = "/Examples"
  }
}

local Node = {
  Identifier = "GlobeTranslation_Example_AdaptiveHeight",
  Parent = "GlobeTranslation_Example_AdaptiveHeight_Globe",
  Transform = {
    Translation = {
      Type = "GlobeTranslation",
      Globe = "GlobeTranslation_Example_AdaptiveHeight_Globe",
      Latitude = 20.0,
      Longitude = -45.0,
      UseHeightmap = true
    }
  },
  Renderable = {
    Type = "RenderableCartesianAxes"
  },
  GUI = {
    Name = "GlobeTranslation - Adaptive Height",
    Path = "/Examples"
  }
}


asset.onInitialize(function()
  openspace.addSceneGraphNode(Globe)
  -- The layer is designed for a globe with Earth scale. So we need to scale it down for
  -- it to make sense for this example
  openspace.setPropertyValueSingle("Scene.GlobeTranslation_Example_AdaptiveHeight_Globe.Renderable.Layers.HeightLayers.Earth_Bluemarble_Height.Enabled", true)
  enspace.setPropertyValueSingle("Scene.GlobeTranslation_Example_AdaptiveHeight_Globe.Renderable.Layers.HeightLayers.Earth_Bluemarble_Height.Settings.Multiplier", 1.9)
  openspace.setPropertyValueSingle("Scene.GlobeTranslation_Example_AdaptiveHeight_Globe.Renderable.Layers.HeightLayers.Earth_Bluemarble_Height.Settings.Gamma", 0.16)

  openspace.addSceneGraphNode(Node)
end)

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

Basic

This asset creates a translation that places coordinate axes on the surface of a planetary body. Note that this examples only the position of the coordinate axes, but leaves the orientation unchanged, causing their rotation to be inherited from the parent node.

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

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


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

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