org.gvsig.symbology.fmap.mapcontext.rendering.symbol.marker.impl

Class AbstractMarkerSymbol

java.lang.Object

org.gvsig.symbology.fmap.mapcontext.rendering.symbol.impl.AbstractSymbol

org.gvsig.symbology.fmap.mapcontext.rendering.symbol.marker.impl.AbstractMarkerSymbol

All Implemented Interfaces:

java.lang.Cloneable, CartographicSupport, IPrintable, ISymbol, ISymbol_v2, IMarkerSymbol, Persistent

Direct Known Subclasses:

ArrowMarkerSymbol, MultiLayerMarkerSymbol, PictureMarkerSymbol, SimpleMarkerSymbol

public abstract class AbstractMarkerSymbol
extends AbstractSymbol
implements IMarkerSymbol

Abstract class that any MARKER SYMBOL should extend.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractMarkerSymbol.RegisterPersistence

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MARKER_SYMBOL_PERSISTENCE_DEFINITION_NAME

Fields inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.symbol.impl.AbstractSymbol

SYMBOL_PERSISTENCE_DEFINITION_NAME

Fields inherited from interface org.gvsig.symbology.fmap.mapcontext.rendering.symbol.marker.IMarkerSymbol

CIRCLE_STYLE, CROSS_STYLE, DIAMOND_STYLE, SQUARE_STYLE, STAR_STYLE, SYMBOL_NAME, TRIANGLE_STYLE, VERTICAL_LINE_STYLE, X_STYLE

Fields inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol

SELECTION_COLOR

Fields inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.CartographicSupport

PAPER, WORLD

Constructor Summary

Constructors

Constructor and Description
AbstractMarkerSymbol()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a copy of the object.
void	drawInsideRectangle(java.awt.Graphics2D g, java.awt.geom.AffineTransform scaleInstance, java.awt.Rectangle r, PrintAttributes properties) Useful to render the symbol inside the TOC, or inside little rectangles.
double	getCartographicSize(ViewPort viewPort, double dpi, Geometry geom) Gets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).
java.awt.Color	getColor() Returns the color of the marker symbol.
IMask	getMask()
java.awt.geom.Point2D	getOffset() Gets the offset for a marker symbol
int	getOnePointRgb() Returns the rgb of the symbol when it is drawn like a point.
void	getPixExtentPlus(Geometry geom, float[] distances, ViewPort viewPort, int dpi) Returns the distance between the shape's bounding box and the symbol-that-represents-this-shape's bounding box in a two-length-float array passed as parameter.
double	getRotation() Returns the rotation (in radians, counter-clockwise) of the marker symbol
double	getSize() Obtains the size of a marker symbol
int	getSymbolType() The use of this method -and its mechanism- is being valorated.
boolean	isSuitableFor(Geometry geom) True if this symbol is ok for the geometry.
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
void	print(java.awt.Graphics2D g, java.awt.geom.AffineTransform at, Geometry geom, PrintAttributes properties)
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setAlpha(int outlineAlpha) Defines the transparency of a line symbol.
void	setCartographicSize(double cartographicSize, Geometry geom) Sets the size of the cartographic element in pixels.
void	setColor(java.awt.Color color) Establishes a color for the marker symbol
void	setMask(IMask mask) Defines a mask for the symbol
void	setOffset(java.awt.geom.Point2D offset) Establishes the offset currently set for the marker symbol.
void	setRotation(double r) Sets the rotation of the marker symbol
void	setSize(double size) Sets the size of marker symbol
double	toCartographicSize(ViewPort viewPort, double dpi, Geometry geom) Computes and sets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).

Methods inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.symbol.impl.AbstractSymbol

cloneForSelection, equals, getDescription, getID, getReferenceSystem, getUnit, isOneDotOrPixel, isShapeVisible, setDescription, setID, setIsShapeVisible, setReferenceSystem, setUnit

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol

draw, getDescription, getSymbolForSelection, isOneDotOrPixel, isShapeVisible, setDescription

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.CartographicSupport

getReferenceSystem, getUnit, setReferenceSystem, setUnit

Field Detail

MARKER_SYMBOL_PERSISTENCE_DEFINITION_NAME

public static final java.lang.String MARKER_SYMBOL_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

AbstractMarkerSymbol

public AbstractMarkerSymbol()

Method Detail

getSymbolType

public final int getSymbolType()

Description copied from interface: ISymbol

The use of this method -and its mechanism- is being valorated. It probably will be deprecated.

Specified by:

getSymbolType in interface ISymbol

Returns:

FSymbol constants. I think it is better to use isSuitableFor

getRotation

public double getRotation()

Description copied from interface: IMarkerSymbol

Returns the rotation (in radians, counter-clockwise) of the marker symbol

Specified by:

getRotation in interface IMarkerSymbol

Returns:

double (rotation)

setRotation

public void setRotation(double r)

Description copied from interface: IMarkerSymbol

Sets the rotation of the marker symbol

Specified by:

setRotation in interface IMarkerSymbol

getOffset

public java.awt.geom.Point2D getOffset()

Description copied from interface: IMarkerSymbol

Gets the offset for a marker symbol

Specified by:

getOffset in interface IMarkerSymbol

Returns:

Point2D

setOffset

public void setOffset(java.awt.geom.Point2D offset)

Description copied from interface: IMarkerSymbol

Establishes the offset currently set for the marker symbol.

Specified by:

setOffset in interface IMarkerSymbol

isSuitableFor

public boolean isSuitableFor(Geometry geom)

Description copied from interface: ISymbol

True if this symbol is ok for the geometry. For example, a FillSymbol will be suitable for a Polygon.

Specified by:

isSuitableFor in interface ISymbol

Returns:

getOnePointRgb

public int getOnePointRgb()

Description copied from interface: ISymbol

Returns the rgb of the symbol when it is drawn like a point.

Specified by:

getOnePointRgb in interface ISymbol

Returns:

rgb of the symbol.

getSize

public double getSize()

Description copied from interface: IMarkerSymbol

Obtains the size of a marker symbol

Specified by:

getSize in interface IMarkerSymbol

setSize

public void setSize(double size)

Description copied from interface: IMarkerSymbol

Sets the size of marker symbol

Specified by:

setSize in interface IMarkerSymbol

getColor

public java.awt.Color getColor()

Description copied from interface: IMarkerSymbol

Returns the color of the marker symbol.

Specified by:

getColor in interface ISymbol

Specified by:

getColor in interface IMarkerSymbol

Returns:

Color

setColor

public void setColor(java.awt.Color color)

Description copied from interface: IMarkerSymbol

Establishes a color for the marker symbol

Specified by:

setColor in interface ISymbol

Specified by:

setColor in interface IMarkerSymbol

Parameters:

color - to render the symbol

setAlpha

public void setAlpha(int outlineAlpha)

Description copied from interface: IMarkerSymbol

Defines the transparency of a line symbol.

Specified by:

setAlpha in interface IMarkerSymbol

getPixExtentPlus

public void getPixExtentPlus(Geometry geom,
                    float[] distances,
                    ViewPort viewPort,
                    int dpi)

Description copied from interface: ISymbol

Returns the distance between the shape's bounding box and the symbol-that-represents-this-shape's bounding box in a two-length-float array passed as parameter.

After this method returns, the float array passed will contain two values representing the amount of pixels separating each of the X (first element) and Y (second element) axes.

This distance maybe dependent on:

1. The ViewPort: if the symbol is an instance of CartographicSupport the units it uses are not pixels and the reference system is CarthographicSupport.WORLD.
2. The target rendering context's dpi (dots-per-inch): if the symbol is an instance of CartographicSupport the units it uses are not pixels and CarthographicSupport.PAPER.

And in any other case, if the unit of the symbol is pixels or the symbol is not even an instance of CartographicSupport, the returning values are only defined by the symbol and are not calculated.

Specified by:

getPixExtentPlus in interface ISymbol

print

public void print(java.awt.Graphics2D g,
         java.awt.geom.AffineTransform at,
         Geometry geom,
         PrintAttributes properties)

Specified by:

print in interface IPrintable

getMask

public final IMask getMask()

Specified by:

getMask in interface IMarkerSymbol

Returns:

the mask of the symbol

drawInsideRectangle

public void drawInsideRectangle(java.awt.Graphics2D g,
                       java.awt.geom.AffineTransform scaleInstance,
                       java.awt.Rectangle r,
                       PrintAttributes properties)
                         throws SymbolDrawingException

Description copied from interface: ISymbol

Useful to render the symbol inside the TOC, or inside little rectangles. For example, think about rendering a Label with size in meters => You will need to specify a size in pixels. Of course, you can also to choose to render a prepared image, etc.

Specified by:

drawInsideRectangle in interface ISymbol

properties - TODO

Throws:

SymbolDrawingException - TODO

setMask

public final void setMask(IMask mask)

Description copied from interface: IMarkerSymbol

Defines a mask for the symbol

Specified by:

setMask in interface IMarkerSymbol

setCartographicSize

public void setCartographicSize(double cartographicSize,
                       Geometry geom)

Description copied from interface: CartographicSupport

Sets the size of the cartographic element in pixels.

Specified by:

setCartographicSize in interface CartographicSupport

toCartographicSize

public double toCartographicSize(ViewPort viewPort,
                        double dpi,
                        Geometry geom)

Description copied from interface: CartographicSupport

Computes and sets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).

Specified by:

toCartographicSize in interface CartographicSupport

Returns:

a double containing the previous defined size

getCartographicSize

public double getCartographicSize(ViewPort viewPort,
                         double dpi,
                         Geometry geom)

Description copied from interface: CartographicSupport

Gets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).

Specified by:

getCartographicSize in interface CartographicSupport

Returns:

double containing the size in [screen/printer] pixels for the current symbol

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Description copied from interface: Cloneable

Creates a copy of the object.

Overrides:

clone in class AbstractSymbol

Returns:

a copy of the object

Throws:

java.lang.CloneNotSupportedException - if the instance of the object cannot be cloned. As this is extending Cloneable so its sure it implements it, so this exception may be used for problems on specific object instances.

See Also:

Object#clone()}.

loadFromState

public void loadFromState(PersistentState state)
                   throws PersistenceException

Description copied from interface: Persistent

Set the state of the object from the state passed as parameter.

Specified by:

loadFromState in interface Persistent

Overrides:

loadFromState in class AbstractSymbol

Throws:

PersistenceException

saveToState

public void saveToState(PersistentState state)
                 throws PersistenceException

Description copied from interface: Persistent

Saves the internal state of the object on the provided PersistentState object.

Specified by:

saveToState in interface Persistent

Overrides:

saveToState in class AbstractSymbol

Throws:

PersistenceException