RenderablePlaneImageOnline

Inherits Renderable

A RenderablePlaneImageOnline creates a textured 3D plane, where the texture image is loaded from the internet though a web URL.

Members

Name	Documentation	Type	Description	Optional
Size	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
AutoScale	Decides whether the plane should automatically adjust in size to match the aspect ratio of the content. Otherwise it will remain in the given size.	Boolean	Value of type ‘Boolean’	Yes
Billboard	Controls whether the plane will be oriented as a billboard. Setting this value to true is the same as setting it to “Camera Position Normal”, setting it to false is the same as setting it to “Fixed Rotation”. If the value is not specified, the default value of false is used instead. “Camera View Direction” rotates the plane so that it is orthogonal to the viewing direction of the camera (useful for planar displays), and “Camera Position Normal” rotates the plane towards the position of the camera (useful for spherical displays, like dome theaters). In both these cases the plane will be billboarded towards the camera but in a slightly different way. In contrast, “Fixed Rotation” does not rotate the plane at all based on the camera and should be used the plane should be oriented in a fixed way.	Boolean, or String	Value of type ‘Boolean’, or In list { Camera View Direction, Camera Position Normal, Fixed Rotation }	Yes
BlendMode	Determines the blending mode that is applied to this plane.	String	In list { Normal, Additive }	Yes
MirrorBackside	If false, the image plane will not be mirrored when viewed 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	An RGB color to multiply with the plane’s texture. Useful for applying a color to grayscale images.	Color3	Value of type ‘Color3’	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 shows how to create a textured plane in 3D space, where the texture is loaded from the internet though a web URL.

local Node = {
  Identifier = "RenderablePlaneImageOnline_Example",
  Renderable = {
    Type = "RenderablePlaneImageOnline",
    Size = 3.0E11,
    URL = "http://data.openspaceproject.com/examples/renderableplaneimageonline.jpg"
  },
  GUI = {
    Name = "RenderablePlaneImageOnline - Basic",
    Path = "/Examples"
  }
}

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

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

Billboard Image

This example shows how to create a textured plane in 3D space, where the texture is loaded from the internet though a web URL and the plane is billboarded to always face the camera.

local Node = {
  Identifier = "RenderablePlaneImageOnline_Example_Billboard",
  Renderable = {
    Type = "RenderablePlaneImageOnline",
    Size = 3.0E11,
    URL = "http://data.openspaceproject.com/examples/renderableplaneimageonline.jpg",
    Billboard = true
  },
  GUI = {
    Name = "RenderablePlaneImageOnline - Billboard",
    Path = "/Examples"
  }
}

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

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