RenderableSphericalGrid

Inherits Renderable

This Renderable creates a grid in the shape of a sphere. Note that the sphere will always be given a radius of one meter. To change its size, use a Scale transform, such as the StaticScale.

The grid may be split up into equal segments in both directions using the Segments parameter, or different number of segments in the latitudal and longtudal direction using the LatSegments and LongSegments parameters.

Members

Name	Documentation	Type	Description	Optional
Color	The color of the grid lines.	Color3	Value of type ‘Color3’	Yes
Labels	The labels for the grid.	Table	LabelsComponent	Yes
LatSegments	The number of latitudinal segments the sphere is split into. Determines the resolution of the rendered sphere in a up/down direction when looking straight at the equator. Should be an even value (if an odd value is provided, the value will be set to the new value minus one). If the Segments value is provided as well, it will have precedence over this value	Integer	Value of type ‘Integer’	Yes
LineWidth	The width of the grid lines. The larger number, the thicker the lines.	Double	Value of type ‘Double’	Yes
LongSegments	The number of longitudinal segments the sphere is split into. Determines the resolution of the rendered sphere in a left/right direction when looking straight at the equator. Should be an even value (if an odd value is provided, the value will be set to the new value minus one). If the Segments value is provided as well, it will have precedence over this value	Integer	Value of type ‘Integer’	Yes
Segments	The number of segments the sphere is split into. Determines the resolution of the rendered sphere. Should be an even value (if an odd value is provided, the value will be set to the new value minus one). Setting this value is equal to setting LongSegments and LatSegments to the same value. If this value is specified, it will overwrite the values provided in LongSegments and LatSegments.	Integer	Value of type ‘Integer’	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 spherical grid with a radius of 100 meters.

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

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

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

Segments

This example adds a spherical grid with a radius of 100 meters, where the sphere is split up into 100 segments in each direction. The default is 64.

local Node = {
  Identifier = "RenderableSphericalGrid_Example_Segments",
  Transform = {
    Scale = {
      Type = "StaticScale",
      Scale = 100.0
    }
  },
  Renderable = {
    Type = "RenderableSphericalGrid",
    Segments = 100
  },
  GUI = {
    Name = "RenderableSphericalGrid - Segments",
    Path = "/Examples"
  }
}

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

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

Styled

This example adds a spherical grid with a custom color and line width.

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

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

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

Different Number of Segments in Latitudinal and Longitudinal Direction

This example adds a spherical grid with a radius of 100 meters, where the sphere is split up into 100 segments in the longitudinal direction and 10 segments in the latitudinal direction.

local Node = {
  Identifier = "RenderableSphericalGrid_Example_SegmentsLatLong",
  Transform = {
    Scale = {
      Type = "StaticScale",
      Scale = 100.0
    }
  },
  Renderable = {
    Type = "RenderableSphericalGrid",
    LatSegments = 100,
    LongSegments = 10
  },
  GUI = {
    Name = "RenderableSphericalGrid - Segments Lat/Long",
    Path = "/Examples"
  }
}

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

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