RenderableBoxGrid

Inherits Renderable

A RenderableBoxGrid creates a 3D box that is rendered using grid lines.

Per default the box is given a uniform size of 1x1x1 meters. It can then be scaled to the desired size. Alternatively, the size in each dimension can be specified.

Members

Name	Documentation	Type	Description	Optional
Color	The color used for the grid lines.	Color3	Value of type ‘Color3’	Yes
LineWidth	The width of the grid lines. The larger number, the thicker the lines.	Double	Value of type ‘Double’	Yes
Size	The size of each dimension of the box, in meters.	Vector3<double>	Value of type ‘Vector3’	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 box grid, which is a 3D box rendered using grid lines, to the scene.

Per default, the box will be given a size of 1x1x1 meters, and here it is scaled up by a factor of 100. It will hence have a size of 100x100x100 meters.

local Node = {
  Identifier = "RenderableBoxGrid_Example",
  Transform = {
    Scale = {
      Type = "StaticScale",
      Scale = 100
    }
  },
  Renderable = {
    Type = "RenderableBoxGrid"
  },
  GUI = {
    Name = "RenderableBoxGrid - Basic",
    Path = "/Examples"
  }
}

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

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

Styled

This example creates a box grid where the grid lines are styled to have a specific color and line width.

local Node = {
  Identifier = "RenderableBoxGrid_Example_Styled",
  Renderable = {
    Type = "RenderableBoxGrid",
    LineWidth = 4.0,
    Color = { 1.0, 1.0, 0.0 }
  },
  GUI = {
    Name = "RenderableBoxGrid - Styled",
    Path = "/Examples"
  }
}

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

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

With Non-uniform Size

This example creates a box grid with a non-uniform size. The size has been set so the box is two times larger in the Y-direction.

The Size values are given in meters, and here the box is scaled up by a factor of 100. So, the box will have a size of 100 times the Size values.

local Node = {
  Identifier = "RenderableBoxGrid_Example_Size",
  Transform = {
    Scale = {
      Type = "StaticScale",
      Scale = 100
    }
  },
  Renderable = {
    Type = "RenderableBoxGrid",
    Size = { 1.0, 2.0, 1.0 }
  },
  GUI = {
    Name = "RenderableBoxGrid - Non-uniform Size",
    Path = "/Examples"
  }
}

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

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