Constructor
new Layer()
Constructs a layer. This constructor is meant to be called by subclasses and not directly by an application.
- Source:
Members
displayName :String
This layer's display name.
Type:
- String
- Default Value:
- "Layer"
- Source:
enabled :Boolean
Indicates whether to display this layer.
Type:
- Boolean
- Default Value:
- true
- Source:
(readonly) inCurrentFrame :Boolean
Indicates whether elements of this layer were drawn in the most recently generated frame.
Type:
- Boolean
- Source:
maxActiveAltitude :Number
The eye altitude below which this layer is displayed, in meters.
Type:
- Number
- Default Value:
- Number.MAX_VALUE (always displayed)
- Source:
minActiveAltitude :Number
The eye altitude above which this layer is displayed, in meters.
Type:
- Number
- Default Value:
- -Number.MAX_VALUE (always displayed)
- Source:
opacity :Number
This layer's opacity, which is combined with the opacity of shapes within layers.
Opacity is in the range [0, 1], with 1 indicating fully opaque.
Type:
- Number
- Default Value:
- 1
- Source:
pickEnabled :Boolean
Indicates whether this layer is pickable.
Type:
- Boolean
- Default Value:
- true
- Source:
time :Date
The time to display. This property selects the layer contents that represents the specified time.
If null, layer-type dependent contents are displayed.
Type:
- Date
- Source:
Methods
(protected) doRender(dc)
Subclass method called to display this layer. Subclasses should implement this method rather than the
render method, which determines enable, pick and active altitude status and does not
call this doRender method if the layer should not be displayed.
Parameters:
| Name | Type | Description |
|---|---|---|
dc |
DrawContext | The current draw context. |
- Source:
(protected) isLayerInView(dc) → {boolean}
Indicates whether this layer is within the current view. Subclasses may override this method and
when called determine whether the layer contents are visible in the current view frustum. The default
implementation always returns true.
Parameters:
| Name | Type | Description |
|---|---|---|
dc |
DrawContext | The current draw context. |
- Source:
Returns:
true If this layer is within the current view, otherwise false.
- Type
- boolean
refresh()
Refreshes the data associated with this layer. The behavior of this function varies with the layer
type. For image layers, it causes the images to be re-retrieved from their origin.
- Source:
render(dc)
Displays this layer. Subclasses should generally not override this method but should instead override the
doRender method. This method calls that method after verifying that the layer is
enabled, the eye point is within this layer's active altitudes and the layer is in view.
Parameters:
| Name | Type | Description |
|---|---|---|
dc |
DrawContext | The current draw context. |
- Source: