 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
class DtScenarioExplorer: More...
Public Member Functions | |
| DtScenarioExplorer () | |
| default constructor | |
| DtScenarioExplorer (const DtScenario &scenario) | |
| real constructor | |
| virtual | ~DtScenarioExplorer () |
| destructor | |
| DtScenarioExplorer (const DtScenarioExplorer &orig) | |
| copy constructor | |
| DtScenarioExplorer & | operator= (const DtScenarioExplorer &orig) |
| assignment operator | |
| virtual bool | init () |
| Initialization. Must be called before any other functions are called. | |
| virtual bool | readScenarioFile (const DtFilename &filename) |
| Read itself from file. | |
| virtual DtFilename | terrainDatabaseFilename () const |
| Get the terrain database filename. | |
| virtual DtFilename | componentAttachmentTableFilename () const |
| Get the component attachment table filename. | |
| virtual DtFilename | orderOfBattleFilename () const |
| Get the order of battle filename. | |
| virtual DtFilename | planFilename () const |
| Get the plan filename. | |
| virtual DtFilename | parameterDatabaseFilename () const |
| Get the parameter database filename. | |
| virtual DtFilename | forceHostilityFilename () const |
| virtual DtFilename | scenarioExtrasFilename () const |
| virtual const std::vector < DtFilename > & | physicalWorldFilenames () const |
| Get the physical world settings files. | |
| virtual const std::vector < DtFilename > & | indirectArtilleryTypesFilenames () const |
| Get the indirect artillery types files. | |
| virtual const std::vector < DtFilename > & | commModelFilenames () const |
| Get the comm model settings files. | |
| virtual DtFilename | objectMapFilename () const |
| Get the object map filename. | |
| virtual DtReal | timeMultiplier () const |
| Get the time multiplier. | |
| virtual bool | autoReorganize () const |
| Get the auto reorganize flag. | |
| virtual unsigned | randomNumberSeed () const |
| Get the random number seed. | |
| virtual DtString | frameRateModeString () const |
| Get frame rate mode. | |
| virtual DtFrameMode | frameRateMode () const |
| virtual DtReal | frameDeltaTime () const |
| Get frame delta time. | |
| virtual DtTime | runDurationTime () |
| Get the run duration time. | |
| virtual DtTime | simTime () const |
| Get simulation time. | |
| virtual DtTime | exerciseStartTime () const |
| Get exercise start time. | |
| virtual DtFilename | filename () const |
| virtual bool | isValid (bool allowEmptyFilenames=true) const |
| Returns true if all information necessary to load the scenario is present. | |
| virtual double | version () const |
| The version of the scenario file. | |
| virtual void | processModelSets () |
| Processes all the model sets found in the myScenario object. | |
| virtual void | loadCoreModelSets () |
| Loads the "core" model sets, which are the ones automatically loaded before any others, if they exist in the directory structure. | |
| virtual const std::vector < DtFilename > & | modelSetForceFilenames () const |
| virtual void | gatherSymbolMapInforation () |
| This routine will see what the current symbol map selection is i the scenario and select the appropriate files. | |
| virtual DtString | symbolMapName (const DtString &symbolMap) const |
| Given the symbol map, return a name (if it is a file, it will return closest match). | |
| virtual void | addFilename (std::vector< DtFilename > &, const DtFilename &map) const |
| virtual void | setSymbolMapName (const DtString &) |
| Sets symbol map filename and resets symbol map into. Also sets value into myScenario. | |
| virtual std::vector< DtFilename > | symbolMapsFor (const DtString &symbolMap, bool includeOverlay=true) const |
| Returns a list of symbol map files given the symbol map name. | |
| DtScenario * | scenario () const |
| Returns scenario associated with explorer. | |
| virtual DtFilename | globalPlanFilename () const |
| Get the global plan filename. | |
| virtual const std::vector < DtFilename > & | additionalOpdFilenames () const |
| Additional OPD files that will be appended (in the order specified) to the main OPD file for this scenario. | |
| virtual DtRwNLengthStringVector | simulationModelSetFilenames () |
| Simulation model set files that want to be loaded for this scenario. | |
| virtual const std::vector < DtFilename > & | symbolMapFilenames () const |
| The following methods are used for the front-end only. | |
| virtual std::vector< DtString > | symbolMapLabels () const |
| Returns a unique list of all labels in the symbol map list. | |
| virtual const std::vector < DtFilename > & | createMenuFilenames () const |
| Returns a list of all (unique) create menu names that should be loaded in support of this scenario. | |
| virtual const std::vector < DtFilename > & | threeDSymbolMaps () const |
| Returns a list of all (unique) 3D symbol map names that should be loaded in support of this scenario. | |
| virtual const std::vector < DtFilename > & | overlayMenuFilenames () const |
| Returns a list of all (unique) overlay menu names that should be loaded in support of this scenario. | |
| std::vector < DtSimulationModelSet * > & | modelSets () |
| return the array of DtSimulationModelSet pointers. | |
| const std::vector < DtSimulationModelSet * > & | modelSets () const |
| return the array of DtSimulationModelSet pointers. | |
| virtual const std::vector < DtFilename > & | modelSetFilenames () const |
| Returns a list of all (unique) model set palette names that should be loaded in support of this scenario. | |
Protected Member Functions | |
| virtual void | clearModelSets () |
| virtual void | mergeAdditionalOpdFiles () |
| virtual void | processModelSet (DtSimulationModelSet *) |
Protected Attributes | |
| DtScenario * | myScenario |
| DtFilename | myParameterDatabaseFilename |
| DtFilename | myForceHostilityFilename |
| DtFilename | myScenarioExtrasFilename |
| std::vector < DtSimulationModelSet * > | myModelSets |
| std::vector< DtFilename > | myPhysicalWorldFilenames |
| std::vector< DtFilename > | myIndirectArtilleryTypesFilenames |
| std::vector< DtFilename > | myAdditionalOpdFilenames |
| std::vector< DtFilename > | myCommModelFilenames |
| std::vector< DtFilename > | mySymbolMapFilenames |
| The following member variables are used in the front-end only. | |
| std::vector< DtFilename > | myCreateMenuFilenames |
| std::vector< DtFilename > | my3DSymbolMapFilenames |
| std::vector< DtFilename > | myOverlayMenuFilenames |
| std::vector< DtFilename > | myModelSetForceFilenames |
| std::vector< DtFilename > | myModelSetFilenames |
class DtScenarioExplorer:
The DtScenarioExplorer class will inspect a scenario for any simulation model set files. If any exist, it will load the files and then present the user, through the interface, the files that are contained within those model set files
default constructor
| DtScenarioExplorer::DtScenarioExplorer | ( | const DtScenario & | scenario | ) |
real constructor
| virtual DtScenarioExplorer::~DtScenarioExplorer | ( | ) | [virtual] |
destructor
| DtScenarioExplorer::DtScenarioExplorer | ( | const DtScenarioExplorer & | orig | ) |
copy constructor
| DtScenarioExplorer& DtScenarioExplorer::operator= | ( | const DtScenarioExplorer & | orig | ) |
assignment operator
| virtual bool DtScenarioExplorer::init | ( | ) | [virtual] |
Initialization. Must be called before any other functions are called.
This method will read in all simulation model sets and place the results into the mySimulationModelSets array. All methods that are affected by the results of this read are marked above. This method will be called from those methods that use it if the model sets have not already been read
| virtual bool DtScenarioExplorer::readScenarioFile | ( | const DtFilename & | filename | ) | [virtual] |
Read itself from file.
| virtual DtFilename DtScenarioExplorer::terrainDatabaseFilename | ( | ) | const [virtual] |
Get the terrain database filename.
This is terrain database used by the backend and Gui (unless a different Gui terrain database is specified).
| virtual DtFilename DtScenarioExplorer::componentAttachmentTableFilename | ( | ) | const [virtual] |
Get the component attachment table filename.
| virtual DtFilename DtScenarioExplorer::orderOfBattleFilename | ( | ) | const [virtual] |
Get the order of battle filename.
| virtual DtFilename DtScenarioExplorer::planFilename | ( | ) | const [virtual] |
Get the plan filename.
| virtual DtFilename DtScenarioExplorer::globalPlanFilename | ( | ) | const [virtual] |
Get the global plan filename.
| virtual DtFilename DtScenarioExplorer::parameterDatabaseFilename | ( | ) | const [virtual] |
Get the parameter database filename.
| virtual DtFilename DtScenarioExplorer::forceHostilityFilename | ( | ) | const [virtual] |
| virtual DtFilename DtScenarioExplorer::scenarioExtrasFilename | ( | ) | const [virtual] |
| virtual const std::vector<DtFilename>& DtScenarioExplorer::physicalWorldFilenames | ( | ) | const [virtual] |
Get the physical world settings files.
| virtual const std::vector<DtFilename>& DtScenarioExplorer::indirectArtilleryTypesFilenames | ( | ) | const [virtual] |
Get the indirect artillery types files.
| virtual const std::vector<DtFilename>& DtScenarioExplorer::commModelFilenames | ( | ) | const [virtual] |
Get the comm model settings files.
| virtual DtFilename DtScenarioExplorer::objectMapFilename | ( | ) | const [virtual] |
Get the object map filename.
| virtual DtReal DtScenarioExplorer::timeMultiplier | ( | ) | const [virtual] |
Get the time multiplier.
| virtual bool DtScenarioExplorer::autoReorganize | ( | ) | const [virtual] |
Get the auto reorganize flag.
| virtual unsigned DtScenarioExplorer::randomNumberSeed | ( | ) | const [virtual] |
Get the random number seed.
| virtual DtString DtScenarioExplorer::frameRateModeString | ( | ) | const [virtual] |
Get frame rate mode.
| virtual DtFrameMode DtScenarioExplorer::frameRateMode | ( | ) | const [virtual] |
| virtual DtReal DtScenarioExplorer::frameDeltaTime | ( | ) | const [virtual] |
Get frame delta time.
| virtual DtTime DtScenarioExplorer::runDurationTime | ( | ) | [virtual] |
Get the run duration time.
By default, the run duration time is set to -1 (run indefinitely).
| virtual DtTime DtScenarioExplorer::simTime | ( | ) | const [virtual] |
Get simulation time.
| virtual DtTime DtScenarioExplorer::exerciseStartTime | ( | ) | const [virtual] |
Get exercise start time.
| virtual const std::vector<DtFilename>& DtScenarioExplorer::additionalOpdFilenames | ( | ) | const [virtual] |
Additional OPD files that will be appended (in the order specified) to the main OPD file for this scenario.
| virtual DtRwNLengthStringVector DtScenarioExplorer::simulationModelSetFilenames | ( | ) | [virtual] |
Simulation model set files that want to be loaded for this scenario.
Note that the first file will be considered the "master" file. All others will merge into the "master" (subsequent model set files that contain .opd files will be considered "additional .opds")
| virtual DtFilename DtScenarioExplorer::filename | ( | ) | const [virtual] |
| virtual bool DtScenarioExplorer::isValid | ( | bool | allowEmptyFilenames = true | ) | const [virtual] |
Returns true if all information necessary to load the scenario is present.
If allowEmptyFilenames is false, do not allow empty filenames for order of battle or plan
| virtual double DtScenarioExplorer::version | ( | ) | const [virtual] |
The version of the scenario file.
| virtual void DtScenarioExplorer::processModelSets | ( | ) | [virtual] |
Processes all the model sets found in the myScenario object.
| virtual void DtScenarioExplorer::loadCoreModelSets | ( | ) | [virtual] |
Loads the "core" model sets, which are the ones automatically loaded before any others, if they exist in the directory structure.
| virtual const std::vector<DtFilename>& DtScenarioExplorer::symbolMapFilenames | ( | ) | const [virtual] |
The following methods are used for the front-end only.
Given a symbol map file from a scenario, map that entry to all possible symbol map files that could be loaded in support of it. If the scenario contains no symbol map files, then this will be empty
| virtual std::vector<DtString> DtScenarioExplorer::symbolMapLabels | ( | ) | const [virtual] |
Returns a unique list of all labels in the symbol map list.
| virtual const std::vector<DtFilename>& DtScenarioExplorer::createMenuFilenames | ( | ) | const [virtual] |
Returns a list of all (unique) create menu names that should be loaded in support of this scenario.
| virtual const std::vector<DtFilename>& DtScenarioExplorer::threeDSymbolMaps | ( | ) | const [virtual] |
Returns a list of all (unique) 3D symbol map names that should be loaded in support of this scenario.
| virtual const std::vector<DtFilename>& DtScenarioExplorer::overlayMenuFilenames | ( | ) | const [virtual] |
Returns a list of all (unique) overlay menu names that should be loaded in support of this scenario.
| std::vector< DtSimulationModelSet * > & DtScenarioExplorer::modelSets | ( | ) | [inline] |
return the array of DtSimulationModelSet pointers.
References myModelSets.
| const std::vector< DtSimulationModelSet * > & DtScenarioExplorer::modelSets | ( | ) | const [inline] |
return the array of DtSimulationModelSet pointers.
References myModelSets.
| virtual const std::vector<DtFilename>& DtScenarioExplorer::modelSetForceFilenames | ( | ) | const [virtual] |
| virtual const std::vector<DtFilename>& DtScenarioExplorer::modelSetFilenames | ( | ) | const [virtual] |
Returns a list of all (unique) model set palette names that should be loaded in support of this scenario.
| virtual void DtScenarioExplorer::gatherSymbolMapInforation | ( | ) | [virtual] |
This routine will see what the current symbol map selection is i the scenario and select the appropriate files.
If there is no symbol map in the scenario, then, no files will be marked for selection
| virtual DtString DtScenarioExplorer::symbolMapName | ( | const DtString & | symbolMap | ) | const [virtual] |
Given the symbol map, return a name (if it is a file, it will return closest match).
If the name is a file name, it must be an exact match for an existing entry to be considered valid (name and directory -- symbol map name will not be enough)
| virtual void DtScenarioExplorer::addFilename | ( | std::vector< DtFilename > & | , |
| const DtFilename & | map | ||
| ) | const [virtual] |
| virtual void DtScenarioExplorer::setSymbolMapName | ( | const DtString & | ) | [virtual] |
Sets symbol map filename and resets symbol map into. Also sets value into myScenario.
| virtual std::vector<DtFilename> DtScenarioExplorer::symbolMapsFor | ( | const DtString & | symbolMap, |
| bool | includeOverlay = true |
||
| ) | const [virtual] |
Returns a list of symbol map files given the symbol map name.
| DtScenario * DtScenarioExplorer::scenario | ( | ) | const [inline] |
Returns scenario associated with explorer.
References myScenario.
| virtual void DtScenarioExplorer::clearModelSets | ( | ) | [protected, virtual] |
| virtual void DtScenarioExplorer::mergeAdditionalOpdFiles | ( | ) | [protected, virtual] |
| virtual void DtScenarioExplorer::processModelSet | ( | DtSimulationModelSet * | ) | [protected, virtual] |
DtScenario* DtScenarioExplorer::myScenario [protected] |
Referenced by scenario().
DtFilename DtScenarioExplorer::myParameterDatabaseFilename [protected] |
DtFilename DtScenarioExplorer::myForceHostilityFilename [protected] |
DtFilename DtScenarioExplorer::myScenarioExtrasFilename [protected] |
std::vector<DtSimulationModelSet*> DtScenarioExplorer::myModelSets [protected] |
Referenced by modelSets().
std::vector<DtFilename> DtScenarioExplorer::myPhysicalWorldFilenames [protected] |
std::vector<DtFilename> DtScenarioExplorer::myIndirectArtilleryTypesFilenames [protected] |
std::vector<DtFilename> DtScenarioExplorer::myAdditionalOpdFilenames [protected] |
std::vector<DtFilename> DtScenarioExplorer::myCommModelFilenames [protected] |
std::vector<DtFilename> DtScenarioExplorer::mySymbolMapFilenames [protected] |
The following member variables are used in the front-end only.
std::vector<DtFilename> DtScenarioExplorer::myCreateMenuFilenames [protected] |
std::vector<DtFilename> DtScenarioExplorer::my3DSymbolMapFilenames [protected] |
std::vector<DtFilename> DtScenarioExplorer::myOverlayMenuFilenames [protected] |
std::vector<DtFilename> DtScenarioExplorer::myModelSetForceFilenames [protected] |
std::vector<DtFilename> DtScenarioExplorer::myModelSetFilenames [protected] |