PolylineMaterialAppearance - Cesium Documentation

# PolylineMaterialAppearance

#### new PolylineMaterialAppearance(options)

  An appearance for `PolylineGeometry` that supports shading with materials.

  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 `PolylineMaterialAppearance#renderState` has alpha blending enabled.
  `material` | Material | `Material.ColorType` | optional The material used to determine the fragment color.
  `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:

      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.PolylineMaterialAppearance.VERTEX_FORMAT
          })
        }),
        appearance : new Cesium.PolylineMaterialAppearance({
          material : Cesium.Material.fromType('Color')
        })
      });

  ##### Demo:

  - Cesium Sandcastle Polyline Material Appearance Demo

  ##### See:

  - Fabric
  Source: Scene/PolylineMaterialAppearance.js, line 60

### Members

#### staticconstantPolylineMaterialAppearance.VERTEX_FORMAT :VertexFormat

  The `VertexFormat` that all `PolylineMaterialAppearance` instances are compatible with. This requires `position` and `st` attributes.
  Source: Scene/PolylineMaterialAppearance.js, line 192

#### readonlyclosed :Boolean

  When `true`, the geometry is expected to be closed so `PolylineMaterialAppearance#renderState` has backface culling enabled. This is always `false` for `PolylineMaterialAppearance`.
  Default Value: `false`
  Source: Scene/PolylineMaterialAppearance.js, line 159

#### readonlyfragmentShaderSource :String

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

#### material :Material

  The material used to determine the fragment color. Unlike other `PolylineMaterialAppearance` properties, this is not read-only, so an appearance's material can change on the fly.
  Default Value: ``Material.ColorType``

  ##### See:

  - Fabric
  Source: Scene/PolylineMaterialAppearance.js, line 77

#### readonlyrenderState :Object

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

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

  Source: Scene/PolylineMaterialAppearance.js, line 141

#### translucent :Boolean

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

#### 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: ``PolylineMaterialAppearance.VERTEX_FORMAT``
  Source: Scene/PolylineMaterialAppearance.js, line 177

#### readonlyvertexShaderSource :String

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

### Methods

#### getFragmentShaderSource()

  Procedurally creates the full GLSL fragment shader source. For `PolylineMaterialAppearance`, this is derived from `PolylineMaterialAppearance#fragmentShaderSource` and `PolylineMaterialAppearance#material`.

  ##### Returns:

  String The full GLSL fragment shader source.
  Source: Scene/PolylineMaterialAppearance.js, line 202

#### 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/PolylineMaterialAppearance.js, line 222

#### isTranslucent() → Boolean

  Determines if the geometry is translucent based on `PolylineMaterialAppearance#translucent` and `Material#isTranslucent`.

  ##### Returns:

  `true` if the appearance is translucent.
  Source: Scene/PolylineMaterialAppearance.js, line 211