PolylineColorAppearance - Cesium Documentation

# PolylineColorAppearance

#### new PolylineColorAppearance(options)

  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:

  - Cesium Sandcastle Polyline Color Appearance Demo
  Source: Scene/PolylineColorAppearance.js, line 60

### Members

#### staticconstantPolylineColorAppearance.VERTEX_FORMAT :VertexFormat

  The `VertexFormat` that all `PolylineColorAppearance` instances are compatible with. This requires only a `position` attribute.
  Source: Scene/PolylineColorAppearance.js, line 189

#### readonlyclosed :Boolean

  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`
  Source: Scene/PolylineColorAppearance.js, line 156

#### readonlyfragmentShaderSource :String

  The GLSL source code for the fragment shader.
  Source: Scene/PolylineColorAppearance.js, line 120

#### material :Material

  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`
  Source: Scene/PolylineColorAppearance.js, line 75

#### readonlyrenderState :Object

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

  Source: Scene/PolylineColorAppearance.js, line 138

#### translucent :Boolean

  When `true`, the geometry is expected to appear translucent so `PolylineColorAppearance#renderState` has alpha blending enabled.
  Default Value: `true`
  Source: Scene/PolylineColorAppearance.js, line 85

#### readonlyvertexFormat :VertexFormat

  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``
  Source: Scene/PolylineColorAppearance.js, line 174

#### readonlyvertexShaderSource :String

  The GLSL source code for the vertex shader.
  Source: Scene/PolylineColorAppearance.js, line 106

### Methods

#### getFragmentShaderSource()

  Procedurally creates the full GLSL fragment shader source.

  ##### Returns:

  String The full GLSL fragment shader source.
  Source: Scene/PolylineColorAppearance.js, line 198

#### getRenderState() → Object

  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.
  Source: Scene/PolylineColorAppearance.js, line 218

#### isTranslucent() → Boolean

  Determines if the geometry is translucent based on `PolylineColorAppearance#translucent`.

  ##### Returns:

  `true` if the appearance is translucent.
  Source: Scene/PolylineColorAppearance.js, line 207