RenderableVideoSphere
Inherits Renderable
Members
Name |
Documentation |
Type |
Description |
Optional |
---|---|---|---|---|
|
This value specifies the number of segments that the sphere is separated in |
|
Value of type ‘Integer’ |
No |
|
This value specifies the radius of the sphere in meters |
|
Value of type ‘Double’ |
No |
|
This should point to the video file that should be played. |
|
Value of type ‘String’ |
No |
|
Enables/Disables the fade in and out effects |
|
Value of type ‘Boolean’ |
Yes |
|
The date and time that the video should end in the format ‘YYYY MM DD hh:mm:ss’. |
|
Value of type ‘Date and time’ |
Yes |
|
This value determines the distance from center of MilkyWay from where the astronomical object starts to fade in, given as a percentage of the size of the object. A negative or zero value means no fading in will happen. This is also the default |
|
Value of type ‘Double’ |
Yes |
|
This value determines percentage of the sphere that is visible before starting to fade it out. A negative or zero value means no fading out will happen. This is also the default |
|
In range: ( 0,1 ) |
Yes |
|
If checked, the video is continues playing from the start when it reaches the end of the video. |
|
Value of type ‘Boolean’ |
Yes |
|
Mirror the texture along the x-axis |
|
Value of type ‘Boolean’ |
Yes |
|
Specifies whether the texture is applied to the inside of the sphere, the outside of the sphere, or both |
|
In list { Outside, Inside, Both } |
Yes |
|
Play audio |
|
Value of type ‘Boolean’ |
Yes |
|
The mode of how the video should be played back. Default is video is played back according to the set start and end times. |
|
In list { MapToSimulationTime, RealTimeLoop } |
Yes |
|
The date and time that the video should start in the format ‘YYYY MM DD hh:mm:ss’. |
|
Value of type ‘Date and time’ |
Yes |
Inherited members from Renderable
Name |
Documentation |
Type |
Description |
Optional |
---|---|---|---|---|
|
Enables/Disables if the object should be dimmed when the camera is in the sunny part of an atmosphere |
|
Value of type ‘Boolean’ |
Yes |
|
This setting determines whether this object will be visible or not |
|
Value of type ‘Boolean’ |
Yes |
|
This value determines the opacity of this renderable. A value of 0 means completely transparent |
|
In range: ( 0,1 ) |
Yes |
|
This value specifies if the renderable should be rendered in the Background,Opaque, Pre/PostDeferredTransparency, or Overlay rendering step |
|
In list { Background, Opaque, PreDeferredTransparent, PostDeferredTransparent, Overlay } |
Yes |
|
A single tag or a list of tags that this renderable will respond to when setting properties |
|
Value of type ‘Table’, or Value of type ‘String’ |
Yes |
|
This tells the type of the renderable |
|
Value of type ‘String’ |
Yes |
Asset Examples
1-- To learn how you can include your own video, see the wiki
2-- http://wiki.openspaceproject.com/docs/builders/assets/resources.html
3
4local Sphere = {
5 Identifier = "ExampleVideoOnSphere",
6 Renderable = {
7 Type = "RenderableVideoSphere",
8 Size = 100.0,
9 Segments = 80,
10 Video = asset.resource("examplevideo.mp4"),
11 Orientation = "Both"
12 },
13 GUI = {
14 Name = "Video Sphere Example",
15 Path = "/Other/Spheres"
16 }
17}
18
19
20asset.onInitialize(function()
21 openspace.addSceneGraphNode(Sphere)
22end)
23
24asset.onDeinitialize(function()
25 openspace.removeSceneGraphNode(Sphere)
26end)
27
28asset.export(Sphere)
29
30
31
32asset.meta = {
33 Name = "Video Player on Sphere Example",
34 Version = "1.0",
35 Description = "An example asset that shows how to include a video on a sphere.",
36 Author = "OpenSpace Team",
37 URL = "https://openspaceproject.com",
38 License = "MIT"
39}