VR-Forces 4.5 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions
makVrv::DtDynamicTerrainIndex Class Reference

Interface provided to terrain feature's state change functions. More...

Public Types

typedef boost::function< void(const
DtDynamicTerrainChange &)> 
IterateRequestCallback

Public Member Functions

virtual ~DtDynamicTerrainIndex ()
 Virtual destructor.
virtual void iterateRequests (const IterateRequestCallback &callback) const =0
 Call the supplied callback on all the events.
virtual const
DtDynamicTerrainChange
firstChange () const =0
 Return the most recent event.
virtual bool addValue (const boost::shared_ptr< DtDynamicTerrainFeature::Link > &link, const DtString &key)=0
 Add a linked change request to this index.

Detailed Description

Interface provided to terrain feature's state change functions.

Provides a view into events which have applied to the terrain feature.

Member Typedef Documentation

Constructor & Destructor Documentation

virtual makVrv::DtDynamicTerrainIndex::~DtDynamicTerrainIndex ( )
virtual

Virtual destructor.

Member Function Documentation

virtual void makVrv::DtDynamicTerrainIndex::iterateRequests ( const IterateRequestCallback callback) const
pure virtual

Call the supplied callback on all the events.

Systems which can deform terrain in detailed ways can reconstruct any set of changes by finding the events they are capable of supporting and applying them in order.

virtual const DtDynamicTerrainChange* makVrv::DtDynamicTerrainIndex::firstChange ( ) const
pure virtual

Return the most recent event.

Many features only care about the latest event that applied to them (i.e are they in a damaged state?). If this function returns null then there are no events the feature should revert to its default state.

virtual bool makVrv::DtDynamicTerrainIndex::addValue ( const boost::shared_ptr< DtDynamicTerrainFeature::Link > &  link,
const DtString key 
)
pure virtual

Add a linked change request to this index.


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

Document ID: Generated on Thu Mar 23 18:54:12 EDT 2017 from SVN revision 174804
Copyright © 2005-2017 VT MÄK. All Rights Reserved (www.mak.com)