makVrv::DtProp Class Reference

Facade object for a scene prop. More...

Public Member Functions
	DtProp (DtDe &de, DtAgentManagerInterface &agentManagerInterface, const std::string &propType, const std::string &name)
	CTOR Construct a prop from a model definition.
	~DtProp ()
	DTOR.
void	destroy ()
	Delete the contents of the prop.
bool	operator== (const DtProp &prop) const
	Returns true IFF argument has same type and name.
bool	getRecord (makArchives::DtPropRecord &recOut) const
	Returns true if recOut was filled with all the information about this prop.
void	setFromRecord (const makArchives::DtPropRecord &rec)
	Fill out this prop from the record.
void	setColorFilter (float r, float g, float b, float a)
	Set the multipliers for the prop's color.
void	setVisible (bool isVisible)
	Set the prop visible or not.
void	setScribed (bool isSelected)
	Set the prop has a scribed bounding box.
bool	scribed () const
	Get if the prop has a scribed bounding box.
DtUniqueID	uniqueID () const
	Accessors.
void	getPosition (double &x, double &y, double &z) const
	Get the prop position.
void	setPosition (double x, double y, double z)
	Set the prop position in scene coordinates.
void	getOrientation (double &x, double &y, double &z, double &w) const
	Get the prop orientation.
void	setOrientation (double x, double y, double z, double w)
	Set the prop orientation.
const std::string &	propType () const
	Get type of prop (e.g. building, tree, ...)
void	setPropType (const std::string &proptype)
	Change the prop type of this prop.
const std::string &	modelDefinition () const
	Get the model definition.
void	setModelDefinition (const std::string &modelDefinition)
	Set the model definition of a prop.
void	setExternalNodeLocation (const std::string &searchExpression, unsigned int index)
	Set the location of the node moved to this prop from a terrain.
const std::string &	searchExp () const
	Get the expression used to find the prop.
unsigned int	searchIndex () const
	Get the index used to find the prop.
const std::string &	name () const
	Get the prop's name.
void	setName (const std::string &name)
	Set the props name.
bool	isVisible () const
const DtModelAgent *	model () const
	Get the prop's distributed model driver.
DtModelAgent *	model ()
	Get the prop's distributed model driver.
bool	operator!= (const DtProp &prop) const
	!= operator for props
float	red () const
	Get the current color filter components.
float	green () const
	Get the current color filter components.
float	blue () const
	Get the current color filter components.
float	alpha () const
	Get the current color filter components.
const DtSceneObjectAgent *	sceneObject () const
	Get the prop's distributed scene object driver.
DtSceneObjectAgent *	sceneObject ()
	Get the prop's distributed scene object driver.

Protected Member Functions
virtual void	selectionChanged (const DtSelectionManager::IdSet &selected, const DtSelectionManager::IdSet &deselected)

Protected Attributes
DtDe &	myDe
std::string	myPropType
DtSceneObjectAgent *	mySceneObject
DtModelAgent *	myObjectModel
DtScribeBoxModelAgent *	myScribeBoxModel
std::string	myModelDefinition
	The model definition.
std::string	mySearchExp
	The expression that was used to find the prop.
unsigned int	mySearchIndex
std::string	myName
	The prop's unique name.
bool	myIsVisible
	Whether the prop is visible.
float	myAlpha
	Color components.
float	myR
float	myG
float	myB
double	myPosX
	Position set by DtPropRecord on load.
double	myPosY
double	myPosZ
double	myOrientationX
double	myOrientationY
double	myOrientationZ
double	myOrientationW
bool	myIsTreeFlag
DtAgentManagerInterface &	myAgentManagerInterface

Private Member Functions
	DtProp (const DtProp &copy)
	Copy CTOR.
DtProp &	operator= (const DtProp &copy)
	Assignment operator.

Detailed Description

Facade object for a scene prop.

Constructor & Destructor Documentation

makVrv::DtProp::DtProp	(	DtDe &	de,
		DtAgentManagerInterface &	agentManagerInterface,
		const std::string &	propType,
		const std::string &	name
	)

CTOR Construct a prop from a model definition.

makVrv::DtProp::DtProp ( const DtProp &  copy )

private

Copy CTOR.

makVrv::DtProp::~DtProp

(

)

DTOR.

Member Function Documentation

DtProp& makVrv::DtProp::operator= ( const DtProp &  copy )

private

Assignment operator.

void makVrv::DtProp::destroy

(

)

Delete the contents of the prop.

bool makVrv::DtProp::operator==

(

const DtProp &

prop

)

const

Returns true IFF argument has same type and name.

bool makVrv::DtProp::getRecord

(

makArchives::DtPropRecord &

recOut

)

const

Returns true if recOut was filled with all the information about this prop.

void makVrv::DtProp::setFromRecord

(

const makArchives::DtPropRecord &

rec

)

Fill out this prop from the record.

void makVrv::DtProp::setColorFilter	(	float	r,
		float	g,
		float	b,
		float	a
	)

Set the multipliers for the prop's color.

void makVrv::DtProp::setVisible

(

bool

isVisible

)

Set the prop visible or not.

void makVrv::DtProp::setScribed

(

bool

isSelected

)

Set the prop has a scribed bounding box.

bool makVrv::DtProp::scribed

(

)

const

Get if the prop has a scribed bounding box.

DtUniqueID makVrv::DtProp::uniqueID

(

)

const

Accessors.

Get a unique id.

void makVrv::DtProp::getPosition	(	double &	x,
		double &	y,
		double &	z
	)		const

Get the prop position.

void makVrv::DtProp::setPosition	(	double	x,
		double	y,
		double	z
	)

Set the prop position in scene coordinates.

void makVrv::DtProp::getOrientation	(	double &	x,
		double &	y,
		double &	z,
		double &	w
	)		const

Get the prop orientation.

void makVrv::DtProp::setOrientation	(	double	x,
		double	y,
		double	z,
		double	w
	)

Set the prop orientation.

const std::string& makVrv::DtProp::propType

(

)

const

Get type of prop (e.g. building, tree, ...)

void makVrv::DtProp::setPropType

(

const std::string &

proptype

)

Change the prop type of this prop.

const std::string& makVrv::DtProp::modelDefinition

(

)

const

Get the model definition.

void makVrv::DtProp::setModelDefinition

(

const std::string &

modelDefinition

)

Set the model definition of a prop.

void makVrv::DtProp::setExternalNodeLocation	(	const std::string &	searchExpression,
		unsigned int	index
	)

Set the location of the node moved to this prop from a terrain.

const std::string& makVrv::DtProp::searchExp

(

)

const

Get the expression used to find the prop.

unsigned int makVrv::DtProp::searchIndex

(

)

const

Get the index used to find the prop.

float makVrv::DtProp::red

(

)

const

Get the current color filter components.

float makVrv::DtProp::green

(

)

const

Get the current color filter components.

float makVrv::DtProp::blue

(

)

const

Get the current color filter components.

float makVrv::DtProp::alpha

(

)

const

Get the current color filter components.

const std::string& makVrv::DtProp::name

(

)

const

Get the prop's name.

void makVrv::DtProp::setName

(

const std::string &

name

)

Set the props name.

bool makVrv::DtProp::isVisible

(

)

const

const DtSceneObjectAgent* makVrv::DtProp::sceneObject

(

)

const

Get the prop's distributed scene object driver.

DtSceneObjectAgent* makVrv::DtProp::sceneObject

(

)

Get the prop's distributed scene object driver.

const DtModelAgent* makVrv::DtProp::model

(

)

const

Get the prop's distributed model driver.

DtModelAgent* makVrv::DtProp::model

(

)

Get the prop's distributed model driver.

bool makVrv::DtProp::operator!=

(

const DtProp &

prop

)

const

!= operator for props

virtual void makVrv::DtProp::selectionChanged ( const DtSelectionManager::IdSet &  selected, const DtSelectionManager::IdSet &  deselected  )

protectedvirtual

Member Data Documentation

DtDe& makVrv::DtProp::myDe

protected

std::string makVrv::DtProp::myPropType

protected

DtSceneObjectAgent* makVrv::DtProp::mySceneObject

protected

DtModelAgent* makVrv::DtProp::myObjectModel

protected

DtScribeBoxModelAgent* makVrv::DtProp::myScribeBoxModel

protected

std::string makVrv::DtProp::myModelDefinition

protected

The model definition.

std::string makVrv::DtProp::mySearchExp

protected

The expression that was used to find the prop.

unsigned int makVrv::DtProp::mySearchIndex

protected

std::string makVrv::DtProp::myName

protected

The prop's unique name.

bool makVrv::DtProp::myIsVisible

protected

Whether the prop is visible.

float makVrv::DtProp::myAlpha

protected

Color components.

float makVrv::DtProp::myR

protected

float makVrv::DtProp::myG

protected

float makVrv::DtProp::myB

protected

double makVrv::DtProp::myPosX

protected

Position set by DtPropRecord on load.

Need because trees require a position when they are added. The scene object doesn't exist yet when the prop is created from the record. Therefore store the position that was loaded from the DtPropRecord.

double makVrv::DtProp::myPosY

protected

double makVrv::DtProp::myPosZ

protected

double makVrv::DtProp::myOrientationX

protected

double makVrv::DtProp::myOrientationY

protected

double makVrv::DtProp::myOrientationZ

protected

double makVrv::DtProp::myOrientationW

protected

bool makVrv::DtProp::myIsTreeFlag

protected

DtAgentManagerInterface& makVrv::DtProp::myAgentManagerInterface

protected

---

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

• include/vrvCore/DtProp.h