![]() |
VR-Forces Developer's Guide
|
The settings manager for grid lines settings.

Static Public Member Functions | |
| static DtGridLinesSettingsManager & | instance (DtDe &de) |
Protected Attributes | |
| makArchives::DtGridLinesSettingsRecord | mySettingsRecord |
Protected Attributes inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtGridLinesSettingsRecord > | |
| DtSignalConnectionManager | myConnections |
| std::string | myName |
| std::string | myExtension |
| std::string | myDisplayName |
| bool | myUseDefaultSettingsRecordFlag |
| bool | myAutoSaveFlag |
| DtSettingsBackup * | mySettingsBackup |
| DtDe & | myDe |
Friends | |
| template<typename ManagerClass > | |
| ManagerClass & | defaultManagerInstanceFunction (DtDe &, bool) |
| template<typename ManagerClass > | |
| void | defaultManagerRegisterInstanceFunction (DtDe &, ManagerClass *) |
Additional Inherited Members | |
Protected Types inherited from makVrv::DtBaseSettingsManager< makArchives::DtGridLinesSettingsRecord > | |
| typedef DtRecordSettingsBackup < DtBaseSettingsManager < makArchives::DtGridLinesSettingsRecord > , makArchives::DtGridLinesSettingsRecord > | RecordBackupType |
|
virtual |
DTOR.
|
protected |
Protected CTOR ( use instance(..) )
|
static |
Get an instance of the settings manager.
| bool makVrv::DtGridLinesSettingsManager::autoSpacing | ( | ) | const |
Get whether auto spacing is enabled.
| void makVrv::DtGridLinesSettingsManager::setAutoSpacing | ( | bool | autoSpacing | ) |
Set whether auto spacing is enabled.
| bool makVrv::DtGridLinesSettingsManager::minimalGridlineLabelsEnabled | ( | ) | const |
Get whether or not minimal gridline labels are used.
| void makVrv::DtGridLinesSettingsManager::setMinimalGridlineLabelsEnabled | ( | bool | enabled | ) |
Set whether or not minimal gridline labels are used.
| bool makVrv::DtGridLinesSettingsManager::getNorthSouthGridLineColor | ( | float & | r, |
| float & | g, | ||
| float & | b, | ||
| float & | a | ||
| ) | const |
Get the color of the north/south gridlines.
| void makVrv::DtGridLinesSettingsManager::setNorthSouthGridLineColor | ( | float | r, |
| float | g, | ||
| float | b, | ||
| float | a | ||
| ) |
Set the color of the north/south gridlines.
| bool makVrv::DtGridLinesSettingsManager::getEastWestGridLineColor | ( | float & | r, |
| float & | g, | ||
| float & | b, | ||
| float & | a | ||
| ) | const |
Get the color of the east/west gridlines.
| void makVrv::DtGridLinesSettingsManager::setEastWestGridLineColor | ( | float | r, |
| float | g, | ||
| float | b, | ||
| float | a | ||
| ) |
Set the color of the east/west gridlines.
| double makVrv::DtGridLinesSettingsManager::fixedSpacingAmount | ( | makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits | unit | ) | const |
Get the fixed spacing amount for the linear unit specified.
| void makVrv::DtGridLinesSettingsManager::setFixedSpacingAmount | ( | makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits | unit, |
| double | amount | ||
| ) |
Set the fixed spacing amount for the linear unit specified.
| double makVrv::DtGridLinesSettingsManager::fixedSpacingAmount | ( | makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits | unit | ) | const |
Get the fixed spacing amount for the angular unit specified.
| void makVrv::DtGridLinesSettingsManager::setFixedSpacingAmount | ( | makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits | unit, |
| double | amount | ||
| ) |
Set the fixed spacing amount for the angular unit specified.
| void makVrv::DtGridLinesSettingsManager::setGarsFixedSpacing | ( | double | degs | ) |
Because GARS spacings are always 5, 15, or 30 minutes, we do not share fixed spacing values with other degree-based gridline types.
| double makVrv::DtGridLinesSettingsManager::garsFixedSpacing | ( | ) | const |
Because GARS spacings are always 5, 15, or 30 minutes, we do not share fixed spacing values with other degree-based gridline types.
| void makVrv::DtGridLinesSettingsManager::setMgrsMapSheetFixedSpacing | ( | double | meters | ) |
Because MGRS spacings are always 10 to the nth power (up to 100K) meters, we do not share fixed spacing values with other meters-based gridline types.
| double makVrv::DtGridLinesSettingsManager::mgrsMapSheetFixedSpacing | ( | ) | const |
Because MGRS spacings are always 10 to the nth power (up to 100K) meters, we do not share fixed spacing values with other meters-based gridline types.
| int makVrv::DtGridLinesSettingsManager::minSpacing | ( | ) | const |
Get the minimum pixels between lines allowed when auto-spacing is enabled (before going to next grid spacing)
| void makVrv::DtGridLinesSettingsManager::setMinSpacing | ( | int | pixels | ) |
Set the minimum pixels between lines allowed when auto-spacing is enabled (before going to next grid spacing)
| makArchives::DtDisplayUnitsSettingsRecord::CoordSys makVrv::DtGridLinesSettingsManager::gridType | ( | ) | const |
Get the type of grid lines to draw.
| void makVrv::DtGridLinesSettingsManager::setGridType | ( | makArchives::DtDisplayUnitsSettingsRecord::CoordSys | gridType | ) |
Set the type of grid lines to draw.
| bool makVrv::DtGridLinesSettingsManager::unitTypeIsAngular | ( | ) | const |
Returns whether users should use the linear or angular unit forms.
| makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits makVrv::DtGridLinesSettingsManager::unitType | ( | ) | const |
Get the units to use. This is actually determined by the grid type for many systems, but may vary (and does for local cartesian (or database) coordinates. It uses distance units for historical reasons (hence distance units, such as degrees, can't be represented at all). For this reason, DtDisplayUnitsSettingsRecord::End_DistanceUnits may be returned.
| makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits makVrv::DtGridLinesSettingsManager::angularUnitType | ( | ) | const |
Because we can't have two methods differing only by return type, this needs to be named differently.
| void makVrv::DtGridLinesSettingsManager::setUnitType | ( | makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits | unit | ) |
Set the linear unit type.
| void makVrv::DtGridLinesSettingsManager::setUnitType | ( | makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits | unit | ) |
Set the angular unit type.
| double makVrv::DtGridLinesSettingsManager::xOffset | ( | makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits | unit | ) | const |
Get the x offset amount in meters.
| void makVrv::DtGridLinesSettingsManager::setXOffset | ( | makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits | unit, |
| double | offset | ||
| ) |
Set the x offset amount in meters.
| double makVrv::DtGridLinesSettingsManager::yOffset | ( | makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits | unit | ) | const |
Get the y offset amount in meters.
| void makVrv::DtGridLinesSettingsManager::setYOffset | ( | makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits | unit, |
| double | offset | ||
| ) |
Set the y offset amount in meters.
| double makVrv::DtGridLinesSettingsManager::longitudeOffset | ( | makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits | unit | ) | const |
Get the x offset amount in meters.
| void makVrv::DtGridLinesSettingsManager::setLongitudeOffset | ( | makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits | unit, |
| double | offset | ||
| ) |
Set the x offset amount in meters.
| double makVrv::DtGridLinesSettingsManager::latitudeOffset | ( | makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits | unit | ) | const |
Get the y offset amount in meters.
| void makVrv::DtGridLinesSettingsManager::setLatitudeOffset | ( | makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits | unit, |
| double | offset | ||
| ) |
Set the y offset amount in meters.
| unsigned int makVrv::DtGridLinesSettingsManager::decimalPlaces | ( | makArchives::DtDisplayUnitsSettingsRecord::CoordSys | cs, |
| makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits | unit | ||
| ) | const |
Get the decimal places for the linear unit specified.
| void makVrv::DtGridLinesSettingsManager::setDecimalPlaces | ( | makArchives::DtDisplayUnitsSettingsRecord::CoordSys | cs, |
| makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits | unit, | ||
| unsigned int | amount | ||
| ) |
Set the decimal places for the linear unit specified.
| unsigned int makVrv::DtGridLinesSettingsManager::decimalPlaces | ( | makArchives::DtDisplayUnitsSettingsRecord::CoordSys | cs, |
| makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits | unit | ||
| ) | const |
Get the precision for the angular unit specified.
| void makVrv::DtGridLinesSettingsManager::setDecimalPlaces | ( | makArchives::DtDisplayUnitsSettingsRecord::CoordSys | cs, |
| makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits | unit, | ||
| unsigned int | amount | ||
| ) |
Set the precision for the angular unit specified.
| bool makVrv::DtGridLinesSettingsManager::gridOnToolbar | ( | makArchives::DtDisplayUnitsSettingsRecord::CoordSys | cs | ) |
Get whether the grid lines associated with the parameter cs should be on the grid lines selection toolbar.
| void makVrv::DtGridLinesSettingsManager::setGridOnToolbar | ( | makArchives::DtDisplayUnitsSettingsRecord::CoordSys | cs, |
| bool | included | ||
| ) |
Set whether the grid lines associated with the parameter cs should be on the grid lines selection toolbar.
| void makVrv::DtGridLinesSettingsManager::setLatLonLabelsCenteringCutoff | ( | int | altitude | ) |
Set the altitude at which we stop moving latitude and longitude labels to the center of the screen.
| double makVrv::DtGridLinesSettingsManager::latLonLabelsCenteringCutoff | ( | ) | const |
Get the altitude at which we stop moving latitude and longitude labels to the center of the screen.
| double makVrv::DtGridLinesSettingsManager::mgrsMapSheetCutoff | ( | ) | const |
Get the altitude in meters at which we stop drawing map sheet ines/labels when using fixed spacing (this isn't necessary when auto spacing in used and will be ignored. This avoids trying to draw too many lines/labels at higher altitudes when a user specifies a small spacing.
| void makVrv::DtGridLinesSettingsManager::setMgrsMapSheetCutoff | ( | double | alt | ) |
Set the altitude in meters at which we stop drawing map sheet lines/labels when using fixed spacing.
| void makVrv::DtGridLinesSettingsManager::setGarsPolarLatitudeCutoff | ( | double | latitude | ) |
Set the latitude above which GARS grid lines are not drawn.
| double makVrv::DtGridLinesSettingsManager::garsPolarLatitudeCutoff | ( | ) | const |
Get the latitude above which GARS grid lines are not drawn.
|
virtual |
Use the settings from the given settings record.
Implements makVrv::DtBaseSettingsManager< makArchives::DtGridLinesSettingsRecord >.
|
virtual |
Populate the given record with the current settings.
Implements makVrv::DtBaseSettingsManager< makArchives::DtGridLinesSettingsRecord >.
|
protectedvirtual |
Get overrides to the factory record, if any. If there are overrides, this function returns true. This is an internal utility function used by VR-Vantage engineers to update factory defaults. As a result, this function returns false in releases but can be overriden by toolkit users if desired; however, generally toolkit users can and should use DtDeInitializer::addDefaultSettingsRecord(...) instead.
Implements makVrv::DtBaseSettingsManager< makArchives::DtGridLinesSettingsRecord >.
|
protectedvirtual |
connected to the de's post init signal to set up the manager based on the current coordinate system
|
protectedvirtual |
Called when the current coordinate system changes.
|
protected |
Sets the fixed spacing values from a record.
|
protected |
Sets the x offset values from a record.
|
protected |
Sets the y offset values from a record.
|
protected |
Sets the fixed (angular) spacing values from a record.
|
protected |
Sets the longitude offset values from a record.
|
protected |
Sets the latitude offset values from a record.
|
protected |
Set a GridToToolbarPresenceMap to our settings record.
|
protected |
Get a GridToToolbarPresenceMap from our settings record.
|
friend |
Befriend the manager instance functions for instance retreival/creation.
Befriend the manager instance functions for instance retreival/creation.
Befriend the manager instance functions for instance retrieval/creation.
Then simply in the implementation of instance call defaultManagerInstanceFunction with the de object and return the return value.
|
friend |
Befriend the manager instance functions for instance retreival/creation.
Befriend the manager instance functions for instance retreival/creation.
Befriend the manager instance functions for instance retrieval/creation.
| boost::signalslib::signal<void (makArchives::DtDisplayUnitsSettingsRecord::CoordSys)> makVrv::DtGridLinesSettingsManager::signal_gridTypeSet |
| boost::signalslib::signal<void (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits)> makVrv::DtGridLinesSettingsManager::signal_unitTypeSet |
| boost::signalslib::signal<void (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits)> makVrv::DtGridLinesSettingsManager::signal_angularUnitTypeSet |
| boost::signalslib::signal<void (float, float, float, float)> makVrv::DtGridLinesSettingsManager::signal_northSouthGridlineColorChanged |
| boost::signalslib::signal<void (float, float, float, float)> makVrv::DtGridLinesSettingsManager::signal_eastWestGridlineColorChanged |
| boost::signalslib::signal<void (bool)> makVrv::DtGridLinesSettingsManager::signal_minimalGridlineLabelsEnabled |
| boost::signalslib::signal<void (bool)> makVrv::DtGridLinesSettingsManager::signal_autoSpacingSet |
| boost::signalslib::signal<void (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits,double)> makVrv::DtGridLinesSettingsManager::signal_fixedSpacingAmountSet |
| boost::signalslib::signal<void (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits,double)> makVrv::DtGridLinesSettingsManager::signal_fixedAngularSpacingAmountSet |
| boost::signalslib::signal<void (int)> makVrv::DtGridLinesSettingsManager::signal_minSpacingSet |
| boost::signalslib::signal<void (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits,double)> makVrv::DtGridLinesSettingsManager::signal_xOffsetSet |
| boost::signalslib::signal<void (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits,double)> makVrv::DtGridLinesSettingsManager::signal_yOffsetSet |
| boost::signalslib::signal<void (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits,double)> makVrv::DtGridLinesSettingsManager::signal_longitudeOffsetSet |
| boost::signalslib::signal<void (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits,double)> makVrv::DtGridLinesSettingsManager::signal_latitudeOffsetSet |
| boost::signalslib::signal<void (makArchives::DtDisplayUnitsSettingsRecord::CoordSys cs,makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits,unsigned int) > makVrv::DtGridLinesSettingsManager::signal_decimalPlacesSet |
| boost::signalslib::signal<void (makArchives::DtDisplayUnitsSettingsRecord::CoordSys cs,makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits,unsigned int)> makVrv::DtGridLinesSettingsManager::signal_angularDecimalPlacesSet |
| boost::signalslib::signal<void(double)> makVrv::DtGridLinesSettingsManager::signal_latLonLabelsCenteringCutoffSet |
| boost::signalslib::signal<void(double)> makVrv::DtGridLinesSettingsManager::signal_mgrsMapSheetCutoffSet |
| boost::signalslib::signal<void (double)> makVrv::DtGridLinesSettingsManager::signal_garsPolarLatitudeCutoffSet |
| boost::signalslib::signal<void (makArchives::DtDisplayUnitsSettingsRecord::CoordSys cs, bool)> makVrv::DtGridLinesSettingsManager::signal_gridOnToolbarPlacementChanged |
| boost::signalslib::signal<void(double)> makVrv::DtGridLinesSettingsManager::signal_garsFixedSpacingSet |
| boost::signalslib::signal<void(double)> makVrv::DtGridLinesSettingsManager::signal_mgrsMapSheetFixedSpacingSet |
|
protected |