DtCulturalFeatureStateRepository Class Reference

Description: This repository holds all information that is common to all the forms of cultural feature objects within the system. More...

Inheritance diagram for DtCulturalFeatureStateRepository:

List of all members.

Public Member Functions
	DtCulturalFeatureStateRepository (DtVrfObject *vrfObject, const DtObjectType &objectType, DtVrfObjectParameters *parameters, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	constructor with parameters to set up read/writability correctly
	DtCulturalFeatureStateRepository (const DtCulturalFeatureStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtCulturalFeatureStateRepository &	operator= (const DtCulturalFeatureStateRepository &orig)
	assignment operator
virtual	~DtCulturalFeatureStateRepository ()
	destructor
virtual DtSimObjectStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
	Clone.
virtual bool	init ()
	Our 'virtual' constructor. Calls all the create<>() methods.
virtual DtString	type () const
virtual const int	vrfMovingObjectStateRepositorySubType () const
virtual const int	culturalFeatureStateRepositorySubType () const
virtual bool	createParameters ()
virtual void	initializeFromParameters ()
virtual const DtCulturalFeatureParameters *	culturalFeatureParameters () const
virtual bool	gravityAligned () const
	Returns whether or not the object is gravity aligned.
virtual void	setGravityAligned (bool)
virtual void	clampToGround (const DtVector &location, const DtReal heading, bool *dataAvailable=0)
	Place entity on ground at location and heading.
Static Public Member Functions
static DtVrfObjectStateRepository *	creator (const DtString &name, DtVrfObject *vrfObject, const DtObjectType &objectType, DtVrfObjectParameters *parameters, DtReaderWriterRegistry *parentRegistry)
static DtCulturalFeatureStateRepository *	isCulturalFeatureStateRepository (DtSimObjectStateRepository *repository)
static const DtCulturalFeatureStateRepository *	isCulturalFeatureStateRepository (const DtSimObjectStateRepository *repository)
Protected Member Functions
	DtCulturalFeatureStateRepository ()
	default constructor cannot be used
Protected Attributes
DtRwBoolean	myGravityAligned

---

Detailed Description

Description: This repository holds all information that is common to all the forms of cultural feature objects within the system.

---

Constructor & Destructor Documentation

DtCulturalFeatureStateRepository::DtCulturalFeatureStateRepository

(

)

[protected]

default constructor cannot be used

DtCulturalFeatureStateRepository::DtCulturalFeatureStateRepository	(	DtVrfObject *	vrfObject,
		const DtObjectType &	objectType,
		DtVrfObjectParameters *	parameters,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor with parameters to set up read/writability correctly

DtCulturalFeatureStateRepository::DtCulturalFeatureStateRepository	(	const DtCulturalFeatureStateRepository &	orig,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtCulturalFeatureStateRepository::~DtCulturalFeatureStateRepository

(

)

[virtual]

destructor

---

Member Function Documentation

const DtCulturalFeatureStateRepository& DtCulturalFeatureStateRepository::operator=

(

const DtCulturalFeatureStateRepository &

orig

)

assignment operator

virtual DtSimObjectStateRepository* DtCulturalFeatureStateRepository::clone	(	const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)		const [virtual]

Clone.

Reimplemented from DtVrfMovingObjectStateRepository.

virtual bool DtCulturalFeatureStateRepository::init

(

)

[virtual]

Our 'virtual' constructor. Calls all the create<>() methods.

Reimplemented from DtVrfObjectStateRepository.

virtual DtString DtCulturalFeatureStateRepository::type

(

)

const [virtual]

Returns:

The string type of the repository, as defined in vrfSRTypes.h.

Reimplemented from DtVrfMovingObjectStateRepository.

virtual const int DtCulturalFeatureStateRepository::vrfMovingObjectStateRepositorySubType

(

)

const [virtual]

Returns:

DtVrfMovingObjectStateRepositorySubTypeCultural.

Reimplemented from DtVrfMovingObjectStateRepository.

virtual const int DtCulturalFeatureStateRepository::culturalFeatureStateRepositorySubType

(

)

const [virtual]

Returns:

DtCulturalFeatureStateRepositorySubTypeBase.

virtual bool DtCulturalFeatureStateRepository::createParameters

(

)

[virtual]

Reimplemented from DtVrfMovingObjectStateRepository.

virtual void DtCulturalFeatureStateRepository::initializeFromParameters

(

)

[virtual]

Reimplemented from DtVrfMovingObjectStateRepository.

virtual const DtCulturalFeatureParameters* DtCulturalFeatureStateRepository::culturalFeatureParameters

(

)

const [virtual]

static DtVrfObjectStateRepository* DtCulturalFeatureStateRepository::creator	(	const DtString &	name,
		DtVrfObject *	vrfObject,
		const DtObjectType &	objectType,
		DtVrfObjectParameters *	parameters,
		DtReaderWriterRegistry *	parentRegistry
	)		[static]

Reimplemented from DtVrfMovingObjectStateRepository.

static DtCulturalFeatureStateRepository* DtCulturalFeatureStateRepository::isCulturalFeatureStateRepository

(

DtSimObjectStateRepository *

repository

)

[static]

Returns:

A the pointer the repository, if the repository passed in is of type DtCulturalFeatureStateRepository, 0 if not.

static const DtCulturalFeatureStateRepository* DtCulturalFeatureStateRepository::isCulturalFeatureStateRepository

(

const DtSimObjectStateRepository *

repository

)

[static]

virtual bool DtCulturalFeatureStateRepository::gravityAligned

(

)

const [virtual]

Returns whether or not the object is gravity aligned.

If an object is gravity aligned it does not clamp to the ground on place, else it does

virtual void DtCulturalFeatureStateRepository::setGravityAligned

(

bool

)

[virtual]

virtual void DtCulturalFeatureStateRepository::clampToGround	(	const DtVector &	location,
		const DtReal	heading,
		bool *	dataAvailable = 0
	)		[virtual]

Place entity on ground at location and heading.

Calls down to DtVrfMovingObjectStateRepository::clampToGround using myGravityAligned.

Parameters:

Output
dataAvailable	prevents the call from blocking due to terrain paging and will get a true value if the terrain intersections are successful. See DtVrfMovingObjectStateRepository::clampToGround for more information.

---

Member Data Documentation

DtRwBoolean DtCulturalFeatureStateRepository::myGravityAligned [protected]

---

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

• include/vrfobjcore/culturalFeatureSR.h