makVrv::DtDynamicTerrainIndex Class Reference

Interface provided to terrain feature's state change functions.

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

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

Public Member Functions
virtual	~DtDynamicTerrainIndex ()
virtual void	iterateRequests (const IterateRequestCallback &callback) const =0
virtual const DtDynamicTerrainChange *	firstChange () const =0
virtual int	size () const =0
virtual bool	addValue (const std::shared_ptr< DtDynamicTerrainFeature::Link > &link, const DtString &key)=0

Member Typedef Documentation

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

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 int makVrv::DtDynamicTerrainIndex::size ( ) const

pure virtual

Returns the total number of events in the change list.

virtual bool makVrv::DtDynamicTerrainIndex::addValue ( const std::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:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrvUtil/DtDynamicTerrainFeature.h