TreeUtilsSVG.h

/*
 
MIT License
 
Copyright (c) 2023 FMI Open Development / Markus Peura, first.last@fmi.fi
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 
*/
/*
Part of Rack development has been done in the BALTRAD projects part-financed
by the European Union (European Regional Development Fund and European
Neighbourhood Partnership Instrument, Baltic Sea Region Programme 2007-2013)
*/
/*
 * TreeSVG.h
 *
 *  Created on: Jun 24, 2012
 *      Author: mpeura
 */
 
#ifndef DRAIN_TREE_UTILS_SVG
#define DRAIN_TREE_UTILS_SVG
 
//
 
#include <drain/Enum.h>
 
#include "TreeSVG.h"
 
namespace drain {
 
namespace image {
 
 
 
// TODO: separate TreeLayoutUtilsSVG
 
struct TreeUtilsSVG {
 
public:
 
    enum Roles {
        MAIN,
    };
 
 
    /*
    static
    TreeSVG & getHeaderObject(TreeSVG & root, svg::tag_t, const std::string & key = "");
    */
 
 
};
 
DRAIN_ENUM_DICT(TreeUtilsSVG::Roles);
DRAIN_ENUM_OSTREAM(TreeUtilsSVG::Roles)
 
 
 
class RelativePathSetterSVG : public drain::TreeVisitor<TreeSVG> {
 
public:
 
    // Leading path, maybe partial, to be pruned
    // const std::string dir;
    const FilePath removePath;
 
    // String starting the modified path, for example "file://"
    const std::string prefixNew;
 
    inline
    RelativePathSetterSVG(const drain::FilePath & filepath, const std::string & prefixNew = "") :
        //dir(filepath.dir.empty() ? "" : filepath.dir.str()),  // +'/'
        removePath(filepath),
        prefixNew(prefixNew) {
        /*
        drain::Logger mout( __FILE__, __FUNCTION__);
        drain::FilePath checkPath(dir);
        mout.warn("checking prefix: ", dir, " to ", checkPath);
        if (checkPath.str() != dir){
            mout.warn("consider pruning prefix: ", dir, " to ", checkPath);
        }
        */
 
 
    }
 
    int visitPrefix(TreeSVG & tree, const TreeSVG::path_t & path) override;
 
 
};
 
 
class MetaDataCollectorSVG : public drain::TreeVisitor<TreeSVG> {
 
public:
 
    static
    const std::string LOCAL;
 
    static
    const std::string SHARED;
 
    /*
    enum MetaDataType {
        LOCAL,
        SHARED
    };
    */
 
    inline
    int visitPrefix(TreeSVG & tree, const TreeSVG::path_t & path) override {
        // always continue
        return 0;
    }
 
    int visitPostfix(TreeSVG & tree, const TreeSVG::path_t & path) override;
 
    // Also
    //GraphicsContext::TitleFlagger titles;
 
protected:
 
    typedef std::map<std::string, unsigned short> variableStat_t;
 
};
 
 
 
class FloaterSVG : public drain::TreeVisitor<TreeSVG> {
public:
 
    static
    const std::string FLOATING;
 
    inline // TreeSVG & root
    FloaterSVG(){
    }
 
    inline
    FloaterSVG(const FloaterSVG & floatLifter){ // : root(clipper.root) { // ???
    }
 
 
    inline
    int visitPrefix(TreeSVG & tree, const TreeSVG::path_t & path) override {
        // always continue
        return 0;
    }
 
    int visitPostfix(TreeSVG & tree, const TreeSVG::path_t & path) override;
 
    // TreeSVG & root;
 
};
 
 
class OverlayMoverSVG : public drain::TreeVisitor<TreeSVG> {
public:
 
    static
    const std::string OVERLAY;
 
    inline // TreeSVG & root
    OverlayMoverSVG(){
    }
 
    inline
    OverlayMoverSVG(const OverlayMoverSVG & floatLifter){ // : root(clipper.root) { // ???
    }
 
    int visitPrefix(TreeSVG & tree, const TreeSVG::path_t & path) override;
    /*
    inline
    int visitPrefix(TreeSVG & tree, const TreeSVG::path_t & path) override {
        // always continue
        return 0;
    }
    */
 
    int visitPostfix(TreeSVG & tree, const TreeSVG::path_t & path) override;
 
    // TreeSVG & root;
 
};
 
 
class ClipperSVG : public drain::TreeVisitor<TreeSVG> {
 
public:
 
    static
    const std::string CLIPPED;
 
 
    inline
    ClipperSVG(){ //  : root(root) {
    }
 
    ClipperSVG(const ClipperSVG & clipper){ //  : root(clipper.root) { // ???
    }
 
 
    static
    TreeSVG & getClippingRect(TreeSVG & root, size_t width, size_t height);
 
    inline
    int visitPrefix(TreeSVG & tree, const TreeSVG::path_t & path) override {
        // always continue
        return 0;
    }
 
    int visitPostfix(TreeSVG & tree, const TreeSVG::path_t & path) override;
 
    // TreeSVG & root;
 
};
 
 
 
 
class MaskerSVG : public drain::TreeVisitor<TreeSVG> {
 
public:
 
    static
    const std::string MASK_ID;
 
    static
    const std::string MASK_POS;
 
    static
    const ClassXML COVER;
 
 
    enum MaskPosition {
        NONE=0,     // alias "false", No mask applied
        TOP=1,      // alias "true", Highest (last) element in a group, added by TreeSVG::addChild(COVER)
        BOTTOM=2,   // Lowest (first) element in a group, added by TreeSVG::prependChild(COVER)
        // Note: also "false" and "true" supported, see Enum dict
    };
 
    inline
    MaskerSVG(){
    }
 
    MaskerSVG(const MaskerSVG & masker){ // ???
    }
 
 
 
    static
    const drain::FlexibleVariable & ensureMaskId(TreeSVG & group);
 
    static
    TreeSVG & getMask(TreeSVG & root, const std::string & maskId);
 
 
    static
    drain::image::TreeSVG & updateMask(TreeSVG & mask, int width, int height, const NodeSVG & contourNode);
 
 
 
    static
    TreeSVG & createMask(TreeSVG & root, TreeSVG & group, int width=0, int height=0, const NodeSVG & node = NodeSVG(svg::UNDEFINED),
            MaskerSVG::MaskPosition pos=MaskerSVG::MaskPosition::BOTTOM);
 
    // static
    //void linkMask(const TreeSVG & mask, TreeSVG & obj);
 
 
    static
    void addCoverRect(const TreeSVG & mask, TreeSVG & group, MaskPosition pos=TOP);
 
 
 
    inline
    int visitPrefix(TreeSVG & tree, const TreeSVG::path_t & path) override {
        return 0;
    }
 
    int visitPostfix(TreeSVG & tree, const TreeSVG::path_t & path) override;
 
};
 
 
 
class TransformerSVG : public drain::TreeVisitor<TreeSVG> {
public:
 
    inline // TreeSVG & root
    TransformerSVG(){
    }
 
    inline
    TransformerSVG(const TransformerSVG & transformer) : transform(transformer.transform){
    }
 
    inline // TreeSVG & root
    TransformerSVG(const TransformSVG & transform) : transform(transform) {
    }
 
    inline
    void set(const TransformSVG & tr){
        transform = tr;
    }
 
 
    inline
    int visitPrefix(TreeSVG & tree, const TreeSVG::path_t & path) override {
        if (tree.data.typeIs(svg::SVG, svg::GROUP)){
            return 0;
        }
        else {
            return 1;
        }
    }
 
    int visitPostfix(TreeSVG & tree, const TreeSVG::path_t & path) override;
 
protected:
 
    TransformSVG transform;
 
};
 
 
// DRAIN_ENUM_DICT(MetaDataCollectorSVG::MetaDataType);
 
}  // image::
 
 
 
DRAIN_ENUM_DICT(image::MaskerSVG::MaskPosition);
DRAIN_ENUM_OSTREAM(image::MaskerSVG::MaskPosition)
 
//DRAIN_GETKEY_ENUM(image::TreeSVG, rack::RackSVG::ElemClass);
 
 
}  // drain::
 
 
 
 
#endif // TREESVG_H_