Class PanoramaTileMaterial

Hierarchy

Material
- PanoramaTileMaterial

Accessors

brightness

get brightness(): number
Returns number
- Defined in src/panorama/panoramaTileMaterial.ts:220
set brightness(value: number): void
Parameters
- value: number
Returns void
- Defined in src/panorama/panoramaTileMaterial.ts:224

contrast

get contrast(): number
Returns number
- Defined in src/panorama/panoramaTileMaterial.ts:212
set contrast(value: number): void
Parameters
- value: number
Returns void
- Defined in src/panorama/panoramaTileMaterial.ts:216

cursorColor

get cursorColor(): Color
The color of the cursor in the panorama tile.

Returns Color
- Defined in src/panorama/panoramaTileMaterial.ts:244
set cursorColor(value: Color): void
Parameters
- value: Color
Returns void
- Defined in src/panorama/panoramaTileMaterial.ts:248

cursorPosition

get cursorPosition(): Cartesian3
The position of the cursor in the panorama tile. Internal API to render the depth cursor. (-1, -1, -1) means no data is available. It should be a valid position in the panorama tiles cartesian coordinate system, scaled by the normalized depth.

Returns Cartesian3
- Defined in src/panorama/panoramaTileMaterial.ts:233
set cursorPosition(value: Cartesian3): void
Parameters
- value: Cartesian3
Returns void
- Defined in src/panorama/panoramaTileMaterial.ts:237

opacity

get opacity(): number
The global opacity of the panorama tile.

Returns number
- Defined in src/panorama/panoramaTileMaterial.ts:204
set opacity(value: number): void
Parameters
- value: number
Returns void
- Defined in src/panorama/panoramaTileMaterial.ts:208

overlay

get overlay(): PanoramaOverlayMode
Display the overlay on the panorama tile.

Returns PanoramaOverlayMode
- Defined in src/panorama/panoramaTileMaterial.ts:171
set overlay(value: PanoramaOverlayMode): void
Parameters
- value: PanoramaOverlayMode
Returns void
- Defined in src/panorama/panoramaTileMaterial.ts:175

overlayNaNColor

get overlayNaNColor(): Color
The color used where overlay values are 0.

Returns Color
- Defined in src/panorama/panoramaTileMaterial.ts:193
set overlayNaNColor(value: Color): void
Parameters
- value: Color
Returns void
- Defined in src/panorama/panoramaTileMaterial.ts:197

overlayOpacity

get overlayOpacity(): number
The opacity of the overlay on the panorama tile.

Returns number
- Defined in src/panorama/panoramaTileMaterial.ts:182
set overlayOpacity(value: number): void
Parameters
- value: number
Returns void
- Defined in src/panorama/panoramaTileMaterial.ts:186

showDebug

get showDebug(): boolean
Shows the debug overlay on the panorama tile.

Returns boolean
- Defined in src/panorama/panoramaTileMaterial.ts:154
set showDebug(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/panorama/panoramaTileMaterial.ts:158

Constructors

constructor

new PanoramaTileMaterial(
tileCoordinate: PanoramaTileCoordinate,
_tileSize: Size,
): PanoramaTileMaterial
Parameters
- tileCoordinate: PanoramaTileCoordinate
- _tileSize: Size
Returns PanoramaTileMaterial
Overrides Material.constructor
- Defined in src/panorama/panoramaTileMaterial.ts:125

Methods

destroy

destroy(): void
Destroys the WebGL resources held by this object. Destroying an object allows for deterministic release of WebGL resources, instead of relying on the garbage collector to destroy this object.

Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.

Returns void
Example
```
material = material && material.destroy();
```
Inherited from Material.destroy
- Defined in node_modules/@vcmap-cesium/engine/index.d.ts:38486

hasTexture

hasTexture(type: PanoramaResourceType): boolean
Parameters
- type: PanoramaResourceType
Returns boolean
- Defined in src/panorama/panoramaTileMaterial.ts:273

isDestroyed

isDestroyed(): boolean
Returns true if this object was destroyed; otherwise, false.

If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.

Returns boolean
True if this object was destroyed; otherwise, false.
Inherited from Material.isDestroyed
- Defined in node_modules/@vcmap-cesium/engine/index.d.ts:38475

isTranslucent

isTranslucent(): boolean
Gets whether or not this material is translucent.

Returns boolean
true if this material is translucent, false otherwise.
Inherited from Material.isTranslucent
- Defined in node_modules/@vcmap-cesium/engine/index.d.ts:38467

setTexture

setTexture<T extends PanoramaResourceType>(
type: T,
data: PanoramaResourceData<T>,
): void
Sets the texture for the given panorama resource type.
Type Parameters
- T extends PanoramaResourceType
Parameters
- type: T
- data: PanoramaResourceData<T>
Returns void
- Defined in src/panorama/panoramaTileMaterial.ts:257

update

update(context: Context): void
Internal cesium API to update the material.
Parameters
- context: Context
Returns void
- Defined in src/panorama/panoramaTileMaterial.ts:285

`Static`fromType

fromType(type: string, uniforms?: any): Material
Creates a new material using an existing material type.

Shorthand for: new Material({fabric : {type : type}});
Parameters
- type: string
  The base material type.
- Optionaluniforms: any
  Overrides for the default uniforms.
Returns Material
New material object.
Example
```
const material = Cesium.Material.fromType('Color', {
  color: new Cesium.Color(1.0, 0.0, 0.0, 1.0)
});
```
Inherited from Material.fromType
- Defined in node_modules/@vcmap-cesium/engine/index.d.ts:38450

`Static`fromTypeAsync

fromTypeAsync(type: string, uniforms?: any): Promise<Material>
Creates a new material using an existing material type and returns a promise that resolves when all of the material's resources have been loaded.
Parameters
- type: string
  The base material type.
- Optionaluniforms: any
  Overrides for the default uniforms.
Returns Promise<Material>
A promise that resolves to a new material object when all resources are loaded.
Example
```
const material = await Cesium.Material.fromTypeAsync('Image', {
   image: '../Images/Cesium_Logo_overlay.png'
});
```
Inherited from Material.fromTypeAsync
- Defined in node_modules/@vcmap-cesium/engine/index.d.ts:38462

Properties

magnificationFilter

magnificationFilter: TextureMagnificationFilter

The TextureMagnificationFilter to apply to this material's textures.

materials

materials: any

Maps sub-material names to Material objects.

minificationFilter

minificationFilter: TextureMinificationFilter

The TextureMinificationFilter to apply to this material's textures.

shaderSource

shaderSource: string

The glsl shader source for this material.

`Readonly`tileCoordinate

tileCoordinate: PanoramaTileCoordinate

translucent

translucent: boolean | ((...params: any[]) => any)

When true or a function that returns true, the geometry is expected to appear translucent.

type

type: string

The material type. Can be an existing type or a new type. If no type is specified in fabric, type is a GUID.

uniforms

uniforms: PanoramaTileMaterialUniforms

The uniforms used by the panorama tile material. These are not intended to be modified directly but rather through the provided properties.

`Static` `Readonly`AlphaMapType

AlphaMapType: string

Gets the name of the alpha map material.

`Static` `Readonly`AspectRampMaterialType

AspectRampMaterialType: string

Gets the name of the aspect ramp material.

`Static` `Readonly`BumpMapType

BumpMapType: string

Gets the name of the bump map material.

`Static` `Readonly`CheckerboardType

CheckerboardType: string

Gets the name of the checkerboard material.

`Static` `Readonly`ColorType

ColorType: string

Gets the name of the color material.

`Static`DefaultCubeMapId

DefaultCubeMapId: string

Gets or sets the default cube map texture uniform value.

`Static`DefaultImageId

DefaultImageId: string

Gets or sets the default texture uniform value.

`Static` `Readonly`DiffuseMapType

DiffuseMapType: string

Gets the name of the diffuce map material.

`Static` `Readonly`DotType

DotType: string

Gets the name of the dot material.

`Static` `Readonly`ElevationBandType

ElevationBandType: string

Gets the name of the elevation band material.

`Static` `Readonly`ElevationContourType

ElevationContourType: string

Gets the name of the elevation contour material.

`Static` `Readonly`ElevationRampType

ElevationRampType: string

Gets the name of the elevation contour material.

`Static` `Readonly`EmissionMapType

EmissionMapType: string

Gets the name of the emmision map material.

`Static` `Readonly`FadeType

FadeType: string

Gets the name of the fade material.

`Static` `Readonly`GridType

GridType: string

Gets the name of the grid material.

`Static` `Readonly`ImageType

ImageType: string

Gets the name of the image material.

`Static` `Readonly`NormalMapType

NormalMapType: string

Gets the name of the normal map material.

`Static` `Readonly`PolylineArrowType

PolylineArrowType: string

Gets the name of the polyline arrow material.

`Static` `Readonly`PolylineDashType

PolylineDashType: string

Gets the name of the polyline glow material.

`Static` `Readonly`PolylineGlowType

PolylineGlowType: string

Gets the name of the polyline glow material.

`Static` `Readonly`PolylineOutlineType

PolylineOutlineType: string

Gets the name of the polyline outline material.

`Static` `Readonly`RimLightingType

RimLightingType: string

Gets the name of the rim lighting material.

`Static` `Readonly`SlopeRampMaterialType

SlopeRampMaterialType: string

Gets the name of the slope ramp material.

`Static` `Readonly`SpecularMapType

SpecularMapType: string

Gets the name of the specular map material.

`Static` `Readonly`StripeType

StripeType: string

Gets the name of the stripe material.

`Static` `Readonly`WaterMaskType

WaterMaskType: string

Gets the name of the water mask material.

`Static` `Readonly`WaterType

WaterType: string

Gets the name of the water material.

Class PanoramaTileMaterial

Hierarchy

Index

Accessors

Constructors

Methods

Properties

Accessors

brightness

Returns number

Parameters

Returns void

contrast

Returns number

Parameters

Returns void

cursorColor

Returns Color

Parameters

Returns void

cursorPosition

Returns Cartesian3

Parameters

Returns void

opacity

Returns number

Parameters

Returns void

overlay

Returns PanoramaOverlayMode

Parameters

Returns void

overlayNaNColor

Returns Color

Parameters

Returns void

overlayOpacity

Returns number

Parameters

Returns void

showDebug

Returns boolean

Parameters

Returns void

Constructors

constructor

Parameters

Returns PanoramaTileMaterial

Methods

destroy

Returns void

Example

hasTexture

Parameters

Returns boolean

isDestroyed

Returns boolean

isTranslucent

Returns boolean

setTexture

Type Parameters

Parameters

Returns void

update

Parameters

Returns void

StaticfromType

Parameters

Returns Material

Example

StaticfromTypeAsync

Parameters

Returns Promise<Material>

Example

Properties

magnificationFilter

materials

minificationFilter

shaderSource

ReadonlytileCoordinate

`Static`fromType

`Static`fromTypeAsync

`Readonly`tileCoordinate

`Static` `Readonly`AlphaMapType

`Static` `Readonly`AspectRampMaterialType

`Static` `Readonly`BumpMapType

`Static` `Readonly`CheckerboardType

`Static` `Readonly`ColorType

`Static`DefaultCubeMapId

`Static`DefaultImageId

`Static` `Readonly`DiffuseMapType

`Static` `Readonly`DotType

`Static` `Readonly`ElevationBandType

`Static` `Readonly`ElevationContourType

`Static` `Readonly`ElevationRampType

`Static` `Readonly`EmissionMapType

`Static` `Readonly`FadeType

`Static` `Readonly`GridType

`Static` `Readonly`ImageType

`Static` `Readonly`NormalMapType

`Static` `Readonly`PolylineArrowType

`Static` `Readonly`PolylineDashType

`Static` `Readonly`PolylineGlowType

`Static` `Readonly`PolylineOutlineType

`Static` `Readonly`RimLightingType

`Static` `Readonly`SlopeRampMaterialType

`Static` `Readonly`SpecularMapType

`Static` `Readonly`StripeType

`Static` `Readonly`WaterMaskType

`Static` `Readonly`WaterType