RenderablePlaneImageOnline

Inherits Renderable

Members

Name	Documentation	Type	Description	Optional
Size	This value specifies the size of the plane in meters	Double, or Vector2<double>	Value of type ‘Double’, or Value of type ‘Vector2’	No
URL	Sets the URL of the texture that is displayed on this screen space plane. If this value is changed, the image at the new path will automatically be loaded and displayed	String	Value of type ‘String’	No
Billboard	This value specifies whether the plane is a billboard, which means that it is always facing the camera. If this is false, it can be oriented using other transformations	Boolean	Value of type ‘Boolean’	Yes
BlendMode	This determines the blending mode that is applied to this plane	String	In list { Normal, Additive }	Yes
MirrorBackside	If this value is set to false, the image plane will not be mirrored when looking from the backside. This is usually desirable when the image shows data at a specific location, but not if it is displaying text for example	Boolean	Value of type ‘Boolean’	Yes
MultiplyColor	If set, the plane’s texture is multiplied with this color. Useful for applying a color grayscale images	Color3	Value of type ‘Color3’	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("scene/solarsystem/sun/transforms")



local RenderablePlaneImageOnline = {
  Identifier = "RenderablePlaneImageOnline",
  Parent = transforms.SolarSystemBarycenter.Identifier,
  Renderable = {
    Type = "RenderablePlaneImageOnline",
    Size = 3.0E11,
    Origin = "Center",
    Billboard = true,
    URL = "http://data.openspaceproject.com/examples/renderableplaneimageonline.jpg"
  },
  GUI = {
    Description = "A plane that loads a texture from the internet.",
    Path = "/Examples"
  }
}


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

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

asset.export(RenderablePlaneImageOnline)


asset.meta = {
  Name = "RenderablePlaneImageOnline Example",
  Version = "1.0",
  Description = [[Example of how to create a textured plane in 3D space, where the
    texture is loaded from a web URL]],
  Author = "OpenSpace Team",
  URL = "http://openspaceproject.com",
  License = "MIT license"
}