Class: SurfaceImage

SurfaceImage(sector, imageSource)

Represents an image drawn on the terrain.

Constructor

new SurfaceImage(sector, imageSource)

Constructs a surface image shape for a specified sector and image path.
Parameters:
Name Type Description
sector Sector The sector spanned by this surface image.
imageSource String | ImageSource The image source of the image to draw on the terrain. May be either a string identifying the URL of the image, or an ImageSource object identifying a dynamically created image.
Source:
Throws:
If either the specified sector or image source is null or undefined.
Type
ArgumentError

Extends

Members

_imageSource :String

The path to the image.
Type:
  • String
Source:

displayName :string

This surface image's display name;
Type:
  • string
Source:

enabled :boolean

Indicates whether this surface image is drawn.
Type:
  • boolean
Default Value:
  • true
Source:

imageSource :String|ImageSource

The source of the image to display. May be either a string identifying the URL of the image, or an ImageSource object identifying a dynamically created image.
Type:
Default Value:
  • null
Source:

opacity :number

This surface image's opacity. When this surface image is drawn, the actual opacity is the product of this opacity and the opacity of the layer containing this surface image.
Type:
  • number
Source:

sector :Sector

The sector spanned by this surface tile.
Type:
Inherited From:
Source:

Methods

applyInternalTransform(dc, matrix)

Applies this surface tile's internal transform, typically a texture transform to align the associated resource with the terrain. Subclasses must override this function.
Parameters:
Name Type Description
dc DrawContext The current draw context.
matrix Matrix The transform to apply.
Overrides:
Source:

bind(dc) → {Boolean}

Causes this surface tile to be active, typically by binding the tile's texture in WebGL. Subclasses must override this function.
Parameters:
Name Type Description
dc DrawContext The current draw context.
Overrides:
Source:
Returns:
true if the resource was successfully bound, otherwise false.
Type
Boolean

render(dc)

Displays this surface image. Called by the layer containing this surface image.
Parameters:
Name Type Description
dc DrawContext The current draw context.
Source: