DashboardItemDistance

Inherits DashboardItem

This DashboardItem displays the distance between two points. The points can be defined either by the location of a scene graph node, the surface of a scene graph node’s bounding sphere, the location of the current focus node, or the position of the camera. These definitions can be mixed and matched to calculate any combination of positions.

The resulting text can be formatted in the FormatString and the measurement unit is chosed by changing the Simplification and RequestedUnit parameters.

Members

Name	Documentation	Type	Description	Optional
DestinationType	The type of position that is used as the destination to calculate the distance.	String	In list { Node, Node Surface, Focus, Camera }	No
SourceType	The type of position that is used as the source to calculate the distance.	String	In list { Node, Node Surface, Focus, Camera }	No
DestinationNodeIdentifier	If a scene graph node is selected as type, this value specifies the identifier of the node that is to be used as the destination for computing the distance.	String	Value of type ‘String’	Yes
FontName	This value is the name of the font that is used. It can either refer to an internal name registered previously, or it can refer to a path that is used.	String	Value of type ‘String’	Yes
FontSize	This value determines the size of the font that is used to render the distance.	Double	Value of type ‘Double’	Yes
FormatString	The format string that is used for formatting the distance string. This format receives four parameters: The name of the source, the name of the destination the value of the distance and the unit of the distance.	String	Value of type ‘String’	Yes
RequestedUnit	If the simplification is disabled, this distance unit is used as a destination to convert the meters into.	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
Simplification	If this value is enabled, the distance is displayed in nuanced units, such as km, AU, light years, parsecs, etc. If this value is disabled, the unit can be explicitly requested.	Boolean	Value of type ‘Boolean’	Yes
SourceNodeIdentifier	If a scene graph node is selected as type, this value specifies the identifier of the node that is to be used as the source for computing the distance.	String	Value of type ‘String’	Yes

Inherited members from DashboardItem

Name	Documentation	Type	Description	Optional
Identifier	The unique identifier for this DashboardItem.	Identifier	An identifier string. May not contain ‘.’, spaces, newlines, or tabs	No
Type	Determines the type of the DashbordItem that should be created.	String	Value of type ‘String’	No
Enabled	If this value is set to ‘true’ this dashboard item is shown in the dashboard. Otherwise it will be hidden.	Boolean	Value of type ‘Boolean’	Yes
GuiName	The name for the DashboardItem that is used when showing it in the user interface.	String	Value of type ‘String’	Yes

Asset Examples

NodeSurface-Camera

This example adds two invisible nodes and a dashboard item that shows the distance between those two nodes

local Node = {
  Identifier = "DashboardItemDistance_Example_NodeSurfaceCamera_Node",
  BoundingSphere = 200.0,
  GUI = {
    Name = "DashboardItemDistance - NodeSurface-Camera"
  }
}

local Item = {
  Identifier = "DashboardItemDistance_Example_NodeSurfaceCamera",
  Type = "DashboardItemDistance",
  SourceType = "Node Surface",
  SourceNodeIdentifier = Node.Identifier,
  DestinationType = "Camera"
}

asset.onInitialize(function()
  openspace.addSceneGraphNode(Node)
  openspace.dashboard.addDashboardItem(Item)
end)

asset.onDeinitialize(function()
  openspace.dashboard.removeDashboardItem(Item)
  openspace.removeSceneGraphNode(Node)
end)

Node-Camera

This example adds an invisible node and a dashboard item that shows the distance between this node and the current focus node.

local Node = {
  Identifier = "DashboardItemDistance_Example_NodeCamera_Node",
  GUI = {
    Name = "DashboardItemDistance - Node-Camera"
  }
}

local Item = {
  Identifier = "DashboardItemDistance_Example_NodeCamera",
  Type = "DashboardItemDistance",
  SourceType = "Node",
  SourceNodeIdentifier = Node.Identifier,
  DestinationType = "Camera"
}

asset.onInitialize(function()
  openspace.addSceneGraphNode(Node)
  openspace.dashboard.addDashboardItem(Item)
end)

asset.onDeinitialize(function()
  openspace.dashboard.removeDashboardItem(Item)
  openspace.removeSceneGraphNode(Node)
end)

Node-Node

This example adds two invisible nodes and a dashboard item that shows the distance between those two nodes.

local Node1 = {
  Identifier = "DashboardItemDistance_Example_NodeNode_Node1",
  GUI = {
    Name = "DashboardItemDistance - Node-Node (Node 1)"
  }
}

local Node2 = {
  Identifier = "DashboardItemDistance_Example_NodeNode_Node2",
  Transform = {
    Translation = {
      Type = "StaticTranslation",
      Position = { 2.0, 0.0, 0.0 }
    }
  },
  GUI = {
    Name = "DashboardItemDistance - Node-Node (Node 2)"
  }
}

local Item = {
  Identifier = "DashboardItemDistance_Example_NodeNode",
  Type = "DashboardItemDistance",
  SourceType = "Node",
  SourceNodeIdentifier = Node1.Identifier,
  DestinationType = "Node",
  DestinationNodeIdentifier = Node2.Identifier
}

asset.onInitialize(function()
  openspace.addSceneGraphNode(Node1)
  openspace.addSceneGraphNode(Node2)
  openspace.dashboard.addDashboardItem(Item)
end)

asset.onDeinitialize(function()
  openspace.dashboard.removeDashboardItem(Item)
  openspace.removeSceneGraphNode(Node2)
  openspace.removeSceneGraphNode(Node1)
end)

Node-Focus

This example adds an invisible node and a dashboard item that shows the distance between this node and the current focus node.

local Node = {
  Identifier = "DashboardItemDistance_Example_NodeFocus_Node",
  GUI = {
    Name = "DashboardItemDistance - Node-Focus"
  }
}

local Item = {
  Identifier = "DashboardItemDistance_Example_NodeFocus",
  Type = "DashboardItemDistance",
  SourceType = "Node",
  SourceNodeIdentifier = Node.Identifier,
  DestinationType = "Focus"
}

asset.onInitialize(function()
  openspace.addSceneGraphNode(Node)
  openspace.dashboard.addDashboardItem(Item)
end)

asset.onDeinitialize(function()
  openspace.dashboard.removeDashboardItem(Item)
  openspace.removeSceneGraphNode(Node1)
end)