XPMP2
X-Plane multiplayer library 2 - using instancing
Classes | Namespaces | Typedefs | Enumerations | Functions
CSLModels.h File Reference

Managing CSL Models, including matching and loading. More...

Go to the source code of this file.

Classes

class  XPMP2::CSLObj
 One .obj file of a CSL model (of which it can have multiple) More...
 
class  XPMP2::CSLModel
 Represents a CSL model as it is saved on disk. More...
 
struct  XPMP2::CSLModel::MatchCritTy
 Combines match-relevant fields (beside ICAO a/c type) More...
 

Namespaces

 XPMP2
 

Typedefs

typedef std::map< std::string, std::string > XPMP2::mapCSLPackageTy
 Map of CSLPackages: Maps an id to the base path (path ends on forward slash) More...
 
typedef std::list< CSLObj > XPMP2::listCSLObjTy
 List of objects. More...
 
typedef std::pair< std::string, std::string > XPMP2::pairOfStrTy
 
typedef std::map< std::string, CSLModel > XPMP2::mapCSLModelTy
 Map of CSLModels (owning the object), ordered by related group / type. More...
 
typedef std::multimap< unsigned long, std::pair< CSLModel *, const CSLModel::MatchCritTy * > > XPMP2::mmapCSLModelPTy
 Multimap of references to CSLModels and match criteria for matching purposes. More...
 

Enumerations

enum  XPMP2::ObjLoadStateTy {
  XPMP2::OLS_INVALID = -1 , XPMP2::OLS_UNAVAIL = 0 , XPMP2::OLS_COPYING , XPMP2::OLS_LOADING ,
  XPMP2::OLS_AVAILABLE
}
 State of the X-Plane object: Is it being loaded or available? More...
 

Functions

void XPMP2::CSLModelsInit ()
 Initialization. More...
 
void XPMP2::CSLModelsCleanup ()
 Grace cleanup. More...
 
const char * XPMP2::CSLModelsLoad (const std::string &_path, int _maxDepth=5)
 Read the CSL Models found in the given path and below. More...
 
CSLModel * XPMP2::CSLModelById (const std::string &_cslId, mapCSLModelTy::iterator *_pOutIter=nullptr)
 Find a model by unique id. More...
 
CSLModel * XPMP2::CSLModelByKey (const std::string &_cslKey, mapCSLModelTy::iterator *_pOutIter=nullptr)
 Find a model by (even more) unique key. More...
 
int XPMP2::CSLModelMatching (const std::string &_type, const std::string &_airline, const std::string &_livery, CSLModel *&pModel)
 Find a matching model. More...
 

Detailed Description

Managing CSL Models, including matching and loading.

Author
Birger Hoppe