RenderableDisc

Inherits Renderable

This renderable can be used to create a circular disc that is colored based on a one-dimensional texture.

The disc will be filled i.e. a full circle, per default, but may also be made with a hole in the center using the Width parameter.

Members

Name	Documentation	Type	Description	Optional
Texture	The path to a file with a one-dimensional texture to be used for the disc color. The leftmost color will be innermost color when rendering the disc, and the rightmost color will be the outermost color.	File	Value of type ‘File’	No
Size	The outer radius of the disc, in meters.	Double	Value of type ‘Double’	Yes
Width	The disc width, given as a ratio of the full disc radius. For example, a value of 1 results in a full circle, while 0.5 results in a disc where the inner radius is half of the full radius.	Double	In range: ( 0,1 )	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

Ellipse

This example creates a disc with an ellipic shape, using a non-uniform scaling.

This renderable requires a texture to be loaded, even for just a single color. Use the utility function that exists for creating single color textures for this purpose.

local purpleTexture = openspace.createSingleColorImage(
  "example_disc_color_purple",
  { 0.5, 0.0, 0.5 }
)

local Node = {
  Identifier = "RenderableDisc_Example_Ellipse",
  Transform = {
    -- Elliptic discs can be created using a non-uniform scaling
    Scale = {
      Type = "NonUniformStaticScale",
      Scale = { 2.0, 1.0, 1.0 }
    }
  },
  Renderable = {
    Type = "RenderableDisc",
    Size = 100.0,
    Texture = purpleTexture
  },
  GUI = {
    Name = "RenderableDisc - Ellipse",
    Path = "/Examples"
  }
}

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

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

With Hole

This example creates a disc that has a hole in it. By specifying a Width of 0.5, the disc will stop halfway from the edge to the center point. The disc is rendered with a single color and an outer radius of 100 meters.

This renderable requires a texture to be loaded, even for just a single color. Use the utility function that exists for creating single color textures for this purpose.

local cyanTexture = openspace.createSingleColorImage(
  "example_disc_color_cyan",
  { 0.0, 1.0, 1.0 }
)

local Node = {
  Identifier = "RenderableDisc_Example_WithHole",
  Renderable = {
    Type = "RenderableDisc",
    Size = 100.0,
    Width = 0.5,
    Texture = cyanTexture
  },
  GUI = {
    Name = "RenderableDisc - With Hole",
    Path = "/Examples"
  }
}

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

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

Basic

This example creates a disc with a single color and a radius of 100 meters.

This renderable requires a texture to be loaded, even for just a single color. Use the utility function that exists for creating single color textures for this purpose.

local cyanTexture = openspace.createSingleColorImage(
  "example_disc_color_cyan",
  { 0.0, 1.0, 1.0 }
)

local Node = {
  Identifier = "RenderableDisc_Example",
  Renderable = {
    Type = "RenderableDisc",
    Size = 100.0,
    Texture = cyanTexture
  },
  GUI = {
    Name = "RenderableDisc - Basic",
    Path = "/Examples"
  }
}

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

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