ScreenSpaceImageLocal
Inherits ScreenSpaceRenderable
Members
Name |
Documentation |
Type |
Description |
Optional |
---|---|---|---|---|
|
Specifies the GUI name of the ScreenspaceImage |
|
Value of type ‘String’ |
Yes |
|
Sets the path 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 |
|
Value of type ‘String’ |
Yes |
Inherited members from ScreenSpaceRenderable
Name |
Documentation |
Type |
Description |
Optional |
---|---|---|---|---|
|
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 |
|
Must name a valid Screenspace renderable |
No |
|
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 |
|
Value of type ‘Color4’ |
Yes |
|
Sets the color of the border |
|
Value of type ‘Color3’ |
Yes |
|
The width of the border |
|
Greater than: 0 |
Yes |
|
This value determines the position of this screen space plane in Cartesian three-dimensional coordinates (meters) |
|
Value of type ‘Vector3 |
Yes |
|
This setting determines whether this sceen space plane will be visible or not |
|
Value of type ‘Boolean’ |
Yes |
|
If enabled, the local rotation is applied after the plane is rotated to face the camera |
|
Value of type ‘Boolean’ |
Yes |
|
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 |
|
Value of type ‘Double’ |
Yes |
|
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. |
|
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 |
|
Specifies the name of this screenspace renderable. This does not have to be unique to the scene, but it is recommended to be |
|
Value of type ‘String’ |
Yes |
|
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 |
|
In range: ( 0,1 ) |
Yes |
|
Sets the gamma correction of the texture |
|
Value of type ‘Vector3 |
Yes |
|
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 |
|
Value of type ‘Boolean’ |
Yes |
|
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 |
|
Value of type ‘Double’ |
Yes |
|
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 |
|
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 |
|
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 |
|
Value of type ‘Boolean’ |
Yes |
Asset Examples
1local icons = asset.resource({
2 Name = "Icons",
3 Type = "HttpSynchronization",
4 Identifier = "icons",
5 Version = 1
6})
7
8
9local marker = {
10 Identifier = "target-marker",
11 Name = "Target Marker",
12 Type = "ScreenSpaceImageLocal",
13 TexturePath = icons .. "target.png"
14}
15
16
17asset.onInitialize(function()
18 openspace.addScreenSpaceRenderable(marker)
19end)
20
21asset.onDeinitialize(function()
22 openspace.removeScreenSpaceRenderable(marker)
23end)