Skip to content

KBE3D / KBCore / Cesium / ImageMaterialProperty

类: ImageMaterialProperty

A MaterialProperty that maps to image Material uniforms.

参数

Object with the following properties:

参数

A Property specifying the Image, URL, Canvas, or Video.

参数

A Cartesian2 Property specifying the number of times the image repeats in each direction.

参数

The color applied to the image

参数

Set to true when the image has transparency (for example, when a png has transparent sections)

属性

isConstant

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.


definitionChanged

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.


image

image: Property | undefined

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


repeat

repeat: Property | undefined

Gets or sets the Cartesian2 Property specifying the number of times the image repeats in each direction.


color

color: Property | undefined

Gets or sets the Color Property specifying the desired color applied to the image.


transparent

transparent: Property | undefined

Gets or sets the Boolean Property specifying whether the image has transparency

方法

getType()

getType(time: JulianDate): string

Gets the Material type at the provided time.

参数

time

JulianDate

The time for which to retrieve the type.

返回

string

The type of material.


getValue()

getValue(time?: JulianDate, result?: any): any

Gets the value of the property at the provided time.

参数

time?

JulianDate

The time for which to retrieve the value. If omitted, the current system time is used.

result?

any

The object to store the value into, if omitted, a new instance is created and returned.

返回

any

The modified result parameter or a new instance if the result parameter was not supplied.


equals()

equals(other?: Property): boolean

Compares this property to the provided property and returns <code>true</code> if they are equal, <code>false</code> otherwise.

参数

other?

Property

The other property.

返回

boolean

true if left and right are equal, false otherwise.

构造函数

构造函数

new ImageMaterialProperty(options?: { image?: string | Property | HTMLCanvasElement | HTMLVideoElement | HTMLImageElement; repeat?: Property | Cartesian2; color?: Color | Property; transparent?: boolean | Property; }): ImageMaterialProperty

参数

options?
image?

string | Property | HTMLCanvasElement | HTMLVideoElement | HTMLImageElement

repeat?

Property | Cartesian2

color?

Color | Property

transparent?

boolean | Property

返回

ImageMaterialProperty

KBE3D @3.0.0 Copyright © 2024-present KBE3D