UniformState

Methods

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.

Returns:

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

See:

• czm_entireFrustum

getFrameNumber

Gets the current frame number.

Returns:

number A number representing the current frame number.

See:

• czm_frameNumber

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

DOC_TBA

Returns:

Matrix4 DOC_TBA.

See:

• czm_inverseModelView

getInverseNormal

DOC_TBA

Returns:

Matrix3 DOC_TBA.

See:

• czm_inverseNormal

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

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

getModel

DOC_TBA

Returns:

Matrix4 DOC_TBA.

See:

• UniformState#setModel
• czm_model

getModelView

DOC_TBA

Returns:

Matrix4 DOC_TBA.

See:

• czm_modelView

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.

Returns:

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

See:

• czm_moonDirectionEC

getNormal

DOC_TBA

Returns:

Matrix3 DOC_TBA.

See:

• czm_normal

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.

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 world coordinates at the current scene time.

Returns:

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

See:

• czm_sunDirectionWC

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

getTime

Gets the scene's current time.

Returns:

JulianDate The scene's current time.

getView

DOC_TBA

Returns:

Matrix4 DOC_TBA.

See:

• czm_view

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

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.