RenderableGrid

Inherits Renderable

This Renderable can be used to create a planar grid, to for example illustrate distances in 3D space.

The grid is created by specifying a size and how many segments to split each dimension into. A secondary color can be used to highlight grid lines with a given interval.

Members

Name	Documentation	Type	Description	Optional
Color	The color of the grid lines.	Color3	Value of type ‘Color3’	Yes
HighlightColor	The color of the highlighted lines in the grid.	Color3	Value of type ‘Color3’	Yes
HighlightLineWidth	The width of the highlighted grid lines. The larger number, the thicker the lines.	Double	Value of type ‘Double’	Yes
HighlightRate	The rate that the columns and rows are highlighted, counted with respect to the center of the grid. If the number of segments in the grid is odd, the highlighting might be offset from the center.	Vector2<int>	Value of type ‘Vector2’	Yes
Labels	The labels for the grid.	Table	LabelsComponent	Yes
LineWidth	The width of the grid lines. The larger number, the thicker the lines.	Double	Value of type ‘Double’	Yes
Segments	The number of segments to split the grid into, in each direction (x and y).	Vector2<int>	Value of type ‘Vector2’	Yes
Size	The size of the grid (in the x and y direction), given in meters.	Vector2<double>	Value of type ‘Vector2’	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

Basic

This example adds a planar grid of 100x100 meters to the scene. Per default, the grid consist of 10x10 segments.

local Node = {
  Identifier = "RenderableGrid_Example",
  Renderable = {
    Type = "RenderableGrid",
    Size = { 100.0, 100.0 }
  },
  GUI = {
    Name = "RenderableGrid - Basic",
    Path = "/Examples"
  }
}

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

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

Specifying Segments

This example adds a planar grid of 50x100 meters, split into 5 segments in the x-direction and 10 segments in the y-direction so that each segment is 10x10 meters.

local Node = {
  Identifier = "RenderableGrid_Example_Segments",
  Renderable = {
    Type = "RenderableGrid",
    Size = { 50.0, 100.0 },
    Segments = { 5, 10 }
  },
  GUI = {
    Name = "RenderableGrid - Segments",
    Path = "/Examples"
  }
}

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

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

Higlighting Grid Lines

This example adds a planar grid of 100x100 meters, with highlight color for every 5th grid line in each direction.

local Node = {
  Identifier = "RenderableGrid_Example_Highlights",
  Renderable = {
    Type = "RenderableGrid",
    Size = { 100.0, 100.0 },
    HighlightColor = { 0.0, 1.0, 0.0 },
    HighlightRate = { 5, 5 },
    HighlightLineWidth = 2.0
  },
  GUI = {
    Name = "RenderableGrid - Highlights",
    Path = "/Examples"
  }
}

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

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

Styled

This example adds a planar grid of 100x100 meters, with a custom color and line width.

local Node = {
  Identifier = "RenderableGrid_Example_Styled",
  Renderable = {
    Type = "RenderableGrid",
    Size = { 100.0, 100.0 },
    Color = { 0.0, 1.0, 0.0 },
    LineWidth = 2.0
  },
  GUI = {
    Name = "RenderableGrid - Styled",
    Path = "/Examples"
  }
}

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

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