![]() |
VR-Forces 4.10 Class Documentation
|
The settings manager for grid lines settings. More...

Public Member Functions | |
| virtual | ~DtGridLinesSettingsManager () |
| DTOR. More... | |
Setting Getters/Setters | |
| bool | autoSpacing () const |
| Get whether auto spacing is enabled. More... | |
| void | setAutoSpacing (bool autoSpacing) |
| Set whether auto spacing is enabled. More... | |
| bool | minimalGridlineLabelsEnabled () const |
| Get whether or not minimal gridline labels are used. More... | |
| void | setMinimalGridlineLabelsEnabled (bool enabled) |
| Set whether or not minimal gridline labels are used. More... | |
| bool | getNorthSouthGridLineColor (float &r, float &g, float &b, float &a) const |
| Get the color of the north/south gridlines. More... | |
| void | setNorthSouthGridLineColor (float r, float g, float b, float a) |
| Set the color of the north/south gridlines. More... | |
| bool | getEastWestGridLineColor (float &r, float &g, float &b, float &a) const |
| Get the color of the east/west gridlines. More... | |
| void | setEastWestGridLineColor (float r, float g, float b, float a) |
| Set the color of the east/west gridlines. More... | |
| double | fixedSpacingAmount (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit) const |
| Get the fixed spacing amount for the linear unit specified. More... | |
| void | setFixedSpacingAmount (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit, double amount) |
| Set the fixed spacing amount for the linear unit specified. More... | |
| double | fixedSpacingAmount (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit) const |
| Get the fixed spacing amount for the angular unit specified. More... | |
| void | setFixedSpacingAmount (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit, double amount) |
| Set the fixed spacing amount for the angular unit specified. More... | |
| int | minSpacing () const |
| Get the minimum pixels between lines allowed when auto-spacing is enabled (before going to next grid spacing) More... | |
| void | setMinSpacing (int pixels) |
| Set the minimum pixels between lines allowed when auto-spacing is enabled (before going to next grid spacing) More... | |
| makArchives::DtDisplayUnitsSettingsRecord::CoordSys | gridType () const |
| Get the type of grid lines to draw. More... | |
| void | setGridType (makArchives::DtDisplayUnitsSettingsRecord::CoordSys gridType) |
| Set the type of grid lines to draw. More... | |
| bool | unitTypeIsAngular () const |
| Returns whether users should use the linear or angular unit forms. More... | |
| makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits | unitType () const |
| Get the units to use. More... | |
| makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits | angularUnitType () const |
| Because we can't have two methods differing only by return type, this needs to be named differently. More... | |
| void | setUnitType (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit) |
| Set the linear unit type. More... | |
| void | setUnitType (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit) |
| Set the angular unit type. More... | |
| double | xOffset (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit) const |
| Get the x offset amount in meters. More... | |
| void | setXOffset (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit, double offset) |
| Set the x offset amount in meters. More... | |
| double | yOffset (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit) const |
| Get the y offset amount in meters. More... | |
| void | setYOffset (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit, double offset) |
| Set the y offset amount in meters. More... | |
| double | longitudeOffset (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit) const |
| Get the x offset amount in meters. More... | |
| void | setLongitudeOffset (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit, double offset) |
| Set the x offset amount in meters. More... | |
| double | latitudeOffset (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit) const |
| Get the y offset amount in meters. More... | |
| void | setLatitudeOffset (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit, double offset) |
| Set the y offset amount in meters. More... | |
| unsigned int | decimalPlaces (makArchives::DtDisplayUnitsSettingsRecord::CoordSys cs, makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit) const |
| Get the decimal places for the linear unit specified. More... | |
| void | setDecimalPlaces (makArchives::DtDisplayUnitsSettingsRecord::CoordSys cs, makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit, unsigned int amount) |
| Set the decimal places for the linear unit specified. More... | |
| unsigned int | decimalPlaces (makArchives::DtDisplayUnitsSettingsRecord::CoordSys cs, makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit) const |
| Get the precision for the angular unit specified. More... | |
| void | setDecimalPlaces (makArchives::DtDisplayUnitsSettingsRecord::CoordSys cs, makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit, unsigned int amount) |
| Set the precision for the angular unit specified. More... | |
Setting persistence methods. | |
| void | setFromRecord (const makArchives::DtGridLinesSettingsRecord &rec) |
| Use the settings from the given settings record. More... | |
| void | getRecord (makArchives::DtGridLinesSettingsRecord &rec) const |
| Populate the given record with the current settings. More... | |
Public Member Functions inherited from makVrv::DtBaseSettingsManager< makArchives::DtGridLinesSettingsRecord > | |
| DtBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext) | |
| CTOR. More... | |
| virtual | ~DtBaseSettingsManager () |
| Virtual DTOR. More... | |
| virtual void | initializeBackup () |
| Creates a backup of the settings' current state. More... | |
Public Member Functions inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtGridLinesSettingsRecord > | |
| DtCommonBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext) | |
| CTOR The name, displayName, and extension parameters are used for creating the settings object (DtDeSettings) and backup, and for constructing the filename when readin/writing the records to disk. More... | |
| virtual | ~DtCommonBaseSettingsManager () |
| Virtual DTOR. More... | |
| virtual void | autoSaveIfNecessary () |
| Saves the current settings as defaults if autosave is enabled. More... | |
| virtual void | setAutoSave (bool doit) |
| Sets whether autosave is enabled for the settings manager. More... | |
| virtual bool | autoSave () const |
| Gets whether autosave is enabled for the settings manager. More... | |
| virtual void | setUseDefaultSettingsRecord (bool useit) |
| Sets whether setting initialization should check for a default record. More... | |
| virtual bool | useDefaultSettingsRecord () const |
| Gets whether setting initialization should check for a default record. More... | |
| virtual DtDeSettings * | settings () |
| Accessor for the manager's DtDeSettings object. More... | |
| virtual const DtDeSettings * | settings () const |
| Accessor for the manager's DtDeSettings object (const). More... | |
| virtual DtSettingsBackup * | settingsBackup () |
| Accessor for the manager's settings backup. More... | |
| virtual const DtSettingsBackup * | settingsBackup () const |
| Accessor for the manager's settings backup (const). More... | |
| virtual void | loadDefaults () |
| Initializes the settings and creates a backup. More... | |
| virtual void | saveDefaultSettings () |
| Saves the current settings' state as the default (on disk). More... | |
| virtual void | loadDefaultSettings (bool loadOnlyFactorySettings) |
| Loads the default settings from disk. More... | |
| virtual void | importSettings (const std::string &filePath) |
| Load the settings' state from the given file. More... | |
| virtual void | exportSettings (const std::string &filePath) const |
| Save the current settings' state to the given file. More... | |
| virtual void | getSplitRecord (std::vector< makArchives::DtGridLinesSettingsRecord > &rec, std::vector< std::string > &fileNames) |
| For directory support, split the main record into different sub-records and give them each a file name. More... | |
| virtual void | addRecords (makArchives::DtGridLinesSettingsRecord &rec, makArchives::DtGridLinesSettingsRecord &combinedRec) |
| For directory support, when reading in a directory, add the records from each file to the combined record. More... | |
Public Member Functions inherited from makVrv::DtVirtualBaseClass | |
| DtVirtualBaseClass () | |
| Do nothing constructor. More... | |
| virtual | ~DtVirtualBaseClass () |
| Virtual do nothing destructor. More... | |
Static Public Member Functions | |
| static DtGridLinesSettingsManager & | instance (DtDe &de) |
| Get an instance of the settings manager. More... | |
Protected Member Functions | |
| DtGridLinesSettingsManager (DtDe &) | |
| Protected CTOR ( use instance(..) ) More... | |
Record setters - sets individual setting values from a record. | |
Called from setFromRecord to preserve logic readability. | |
| void | setFixedSpacings (const makArchives::DtGridLinesSettingsRecord &rec) |
| Sets the fixed spacing values from a record. More... | |
| void | setXOffsets (const makArchives::DtGridLinesSettingsRecord &rec) |
| Sets the x offset values from a record. More... | |
| void | setYOffsets (const makArchives::DtGridLinesSettingsRecord &rec) |
| Sets the y offset values from a record. More... | |
| void | setFixedAngularSpacings (const makArchives::DtGridLinesSettingsRecord &rec) |
| Sets the fixed (angular) spacing values from a record. More... | |
| void | setLongitudeOffsets (const makArchives::DtGridLinesSettingsRecord &rec) |
| Sets the longitude offset values from a record. More... | |
| void | setLatitudeOffsets (const makArchives::DtGridLinesSettingsRecord &rec) |
| Sets the latitude offset values from a record. More... | |
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) |
| Befriend the manager instance functions for instance retreival/creation. More... | |
| template<typename ManagerClass > | |
| void | defaultManagerRegisterInstanceFunction (DtDe &, ManagerClass *) |
| Befriend the manager instance functions for instance retreival/creation. More... | |
Additional Inherited Members | |
Protected Types inherited from makVrv::DtBaseSettingsManager< makArchives::DtGridLinesSettingsRecord > | |
| typedef DtRecordSettingsBackup < DtBaseSettingsManager < makArchives::DtGridLinesSettingsRecord > , makArchives::DtGridLinesSettingsRecord > | RecordBackupType |
The settings manager for grid lines settings.
|
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.
| 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.
|
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 >.
|
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.
|
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.
Manager requirements: 1) Static instance function 2) Protected DtSignalConnectionManager named myConnections. 3) Member functioned called loadDefaults which takes no arguments. and loads the default settings of the manager or factory from disk. 4) define defaultManagerInstanceFunction as friend. 5) define defaultManagerRegisterInstanceFunction as friend (see below). 5) Protected Constructor which only takes a DtDe reference.
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 |
|
protected |