Kaim::GeneratorInputProducer Class Reference

#include <generatorinputproducer.h>

Class Description

The GeneratorInputProducer is an abstract base class for an object invoked by the NavData generation system to retrieve the geometry for which it should generate NavData.

This class cannot be used as-is; you must create your own class that derives from GeneratorInputProducer, and implement the Produce() method. You pass an instance of this class to the Generator for each sector or multi-sector that you want to create. Therefore, each object that derives from this class is typically responsible for handling a single sector chunk of the geometry in your terrain.

Examples:

Inherits Kaim::RefCountBaseNTS< C, Stat >.

Inherited by Kaim::ObjFileInputProducer, and LabEngine::MirroredOBJProducer.

Public Member Functions
	GeneratorInputProducer ()
	Constructor for objects of this class. More...
KyResult	ProduceSectorInputs (const GeneratorSector &sector, ClientInputConsumer &sectorInputConsumer)
	Called by the NavData generation system to retrieve the geometry all the input associated with this sector. More...

Private Member Functions
virtual KyResult	Produce (const GeneratorSector &sector, ClientInputConsumer &sectorInputConsumer)=0
	Called by the NavData generation system to retrieve the geometry associated to the sector. More...

Constructor & Destructor Documentation

Kaim::GeneratorInputProducer::GeneratorInputProducer ( )

inline

Constructor for objects of this class.

It should not be necessary to use this constructor directly in your own code. However, if you write a class that derives directly from this class, you may need to call this constructor from within the constructor of your derived class.

Member Function Documentation

virtual KyResult Kaim::GeneratorInputProducer::Produce ( const GeneratorSector &  sector, ClientInputConsumer &  sectorInputConsumer  )

privatepure virtual

Called by the NavData generation system to retrieve the geometry associated to the sector.

Your implementation of this method must call sectorInputConsumer.ConsumeXXX() for triangles and NavTags, TagVolumes, and SeedPoints contained in your sector. For TagVolumes and SeedPoints, one alternative is to use sector.m_additionalTagVolumes and sector.m_additionalSeedPoints

Implemented in LabEngine::MirroredOBJProducer, and Kaim::ObjFileInputProducer.

Examples:

KyResult Kaim::GeneratorInputProducer::ProduceSectorInputs ( const GeneratorSector &  sector, ClientInputConsumer &  sectorInputConsumer  )

inline

Called by the NavData generation system to retrieve the geometry all the input associated with this sector.

Consume sector.m_inputTagVolumes and sector.m_inputSeedPoints before calling Produce().

---

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

• gwnavgeneration/input/generatorinputproducer.h