The settings manager for grid lines settings.

Inheritance diagram for makVrv::DtGridLinesSettingsManager:

Public Member Functions
virtual	~DtGridLinesSettingsManager ()

Setting Getters/Setters
bool	autoSpacing () const

void	setAutoSpacing (bool autoSpacing)

bool	minimalGridlineLabelsEnabled () const

void	setMinimalGridlineLabelsEnabled (bool enabled)

bool	getNorthSouthGridLineColor (float &r, float &g, float &b, float &a) const

void	setNorthSouthGridLineColor (float r, float g, float b, float a)

bool	getEastWestGridLineColor (float &r, float &g, float &b, float &a) const

void	setEastWestGridLineColor (float r, float g, float b, float a)

double	fixedSpacingAmount (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit) const

void	setFixedSpacingAmount (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit, double amount)

double	fixedSpacingAmount (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit) const

void	setFixedSpacingAmount (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit, double amount)

int	minSpacing () const

void	setMinSpacing (int pixels)

makArchives::DtDisplayUnitsSettingsRecord::CoordSys	gridType () const

void	setGridType (makArchives::DtDisplayUnitsSettingsRecord::CoordSys gridType)

bool	unitTypeIsAngular () const

makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits	unitType () const

makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits	angularUnitType () const

void	setUnitType (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit)

void	setUnitType (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit)

double	xOffset (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit) const

void	setXOffset (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit, double offset)

double	yOffset (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit) const

void	setYOffset (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit, double offset)

double	longitudeOffset (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit) const

void	setLongitudeOffset (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit, double offset)

double	latitudeOffset (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit) const

void	setLatitudeOffset (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit, double offset)

unsigned int	decimalPlaces (makArchives::DtDisplayUnitsSettingsRecord::CoordSys cs, makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit) const

void	setDecimalPlaces (makArchives::DtDisplayUnitsSettingsRecord::CoordSys cs, makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit, unsigned int amount)

unsigned int	decimalPlaces (makArchives::DtDisplayUnitsSettingsRecord::CoordSys cs, makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit) const

void	setDecimalPlaces (makArchives::DtDisplayUnitsSettingsRecord::CoordSys cs, makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit, unsigned int amount)

Setting persistence methods.
void	setFromRecord (const makArchives::DtGridLinesSettingsRecord &rec)

void	getRecord (makArchives::DtGridLinesSettingsRecord &rec) const

Public Member Functions inherited from makVrv::DtBaseSettingsManager< makArchives::DtGridLinesSettingsRecord >
	DtBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)

virtual	~DtBaseSettingsManager ()

virtual void	initializeBackup ()

Public Member Functions inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtGridLinesSettingsRecord >
	DtCommonBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)

virtual	~DtCommonBaseSettingsManager ()

virtual void	autoSaveIfNecessary ()

virtual void	setAutoSave (bool doit)

virtual bool	autoSave () const

virtual void	setUseDefaultSettingsRecord (bool useit)

virtual bool	useDefaultSettingsRecord () const

virtual DtDeSettings *	settings ()

virtual const DtDeSettings *	settings () const

virtual DtSettingsBackup *	settingsBackup ()

virtual const DtSettingsBackup *	settingsBackup () const

virtual void	loadDefaults ()

virtual void	saveDefaultSettings ()

virtual void	loadDefaultSettings (bool loadOnlyFactorySettings)

virtual void	importSettings (const std::string &filePath)

virtual void	exportSettings (const std::string &filePath) const

virtual void	getSplitRecord (std::vector< makArchives::DtGridLinesSettingsRecord > &rec, std::vector< std::string > &fileNames)

virtual void	addRecords (makArchives::DtGridLinesSettingsRecord &rec, makArchives::DtGridLinesSettingsRecord &combinedRec)

Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()

virtual	~DtVirtualBaseClass ()

Static Public Member Functions
static DtGridLinesSettingsManager &	instance (DtDe &de)

Public Attributes
Boost signals for changed settings
boost::signalslib::signal < void(makArchives::DtDisplayUnitsSettingsRecord::CoordSys)>	signal_gridTypeSet

boost::signalslib::signal < void(makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits)>	signal_unitTypeSet

boost::signalslib::signal < void(makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits)>	signal_angularUnitTypeSet

boost::signalslib::signal < void(float, float, float, float)>	signal_northSouthGridlineColorChanged

boost::signalslib::signal < void(float, float, float, float)>	signal_eastWestGridlineColorChanged

boost::signalslib::signal < void(bool)>	signal_minimalGridlineLabelsEnabled

boost::signalslib::signal < void(bool)>	signal_autoSpacingSet

boost::signalslib::signal < void(makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits, double)>	signal_fixedSpacingAmountSet

boost::signalslib::signal < void(makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits, double)>	signal_fixedAngularSpacingAmountSet

boost::signalslib::signal < void(int)>	signal_minSpacingSet

boost::signalslib::signal < void(makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits, double)>	signal_xOffsetSet

boost::signalslib::signal < void(makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits, double)>	signal_yOffsetSet

boost::signalslib::signal < void(makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits, double)>	signal_longitudeOffsetSet

boost::signalslib::signal < void(makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits, double)>	signal_latitudeOffsetSet

boost::signalslib::signal < void(makArchives::DtDisplayUnitsSettingsRecord::CoordSys cs, makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits, unsigned int) >	signal_decimalPlacesSet

boost::signalslib::signal < void(makArchives::DtDisplayUnitsSettingsRecord::CoordSys cs, makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits, unsigned int)>	signal_angularDecimalPlacesSet

Protected Member Functions
	DtGridLinesSettingsManager (DtDe &)

Record setters - sets individual setting values from a record.
Called from setFromRecord to preserve logic readability.
void	setFixedSpacings (const makArchives::DtGridLinesSettingsRecord &rec)

void	setXOffsets (const makArchives::DtGridLinesSettingsRecord &rec)

void	setYOffsets (const makArchives::DtGridLinesSettingsRecord &rec)

void	setFixedAngularSpacings (const makArchives::DtGridLinesSettingsRecord &rec)

void	setLongitudeOffsets (const makArchives::DtGridLinesSettingsRecord &rec)

void	setLatitudeOffsets (const makArchives::DtGridLinesSettingsRecord &rec)

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

Constructor & Destructor Documentation

virtual makVrv::DtGridLinesSettingsManager::~DtGridLinesSettingsManager ( )

virtual

DTOR.

makVrv::DtGridLinesSettingsManager::DtGridLinesSettingsManager ( DtDe & )

protected

Protected CTOR ( use instance(..) )

Member Function Documentation

static DtGridLinesSettingsManager& makVrv::DtGridLinesSettingsManager::instance ( DtDe & de )

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.

void makVrv::DtGridLinesSettingsManager::setFromRecord ( const makArchives::DtGridLinesSettingsRecord & rec )

virtual

Use the settings from the given settings record.

Implements makVrv::DtBaseSettingsManager< makArchives::DtGridLinesSettingsRecord >.

void makVrv::DtGridLinesSettingsManager::getRecord ( makArchives::DtGridLinesSettingsRecord & rec ) const

virtual

Populate the given record with the current settings.

Implements makVrv::DtBaseSettingsManager< makArchives::DtGridLinesSettingsRecord >.

void makVrv::DtGridLinesSettingsManager::setFixedSpacings ( const makArchives::DtGridLinesSettingsRecord & rec )

protected

Sets the fixed spacing values from a record.

void makVrv::DtGridLinesSettingsManager::setXOffsets ( const makArchives::DtGridLinesSettingsRecord & rec )

protected

Sets the x offset values from a record.

void makVrv::DtGridLinesSettingsManager::setYOffsets ( const makArchives::DtGridLinesSettingsRecord & rec )

protected

Sets the y offset values from a record.

void makVrv::DtGridLinesSettingsManager::setFixedAngularSpacings ( const makArchives::DtGridLinesSettingsRecord & rec )

protected

Sets the fixed (angular) spacing values from a record.

void makVrv::DtGridLinesSettingsManager::setLongitudeOffsets ( const makArchives::DtGridLinesSettingsRecord & rec )

protected

Sets the longitude offset values from a record.

void makVrv::DtGridLinesSettingsManager::setLatitudeOffsets ( const makArchives::DtGridLinesSettingsRecord & rec )

protected

Sets the latitude offset values from a record.

Friends And Related Function Documentation

template<typename ManagerClass >

ManagerClass& defaultManagerInstanceFunction	(	DtDe &	de,
		bool	allowedInSlave
	)

friend

Befriend the manager instance functions for instance retreival/creation.

Befriend the manager instance functions for instance retrieval/creation.

class Manager
{
public:
   static Manager& instance(DtDe& de);
   void loadDefaults();
protected:
   template <typename ManagerClass>
   friend ManagerClass& defaultManagerInstanceFunction(DtDe& de, bool);
   template <typename ManagerClass>
   friend void defaultManagerRegisterInstanceFunction(DtDe& de, ManagerClass* mgr)
   Manager(DtDe&);
   DtSignalConnectionManager myConnections;
};

Then simply in the implementation of instance call defaultManagerInstanceFunction with the de object and return the return value.

Manager& Manager::instance(DtDe& de)
{
   return defaultManagerInstanceFunction<Manager>(de);
}

template<typename ManagerClass >

void defaultManagerRegisterInstanceFunction	(	DtDe &	de,
		ManagerClass *	mgr
	)

friend

Befriend the manager instance functions for instance retreival/creation.

Befriend the manager instance functions for instance retrieval/creation.

static void Manager::registerInstance(DtDe& de, Manager* mgr)
{
   defaultManagerRegisterInstanceFunction(de,mgr);
}
...else where call.
// Assuming class NewManager : public Manager
Manager::registerInstance(de,new NewManager(de));

Member Data Documentation

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

makArchives::DtGridLinesSettingsRecord makVrv::DtGridLinesSettingsManager::mySettingsRecord

protected

The documentation for this class was generated from the following file:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvCore/DtGridLinesSettingsManager.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation