VR-Forces 5.0.1 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
makVrv::DtIntervisibilitySettingsManager Class Reference
vrvCore

This manager will manage settings for intervisibility objects.

Inheritance diagram for makVrv::DtIntervisibilitySettingsManager:
Inheritance graph
[legend]

Public Member Functions

virtual ~DtIntervisibilitySettingsManager ()
 
Setters/getters for settings
void setIntervisibilityEnabled (bool enabled)
 
bool intervisibilityEnabled () const
 
void setLeftClickMakesObjectsPermanent (bool enabled)
 
bool leftClickMakesObjectsPermanent () const
 
void setOriginIntervisibilityElevation (double height)
 
double originIntervisibilityElevation () const
 
void setEndPointIntervisibilityElevation (double height)
 
double endPointIntervisibilityElevation () const
 
void setFanModeSamplingRate (double radAngle)
 
double fanModeSamplingRate () const
 
void setEntityFanUpdateRate (double interval)
 
double entityFanUpdateRate () const
 
void setHatLinesEnabled (bool hatEnabled)
 
bool hatLinesEnabled () const
 
void setHatLinesOnSelectionOnly (bool selOnly)
 
bool hatLinesOnSelectionOnly () const
 
void setVisibleColor (float r, float g, float b, float a)
 
void visibleColor (float &r, float &g, float &b, float &a) const
 
void setBlockedColor (float r, float g, float b, float a)
 
void blockedColor (float &r, float &g, float &b, float &a) const
 
void setCircleColor (float r, float g, float b, float a)
 
void circleColor (float &r, float &g, float &b, float &a) const
 
void setRangeInfoLabelsEnabled (bool enabled)
 
bool rangeInfoLabelsEnabled () const
 
void setRangeInfoLabelBackgroundColor (float r, float g, float b)
 
void rangeInfoLabelBackgroundColor (float &r, float &g, float &b)
 
void setRangeInfoLabelBackgroundOpacity (float opacity)
 
float rangeInfoLabelBackgroundOpacity () const
 
void setRangeInfoAltChangeFieldEnabled (bool enabled)
 
bool rangeInfoAltChangeFieldEnabled () const
 
void setRangeInfoLocationFieldEnabled (bool enabled)
 
bool rangeInfoLocationFieldEnabled () const
 
void setRangeInfoHeadingFieldEnabled (bool enabled)
 
bool rangeInfoHeadingFieldEnabled () const
 
void setRangeInfoRangeFieldEnabled (bool enabled)
 
bool rangeInfoRangeFieldEnabled () const
 
Archiving methods
virtual void setFromRecord (const makArchives::DtIntervisibilitySettingsRecord &rec)
 
virtual void getRecord (makArchives::DtIntervisibilitySettingsRecord &rec) const
 
Methods for checking if object (object type) is attachable.
virtual bool isAttachableObjectType (DtElementEntry::ObjectType t) const
 
virtual bool isAttachableObjectType (DtUniqueID elementId) const
 
- Public Member Functions inherited from makVrv::DtBaseSettingsManager< makArchives::DtIntervisibilitySettingsRecord >
 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::DtIntervisibilitySettingsRecord >
 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::DtIntervisibilitySettingsRecord > &rec, std::vector< std::string > &fileNames)
 
virtual void addRecords (makArchives::DtIntervisibilitySettingsRecord &rec, makArchives::DtIntervisibilitySettingsRecord &combinedRec)
 
- Public Member Functions inherited from makVrv::DtVirtualBaseClass
 DtVirtualBaseClass ()
 
virtual ~DtVirtualBaseClass ()
 

Static Public Member Functions

static
DtIntervisibilitySettingsManager & 		instance (DtDe &de)
 

Public Attributes

Boost signals for changed settings
boost::signalslib::signal
< void(bool)> 		signal_intervisibilityEnabledSet
 
boost::signalslib::signal
< void(bool)> 		signal_leftClickMakesObjectsPermanentSet
 
boost::signalslib::signal
< void(double)> 		signal_originIntervisibilityElevationSet
 
boost::signalslib::signal
< void(double)> 		signal_endPointIntervisibilityElevationSet
 
boost::signalslib::signal
< void(double)> 		signal_fanModeSamplingRateSet
 
boost::signalslib::signal
< void(double)> 		signal_entityFanUpdateRateSet
 
boost::signalslib::signal
< void(bool)> 		signal_hatLinesEnabledSet
 
boost::signalslib::signal
< void(bool)> 		signal_hatLinesOnSelectionOnlySet
 
boost::signalslib::signal
< void(float r, float g, float
b, float a)> 		signal_visibleColorSet
 
boost::signalslib::signal
< void(float r, float g, float
b, float a)> 		signal_blockedColorSet
 
boost::signalslib::signal
< void(float r, float g, float
b, float a)> 		signal_circleColorSet
 
boost::signalslib::signal
< void(bool)> 		signal_rangeInfoLabelsEnabledSet
 
boost::signalslib::signal
< void(float r, float g, float
b, float a)> 		signal_rangeInfoBackgroundColorSet
 
boost::signalslib::signal
< void(bool)> 		signal_rangeInfoAltChangeFieldEnabledChanged
 
boost::signalslib::signal
< void(bool)> 		signal_rangeInfoLocationFieldEnabledChanged
 
boost::signalslib::signal
< void(bool)> 		signal_rangeInfoHeadingFieldEnabledChanged
 
boost::signalslib::signal
< void(bool)> 		signal_rangeInfoRangeFieldEnabledChanged
 

Protected Member Functions

 DtIntervisibilitySettingsManager (DtDe &de)
 

Protected Attributes

bool myIntervisibilityEnabled
 
bool myLeftClickMakesObjectsPermanent
 
bool myHatLinesEnabled
 
bool myHatLinesOnSelectionOnly
 
double myOriginIntervisibilityElevation
 
double myEndPointIntervisibilityElevation
 
double myFanModeSamplingRate
 
double myEntityFanUpdateRate
 
float myVisibleColor [4]
 
float myBlockedColor [4]
 
float myCircleColor [4]
 
bool myRangeInfoLabelsEnabled
 
float myRangeInfoBackgroundColor [4]
 
bool myRangeInfoAltChangeFieldEnabled
 
bool myRangeInfoLocationFieldEnabled
 
bool myRangeInfoHeadingFieldEnabled
 
bool myRangeInfoRangeFieldEnabled
 
- Protected Attributes inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtIntervisibilitySettingsRecord >
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::DtIntervisibilitySettingsRecord >
typedef DtRecordSettingsBackup
< DtBaseSettingsManager
< makArchives::DtIntervisibilitySettingsRecord >
, makArchives::DtIntervisibilitySettingsRecord > 		RecordBackupType
 

Constructor & Destructor Documentation

virtual makVrv::DtIntervisibilitySettingsManager::~DtIntervisibilitySettingsManager ( )
virtual

DTOR.

makVrv::DtIntervisibilitySettingsManager::DtIntervisibilitySettingsManager ( DtDe &  de)
protected

Protected CTOR ( use instance(..) ).

Member Function Documentation

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

Get an instance of the settings manager.

void makVrv::DtIntervisibilitySettingsManager::setIntervisibilityEnabled ( bool  enabled)

Sets whether intervisibility objects are globally seen/hidden.

bool makVrv::DtIntervisibilitySettingsManager::intervisibilityEnabled ( ) const

Gets whether intervisibility objects are globally seen/hidden.

void makVrv::DtIntervisibilitySettingsManager::setLeftClickMakesObjectsPermanent ( bool  enabled)

Sets whether left-clicking places object or starts a new one.

bool makVrv::DtIntervisibilitySettingsManager::leftClickMakesObjectsPermanent ( ) const

Gets whether left-clicking places object or starts a new one.

void makVrv::DtIntervisibilitySettingsManager::setOriginIntervisibilityElevation ( double  height)

Sets the distance above the origin to place the intervisibility line (in meters).

double makVrv::DtIntervisibilitySettingsManager::originIntervisibilityElevation ( ) const

Gets the distance above the origin the intervisibility line is placed (in meters).

void makVrv::DtIntervisibilitySettingsManager::setEndPointIntervisibilityElevation ( double  height)

Sets the distance above the end point to place the intervisibility line (in meters).

double makVrv::DtIntervisibilitySettingsManager::endPointIntervisibilityElevation ( ) const

Gets the distance above the end point the intervisibility line is placed (in meters).

void makVrv::DtIntervisibilitySettingsManager::setFanModeSamplingRate ( double  radAngle)

Sets the angle between fan mode samples (in radians).

double makVrv::DtIntervisibilitySettingsManager::fanModeSamplingRate ( ) const

Gets the angle between fan mode samples (in radians).

void makVrv::DtIntervisibilitySettingsManager::setEntityFanUpdateRate ( double  interval)

Sets the time between entity fan mode updates (in seconds). Zero (0) default means check as fast as possible.

double makVrv::DtIntervisibilitySettingsManager::entityFanUpdateRate ( ) const

Gets the time between entity fan mode updates (in seconds). Zero (0) default means check as fast as possible.

void makVrv::DtIntervisibilitySettingsManager::setHatLinesEnabled ( bool  hatEnabled)

Sets whether height above terrain lines are enabled.

bool makVrv::DtIntervisibilitySettingsManager::hatLinesEnabled ( ) const

Gets whether height above terrain lines are enabled.

void makVrv::DtIntervisibilitySettingsManager::setHatLinesOnSelectionOnly ( bool  selOnly)

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

bool makVrv::DtIntervisibilitySettingsManager::hatLinesOnSelectionOnly ( ) const

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

void makVrv::DtIntervisibilitySettingsManager::setVisibleColor ( float  r,
float  g,
float  b,
float  a 
)

Sets the color of the visible portion of the intervisibility line.

void makVrv::DtIntervisibilitySettingsManager::visibleColor ( float &  r,
float &  g,
float &  b,
float &  a 
) const

Gets the color of the visible portion of the intervisibility line.

void makVrv::DtIntervisibilitySettingsManager::setBlockedColor ( float  r,
float  g,
float  b,
float  a 
)

Sets the color of the blocked portion of the intervisibility line.

void makVrv::DtIntervisibilitySettingsManager::blockedColor ( float &  r,
float &  g,
float &  b,
float &  a 
) const

Gets the color of the blocked portion of the intervisibility line.

void makVrv::DtIntervisibilitySettingsManager::setCircleColor ( float  r,
float  g,
float  b,
float  a 
)

Sets the color of the circle outline of a fan, grid line or entity intervisibility.

void makVrv::DtIntervisibilitySettingsManager::circleColor ( float &  r,
float &  g,
float &  b,
float &  a 
) const

Gets the color of the circle outline of a fan, grid line or entity intervisibility.

void makVrv::DtIntervisibilitySettingsManager::setRangeInfoLabelsEnabled ( bool  enabled)

Sets whether intervisibility lines display range ruler information.

bool makVrv::DtIntervisibilitySettingsManager::rangeInfoLabelsEnabled ( ) const

Gets whether intervisibility lines display range ruler information.

void makVrv::DtIntervisibilitySettingsManager::setRangeInfoLabelBackgroundColor ( float  r,
float  g,
float  b 
)

Sets the background color for the range info labels.

void makVrv::DtIntervisibilitySettingsManager::rangeInfoLabelBackgroundColor ( float &  r,
float &  g,
float &  b 
)

Gets the background color for the range info labels.

void makVrv::DtIntervisibilitySettingsManager::setRangeInfoLabelBackgroundOpacity ( float  opacity)

Sets the opacity/transparency level for the range info label backgrounds.

float makVrv::DtIntervisibilitySettingsManager::rangeInfoLabelBackgroundOpacity ( ) const

Gets the opacity/transparency level for the range info label backgrounds.

void makVrv::DtIntervisibilitySettingsManager::setRangeInfoAltChangeFieldEnabled ( bool  enabled)

Sets whether the range info's altitude change field is enabled.

bool makVrv::DtIntervisibilitySettingsManager::rangeInfoAltChangeFieldEnabled ( ) const

Gets whether the range info's altitude change field is enabled.

void makVrv::DtIntervisibilitySettingsManager::setRangeInfoLocationFieldEnabled ( bool  enabled)

Sets whether the range info's location field is enabled.

bool makVrv::DtIntervisibilitySettingsManager::rangeInfoLocationFieldEnabled ( ) const

Gets whether the range info's location field is enabled.

void makVrv::DtIntervisibilitySettingsManager::setRangeInfoHeadingFieldEnabled ( bool  enabled)

Sets whether the range info's heading field is enabled.

bool makVrv::DtIntervisibilitySettingsManager::rangeInfoHeadingFieldEnabled ( ) const

Gets whether the range info's heading field is enabled.

void makVrv::DtIntervisibilitySettingsManager::setRangeInfoRangeFieldEnabled ( bool  enabled)

Sets whether the range info's range field is enabled.

bool makVrv::DtIntervisibilitySettingsManager::rangeInfoRangeFieldEnabled ( ) const

Gets whether the range info's range field is enabled.

virtual void makVrv::DtIntervisibilitySettingsManager::setFromRecord ( const makArchives::DtIntervisibilitySettingsRecord &  rec)
virtual

Use the settings from the given settings record.

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

virtual void makVrv::DtIntervisibilitySettingsManager::getRecord ( makArchives::DtIntervisibilitySettingsRecord &  rec) const
virtual

Populate the given record with the current settings.

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

virtual bool makVrv::DtIntervisibilitySettingsManager::isAttachableObjectType ( DtElementEntry::ObjectType  t) const
virtual

Checks whether the given object type is one that can be attached to.

virtual bool makVrv::DtIntervisibilitySettingsManager::isAttachableObjectType ( DtUniqueID  elementId) const
virtual

Checks whether the entity with the given element id can be attached to.

Reimplemented in makVrf::DtVrfIntervisibilitySettingsManager.

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 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 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 (bool)> makVrv::DtIntervisibilitySettingsManager::signal_intervisibilityEnabledSet
boost::signalslib::signal<void (bool)> makVrv::DtIntervisibilitySettingsManager::signal_leftClickMakesObjectsPermanentSet
boost::signalslib::signal<void (double)> makVrv::DtIntervisibilitySettingsManager::signal_originIntervisibilityElevationSet
boost::signalslib::signal<void (double)> makVrv::DtIntervisibilitySettingsManager::signal_endPointIntervisibilityElevationSet
boost::signalslib::signal<void (double)> makVrv::DtIntervisibilitySettingsManager::signal_fanModeSamplingRateSet
boost::signalslib::signal<void (double)> makVrv::DtIntervisibilitySettingsManager::signal_entityFanUpdateRateSet
boost::signalslib::signal<void (bool)> makVrv::DtIntervisibilitySettingsManager::signal_hatLinesEnabledSet
boost::signalslib::signal<void (bool)> makVrv::DtIntervisibilitySettingsManager::signal_hatLinesOnSelectionOnlySet
boost::signalslib::signal<void (float r, float g, float b, float a)> makVrv::DtIntervisibilitySettingsManager::signal_visibleColorSet
boost::signalslib::signal<void (float r, float g, float b, float a)> makVrv::DtIntervisibilitySettingsManager::signal_blockedColorSet
boost::signalslib::signal<void (float r, float g, float b, float a)> makVrv::DtIntervisibilitySettingsManager::signal_circleColorSet
boost::signalslib::signal<void (bool)> makVrv::DtIntervisibilitySettingsManager::signal_rangeInfoLabelsEnabledSet
boost::signalslib::signal<void (float r, float g, float b, float a)> makVrv::DtIntervisibilitySettingsManager::signal_rangeInfoBackgroundColorSet
boost::signalslib::signal<void (bool)> makVrv::DtIntervisibilitySettingsManager::signal_rangeInfoAltChangeFieldEnabledChanged
boost::signalslib::signal<void (bool)> makVrv::DtIntervisibilitySettingsManager::signal_rangeInfoLocationFieldEnabledChanged
boost::signalslib::signal<void (bool)> makVrv::DtIntervisibilitySettingsManager::signal_rangeInfoHeadingFieldEnabledChanged
boost::signalslib::signal<void (bool)> makVrv::DtIntervisibilitySettingsManager::signal_rangeInfoRangeFieldEnabledChanged
bool makVrv::DtIntervisibilitySettingsManager::myIntervisibilityEnabled
protected
bool makVrv::DtIntervisibilitySettingsManager::myLeftClickMakesObjectsPermanent
protected
bool makVrv::DtIntervisibilitySettingsManager::myHatLinesEnabled
protected
bool makVrv::DtIntervisibilitySettingsManager::myHatLinesOnSelectionOnly
protected
double makVrv::DtIntervisibilitySettingsManager::myOriginIntervisibilityElevation
protected
double makVrv::DtIntervisibilitySettingsManager::myEndPointIntervisibilityElevation
protected
double makVrv::DtIntervisibilitySettingsManager::myFanModeSamplingRate
protected
double makVrv::DtIntervisibilitySettingsManager::myEntityFanUpdateRate
protected
float makVrv::DtIntervisibilitySettingsManager::myVisibleColor[4]
protected
float makVrv::DtIntervisibilitySettingsManager::myBlockedColor[4]
protected
float makVrv::DtIntervisibilitySettingsManager::myCircleColor[4]
protected
bool makVrv::DtIntervisibilitySettingsManager::myRangeInfoLabelsEnabled
protected
float makVrv::DtIntervisibilitySettingsManager::myRangeInfoBackgroundColor[4]
protected
bool makVrv::DtIntervisibilitySettingsManager::myRangeInfoAltChangeFieldEnabled
protected
bool makVrv::DtIntervisibilitySettingsManager::myRangeInfoLocationFieldEnabled
protected
bool makVrv::DtIntervisibilitySettingsManager::myRangeInfoHeadingFieldEnabled
protected
bool makVrv::DtIntervisibilitySettingsManager::myRangeInfoRangeFieldEnabled
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Mon Jun 20 00:38:30 EDT 2022 from SVN revision 244029
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)