FrameState

FrameState

new

State information about the current frame. An instance of this class is provided to update functions.

Parameters:
Name Type Description
creditDisplay CreditDisplay Handles adding and removing credits from an HTML element
Source:

Members

:Camera

The current camera.
Default Value:
  • undefined

:Cartesian2

The dimensions of the canvas.
Default Value:
  • Cartesian2(0.0, 0.0)

:CreditDisplay

The credit display.

:CullingVolume

The culling volume.
Default Value:
  • undefined

:Number

The current frame number.
Default Value:
  • 0

:SceneMode

The current mode of the scene.
Default Value:

:Number

The current morph transition time between 2D/Columbus View and 3D, with 0.0 being 2D or Columbus View and 1.0 being 3D.
Default Value:
  • SceneMode.SCENE3D.morphTime

:Occluder

The current occluder.
Default Value:
  • undefined

:JulianDate

The scene's current time.
Default Value:
  • undefined