public class CharacterMarkerSymbol extends Object implements IMarkerSymbol
Modifier and Type | Field and Description |
---|---|
static String |
CHARACTER_MARKER_SYMBOL_PERSISTENCE_NAME |
CIRCLE_STYLE, CROSS_STYLE, DIAMOND_STYLE, SQUARE_STYLE, STAR_STYLE, SYMBOL_NAME, TRIANGLE_STYLE, VERTICAL_LINE_STYLE, X_STYLE
SELECTION_COLOR
PAPER, WORLD
Constructor and Description |
---|
CharacterMarkerSymbol()
Creates a new instance of CharacterMarker with default values
|
CharacterMarkerSymbol(Font font,
int charCode,
Color color)
Creates a new instance of CharacterMarker specifying the marker source
font, the character code corresponding to the symbol, and the color that
will be used in rendering time.
|
Modifier and Type | Method and Description |
---|---|
Object |
clone()
Creates a copy of the object.
|
void |
draw(Graphics2D g,
AffineTransform affineTransform,
Geometry geom,
Feature feat,
Cancellable cancel)
Used when a symbol is going to be drawn.The method to do
it will depend on the derived version of the symbol.
|
void |
drawInsideRectangle(Graphics2D g,
AffineTransform scaleInstance,
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).
|
Color |
getColor()
Returns the color of the marker symbol.
|
String |
getDescription()
The description is a human-readable text used to label it when show in a symbol menu or something like that.
|
Font |
getFont()
Returns the font that will be used to define the symbol
|
IMask |
getMask() |
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.
|
int |
getReferenceSystem()
Returns the Reference System used to draw the elements of the image.
|
double |
getRotation()
Returns the rotation (in radians, counter-clockwise) of the marker symbol
|
double |
getSize()
Obtains the size of a marker symbol
|
ISymbol |
getSymbolForSelection()
Returns the derived version of the symbol that will be used to draw the
feature when it is selected.
|
int |
getSymbolType()
The use of this method -and its mechanism- is being valorated.
|
int |
getUnicode()
Obtains the unicode for a symbol
|
int |
getUnit()
Returns the unit used to express measures.
|
boolean |
isOneDotOrPixel(Geometry geom,
double[] positionOfDotOrPixel,
ViewPort viewPort,
int dpi)
Informs that the geometry will be represented with that symbol in just one pixel or dot
|
boolean |
isShapeVisible()
Tells whether the shape of the symbol will be drawn or not.
|
boolean |
isSuitableFor(Geometry geom)
True if this symbol is ok for the geometry.
|
boolean |
isVisuallyCorrected()
Returns true of false depending if the character marker symbol selected is visually
corrected.That is, if the character has been properly scaled to use a specific number
of pixels to be represented.
|
void |
loadFromState(PersistentState state)
Set the state of the object from the state passed as parameter.
|
void |
print(Graphics2D g,
AffineTransform at,
Geometry geom,
PrintAttributes properties) |
static void |
registerPersistent() |
void |
saveToState(PersistentState state)
Saves the internal state of the object on the provided
PersistentState object.
|
void |
setAlpha(int a)
Defines the transparency of a line symbol.
|
void |
setCartographicSize(double cartographicSize,
Geometry geom)
Sets the size of the cartographic element in pixels.
|
void |
setColor(Color co)
Establishes a color for the marker symbol
|
void |
setDescription(String d)
Sets the description of this symbol
|
void |
setFont(Font font)
Sets the font that will be used to define the symbol
|
void |
setMask(IMask m)
Defines a mask for the symbol
|
void |
setOffset(Point2D off)
Establishes the offset currently set for the marker symbol.
|
void |
setReferenceSystem(int rs)
Sets the Reference System that defines how this units have to be
handled.
|
void |
setRotation(double rot)
Sets the rotation of the marker symbol
|
void |
setSize(double size)
Sets the size of marker symbol
|
void |
setUnicode(int symbol)
Sets the unicode for a symbol represented by a character
|
void |
setUnit(int unitIndex)
Defines the unit used to express measures.
|
void |
setVisuallyCorrected(boolean visuallyCorrected)
Sets the visual correction for a character in order to scale it if it is necessary.
|
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).
|
public static final String CHARACTER_MARKER_SYMBOL_PERSISTENCE_NAME
public CharacterMarkerSymbol()
public CharacterMarkerSymbol(Font font, int charCode, Color color)
font
- -
src FontcharCode
- -
character code of the symbol for this fontcolor
- -
color to be used in when rendering.public Font getFont()
public void setFont(Font font)
public ISymbol getSymbolForSelection()
ISymbol
getSymbolForSelection
in interface ISymbol
public void draw(Graphics2D g, AffineTransform affineTransform, Geometry geom, Feature feat, Cancellable cancel)
ISymbol
public void setUnicode(int symbol)
symbol,
- intpublic int getUnicode()
public double getSize()
IMarkerSymbol
getSize
in interface IMarkerSymbol
public void setSize(double size)
IMarkerSymbol
setSize
in interface IMarkerSymbol
public boolean isVisuallyCorrected()
public void setVisuallyCorrected(boolean visuallyCorrected)
public Object clone() throws CloneNotSupportedException
Cloneable
clone
in class Object
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.Object#clone()}.
public void getPixExtentPlus(Geometry geom, float[] distances, ViewPort viewPort, int dpi)
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:
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.
getPixExtentPlus
in interface ISymbol
public boolean isOneDotOrPixel(Geometry geom, double[] positionOfDotOrPixel, ViewPort viewPort, int dpi)
ISymbol
isOneDotOrPixel
in interface ISymbol
positionOfDotOrPixel
- (out) filled with pixel or dot locationpublic int getOnePointRgb()
ISymbol
getOnePointRgb
in interface ISymbol
public String getDescription()
ISymbol
getDescription
in interface ISymbol
public boolean isShapeVisible()
ISymbol
isShapeVisible
in interface ISymbol
public void setDescription(String d)
ISymbol
setDescription
in interface ISymbol
ISymbol.getDescription();
public int getSymbolType()
ISymbol
getSymbolType
in interface ISymbol
public boolean isSuitableFor(Geometry geom)
ISymbol
isSuitableFor
in interface ISymbol
public void drawInsideRectangle(Graphics2D g, AffineTransform scaleInstance, Rectangle r, PrintAttributes properties) throws SymbolDrawingException
ISymbol
drawInsideRectangle
in interface ISymbol
properties
- TODOSymbolDrawingException
- TODOpublic void print(Graphics2D g, AffineTransform at, Geometry geom, PrintAttributes properties)
print
in interface IPrintable
public void setUnit(int unitIndex)
CartographicSupport
setUnit
in interface CartographicSupport
public int getUnit()
CartographicSupport
getUnit
in interface CartographicSupport
public int getReferenceSystem()
CartographicSupport
The elements have to be scaled to pixel when the image is bein drawn in
order to compose the map. The elements of the map may define its size in
other units than pixel.
CartographicSupport enables the elements to define the size in
measure units but these units may refer to different reference system. Two
kinds of Reference Systems are allowed in this context: CartographicSupport.WORLD,
and CartographicSupport.PAPER.
Depending on which Reference System is used the unit used by this element
refers to distances in the real world (then they are map's CRS-dependant)
or screen or printer output (then they are output DPI-dependant)
In case the unit used is pixel then the reference system does not
have any effect since the source unit is the same than the target unit.
getReferenceSystem
in interface CartographicSupport
public void setReferenceSystem(int rs)
CartographicSupport
setReferenceSystem
in interface CartographicSupport
public double toCartographicSize(ViewPort viewPort, double dpi, Geometry geom)
CartographicSupport
toCartographicSize
in interface CartographicSupport
public void setCartographicSize(double cartographicSize, Geometry geom)
CartographicSupport
setCartographicSize
in interface CartographicSupport
public double getCartographicSize(ViewPort viewPort, double dpi, Geometry geom)
CartographicSupport
getCartographicSize
in interface CartographicSupport
public double getRotation()
IMarkerSymbol
getRotation
in interface IMarkerSymbol
public void setRotation(double rot)
IMarkerSymbol
setRotation
in interface IMarkerSymbol
public Point2D getOffset()
IMarkerSymbol
getOffset
in interface IMarkerSymbol
public void setOffset(Point2D off)
IMarkerSymbol
setOffset
in interface IMarkerSymbol
public Color getColor()
IMarkerSymbol
getColor
in interface ISymbol
getColor
in interface IMarkerSymbol
public void setColor(Color co)
IMarkerSymbol
setColor
in interface ISymbol
setColor
in interface IMarkerSymbol
co
- to render the symbolpublic void setAlpha(int a)
IMarkerSymbol
setAlpha
in interface IMarkerSymbol
public IMask getMask()
getMask
in interface IMarkerSymbol
public void setMask(IMask m)
IMarkerSymbol
setMask
in interface IMarkerSymbol
public void loadFromState(PersistentState state) throws PersistenceException
Persistent
loadFromState
in interface Persistent
PersistenceException
public void saveToState(PersistentState state) throws PersistenceException
Persistent
saveToState
in interface Persistent
PersistenceException
public static void registerPersistent()