RenderableTimeVaryingVolume

Inherits Renderable

Members

Name	Documentation	Type	Description	Optional
SecondsAfter	The number of seconds to show the the last timestep after its actual time.	Double	Value of type ‘Double’	No
SourceDirectory	A directory from where to load the data files for the different time steps.	Directory	Value of type ‘Directory’	No
TransferFunction	The path to the transfer function file.	File	Value of type ‘File’	No
Brightness	A value that affects the general brightness of the volume rendering.	Double	Value of type ‘Double’	Yes
ClipPlanes	@TODO Missing documentation	Table		Yes
DimInAtmosphere	Decides if the object should be dimmed (i.e. faded out) when the camera is in the sunny part of an atmosphere.	Boolean	Value of type ‘Boolean’	Yes
Enabled	Determines whether this object will be visible or not.	Boolean	Value of type ‘Boolean’	Yes
GridType	The grid type to use for the volume.	String	In list { Spherical, Cartesian }	Yes
InvertDataAtZ	If true, the volume data will be inverted at its z-axis.	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	A value that specifies if the renderable should be rendered in the Background, Opaque, Pre-/PostDeferredTransparency, Overlay, or Sticker rendering step.	String	In list { Background, Opaque, PreDeferredTransparent, Overlay, PostDeferredTransparent, Sticker }	Yes
SecondsBefore	The number of seconds to show the first timestep before its actual time.	Double	Value of type ‘Double’	Yes
StepSize	Specifies how often to sample during raycasting. Lower step size leads to higher resolution.	Double	Value of type ‘Double’	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	The type of the renderable.	String	Value of type ‘String’	Yes

Inherited members from Renderable

Name	Documentation	Type	Description	Optional
DimInAtmosphere	Decides if the object should be dimmed (i.e. faded out) when the camera is in the sunny part of an atmosphere.	Boolean	Value of type ‘Boolean’	Yes
Enabled	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	A value that specifies if the renderable should be rendered in the Background, Opaque, Pre-/PostDeferredTransparency, Overlay, or Sticker rendering step.	String	In list { Background, Opaque, PreDeferredTransparent, Overlay, PostDeferredTransparent, Sticker }	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	The type of the renderable.	String	Value of type ‘String’	Yes

Asset Examples

-- Before using this asset, the volume data itself needs to be generated,
-- using the task 'data/tasks/volume/debristasks/generate_debris_volume.task'

local earthAsset = asset.require("scene/solarsystem/planets/earth/transforms")



local MaxApogee = 10946320

local DebrisVolumeSpherical = {
  Identifier = "DebrisVolumeSpherical",
  Parent = earthAsset.EarthInertial.Identifier,
  Transform = {
    Scale = {
      Type = "StaticScale",
      Scale = MaxApogee
    }
  },
  Renderable = {
    Type = "RenderableTimeVaryingVolume",
    SourceDirectory = asset.resource("generated"),
    TransferFunction = asset.resource("transferfunction.txt"),
    StepSize = 0.01,
    MinValue = 0,
    MaxValue = 1,
    GridType = "Spherical",
    SecondsBefore = 50 * openspace.time.secondsPerYear(),
    SecondsAfter = 50 * openspace.time.secondsPerYear()
  },
  GUI = {
    Name = "DebrisVolume - Spherical",
    Path = "/Volumes"
  }
}


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

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

asset.export(DebrisVolumeSpherical)



asset.meta = {
  Name = "Satellites Debris - Volume Spherical",
  Description = "Satellites asset for Debris - Volume Spherical. Example asset",
  Author = "OpenSpace Team",
  URL = "",
  License = "MIT"
}