VR-Forces 5.0.3 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends
makVrf::DtRangeLineSettingsManager Class Reference
vrvCore

This manager will manage settings for intervisibility objects.

Inheritance diagram for makVrf::DtRangeLineSettingsManager:
Inheritance graph
[legend]

Public Member Functions

virtual ~DtRangeLineSettingsManager ()
 
Setters/getters for settings
void setRangeLinesVisible (bool enabled)
 
bool rangeLinesVisible () const
 
void setColor (float r, float g, float b, float a)
 
void color (float &r, float &g, float &b, float &a) const
 
void setRangeInfoLabelBackgroundColor (float r, float g, float b, float a)
 
void rangeInfoLabelBackgroundColor (float &r, float &g, float &b, float &a) const
 
void setFontColor (float r, float g, float b, float a)
 
void fontColor (float &r, float &g, float &b, float &a) const
 
void setFontSize (int)
 
int fontSize () const
 
void setLineWidth (int)
 
int lineWidth () const
 
void setHatLinesEnabled (bool hatEnabled)
 
bool hatLinesEnabled () const
 
void setHatLinesOnSelectionOnly (bool selOnly)
 
bool hatLinesOnSelectionOnly () const
 
virtual void setRangeLineCreatedOnMiddleMouseClick (bool)
 
bool rangeLineCreatedOnMiddleMouseClick () const
 
Archiving methods
virtual void setFromRecord (const DtRangeLineSettingsRecord &rec)
 
virtual void getRecord (DtRangeLineSettingsRecord &rec) const
 
void setAutoSave (bool b)
 
bool autoSave () const
 
- Public Member Functions inherited from makVrv::DtBaseSettingsManager< makVrf::DtRangeLineSettingsRecord >
 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< makVrf::DtRangeLineSettingsRecord >
 DtCommonBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
 
virtual ~DtCommonBaseSettingsManager ()
 
virtual void autoSaveIfNecessary ()
 
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< makVrf::DtRangeLineSettingsRecord > &rec, std::vector< std::string > &fileNames)
 
virtual void addRecords (makVrf::DtRangeLineSettingsRecord &rec, makVrf::DtRangeLineSettingsRecord &combinedRec)
 
- Public Member Functions inherited from makVrv::DtVirtualBaseClass
 DtVirtualBaseClass ()
 
virtual ~DtVirtualBaseClass ()
 

Static Public Member Functions

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

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
 
boost::signals2::signal< void(bool)> signal_rangeLineCreateOnMiddleClickSet
 

Protected Member Functions

 DtRangeLineSettingsManager (makVrv::DtDe &de)
 
virtual void completeSetup ()
 

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)
 
template<typename ManagerClass >
void makVrv::defaultManagerRegisterInstanceFunction (makVrv::DtDe &, ManagerClass *)
 

Additional Inherited Members

- Protected Types inherited from makVrv::DtBaseSettingsManager< makVrf::DtRangeLineSettingsRecord >
typedef DtRecordSettingsBackup
< DtBaseSettingsManager
< makVrf::DtRangeLineSettingsRecord >
, makVrf::DtRangeLineSettingsRecord > 		RecordBackupType
 

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::setRangeLineCreatedOnMiddleMouseClick ( bool  )
virtual

Sets whether or not, when the middle mouse button is pressed when on the PVD, a temporary range line is created (and destroyed when the mouse button is released).

bool makVrf::DtRangeLineSettingsManager::rangeLineCreatedOnMiddleMouseClick ( ) const

Sets whether range line objects are globally seen/hidden.

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  b)
virtual

Use the settings from the given settings record.

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

bool makVrf::DtRangeLineSettingsManager::autoSave ( ) const
virtual

Use the settings from the given settings record.

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
boost::signals2::signal<void (bool)> makVrf::DtRangeLineSettingsManager::signal_rangeLineCreateOnMiddleClickSet
DtRangeLineSettingsRecord makVrf::DtRangeLineSettingsManager::mySettings
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Thu Jun 1 17:58:13 EDT 2023 from SVN revision 255404
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)