DebugAppearance - Cesium Documentation

DebugAppearance

new DebugAppearance

Visualizes a vertex attribute by displaying it as a color for debugging.

Components for well-known unit-length vectors, i.e., normal, binormal, and tangent, are scaled and biased from [-1.0, 1.0] to (-1.0, 1.0).

Parameters:

Name	Type	Argument	Default	Description
`options.attributeName`	String			The name of the attribute to visualize.
`options.glslDatatype`	String	<optional>	'vec3'	The GLSL datatype of the attribute. Supported datatypes are `float`, `vec2`, `vec3`, and `vec4`.
`options.vertexShaderSource`	String	<optional>	undefined	Optional GLSL vertex shader source to override the default vertex shader.
`options.fragmentShaderSource`	String	<optional>	undefined	Optional GLSL fragment shader source to override the default fragment shader.
`options.renderState`	RenderState	<optional>	undefined	Optional render state to override the default render state.

Throws:

DeveloperError : options.glslDatatype must be float, vec2, vec3, or vec4.

Example

var primitive = new Cesium.Primitive({
  geometryInstances : // ...
  appearance : new Cesium.DebugAppearance({
    attributeName : 'normal'
  })
});

Source:

/Source/Scene/DebugAppearance.js

Members

<readonly> attributeName :String

The name of the attribute being visualized.

<readonly> closed

When true, the geometry is expected to be closed.

Default Value:

false

<readonly> fragmentShaderSource :String

The GLSL source code for the fragment shader.

getFragmentShaderSource

Returns the full GLSL fragment shader source, which for DebugAppearance is just DebugAppearance#fragmentShaderSource.

getRenderState

Creates a render state. This is not the final RenderState instance; instead, it can contain a subset of render state properties identical to renderState passed to Context#createRenderState.

<readonly> glslDatatype :String

The GLSL datatype of the attribute being visualized.

isTranslucent

Determines if the geometry is translucent based on DebugAppearance#translucent.

material :Material

This property is part of the Appearance interface, but is not used by DebugAppearance since a fully custom fragment shader is used.

Default Value:

undefined

<readonly> renderState :Object

The render state. This is not the final RenderState instance; instead, it can contain a subset of render state properties identical to renderState passed to Context#createRenderState.

<readonly> translucent

When true, the geometry is expected to appear translucent.

Default Value:

false

<readonly> vertexShaderSource :String

The GLSL source code for the vertex shader.