Class: Compass

Compass(screenOffset, imagePath)

Displays a compass image at a specified location in the WorldWindow. The compass image rotates and tilts to reflect the current navigator's heading and tilt.

Constructor

new Compass(screenOffset, imagePath)

Constructs a compass.
Parameters:
Name Type Description
screenOffset Offset The offset indicating the image's placement on the screen. If null or undefined the compass is placed at the upper-right corner of the WorldWindow. Use the image offset property to position the image relative to the screen point.
imagePath String The URL of the image to display. If null or undefined, a default compass image is used.
Source:

Extends

Members

displayName :String

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

enabled :Boolean

Indicates whether to draw this screen image.
Type:
  • Boolean
Inherited From:
Default Value:
  • true
Source:

imageColor :Color

The image color. When displayed, this shape's image is multiplied by this image color to achieve the final image color. The color white, the default, causes the image to be drawn in its native colors.
Type:
Inherited From:
Default Value:
  • White (1, 1, 1, 1)
Source:

imageOffset :Offset

Indicates the location within the image at which to align with the specified screen location. May be null, in which case the image's bottom-left corner is placed at the screen location.
Type:
Overrides:
Default Value:
  • 0.5, 0.5, both fractional (Centers the image on the screen location.)
Source:

imageRotation :Number

The amount of rotation to apply to the image, measured in degrees clockwise from the top of the window.
Type:
  • Number
Overrides:
Default Value:
  • 0
Source:

imageScale :Number

Indicates the amount to scale the image.
Type:
  • Number
Overrides:
Default Value:
  • 1
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:
Inherited From:
Default Value:
  • null
Source:

imageTilt :Number

The amount of tilt to apply to the image, measured in degrees.
Type:
  • Number
Overrides:
Default Value:
  • 0
Source:

opacity :Number

This image's opacity. When this screen image is drawn, the actual opacity is the product of this opacity and the opacity of the layer containing this screen image.
Type:
  • Number
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:

screenOffset :Offset

The offset indicating this screen image's placement on the screen.
Type:
Inherited From:
Source:

size :number

Specifies the size of the compass as a fraction of the WorldWindow width.
Type:
  • number
Default Value:
  • 0.15
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

render(dc)

Capture the navigator's heading and tilt and apply it to the compass' screen image.
Parameters:
Name Type Description
dc DrawContext The current draw context.
Overrides:
Source:

renderOrdered(dc)

Draws this shape as an ordered renderable. Applications do not call this function. It is called by WorldWindow during rendering.
Parameters:
Name Type Description
dc DrawContext The current draw context.
Inherited From:
Source: