ligo_config.h

Go to the documentation of this file.

/* Copyright, 2000, 2001 Nevrax Ltd.
 *
 * This file is part of NEVRAX NEL.
 * NEVRAX NEL is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.

 * NEVRAX NEL is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with NEVRAX NEL; see the file COPYING. If not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
 * MA 02111-1307, USA.
 */

#ifndef NL_LIGO_CONFIG_H
#define NL_LIGO_CONFIG_H

#include "nel/misc/types_nl.h"
#include "primitive_class.h"
#include "primitive_configuration.h"

#define DEFAULT_PRIMITIVE_COLOR (CRGBA (128, 0, 0, 128))

namespace NLLIGO
{

class IPrimitive;
class CPrimitive;

class CLigoConfig
{
public:

    CLigoConfig();

    virtual ~CLigoConfig() { }

    bool readConfigFile (const char *fileName, bool parsePrimitiveComboContent);

    bool readPrimitiveClass (const char *fileName, bool parsePrimitiveComboContent);

    bool reloadIndexFile(const std::string &indexFileName = std::string());


    void resetPrimitiveConfiguration ();


    float   CellSize;

    float   Snap;

    uint    ZoneSnapShotRes;

    std::string PrimitiveClassFilename;


    uint32              getDynamicAliasSize() const;
    uint32              getDynamicAliasMask() const;
    uint32              getStaticAliasSize() const;
    uint32              getStaticAliasMask() const;
    uint32              buildAlias(uint32 staticPart, uint32 dynamicPart, bool warnIfOverload = true) const;
    void                registerFileToStaticAliasTranslation(const std::string &fileName, uint32 staticPart);
    virtual uint32              getFileStaticAliasMapping(const std::string &fileName) const;
    const std::string   &getFileNameForStaticAlias(uint32 staticAlias) const;
    bool                isFileStaticAliasMapped(const std::string &fileName) const;
    std::string         aliasToString(uint32 fullAlias);
    uint32              aliasFromString(std::string fullAlias);


    // Get a primitive class
    const CPrimitiveClass       *getPrimitiveClass (const NLLIGO::IPrimitive &primitive) const;

    // Get a primitive class
    const CPrimitiveClass       *getPrimitiveClass (const char *className) const;

    // Get the primitive color
    NLMISC::CRGBA               getPrimitiveColor (const NLLIGO::IPrimitive &primitive);

    // Is the primitive deletable ?
    bool isStaticChild (const NLLIGO::IPrimitive &primitive);

    // Is the primitive linked to its brother primitive ?
    bool isPrimitiveLinked (const NLLIGO::IPrimitive &primitive);

    // Return the next primitive linked to 'primitive', or NULL
    const NLLIGO::IPrimitive *getLinkedPrimitive (const NLLIGO::IPrimitive &primitive) const;

    // Return the previous primitive linked to 'primitive', or NULL
    const NLLIGO::IPrimitive *getPreviousLinkedPrimitive (const NLLIGO::IPrimitive &primitive) const;

    // Is the primitive deletable ?
    bool isPrimitiveDeletable (const NLLIGO::IPrimitive &primitive);

    // Is the child primitive can be a child of the parent primitive ?
    bool canBeChild (const NLLIGO::IPrimitive &child, const NLLIGO::IPrimitive &parent);

    // Is the primitive a root primitive ?
    bool canBeRoot (const NLLIGO::IPrimitive &primitive);

    // Read a property from an XML file
    bool getPropertyString (std::string &result, const char *filename, xmlNodePtr xmlNode, const char *propName);

    // Output error message
    void syntaxError (const char *filename, xmlNodePtr xmlNode, const char *format, ...);
    virtual void errorMessage (const char *format, ... );

    // Access to the config string
    const std::vector<std::string> &getContextString () const;

    // Access the primitive configuration
    const std::vector<CPrimitiveConfigurations> &getPrimitiveConfiguration() const
    {
        return _PrimitiveConfigurations;
    }

    // Update the DynamicAlias bit count that was previously defined in the config file.
    // The _StaticAliasFileMapping is updated in order that full alias stay the same.
    // All previous DynamicAlias must fit in the new DynamicAliasBitCount
    void updateDynamicAliasBitCount(uint32 newDynamicAliasBitCount);

private:

    // Init primitive class manager
    bool        initPrimitiveClass (const char *filename);

    // The primitive class manager
    std::map<std::string, CPrimitiveClass>  _PrimitiveClasses;

    // The context strings
    std::vector<std::string>    _Contexts;

    // The file context look up
    std::map<std::string, std::string>  _ContextFilesLookup;

    // The primitive configurations
    std::vector<CPrimitiveConfigurations>   _PrimitiveConfigurations;

    // Dynamic alias bit count
    uint32              _DynamicAliasBitCount;

    std::string         _IndexFileName;
    // Static alias part file mapping : filename -> staticAliasPart
    std::map<std::string, uint32>       _StaticAliasFileMapping;
};

}

#endif // NL_LIGO_CONFIG_H

/* End of ligo_config.h */