This manager will manage settings for intervisibility objects. More...

Inheritance diagram for makVrf::DtRangeLineSettingsManager:

Public Member Functions
virtual	~DtRangeLineSettingsManager ()
	DTOR. More...

Setters/getters for settings
void	setRangeLinesVisible (bool enabled)
	Sets whether range line objects are globally seen/hidden. More...

bool	rangeLinesVisible () const
	Gets whether intervisibility objects are globally seen/hidden. More...

void	setColor (float r, float g, float b, float a)
	Sets the color of the range line (default red) More...

void	color (float &r, float &g, float &b, float &a) const
	Gets the color of the range line. More...

void	setRangeInfoLabelBackgroundColor (float r, float g, float b, float a)
	Sets the background color (and opacity) for the range info labels. More...

void	rangeInfoLabelBackgroundColor (float &r, float &g, float &b, float &a) const
	Gets the background color (and opacity) for the range info labels. More...

void	setFontColor (float r, float g, float b, float a)
	Sets the color of the font (default green) More...

void	fontColor (float &r, float &g, float &b, float &a) const
	Gets the color of the range line font. More...

void	setFontSize (int)
	Sets the font size (default 14);. More...

int	fontSize () const
	Gets the font size. More...

void	setLineWidth (int)
	Sets the line width (default is 3) More...

int	lineWidth () const
	Gets the line width. More...

void	setHatLinesEnabled (bool hatEnabled)
	Sets whether height above terrain lines are enabled (default is false) More...

bool	hatLinesEnabled () const
	Gets whether height above terrain lines are enabled. More...

void	setHatLinesOnSelectionOnly (bool selOnly)
	Sets whether HAT lines are shown only when the object is selected (default is false) More...

bool	hatLinesOnSelectionOnly () const
	Gets whether HAT lines are shown only when the object is selected. More...

Archiving methods
virtual void	setFromRecord (const DtRangeLineSettingsRecord &rec)
	Use the settings from the given settings record. More...

virtual void	getRecord (DtRangeLineSettingsRecord &rec) const
	Populate the given record with the current settings. More...

void	setAutoSave (bool b)
	Sets whether autosave is enabled for the settings manager. More...

bool	autoSave () const
	Gets whether autosave is enabled for the settings manager. More...

Public Member Functions inherited from makVrv::DtBaseSettingsManager< makVrf::DtRangeLineSettingsRecord >
	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< makVrf::DtRangeLineSettingsRecord >
	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	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< makVrf::DtRangeLineSettingsRecord > &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 (makVrf::DtRangeLineSettingsRecord &rec, makVrf::DtRangeLineSettingsRecord &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 DtRangeLineSettingsManager &	instance (makVrv::DtDe &de)
	Get an instance of the settings manager. More...

Public Attributes
Boost signals for changed settings
boost::signals2::signal< void(bool)>	signal_rangeLinesVisibleChanged

boost::signals2::signal< void(int)>	signal_fontSizeChanged

boost::signals2::signal< void(int)>	signal_lineWidthChanged

boost::signals2::signal< void(bool)>	signal_hatLinesEnabledSet

boost::signals2::signal< void(bool)>	signal_hatLinesOnSelectionOnlySet

boost::signals2::signal< void(float r, float g, float b, float a)>	signal_colorSet

boost::signals2::signal< void(float r, float g, float b, float a)>	signal_fontColorSet

boost::signals2::signal< void(float r, float g, float b, float a)>	signal_rangeInfoBackgroundColorSet

Protected Member Functions
	DtRangeLineSettingsManager (makVrv::DtDe &de)
	Protected CTOR ( use instance(..) ). More...

virtual void	completeSetup ()
	register the type of information to save and reload More...

Protected Attributes
DtRangeLineSettingsRecord	mySettings

Protected Attributes inherited from makVrv::DtCommonBaseSettingsManager< makVrf::DtRangeLineSettingsRecord >
DtSignalConnectionManager	myConnections

std::string	myName

std::string	myExtension

std::string	myDisplayName

bool	myUseDefaultSettingsRecordFlag

bool	myAutoSaveFlag

DtSettingsBackup *	mySettingsBackup

DtDe &	myDe

Friends
template<typename ManagerClass >
ManagerClass &	makVrv::defaultManagerInstanceFunction (makVrv::DtDe &, bool)
	Befriend the manager instance functions for instance retrieval/creation. More...

template<typename ManagerClass >
void	makVrv::defaultManagerRegisterInstanceFunction (makVrv::DtDe &, ManagerClass *)
	Befriend the manager instance functions for instance retrieval/creation. More...

Additional Inherited Members
Protected Types inherited from makVrv::DtBaseSettingsManager< makVrf::DtRangeLineSettingsRecord >
typedef DtRecordSettingsBackup < DtBaseSettingsManager < makVrf::DtRangeLineSettingsRecord > , makVrf::DtRangeLineSettingsRecord >	RecordBackupType

Detailed Description

This manager will manage settings for intervisibility objects.

Constructor & Destructor Documentation

virtual makVrf::DtRangeLineSettingsManager::~DtRangeLineSettingsManager ( )

virtual

DTOR.

makVrf::DtRangeLineSettingsManager::DtRangeLineSettingsManager ( makVrv::DtDe & de )

protected

Protected CTOR ( use instance(..) ).

Member Function Documentation

static DtRangeLineSettingsManager& makVrf::DtRangeLineSettingsManager::instance ( makVrv::DtDe & de )

static

Get an instance of the settings manager.

void makVrf::DtRangeLineSettingsManager::setRangeLinesVisible ( bool enabled )

Sets whether range line objects are globally seen/hidden.

bool makVrf::DtRangeLineSettingsManager::rangeLinesVisible ( ) const

Gets whether intervisibility objects are globally seen/hidden.

void makVrf::DtRangeLineSettingsManager::setColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

Sets the color of the range line (default red)

void makVrf::DtRangeLineSettingsManager::color	(	float &	r,
		float &	g,
		float &	b,
		float &	a
	)		const

Gets the color of the range line.

void makVrf::DtRangeLineSettingsManager::setRangeInfoLabelBackgroundColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

Sets the background color (and opacity) for the range info labels.

void makVrf::DtRangeLineSettingsManager::rangeInfoLabelBackgroundColor	(	float &	r,
		float &	g,
		float &	b,
		float &	a
	)		const

Gets the background color (and opacity) for the range info labels.

void makVrf::DtRangeLineSettingsManager::setFontColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

Sets the color of the font (default green)

void makVrf::DtRangeLineSettingsManager::fontColor	(	float &	r,
		float &	g,
		float &	b,
		float &	a
	)		const

Gets the color of the range line font.

void makVrf::DtRangeLineSettingsManager::setFontSize ( int )

Sets the font size (default 14);.

int makVrf::DtRangeLineSettingsManager::fontSize ( ) const

Gets the font size.

void makVrf::DtRangeLineSettingsManager::setLineWidth ( int )

Sets the line width (default is 3)

int makVrf::DtRangeLineSettingsManager::lineWidth ( ) const

Gets the line width.

void makVrf::DtRangeLineSettingsManager::setHatLinesEnabled ( bool hatEnabled )

Sets whether height above terrain lines are enabled (default is false)

bool makVrf::DtRangeLineSettingsManager::hatLinesEnabled ( ) const

Gets whether height above terrain lines are enabled.

void makVrf::DtRangeLineSettingsManager::setHatLinesOnSelectionOnly ( bool selOnly )

Sets whether HAT lines are shown only when the object is selected (default is false)

bool makVrf::DtRangeLineSettingsManager::hatLinesOnSelectionOnly ( ) const

Gets whether HAT lines are shown only when the object is selected.

virtual void makVrf::DtRangeLineSettingsManager::setFromRecord ( const DtRangeLineSettingsRecord & rec )

virtual

Use the settings from the given settings record.

Implements makVrv::DtBaseSettingsManager< makVrf::DtRangeLineSettingsRecord >.

virtual void makVrf::DtRangeLineSettingsManager::getRecord ( DtRangeLineSettingsRecord & rec ) const

virtual

Populate the given record with the current settings.

Implements makVrv::DtBaseSettingsManager< makVrf::DtRangeLineSettingsRecord >.

void makVrf::DtRangeLineSettingsManager::setAutoSave ( bool doit )

virtual

Sets whether autosave is enabled for the settings manager.

If autosave is enabled, the settings will be saved as they're changed.

Reimplemented from makVrv::DtCommonBaseSettingsManager< makVrf::DtRangeLineSettingsRecord >.

bool makVrf::DtRangeLineSettingsManager::autoSave ( ) const

virtual

Gets whether autosave is enabled for the settings manager.

If autosave is enabled, the settings will be saved as they're changed.

Reimplemented from makVrv::DtCommonBaseSettingsManager< makVrf::DtRangeLineSettingsRecord >.

virtual void makVrf::DtRangeLineSettingsManager::completeSetup ( )

protectedvirtual

register the type of information to save and reload

Friends And Related Function Documentation

template<typename ManagerClass >

ManagerClass& makVrv::defaultManagerInstanceFunction	(	makVrv::DtDe &	,
		bool
	)

friend

Befriend the manager instance functions for instance retrieval/creation.

template<typename ManagerClass >

void makVrv::defaultManagerRegisterInstanceFunction	(	makVrv::DtDe &	,
		ManagerClass *
	)

friend

Befriend the manager instance functions for instance retrieval/creation.

Member Data Documentation

boost::signals2::signal<void (bool)> makVrf::DtRangeLineSettingsManager::signal_rangeLinesVisibleChanged

boost::signals2::signal<void (int)> makVrf::DtRangeLineSettingsManager::signal_fontSizeChanged

boost::signals2::signal<void (int)> makVrf::DtRangeLineSettingsManager::signal_lineWidthChanged

boost::signals2::signal<void (bool)> makVrf::DtRangeLineSettingsManager::signal_hatLinesEnabledSet

boost::signals2::signal<void (bool)> makVrf::DtRangeLineSettingsManager::signal_hatLinesOnSelectionOnlySet

boost::signals2::signal<void (float r, float g, float b, float a)> makVrf::DtRangeLineSettingsManager::signal_colorSet

boost::signals2::signal<void (float r, float g, float b, float a)> makVrf::DtRangeLineSettingsManager::signal_fontColorSet

boost::signals2::signal<void (float r, float g, float b, float a)> makVrf::DtRangeLineSettingsManager::signal_rangeInfoBackgroundColorSet

DtRangeLineSettingsRecord makVrf::DtRangeLineSettingsManager::mySettings

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrfGuiCore/rangeLineSettingsManager.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation