FrameState

new FrameState(creditDisplay)

State information about the current frame. An instance of this class is provided to update functions.
Name Type Description
creditDisplay CreditDisplay Handles adding and removing credits from an HTML element
Source: Scene/FrameState.js, line 17

Members

afterRender :Function[]

An array of functions to be called at the end of the frame. This array will be cleared after each frame.

This allows queueing up events in update functions and firing them at a time when the subscribers are free to change the scene state, e.g., manipulate the camera, instead of firing events directly in update functions.

Example:
frameState.afterRender.push(function() {
  // take some action, raise an event, etc.
});
Source: Scene/FrameState.js, line 116

camera :Camera

The current camera.
Default Value: undefined
Source: Scene/FrameState.js, line 62

creditDisplay :CreditDisplay

The credit display.
Source: Scene/FrameState.js, line 97

cullingVolume :CullingVolume

The culling volume.
Default Value: undefined
Source: Scene/FrameState.js, line 69

frameNumber :Number

The current frame number.
Default Value: 0
Source: Scene/FrameState.js, line 39

mode :SceneMode

The current mode of the scene.
Default Value: SceneMode.SCENE3D
Source: Scene/FrameState.js, line 23

morphTime :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.
Source: Scene/FrameState.js, line 31

occluder :Occluder

The current occluder.
Default Value: undefined
Source: Scene/FrameState.js, line 76

time :JulianDate

The scene's current time.
Default Value: undefined
Source: Scene/FrameState.js, line 47