PolylineColorAppearance

new Cesium.PolylineColorAppearance(options)
Scene/PolylineColorAppearance.js 60

An appearance for GeometryInstance instances with color attributes and PolylineGeometry. This allows several geometry instances, each with a different color, to be drawn with the same Primitive.
Name Type Description
options Object optional Object with the following properties:
Name Type Default Description
translucent Boolean true optional When true, the geometry is expected to appear translucent so PolylineColorAppearance#renderState has alpha blending enabled.
vertexShaderSource String optional Optional GLSL vertex shader source to override the default vertex shader.
fragmentShaderSource String optional Optional GLSL fragment shader source to override the default fragment shader.
renderState RenderState optional Optional render state to override the default render state.
Example:
// A solid white line segment
var primitive = new Cesium.Primitive({
  geometryInstances : new Cesium.GeometryInstance({
    geometry : new Cesium.PolylineGeometry({
      positions : Cesium.Cartesian3.fromDegreesArray([
        0.0, 0.0,
        5.0, 0.0
      ]),
      width : 10.0,
      vertexFormat : Cesium.PolylineColorAppearance.VERTEX_FORMAT
    }),
    attributes : {
      color : Cesium.ColorGeometryInstanceAttribute.fromColor(new Cesium.Color(1.0, 1.0, 1.0, 1.0))
    }
  }),
  appearance : new Cesium.PolylineColorAppearance({
    translucent : false
  })
});
Demo:

Members

staticconstantCesium.PolylineColorAppearance.VERTEX_FORMAT : VertexFormat
Scene/PolylineColorAppearance.js 189

The VertexFormat that all PolylineColorAppearance instances are compatible with. This requires only a position attribute.

readonlyclosed : Boolean
Scene/PolylineColorAppearance.js 156

When true, the geometry is expected to be closed so PolylineColorAppearance#renderState has backface culling enabled. This is always false for PolylineColorAppearance.
Default Value: false

readonlyfragmentShaderSource : String
Scene/PolylineColorAppearance.js 120

The GLSL source code for the fragment shader.

material : Material
Scene/PolylineColorAppearance.js 75

This property is part of the Appearance interface, but is not used by PolylineColorAppearance since a fully custom fragment shader is used.
Default Value: undefined

readonlyrenderState : Object
Scene/PolylineColorAppearance.js 138

The WebGL fixed-function state to use when rendering the geometry.

The render state can be explicitly defined when constructing a PolylineColorAppearance instance, or it is set implicitly via PolylineColorAppearance#translucent.

translucent : Boolean
Scene/PolylineColorAppearance.js 85

When true, the geometry is expected to appear translucent so PolylineColorAppearance#renderState has alpha blending enabled.
Default Value: true

readonlyvertexFormat : VertexFormat
Scene/PolylineColorAppearance.js 174

The VertexFormat that this appearance instance is compatible with. A geometry can have more vertex attributes and still be compatible - at a potential performance cost - but it can't have less.
Default Value: PolylineColorAppearance.VERTEX_FORMAT

readonlyvertexShaderSource : String
Scene/PolylineColorAppearance.js 106

The GLSL source code for the vertex shader.

Methods

getFragmentShaderSource() → String
Scene/PolylineColorAppearance.js 198

Procedurally creates the full GLSL fragment shader source.
Returns:
The full GLSL fragment shader source.

getRenderState() → Object
Scene/PolylineColorAppearance.js 218

Creates a render state. This is not the final render state instance; instead, it can contain a subset of render state properties identical to the render state created in the context.
Returns:
The render state.

isTranslucent() → Boolean
Scene/PolylineColorAppearance.js 207

Determines if the geometry is translucent based on PolylineColorAppearance#translucent.
Returns:
true if the appearance is translucent.