makArchives::DtObserverStateRecord Class Reference

A DtObserverSettingsRecord contains the state of an observer. More...

Public Member Functions
	DtObserverStateRecord ()
	CTOR.
	DtObserverStateRecord (const DtObserverStateRecord &orig)
	Copy CTOR.
DtObserverStateRecord &	operator= (const DtObserverStateRecord &orig)
	Assignment OP.
	~DtObserverStateRecord ()
	DTOR.
Accessors/ mutators:
void	setObserverSettingsRecord (const DtObserverSettingsRecord &rec)
	Set magnification given to all 3D cameras controlled by this observer.
const DtObserverSettingsRecord &	observerSettingsRecord () const
	Set magnification given to all 3D cameras controlled by this observer.
void	setAttachedToDisplayNames (const std::set< std::string > &displayNames)
	Set magnification given to all 3D cameras controlled by this observer.
const std::set< std::string > &	attachedToDisplayNames () const
	Set magnification given to all 3D cameras controlled by this observer.
void	setSecondaryAttachedToDisplayNames (const std::set< std::string > &displayNames)
	Set magnification given to all 3D cameras controlled by this observer.
const std::set< std::string > &	secondaryAttachedToDisplayNames () const
	Set magnification given to all 3D cameras controlled by this observer.
void	getObserverOffsetVector (double &x, double &y, double &z) const
	Set magnification given to all 3D cameras controlled by this observer.
void	setObserverOffsetVector (double x, double y, double z)
	Set magnification given to all 3D cameras controlled by this observer.
void	getObserverRotationOffset (double &x, double &y, double &z, double &w) const
	Set magnification given to all 3D cameras controlled by this observer.
void	setObserverRotationOffset (double x, double y, double z, double w)
	Set magnification given to all 3D cameras controlled by this observer.
void	getPosition (double &x, double &y, double &z) const
	Set magnification given to all 3D cameras controlled by this observer.
void	setPosition (double x, double y, double z)
	Set magnification given to all 3D cameras controlled by this observer.
void	getOrientation (double &x, double &y, double &z, double &w) const
	Set magnification given to all 3D cameras controlled by this observer.
void	setOrientation (double x, double y, double z, double w)
	Set magnification given to all 3D cameras controlled by this observer.
void	setDisplayName (const std::string &)
	Set magnification given to all 3D cameras controlled by this observer.
const std::string &	displayName () const
	Set magnification given to all 3D cameras controlled by this observer.
void	setViewResolution (double resolution)
	Set magnification given to all 3D cameras controlled by this observer.
double	viewResolution () const
	Set magnification given to all 3D cameras controlled by this observer.
void	setViewMagnification (double magnification)
	Set magnification given to all 3D cameras controlled by this observer.
double	viewMagnification () const
	Get magnification given to all 3D cameras controlled by this observer.
void	setSetIntoObserver (bool)
	Set magnification given to all 3D cameras controlled by this observer.
bool	setIntoObserver () const
	Set magnification given to all 3D cameras controlled by this observer.
void	setPartAttachment (int partId)
	Set magnification given to all 3D cameras controlled by this observer.
int	partAttachment () const
	Set magnification given to all 3D cameras controlled by this observer.

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
DtObserverSettingsRecord	myObserverSettingsRecord
std::set< std::string >	myAttachedToDisplayNames
double	myObserverOffsetVectorX
double	myObserverOffsetVectorY
double	myObserverOffsetVectorZ
double	myObserverRotationOffsetX
double	myObserverRotationOffsetY
double	myObserverRotationOffsetZ
double	myObserverRotationOffsetW
double	myPosX
double	myPosY
double	myPosZ
double	myOrientationX
double	myOrientationY
double	myOrientationZ
double	myOrientationW
std::string	myDisplayName
double	myViewResolution
std::set< std::string >	mySecondaryAttachedToDisplayNames
int	myPartAttachment
double	myViewMagnification
bool	mySetIntoObserver
	Intentionally not archived into file.

Friends
class	boost::serialization::access

Detailed Description

A DtObserverSettingsRecord contains the state of an observer.

Constructor & Destructor Documentation

makArchives::DtObserverStateRecord::DtObserverStateRecord

(

)

CTOR.

makArchives::DtObserverStateRecord::DtObserverStateRecord

(

const DtObserverStateRecord &

orig

)

Copy CTOR.

makArchives::DtObserverStateRecord::~DtObserverStateRecord

(

)

DTOR.

Member Function Documentation

DtObserverStateRecord& makArchives::DtObserverStateRecord::operator=

(

const DtObserverStateRecord &

orig

)

Assignment OP.

void makArchives::DtObserverStateRecord::setObserverSettingsRecord

(

const DtObserverSettingsRecord &

rec

)

Set magnification given to all 3D cameras controlled by this observer.

const DtObserverSettingsRecord& makArchives::DtObserverStateRecord::observerSettingsRecord

(

)

const

Set magnification given to all 3D cameras controlled by this observer.

void makArchives::DtObserverStateRecord::setAttachedToDisplayNames

(

const std::set< std::string > &

displayNames

)

Set magnification given to all 3D cameras controlled by this observer.

const std::set<std::string>& makArchives::DtObserverStateRecord::attachedToDisplayNames

(

)

const

Set magnification given to all 3D cameras controlled by this observer.

void makArchives::DtObserverStateRecord::setSecondaryAttachedToDisplayNames

(

const std::set< std::string > &

displayNames

)

Set magnification given to all 3D cameras controlled by this observer.

const std::set<std::string>& makArchives::DtObserverStateRecord::secondaryAttachedToDisplayNames

(

)

const

Set magnification given to all 3D cameras controlled by this observer.

void makArchives::DtObserverStateRecord::getObserverOffsetVector	(	double &	x,
		double &	y,
		double &	z
	)		const

Set magnification given to all 3D cameras controlled by this observer.

void makArchives::DtObserverStateRecord::setObserverOffsetVector	(	double	x,
		double	y,
		double	z
	)

Set magnification given to all 3D cameras controlled by this observer.

void makArchives::DtObserverStateRecord::getObserverRotationOffset	(	double &	x,
		double &	y,
		double &	z,
		double &	w
	)		const

Set magnification given to all 3D cameras controlled by this observer.

void makArchives::DtObserverStateRecord::setObserverRotationOffset	(	double	x,
		double	y,
		double	z,
		double	w
	)

Set magnification given to all 3D cameras controlled by this observer.

void makArchives::DtObserverStateRecord::getPosition	(	double &	x,
		double &	y,
		double &	z
	)		const

Set magnification given to all 3D cameras controlled by this observer.

void makArchives::DtObserverStateRecord::setPosition	(	double	x,
		double	y,
		double	z
	)

Set magnification given to all 3D cameras controlled by this observer.

void makArchives::DtObserverStateRecord::getOrientation	(	double &	x,
		double &	y,
		double &	z,
		double &	w
	)		const

Set magnification given to all 3D cameras controlled by this observer.

void makArchives::DtObserverStateRecord::setOrientation	(	double	x,
		double	y,
		double	z,
		double	w
	)

Set magnification given to all 3D cameras controlled by this observer.

void makArchives::DtObserverStateRecord::setDisplayName

(

const std::string &

)

Set magnification given to all 3D cameras controlled by this observer.

const std::string& makArchives::DtObserverStateRecord::displayName

(

)

const

Set magnification given to all 3D cameras controlled by this observer.

void makArchives::DtObserverStateRecord::setViewResolution

(

double

resolution

)

Set magnification given to all 3D cameras controlled by this observer.

double makArchives::DtObserverStateRecord::viewResolution

(

)

const

Set magnification given to all 3D cameras controlled by this observer.

void makArchives::DtObserverStateRecord::setViewMagnification

(

double

magnification

)

Set magnification given to all 3D cameras controlled by this observer.

double makArchives::DtObserverStateRecord::viewMagnification

(

)

const

Get magnification given to all 3D cameras controlled by this observer.

void makArchives::DtObserverStateRecord::setSetIntoObserver

(

bool

)

Set magnification given to all 3D cameras controlled by this observer.

bool makArchives::DtObserverStateRecord::setIntoObserver

(

)

const

Set magnification given to all 3D cameras controlled by this observer.

void makArchives::DtObserverStateRecord::setPartAttachment

(

int

partId

)

Set magnification given to all 3D cameras controlled by this observer.

int makArchives::DtObserverStateRecord::partAttachment

(

)

const

Set magnification given to all 3D cameras controlled by this observer.

template<class Archive >

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

DtObserverSettingsRecord makArchives::DtObserverStateRecord::myObserverSettingsRecord

protected

std::set<std::string> makArchives::DtObserverStateRecord::myAttachedToDisplayNames

protected

double makArchives::DtObserverStateRecord::myObserverOffsetVectorX

protected

double makArchives::DtObserverStateRecord::myObserverOffsetVectorY

protected

double makArchives::DtObserverStateRecord::myObserverOffsetVectorZ

protected

double makArchives::DtObserverStateRecord::myObserverRotationOffsetX

protected

double makArchives::DtObserverStateRecord::myObserverRotationOffsetY

protected

double makArchives::DtObserverStateRecord::myObserverRotationOffsetZ

protected

double makArchives::DtObserverStateRecord::myObserverRotationOffsetW

protected

double makArchives::DtObserverStateRecord::myPosX

protected

double makArchives::DtObserverStateRecord::myPosY

protected

double makArchives::DtObserverStateRecord::myPosZ

protected

double makArchives::DtObserverStateRecord::myOrientationX

protected

double makArchives::DtObserverStateRecord::myOrientationY

protected

double makArchives::DtObserverStateRecord::myOrientationZ

protected

double makArchives::DtObserverStateRecord::myOrientationW

protected

std::string makArchives::DtObserverStateRecord::myDisplayName

protected

double makArchives::DtObserverStateRecord::myViewResolution

protected

std::set<std::string> makArchives::DtObserverStateRecord::mySecondaryAttachedToDisplayNames

protected

int makArchives::DtObserverStateRecord::myPartAttachment

protected

double makArchives::DtObserverStateRecord::myViewMagnification

protected

bool makArchives::DtObserverStateRecord::mySetIntoObserver

protected

Intentionally not archived into file.

This is used by the command line argument to determine whether or not this view should initially be set to an observer

---

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

• include/makArchives/DtObserverStateRecord.h