makArchives::DtAggregateSettingsRecord Class Reference

Record class for aggregate settings. More...

Public Types
enum	DisplayFlags {   DisplayBoundingBoxes = 0x00000001, DisplayBoundingBoxesForSelected = 0x00000002, GhostEchelonLevelItems = 0x00000004, InitiallyDisplayExpanded = 0x00000008,   DisplayMainIcon = 0x00000010, DisplayLeafLevelItems = 0x00000020, AllowSelectingOfGhostedItems = 0x00000040, DisplayAggregates = 0x00000080 }

Public Member Functions
	DtAggregateSettingsRecord ()
	CTOR.
	DtAggregateSettingsRecord (const DtAggregateSettingsRecord &copy)
	Copy CTOR.
	~DtAggregateSettingsRecord ()
	DTOR.
DtAggregateSettingsRecord &	operator= (const DtAggregateSettingsRecord &obj)
	Assignment Operator.
bool	operator== (const DtAggregateSettingsRecord &rhs) const
bool	operator!= (const DtAggregateSettingsRecord &rhs) const
Setting Getters/Setters
double	ghostingTransparency () const
	Set the state flags for the various boolean settings.
void	setGhostingTransparency (double transparency)
	Set the state flags for the various boolean settings.
bool	ghostEchelonLevelItems () const
	Set the state flags for the various boolean settings.
void	setGhostEchelonLevelItems (bool enabled)
	Set the state flags for the various boolean settings.
int	echelonLevel () const
	Set the state flags for the various boolean settings.
void	setEchelonLevel (int level)
	Set the state flags for the various boolean settings.
bool	displayAggregates () const
	Set the state flags for the various boolean settings.
void	setDisplayAggregates (bool enabled)
	Set the state flags for the various boolean settings.
bool	displayBoundingBoxes () const
	Set the state flags for the various boolean settings.
void	setDisplayBoundingBoxes (bool enabled)
	Set the state flags for the various boolean settings.
bool	displayLeafNodes () const
	Set the state flags for the various boolean settings.
void	setDisplayLeafNodes (bool enabled)
	Set the state flags for the various boolean settings.
bool	displayBoundingBoxesForSelected () const
	Set the state flags for the various boolean settings.
void	setDisplayBoundingBoxesForSelected (bool enabled)
	Set the state flags for the various boolean settings.
bool	initiallyDisplayExpanded () const
	Set the state flags for the various boolean settings.
void	setInitiallyDisplayExpanded (bool enabled)
	Set the state flags for the various boolean settings.
bool	allowSelectingOfGhostedItems () const
	Set the state flags for the various boolean settings.
void	setAllowSelectingOfGhostedItems (bool enabled)
	Set the state flags for the various boolean settings.
bool	displayMainIcon () const
	Set the state flags for the various boolean settings.
void	setDisplayMainIcon (bool enabled)
	Set the state flags for the various boolean settings.
unsigned char	colorizedModelColorType () const
	Set the state flags for the various boolean settings.
void	setColorizedModelColorType (unsigned char colorMode)
	Set the state flags for the various boolean settings.
void	setFlags (int f)
	Set the state flags for the various boolean settings.
int	flags () const
	Get the state flags for the various boolean settings.

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
int	myFlags
int	myEchelonLevel
double	myGhostingTransparency
unsigned char	myColorizedModelColorType

Friends
class	boost::serialization::access

Detailed Description

Record class for aggregate settings.

Member Enumeration Documentation

enum makArchives::DtAggregateSettingsRecord::DisplayFlags

Enumerator:

DisplayBoundingBoxes
DisplayBoundingBoxesForSelected	Default is on for all model sets.
GhostEchelonLevelItems	Default is on.
InitiallyDisplayExpanded
DisplayMainIcon
DisplayLeafLevelItems
AllowSelectingOfGhostedItems
DisplayAggregates

Constructor & Destructor Documentation

makArchives::DtAggregateSettingsRecord::DtAggregateSettingsRecord

(

)

CTOR.

makArchives::DtAggregateSettingsRecord::DtAggregateSettingsRecord

(

const DtAggregateSettingsRecord &

copy

)

Copy CTOR.

makArchives::DtAggregateSettingsRecord::~DtAggregateSettingsRecord

(

)

DTOR.

Member Function Documentation

DtAggregateSettingsRecord& makArchives::DtAggregateSettingsRecord::operator=

(

const DtAggregateSettingsRecord &

obj

)

Assignment Operator.

bool makArchives::DtAggregateSettingsRecord::operator==

(

const DtAggregateSettingsRecord &

rhs

)

const

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

inline

double makArchives::DtAggregateSettingsRecord::ghostingTransparency

(

)

const

Set the state flags for the various boolean settings.

void makArchives::DtAggregateSettingsRecord::setGhostingTransparency

(

double

transparency

)

Set the state flags for the various boolean settings.

bool makArchives::DtAggregateSettingsRecord::ghostEchelonLevelItems

(

)

const

Set the state flags for the various boolean settings.

void makArchives::DtAggregateSettingsRecord::setGhostEchelonLevelItems

(

bool

enabled

)

Set the state flags for the various boolean settings.

int makArchives::DtAggregateSettingsRecord::echelonLevel

(

)

const

Set the state flags for the various boolean settings.

void makArchives::DtAggregateSettingsRecord::setEchelonLevel

(

int

level

)

Set the state flags for the various boolean settings.

bool makArchives::DtAggregateSettingsRecord::displayAggregates

(

)

const

Set the state flags for the various boolean settings.

void makArchives::DtAggregateSettingsRecord::setDisplayAggregates

(

bool

enabled

)

Set the state flags for the various boolean settings.

bool makArchives::DtAggregateSettingsRecord::displayBoundingBoxes

(

)

const

Set the state flags for the various boolean settings.

void makArchives::DtAggregateSettingsRecord::setDisplayBoundingBoxes

(

bool

enabled

)

Set the state flags for the various boolean settings.

bool makArchives::DtAggregateSettingsRecord::displayLeafNodes

(

)

const

Set the state flags for the various boolean settings.

void makArchives::DtAggregateSettingsRecord::setDisplayLeafNodes

(

bool

enabled

)

Set the state flags for the various boolean settings.

bool makArchives::DtAggregateSettingsRecord::displayBoundingBoxesForSelected

(

)

const

Set the state flags for the various boolean settings.

void makArchives::DtAggregateSettingsRecord::setDisplayBoundingBoxesForSelected

(

bool

enabled

)

Set the state flags for the various boolean settings.

bool makArchives::DtAggregateSettingsRecord::initiallyDisplayExpanded

(

)

const

Set the state flags for the various boolean settings.

void makArchives::DtAggregateSettingsRecord::setInitiallyDisplayExpanded

(

bool

enabled

)

Set the state flags for the various boolean settings.

bool makArchives::DtAggregateSettingsRecord::allowSelectingOfGhostedItems

(

)

const

Set the state flags for the various boolean settings.

void makArchives::DtAggregateSettingsRecord::setAllowSelectingOfGhostedItems

(

bool

enabled

)

Set the state flags for the various boolean settings.

bool makArchives::DtAggregateSettingsRecord::displayMainIcon

(

)

const

Set the state flags for the various boolean settings.

void makArchives::DtAggregateSettingsRecord::setDisplayMainIcon

(

bool

enabled

)

Set the state flags for the various boolean settings.

unsigned char makArchives::DtAggregateSettingsRecord::colorizedModelColorType

(

)

const

Set the state flags for the various boolean settings.

void makArchives::DtAggregateSettingsRecord::setColorizedModelColorType

(

unsigned char

colorMode

)

Set the state flags for the various boolean settings.

void makArchives::DtAggregateSettingsRecord::setFlags ( int  f )

inline

Set the state flags for the various boolean settings.

int makArchives::DtAggregateSettingsRecord::flags ( ) const

inline

Get the state flags for the various boolean settings.

template<class Archive >

void makArchives::DtAggregateSettingsRecord::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

int makArchives::DtAggregateSettingsRecord::myFlags

protected

int makArchives::DtAggregateSettingsRecord::myEchelonLevel

protected

double makArchives::DtAggregateSettingsRecord::myGhostingTransparency

protected

unsigned char makArchives::DtAggregateSettingsRecord::myColorizedModelColorType

protected

---

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

• include/makArchives/DtAggregateSettingsRecord.h