RenderablePlaneImageLocal

Inherits Renderable

A RenderablePlaneImageLocal creates a textured 3D plane, where the texture is provided by a local file on disk.

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
Texture	A path to an image file to use as a texture for the plane.	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
DistanceScalingSettings	Settings for scaling points based on camera distance	Table	Table parameters	Yes
LazyLoading	If this value is set to true, the image for this plane will not be loaded at startup but rather when image is shown for the first time. Additionally, if the plane is hidden, the image will automatically be unloaded.	Boolean	Value of type ‘Boolean’	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

Table parameters for DistanceScalingSettings

Settings for scaling points based on camera distance

• Optional: Yes

Name	Documentation	Type	Description	Optional
ApparentSizeMultiplier	Value that controls the visual size of the object when using distance scaling.A value of 1.0 results in a natural angular size based on camera distance and field of view. Smaller values (e.g., 0.01) make the object appear smaller, while larger values make it appear bigger.	Double	Greater than: 0	Yes
ScaleByDistance	Decides whether the plane should automatically adjust in size to based on the distance to the camera. Otherwise it will remain in the given size.	Boolean	Value of type ‘Boolean’	Yes
ScaleByDistanceMaxHeight	The maximum height in meters a plane can get when using distance scaling.	Double	Greater than: 0	Yes
ScaleByDistanceMinHeight	The minimum height in meters a plane can get when using distance scaling.	Double	Greater than: 0	Yes

Asset Examples

Basic

This example shows how to create a textured plane in 3D space, where the texture is loaded from a local file on disk.

local Node = {
  Identifier = "RenderablePlaneImageLocal_Example",
  Renderable = {
    Type = "RenderablePlaneImageLocal",
    Size = 3.0E11,
    Texture = openspace.absPath("${DATA}/test2.jpg")
  },
  GUI = {
    Name = "RenderablePlaneImageLocal - Basic",
    Path = "/Examples"
  }
}

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

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

Scale by Distance to Camera

This example creates a textured plane that is scaled based on the distance to the camera, so that it stays a constant size in screen space. The scale is limited so that the plane does not become larger or smaller than a given max height and min height, in meters.

local earth = asset.require("scene/solarsystem/planets/earth/earth")

local Node = {
  Identifier = "RenderablePlaneImageLocal_Example_ScaleByDistance",
  Renderable = {
    Type = "RenderablePlaneImageLocal",
    Size = 100000,
    Texture = openspace.absPath("${DATA}/test2.jpg"),
    DistanceScalingSettings = {
      ScaleByDistance = true,
      ApparentSizeMultiplier = 0.01,
      ScaleByDistanceMaxHeight = 200000,
      ScaleByDistanceMinHeight = 30000
    }
  },
  GUI = {
    Name = "RenderablePlaneImageLocal - ScaleByDistance",
    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 a local file on disk and the plane is billboarded to always face the camera.

local Node = {
  Identifier = "RenderablePlaneImageLocal_Example_Billboard",
  Renderable = {
    Type = "RenderablePlaneImageLocal",
    Size = 3.0E11,
    Texture = openspace.absPath("${DATA}/test2.jpg"),
    Billboard = true
  },
  GUI = {
    Name = "RenderablePlaneImageLocal - Billboard",
    Path = "/Examples"
  }
}

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

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