public class ScreenOverlay extends Overlay implements Cloneable
The
This element draws an image overlay fixed to the screen. Sample uses for ScreenOverlays
are compasses, logos, and heads-up displays. ScreenOverlay sizing is determined
by the
This element draws an image overlay fixed to the screen. Sample uses for ScreenOverlays
are compasses, logos, and heads-up displays. ScreenOverlay sizing is determined
by the
<ScreenOverlay id="ID"> <!-- inherited from Feature element --> <name>...</name> <!-- string --> <visibility>1</visibility> <!-- boolean --> <open>0</open> <!-- boolean --> <atom:author>...<atom:author> <!-- xmlns:atom --> <atom:link>...</atom:link> <!-- xmlns:atom --> <address>...</address> <!-- string --> <xal:AddressDetails>...</xal:AddressDetails> <!-- xmlns:xal -->Extends:
<phoneNumber>...</phoneNumber> <!-- string -->
<Snippet maxLines="2">...</Snippet> <!-- string --> <description>...</description> <!-- string --> <AbstractView>...</AbstractView> <!-- Camera or LookAt --> <TimePrimitive>...</TimePrimitive> <styleUrl>...</styleUrl> <!-- anyURI --> <StyleSelector>...</StyleSelector> <Region>...</Region> <Metadata>...</Metadata> <!-- deprecated in KML 2.2 --> <ExtendedData>...</ExtendedData> <!-- new in KML 2.2 --> <!-- inherited from Overlay element --> <color>ffffffff</color> <!-- kml:color --> <drawOrder>0</drawOrder> <!-- int --> <Icon>...</Icon> <!-- specific to ScreenOverlay --> <overlayXY x="double" y="double" xunits="fraction" yunits="fraction"/> <!-- vec2 --> <!-- xunits and yunits can be one of: fraction, pixels, or insetPixels --> <screenXY x="double" y="double" xunits="fraction" yunits="fraction"/> <!-- vec2 --> <rotationXY x="double" y="double" xunits="fraction" yunits"fraction"/> <!-- vec2 --> <size x="double" y="double" xunits="fraction" yunits="fraction"/> <!-- vec2 --> <rotation>0</rotation> <!-- float --> </ScreenOverlay>
| Modifier and Type | Field and Description |
|---|---|
protected Vec2 |
overlayXY
|
protected double |
rotation
|
protected Vec2 |
rotationXY
|
protected List<AbstractObject> |
screenOverlayObjectExtension
|
protected List<Object> |
screenOverlaySimpleExtension |
protected Vec2 |
screenXY
|
protected Vec2 |
size
|
color, drawOrder, icon, overlayObjectExtension, overlaySimpleExtensionabstractView, address, atomAuthor, atomLink, description, extendedData, featureObjectExtension, featureSimpleExtension, metadata, name, open, phoneNumber, region, snippet, snippetd, styleSelector, styleUrl, timePrimitive, visibility, xalAddressDetailsid, objectSimpleExtension, targetId| Constructor and Description |
|---|
ScreenOverlay() |
| Modifier and Type | Method and Description |
|---|---|
ScreenOverlay |
addToFeatureObjectExtension(AbstractObject featureObjectExtension)
add a value to the featureObjectExtension property collection
|
ScreenOverlay |
addToFeatureSimpleExtension(Object featureSimpleExtension)
add a value to the featureSimpleExtension property collection
|
ScreenOverlay |
addToObjectSimpleExtension(Object objectSimpleExtension)
add a value to the objectSimpleExtension property collection
|
ScreenOverlay |
addToOverlayObjectExtension(AbstractObject overlayObjectExtension)
add a value to the overlayObjectExtension property collection
|
ScreenOverlay |
addToOverlaySimpleExtension(Object overlaySimpleExtension)
add a value to the overlaySimpleExtension property collection
|
ScreenOverlay |
addToScreenOverlayObjectExtension(AbstractObject screenOverlayObjectExtension)
add a value to the screenOverlayObjectExtension property collection
|
ScreenOverlay |
addToScreenOverlaySimpleExtension(Object screenOverlaySimpleExtension)
add a value to the screenOverlaySimpleExtension property collection
|
ScreenOverlay |
addToStyleSelector(StyleSelector styleSelector)
add a value to the styleSelector property collection
|
ScreenOverlay |
clone() |
Vec2 |
createAndSetOverlayXY()
Creates a new instance of
Vec2 and set it to overlayXY. |
Vec2 |
createAndSetRotationXY()
Creates a new instance of
Vec2 and set it to rotationXY. |
Vec2 |
createAndSetScreenXY()
Creates a new instance of
Vec2 and set it to screenXY. |
Vec2 |
createAndSetSize()
Creates a new instance of
Vec2 and set it to size. |
boolean |
equals(Object obj) |
Vec2 |
getOverlayXY() |
double |
getRotation() |
Vec2 |
getRotationXY() |
List<AbstractObject> |
getScreenOverlayObjectExtension() |
List<Object> |
getScreenOverlaySimpleExtension() |
Vec2 |
getScreenXY() |
Vec2 |
getSize() |
int |
hashCode() |
void |
setFeatureObjectExtension(List<AbstractObject> featureObjectExtension) |
void |
setFeatureSimpleExtension(List<Object> featureSimpleExtension) |
void |
setObjectSimpleExtension(List<Object> objectSimpleExtension) |
void |
setOverlayObjectExtension(List<AbstractObject> overlayObjectExtension) |
void |
setOverlaySimpleExtension(List<Object> overlaySimpleExtension) |
void |
setOverlayXY(Vec2 value) |
void |
setRotation(double value) |
void |
setRotationXY(Vec2 value) |
void |
setScreenOverlayObjectExtension(List<AbstractObject> screenOverlayObjectExtension) |
void |
setScreenOverlaySimpleExtension(List<Object> screenOverlaySimpleExtension) |
void |
setScreenXY(Vec2 value) |
void |
setSize(Vec2 value) |
void |
setStyleSelector(List<StyleSelector> styleSelector) |
ScreenOverlay |
withAbstractView(AbstractView abstractView)
fluent setter
|
ScreenOverlay |
withAddress(String address)
fluent setter
|
ScreenOverlay |
withAtomAuthor(Author atomAuthor)
fluent setter
|
ScreenOverlay |
withAtomLink(Link atomLink)
fluent setter
|
ScreenOverlay |
withColor(String color)
fluent setter
|
ScreenOverlay |
withDescription(String description)
fluent setter
|
ScreenOverlay |
withDrawOrder(int drawOrder)
fluent setter
|
ScreenOverlay |
withExtendedData(ExtendedData extendedData)
fluent setter
|
ScreenOverlay |
withFeatureObjectExtension(List<AbstractObject> featureObjectExtension)
fluent setter
|
ScreenOverlay |
withFeatureSimpleExtension(List<Object> featureSimpleExtension)
fluent setter
|
ScreenOverlay |
withIcon(Icon icon)
fluent setter
|
ScreenOverlay |
withId(String id)
fluent setter
|
ScreenOverlay |
withMetadata(Metadata metadata)
fluent setter
|
ScreenOverlay |
withName(String name)
fluent setter
|
ScreenOverlay |
withObjectSimpleExtension(List<Object> objectSimpleExtension)
fluent setter
|
ScreenOverlay |
withOpen(Boolean open)
fluent setter
|
ScreenOverlay |
withOverlayObjectExtension(List<AbstractObject> overlayObjectExtension)
fluent setter
|
ScreenOverlay |
withOverlaySimpleExtension(List<Object> overlaySimpleExtension)
fluent setter
|
ScreenOverlay |
withOverlayXY(Vec2 overlayXY)
fluent setter
|
ScreenOverlay |
withPhoneNumber(String phoneNumber)
fluent setter
|
ScreenOverlay |
withRegion(Region region)
fluent setter
|
ScreenOverlay |
withRotation(double rotation)
fluent setter
|
ScreenOverlay |
withRotationXY(Vec2 rotationXY)
fluent setter
|
ScreenOverlay |
withScreenOverlayObjectExtension(List<AbstractObject> screenOverlayObjectExtension)
fluent setter
|
ScreenOverlay |
withScreenOverlaySimpleExtension(List<Object> screenOverlaySimpleExtension)
fluent setter
|
ScreenOverlay |
withScreenXY(Vec2 screenXY)
fluent setter
|
ScreenOverlay |
withSize(Vec2 size)
fluent setter
|
ScreenOverlay |
withSnippet(Snippet snippet)
fluent setter
|
ScreenOverlay |
withSnippetd(String snippetd)
fluent setter
|
ScreenOverlay |
withStyleSelector(List<StyleSelector> styleSelector)
fluent setter
|
ScreenOverlay |
withStyleUrl(String styleUrl)
fluent setter
|
ScreenOverlay |
withTargetId(String targetId)
fluent setter
|
ScreenOverlay |
withTimePrimitive(TimePrimitive timePrimitive)
fluent setter
|
ScreenOverlay |
withVisibility(Boolean visibility)
fluent setter
|
ScreenOverlay |
withXalAddressDetails(AddressDetails xalAddressDetails)
fluent setter
|
createAndSetIcon, getColor, getDrawOrder, getIcon, getOverlayObjectExtension, getOverlaySimpleExtension, setColor, setDrawOrder, setIconcreateAndAddStyle, createAndAddStyleMap, createAndSetAtomAuthor, createAndSetAtomLink, createAndSetCamera, createAndSetExtendedData, createAndSetLookAt, createAndSetMetadata, createAndSetRegion, createAndSetSnippet, createAndSetTimeSpan, createAndSetTimeStamp, createAndSetXalAddressDetails, getAbstractView, getAddress, getAtomAuthor, getAtomLink, getDescription, getExtendedData, getFeatureObjectExtension, getFeatureSimpleExtension, getMetadata, getName, getPhoneNumber, getRegion, getSnippet, getSnippetd, getStyleSelector, getStyleUrl, getTimePrimitive, getXalAddressDetails, isOpen, isVisibility, setAbstractView, setAddress, setAtomAuthor, setAtomLink, setDescription, setExtendedData, setMetadata, setName, setOpen, setPhoneNumber, setRegion, setSnippet, setSnippetd, setStyleUrl, setTimePrimitive, setVisibility, setXalAddressDetailsgetId, getObjectSimpleExtension, getTargetId, setId, setTargetIdprotected Vec2 overlayXY
Specifies a point on (or outside of) the overlay image that is mapped to the screen
coordinate (
The x and y values can be specified in three different ways: as pixels ("pixels"), as fractions of the image ("fraction"), or as inset pixels ("insetPixels"), which is an offset in pixels from the upper right corner of the image. The x and y positions can be specified in different ways—for example, x can be in pixels and y can be a fraction. The origin of the coordinate system is in the lower left corner of the image. x - Either the number of pixels, a fractional component of the image, or a pixel inset indicating the x component of a point on the overlay image. y - Either the number of pixels, a fractional component of the image, or a pixel inset indicating the y component of a point on the overlay image. xunits - Units in which the x value is specified. A value of "fraction" indicates the x value is a fraction of the image. A value of "pixels" indicates the x value in pixels. A value of "insetPixels" indicates the indent from the right edge of the image. yunits - Units in which the y value is specified. A value of "fraction" indicates the y value is a fraction of the image. A value of "pixels" indicates the y value in pixels. A value of "insetPixels" indicates the indent from the top edge of the image.
protected Vec2 screenXY
Center the image:
Center the image:
For example,
Here are some examples:
Place the image at the right of the screen:
Place the image on the top left:
Specifies a point relative to the screen origin that the overlay image is mapped to. The x and y values can be specified in three different ways: as pixels ("pixels"), as fractions of the screen ("fraction"), or as inset pixels ("insetPixels"), which is an offset in pixels from the upper right corner of the screen. The x and y positions can be specified in different ways—for example, x can be in pixels and y can be a fraction. The origin of the coordinate system is in the lower left corner of the screen. x - Either the number of pixels, a fractional component of the screen, or a pixel inset indicating the x component of a point on the screen. y - Either the number of pixels, a fractional component of the screen, or a pixel inset indicating the y component of a point on the screen. xunits - Units in which the x value is specified. A value of "fraction" indicates the x value is a fraction of the screen. A value of "pixels" indicates the x value in pixels. A value of "insetPixels" indicates the indent from the right edge of the screen. yunits - Units in which the y value is specified. A value of fraction indicates the y value is a fraction of the screen. A value of "pixels" indicates the y value in pixels. A value of "insetPixels" indicates the indent from the top edge of the screen.
protected Vec2 rotationXY
Point relative to the screen about which the screen overlay is rotated.
protected Vec2 size
For example:
Specifies the size of the image for the screen overlay, as follows: A value of −1 indicates to use the native dimension A value of 0 indicates to maintain the aspect ratio A value of n sets the value of the dimension
To force the image to resize to 100px by 500px:
To force the image to retain its horizontal dimension, but to take up 20 percent of the vertical screen space:
To force the image to retain its original x and y dimensions, set the values to −1:
To force the image to retain its original x and y dimensions, set the values to
−1:
protected double rotation
Adjusts how the photo is placed inside the field of view. This element is useful if your photo has been rotated and deviates slightly from a desired horizontal view.
Indicates the angle of rotation of the parent object. A value of 0 means no rotation.
The value is an angle in degrees counterclockwise starting from north. Use ±180
to indicate the rotation of the parent object from 0. The center of the
protected List<AbstractObject> screenOverlayObjectExtension
public void setOverlayXY(Vec2 value)
value - allowed object is
Vec2overlayXYpublic void setScreenXY(Vec2 value)
value - allowed object is
Vec2screenXYpublic void setRotationXY(Vec2 value)
value - allowed object is
Vec2rotationXYpublic double getRotation()
Doublerotationpublic void setRotation(double value)
value - allowed object is
Doublerotationpublic List<Object> getScreenOverlaySimpleExtension()
screenOverlaySimpleExtensionpublic List<AbstractObject> getScreenOverlayObjectExtension()
screenOverlayObjectExtensionpublic Vec2 createAndSetOverlayXY()
Vec2 and set it to overlayXY.
This method is a short version for:
Vec2 vec2 = new Vec2();
this.setOverlayXY(vec2); public Vec2 createAndSetScreenXY()
Vec2 and set it to screenXY.
This method is a short version for:
Vec2 vec2 = new Vec2();
this.setScreenXY(vec2); public Vec2 createAndSetRotationXY()
Vec2 and set it to rotationXY.
This method is a short version for:
Vec2 vec2 = new Vec2();
this.setRotationXY(vec2); public Vec2 createAndSetSize()
Vec2 and set it to size.
This method is a short version for:
Vec2 vec2 = new Vec2();
this.setSize(vec2); public void setScreenOverlaySimpleExtension(List<Object> screenOverlaySimpleExtension)
screenOverlaySimpleExtension - screenOverlaySimpleExtensionpublic ScreenOverlay addToScreenOverlaySimpleExtension(Object screenOverlaySimpleExtension)
screenOverlaySimpleExtension - Objects of the following type are allowed in the list: Objectpublic void setScreenOverlayObjectExtension(List<AbstractObject> screenOverlayObjectExtension)
screenOverlayObjectExtension - screenOverlayObjectExtensionpublic ScreenOverlay addToScreenOverlayObjectExtension(AbstractObject screenOverlayObjectExtension)
screenOverlayObjectExtension - Objects of the following type are allowed in the list: AbstractObjectpublic void setObjectSimpleExtension(List<Object> objectSimpleExtension)
setObjectSimpleExtension in class OverlayobjectSimpleExtensionpublic ScreenOverlay addToObjectSimpleExtension(Object objectSimpleExtension)
AbstractObjectaddToObjectSimpleExtension in class OverlayobjectSimpleExtension - Objects of the following type are allowed in the list: Objectpublic void setStyleSelector(List<StyleSelector> styleSelector)
setStyleSelector in class OverlaystyleSelectorpublic ScreenOverlay addToStyleSelector(StyleSelector styleSelector)
FeatureaddToStyleSelector in class OverlaystyleSelector - Objects of the following type are allowed in the list: <StyleJAXBElement<StyleSelectorJAXBElement<StyleMappublic void setFeatureSimpleExtension(List<Object> featureSimpleExtension)
setFeatureSimpleExtension in class OverlayfeatureSimpleExtensionpublic ScreenOverlay addToFeatureSimpleExtension(Object featureSimpleExtension)
FeatureaddToFeatureSimpleExtension in class OverlayfeatureSimpleExtension - Objects of the following type are allowed in the list: <DoubleJAXBElement<ObjectJAXBElement<Booleanpublic void setFeatureObjectExtension(List<AbstractObject> featureObjectExtension)
setFeatureObjectExtension in class OverlayfeatureObjectExtensionpublic ScreenOverlay addToFeatureObjectExtension(AbstractObject featureObjectExtension)
FeatureaddToFeatureObjectExtension in class OverlayfeatureObjectExtension - Objects of the following type are allowed in the list: AbstractObjectpublic void setOverlaySimpleExtension(List<Object> overlaySimpleExtension)
setOverlaySimpleExtension in class OverlayoverlaySimpleExtensionpublic ScreenOverlay addToOverlaySimpleExtension(Object overlaySimpleExtension)
OverlayaddToOverlaySimpleExtension in class OverlayoverlaySimpleExtension - Objects of the following type are allowed in the list: Objectpublic void setOverlayObjectExtension(List<AbstractObject> overlayObjectExtension)
setOverlayObjectExtension in class OverlayoverlayObjectExtensionpublic ScreenOverlay addToOverlayObjectExtension(AbstractObject overlayObjectExtension)
OverlayaddToOverlayObjectExtension in class OverlayoverlayObjectExtension - Objects of the following type are allowed in the list: AbstractObjectpublic ScreenOverlay withOverlayXY(Vec2 overlayXY)
overlayXY - required parametersetOverlayXY(Vec2)public ScreenOverlay withScreenXY(Vec2 screenXY)
screenXY - required parametersetScreenXY(Vec2)public ScreenOverlay withRotationXY(Vec2 rotationXY)
rotationXY - required parametersetRotationXY(Vec2)public ScreenOverlay withSize(Vec2 size)
size - required parametersetSize(Vec2)public ScreenOverlay withRotation(double rotation)
rotation - required parametersetRotation(double)public ScreenOverlay withScreenOverlaySimpleExtension(List<Object> screenOverlaySimpleExtension)
screenOverlaySimpleExtension - required parameter#setScreenOverlaySimpleExtension(Listpublic ScreenOverlay withScreenOverlayObjectExtension(List<AbstractObject> screenOverlayObjectExtension)
screenOverlayObjectExtension - required parameter#setScreenOverlayObjectExtension(List) public ScreenOverlay withObjectSimpleExtension(List<Object> objectSimpleExtension)
AbstractObjectwithObjectSimpleExtension in class OverlayobjectSimpleExtension - required parameter#setObjectSimpleExtension(Listpublic ScreenOverlay withId(String id)
AbstractObjectwithId in class Overlayid - required parameterAbstractObject.setId(String)public ScreenOverlay withTargetId(String targetId)
AbstractObjectwithTargetId in class OverlaytargetId - required parameterAbstractObject.setTargetId(String)public ScreenOverlay withName(String name)
FeaturewithName in class Overlayname - required parameterFeature.setName(String)public ScreenOverlay withVisibility(Boolean visibility)
FeaturewithVisibility in class Overlayvisibility - required parameterFeature.setVisibility(Boolean)public ScreenOverlay withOpen(Boolean open)
FeaturewithOpen in class Overlayopen - required parameterFeature.setOpen(Boolean)public ScreenOverlay withAtomAuthor(Author atomAuthor)
FeaturewithAtomAuthor in class OverlayatomAuthor - required parameterFeature.setAtomAuthor(Author)public ScreenOverlay withAtomLink(Link atomLink)
FeaturewithAtomLink in class OverlayatomLink - required parameterFeature.setAtomLink(Link)public ScreenOverlay withAddress(String address)
FeaturewithAddress in class Overlayaddress - required parameterFeature.setAddress(String)public ScreenOverlay withXalAddressDetails(AddressDetails xalAddressDetails)
FeaturewithXalAddressDetails in class OverlayxalAddressDetails - required parameterFeature.setXalAddressDetails(AddressDetails)public ScreenOverlay withPhoneNumber(String phoneNumber)
FeaturewithPhoneNumber in class OverlayphoneNumber - required parameterFeature.setPhoneNumber(String)public ScreenOverlay withSnippet(Snippet snippet)
FeaturewithSnippet in class Overlaysnippet - required parameterFeature.setSnippet(Snippet)public ScreenOverlay withSnippetd(String snippetd)
FeaturewithSnippetd in class Overlaysnippetd - required parameterFeature.setSnippetd(String)public ScreenOverlay withDescription(String description)
FeaturewithDescription in class Overlaydescription - required parameterFeature.setDescription(String)public ScreenOverlay withAbstractView(AbstractView abstractView)
FeaturewithAbstractView in class OverlayabstractView - required parameterFeature.setAbstractView(AbstractView)public ScreenOverlay withTimePrimitive(TimePrimitive timePrimitive)
FeaturewithTimePrimitive in class OverlaytimePrimitive - required parameterFeature.setTimePrimitive(TimePrimitive)public ScreenOverlay withStyleUrl(String styleUrl)
FeaturewithStyleUrl in class OverlaystyleUrl - required parameterFeature.setStyleUrl(String)public ScreenOverlay withStyleSelector(List<StyleSelector> styleSelector)
FeaturewithStyleSelector in class OverlaystyleSelector - required parameter#setStyleSelector(List) public ScreenOverlay withRegion(Region region)
FeaturewithRegion in class Overlayregion - required parameterFeature.setRegion(Region)public ScreenOverlay withMetadata(Metadata metadata)
FeaturewithMetadata in class Overlaymetadata - required parameterFeature.setMetadata(Metadata)public ScreenOverlay withExtendedData(ExtendedData extendedData)
FeaturewithExtendedData in class OverlayextendedData - required parameterFeature.setExtendedData(ExtendedData)public ScreenOverlay withFeatureSimpleExtension(List<Object> featureSimpleExtension)
FeaturewithFeatureSimpleExtension in class OverlayfeatureSimpleExtension - required parameter#setFeatureSimpleExtension(Listpublic ScreenOverlay withFeatureObjectExtension(List<AbstractObject> featureObjectExtension)
FeaturewithFeatureObjectExtension in class OverlayfeatureObjectExtension - required parameter#setFeatureObjectExtension(List) public ScreenOverlay withColor(String color)
OverlaywithColor in class Overlaycolor - required parameterOverlay.setColor(String)public ScreenOverlay withDrawOrder(int drawOrder)
OverlaywithDrawOrder in class OverlaydrawOrder - required parameterOverlay.setDrawOrder(int)public ScreenOverlay withIcon(Icon icon)
OverlaywithIcon in class Overlayicon - required parameterOverlay.setIcon(Icon)public ScreenOverlay withOverlaySimpleExtension(List<Object> overlaySimpleExtension)
OverlaywithOverlaySimpleExtension in class OverlayoverlaySimpleExtension - required parameter#setOverlaySimpleExtension(Listpublic ScreenOverlay withOverlayObjectExtension(List<AbstractObject> overlayObjectExtension)
OverlaywithOverlayObjectExtension in class OverlayoverlayObjectExtension - required parameter#setOverlayObjectExtension(List) public ScreenOverlay clone()
Copyright © 2014 Micromata GmbH. All rights reserved.