DashboardItemAngle

Inherits DashboardItem

This DashboardItem shows the angle between the lines Source->Reference and Source->Destination. Each of Source, Reference, and Destination can be either the identifier of a node, the current focus node, or the position of the camera. The angle cannot be calculated if two of these three items are located in the same position, in which case an error message is printed. The SourceNodeName, ReferenceNodeName, and DestinationNodeName parameters are only used if the SourceType, ReferenceType, or DestinationType respectively is set to Node.

Members

Name	Documentation	Type	Description	Optional
DestinationType	The type of position that is used as the destination to calculate the angle. The computed angle is the incident angle to Source in the triangle (Source, Reference, Destination).	String	In list { Node, Focus, Camera }	No
ReferenceType	The type of position that is used as the destination of the reference line used to calculate the angle. The computed angle is the incident angle to Source in the triangle (Source, Reference, Destination).	String	In list { Node, Focus, Camera }	No
SourceType	The type of position that is used as the triangle apex used to calculate the angle.	String	In list { Node, 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 angle.	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
ReferenceNodeIdentifier	If a scene graph node is selected as type, this value specifies the identifier of the node that is to be used as the reference direction to compute the angle.	String	Value of type ‘String’	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 apex of the triangle used to calculate the angle. The computed angle is the incident angle to Source in the triangle (Source, Reference, Destination).	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

Three nodes

This example adds three invisible scene graph nodes and then shows the angle between those three nodes.

local Node1 = {
  Identifier = "DashboardItemAngle_Example_ThreeNodes_Node1",
  GUI = {
    Name = "DashboardItemAngle - Three Nodes (Node 1)"
  }
}

local Node2 = {
  Identifier = "DashboardItemAngle_Example_ThreeNodes_Node2",
  Transform = {
    Translation = {
      Type = "StaticTranslation",
      Position = { 2.0, 1.0, 0.0 }
    }
  },
  GUI = {
    Name = "DashboardItemAngle - Three Nodes (Node 2)"
  }
}

local Node3 = {
  Identifier = "DashboardItemAngle_Example_ThreeNodes_Node3",
  Transform = {
    Translation = {
      Type = "StaticTranslation",
      Position = { -2.0, 1.0, 0.0 }
    }
  },
  GUI = {
    Name = "DashboardItemAngle - Three Nodes (Node 3)"
  }
}

local Item = {
  Identifier = "DashboardItemAngle_Example_ThreeNodes",
  Type = "DashboardItemAngle",
  SourceType = "Node",
  SourceNodeIdentifier = Node1.Identifier,
  ReferenceType = "Node",
  ReferenceNodeIdentifier = Node2.Identifier,
  DestinationType = "Node",
  DestinationNodeIdentifier = Node3.Identifier
}

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

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

Two nodes and focus

This example adds two invisible scene graph nodes and then shows the angle between the current focus node and those two nodes.

local Node1 = {
  Identifier = "DashboardItemAngle_Example_TwoNodesFocus_Node1",
  GUI = {
    Name = "DashboardItemAngle - Two Nodes & Focus (Node 1)"
  }
}

local Node2 = {
  Identifier = "DashboardItemAngle_Example_TwoNodesFocus_Node2",
  Transform = {
    Translation = {
      Type = "StaticTranslation",
      Position = { 20.0, 1.0, 0.0 }
    }
  },
  GUI = {
    Name = "DashboardItemAngle - Two Nodes & Focus (Node 2)"
  }
}

local Item = {
  Identifier = "DashboardItemAngle_Example_TwoNodesFocus",
  Type = "DashboardItemAngle",
  SourceType = "Focus",
  ReferenceType = "Node",
  ReferenceNodeIdentifier = 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)

Two nodes and camera

This example adds two invisible scene graph nodes and then shows the angle between the camera and those two nodes.

local Node1 = {
  Identifier = "DashboardItemAngle_Example_TwoNodesCamera_Node1",
  GUI = {
    Name = "DashboardItemAngle - Two Nodes & Camera (Node 1)"
  }
}

local Node2 = {
  Identifier = "DashboardItemAngle_Example_TwoNodesCamera_Node2",
  Transform = {
    Translation = {
      Type = "StaticTranslation",
      Position = { 20.0, 1.0, 0.0 }
    }
  },
  GUI = {
    Name = "DashboardItemAngle - Two Nodes & Camera (Node 2)"
  }
}

local Item = {
  Identifier = "DashboardItemAngle_Example_TwoNodesCamera",
  Type = "DashboardItemAngle",
  SourceType = "Camera",
  ReferenceType = "Node",
  ReferenceNodeIdentifier = 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)