ScreenSpaceRenderable
This is the base class of all ScreenSpaceRenderable types, which are objects that are rendered in their own coordinate system on top of the other 3D rendering.
The coordinate system of these renderables is a custom one that has its own depth, to control how the screen space objects are sorted. There are also two ways of specifying the position of the object: in Cartesian coordinates using XYZ, or spherical using radius, azimuth, and elevation. The latter might be more useful in a planetarium context.
Most screen space renderables are instantiated as image planes in one way or another, and this base class includes some properties for setting things like gamma settings, border and background colors, et cetera.
Members
Name |
Documentation |
Type |
Description |
Optional |
|---|---|---|---|---|
|
The type of the |
|
Must name a valid ScreenSpaceRenderable |
No |
|
A 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. |
|
Value of type ‘Color4’ |
Yes |
|
The color of the border. |
|
Value of type ‘Color3’ |
Yes |
|
The width of the border. |
|
Greater than: 0 |
Yes |
|
Determines the position of this screen space plane in Cartesian three-dimensional coordinates (meters). |
|
Value of type ‘Vector3 |
Yes |
|
Determines whether this sceen space object will be rendered or not. |
|
Value of type ‘Boolean’ |
Yes |
|
If enabled, the object will be rotated to face the camera position. Any local rotation is then applied after this rotation. |
|
Value of type ‘Boolean’ |
Yes |
|
Sets the gamma correction of the texture that is applied in addition to the global gamma value. |
|
Value of type ‘Double’ |
Yes |
|
The unique identifier for this screen space renderable. It has to be unique amongst all existing screen space nodes that have been added to the scene. |
|
An identifier string. May not contain ‘.’, spaces, newlines, or tabs |
Yes |
|
If set, the plane’s texture is multiplied with this color. Useful for applying a color grayscale images. |
|
Value of type ‘Color3’ |
Yes |
|
The name of the |
|
Value of type ‘String’ |
Yes |
|
The opacity of the screen space object. If 1, the object is completely opaque. If 0, the object is completely transparent. |
|
In range: ( 0,1 ) |
Yes |
|
Determines the position of this screen space plane in a coordinate system based on radius (meters), azimuth (radians), and elevation (radians). |
|
Value of type ‘Vector3 |
Yes |
|
If true, this screen space renderable is going to ignore the global blackout factor from the Render Engine and will always render at full opacity. If false, it will adhere to the factor and fade out like the rest of the 3D rendering. |
|
Value of type ‘Boolean’ |
Yes |
|
A scale factor for the plane that can be used to increase or decrease the visual size. The default size is determined separately for each screen space renderable type and may for example be affected by the size of an image being displayed. |
|
Value of type ‘Double’ |
Yes |
|
Defines either a single or multiple tags that apply to this |
|
Value of type ‘String’, or Value of type ‘Table’ |
Yes |
|
Determines whetether the z/radius values affects the size of the plane or not. |
|
Value of type ‘Boolean’ |
Yes |
|
Determines whether the location of this screen space plane will be specified using radius, azimuth and elevation (if ‘true’) or using Cartesian coordinates. The Cartesian coordinate system is useful if a regular rendering is applied, whereas the radius azimuth elevation are most useful in a planetarium environment. |
|
Value of type ‘Boolean’ |
Yes |