RenderableVideoSphere

Inherits Renderable

Members

Name	Documentation	Type	Description	Optional
Segments	This value specifies the number of segments that the sphere is separated in	Integer	Value of type ‘Integer’	No
Size	This value specifies the radius of the sphere in meters	Double	Value of type ‘Double’	No
Video	This should point to the video file that should be played.	String	Value of type ‘String’	No
DisableFadeInOut	Enables/Disables the fade in and out effects	Boolean	Value of type ‘Boolean’	Yes
EndTime	The date and time that the video should end in the format ‘YYYY MM DD hh:mm:ss’.	Date and time	Value of type ‘Date and time’	Yes
FadeInThreshold	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	Double	Value of type ‘Double’	Yes
FadeOutThreshold	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	Double	In range: ( 0,1 )	Yes
LoopVideo	If checked, the video is continues playing from the start when it reaches the end of the video.	Boolean	Value of type ‘Boolean’	Yes
MirrorTexture	Mirror the texture along the x-axis	Boolean	Value of type ‘Boolean’	Yes
Orientation	Specifies whether the texture is applied to the inside of the sphere, the outside of the sphere, or both	String	In list { Outside, Inside, Both }	Yes
PlayAudio	Play audio	Boolean	Value of type ‘Boolean’	Yes
PlaybackMode	The mode of how the video should be played back. Default is video is played back according to the set start and end times.	String	In list { MapToSimulationTime, RealTimeLoop }	Yes
StartTime	The date and time that the video should start in the format ‘YYYY MM DD hh:mm:ss’.	Date and time	Value of type ‘Date and time’	Yes

Inherited members from Renderable

Name	Documentation	Type	Description	Optional
DimInAtmosphere	Enables/Disables if the object should be dimmed when the camera is in the sunny part of an atmosphere	Boolean	Value of type ‘Boolean’	Yes
Enabled	This setting determines whether this object will be visible or not	Boolean	Value of type ‘Boolean’	Yes
Opacity	This value determines the opacity of this renderable. A value of 0 means completely transparent	Double	In range: ( 0,1 )	Yes
RenderBinMode	This value specifies if the renderable should be rendered in the Background,Opaque, Pre/PostDeferredTransparency, or Overlay rendering step	String	In list { Background, Opaque, PreDeferredTransparent, PostDeferredTransparent, Overlay }	Yes
Tag	A single tag or a list of tags that this renderable will respond to when setting properties	Table, or String	Value of type ‘Table’, or Value of type ‘String’	Yes
Type	This tells the type of the renderable	String	Value of type ‘String’	Yes

Asset Examples

-- To learn how you can include your own video, see the wiki
-- http://wiki.openspaceproject.com/docs/builders/assets/resources.html

local Sphere = {
  Identifier = "ExampleVideoOnSphere",
  Renderable = {
    Type = "RenderableVideoSphere",
    Size = 100.0,
    Segments = 80,
    Video = asset.resource("examplevideo.mp4"),
    Orientation = "Both"
  },
  GUI = {
    Name = "Video Sphere Example",
    Path = "/Other/Spheres"
  }
}


asset.onInitialize(function()
    openspace.addSceneGraphNode(Sphere)
end)

asset.onDeinitialize(function()
  openspace.removeSceneGraphNode(Sphere)
end)

asset.export(Sphere)



asset.meta = {
  Name = "Video Player on Sphere Example",
  Version = "1.0",
  Description = "An example asset that shows how to include a video on a sphere.",
  Author = "OpenSpace Team",
  URL = "https://openspaceproject.com",
  License = "MIT"
}