| java.lang.Object | |||
| ↳ | com.carto.vectorelements.VectorElement | ||
| ↳ | com.carto.vectorelements.Billboard | ||
| ↳ | com.carto.vectorelements.Popup | ||
 Known Direct Subclasses
|
Class Overview
An abstract billboard element that can be displayed on the map. It
always faces the camera and has a dynamically drawn bitmap.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| synchronized void | delete() | ||||||||||
| Bitmap |
drawBitmap(ScreenPos anchorScreenPos, float screenWidth, float screenHeight, float dpToPX)
Draws a custom bitmap for this Popup that will be used for drawing the Popup on the map.
| ||||||||||
| float |
getAnchorPointX()
Returns the horizontal anchor point of this popup.
| ||||||||||
| float |
getAnchorPointY()
Returns the vertical anchor point of this popup.
| ||||||||||
| PopupStyle |
getStyle()
Returns the style of this Popup.
| ||||||||||
| boolean |
processClick(ClickType clickType, MapPos clickPos, ScreenPos elementClickPos)
Handles the click events for this Popup.
| ||||||||||
| void |
setAnchorPoint(float anchorPointX, float anchorPointY)
Sets the anchor point for the popup.
| ||||||||||
| void |
setAnchorPointX(float anchorPointX)
Sets the horizontal anchor point for the popup.
| ||||||||||
| void |
setAnchorPointY(float anchorPointY)
Sets the vertical anchor point for the popup.
| ||||||||||
| void |
setStyle(PopupStyle style)
Sets the style for this Popup.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
com.carto.vectorelements.Billboard
| |||||||||||
|
From class
com.carto.vectorelements.VectorElement
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Public Methods
public synchronized void delete ()
public Bitmap drawBitmap (ScreenPos anchorScreenPos, float screenWidth, float screenHeight, float dpToPX)
Draws a custom bitmap for this Popup that will be used for drawing the Popup on the map.
The method is called each time the Popup gets reloaded internally.
Parameters
| anchorScreenPos | The screen position of the anchor point of this popup in pixels. |
|---|---|
| screenWidth | The current screen width in pixels. |
| screenHeight | The current screen height in pixels. |
| dpToPX | The value used for converting display independent pixels (dp) to pixels (px). |
Returns
- The custom Popup bitmap.
public float getAnchorPointX ()
Returns the horizontal anchor point of this popup.
Returns
- The horizontal anchor point of this popup.
public float getAnchorPointY ()
Returns the vertical anchor point of this popup.
Returns
- The vertical anchor point of this popup.
public PopupStyle getStyle ()
Returns the style of this Popup.
Returns
- The style that defines what this Popup looks like.
public boolean processClick (ClickType clickType, MapPos clickPos, ScreenPos elementClickPos)
Handles the click events for this Popup.
Parameters
| clickType | The type of the click. |
|---|---|
| clickPos | The position of the click. |
| elementClickPos | The 2D position of the click on the popup. |
Returns
- True if the click was handled. False otherwise.
public void setAnchorPoint (float anchorPointX, float anchorPointY)
Sets the anchor point for the popup. It should only be called from
Popup::drawBitmap method, to match the anchor point to the drawn bitmap.
Values will be clamped to [-1, 1] range.
Parameters
| anchorPointX | The new horizontal anchor point for the popup. -1 means the left side, 0 the center and 1 the right side of the popup. The default is 0. |
|---|---|
| anchorPointY | The vertical anchor point for the popup. -1 means the bottom, 0 the center and 1 the top of the popup. The default is -1. |
public void setAnchorPointX (float anchorPointX)
Sets the horizontal anchor point for the popup. It should only be called from
Popup::drawBitmap method, to match the anchor point to the drawn bitmap.
Parameters
| anchorPointX | The new horizontal anchor point for the popup. -1 means the left side, 0 the center and 1 the right side of the popup. The default is 0. |
|---|
public void setAnchorPointY (float anchorPointY)
Sets the vertical anchor point for the popup. It should only be called from
Popup::drawBitmap method, to match the anchor point to the drawn bitmap.
Parameters
| anchorPointY | The vertical anchor point for the popup. -1 means the bottom, 0 the center and 1 the top of the popup. The default is -1. |
|---|
public void setStyle (PopupStyle style)
Sets the style for this Popup.
Parameters
| style | The new style that defines what this popup looks like. |
|---|