UniformState

Members

backgroundColor : Color

The current background color

currentFrustum : Cartesian2

The near distance (x) and the far distance (y) of the frustum defined by the camera. This is the individual frustum used for multi-frustum rendering.

encodedCameraPositionMCHigh : Cartesian3

The high bits of the camera position.

encodedCameraPositionMCLow : Cartesian3

The low bits of the camera position.

entireFrustum : Cartesian2

The near distance (x) and the far distance (y) of the frustum defined by the camera. This is the largest possible frustum, not an individual frustum used for multi-frustum rendering.

eyeHeight2D : Cartesian2

The the height (x) and the height squared (y) in meters of the camera above the 2D world plane. This uniform is only valid when the SceneMode equal to SCENE2D.

fogDensity : Number

A scalar used to mix a color with the fog color based on the distance to the camera.

readonlyframeState : FrameState

frustumPlanes : Cartesian4

The distances to the frustum planes. The top, bottom, left and right distances are the x, y, z, and w components, respectively.

globeDepthTexture : Texture

imagerySplitPosition : Number

infiniteProjection : Matrix4

inverseModel : Matrix4

inverseModelView : Matrix4

inverseModelView3D : Matrix4

The inverse of the 3D model-view matrix. In 3D mode, this is equivalent to UniformState#inverseModelView. In 2D and Columbus View, however, it is a synthetic matrix based on the equivalent position of the camera in the 3D world.

inverseModelViewProjection : Matrix4

inverseNormal : Matrix3

An inverse 3x3 normal transformation matrix that transforms normal vectors in model coordinates to eye coordinates.

inverseNormal3D : Matrix3

An inverse 3x3 normal transformation matrix that transforms normal vectors in eye coordinates to 3D model coordinates. In 3D mode, this is identical to UniformState#inverseNormal, but in 2D and Columbus View it represents the normal transformation matrix as if the camera were at an equivalent location in 3D mode.

inverseProjection : Matrix4

inverseView : Matrix4

inverseView3D : Matrix4

the 4x4 inverse-view matrix that transforms from eye to 3D world coordinates. In 3D mode, this is identical to UniformState#inverseView, but in 2D and Columbus View it is a synthetic matrix based on the equivalent position of the camera in the 3D world.

inverseViewProjection : Matrix4

inverseViewRotation : Matrix3

inverseViewRotation3D : Matrix3

The 3x3 rotation matrix of the current 3D inverse-view matrix (UniformState#inverseView3D).

minimumDisableDepthTestDistance : Number

The distance from the camera at which to disable the depth test of billboards, labels and points to, for example, prevent clipping against terrain. When set to zero, the depth test should always be applied. When less than zero, the depth test should never be applied.

model : Matrix4

modelView : Matrix4

modelView3D : Matrix4

The 3D model-view matrix. In 3D mode, this is equivalent to UniformState#modelView. In 2D and Columbus View, however, it is a synthetic matrix based on the equivalent position of the camera in the 3D world.

modelViewInfiniteProjection : Matrix4

modelViewProjection : Matrix4

modelViewProjectionRelativeToEye : Matrix4

Model-view-projection relative to eye matrix.

modelViewRelativeToEye : Matrix4

Model-view relative to eye matrix.

moonDirectionEC : Cartesian3

A normalized vector to the moon in eye coordinates at the current scene time. In 3D mode, this returns the actual vector from the camera position to the moon position. In 2D and Columbus View, it returns the vector from the equivalent 3D camera position to the position of the moon in the 3D scene.

normal : Matrix3

A 3x3 normal transformation matrix that transforms normal vectors in model coordinates to eye coordinates.

normal3D : Matrix3

A 3x3 normal transformation matrix that transforms normal vectors in 3D model coordinates to eye coordinates. In 3D mode, this is identical to UniformState#normal, but in 2D and Columbus View it represents the normal transformation matrix as if the camera were at an equivalent location in 3D mode.

pass : Pass

projection : Matrix4

resolutionScale : Number

Gets the scaling factor for transforming from the canvas pixel space to canvas coordinate space.

sunDirectionEC : Cartesian3

A normalized vector to the sun in eye coordinates at the current scene time. In 3D mode, this returns the actual vector from the camera position to the sun position. In 2D and Columbus View, it returns the vector from the equivalent 3D camera position to the position of the sun in the 3D scene.

sunDirectionWC : Cartesian3

A normalized vector to the sun in 3D world coordinates at the current scene time. Even in 2D or Columbus View mode, this returns the position of the sun in the 3D scene.

sunPositionColumbusView : Cartesian3

The sun position in 2D world coordinates at the current scene time.

sunPositionWC : Cartesian3

The sun position in 3D world coordinates at the current scene time.

temeToPseudoFixedMatrix : Matrix3

A 3x3 matrix that transforms from True Equator Mean Equinox (TEME) axes to the pseudo-fixed axes at the Scene's current time.

view : Matrix4

view3D : Matrix4

The 3D view matrix. In 3D mode, this is identical to UniformState#view, but in 2D and Columbus View it is a synthetic matrix based on the equivalent position of the camera in the 3D world.

viewport : BoundingRectangle

viewProjection : Matrix4

viewRotation : Matrix3

The 3x3 rotation matrix of the current view matrix (UniformState#view).

viewRotation3D : Matrix3

Methods

update(frameState)

Synchronizes frame state with the uniform state. This is called by the Scene when rendering to ensure that automatic GLSL uniforms are set to the right value.

Name	Type	Description
frameState	FrameState	The frameState to synchronize with.

updateCamera(camera)

Synchronizes the frustum's state with the camera state. This is called by the Scene when rendering to ensure that automatic GLSL uniforms are set to the right value.

Name	Type	Description
camera	Object	The camera to synchronize with.

updateFrustum(frustum)

Synchronizes the frustum's state with the uniform state. This is called by the Scene when rendering to ensure that automatic GLSL uniforms are set to the right value.

Name	Type	Description
frustum	Object	The frustum to synchronize with.