 |
LuciadCPillar 2023.1.05
|
|
LuciadCPillar 2023.1.05
|
Builder for a LonLat grid setting. More...
#include <luciad/layers/grids/lonlat/LonLatGrid.h>
Public Member Functions | |
| Builder (const Builder &other) | |
| ~Builder () | |
| LonLatGridSetting | build () const |
| Returns the LonLat grid setting. More... | |
| Builder & | deltaLat (double deltaLat) |
| Indicates the delta angle between latitude grid lines in degrees. More... | |
| Builder & | deltaLon (double deltaLon) |
| Indicates the delta angle between longitude grid lines in degrees. More... | |
| Builder & | labelEdgeOffset (double labelEdgeOffset) |
| This specifies the offset of the label, away from the edges of the view, in device independent pixels. More... | |
| Builder & | labelFormat (const std::string &labelFormat) |
| This specifies the format pattern to use for the labels of the current LonLat grid. More... | |
| Builder & | labelGridOffset (double labelGridOffset) |
| This specifies the offset of the label, in device independent pixels, away from the grid line to which it is attached. More... | |
| Builder & | labelOrientation (GridLabelOrientation labelOrientation) |
| This specifies the label orientation with respect to the line. More... | |
| Builder & | labelPosition (LonLatGridLabelPosition labelPosition) |
| This specifies the label position with respect to the view. More... | |
| Builder & | labelStyle (TextStyle labelStyle) |
| Indicates the label style to use for this setting. More... | |
| Builder & | lineLabelPosition (GridLineLabelPosition lineLabelPosition) |
| This specifies the label position (with respect to the line) to use for the line labels. More... | |
| Builder & | lineStyle (LineStyle lineStyle) |
| Indicates the line style to use for this setting. More... | |
| Builder & | originLabelStyle (TextStyle labelStyle) |
| Indicates the origin label style to use for this setting. More... | |
| Builder & | originLineStyle (LineStyle lineStyle) |
| Indicates the origin line style to use for this setting. More... | |
| Builder & | scaleRange (MapScale minScale, MapScale maxScale) |
| Indicates the scale range for which this setting applies. More... | |
Builder for a LonLat grid setting.
| luciad::LonLatGridSetting::Builder::Builder | ( | const Builder & | other | ) |
| luciad::LonLatGridSetting::Builder::~Builder | ( | ) |
| LonLatGridSetting luciad::LonLatGridSetting::Builder::build | ( | ) | const |
Returns the LonLat grid setting.
Mandatory parameters:
Other parameters are optional.
| luciad::LogicException | when not all mandatory parameters are set. |
| Builder & luciad::LonLatGridSetting::Builder::deltaLat | ( | double | deltaLat | ) |
Indicates the delta angle between latitude grid lines in degrees.
This is mandatory.
| deltaLat | the delta angle. |
| luciad::InvalidArgumentException | when the angle is smaller than or equal to 0. |
| Builder & luciad::LonLatGridSetting::Builder::deltaLon | ( | double | deltaLon | ) |
Indicates the delta angle between longitude grid lines in degrees.
This is mandatory.
| deltaLon | the delta angle. |
| luciad::InvalidArgumentException | when the angle is smaller than or equal to 0. |
| Builder & luciad::LonLatGridSetting::Builder::labelEdgeOffset | ( | double | labelEdgeOffset | ) |
This specifies the offset of the label, away from the edges of the view, in device independent pixels.
This is optional. Defaults to 6.
| labelEdgeOffset | the edge offset value. Must be >= 0. |
| luciad::InvalidArgumentException | when an invalid value is passed. |
| Builder & luciad::LonLatGridSetting::Builder::labelFormat | ( | const std::string & | labelFormat | ) |
This specifies the format pattern to use for the labels of the current LonLat grid.
| labelFormat | the pattern to use. |
| luciad::InvalidArgumentException | if format is not a valid format pattern. |
| Builder & luciad::LonLatGridSetting::Builder::labelGridOffset | ( | double | labelGridOffset | ) |
This specifies the offset of the label, in device independent pixels, away from the grid line to which it is attached.
This is optional. Defaults to 3.
| labelGridOffset | the grid offset value. Must be >= 0. |
| luciad::InvalidArgumentException | when an invalid value is passed. |
| Builder & luciad::LonLatGridSetting::Builder::labelOrientation | ( | GridLabelOrientation | labelOrientation | ) |
This specifies the label orientation with respect to the line.
This is optional. Defaults to AlongLine.
| labelOrientation | the label orientation. |
| Builder & luciad::LonLatGridSetting::Builder::labelPosition | ( | LonLatGridLabelPosition | labelPosition | ) |
This specifies the label position with respect to the view.
They can for example be placed at the left or at the right edge of the view. For example, when a label is placed at the east or south side of a line, it is placed at the left or lower edge of the view when using a rectangular projection like Mercator.
This is optional. Defaults to AllSides.
| labelPosition | the label position. |
Indicates the label style to use for this setting.
This is optional. Defaults to a white text style with font size 12 and a gray halo of size 1.
| labelStyle | the label style. |
| Builder & luciad::LonLatGridSetting::Builder::lineLabelPosition | ( | GridLineLabelPosition | lineLabelPosition | ) |
This specifies the label position (with respect to the line) to use for the line labels.
They can for example be placed at the left or at the right of the line.
This is optional. Defaults to AboveOrLeft.
| lineLabelPosition | the line label position. |
Indicates the line style to use for this setting.
This is optional. Defaults to a white line style with width 0.5 and 60% opacity.
| lineStyle | the line style. |
Indicates the origin label style to use for this setting.
This is optional. Defaults to a white text style with font size 12, 80% opacity, and a red halo of size 1.
| labelStyle | the label style. |
Indicates the origin line style to use for this setting.
This is optional. Defaults to a red line style with width 1 and 60% opacity.
| lineStyle | the line style. |
Indicates the scale range for which this setting applies.
This is mandatory.
| minScale | the min scale (most zoomed out). |
| maxScale | the max scale (most zoomed in). |
| luciad::InvalidArgumentException | when the min scale is larger than or equal to the max scale. |
1.9.4