new FrameState
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
-
afterRender :Array
-
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 inupdate
functions.Example
frameState.afterRender.push(function() { // take some action, raise an event, etc. });
-
camera :Camera
-
The current camera.
- Default Value:
- undefined
-
creditDisplay :CreditDisplay
-
The credit display.
-
cullingVolume :CullingVolume
-
The culling volume.
- Default Value:
- undefined
-
frameNumber :Number
-
The current frame number.
- Default Value:
- 0
-
mode :SceneMode
-
The current mode of the scene.
- Default Value:
-
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.
- Default Value:
- SceneMode.SCENE3D.morphTime
-
occluder :Occluder
-
The current occluder.
- Default Value:
- undefined
-
time :JulianDate
-
The scene's current time.
- Default Value:
- undefined