RenderableTimeVaryingVolume

Inherits Renderable

Members

Name	Documentation	Type	Description	Optional
SecondsAfter	Specifies the number of seconds to show the the last timestep after its actual time	Double	Value of type ‘Double’	No
SourceDirectory	Specifies the path to load timesteps from	String	Value of type ‘String’	No
TransferFunction	Specifies the transfer function file path	String	Value of type ‘String’	No
Brightness	The volume renderer’s general brightness	Double	Value of type ‘Double’	Yes
ClipPlanes	@TODO Missing documentation	Table		Yes
GridType	Spherical or Cartesian grid	String	Value of type ‘String’	Yes
InvertDataAtZ	Specifies if you want to invert the volume data at it z-axis.	Boolean	Value of type ‘Boolean’	Yes
SecondsBefore	Specifies the number of seconds to show the first timestep before its actual time. The default value is 0	Double	Value of type ‘Double’	Yes
StepSize	Specifies how often to sample on the raycaster. Lower step -> higher resolution	Double	Value of type ‘Double’	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

-- Before using this example,
-- the volume data itself needs to be generated,
-- using the task 'data/tasks/volume/generate_cartesian.task'

local transforms = asset.require("scene/solarsystem/sun/transforms")



local SunRadius = 695508000

local Volume = {
  Identifier = "GeneratedVolumeCartesian",
  Parent = transforms.SolarSystemBarycenter.Identifier,
  Transform = {
    Scale = {
        Type = "StaticScale",
        Scale = 1000 * SunRadius
    }
  },
  Renderable = {
    Type = "RenderableTimeVaryingVolume",
    SourceDirectory = asset.resource("cartesian"),
    TransferFunction = asset.resource("../transferfunction.txt"),
    StepSize = 0.01,
    MinValue = 0,
    MaxValue = 1,
    GridType = "Cartesian",
    SecondsBefore = 50 * 365 * 24 * 60 * 60, -- 50 years before
    SecondsAfter = 50 * 365 * 24 * 60 * 60 -- 50 years after
  },
  GUI = {
    Path = "/Examples"
  }
}


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

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

asset.export(Volume)