new ImageMaterialProperty(optionsopt)
A
MaterialProperty
that maps to image Material
uniforms.
Parameters:
Name | Type | Attributes | Description | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
<optional> |
Object with the following properties:
Properties
|
Members
color :Property
Gets or sets the Color Property specifying the desired color applied to the image.
Type:
- Default Value:
- 1.0
- Source:
(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:
image :Property
Gets or sets the Property specifying Image, URL, Canvas, or Video to use.
Type:
(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
repeat :Property
Gets or sets the
Cartesian2
Property specifying the number of times the image repeats in each direction.
Type:
- Default Value:
- new Cartesian2(1, 1)
- Source:
transparent :Property
Gets or sets the Boolean Property specifying whether the image has transparency
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. |
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. |
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. |
Returns:
The modified result parameter or a new instance if the result parameter was not supplied.
- Type
- Object