com.kheops.jmap.client.graphics2D

Class K2DPolygon

java.lang.Object

com.kheops.jmap.client.graphics2D.K2DElement

com.kheops.jmap.client.graphics2D.K2DPolygon

All Implemented Interfaces:

Shareable, java.io.Serializable, java.lang.Cloneable

public class K2DPolygon
extends K2DElement

A class used to display 2D polygon type geometries. Can be use to display polygons with holes and multiple polygons.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static byte	FILL_COLOR
protected PolygonTypeGeometry	geometry Defines the geometry of the current element.
protected static byte	LINE_COLOR

Fields inherited from class com.kheops.jmap.client.graphics2D.K2DElement

attributes, DEFAULT_DC_BUFFER, id, selected

Constructor Summary

Constructors

Constructor and Description
K2DPolygon() Creates a new empty K2DPolygon without any geometry.
K2DPolygon(K2DPolygon polygon) Creates a K2DPolygon from the specified K2DPolygon Object.
K2DPolygon(PolygonTypeGeometry geometry, java.lang.Object[] attributes, long id) Creates a K2DPolygon from the specified parameters.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() This will clone the current instance of K2DElement.
protected static Rectangle	computeDisplayBounds(PolygonTypeGeometry geometry, K2DTransform t, Style s) Computes the DC bounding box of the specified geometry using the specified parameters.
void	draw(GraphicsRef gr, K2DTransform t, Style s) Draws the element on the specified graphics object using the specified transformation and style.
void	drawHandles(GraphicsRef gr, K2DTransform t, Style s) This method draws handles around the element.
Rectangle	getDisplayBounds(K2DTransform t, Style s) Determines the bounding box of the displayed element in DC.
Rectangle	getDisplayBoundsWc(ViewState vs, Style s) Determines the bounding box including the style of element in WC (World Coordinates).
Geometry	getGeometry() Returns the geometry object associated with the element.
int	getType() Return the current element type.
void	setGeometry(Geometry geometry) Sets the geometry object associated with the element.
Shareable	share() Creates a clone of the current element excluding the geometry which remains the same instance in both elements. Use clone() to create a real copy of the current element.
int	sizeOf() Returns the estimated memory used by this object in bytes.
java.lang.String	toString() This method overrides the toString method
boolean	touches(Point dcCoord, K2DTransform t, Style s) Determines if the specified device coordinate touches the displayed element.

Methods inherited from class com.kheops.jmap.client.graphics2D.K2DElement

copyAttributes, draw, drawHandles, equals, fromByteArray, generateUniqueId, getAttributes, getDisplayBounds, getId, hashCode, isSelected, setAttributes, setId, setSelected, sizeOfAttributes, toByteArray, toByteArray, touches

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LINE_COLOR

protected static final byte LINE_COLOR

See Also:

Constant Field Values

FILL_COLOR

protected static final byte FILL_COLOR

See Also:

Constant Field Values

geometry

protected PolygonTypeGeometry geometry

Defines the geometry of the current element.

Constructor Detail

K2DPolygon

public K2DPolygon()

Creates a new empty K2DPolygon without any geometry.

K2DPolygon

public K2DPolygon(PolygonTypeGeometry geometry,
                  java.lang.Object[] attributes,
                  long id)

Creates a K2DPolygon from the specified parameters.

Parameters:

geometry - the polygon type geometry to use.

attributes - the attributes of the element

id - the id of the element

K2DPolygon

public K2DPolygon(K2DPolygon polygon)

Creates a K2DPolygon from the specified K2DPolygon Object.

Parameters:

polygon - the K2DPolygon to copy.

Method Detail

draw

public void draw(GraphicsRef gr,
                 K2DTransform t,
                 Style s)

Draws the element on the specified graphics object using the specified transformation and style.
If the specified style contains a painter, that one will be used to fill polygons. Otherwise, the fill color of the style will be used.
The border color of the specified style will be used to draw the polygons border.

Specified by:

draw in class K2DElement

Parameters:

gr - a wrapper to the Graphics object to draw on

t - the transformation to apply to the element

s - the style that defines the appearance of the element

See Also:

KPaint

touches

public final boolean touches(Point dcCoord,
                             K2DTransform t,
                             Style s)

Determines if the specified device coordinate touches the displayed element. A point touches the element if it overlaps the graphical representation of the element. The style of the element influences the result.

Specified by:

touches in class K2DElement

Parameters:

dcCoord - the device coordinate

t - the transformation used to display the element

s - the style used to display the element

Returns:

true if the element contains the point, false otherwise

See Also:

K2DTransform, Style

computeDisplayBounds

protected static Rectangle computeDisplayBounds(PolygonTypeGeometry geometry,
                                                K2DTransform t,
                                                Style s)

Computes the DC bounding box of the specified geometry using the specified parameters.

Parameters:

geometry - the geometry to use when computing the bounding box.

t - the view transformation matrix.

s - the current style associated to the geometry.

Returns:

the DC bounding box of the geometry.

getDisplayBounds

public Rectangle getDisplayBounds(K2DTransform t,
                                  Style s)

Determines the bounding box of the displayed element in DC. The bounding box is the smallest possible rectangle in which the displayed element fits entirely.

Specified by:

getDisplayBounds in class K2DElement

Parameters:

t - the transformation used to calculate the display bounds of the element.

s - the style used used to calculate the display bounds of the element.

Returns:

the bounding box of the displayed element

clone

public java.lang.Object clone()

This will clone the current instance of K2DElement. The cloned element is always a deep copy of the source element.

Specified by:

clone in class K2DElement

Returns:

a new instance of K2DElement which is equal to the specified the current element.

sizeOf

public int sizeOf()

Returns the estimated memory used by this object in bytes.

Overrides:

sizeOf in class K2DElement

Returns:

the estimated memory used by this object in bytes.

toString

public java.lang.String toString()

This method overrides the toString method

Overrides:

toString in class java.lang.Object

Returns:

String description of the element and its attributes

share

public Shareable share()

Creates a clone of the current element excluding the geometry which remains the same instance in both elements.
Use clone() to create a real copy of the current element.

Specified by:

share in interface Shareable

Specified by:

share in class K2DElement

Returns:

a shared instance of the current element.

See Also:

K2DElement.clone()

drawHandles

public void drawHandles(GraphicsRef gr,
                        K2DTransform t,
                        Style s)

This method draws handles around the element. The position of the handles is implementation dependent. These handles are typically used to modify the geometry of the element.

Specified by:

drawHandles in class K2DElement

Parameters:

gr - the Graphics object to draw on.

t - the transformation to apply to the element.

s - the style of the element.

getGeometry

public Geometry getGeometry()

Returns the geometry object associated with the element.
The returned object is an instance of PolygonTypeGeometry.

Specified by:

getGeometry in class K2DElement

Returns:

The geometry object associated with the element.

setGeometry

public void setGeometry(Geometry geometry)

Sets the geometry object associated with the element.

Specified by:

setGeometry in class K2DElement

Parameters:

geometry - the geometry

Throws:

java.lang.IllegalArgumentException - if the specified geometry is not a valid PolygonTypeGeometry instance.

getType

public int getType()

Return the current element type.

Specified by:

getType in class K2DElement

Returns:

the element type.

See Also:

ElementTypes

getDisplayBoundsWc

public Rectangle getDisplayBoundsWc(ViewState vs,
                                    Style s)

Determines the bounding box including the style of element in WC (World Coordinates). The bounding box is the smallest possible rectangle in which the displayed element fits entirely. This method offers a basic implementation by transforming the DC getDisplayBounds method result in WC. To optimize performance, each K2DElement should override this method with its own implementation. See existing implementations (K2DPolygon, K2DPoint, K2DPolyline, etc.) for examples.

Overrides:

getDisplayBoundsWc in class K2DElement

Parameters:

vs - the view state that provides context information to calculate the display bounds of the element.

s - the style used used to calculate the display bounds of the element.

Returns:

the bounding box of the displayed element in WC