Record class for Intervisibility settings. More...

Public Member Functions
	DtIntervisibilitySettingsRecord ()
	CTOR.
	DtIntervisibilitySettingsRecord (const DtIntervisibilitySettingsRecord &copy)
	Copy CTOR.
DtIntervisibilitySettingsRecord &	operator= (const DtIntervisibilitySettingsRecord &obj)
	Assignment operator.
	~DtIntervisibilitySettingsRecord ()
	DTOR.
bool	operator== (const DtIntervisibilitySettingsRecord &rhs) const
	Equality operator.
bool	operator!= (const DtIntervisibilitySettingsRecord &rhs) const
	Not-Equals operator.
Setting value Setters/Getters
void	setIntervisibilityEnabled (bool enabled)
	Sets whether intervisibility objects are globally seen/hidden.
bool	intervisibilityEnabled () const
	Gets whether intervisibility objects are globally seen/hidden.
void	setLeftClickMakesObjectsPermanent (bool enabled)
	Sets whether left-clicking places object or starts a new one.
bool	leftClickMakesObjectsPermanent () const
	Gets whether left-clicking places object or starts a new one.
void	setOriginIntervisibilityElevation (double height)
	Sets the distance above the origin to place the intervisibility line (in meters).
double	originIntervisibilityElevation () const
	Gets the distance above the origin the intervisibility line is placed (in meters).
void	setEndPointIntervisibilityElevation (double height)
	Sets the distance above the end point to place the intervisibility line (in meters).
double	endPointIntervisibilityElevation () const
	Gets the distance above the end point the intervisibility line is placed (in meters).
void	setFanModeSamplingRate (double radAngle)
	Sets the angle between fan mode samples (in radians).
double	fanModeSamplingRate () const
	Gets the angle between fan mode samples (in radians).
void	setEntityFanUpdateRate (double interval)
	Sets the time between entity fan mode updates (in seconds).
double	entityFanUpdateRate () const
	Gets the time between entity fan mode updates (in seconds).
void	setHatLinesEnabled (bool hatEnabled)
	Sets whether height above terrain lines are enabled.
bool	hatLinesEnabled () const
	Gets whether height above terrain lines are enabled.
void	setHatLinesOnSelectionOnly (bool selOnly)
	Sets whether HAT lines are shown only when the object is selected.
bool	hatLinesOnSelectionOnly () const
	Gets whether HAT lines are shown only when the object is selected.
void	setVisibleColor (float r, float g, float b, float a)
	Sets the color of the visible portion of the intervisibility line.
void	visibleColor (float &r, float &g, float &b, float &a) const
	Gets the color of the visible portion of the intervisibility line.
void	setBlockedColor (float r, float g, float b, float a)
	Sets the color of the blocked portion of the intervisibility line.
void	blockedColor (float &r, float &g, float &b, float &a) const
	Gets the color of the blocked portion of the intervisibility line.
void	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	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	setRangeInfoLabelsEnabled (bool enabled)
	Sets whether intervisibility lines display range ruler information.
bool	rangeInfoLabelsEnabled () const
	Gets whether intervisibility lines display range ruler information.
void	setRangeInfoLabelBackgroundColor (float r, float g, float b, float a)
	Sets the background color (and opacity) for the range info labels.
void	rangeInfoLabelBackgroundColor (float &r, float &g, float &b, float &a) const
	Gets the background color (and opacity) for the range info labels.
void	setRangeInfoAltChangeFieldEnabled (bool enabled)
	Sets whether the altitude change field is visible on the range info labels.
bool	rangeInfoAltChangeFieldEnabled () const
	Gets whether the altitude change field is visible on the range info labels.
void	setRangeInfoLocationFieldEnabled (bool enabled)
	Sets whether the location field is visible on the range info labels.
bool	rangeInfoLocationFieldEnabled () const
	Gets whether the location field is visible on the range info labels.
void	setRangeInfoHeadingFieldEnabled (bool enabled)
	Sets whether the heading field is visible on the range info labels.
bool	rangeInfoHeadingFieldEnabled () const
	Gets whether the heading field is visible on the range info labels.
void	setRangeInfoRangeFieldEnabled (bool enabled)
	Sets whether the range field is visible on the range info labels.
bool	rangeInfoRangeFieldEnabled () const
	Gets whether the range field is visible on the range info labels.

Protected Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
	When the class Archive corresponds to an output archive, the & operator is defined similar to <<.

Protected Attributes
bool	myIntervisibilityEnabled
bool	myLeftClickMakesObjectsPermanent
bool	myHatLinesEnabled
bool	myHatLinesOnSelectionOnly
double	myOriginIntervisibilityElevation
double	myEndPointIntervisibilityElevation
double	myFanModeSamplingRate
double	myEntityFanUpdateRate
float	myVisibleColorR
float	myVisibleColorG
float	myVisibleColorB
float	myVisibleColorA
float	myBlockedColorR
float	myBlockedColorG
float	myBlockedColorB
float	myBlockedColorA
float	myCircleColorR
float	myCircleColorG
float	myCircleColorB
float	myCircleColorA
bool	myRangeInfoLabelsEnabled
float	myRangeInfoLabelBackgroundColorR
float	myRangeInfoLabelBackgroundColorG
float	myRangeInfoLabelBackgroundColorB
float	myRangeInfoLabelBackgroundColorA
bool	myRangeInfoAltChangeFieldEnabledFlag
bool	myRangeInfoLocationFieldEnabledFlag
bool	myRangeInfoHeadingFieldEnabledFlag
bool	myRangeInfoRangeFieldEnabledFlag

Friends
class	boost::serialization::access

Detailed Description

Record class for Intervisibility settings.

Constructor & Destructor Documentation

makArchives::DtIntervisibilitySettingsRecord::DtIntervisibilitySettingsRecord ( )

CTOR.

makArchives::DtIntervisibilitySettingsRecord::DtIntervisibilitySettingsRecord ( const DtIntervisibilitySettingsRecord & copy )

Copy CTOR.

makArchives::DtIntervisibilitySettingsRecord::~DtIntervisibilitySettingsRecord ( )

DTOR.

Member Function Documentation

DtIntervisibilitySettingsRecord& makArchives::DtIntervisibilitySettingsRecord::operator= ( const DtIntervisibilitySettingsRecord & obj )

Assignment operator.

bool makArchives::DtIntervisibilitySettingsRecord::operator== ( const DtIntervisibilitySettingsRecord & rhs ) const

Equality operator.

bool makArchives::DtIntervisibilitySettingsRecord::operator!= ( const DtIntervisibilitySettingsRecord & rhs ) const

inline

Not-Equals operator.

void makArchives::DtIntervisibilitySettingsRecord::setIntervisibilityEnabled ( bool enabled )

Sets whether intervisibility objects are globally seen/hidden.

bool makArchives::DtIntervisibilitySettingsRecord::intervisibilityEnabled ( ) const

Gets whether intervisibility objects are globally seen/hidden.

void makArchives::DtIntervisibilitySettingsRecord::setLeftClickMakesObjectsPermanent ( bool enabled )

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

bool makArchives::DtIntervisibilitySettingsRecord::leftClickMakesObjectsPermanent ( ) const

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

void makArchives::DtIntervisibilitySettingsRecord::setOriginIntervisibilityElevation ( double height )

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

double makArchives::DtIntervisibilitySettingsRecord::originIntervisibilityElevation ( ) const

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

void makArchives::DtIntervisibilitySettingsRecord::setEndPointIntervisibilityElevation ( double height )

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

double makArchives::DtIntervisibilitySettingsRecord::endPointIntervisibilityElevation ( ) const

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

void makArchives::DtIntervisibilitySettingsRecord::setFanModeSamplingRate ( double radAngle )

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

double makArchives::DtIntervisibilitySettingsRecord::fanModeSamplingRate ( ) const

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

void makArchives::DtIntervisibilitySettingsRecord::setEntityFanUpdateRate ( double interval )

Sets the time between entity fan mode updates (in seconds).

Zero (0) default means check as fast as possible.

double makArchives::DtIntervisibilitySettingsRecord::entityFanUpdateRate ( ) const

Gets the time between entity fan mode updates (in seconds).

Zero (0) default means check as fast as possible.

void makArchives::DtIntervisibilitySettingsRecord::setHatLinesEnabled ( bool hatEnabled )

Sets whether height above terrain lines are enabled.

bool makArchives::DtIntervisibilitySettingsRecord::hatLinesEnabled ( ) const

Gets whether height above terrain lines are enabled.

void makArchives::DtIntervisibilitySettingsRecord::setHatLinesOnSelectionOnly ( bool selOnly )

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

bool makArchives::DtIntervisibilitySettingsRecord::hatLinesOnSelectionOnly ( ) const

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

void makArchives::DtIntervisibilitySettingsRecord::setVisibleColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

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

void makArchives::DtIntervisibilitySettingsRecord::visibleColor	(	float &	r,
		float &	g,
		float &	b,
		float &	a
	)		const

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

void makArchives::DtIntervisibilitySettingsRecord::setBlockedColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

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

void makArchives::DtIntervisibilitySettingsRecord::blockedColor	(	float &	r,
		float &	g,
		float &	b,
		float &	a
	)		const

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

void makArchives::DtIntervisibilitySettingsRecord::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 makArchives::DtIntervisibilitySettingsRecord::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 makArchives::DtIntervisibilitySettingsRecord::setRangeInfoLabelsEnabled ( bool enabled )

Sets whether intervisibility lines display range ruler information.

bool makArchives::DtIntervisibilitySettingsRecord::rangeInfoLabelsEnabled ( ) const

Gets whether intervisibility lines display range ruler information.

void makArchives::DtIntervisibilitySettingsRecord::setRangeInfoLabelBackgroundColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

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

void makArchives::DtIntervisibilitySettingsRecord::rangeInfoLabelBackgroundColor	(	float &	r,
		float &	g,
		float &	b,
		float &	a
	)		const

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

void makArchives::DtIntervisibilitySettingsRecord::setRangeInfoAltChangeFieldEnabled ( bool enabled )

Sets whether the altitude change field is visible on the range info labels.

bool makArchives::DtIntervisibilitySettingsRecord::rangeInfoAltChangeFieldEnabled ( ) const

Gets whether the altitude change field is visible on the range info labels.

void makArchives::DtIntervisibilitySettingsRecord::setRangeInfoLocationFieldEnabled ( bool enabled )

Sets whether the location field is visible on the range info labels.

bool makArchives::DtIntervisibilitySettingsRecord::rangeInfoLocationFieldEnabled ( ) const

Gets whether the location field is visible on the range info labels.

void makArchives::DtIntervisibilitySettingsRecord::setRangeInfoHeadingFieldEnabled ( bool enabled )

Sets whether the heading field is visible on the range info labels.

bool makArchives::DtIntervisibilitySettingsRecord::rangeInfoHeadingFieldEnabled ( ) const

Gets whether the heading field is visible on the range info labels.

void makArchives::DtIntervisibilitySettingsRecord::setRangeInfoRangeFieldEnabled ( bool enabled )

Sets whether the range field is visible on the range info labels.

bool makArchives::DtIntervisibilitySettingsRecord::rangeInfoRangeFieldEnabled ( ) const

Gets whether the range field is visible on the range info labels.

template<class Archive >

void makArchives::DtIntervisibilitySettingsRecord::serialize	(	Archive &	ar,
		const unsigned int	version
	)

inlineprotected

When the class Archive corresponds to an output archive, the & operator is defined similar to <<.

Likewise, when the class Archive is a type of input archive the & operator is defined similar to >>.

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Member Data Documentation

bool makArchives::DtIntervisibilitySettingsRecord::myIntervisibilityEnabled

protected

bool makArchives::DtIntervisibilitySettingsRecord::myLeftClickMakesObjectsPermanent

protected

bool makArchives::DtIntervisibilitySettingsRecord::myHatLinesEnabled

protected

bool makArchives::DtIntervisibilitySettingsRecord::myHatLinesOnSelectionOnly

protected

double makArchives::DtIntervisibilitySettingsRecord::myOriginIntervisibilityElevation

protected

double makArchives::DtIntervisibilitySettingsRecord::myEndPointIntervisibilityElevation

protected

double makArchives::DtIntervisibilitySettingsRecord::myFanModeSamplingRate

protected

double makArchives::DtIntervisibilitySettingsRecord::myEntityFanUpdateRate

protected

float makArchives::DtIntervisibilitySettingsRecord::myVisibleColorR

protected

float makArchives::DtIntervisibilitySettingsRecord::myVisibleColorG

protected

float makArchives::DtIntervisibilitySettingsRecord::myVisibleColorB

protected

float makArchives::DtIntervisibilitySettingsRecord::myVisibleColorA

protected

float makArchives::DtIntervisibilitySettingsRecord::myBlockedColorR

protected

float makArchives::DtIntervisibilitySettingsRecord::myBlockedColorG

protected

float makArchives::DtIntervisibilitySettingsRecord::myBlockedColorB

protected

float makArchives::DtIntervisibilitySettingsRecord::myBlockedColorA

protected

float makArchives::DtIntervisibilitySettingsRecord::myCircleColorR

protected

float makArchives::DtIntervisibilitySettingsRecord::myCircleColorG

protected

float makArchives::DtIntervisibilitySettingsRecord::myCircleColorB

protected

float makArchives::DtIntervisibilitySettingsRecord::myCircleColorA

protected

bool makArchives::DtIntervisibilitySettingsRecord::myRangeInfoLabelsEnabled

protected

float makArchives::DtIntervisibilitySettingsRecord::myRangeInfoLabelBackgroundColorR

protected

float makArchives::DtIntervisibilitySettingsRecord::myRangeInfoLabelBackgroundColorG

protected

float makArchives::DtIntervisibilitySettingsRecord::myRangeInfoLabelBackgroundColorB

protected

float makArchives::DtIntervisibilitySettingsRecord::myRangeInfoLabelBackgroundColorA

protected

bool makArchives::DtIntervisibilitySettingsRecord::myRangeInfoAltChangeFieldEnabledFlag

protected

bool makArchives::DtIntervisibilitySettingsRecord::myRangeInfoLocationFieldEnabledFlag

protected

bool makArchives::DtIntervisibilitySettingsRecord::myRangeInfoHeadingFieldEnabledFlag

protected

bool makArchives::DtIntervisibilitySettingsRecord::myRangeInfoRangeFieldEnabledFlag

protected

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

include/makArchives/DtIntervisibilitySettingsRecord.h

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation