 |
Mapper
0.9.0
API documentation
|
|
Mapper
0.9.0
API documentation
|
#include <ocd_file_import.h>
Friends | |
| class | OcdFileImport |
Additional Inherited Members | |
 Public Types inherited from OpenOrienteering::LineSymbol | |
| enum | CapStyle { FlatCap = 0, RoundCap = 1, SquareCap = 2, PointedCap = 3 } |
| enum | JoinStyle { BevelJoin = 0, MiterJoin = 1, RoundJoin = 2 } |
| enum | MidSymbolPlacement { CenterOfDash = 0, CenterOfDashGroup = 1, CenterOfGap = 2, NoMidSymbols = 99 } |
| Mid symbol placement on dashed lines. More... | |
| Public Types inherited from OpenOrienteering::Symbol | |
| enum | Type { Point = 1, Line = 2, Area = 4, Text = 8, Combined = 16, NoSymbol = 0, AllSymbols = Point | Line | Area | Text | Combined } |
| Enumeration of all possible symbol types. More... | |
| enum | RenderableOption { RenderBaselines = 1 << 0, RenderAreasHatched = 1 << 1, RenderNormal = 0 } |
| RenderableOptions denominate variations in painting symbols. More... | |
| Public Member Functions inherited from OpenOrienteering::LineSymbol | |
| LineSymbol () noexcept | |
| Constructs an empty line symbol. More... | |
| ~LineSymbol () override | |
| bool | validate () const override |
| void | createRenderables (const Object *object, const VirtualCoordVector &coords, ObjectRenderables &output, Symbol::RenderableOptions options) const override |
| Creates renderables for a generic object. More... | |
| void | createRenderables (const PathObject *object, const PathPartVector &path_parts, ObjectRenderables &output, Symbol::RenderableOptions options) const override |
| Creates renderables for a path object. More... | |
| void | createSinglePathRenderables (const VirtualPath &path, bool path_closed, ObjectRenderables &output) const |
| Creates the renderables for a single path (i.e. More... | |
| void | colorDeletedEvent (const MapColor *color) override |
| Called when a color is removed from the map. More... | |
| bool | containsColor (const MapColor *color) const override |
| Returns if the given color is used by this symbol. More... | |
| const MapColor * | guessDominantColor () const override |
| Returns the dominant color of this symbol. More... | |
| void | replaceColors (const MapColorMap &color_map) override |
| Replaces colors used by this symbol. More... | |
| void | scale (double factor) override |
| Scales the symbol. More... | |
| void | ensurePointSymbols (const QString &start_name, const QString &mid_name, const QString &end_name, const QString &dash_name) |
| Creates empty point symbols with the given names for undefined subsymbols. More... | |
| void | cleanupPointSymbols () |
| Deletes unused point symbols and sets them to nullptr again. More... | |
| qreal | dimensionForIcon () const override |
| Returns the dimension which shall considered when scaling the icon. More... | |
| qreal | calculateLargestLineExtent () const override |
| Returns the largest extent (half width) of the components of this line. More... | |
| int | getLineWidth () const |
| void | setLineWidth (double width) |
| const MapColor * | getColor () const |
| void | setColor (const MapColor *color) |
| int | getMinimumLength () const |
| void | setMinimumLength (int length) |
| CapStyle | getCapStyle () const |
| void | setCapStyle (CapStyle style) |
| JoinStyle | getJoinStyle () const |
| void | setJoinStyle (JoinStyle style) |
| int | startOffset () const |
| void | setStartOffset (int value) |
| int | endOffset () const |
| void | setEndOffset (int value) |
| bool | isDashed () const |
| void | setDashed (bool value) |
| PointSymbol * | getStartSymbol () const |
| void | setStartSymbol (PointSymbol *symbol) |
| PointSymbol * | getMidSymbol () const |
| void | setMidSymbol (PointSymbol *symbol) |
| PointSymbol * | getEndSymbol () const |
| void | setEndSymbol (PointSymbol *symbol) |
| PointSymbol * | getDashSymbol () const |
| void | setDashSymbol (PointSymbol *symbol) |
| int | getMidSymbolsPerSpot () const |
| void | setMidSymbolsPerSpot (int value) |
| int | getMidSymbolDistance () const |
| void | setMidSymbolDistance (int value) |
| MidSymbolPlacement | getMidSymbolPlacement () const |
| void | setMidSymbolPlacement (MidSymbolPlacement placement) |
| bool | getSuppressDashSymbolAtLineEnds () const |
| void | setSuppressDashSymbolAtLineEnds (bool value) |
| bool | getScaleDashSymbol () const |
| void | setScaleDashSymbol (bool value) |
| int | getSegmentLength () const |
| void | setSegmentLength (int value) |
| int | getEndLength () const |
| void | setEndLength (int value) |
| bool | getShowAtLeastOneSymbol () const |
| void | setShowAtLeastOneSymbol (bool value) |
| int | getMinimumMidSymbolCount () const |
| void | setMinimumMidSymbolCount (int value) |
| int | getMinimumMidSymbolCountWhenClosed () const |
| void | setMinimumMidSymbolCountWhenClosed (int value) |
| int | getDashLength () const |
| void | setDashLength (int value) |
| int | getBreakLength () const |
| void | setBreakLength (int value) |
| int | getDashesInGroup () const |
| void | setDashesInGroup (int value) |
| int | getInGroupBreakLength () const |
| void | setInGroupBreakLength (int value) |
| bool | getHalfOuterDashes () const |
| void | setHalfOuterDashes (bool value) |
| bool | hasBorder () const |
| void | setHasBorder (bool value) |
| bool | areBordersDifferent () const |
| LineSymbolBorder & | getBorder () |
| const LineSymbolBorder & | getBorder () const |
| LineSymbolBorder & | getRightBorder () |
| const LineSymbolBorder & | getRightBorder () const |
| SymbolPropertiesWidget * | createPropertiesWidget (SymbolSettingDialog *dialog) override |
| Creates a properties widget for the symbol. More... | |
| Public Member Functions inherited from OpenOrienteering::Symbol | |
| Symbol (Type type) noexcept | |
| virtual | ~Symbol () |
| Symbol & | operator= (const Symbol &)=delete |
| Symbol & | operator= (Symbol &&)=delete |
| bool | equals (const Symbol *other, Qt::CaseSensitivity case_sensitivity=Qt::CaseSensitive) const |
| Checks for equality to the other symbol. More... | |
| bool | stateEquals (const Symbol *other) const |
| Checks protected/hidden state for equality to the other symbol. More... | |
| Type | getType () const |
| Returns the type of the symbol. More... | |
| const PointSymbol * | asPoint () const |
| Case to PointSymbol with type checking. More... | |
| PointSymbol * | asPoint () |
| Case to PointSymbol with type checking. More... | |
| const LineSymbol * | asLine () const |
| Case to LineSymbol with type checking. More... | |
| LineSymbol * | asLine () |
| Case to LineSymbol with type checking. More... | |
| const AreaSymbol * | asArea () const |
| Case to AreaSymbol with type checking. More... | |
| AreaSymbol * | asArea () |
| Case to AreaSymbol with type checking. More... | |
| const TextSymbol * | asText () const |
| Case to TextSymbol with type checking. More... | |
| TextSymbol * | asText () |
| Case to TextSymbol with type checking. More... | |
| const CombinedSymbol * | asCombined () const |
| Case to CombinedSymbol with type checking. More... | |
| CombinedSymbol * | asCombined () |
| Case to CombinedSymbol with type checking. More... | |
| virtual TypeCombination | getContainedTypes () const |
| Returns the combined bitmask of all symbol types this symbol contains. More... | |
| bool | isTypeCompatibleTo (const Object *object) const |
| Checks if the symbol can be applied to the given object. More... | |
| bool | numberEquals (const Symbol *other) const |
| Returns if the symbol numbers are exactly equal. More... | |
| bool | numberEqualsRelaxed (const Symbol *other) const |
| Returns if the symbol numbers are equal, ignoring trailing zeros. More... | |
| void | save (QXmlStreamWriter &xml, const Map &map) const |
| Saves the symbol in xml format. More... | |
| virtual bool | loadingFinishedEvent (Map *map) |
| Called when loading the map is finished. More... | |
| virtual void | createBaselineRenderables (const PathObject *object, const PathPartVector &path_parts, ObjectRenderables &output, const MapColor *color) const |
| Creates baseline renderables for a path object. More... | |
| virtual bool | symbolChangedEvent (const Symbol *old_symbol, const Symbol *new_symbol) |
| Called when a symbol was changed, replaced, or removed. More... | |
| virtual bool | containsSymbol (const Symbol *symbol) const |
| Returns true if the given symbol is referenced by this symbol. More... | |
| QImage | getCustomIcon () const |
| Returns the custom symbol icon. More... | |
| void | setCustomIcon (const QImage &image) |
| Sets a custom symbol icon. More... | |
| QImage | getIcon (const Map *map) const |
| Returns the symbol's icon. More... | |
| QImage | createIcon (const Map &map, int side_length, bool antialiasing=true, qreal zoom=0) const |
| Creates a symbol icon with the given side length (pixels). More... | |
| void | resetIcon () |
| Clear the symbol's cached icon. More... | |
| const QString & | getName () const |
| Returns the symbol name. More... | |
| QString | getPlainTextName () const |
| Returns the symbol name with all HTML markup stripped. More... | |
| void | setName (const QString &new_name) |
| Sets the symbol name. More... | |
| QString | getNumberAsString () const |
| Returns the symbol number as string. More... | |
| int | getNumberComponent (int i) const |
| Returns the i-th component of the symbol number as int. More... | |
| void | setNumberComponent (int i, int new_number) |
| Sets the i-th component of the symbol number. More... | |
| const QString & | getDescription () const |
| Returns the symbol description. More... | |
| void | setDescription (const QString &new_description) |
| Sets the symbol description. More... | |
| bool | isHelperSymbol () const |
| Returns if this is a helper symbol (which is not printed in the final map). More... | |
| void | setIsHelperSymbol (bool value) |
| Sets if this is a helper symbol, see isHelperSymbol(). More... | |
| bool | isHidden () const |
| Returns if this symbol is hidden. More... | |
| void | setHidden (bool value) |
| Sets the hidden state of this symbol. More... | |
| bool | isProtected () const |
| Returns if this symbol is protected. More... | |
| void | setProtected (bool value) |
| Sets the protected state of this symbol. More... | |
| bool | isRotatable () const |
| Returns if objects with this symbol can be rotated in arbitrary directions. More... | |
| Static Public Member Functions inherited from OpenOrienteering::LineSymbol | |
| static constexpr qreal | miterLimit () |
| Returns the limit for miter joins in units of the line width. More... | |
| Static Public Member Functions inherited from OpenOrienteering::Symbol | |
| template<class S > | |
| static std::unique_ptr< S > | duplicate (const S &s) |
| Duplicates a symbol. More... | |
| static std::unique_ptr< Symbol > | load (QXmlStreamReader &xml, const Map &map, SymbolDictionary &symbol_dict, int version) |
| Load the symbol in xml format. More... | |
| static std::unique_ptr< Symbol > | makeSymbolForType (Type type) |
| Returns a newly created symbol of the given type. More... | |
| static bool | areTypesCompatible (Type a, Type b) |
| Returns if the symbol types can be applied to the same object types. More... | |
| static TypeCombination | getCompatibleTypes (Type type) |
| Returns a bitmask of all types which can be applied to the same objects as the given type. More... | |
| static bool | lessByNumber (const Symbol *s1, const Symbol *s2) |
| Compares two symbols by number. More... | |
| static bool | lessByColorPriority (const Symbol *s1, const Symbol *s2) |
| Compares two symbols by the dominant colors' priorities. More... | |
| Static Public Attributes inherited from OpenOrienteering::Symbol | |
| static constexpr auto | number_components = 3u |
| Number of components of symbol numbers. More... | |
| Protected Member Functions inherited from OpenOrienteering::LineSymbol | |
| LineSymbol (const LineSymbol &proto) | |
| LineSymbol * | duplicate () const override |
| void | saveImpl (QXmlStreamWriter &xml, const Map &map) const override |
| Must be overridden to save type-specific symbol properties. More... | |
| bool | loadImpl (QXmlStreamReader &xml, const Map &map, SymbolDictionary &symbol_dict, int version) override |
| Must be overridden to load type-specific symbol properties. More... | |
| PointSymbol * | loadPointSymbol (QXmlStreamReader &xml, const Map &map, SymbolDictionary &symbol_dict, int version) |
| bool | equalsImpl (const Symbol *other, Qt::CaseSensitivity case_sensitivity) const override |
| Must be overridden to compare specific attributes. More... | |
| void | createBorderLines (const VirtualPath &path, const SplitPathCoord &start, const SplitPathCoord &end, ObjectRenderables &output) const |
| Creates the border lines' renderables for a single path (i.e. More... | |
| void | shiftCoordinates (const VirtualPath &path, double main_shift, MapCoordVector &out_flags, MapCoordVectorF &out_coords) const |
| void | processContinuousLine (const VirtualPath &path, const SplitPathCoord &start, const SplitPathCoord &end, bool set_mid_symbols, MapCoordVector &processed_flags, MapCoordVectorF &processed_coords, ObjectRenderables &output) const |
| Creates flags and coords for a continuous line segment, and adds pointed line caps and mid symbol renderables to the output. More... | |
| void | createPointedLineCap (const VirtualPath &path, const SplitPathCoord &start, const SplitPathCoord &end, bool is_end, ObjectRenderables &output) const |
| void | processDashedLine (const VirtualPath &path, const SplitPathCoord &start, const SplitPathCoord &end, bool path_closed, MapCoordVector &out_flags, MapCoordVectorF &out_coords, ObjectRenderables &output) const |
| Creates flags and coords for a single dashed path (i.e. More... | |
| SplitPathCoord | createDashGroups (const VirtualPath &path, bool path_closed, const SplitPathCoord &line_start, const SplitPathCoord &start, const SplitPathCoord &end, bool is_part_start, bool is_part_end, MapCoordVector &out_flags, MapCoordVectorF &out_coords, ObjectRenderables &output) const |
| Creates flags and coords for a single dashed path section, and adds pointed line caps and mid symbol renderables to the output. More... | |
| void | createDashSymbolRenderables (const VirtualPath &path, bool path_closed, ObjectRenderables &output) const |
| void | createMidSymbolRenderables (const VirtualPath &path, const SplitPathCoord &start, const SplitPathCoord &end, bool path_closed, ObjectRenderables &output) const |
| Adds just the mid symbol renderables for a single solid path (i.e. More... | |
| void | createStartEndSymbolRenderables (const PathPartVector &path_parts, ObjectRenderables &output) const |
| Adds just the start and end symbol renderables to the output. More... | |
| void | replaceSymbol (PointSymbol *&old_symbol, PointSymbol *replace_with, const QString &name) |
| Protected Member Functions inherited from OpenOrienteering::Symbol | |
| Symbol (const Symbol &proto) | |
| void | setRotatable (bool value) |
| Sets the rotatability state of the symbol. More... | |
| Protected Attributes inherited from OpenOrienteering::LineSymbol | |
| LineSymbolBorder | border |
| LineSymbolBorder | right_border |
| PointSymbol * | start_symbol |
| PointSymbol * | mid_symbol |
| PointSymbol * | end_symbol |
| PointSymbol * | dash_symbol |
| const MapColor * | color |
| int | line_width |
| int | minimum_length |
| int | start_offset |
| int | end_offset |
| int | mid_symbols_per_spot |
| int | mid_symbol_distance |
| int | minimum_mid_symbol_count |
| int | minimum_mid_symbol_count_when_closed |
| int | segment_length |
| int | end_length |
| int | dash_length |
| int | break_length |
| int | dashes_in_group |
| int | in_group_break_length |
| CapStyle | cap_style |
| JoinStyle | join_style |
| MidSymbolPlacement | mid_symbol_placement |
| bool | dashed |
| bool | half_outer_dashes |
| bool | show_at_least_one_symbol |
| bool | suppress_dash_symbol_at_ends |
| bool | scale_dash_symbol |
| bool | have_border_lines |
|
friend |
1.8.13