Class: StripeMaterialProperty

StripeMaterialProperty

new StripeMaterialProperty(optionsopt)

A MaterialProperty that maps to stripe Material uniforms.
Parameters:
Name Type Attributes Description
options Object <optional>
 Object with the following properties:
Properties
Name Type Attributes Default Description
evenColor Property <optional>
 Color.WHITE A Property specifying the first Color.
oddColor Property <optional>
 Color.BLACK A Property specifying the second Color.
repeat Property <optional>
 1 A numeric Property specifying how many times the stripes repeat.
offset Property <optional>
 0 A numeric Property specifying how far into the pattern to start the material.
orientation Property <optional>
 StripeOrientation.HORIZONTAL A Property specifying the StripeOrientation.
Source:

Members

(readonly) definitionChanged :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.
Type:
Source:

evenColor :Property

Gets or sets the Property specifying the first Color.
Type:
Default Value:
  • Color.WHITE
Source:

(readonly) isConstant :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.
Type:
  • Boolean
Source:

oddColor :Property

Gets or sets the Property specifying the second Color.
Type:
Default Value:
  • Color.BLACK
Source:

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.
Type:
Default Value:
  • 0.0
Source:

orientation :Property

Gets or sets the Property specifying the StripeOrientation/
Type:
Default Value:
  • StripeOrientation.HORIZONTAL
Source:

repeat :Property

Gets or sets the numeric Property specifying how many times the stripes repeat.
Type:
Default Value:
  • 1.0
Source:

Methods

equals(otheropt) → {Boolean}

Compares this property to the provided property and returns true if they are equal, false otherwise.
Parameters:
Name Type Attributes Description
other Property <optional>
 The other property.
Source:
Returns:
true if left and right are equal, false otherwise.
Type
Boolean

getType(time) → {String}

Gets the Material type at the provided time.
Parameters:
Name Type Description
time JulianDate The time for which to retrieve the type.
Source:
Returns:
The type of material.
Type
String

getValue(time, resultopt) → {Object}

Gets the value of the property at the provided time.
Parameters:
Name Type Attributes 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.
Source:
Returns:
The modified result parameter or a new instance if the result parameter was not supplied.
Type
Object