te::se::Mark Class Reference

A Mark specifies a geometric shape and applies coloring to it. More...

#include <Mark.h>

Inheritance diagram for te::se::Mark:

Public Member Functions

Markclone () const
 It creates a new copy of this object. More...
 
const FillgetFill () const
 
const std::string * getFormat () const
 
InlineContentgetInlineContent () const
 
int getMarkIndex () const
 
const te::xl::SimpleLinkgetOnlineResource () const
 
const StrokegetStroke () const
 
const std::string * getWellKnownName () const
 
void setFill (Fill *f)
 
void setFormat (std::string *f)
 
void setInlineContent (InlineContent *iContent)
 
void setMarkIndex (int i)
 
void setOnlineResource (te::xl::SimpleLink *link)
 
void setStroke (Stroke *s)
 
void setWellKnownName (std::string *name)
 The WellKnownName element gives the well-known name of the shape of the mark. More...
 
Initializer Methods

Methods related to instantiation and destruction.

 Mark ()
 It initializes a new Mark. More...
 
 ~Mark ()
 Destructor. More...
 

Private Attributes

Fillm_fill
 It specifies the pattern for filling an area geometry. (Optional) More...
 
std::string * m_format
 Identifies the expected document MIME type of a successful fetch. (Mandatory if onlineResource_ or inlineContent_ is set) More...
 
InlineContentm_inlineContent
 Allows the content of an external graphic object to be included in-line. (Optional and just one of onlineResource_ or inlineContent_ can be set a time) More...
 
int m_markIndex
 It allows an individual mark in a mark archive to be selected. (Optional and it should be set only if onlineResource_ or inlineContent_ is set) More...
 
te::xl::SimpleLinkm_onlineResource
 The graphics can either be referenced from an external URL in a common format. (Optional and just one of onlineResource_ or inlineContent_ can be set a time) More...
 
Strokem_stroke
 It specifies the appearance of a linear geometry. (Optional) More...
 
std::string * m_wellKnownName
 The WellKnownName element gives the well-known name of the shape of the mark. (Optional and if it is set then nor onlineResource_ neither inlineContent_ should be set) More...
 

Detailed Description

A Mark specifies a geometric shape and applies coloring to it.

The WellKnownName element gives the well-known name of the shape of the mark. Allowed values include at least "square", "circle", "triangle", "star", "cross", and "x", though map servers may draw a different symbol instead if they don't have a shape for all of these. The default WellKnownName is "square". Renderings of these marks may be made solid or hollow depending on Fill and Stroke elements.

The alternative to a WellKnownName is an external mark format. The MarkIndex allows an individual mark in a mark archive to be selected. An example format for an external mark achive would be a TrueType font file, with MarkIndex being used to select an individual glyph from that file.

The Mark element serves two purposes. It allows the selection of simple shapes, and, in combination with the capability to select and mix multiple external-URL graphics and marks, it allows a style to be specified that can produce a usable result in a best-effort rendering environment, provided that a simple Mark is included at the bottom of the list of sources for every Graphic.

See also
Graphic, Fill, Stroke, InlineContent

Definition at line 84 of file Mark.h.

Constructor & Destructor Documentation

te::se::Mark::Mark ( )

It initializes a new Mark.

te::se::Mark::~Mark ( )

Destructor.

Member Function Documentation

Mark* te::se::Mark::clone ( ) const

It creates a new copy of this object.

const Fill* te::se::Mark::getFill ( ) const
const std::string* te::se::Mark::getFormat ( ) const
InlineContent* te::se::Mark::getInlineContent ( ) const
int te::se::Mark::getMarkIndex ( ) const
const te::xl::SimpleLink* te::se::Mark::getOnlineResource ( ) const
const Stroke* te::se::Mark::getStroke ( ) const
const std::string* te::se::Mark::getWellKnownName ( ) const
void te::se::Mark::setFill ( Fill f)
void te::se::Mark::setFormat ( std::string *  f)
void te::se::Mark::setInlineContent ( InlineContent iContent)
void te::se::Mark::setMarkIndex ( int  i)
void te::se::Mark::setOnlineResource ( te::xl::SimpleLink link)
void te::se::Mark::setStroke ( Stroke s)
void te::se::Mark::setWellKnownName ( std::string *  name)

The WellKnownName element gives the well-known name of the shape of the mark.

Allowed values include at least "square", "circle", "triangle", "star", "cross", and "x". The default WellKnownName is "square".

Member Data Documentation

Fill* te::se::Mark::m_fill
private

It specifies the pattern for filling an area geometry. (Optional)

Definition at line 145 of file Mark.h.

std::string* te::se::Mark::m_format
private

Identifies the expected document MIME type of a successful fetch. (Mandatory if onlineResource_ or inlineContent_ is set)

Definition at line 143 of file Mark.h.

InlineContent* te::se::Mark::m_inlineContent
private

Allows the content of an external graphic object to be included in-line. (Optional and just one of onlineResource_ or inlineContent_ can be set a time)

Definition at line 142 of file Mark.h.

int te::se::Mark::m_markIndex
private

It allows an individual mark in a mark archive to be selected. (Optional and it should be set only if onlineResource_ or inlineContent_ is set)

Definition at line 144 of file Mark.h.

te::xl::SimpleLink* te::se::Mark::m_onlineResource
private

The graphics can either be referenced from an external URL in a common format. (Optional and just one of onlineResource_ or inlineContent_ can be set a time)

Definition at line 141 of file Mark.h.

Stroke* te::se::Mark::m_stroke
private

It specifies the appearance of a linear geometry. (Optional)

Definition at line 146 of file Mark.h.

std::string* te::se::Mark::m_wellKnownName
private

The WellKnownName element gives the well-known name of the shape of the mark. (Optional and if it is set then nor onlineResource_ neither inlineContent_ should be set)

Definition at line 140 of file Mark.h.


The documentation for this class was generated from the following file: