 |
LuciadCPillar 2023.1.04
|
|
LuciadCPillar 2023.1.04
|
Builder for a LonLat grid. More...
#include <luciad/layers/grids/lonlat/LonLatGrid.h>
Public Member Functions | |
| Builder (const Builder &other) | |
| ~Builder () | |
| LonLatGrid | build () const |
| Returns the LonLat grid. 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 & | 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 the LonLat grid. 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 the LonLat grid. More... | |
| Builder & | originLabelStyle (TextStyle labelStyle) |
| Indicates the origin label style to use for the LonLat grid. More... | |
| Builder & | originLat (double originLat) |
| Indicates the origin latitude. More... | |
| Builder & | originLineStyle (LineStyle lineStyle) |
| Indicates the origin line style to use for the LonLat grid. More... | |
| Builder & | originLon (double originLon) |
| Indicates the origin longitude. More... | |
| Builder & | scaleMultiplier (double scaleMultiplier) |
| Indicates the scale multiplier to use for the LonLat grid scale ranges. More... | |
Builder for a LonLat grid.
Creates a LonLat grid with predefined scale ranges and default (customizable) styling.
| luciad::LonLatGrid::Builder::Builder | ( | const Builder & | other | ) |
| luciad::LonLatGrid::Builder::~Builder | ( | ) |
| LonLatGrid luciad::LonLatGrid::Builder::build | ( | ) | const |
Returns the LonLat grid.
| luciad::LogicException | when the settings are invalid. |
| Builder & luciad::LonLatGrid::Builder::labelEdgeOffset | ( | double | labelEdgeOffset | ) |
This specifies the offset of the label, away from the edges of the view, in device independent pixels.
This is applied to all style settings in the grid.
This is optional. Defaults to 6.
| labelEdgeOffset | the edge offset value. Must be >= 0. |
| luciad::InvalidArgumentException | when an invalid value is passed. |
| Builder & luciad::LonLatGrid::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 applied to all style settings in the grid.
This is optional. Defaults to 3.
| labelGridOffset | the grid offset value. Must be >= 0. |
| luciad::InvalidArgumentException | when an invalid value is passed. |
| Builder & luciad::LonLatGrid::Builder::labelOrientation | ( | GridLabelOrientation | labelOrientation | ) |
This specifies the label orientation with respect to the line.
This is applied to all style settings in the grid.
This is optional. Defaults to AlongLine.
| labelOrientation | the label orientation. |
| Builder & luciad::LonLatGrid::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 applied to all style settings in the grid.
This is optional. Defaults to AllSides.
| labelPosition | the label position. |
Indicates the label style to use for the LonLat grid.
| labelStyle | the label style. |
| Builder & luciad::LonLatGrid::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 applied to all style settings in the grid.
This is optional. Defaults to AboveOrLeft.
| lineLabelPosition | the line label position. |
Indicates the line style to use for the LonLat grid.
| lineStyle | the line style. |
Indicates the origin label style to use for the LonLat grid.
| labelStyle | the label style. |
| Builder & luciad::LonLatGrid::Builder::originLat | ( | double | originLat | ) |
Indicates the origin latitude.
This is optional. Defaults to 0.
| originLat | the origin latitude. |
| luciad::InvalidArgumentException | when the origin latitude is smaller than -90 or larger than 90. |
Indicates the origin line style to use for the LonLat grid.
| lineStyle | the line style. |
| Builder & luciad::LonLatGrid::Builder::originLon | ( | double | originLon | ) |
Indicates the origin longitude.
This is optional. Defaults to 0.
| originLon | the origin longitude. |
| luciad::InvalidArgumentException | when the origin longitude is smaller than -180 or larger than 180. |
| Builder & luciad::LonLatGrid::Builder::scaleMultiplier | ( | double | scaleMultiplier | ) |
Indicates the scale multiplier to use for the LonLat grid scale ranges.
The value must be within the range [0.1, 10.0].
A value larger than 1 makes the grid lines appear later when zooming in. This results in a coarser grid. A value below 1 makes the grid lines appear sooner when zooming in. This results in a finer grid.
| scaleMultiplier | the scale multiplier. |
| luciad::InvalidArgumentException | when an invalid value is passed. |
1.9.4