RenderableVideoPlane
Inherits Renderable
Members
Name |
Documentation |
Type |
Description |
Optional |
|---|---|---|---|---|
|
The size of the plane in meters. |
|
Value of type ‘Double’, or Value of type ‘Vector2 |
No |
|
The video file that is played. |
|
Value of type ‘File’ |
No |
|
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. |
|
Value of type ‘Boolean’ |
Yes |
|
Specifies whether the plane should be a billboard, which means that it is always facing the camera. If it is not, it can be oriented using other transformations. |
|
Value of type ‘Boolean’ |
Yes |
|
Determines the blending mode that is applied to this plane. |
|
In list { Normal, Additive } |
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 |
|
If checked, the video is continues playing from the start when it reaches the end of the video. |
|
Value of type ‘Boolean’ |
Yes |
|
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. |
|
Value of type ‘Boolean’ |
Yes |
|
An RGB color to multiply with the plane’s texture. Useful for applying a color to grayscale images. |
|
Value of type ‘Color3’ |
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 |
|---|---|---|---|---|
|
Decides if the object should be dimmed (i.e. faded out) when the camera is in the sunny part of an atmosphere. |
|
Value of type ‘Boolean’ |
Yes |
|
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 |
|
A value that specifies if the renderable should be rendered in the Background, Opaque, Pre-/PostDeferredTransparency, Overlay, or Sticker 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 |
|
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 transforms = asset.require("scene/solarsystem/planets/earth/transforms")
5
6
7
8local Plane = {
9 Identifier = "VideoPlaneExample",
10 Parent = transforms.EarthCenter.Identifier,
11 Transform = {
12 Translation = {
13 Type = "StaticTranslation",
14 Position = { 0.0, -11E7, 0.0 }
15 }
16 },
17 Renderable = {
18 Type = "RenderableVideoPlane",
19 MirrorBackside = true,
20 Size = 3E7,
21 Video = asset.resource("examplevideo.mp4"),
22 },
23 GUI = {
24 Name = "Video Plane Example",
25 Path = "/Other/Planes"
26 }
27}
28
29
30asset.onInitialize(function()
31 openspace.addSceneGraphNode(Plane)
32end)
33
34asset.onDeinitialize(function()
35 openspace.removeSceneGraphNode(Plane)
36end)
37
38asset.export(Plane)
39
40
41
42asset.meta = {
43 Name = "Video Plane Example",
44 Description = "An example asset that shows how to include a video on a plane.",
45 Author = "OpenSpace Team",
46 URL = "https://openspaceproject.com",
47 License = "MIT"
48}