dtHLAGM::DDMCalculatorGeographic Class Reference

#include <ddmcalculatorgeographic.h>

Inheritance diagram for dtHLAGM::DDMCalculatorGeographic:

List of all members.

Public Types
typedef dtHLAGM::DDMAppSpaceCalculator	BaseClass
Public Member Functions
	DDMCalculatorGeographic ()
virtual dtCore::RefPtr < DDMRegionData >	CreateRegionData () const
	Creates and returns a pointer to a region data object for this calculator.
virtual void	CreateSubscriptionRegionData (std::vector< dtCore::RefPtr< DDMRegionData > > &toFill) const
	Creates and returns a pointer to a region data object for this calculator.
virtual bool	UpdateRegionData (DDMRegionData &ddmData) const
	Updates the subscription region.
void	SetCoordinateConverter (const dtUtil::Coordinates &coord)
dtUtil::Coordinates &	GetCoordinateConverter ()
const dtUtil::Coordinates &	GetCoordinateConverter () const
DDMObjectKind &	GetCalculatorObjectKind () const
void	SetCalculatorObjectKind (DDMObjectKind &newKind)
RegionCalculationType &	GetFriendlyRegionType () const
void	SetFriendlyRegionType (RegionCalculationType &newType)
RegionCalculationType &	GetEnemyRegionType () const
void	SetEnemyRegionType (RegionCalculationType &newType)
RegionCalculationType &	GetNeutralRegionType () const
void	SetNeutralRegionType (RegionCalculationType &newType)
RegionCalculationType &	GetDefaultRegionType () const
void	SetDefaultRegionType (RegionCalculationType &newType)
long	GetFriendlyAppSpace () const
void	SetFriendlyAppSpace (long newSpace)
long	GetEnemyAppSpace () const
void	SetEnemyAppSpace (long newSpace)
long	GetNeutralAppSpace () const
void	SetNeutralAppSpace (long newSpace)
std::pair < RegionCalculationType *, long >	GetAppSpaceValues (DDMForce &force, DDMObjectKind &kind) const
Static Public Attributes
static const std::string	PROP_CALCULATOR_OBJECT_KIND
static const std::string	PROP_FRIENDLY_REGION_TYPE
static const std::string	PROP_ENEMY_REGION_TYPE
static const std::string	PROP_NEUTRAL_REGION_TYPE
static const std::string	PROP_DEFAULT_REGION_TYPE
static const std::string	PROP_FRIENDLY_APPSPACE
static const std::string	PROP_ENEMY_APPSPACE
static const std::string	PROP_NEUTRAL_APPSPACE
Protected Member Functions
virtual	~DDMCalculatorGeographic ()
Protected Attributes
DDMObjectKind *	mCalculatorObjectKind
RegionCalculationType *	mFriendlyRegionType
RegionCalculationType *	mEnemyRegionType
RegionCalculationType *	mNeutralRegionType
RegionCalculationType *	mDefaultRegionType
long	mFriendlyAppSpace
long	mEnemyAppSpace
long	mNeutralAppSpace
dtUtil::Coordinates	mCoordinates
Classes
class	DDMForce
class	DDMObjectKind
class	RegionCalculationType

---

Member Typedef Documentation

typedef dtHLAGM::DDMAppSpaceCalculator dtHLAGM::DDMCalculatorGeographic::BaseClass

Reimplemented in dtHLAGM::DDMCameraCalculatorGeographic.

---

Constructor & Destructor Documentation

dtHLAGM::DDMCalculatorGeographic::DDMCalculatorGeographic

(

)

dtHLAGM::DDMCalculatorGeographic::~DDMCalculatorGeographic

(

)

[protected, virtual]

---

Member Function Documentation

dtCore::RefPtr< DDMRegionData > dtHLAGM::DDMCalculatorGeographic::CreateRegionData

(

)

const [virtual]

Creates and returns a pointer to a region data object for this calculator.

This is basically a factory method. This will be called on the calculator when it is creating regions for published entities.

Returns:

the new region data object.

Implements dtHLAGM::DDMRegionCalculator.

void dtHLAGM::DDMCalculatorGeographic::CreateSubscriptionRegionData

(

std::vector< dtCore::RefPtr< DDMRegionData > > &

toFill

)

const [virtual]

Creates and returns a pointer to a region data object for this calculator.

This is basically a factory method. This will be called on the calculator when it is creating regions for subscription. The calculator may handle multiple regions, so it will fill a vector.

Implements dtHLAGM::DDMRegionCalculator.

bool dtHLAGM::DDMCalculatorGeographic::UpdateRegionData

(

DDMRegionData &

ddmData

)

const [virtual]

Updates the subscription region.

Parameters:

region

the region to update.

Implements dtHLAGM::DDMRegionCalculator.

Reimplemented in dtHLAGM::DDMCameraCalculatorGeographic.

void dtHLAGM::DDMCalculatorGeographic::SetCoordinateConverter

(

const dtUtil::Coordinates &

coord

)

dtUtil::Coordinates& dtHLAGM::DDMCalculatorGeographic::GetCoordinateConverter

(

)

[inline]

const dtUtil::Coordinates& dtHLAGM::DDMCalculatorGeographic::GetCoordinateConverter

(

)

const [inline]

DDMObjectKind& dtHLAGM::DDMCalculatorGeographic::GetCalculatorObjectKind

(

)

const [inline]

void dtHLAGM::DDMCalculatorGeographic::SetCalculatorObjectKind

(

DDMObjectKind &

newKind

)

[inline]

RegionCalculationType& dtHLAGM::DDMCalculatorGeographic::GetFriendlyRegionType

(

)

const [inline]

void dtHLAGM::DDMCalculatorGeographic::SetFriendlyRegionType

(

RegionCalculationType &

newType

)

[inline]

RegionCalculationType& dtHLAGM::DDMCalculatorGeographic::GetEnemyRegionType

(

)

const [inline]

void dtHLAGM::DDMCalculatorGeographic::SetEnemyRegionType

(

RegionCalculationType &

newType

)

[inline]

RegionCalculationType& dtHLAGM::DDMCalculatorGeographic::GetNeutralRegionType

(

)

const [inline]

void dtHLAGM::DDMCalculatorGeographic::SetNeutralRegionType

(

RegionCalculationType &

newType

)

[inline]

RegionCalculationType& dtHLAGM::DDMCalculatorGeographic::GetDefaultRegionType

(

)

const [inline]

void dtHLAGM::DDMCalculatorGeographic::SetDefaultRegionType

(

RegionCalculationType &

newType

)

[inline]

long dtHLAGM::DDMCalculatorGeographic::GetFriendlyAppSpace

(

)

const [inline]

void dtHLAGM::DDMCalculatorGeographic::SetFriendlyAppSpace

(

long

newSpace

)

[inline]

long dtHLAGM::DDMCalculatorGeographic::GetEnemyAppSpace

(

)

const [inline]

void dtHLAGM::DDMCalculatorGeographic::SetEnemyAppSpace

(

long

newSpace

)

[inline]

long dtHLAGM::DDMCalculatorGeographic::GetNeutralAppSpace

(

)

const [inline]

void dtHLAGM::DDMCalculatorGeographic::SetNeutralAppSpace

(

long

newSpace

)

[inline]

std::pair< DDMCalculatorGeographic::RegionCalculationType *, long > dtHLAGM::DDMCalculatorGeographic::GetAppSpaceValues	(	DDMCalculatorGeographic::DDMForce &	force,
		DDMCalculatorGeographic::DDMObjectKind &	kind
	)			const

---

Member Data Documentation

const std::string dtHLAGM::DDMCalculatorGeographic::PROP_CALCULATOR_OBJECT_KIND [static]

const std::string dtHLAGM::DDMCalculatorGeographic::PROP_FRIENDLY_REGION_TYPE [static]

const std::string dtHLAGM::DDMCalculatorGeographic::PROP_ENEMY_REGION_TYPE [static]

const std::string dtHLAGM::DDMCalculatorGeographic::PROP_NEUTRAL_REGION_TYPE [static]

const std::string dtHLAGM::DDMCalculatorGeographic::PROP_DEFAULT_REGION_TYPE [static]

const std::string dtHLAGM::DDMCalculatorGeographic::PROP_FRIENDLY_APPSPACE [static]

const std::string dtHLAGM::DDMCalculatorGeographic::PROP_ENEMY_APPSPACE [static]

const std::string dtHLAGM::DDMCalculatorGeographic::PROP_NEUTRAL_APPSPACE [static]

DDMObjectKind* dtHLAGM::DDMCalculatorGeographic::mCalculatorObjectKind [protected]

RegionCalculationType* dtHLAGM::DDMCalculatorGeographic::mFriendlyRegionType [protected]

RegionCalculationType* dtHLAGM::DDMCalculatorGeographic::mEnemyRegionType [protected]

RegionCalculationType* dtHLAGM::DDMCalculatorGeographic::mNeutralRegionType [protected]

RegionCalculationType* dtHLAGM::DDMCalculatorGeographic::mDefaultRegionType [protected]

long dtHLAGM::DDMCalculatorGeographic::mFriendlyAppSpace [protected]

long dtHLAGM::DDMCalculatorGeographic::mEnemyAppSpace [protected]

long dtHLAGM::DDMCalculatorGeographic::mNeutralAppSpace [protected]

dtUtil::Coordinates dtHLAGM::DDMCalculatorGeographic::mCoordinates [mutable, protected]

---