RenderableNodeArrow

Inherits Renderable

Members

Name	Documentation	Type	Description	Optional
EndNode	The identifier of the node the arrow should point towards	String	Value of type ‘String’	No
StartNode	The identifier of the node the arrow starts from	String	Value of type ‘String’	No
AmbientIntensity	A multiplier for ambient lighting for the shading of the arrow	Double	Greater or equal to: 0	Yes
ArrowHeadSize	This size of the arrow head, given in relative value of the entire length of the arrow. For example, 0.1 makes the arrow head length be 10% of the full arrow length	Double	Greater or equal to: 0	Yes
ArrowHeadWidthFactor	A factor that is multiplied with the width, or the arrow itself, to determine the width of the base of the arrow head	Double	Greater or equal to: 0	Yes
Color	This value determines the RGB color for the arrow	Color3	Value of type ‘Color3’	Yes
DiffuseIntensity	A multiplier for diffuse lighting for the shading of the arrow	Double	Greater or equal to: 0	Yes
Invert	If set to true, the arrow direction is inverted so that it points to the start node instead of the end node	Boolean	Value of type ‘Boolean’	Yes
Length	The length of the arrow, given either in meters or as a factor to be multiplied with the bounding sphere of the start node (if ‘UseRelativeLength’ is true)	Double	Greater or equal to: 0	Yes
Offset	The distance from the center of the start node where the arrow starts. If ‘UseRelativeOffset’ is true, the value should be given as a factor to multiply with the bounding sphere of the node. Otherwise, the value is specified in meters	Double	Value of type ‘Double’	Yes
PerformShading	This value determines whether shading should be applied to the arrow model	Double	Value of type ‘Double’	Yes
Segments	This value specifies the number of segments that the shapes for the arrow are separated in. A higher number leads to a higher resolution	Integer	Greater or equal to: 3	Yes
SpecularIntensity	A multiplier for specular lighting for the shading of the arrow	Double	Greater or equal to: 0	Yes
UseRelativeLength	Decide whether to use relative size (in units of start node bounding sphere) for the length of the arrow. If false, meters is used	Boolean	Value of type ‘Boolean’	Yes
UseRelativeOffset	Decide whether to use relative distances (in units of start node bounding sphere) for the offset distance. If false, meters is used	Boolean	Value of type ‘Boolean’	Yes
Width	This value specifies the width of the arrow shape	Double	Greater or equal to: 0	Yes

Inherited members from Renderable

Name	Documentation	Type	Description	Optional
DimInAtmosphere	Enables/Disables if the object should be dimmed when the camera is in the sunny part of an atmosphere	Boolean	Value of type ‘Boolean’	Yes
Enabled	This setting 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	This value specifies if the renderable should be rendered in the Background,Opaque, Pre/PostDeferredTransparency, or Overlay 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	This tells the type of the renderable	String	Value of type ‘String’	Yes

Asset Examples

local earth = asset.require("scene/solarsystem/planets/earth/earth")
local moon = asset.require("scene/solarsystem/planets/earth/moon/moon")
local mars = asset.require("scene/solarsystem/planets/mars/mars")



local EarthRadius = 6371000.0

local ArrowExample = {
  Identifier = "RenderableNodeArrowExample",
  Parent = earth.Earth.Identifier,
  Renderable = {
    Type = "RenderableNodeArrow",
    StartNode = earth.Earth.Identifier,
    EndNode = mars.Mars.Identifier,
    Color = { 0.8, 1.0, 0.8 },
    Offset = 2 * EarthRadius,
    Length = 5 * EarthRadius,
    Width = 900000.0
  },
  GUI = {
    Name = "Node Arrow Example",
    Path = "/Example",
    Description = [[Example node direction arrow, using absolute sizes]]
  }
}

-- Relative values: Multiplied with bounding sphere
local ArrowExample_RelativeUnits = {
  Identifier = "RenderableNodeArrowExample_Relative",
  Parent = earth.Earth.Identifier,
  Renderable = {
    Type = "RenderableNodeArrow",
    StartNode = earth.Earth.Identifier,
    EndNode = moon.Moon.Identifier,
    Color = { 0.78, 0.0, 1.0 },
    UseRelativeOffset = true,
    UseRelativeLength = true,
    Offset = 2.0,
    Length = 5.0,
    Width = 900000.0,
    Invert = true -- Point to start node instead of end node
  },
  GUI = {
    Name = "Node Arrow Example (relative units)",
    Path = "/Example",
    Description = [[Example node direction arrow, using relative sizes]]
  }
}


asset.onInitialize(function()
  openspace.addSceneGraphNode(ArrowExample)
  openspace.addSceneGraphNode(ArrowExample_RelativeUnits)
end)

asset.onDeinitialize(function()
  openspace.removeSceneGraphNode(ArrowExample_RelativeUnits)
  openspace.removeSceneGraphNode(ArrowExample)
end)

asset.export(ArrowExample)
asset.export(ArrowExample_RelativeUnits)



asset.meta = {
  Name = "RenderableNodeArrow Example asset",
  Version = "1.0",
  Description = [[Examples of the RenderableNodeArrow renderable, that can be used to draw
    an arrow pointing from one scene graph node in the direction of another. Note that
    the arrows are generated as objects in 3D space and need to have a size that is
    suitable for their 3D context.]],
  Author = "OpenSpace Team",
  URL = "http://openspaceproject.com",
  License = "MIT license"
}