Class: KmlCamera

KmlCamera(options)

Contains the data associated with Camera node.

Constructor

new KmlCamera(options)

Constructs an KmlCamera. Applications usually don't call this constructor. It is called by KmlFile as objects from Kml file are read. This object is already concrete implementation.
Parameters:
Name Type Description
options Object
Properties
Name Type Description
objectNode Node Node representing camera in the document.
Source:
See:
Throws:
If the node is null or undefined.
Type
ArgumentError

Extends

Members

displayName :String

The display name of the renderable.
Type:
  • String
Inherited From:
Default Value:
  • "Renderable"
Source:

enabled :Boolean

Indicates whether to display this renderable.
Type:
  • Boolean
Inherited From:
Default Value:
  • true
Source:

(readonly) id :String

Every object, which is part of the KML document has its identity. We will use it for changes in the document for binding.
Type:
  • String
Inherited From:
Source:

(readonly) kmlAltitude :String

Distance of the camera from the earth's surface, in meters. Interpreted according to the Camera's <altitudeMode> or <gx:altitudeMode>.
Type:
  • String
Source:

(readonly) kmlAltitudeMode :String

Specifies how the <altitude> specified for the Camera is interpreted. Possible values are as follows: relativeToGround - (default) Interprets the <altitude> as a value in meters above the ground. If the point is over water, the <altitude> will be interpreted as a value in meters above sea level. See <gx:altitudeMode> below to specify points relative to the sea floor. clampToGround - For a camera, this setting also places the camera relativeToGround, since putting the camera exactly at terrain height would mean that the eye would intersect the terrain (and the view would be blocked). absolute - Interprets the <altitude> as a value in meters above sea level.
Type:
  • String
Source:

(readonly) kmlHeading :String

Direction (azimuth) of the camera, in degrees. Default=0 (true North). (See diagram.) Values range from 0 to 360 degrees.
Type:
  • String
Source:

(readonly) kmlLatitude :String

Latitude of the virtual camera. Degrees north or south of the Equator (0 degrees). Values range from -90 degrees to 90 degrees.
Type:
  • String
Source:

(readonly) kmlLongitude :String

Longitude of the virtual camera (eye point). Angular distance in degrees, relative to the Prime Meridian. Values west of the Meridian range from +-180 to 0 degrees. Values east of the Meridian range from 0 to 180 degrees.
Type:
  • String
Source:

(readonly) kmlRoll :String

Rotation, in degrees, of the camera around the Z axis. Values range from -180 to +180 degrees.
Type:
  • String
Source:

(readonly) kmlTilt :String

Rotation, in degrees, of the camera around the X axis. A value of 0 indicates that the view is aimed straight down toward the earth (the most common case). A value for 90 for <tilt> indicates that the view is aimed toward the horizon. Values greater than 90 indicate that the view is pointed up into the sky. Values for <tilt> are clamped at +180 degrees.
Type:
  • String
Source:

(readonly) kmlTimePrimitive :KmlTimePrimitive

Time associated with current view. It shouldn't be displayed outside of this time frame.
Type:
Inherited From:
Source:

(readonly) node :Node

Node of this object. It may be overridden by other users of some functions like parse.
Type:
  • Node
Inherited From:
Source:

pickDelegate :Object

Indicates the object to return as the userObject of this shape when picked. If null, then this shape is returned as the userObject.
Type:
  • Object
Inherited From:
Default Value:
  • null
Source:
See:

timeRange :Array.<Date>

An array with two elements: start time and end time of the visible range.
Type:
  • Array.<Date>
Inherited From:
Source:

userProperties :Object

An application defined object associated with this renderable. A typical use case is to associate application defined data with a picked renderable.
Type:
  • Object
Inherited From:
Default Value:
  • An empty object
Source:

Methods

getTagNames() → {Array.<String>}

Returns tag name of all descendants of abstract node or the tag name for current node.
Overrides:
Source:
Returns:
Type
Array.<String>

hook(controls, options)

It calls all controls associated with current KmlFile with the link to this.
Parameters:
Name Type Description
controls Array.<KmlControls> Controls associated with current tree.
options Object Options to pass into the controls.
Inherited From:
Source:

render(dc)

Render this renderable. Some shapes actually draw themselves during this call, others only add themselves to the draw context's ordered rendering list for subsequent drawing when their renderOrdered method is called. This method is intended to be called by layers such as RenderableLayer and not by applications.
Parameters:
Name Type Description
dc DrawContext The current draw context.
Inherited From:
Source: