Class: PolylineColorAppearance

PolylineColorAppearance

new PolylineColorAppearance(optionsopt)

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.
Parameters:
Name Type Attributes Description
options Object <optional>
 Object with the following properties:
Properties
Name Type Attributes Default Description
translucent Boolean <optional>
 true 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.
Source:
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
  })
});

Members

(static, constant) VERTEX_FORMAT :VertexFormat

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

(readonly) closed :Boolean

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

(readonly) fragmentShaderSource :String

The GLSL source code for the fragment shader.
Type:
  • String
Source:

material :Material

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

(readonly) renderState :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.

Type:
  • Object
Source:

translucent :Boolean

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

(readonly) vertexFormat :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.
Type:
Default Value:
Source:

(readonly) vertexShaderSource :String

The GLSL source code for the vertex shader.
Type:
  • String
Source:

Methods

getFragmentShaderSource() → {String}

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

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.
Source:
Returns:
The render state.
Type
Object

isTranslucent() → {Boolean}

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