document.h

Go to the documentation of this file.

/*
 * Kage Studio - a simple free and open source vector-based 2D animation software
 * Copyright (C) 2011~2024  Mj Mendoza IV
 * 
 * This program 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 3 of the License, or
 * (at your option) any later version.
 * 
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301, USA.  Or, see <https://www.gnu.org/licenses/>.
 * 
 */
/*Project
    Info
        Name
        Width
        Height
        BG Color
    Assets
        asset01 Image
        asset02 Image
        asset03 SceneID
    Scene01
        layer01
            frame01
                data Move X Y
                data Line X Y
                data Color
            frame02
                data Move X Y
                data Line X Y
                data Asset ID
        layer02
            ...
    Scene02
        ...
    Scene03
        layer01
            frame01
                data Move X Y
                data Line X Y
                data Color
            frame02
                ...
        layer02
            ...
        layer03
            ...
*/
#ifndef GTKMM_KAGE_DOCUMENT_H
    #define GTKMM_KAGE_DOCUMENT_H
    
    #include <vector>
    #include "data/color.h"
    #include "./data/scene.h"
    
    #include "../util/string/stringhelper.h"
    
    #include <gdkmm/color.h>
    
    class KageDocument {
        public:
            bool _saved;
            unsigned int _activeSceneID;
            unsigned int _activeSceneIndex;
 
            unsigned int sceneCtr; 
            
            unsigned int _activeScene;
 
            KageDocument();
            KageDocument(KageDocument &p_document);
            KageDocument operator=(const KageDocument &p_document);
            void init();
            virtual ~KageDocument();
            unsigned int openScene(std::string p_filepath);
            bool saveScene(unsigned int p_sceneID);
            bool openProject();
            bool saveProject();
            bool isSaved();
 
            unsigned int addScene(std::string p_sceneLabel, bool p_asset = false);
            bool removeAllScenes();
            bool removeSceneAt(unsigned int p_sceneIndex);
            
            enum AssetType {
                ASSET_IMAGE,
                ASSET_VIDEO,
                ASSET_KAGE
            };
            
            struct Asset {
                unsigned int ID;
                AssetType Type;
                std::string Path;
                std::string Name;
            };
            //TODO: each instance of asset will reference to this
            std::vector<Asset> Assets;
            
            //TODO: each Scene will be saved as separate KSF file
            std::vector<KageScene*> Scenes;
            KageScene* _scenePtr;
 
            KageScene *getScene();
            unsigned int getCurrentScene(); 
            void setCurrentScene(unsigned int p_newScene); //p_scene-1 is index
            void setCurrentSceneByID(unsigned int p_newSceneID);
            unsigned int getActiveSceneID();
            unsigned int getActiveLayerID();
            unsigned int getActiveFrameID();
 
            unsigned int frameCount();
            void setSceneLayerCurrentFrame(unsigned int p_frame);
            std::string getLayerLabel();
            void setLayerLabel(std::string p_label);
            void toggleLayerVisibility();
            bool isLayerVisible();
            void setLayerVisible(bool p_visible);
            void toggleLayerLock();
            bool isLayerLocked();
            void setLayerLocked(bool p_lock);
            
            bool moveSceneUp();
            bool moveSceneDown();
            bool moveSceneToTop();
            bool moveSceneToBottom();
 
            bool gotoNextScene();
            
            static GdkPoint _mouseLocation;
            static bool _displayObjectIsShape;
            static bool ASSET_MODE;
    };
#endif //GTKMM_KAGE_DOCUMENT_H