Package de.bluecolored.bluemap.api.markers

Class ShapeMarker

java.lang.Object

de.bluecolored.bluemap.api.markers.Marker

de.bluecolored.bluemap.api.markers.DistanceRangedMarker

de.bluecolored.bluemap.api.markers.ObjectMarker

de.bluecolored.bluemap.api.markers.ShapeMarker

All Implemented Interfaces:

DetailMarker

public class ShapeMarker
extends ObjectMarker

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShapeMarker.Builder

Constructor Summary

Constructors

Constructor	Description
ShapeMarker(String label, Vector3d position, Shape shape, float shapeY)	Creates a new ShapeMarker.
ShapeMarker(String label, Shape shape, float shapeY)	Creates a new ShapeMarker.

Method Summary

Modifier and Type	Method	Description
static ShapeMarker.Builder	builder()	Creates a Builder for ShapeMarkers.
void	centerPosition()	Sets the position of this ShapeMarker to the center of the Shape (it's bounding box).
boolean	equals(Object o)
Color	getFillColor()	Getter for the fill-Color of the shape.
Collection<Shape>	getHoles()	Getter for the mutable collection of holes in this ShapeMarker.
Color	getLineColor()	Getter for the Color of the border-line of the shape.
int	getLineWidth()	Getter for the width of the border-line of this ShapeMarker.
Shape	getShape()	Getter for Shape of this ShapeMarker.
float	getShapeY()	Getter for the height (y-coordinate) of where the shape is displayed on the map.
int	hashCode()
boolean	isDepthTestEnabled()	If the depth-test is disabled, you can see the marker fully through all objects on the map.
void	setColors(Color lineColor, Color fillColor)	Sets the border- and fill- color.
void	setDepthTestEnabled(boolean enabled)	If the depth-test is disabled, you can see the marker fully through all objects on the map.
void	setFillColor(Color color)	Sets the fill-Color of the shape.
void	setLineColor(Color color)	Sets the Color of the border-line of the shape.
void	setLineWidth(int width)	Sets the width of the border-line for this ShapeMarker.
void	setShape(Shape shape, float y)	Sets the Shape of this ShapeMarker.

Methods inherited from class de.bluecolored.bluemap.api.markers.ObjectMarker

getDetail, getLink, isNewTab, removeLink, setDetail, setLink

Methods inherited from class de.bluecolored.bluemap.api.markers.DistanceRangedMarker

getMaxDistance, getMinDistance, setMaxDistance, setMinDistance

Methods inherited from class de.bluecolored.bluemap.api.markers.Marker

getLabel, getPosition, getSorting, getType, isListed, setLabel, setListed, setPosition, setPosition, setPosition, setSorting

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ShapeMarker

public ShapeMarker(String label,
 Shape shape,
 float shapeY)

Creates a new ShapeMarker.

(The position of the marker will be the center of the shape (it's bounding box))

Parameters:

label - the label of the marker

shape - the Shape of the marker

shapeY - the y-position of the shape

See Also:

• Marker.setLabel(String)
• setShape(Shape, float)

ShapeMarker

public ShapeMarker(String label,
 Vector3d position,
 Shape shape,
 float shapeY)

Creates a new ShapeMarker.

(Since the shape has its own positions, the position is only used to determine e.g. the distance to the camera)

Parameters:

label - the label of the marker

position - the coordinates of the marker

shape - the shape of the marker

shapeY - the y-position of the shape

See Also:

• Marker.setLabel(String)
• Marker.setPosition(Vector3d)
• setShape(Shape, float)

Method Details

getShape

public Shape getShape()

Getter for Shape of this ShapeMarker.

The shape is placed on the xz-plane of the map, so the y-coordinates of the Shape's points are the z-coordinates in the map.

Returns:

the Shape

getShapeY

public float getShapeY()

Getter for the height (y-coordinate) of where the shape is displayed on the map.

Returns:

the height of the shape on the map

setShape

public void setShape(Shape shape,
 float y)

Sets the Shape of this ShapeMarker.

The shape is placed on the xz-plane of the map, so the y-coordinates of the Shape's points will be the z-coordinates in the map.

Parameters:

shape - the new Shape

y - the new height (y-coordinate) of the shape on the map

See Also:

• centerPosition()

getHoles

public Collection<Shape> getHoles()

Getter for the mutable collection of holes in this ShapeMarker.

Any shape in this collection will be a hole in the main Shape of this marker

Returns:

A mutable collection of hole-shapes

centerPosition

public void centerPosition()

Sets the position of this ShapeMarker to the center of the Shape (it's bounding box).

(Invoke this after changing the Shape to make sure the markers position gets updated as well)

isDepthTestEnabled

public boolean isDepthTestEnabled()

If the depth-test is disabled, you can see the marker fully through all objects on the map. If it is enabled, you'll only see the marker when it is not behind anything.

Returns:

true if the depthTest is enabled

setDepthTestEnabled

public void setDepthTestEnabled(boolean enabled)

If the depth-test is disabled, you can see the marker fully through all objects on the map. If it is enabled, you'll only see the marker when it is not behind anything.

Parameters:

enabled - if the depth-test should be enabled for this ShapeMarker

getLineWidth

public int getLineWidth()

Getter for the width of the border-line of this ShapeMarker.

Returns:

the width of the line in pixels

setLineWidth

public void setLineWidth(int width)

Sets the width of the border-line for this ShapeMarker.

Parameters:

width - the new width in pixels

getLineColor

public Color getLineColor()

Getter for the Color of the border-line of the shape.

Returns:

the line-color

setLineColor

public void setLineColor(Color color)

Sets the Color of the border-line of the shape.

Parameters:

color - the new line-color

getFillColor

public Color getFillColor()

Getter for the fill-Color of the shape.

Returns:

the fill-color

setFillColor

public void setFillColor(Color color)

Sets the fill-Color of the shape.

Parameters:

color - the new fill-color

setColors

public void setColors(Color lineColor,
 Color fillColor)

Sets the border- and fill- color.

Parameters:

lineColor - the new border-color

fillColor - the new fill-color

See Also:

• setLineColor(Color)
• setFillColor(Color)

equals

public boolean equals(Object o)

Overrides:

equals in class ObjectMarker

hashCode

public int hashCode()

Overrides:

hashCode in class ObjectMarker

builder

public static ShapeMarker.Builder builder()

Creates a Builder for ShapeMarkers.

Returns:

a new Builder