A GraphicStroke defines a repeated-linear graphic pattern to be used for stroking a line. More...
#include <GraphicStroke.h>
Public Member Functions | |
Initializer Methods | |
Methods related to instantiation and destruction. | |
| GraphicStroke () | |
| It initializes a new GraphicStroke. More... | |
| ~GraphicStroke () | |
| Destructor. More... | |
Accessor methods | |
Methods used to get or set properties. | |
| Graphic * | m_graphic |
| It specifies the linear graphic. (Mandatory) More... | |
| ParameterValue * | m_initialGap |
| It defines the initial empty space, before the first Graphic or Label should be rendered. (Optional) More... | |
| ParameterValue * | m_gap |
| It defines the empty space between two Graphics or Labels. (Optional) More... | |
| void | setGraphic (Graphic *g) |
| It specifies the linear graphic. More... | |
| const Graphic * | getGraphic () const |
| void | removeGraphic () |
| void | setInitialGap (ParameterValue *initialGap) |
| It specifies how far away the first graphic will be drawn relative to the start of the rendering line. More... | |
| const ParameterValue * | getInitialGap () const |
| void | setGap (ParameterValue *gap) |
| It sets the distance between two graphics. More... | |
| const ParameterValue * | getGap () const |
| GraphicStroke * | clone () const |
| It creates a new copy of this object. More... | |
Detailed Description
A GraphicStroke defines a repeated-linear graphic pattern to be used for stroking a line.
- See also
- Stroke, Graphic, ParameterValue
Definition at line 50 of file GraphicStroke.h.
Constructor & Destructor Documentation
◆ GraphicStroke()
| te::se::GraphicStroke::GraphicStroke | ( | ) |
It initializes a new GraphicStroke.
◆ ~GraphicStroke()
| te::se::GraphicStroke::~GraphicStroke | ( | ) |
Destructor.
Member Function Documentation
◆ clone()
| GraphicStroke * te::se::GraphicStroke::clone | ( | ) | const |
It creates a new copy of this object.
◆ getGap()
| const ParameterValue * te::se::GraphicStroke::getGap | ( | ) | const |
◆ getGraphic()
| const Graphic * te::se::GraphicStroke::getGraphic | ( | ) | const |
◆ getInitialGap()
| const ParameterValue * te::se::GraphicStroke::getInitialGap | ( | ) | const |
◆ removeGraphic()
| void te::se::GraphicStroke::removeGraphic | ( | ) |
◆ setGap()
| void te::se::GraphicStroke::setGap | ( | ParameterValue * | gap | ) |
It sets the distance between two graphics.
- Parameters
-
gap The initial gap.
- Note
- The GraphicStroke object will take the ownership of the informed ParameterValue pointer.
◆ setGraphic()
| void te::se::GraphicStroke::setGraphic | ( | Graphic * | g | ) |
It specifies the linear graphic.
Proper stroking with a linear graphic requires two "hot-spot" points within the space of the graphic to indicate where the rendering line starts and stops. In the case of raster images with no special mark-up, this line will be assumed to be middle pixel row of the image, starting from the first pixel column and ending at the last pixel column.
- Parameters
-
g The linear graphic.
- Note
- The GraphicStroke object will take the ownership of the informed Graphic pointer.
◆ setInitialGap()
| void te::se::GraphicStroke::setInitialGap | ( | ParameterValue * | initialGap | ) |
It specifies how far away the first graphic will be drawn relative to the start of the rendering line.
- Parameters
-
initialGap The initial gap.
- Note
- The GraphicStroke object will take the ownership of the informed ParameterValue pointer.
Member Data Documentation
◆ m_gap
|
private |
It defines the empty space between two Graphics or Labels. (Optional)
Definition at line 122 of file GraphicStroke.h.
◆ m_graphic
|
private |
It specifies the linear graphic. (Mandatory)
Definition at line 120 of file GraphicStroke.h.
◆ m_initialGap
|
private |
It defines the initial empty space, before the first Graphic or Label should be rendered. (Optional)
Definition at line 121 of file GraphicStroke.h.
The documentation for this class was generated from the following file:
- /home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/se/GraphicStroke.h
