ScreenSpaceImageOnline

Inherits ScreenSpaceRenderable

Members

Name	Documentation	Type	Description	Optional
Name	Specifies the GUI name of the ScreenspaceImage	String	Value of type ‘String’	Yes
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. The size of the image will also automatically set the default size of this plane	String	Value of type ‘String’	Yes

Inherited members from ScreenSpaceRenderable

Name	Documentation	Type	Description	Optional
Type	The type of the Screenspace renderable that is to be created. The available types of Screenspace renderable depend on the configuration of the application and can be written to disk on application startup into the FactoryDocumentation	String	Must name a valid Screenspace renderable	No
BackgroundColor	The fixed color that is combined with the screen space renderable to create the final color. The actual color of the screen space renderable is alpha-blended with the background color to produce the final result	Color4	Value of type ‘Color4’	Yes
BorderColor	Sets the color of the border	Color3	Value of type ‘Color3’	Yes
BorderWidth	The width of the border	Double	Greater than: 0	Yes
CartesianPosition	This value determines the position of this screen space plane in Cartesian three-dimensional coordinates (meters)	Vector3<double>	Value of type ‘Vector3’	Yes
Enabled	This setting determines whether this sceen space plane will be visible or not	Boolean	Value of type ‘Boolean’	Yes
FaceCamera	If enabled, the local rotation is applied after the plane is rotated to face the camera	Boolean	Value of type ‘Boolean’	Yes
Gamma	This value determines whether the location of this screen space plane will be specified using radius, azimuth and elevation (if this is set to ‘true’) or using cartesian coordinates. By switching this value, the correct property will be shown or hidden. The Cartesian coordinate system is useful if a regular rendering is applied, whereas the radius azimuth elevation are most useful in a planetarium environment	Double	Value of type ‘Double’	Yes
Identifier	This is the unique identifier for this screenspace renderable. It has to be unique amongst all existing screenspace nodes that already have been added to the scene.	Identifier	An identifier string. May not contain ‘.’, spaces, newlines, or tabs	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
Name	Specifies the name of this screenspace renderable. This does not have to be unique to the scene, but it is recommended to be	String	Value of type ‘String’	Yes
Opacity	This value determines the opacity of the screen space plane. If this value is 1, the plane is completely opaque, if this value is 0, the plane is completely transparent	Double	In range: ( 0,1 )	Yes
RadiusAzimuthElevation	Sets the gamma correction of the texture	Vector3<double>	Value of type ‘Vector3’	Yes
RenderDuringBlackout	If this value is ‘true’, this screenspace renderable is going to ignore the global blackout factor from the Render Engine and will always render at full opacity. If it is ‘false’, it will adhere to the factor and fade out like the rest of the 3D rendering	Boolean	Value of type ‘Boolean’	Yes
Scale	This value determines a scale factor for the plane. The default size of a plane is determined by the concrete instance and reflects, for example, the size of the image being displayed	Double	Value of type ‘Double’	Yes
Tag	Defines either a single or multiple tags that apply to this ScreenSpaceRenderable, thus making it possible to address multiple, separate Renderables with a single property change	String, or Table	Value of type ‘String’, or Value of type ‘Table’	Yes
UsePerspectiveProjection	Determines whetether the z/radius values affects the size of the plane or not	Boolean	Value of type ‘Boolean’	Yes
UseRadiusAzimuthElevation	This value determines whether the location of this screen space plane will be specified using radius, azimuth and elevation (if this is set to ‘true’) or using cartesian coordinates. By switching this value, the correct property will be shown or hidden. The Cartesian coordinate system is useful if a regular rendering is applied, whereas the radius azimuth elevation are most useful in a planetarium environment	Boolean	Value of type ‘Boolean’	Yes