RenderableLabel

Inherits Renderable

Members

Name	Documentation	Type	Description	Optional
BlendMode	This determines the blending mode that is applied to the renderable	String	In list { Normal, Additive }	Yes
Color	The label text color	Color3	Value of type ‘Color3’	Yes
EnableFading	Enable/Disable the Fade-in effect	Boolean	Value of type ‘Boolean’	Yes
FadeDistances	The distance range in which the labels should be fully opaque, specified in the chosen unit. The distance from the position of the label to the camera	Vector2<double>	Value of type ‘Vector2’	Yes
FadeUnit	Distance unit for fade-in/-out distance calculations. Defaults to “au”	String	In list { m, Km, Mm, Gm, Tm, Pm, au, pc, Kpc, Mpc, Gpc, Gly }	Yes
FadeWidths	The distances over which the fading takes place, given in the specified unit. The first value is the distance before the closest distance and the second the one after the furthest distance. For example, with the unit Parsec (pc), a value of {1, 2} will make the label being fully faded out 1 Parsec before the closest distance and 2 Parsec away from the furthest distance	Vector2<double>	Value of type ‘Vector2’	Yes
FontSize	The font size (in points) for the label	Double	Value of type ‘Double’	Yes
MinMaxSize	The minimum and maximum size (in pixels) of the label	Vector2<int>	Value of type ‘Vector2’	Yes
OrientationOption	Label orientation rendering mode	String	In list { Camera View Direction, Camera Position Normal }	Yes
Size	This value affects the size scale of the label	Double	Value of type ‘Double’	Yes
Text	The text that will be displayed on screen	String	Value of type ‘String’	Yes
TransformationMatrix	Transformation matrix to be applied to the label	Matrix4x4<double>	Value of type ‘Matrix4x4’	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

local transforms = asset.require("./transforms")



local Label = {
  Identifier = "ErisLabel",
  Parent = transforms.Position.Identifier,
  Renderable = {
    Type = "RenderableLabel",
    Enabled = asset.enabled,
    Text = "Eris",
    FontSize = 70.0,
    Size = 9.10,
    MinMaxSize = { 1, 100 },
    BlendMode = "Additive",
    OrientationOption = "Camera View Direction",
    EnableFading = true,
    FadeUnit = "au",
    FadeDistances = { 2.0, 120.0 },
    FadeWidths = { 1.0, 150.0 }
  },
  Tag = { "solarsystem_labels" },
  GUI = {
    Name = "Eris Label",
    Path = "/Solar System/Dwarf Planets/Eris",
    Description = "Label for Eris, visible at the solarsystem overview zoom level"
  }
}


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

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

asset.export("Label", Label)



asset.meta = {
  Name = "Eris Label",
  Version = "1.0",
  Description = [[Label of Eris]],
  Author = "OpenSpace Team",
  URL = "https://www.openspaceproject.com",
  License = "MIT"
}