RenderableDisc

Inherits Renderable

Members

Name	Documentation	Type	Description	Optional
Texture	This value is the path to a texture on disk that contains a one-dimensional texture to be used for the color	File	Value of type ‘File’	No
Size	This value specifies the outer radius of the disc in meter	Double	Value of type ‘Double’	Yes
Width	This value is used to set the width of the disc. The actual width is set based on the given size and this value should be set between 0 and 1. A value of 1 results in a full circle and 0.5 a disc with an inner radius of 0.5*size	Double	Value of type ‘Double’	Yes

Inherited members from Renderable

Name	Documentation	Type	Description	Optional
DimInAtmosphere	Enables/Disables if the object should be dimmed when the camera is in the sunny part of an atmosphere	Boolean	Value of type ‘Boolean’	Yes
Enabled	This setting 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	This value specifies if the renderable should be rendered in the Background,Opaque, Pre/PostDeferredTransparency, or Overlay rendering step	String	In list { Background, Opaque, PreDeferredTransparent, PostDeferredTransparent, Overlay }	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	This tells the type of the renderable	String	Value of type ‘String’	Yes

Asset Examples

-- @TODO (emmbr 2020-02-03) Potential threading issue later on? This will run on the main thread
local cyanTexture = openspace.createSingleColorImage("example_disc_color1", { 0.0, 1.0, 1.0 })
local purpleTexture = openspace.createSingleColorImage("example_disc_color2", { 0.5, 0.0, 0.5 })

local BasicDisc = {
  Identifier = "BasicDisc",
  Renderable = {
    Type = "RenderableDisc",
    Texture = cyanTexture,
    Size = 1e10,
    Width = 0.5
  },
  GUI = {
    Name = "Basic Disc",
    Path = "/Examples/Discs"
  }
}

-- Elliptic discs can be created using a non-uniform scaling
-- For a full disc, use a width of 1.0
local FullEllipticDisc = {
  Identifier = "FullEllipticDisc",
  Transform = {
    Scale = {
      Type = "NonUniformStaticScale",
      Scale = { 2.0, 1.0, 1.0 }
    }
  },
  Renderable = {
    Type = "RenderableDisc",
    Texture = purpleTexture,
    Size = 2e10,
    Width = 1.0
  },
  GUI = {
    Name = "Full Elliptic Disc",
    Path = "/Examples/Discs"
  }
}


asset.onInitialize(function()
  openspace.addSceneGraphNode(BasicDisc)
  openspace.addSceneGraphNode(FullEllipticDisc)
end)

asset.onDeinitialize(function()
  openspace.removeSceneGraphNode(FullEllipticDisc)
  openspace.removeSceneGraphNode(BasicDisc)
end)

asset.export(BasicDisc)
asset.export(FullEllipticDisc)


asset.meta = {
  Name = "Example Discs",
  Version = "1.0",
  Description = [[Examples of different types of rendered discs.]],
  Author = "OpenSpace Team",
  URL = "http://openspaceproject.com",
  License = "MIT license"
}