UniformState

Members

<readonly> frameState :FrameState

Gets the current frame state.

Default Value:

• undefined

See:

• czm_frameNumber

Methods

getCurrentFrustum

Returns 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.

Returns:

Cartesian2 Returns the near distance and the far distance of the frustum defined by the camera.

See:

• czm_currentFrustum
• UniformState#getEntireFrustum

getEncodedCameraPositionMCHigh

Returns the high bits of the camera position used to define the czm_encodedCameraPositionMCHigh GLSL uniform.

Returns:

Cartesian3 The high bits of the camera position.

See:

• UniformState#getEncodedCameraPositionMCLow

getEncodedCameraPositionMCLow

Returns the low bits of the camera position used to define the czm_encodedCameraPositionMCLow GLSL uniform.

Returns:

Cartesian3 The low bits of the camera position.

See:

• UniformState#getEncodedCameraPositionMCHigh

getEntireFrustum

Returns 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.

Returns:

Cartesian2 Returns the near distance and the far distance of the frustum defined by the camera.

See:

• czm_entireFrustum
• UniformState#getCurrentFrustum

getEyeHeight2D

Returns 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.

Returns:

Cartesian2 Height and height squared above the 2D world plane for SCENE2D SceneMode.

See:

• czm_eyeHeight2D

getInfiniteProjection

DOC_TBA

Returns:

Matrix4 DOC_TBA.

See:

• UniformState#setInfiniteProjection
• czm_infiniteProjection

getInverseModel

Returns the inverse model matrix used to define the czm_inverseModel GLSL uniform.

Returns:

Matrix4 The inverse model matrix.

See:

• UniformState#setModel
• UniformState#getModel
• czm_inverseModel

getInverseModelView

Gets the inverse of the model-view matrix.

Returns:

Matrix4 The inverse of the model-view matrix.

See:

• czm_inverseModelView

getInverseModelView3D

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

Returns:

Matrix4 The inverse of the 3D model-view matrix.

See:

• czm_inverseModelView3D

getInverseModelViewProjection

Returns the inverse model-view-projection matrix.

Returns:

Matrix4 The inverse model-view-projection matrix.

See:

• czm_inverseModelViewProjection

getInverseNormal

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

Returns:

Matrix3 The inverse normal transformation matrix.

See:

• czm_inverseNormal

getInverseNormal3D

Gets 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#getInverseNormal, but in 2D and Columbus View it represents the normal transformation matrix as if the camera were at an equivalent location in 3D mode.

Returns:

Matrix3 The inverse normal transformation matrix.

See:

• czm_inverseNormal3D

getInverseProjection

DOC_TBA

Returns:

Matrix4 DOC_TBA.

See:

• czm_inverseProjection

getInverseView

Returns the 4x4 inverse-view matrix that transforms from eye to world coordinates.

Returns:

Matrix4 The 4x4 inverse-view matrix that transforms from eye to world coordinates.

See:

• czm_inverseView

getInverseView3D

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

Returns:

Matrix4 The 4x4 inverse-view matrix that transforms from eye to 3D world coordinates.

See:

• czm_inverseView3D

getInverseViewProjection

Returns the inverse view-projection matrix

Returns:

Matrix4 The inverse view-projection matrix.

See:

• czm_inverseViewProjection

getInverseViewRotation

Returns the 3x3 rotation matrix of the current inverse-view matrix (UniformState#getInverseView).

Returns:

Matrix3 The 3x3 rotation matrix of the current inverse-view matrix.

See:

• UniformState#getInverseView
• czm_inverseViewRotation

getInverseViewRotation3D

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

Returns:

Matrix3 The 3x3 rotation matrix of the current 3D inverse-view matrix.

See:

• UniformState#getInverseView3D
• czm_inverseViewRotation3D

getModel

DOC_TBA

Returns:

Matrix4 DOC_TBA.

See:

• UniformState#setModel
• czm_model

getModelView

Gets the model-view matrix.

Returns:

Matrix4 The model-view matrix.

See:

• czm_modelView

getModelView3D

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

Returns:

Matrix4 The 3D model-view matrix.

See:

• czm_modelView3D

getModelViewInfiniteProjection

DOC_TBA

Returns:

Matrix4 DOC_TBA.

See:

• czm_modelViewProjection

getModelViewProjection

DOC_TBA

Returns:

Matrix4 DOC_TBA.

See:

• czm_modelViewProjection

getModelViewProjectionRelativeToEye

Returns the model-view-projection relative to eye matrix used to define the czm_modelViewProjectionRelativeToEye GLSL uniform.

Returns:

Matrix4 The model-view-projection relative to eye matrix.

See:

• czm_modelViewProjectionRelativeToEye

getModelViewRelativeToEye

Returns the model-view relative to eye matrix used to define the czm_modelViewRelativeToEye GLSL uniform.

Returns:

Matrix4 The model-view relative to eye matrix.

See:

• czm_modelViewRelativeToEye

getMoonDirectionEC

Returns 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.

Returns:

Cartesian3 A normalized vector to the moon in eye coordinates at the current scene time.

See:

• czm_moonDirectionEC

getNormal

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

Returns:

Matrix3 The normal transformation matrix.

See:

• czm_normal

getNormal3D

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

Returns:

Matrix3 The normal transformation matrix.

See:

• czm_normal3D

getPixelSize

Returns the size of a pixel in meters at a distance of one meter from the camera.

Returns:

Number Returns the size of a pixel in meters at a distance of one meter from the camera.

See:

• czm_pixelSizeInMeters

getProjection

DOC_TBA

Returns:

Matrix4 DOC_TBA.

See:

• UniformState#setProjection
• czm_projection

getSunDirectionEC

Returns 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.

Returns:

Cartesian3 A normalized vector to the sun in eye coordinates at the current scene time.

See:

• czm_sunDirectionEC

getSunDirectionWC

Returns 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.

Returns:

Cartesian3 A normalized vector to the sun in 3D world coordinates at the current scene time.

See:

• czm_sunDirectionWC

getSunPositionColumbusView

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

Returns:

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

See:

• czm_sunPositionColumbusView

getSunPositionWC

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

Returns:

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

See:

• czm_sunPositionWC

getTemeToPseudoFixedMatrix

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

Returns:

Matrix3 The transform from TEME to pseudo-fixed.

See:

• czm_temeToPseudoFixed

getView

DOC_TBA

Returns:

Matrix4 DOC_TBA.

See:

• czm_view

getView3D

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

Returns:

Matrix4 The 3D view matrix.

See:

• czm_view3D

getViewportOrthographic

DOC_TBA

See:

• czm_viewportOrthographic

getViewportTransformation

DOC_TBA

See:

• czm_viewportTransformation

getViewProjection

DOC_TBA

Returns:

Matrix4 DOC_TBA.

See:

• czm_viewProjection

getViewRotation

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

Returns:

Matrix3 The 3x3 rotation matrix of the current view matrix.

See:

• UniformState#getView
• czm_viewRotation

getViewRotation3D

Returns the 3x3 rotation matrix of the current 3D view matrix (UniformState#getView3D).

Returns:

Matrix3 The 3x3 rotation matrix of the current 3D view matrix.

See:

• UniformState#getView3D
• czm_viewRotation3D

setModel

DOC_TBA

Parameters:

Name	Type	Argument	Description
matrix	Matrix4	<optional>	DOC_TBA.

See:

• UniformState#getModel
• czm_model

setViewport

DOC_TBA

Parameters:

Name	Type	Description
viewport	BoundingRectangle	DOC_TBA.

See:

• UniformState#getViewport
• czm_viewport

update

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.

Parameters:

Name	Type	Description
frameState	FrameState	The frameState to synchronize with.

updateFrustum

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.

Parameters:

Name	Type	Description
frustum	Object	The frustum to synchronize with.