ImageMaterialProperty

new Cesium.ImageMaterialProperty(options)
engine/Source/DataSources/ImageMaterialProperty.js 25

A MaterialProperty that maps to image Material uniforms.
Name Type Description
options object optional Object with the following properties:
Name Type Default Description
image Property | string | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement optional A Property specifying the Image, URL, Canvas, or Video.
repeat Property | Cartesian2 new Cartesian2(1.0, 1.0) optional A Cartesian2 Property specifying the number of times the image repeats in each direction.
color Property | Color Color.WHITE optional The color applied to the image
transparent Property | boolean false optional Set to true when the image has transparency (for example, when a png has transparent sections)

Members

color : Property|undefined
engine/Source/DataSources/ImageMaterialProperty.js 97

Gets or sets the Color Property specifying the desired color applied to the image.
Default Value: 1.0

readonly definitionChanged : Event
engine/Source/DataSources/ImageMaterialProperty.js 70

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.

image : Property|undefined
engine/Source/DataSources/ImageMaterialProperty.js 81

Gets or sets the Property specifying Image, URL, Canvas, or Video to use.

readonly isConstant : boolean
engine/Source/DataSources/ImageMaterialProperty.js 53

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.

repeat : Property|undefined
engine/Source/DataSources/ImageMaterialProperty.js 89

Gets or sets the Cartesian2 Property specifying the number of times the image repeats in each direction.
Default Value: new Cartesian2(1, 1)

transparent : Property|undefined
engine/Source/DataSources/ImageMaterialProperty.js 105

Gets or sets the Boolean Property specifying whether the image has transparency
Default Value: 1.0

Methods

equals(other) → boolean
engine/Source/DataSources/ImageMaterialProperty.js 163

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.

getType(time) → string
engine/Source/DataSources/ImageMaterialProperty.js 114

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.

getValue(time, result) → object
engine/Source/DataSources/ImageMaterialProperty.js 127

Gets the value of the property at the provided time.
Name Type Default Description
time JulianDate JulianDate.now() optional The time for which to retrieve the value. If omitted, the current system time is used.
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.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
packages/engine
packages/widgets