dtHLAGM::DDMRegionData Class Reference

An abstract class that will be extended by DDMRegionCalculator implementations to store object instance data used when updating the region for a given object. More...

#include <ddmregiondata.h>

Inheritance diagram for dtHLAGM::DDMRegionData:

dtHLAGM::DDMGeographicRegionData

List of all members.

Public Member Functions

 DDMRegionData ()
void SetRegion (RTI::Region *region)
 Sets the region associated with this data class.
RTI::Region * GetRegion ()
 
Returns:
the region this data object supports.

const RTI::Region * GetRegion () const
 
Returns:
the region this data object supports.

unsigned GetNumberOfExtents () const
 
Returns:
the number of dimensions/extents for this class.

void SetDimensionValue (unsigned extent, const DimensionValues &dimVal)
const DimensionValuesGetDimensionValue (unsigned extent) const
void ClearDimensions ()

Protected Member Functions

virtual ~DDMRegionData ()

Classes

class  DimensionValues


Detailed Description

An abstract class that will be extended by DDMRegionCalculator implementations to store object instance data used when updating the region for a given object.

This abstract exists because calculating the region uses data in attributes that may not be updated every time an update message is received, but the values are required to update the region.

This class is not referenced because the region this class holds onto must be manually deleted by the rti ambassador. At that point the instance is no longer valid and should be deleted itself. Since deletion can't be guaranteed with a refptr, is not referenced.


Constructor & Destructor Documentation

dtHLAGM::DDMRegionData::DDMRegionData (  )  [inline]

virtual dtHLAGM::DDMRegionData::~DDMRegionData (  )  [inline, protected, virtual]


Member Function Documentation

void dtHLAGM::DDMRegionData::SetRegion ( RTI::Region *  region  )  [inline]

Sets the region associated with this data class.

RTI::Region* dtHLAGM::DDMRegionData::GetRegion (  )  [inline]

Returns:
the region this data object supports.

const RTI::Region* dtHLAGM::DDMRegionData::GetRegion (  )  const [inline]

Returns:
the region this data object supports.

unsigned dtHLAGM::DDMRegionData::GetNumberOfExtents (  )  const [inline]

Returns:
the number of dimensions/extents for this class.

void dtHLAGM::DDMRegionData::SetDimensionValue ( unsigned  extent,
const DimensionValues dimVal 
)

const DDMRegionData::DimensionValues * dtHLAGM::DDMRegionData::GetDimensionValue ( unsigned  extent  )  const

void dtHLAGM::DDMRegionData::ClearDimensions (  )  [inline]


http://www.delta3d.org
2.0.0 generated 14 Feb 2008