RenderableRadialGrid

Inherits Renderable

This Renderable creates a planar circular grid with a given size. Optionally, it may have a hole in the center.

The size is determined by two radii values: The first (inner) radius defines the hole in the center. The second (outer) radius defines the full grid size. To create a solid circle that connects at the center, set the inner radius to zero (default).

Members

Name	Documentation	Type	Description	Optional
CircleSegments	The number of segments that is used to render each circle in the grid.	Integer	Value of type ‘Integer’	Yes
Color	The color used for the grid lines.	Color3	Value of type ‘Color3’	Yes
GridSegments	Specifies the number of segments for the grid, in the radial and angular direction respectively.	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
Radii	The radii values that determine the size of the circular grid. The first value is the radius of the inmost ring and the second is the radius of the outmost ring.	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

Styled

This example adds a circular grid with a specific color and line width. Note that we keep the size at its default value.

local Node = {
  Identifier = "RenderableRadialGrid_Example_Styled",
  Renderable = {
    Type = "RenderableRadialGrid",
    Color = { 1.0, 0.0, 0.0 },
    LineWidth = 2.0
  },
  GUI = {
    Name = "RenderableRadialGrid - Styled",
    Path = "/Examples"
  }
}

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

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

Ring

The RenderableRadialGrid can also be used to create a simple ring. This is done by setting the number of segments in each direction to 1 and make sure the inner radius is zero (which is the default).

local Node = {
  Identifier = "RenderableRadialGrid_Example_Ring",
  Renderable = {
    Type = "RenderableRadialGrid",
    GridSegments = { 1, 1 }
  },
  GUI = {
    Name = "RenderableRadialGrid - Ring",
    Path = "/Examples"
  }
}

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

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

Basic

This example adds a circular grid with a radius of 100 meters to the scene. Per default, the grid is split into 10 angular and radial segments.

The grid is created with a radius of 1 meter per default. Here we scale it up by a factor of 100 to get the desired size.

local Node = {
  Identifier = "RenderableRadialGrid_Example",
  Transform = {
    Scale = {
      Type = "StaticScale",
      Scale = 100.0
    }
  },
  Renderable = {
    Type = "RenderableRadialGrid"
  },
  GUI = {
    Name = "RenderableRadialGrid - Basic",
    Path = "/Examples"
  }
}

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

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

Custom Radii

This example adds a circular grid with a radius of 100 meters with a hole of 10 meters in the center. This is achieved by specifying two radii, the first one being the radius of the inner circle and the second one being the radius of the outer circle.

local Node = {
  Identifier = "RenderableRadialGrid_Example_Radii",
  Renderable = {
    Type = "RenderableRadialGrid",
    Radii = { 10.0, 100.0 }
  },
  GUI = {
    Name = "RenderableRadialGrid - Custom Radii",
    Path = "/Examples"
  }
}

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

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

Custom Grid Segments

This example adds a circular grid with 10 segments in the radial direction and 1 segment in the angular direction. 1 here means that we do not split the grid into smaller segments in the angular direction.

local Node = {
  Identifier = "RenderableRadialGrid_Example_Segments",
  Renderable = {
    Type = "RenderableRadialGrid",
    GridSegments = { 10, 1 }
  },
  GUI = {
    Name = "RenderableRadialGrid - Segments",
    Path = "/Examples"
  }
}

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

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