scene.h

Go to the documentation of this file.

/*
 * Kage Studio - a simple free and open source vector-based 2D animation software
 * Copyright (C) 2011~2023  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/>.
 * 
 */
#ifndef GTKMM_KAGE_SCENE_H
    #define GTKMM_KAGE_SCENE_H
    
    #include <vector>
    #include "color.h"
    
    #include "frame.h"
    #include "layer.h"
    #include "../vectordatamanager.h"
 
    #include "../../util/string/stringhelper.h"
    
    #include <gdkmm/color.h>
    //class Kage; //forward declaration
    
    using namespace std;
    
    class KageFrame; //forward declaration
    class KageLayer; //forward declaration
 
    class KageDocument; //forward declaration
 
    class KageScene {
        protected:
            void init(KageDocument *p_document);
 
            unsigned int ID;
            bool _selected;
            bool _saved;
            unsigned int _activeLayer;
        public:
            static bool LOADING_MODE;
            KageScene(KageDocument *p_document, string p_filepath);
 
            vector<KageLayer *> Layers;
 
            bool open(string p_filepath);
            bool save();
            
            bool isSelected();
            bool isSaved();
 
        public:
            KageScene(KageDocument *p_document);
            KageScene(KageDocument *p_document, KageScene *p_scene);
            virtual ~KageScene();
            void addLayer(unsigned int p_layer);
            void deleteFrameset(unsigned int p_layer);
            bool addFrame();
            bool extendFrame();
            bool duplicateFrame();
            bool removeFrame();
            void setCurrentFrame(unsigned int p_frame);
            void setCurrentFrameByID(unsigned int p_frameID);
            unsigned int getCurrentFrame();
            void setCurrentLayer(unsigned int p_currentLayer);
            void setCurrentLayerByID(unsigned int p_layerID);
            unsigned int getCurrentLayer(); //currently used by getFrame()
            unsigned int layerCount();
            unsigned int frameCount();
            void selectAll(bool p_selectAll);
            KageFrame *getFrame();
            KageFrame *getFrameAt(unsigned int p_frame);
            KageLayer *getLayer();
            KageLayer *getLayerAt(unsigned int p_layer);
            
            void renderStage(); //used by KageFrame
            
            bool removeAllFrames();
            
            bool moveToTop();
            bool moveUp();
            bool moveDown();
            bool moveToBottom();
            
            vector<unsigned int> raiseSelectedShape(vector<unsigned int> p_selectedShapes);
            vector<unsigned int> lowerSelectedShape(vector<unsigned int> p_selectedShapes);
            vector<unsigned int> raiseToTopSelectedShape(vector<unsigned int> p_selectedShapes);
            vector<unsigned int> lowerToBottomSelectedShape(vector<unsigned int> p_selectedShapes);
            vector<unsigned int> groupSelectedShapes(vector<unsigned int> p_selectedShapes);
            vector<unsigned int> ungroupSelectedShapes(vector<unsigned int> p_selectedShapes);
            vector<unsigned int> duplicateShapes(vector<unsigned int> p_selectedShapes);
            bool flipHorizontalSelectedShape(vector<unsigned int> p_selectedShapes);
            bool flipVerticalSelectedShape(vector<unsigned int> p_selectedShapes);
            
            bool recenterRotationPoint(vector<unsigned int> p_selectedShapes);
            
            bool addDataToFrame(VectorDataManager p_vectorsData);
            bool setFrameData(VectorDataManager p_vectorsData);
            VectorDataManager getFrameData();
            VectorDataManager getFrameDataAt(unsigned int p_frame);  
            
            bool forceSetTween(unsigned int p_tween);
            bool setTween(unsigned int p_tween);
            unsigned int getTween();
            
            bool switchToPreviousFrame(); 
            bool switchToPreviousFrame(unsigned int p_frameID); 
            bool switchToNextFrame(); 
            bool switchToNextFrame(unsigned int p_frameID); 
            
            void setFrameExtension(KageFrame::extension p_extension);
            //Kage *_kage;
            KageDocument *_document;
            KageScene *_parent;
 
            unsigned int getActiveLayerID();
            void setActiveLayerID(unsigned int p_layerID);
    };
#endif //GTKMM_KAGE_SCENE_H