RenderableDistanceLabel

Inherits Renderable

This Renderable creates a label that shows the distance between two nodes, based on an existing RenderableNodeLine. The label will be placed halfway between the two scene graph nodes that the line connects.

The unit in which the distance is displayed can be customized, as well as the precision of the number.

Members

Name	Documentation	Type	Description	Optional
NodeLine	The identifier of a scene graph node with a RenderableNodeLine that this label should track. The label text will be updating based on the distance from the node line’s start and end.	String	Value of type ‘String’	No
CustomUnitDescriptor	Property to define a custom unit descriptor to use to describe the distance value. Defaults to the selected unit’s SI descriptor if not specified.	String	Value of type ‘String’	Yes
DistanceUnit	The unit in which the distance value should be displayed. Defaults to ‘km’ if not specified.	String	In list { Nanometer, Micrometer, Millimeter, Centimeter, Decimeter, Meter, Kilometer, AU, Lighthour, Lightday, Lightmonth, Lightyear, Parsec, Kiloparsec, Megaparsec, Gigaparsec, Gigalightyear, Thou, Inch, Foot, Yard, Chain, Furlong, Mile, League, Nautical Mile }	Yes
Precision	The precision in which to to show the distance number, i.e. the number of digits after the decimal point.	Integer	Greater or equal to: 0	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

Asset Examples

Custom Unit Descriptor

In addition to setting the unit, it is also possible to specify a custom unit descriptor, i.e. a text that will de displayed for the unit instead of the default one. Here, we write out “Astronomical Units” instead of using the default descriptor for AU.

local nodelineAsset = asset.require("examples/renderable/renderablenodeline/nodeline")

local Node = {
  Identifier = "RenderableDistanceLabel_Example_CustomDescriptor",
  Renderable = {
    Type = "RenderableDistanceLabel",
    NodeLine = nodelineAsset.NodeLine.Identifier,
    DistanceUnit = "AU",
    Precision = 2,
    CustomUnitDescriptor = "Astronomical Units"
  },
  GUI = {
    Name = "RenderableDistanceLabel - Custom Unit Descriptor",
    Path = "/Examples"
  }
}

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

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

Basic

This example adds a distance label between two nodes in the scene, based on an existing RenderableNodeLine. Note that the identifier of the RenderableNodeLine is accessed by importing another example asset, which also adds the node line to the scene.

local nodelineAsset = asset.require("examples/renderable/renderablenodeline/nodeline")

local Node = {
  Identifier = "RenderableDistanceLabel_Example",
  Renderable = {
    Type = "RenderableDistanceLabel",
    NodeLine = nodelineAsset.NodeLine.Identifier
  },
  GUI = {
    Name = "RenderableDistanceLabel - Basic",
    Path = "/Examples"
  }
}

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

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

Set Unit

Per default, the distance is displayed in meters. This example shows how to specify a specific unit, and how to set the precision of dislayed number.

local nodelineAsset = asset.require("examples/renderable/renderablenodeline/nodeline")

local Node = {
  Identifier = "RenderableDistanceLabel_Example_Unit",
  Renderable = {
    Type = "RenderableDistanceLabel",
    NodeLine = nodelineAsset.NodeLine.Identifier,
    DistanceUnit = "AU",
    Precision = 2
  },
  GUI = {
    Name = "RenderableDistanceLabel - Unit",
    Path = "/Examples"
  }
}

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

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