| java.lang.Object | ||
| ↳ | com.carto.styles.Style | |
| ↳ | com.carto.styles.BillboardStyle | |
 Known Direct Subclasses
|
|
Known Indirect Subclasses
|
Class Overview
A base class for BillboardStyle subclasses.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| synchronized void | delete() | ||||||||||
| AnimationStyle |
getAnimationStyle()
Returns the animation style of the billboard.
| ||||||||||
| float |
getAttachAnchorPointX()
Returns the horizontal attaching anchor point of the billoard.
| ||||||||||
| float |
getAttachAnchorPointY()
Returns the vertical attaching anchor point of the billoard.
| ||||||||||
| float |
getHorizontalOffset()
Returns the horizontal offset of the billboard.
| ||||||||||
| int |
getPlacementPriority()
Returns the placement priority of the billboard.
| ||||||||||
| float |
getVerticalOffset()
Returns the vertical offset of the billboard.
| ||||||||||
| boolean |
isCausesOverlap()
Returns the state of the causes overlap flag.
| ||||||||||
| boolean |
isHideIfOverlapped()
Returns the state of the allow overlap flag.
| ||||||||||
| boolean |
isScaleWithDPI()
Returns the state of the scale with DPI flag.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
com.carto.styles.Style
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Public Methods
public synchronized void delete ()
public AnimationStyle getAnimationStyle ()
Returns the animation style of the billboard.
Returns
- The animation style of the billboard. Can be null if animations are not used.
public float getAttachAnchorPointX ()
Returns the horizontal attaching anchor point of the billoard.
Returns
- The horizontal attaching anchor point of the billoard.
public float getAttachAnchorPointY ()
Returns the vertical attaching anchor point of the billoard.
Returns
- The vertical attaching anchor point of the billoard.
public float getHorizontalOffset ()
Returns the horizontal offset of the billboard.
Returns
- The horizontal offset of the billboard, units depend on the scaling mode.
public int getPlacementPriority ()
Returns the placement priority of the billboard.
Returns
- The placement priority of the billboard.
public float getVerticalOffset ()
Returns the vertical offset of the billboard.
Returns
- The vertical offset of the billboard, units depend on the scaling mode.
public boolean isCausesOverlap ()
Returns the state of the causes overlap flag.
Returns
- True if this billboard causes overlapping with other billboards behind it.
public boolean isHideIfOverlapped ()
Returns the state of the allow overlap flag.
Returns
- True if this billboard can be hidden by overlapping billboards in front of it.
public boolean isScaleWithDPI ()
Returns the state of the scale with DPI flag.
Returns
- True if this billboard's size will be scaled using the screen dot's per inch parameter.