Window.h

[詳解]

#if !defined(__FK_WINDOW_HEADER__)
#define __FK_WINDOW_HEADER__
 
#include <stdarg.h>
#include <map>
 
// for Graphics Header.
#include <FL/Fl_Gl_Window.H>
#include <FL/Fl_Multi_Browser.H>
 
// for FK Header.
#include <FK/FrameController.h>
#include <FK/Plane.h>
#include <FK/Image.h>
#include <FK/Model.h>
 
// for Graphics Routine
 
namespace FK {
    class fk_GraphicsEngine;
    class fk_Scene;
 
    enum class fk_Key {
        SHIFT_R,    
        SHIFT_L,    
        CTRL_R,     
        CTRL_L,     
        ALT_R,      
        ALT_L,      
        ENTER,      
        BACKSPACE,  
        DEL,        
        CAPS_LOCK,  
        TAB,        
        PAGE_UP,    
        PAGE_DOWN,  
        HOME,       
        END,        
        INSERT,     
        LEFT,       
        RIGHT,      
        UP,         
        DOWN,       
        F1,         
        F2,         
        F3,         
        F4,         
        F5,         
        F6,         
        F7,         
        F8,         
        F9,         
        F10,        
        F11,        
        F12,        
        SPACE       
    };
 
    enum class fk_MouseButton {
        M1,     
        M2,     
        M3      
    };
 
    enum class fk_PutStrMode {
        NONE,           
        CONSOLE,        
        ERR_CONSOLE,    
        BROWSER,        
        FILE            
    };
 
    enum class fk_Switch {
        RELEASE,    
        UP,         
        DOWN,       
        PRESS       
    };
 
 
    class fk_Window : public Fl_Gl_Window {
 
#if !defined(FK_DOXYGEN_USER_PROCESS)
        class Member {
        public:
            fk_Image snapBuffer;
            bool winOpenFlag;
            int GLWinXPosition;
            int GLWinYPosition;
            int GLWinWSize;
            int GLWinHSize;
            char lastKey;
            std::map<char, bool> keyStatus;
            std::map<fk_Key, bool> specialKeyStatus;
            std::map<fk_MouseButton, bool> mouseStatus;
            double frameTime, prevTime;
            double frameInterval;
            int skipCount;
            fk_FrameController fps_admin;
            int fps;
#if !defined(FK_OLD_NONSUPPORT)
            bool stereoMode;
#endif
 
            Member(int, int, int, int);
        };
#endif
 
    public:
 
 
        fk_Window(int x = 0, int y = 0, int w = 300, int h = 300, std::string name = "FK Window");
 
        virtual ~fk_Window();
 
 
 
 
        void setScene(fk_Scene *scene);
 
 
 
        int drawWindow(bool drawFlag = true);
 
 
        bool winOpenStatus(void);
 
 
        void resizeWindow(int x, int y, int w, int h);
 
 
        bool getKeyStatus(char key, fk_Switch status, bool insideFlag = true);
    
 
        bool getKeyStatus(char key, bool insideFlag = true);
 
 
        bool getSpecialKeyStatus(fk_Key key, fk_Switch status, bool insideFlag = true);
 
 
        bool getSpecialKeyStatus(fk_Key key, bool insideFlag = true);
 
 
        bool getKeyStatus(fk_Key key, fk_Switch status, bool insideFlag = true);
 
 
        bool getKeyStatus(fk_Key key, bool insideFlag = true);
 
 
        char getLastKey(void);
 
 
        std::tuple<int, int> getMousePosition(bool insideFlag = true);
 
#if !defined(FK_OLD_NONSUPPORT) && !defined(FK_DOXYGEN_USER_PROCESS)
        void getMousePosition(int *, int *, bool = true);
#endif
        
 
        bool getMouseStatus(fk_MouseButton button, fk_Switch status, bool insideFlag = true);
 
#if !defined(FK_OLD_NONSUPPORT) && !defined(FK_DOXYGEN_USER_PROCESS)
        bool getMouseStatus(fk_MouseButton, bool = true);
#endif
 
 
        int getMouseWheelStatus(void);
 
 
        void setFPS(int fps);
 
 
 
 
        std::tuple<bool, fk_Vector> getProjectPosition(double x, double y, fk_Plane &plane);
 
#if !defined(FK_OLD_NONSUPPORT) && !defined(FK_DOXYGEN_USER_PROCESS)
        bool getProjectPosition(double x, double y, fk_Plane *plane, fk_Vector *pos);
#endif
 
        std::tuple<bool, fk_Vector> getProjectPosition(double x, double y, double dist);
 
#if !defined(FK_OLD_NONSUPPORT) && !defined(FK_DOXYGEN_USER_PROCESS)
        bool getProjectPosition(double x, double y, double dist, fk_Vector *pos);
#endif
 
        std::tuple<bool, fk_Vector> getWindowPosition(fk_Vector &pos_3D);
 
#if !defined(FK_OLD_NONSUPPORT) && !defined(FK_DOXYGEN_USER_PROCESS)
        bool getWindowPosition(fk_Vector, fk_Vector *);
#endif
 
 
 
        virtual void preInit(void) {}
 
 
        virtual void postInit(void) {}
 
 
        virtual void preDraw(void) {}
 
 
        virtual void postDraw(void) {}
 
#if !defined(FK_OLD_NONSUPPORT) && !defined(FK_DOXYGEN_USER_PROCESS)
        virtual void preDrawLeft(void) {}
        virtual void postDrawLeft(void) {}
        virtual void preDrawRight(void) {}
        virtual void postDrawRight(void) {}
#endif
 
#if !defined(FK_DOXYGEN_USER_PROCESS)
        std::list<fk_funcSet> preDrawList;
        std::list<fk_funcSet> postDrawList;
#endif
 
 
 
        bool snapImage(std::string fileName,
                       fk_ImageType format = fk_ImageType::BMP,
                       fk_SnapProcMode mode = fk_SnapProcMode::FRONT);
 
 
        bool snapImage(fk_Image *image, fk_SnapProcMode mode = fk_SnapProcMode::FRONT);
 
 
 
        static void setPutStrMode(const fk_PutStrMode mode);
 
 
        static fk_PutStrMode getPutStrMode(void);
 
 
        static bool setPutFile(const std::string &fileName);
 
 
        static void putString(const std::string &str);
 
#if !defined(FK_CLI_CODE)
 
        static void printf(const char *format, ...);
#endif
 
 
        static void clearBrowser(void);
 
 
        static void fontInit(void);
 
 
#if !defined(FK_OLD_NONSUPPORT) && !defined(FK_DOXYGEN_USER_PROCESS)
 
 
        void setOGLStereoMode(bool mode);
 
 
        bool getOGLStereoMode(void);
#endif
 
#if !defined(FK_DOXYGEN_USER_PROCESS)
        fk_GraphicsEngine * GetEngine(void);
#endif
        
    private:
        std::unique_ptr<Member> _m;
 
        static inline std::unique_ptr<Fl_Window> _s_putWin;
        static inline Fl_Multi_Browser * _s_browser;
        static inline std::unique_ptr<fk_PutStrMode> _s_putStrMode;
        static inline std::unique_ptr<std::ofstream> _s_putStrOFS;
        static inline std::unique_ptr<int> _s_winNum;
 
        static inline std::unique_ptr<Fl_Window> _s_error_win;
        static inline std::map<fk_Key, int> _keyMap;
 
        bool IsInsideWindow(void);
        Fl_Group * GetInhParentWindow(void);
        void PushPrevStatus(void);
    
        void draw(); // virtual Function from Fl_Gl_Window class
 
        static void PutBrowser(const std::string &);
 
#if defined(WIN32)
     bool SnapImageGDI(fk_Image *);
#endif
        static void ErrorInit(void);
        static void MakeKeyMap(void);
 
        static void StaticInit(void);
        bool GetMouseStatus(fk_MouseButton, bool);
 
    protected:
 
#if !defined(FK_DOXYGEN_USER_PROCESS)
        std::unique_ptr<fk_GraphicsEngine> _m_engine;
 
        void drawScene(void);
        void drawSceneLeft(void);
        void drawSceneRight(void);
#endif
 
    };
}
 
#endif /* !__FK_WINDOW_HEADER__ */
 
/****************************************************************************
 *
 *  Copyright (c) 1999-2024, Fine Kernel Project, All rights reserved.
 *
 *  Redistribution and use in source and binary forms,
 *  with or without modification, are permitted provided that the
 *  following conditions are met:
 *
 *      - Redistributions of source code must retain the above
 *          copyright notice, this list of conditions and the
 *          following disclaimer.
 *
 *      - Redistributions in binary form must reproduce the above
 *          copyright notice, this list of conditions and the
 *          following disclaimer in the documentation and/or
 *          other materials provided with the distribution.
 *
 *      - Neither the name of the copyright holders nor the names
 *          of its contributors may be used to endorse or promote
 *          products derived from this software without specific
 *          prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 *  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 *  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 *  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 *  IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE. 
 *
 ****************************************************************************/
/****************************************************************************
 *
 *  Copyright (c) 1999-2024, Fine Kernel Project, All rights reserved.
 *
 *  本ソフトウェアおよびソースコードのライセンスは、基本的に
 *  「修正 BSD ライセンス」に従います。以下にその詳細を記します。
 *
 *  ソースコード形式かバイナリ形式か、変更するかしないかを問わず、
 *  以下の条件を満たす場合に限り、再頒布および使用が許可されます。
 *
 *  - ソースコードを再頒布する場合、上記の著作権表示、本条件一覧、
 *      および下記免責条項を含めること。
 *
 *  - バイナリ形式で再頒布する場合、頒布物に付属のドキュメント等の
 *      資料に、上記の著作権表示、本条件一覧、および下記免責条項を
 *      含めること。
 *
 *  - 書面による特別の許可なしに、本ソフトウェアから派生した製品の
 *      宣伝または販売促進に、本ソフトウェアの著作権者の名前または
 *      コントリビューターの名前を使用してはならない。
 *
 *  本ソフトウェアは、著作権者およびコントリビューターによって「現
 *  状のまま」提供されており、明示黙示を問わず、商業的な使用可能性、
 *  および特定の目的に対する適合性に関す暗黙の保証も含め、またそれ
 *  に限定されない、いかなる保証もないものとします。著作権者もコン
 *  トリビューターも、事由のいかんを問わず、損害発生の原因いかんを
 *  問わず、かつ責任の根拠が契約であるか厳格責任であるか(過失その
 *  他の)不法行為であるかを問わず、仮にそのような損害が発生する可
 *  能性を知らされていたとしても、本ソフトウェアの使用によって発生
 *  した(代替品または代用サービスの調達、使用の喪失、データの喪失、
 *  利益の喪失、業務の中断も含め、またそれに限定されない)直接損害、
 *  間接損害、偶発的な損害、特別損害、懲罰的損害、または結果損害に
 *  ついて、一切責任を負わないものとします。
 *
 ****************************************************************************/