| java.lang.Object | ||
| ↳ | com.carto.vectorelements.VectorElement | |
| ↳ | com.carto.vectorelements.Polygon3D | |
Class Overview
A geometric 3d polygon that can be displayed on the map.
3d polygons can be concave and have multiple overlapping holes.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
Polygon3D(PolygonGeometry geometry, Polygon3DStyle style, float height)
Constructs a Polygon3D object from a geometry object and a style.
| |||||||||||
|
Polygon3D(MapPosVector poses, Polygon3DStyle style, float height)
Constructs a Polygon3D object from a vector of map positions and a style.
| |||||||||||
|
Polygon3D(MapPosVector poses, MapPosVectorVector holes, Polygon3DStyle style, float height)
Constructs a Polygon3D object from a vector of map positions, a vector of holes and a style.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| synchronized void | delete() | ||||||||||
| PolygonGeometry |
getGeometry()
Returns the geometry object that defines the location of this vector element.
| ||||||||||
| float |
getHeight()
Returns the height of this 3d polygon.
| ||||||||||
| MapPosVectorVector |
getHoles()
Returns the holes of the 3d polygon.
| ||||||||||
| MapPosVector |
getPoses()
Returns the vertices that define this 3d polygon.
| ||||||||||
| Polygon3DStyle |
getStyle()
Returns the style of this 3d polygon.
| ||||||||||
| void |
setGeometry(PolygonGeometry geometry)
Sets the location for this 3d polygon.
| ||||||||||
| void |
setHeight(float height)
Sets the height for this 3d polygon.
| ||||||||||
| void |
setHoles(MapPosVectorVector holes)
Sets the holes of the 3d polygon.
| ||||||||||
| void |
setPoses(MapPosVector poses)
Sets the vertices that define this 3d polygon.
| ||||||||||
| void |
setStyle(Polygon3DStyle style)
Sets the style for this 3d polygon.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.carto.vectorelements.VectorElement
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Public Constructors
public Polygon3D (PolygonGeometry geometry, Polygon3DStyle style, float height)
Constructs a Polygon3D object from a geometry object and a style.
Parameters
| geometry | The geometry object that defines the location and holes of this 3d polygon. |
|---|---|
| style | The style that defines what this 3d polygon looks like. |
| height | The height of this 3d polygon in meters. |
public Polygon3D (MapPosVector poses, Polygon3DStyle style, float height)
Constructs a Polygon3D object from a vector of map positions and a style.
Parameters
| poses | The vector of map positions that defines the location of this 3d polygon. |
|---|---|
| style | The style that defines what this 3d polygon looks like. |
| height | The height of this 3d polygon in meters. |
public Polygon3D (MapPosVector poses, MapPosVectorVector holes, Polygon3DStyle style, float height)
Constructs a Polygon3D object from a vector of map positions, a vector of holes and a style.
Parameters
| poses | The vector of map positions that defines the location of this 3d polygon. |
|---|---|
| holes | The vector of holes that defines the locations of holes of this 3d polygon. |
| style | The style that defines what this 3d polygon looks like. |
| height | The height of this 3d polygon in meters. |
Public Methods
public synchronized void delete ()
public PolygonGeometry getGeometry ()
Returns the geometry object that defines the location of this vector element.
Returns
- The geometry object of this vector element.
public float getHeight ()
Returns the height of this 3d polygon.
Returns
- The height of this 3d polygon in meters.
public MapPosVectorVector getHoles ()
Returns the holes of the 3d polygon.
Returns
- The list of holes of the 3d polygon.
public MapPosVector getPoses ()
Returns the vertices that define this 3d polygon.
Returns
- The new vector of map positions that define this 3d polygon.
public Polygon3DStyle getStyle ()
Returns the style of this 3d polygon.
Returns
- The style that defines what this 3d polygon looks like.
public void setGeometry (PolygonGeometry geometry)
Sets the location for this 3d polygon.
Parameters
| geometry | The new geometry object that defines the location and holes of this 3d polygon. |
|---|
public void setHeight (float height)
Sets the height for this 3d polygon.
Parameters
| height | The new height for this 3d polygon in meters. |
|---|
public void setHoles (MapPosVectorVector holes)
Sets the holes of the 3d polygon.
Parameters
| holes | The list of holes of the 3d polygon. |
|---|
public void setPoses (MapPosVector poses)
Sets the vertices that define this 3d polygon.
Note: holes are not affected by this call.
Parameters
| poses | The new vector of map positions that define this 3d polygon. |
|---|
public void setStyle (Polygon3DStyle style)
Sets the style for this 3d polygon.
Parameters
| style | The new style that defines what this 3d polygon looks like. |
|---|