Kaim::GenFlags Namespace Reference

Kaim::GenFlags Namespace Reference

Namespace description

This namespace contains enumeration values used to configure the NavData generation process.

Enumerations

enum  SectorChange { SECTOR_CHANGED = 0, SECTOR_NOCHANGE = 1, SECTOR_REMOVED = 2 }
 
enum  SectorColDataBuildMode { SECTOR_COLDATA_BUILD_ENABLED, SECTOR_COLDATA_BUILD_DISABLED }
 
enum  SectorInputSource { INPUTSOURCE_PRODUCER_WHEN_CHANGED = 0, INPUTSOURCE_PRODUCER = 1, INPUTSOURCE_CLIENTINPUT = 2 }
 

Enumeration Type Documentation

Describes what the generation does about a sector.

SECTOR_NOCHANGE and SECTOR_REMOVED are relevant only in iterative generations, i.e. when a generation uses a previous result to re-generate only minimal NavData depending on the changes.

Enumerator
SECTOR_CHANGED 

Load the Sector inputs, generate the Sector NavData or impact the NavDataPatch.

SECTOR_NOCHANGE 

May load the Sector inputs (if required by other CHANGED Sectors), does NOT generate any NavData or NavDataPatch related to this sector.

SECTOR_REMOVED 

Read previous imprint of the Sector, the difference is included in the generated NavDataPatch.

Describes whether or not CollisionData should be saved on a per-sector basis.

Enumerator
SECTOR_COLDATA_BUILD_ENABLED 

The Collision Data will be generated for this sector.

SECTOR_COLDATA_BUILD_DISABLED 

(default) The Collision Data will NOT be generated for this sector

Describes where the Generator will get its input for each sector.

Enumerator
INPUTSOURCE_PRODUCER_WHEN_CHANGED 

(default) To get the input of the sector, GeneratorInputProducer is called if SECTOR_CHANGED is set, ClientInput is loaded otherwise

INPUTSOURCE_PRODUCER 

GeneratorInputProducer is called to get the input of the sector.

INPUTSOURCE_CLIENTINPUT 

ClientInput is loaded to get the input of the sector.