StripeMaterialProperty - Cesium Documentation

# StripeMaterialProperty

#### new StripeMaterialProperty(options)

  A `MaterialProperty` that maps to stripe `Material` uniforms.

  Name | Type | Description
  --- | --- | ---

  `options`

  Object

  optional Object with the following properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `evenColor` | Property | `Color.WHITE` | optional A Property specifying the first `Color`.
  `oddColor` | Property | `Color.BLACK` | optional A Property specifying the second `Color`.
  `repeat` | Property | `1` | optional A numeric Property specifying how many times the stripes repeat.
  `offset` | Property | `0` | optional A numeric Property specifying how far into the pattern to start the material.
  `orientation` | Property | `StripeOrientation.HORIZONTAL` | optional A Property specifying the `StripeOrientation`.

  Source: DataSources/StripeMaterialProperty.js, line 40

### Members

#### readonlydefinitionChanged :Event

  Gets the event that is raised whenever the definition of this property changes. The definition is considered to have changed if a call to getValue would return a different result for the same time.
  Source: DataSources/StripeMaterialProperty.js, line 94

#### evenColor :Property

  Gets or sets the Property specifying the first `Color`.
  Default Value: `Color.WHITE`
  Source: DataSources/StripeMaterialProperty.js, line 112

#### readonlyisConstant :Boolean

  Gets a value indicating if this property is constant. A property is considered constant if getValue always returns the same result for the current definition.
  Source: DataSources/StripeMaterialProperty.js, line 76

#### oddColor :Property

  Gets or sets the Property specifying the second `Color`.
  Default Value: `Color.BLACK`
  Source: DataSources/StripeMaterialProperty.js, line 119

#### offset :Property

  Gets or sets the numeric Property specifying the point into the pattern to begin drawing; with 0.0 being the beginning of the even color, 1.0 the beginning of the odd color, 2.0 being the even color again, and any multiple or fractional values being in between.
  Default Value: `0.0`
  Source: DataSources/StripeMaterialProperty.js, line 129

#### orientation :Property

  Gets or sets the Property specifying the `StripeOrientation`/
  Default Value: `StripeOrientation.HORIZONTAL`
  Source: DataSources/StripeMaterialProperty.js, line 105

#### repeat :Property

  Gets or sets the numeric Property specifying how many times the stripes repeat.
  Default Value: `1.0`
  Source: DataSources/StripeMaterialProperty.js, line 136

### Methods

#### equals(other) → Boolean

  Compares this property to the provided property and returns `true` if they are equal, `false` otherwise.

  Name | Type | Description
  --- | --- | ---
  `other` | Property | optional The other property.

  ##### Returns:

  `true` if left and right are equal, `false` otherwise.
  Source: DataSources/StripeMaterialProperty.js, line 175

#### getType(time) → String

  Gets the `Material` type at the provided time.

  Name | Type | Description
  --- | --- | ---
  `time` | JulianDate | The time for which to retrieve the type.

  ##### Returns:

  The type of material.
  Source: DataSources/StripeMaterialProperty.js, line 145

#### getValue(time, result) → Object

  Gets the value of the property at the provided time.

  Name | Type | Description
  --- | --- | ---
  `time` | JulianDate | The time for which to retrieve the value.
  `result` | Object | optional The object to store the value into, if omitted, a new instance is created and returned.

  ##### Returns:

  The modified result parameter or a new instance if the result parameter was not supplied.
  Source: DataSources/StripeMaterialProperty.js, line 156