eda_3d_viewer_frame.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2015-2016 Mario Luzeiro <[email protected]>
 * Copyright (C) 2014 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2011 Wayne Stambaugh <[email protected]>
 * Copyright (C) 2023 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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 2
 * 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

 
#ifndef EDA_3D_VIEWER_H
#define EDA_3D_VIEWER_H
 
#include "3d_canvas/board_adapter.h"
#include "3d_canvas/eda_3d_canvas.h"
#include "3d_rendering/track_ball.h"
#include <kiway_player.h>
#include <wx/colourdata.h>
#include <dialogs/dialog_color_picker.h>  // for CUSTOM_COLORS_LIST definition
 
 
#define KICAD_DEFAULT_3D_DRAWFRAME_STYLE    (wxDEFAULT_FRAME_STYLE | wxWANTS_CHARS)
 
// Forward declarations
#ifdef __linux__
class SPNAV_VIEWER_PLUGIN;
#else
class NL_3D_VIEWER_PLUGIN;
#endif
class APPEARANCE_CONTROLS_3D;
 
 
enum EDA_3D_VIEWER_STATUSBAR
{
    ACTIVITY = 0,
    HOVERED_ITEM,
    X_POS,
    Y_POS,
    ZOOM_LEVEL,
};
 
enum class EDA_3D_VIEWER_EXPORT_FORMAT
{
    CLIPBOARD,
    IMAGE,
    PNG,
    JPEG
};

class EDA_3D_VIEWER_FRAME : public KIWAY_PLAYER
{
public:
    EDA_3D_VIEWER_FRAME( KIWAY* aKiway, PCB_BASE_FRAME* aParent, const wxString& aTitle,
                         long style = KICAD_DEFAULT_3D_DRAWFRAME_STYLE );
 
    ~EDA_3D_VIEWER_FRAME();
 
    PCB_BASE_FRAME* Parent() const { return (PCB_BASE_FRAME*)GetParent(); }
 
    BOARD* GetBoard() { return Parent()->GetBoard(); }
 
    wxWindow* GetToolCanvas() const override { return m_canvas; }

    void ReloadRequest();
 
    // !TODO: review this function: it need a way to tell what changed,
    // to only reload/rebuild things that have really changed
    void NewDisplay( bool aForceImmediateRedraw = false );
 
    void Redraw();
 
    BOARD_ADAPTER& GetAdapter() { return m_boardAdapter; }
    CAMERA& GetCurrentCamera() { return m_currentCamera; }
 
    EDA_3D_CANVAS* GetCanvas()  { return m_canvas; }
 
    void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
    void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;

    void CommonSettingsChanged( int aFlags ) override;
    void ShowChangedLanguage() override;
 
    APPEARANCE_CONTROLS_3D* GetAppearanceManager() { return m_appearancePanel; }
 
    void ToggleAppearanceManager();
 
    void OnDarkModeToggle();

    void TakeScreenshot( EDA_3D_VIEWER_EXPORT_FORMAT aFormat );

    void ExportImage( EDA_3D_VIEWER_EXPORT_FORMAT aFormat, const wxSize& aSize );
 
protected:
    void setupUIConditions() override;
 
    void handleIconizeEvent( wxIconizeEvent& aEvent ) override;
 
private:
    void Exit3DFrame( wxCommandEvent& event );
 
    void OnCloseWindow( wxCloseEvent& event );
 
    bool TryBefore( wxEvent& aEvent ) override;
 
    void Process_Special_Functions( wxCommandEvent& event );
 
    void onDisableRayTracing( wxCommandEvent& aEvent );
 
    void OnActivate( wxActivateEvent& event );
    void OnSetFocus( wxFocusEvent& event );
 
    void doReCreateMenuBar() override;

    void RenderEngineChanged();
 
    void refreshRender();
 
    DECLARE_EVENT_TABLE()
 
    
    void loadCommonSettings();
 
    void applySettings( EDA_3D_VIEWER_SETTINGS* aSettings );

    bool getExportFileName( EDA_3D_VIEWER_EXPORT_FORMAT& aFormat, wxString& fullFileName );

    wxImage captureScreenshot( const wxSize& aSize );

    void setupRenderingConfig( BOARD_ADAPTER& adapter );

    wxImage captureCurrentViewScreenshot();

    wxImage captureRaytracingScreenshot( BOARD_ADAPTER& adapter, TRACK_BALL& camera, const wxSize& aSize );

    wxImage convertRGBAToImage( uint8_t* rgbaBuffer, const wxSize& realSize );

    wxImage captureOpenGLScreenshot( BOARD_ADAPTER& adapter, TRACK_BALL& camera, const wxSize& aSize );

    void configureCanvas( std::unique_ptr<EDA_3D_CANVAS>& canvas, EDA_3D_VIEWER_SETTINGS* cfg );

    void saveOrCopyImage( const wxImage& screenshotImage, EDA_3D_VIEWER_EXPORT_FORMAT aFormat, const wxString& fullFileName );

    void copyImageToClipboard( const wxImage& screenshotImage );

    void saveImageToFile( const wxImage& screenshotImage, EDA_3D_VIEWER_EXPORT_FORMAT aFormat, const wxString& fullFileName );
 
private:
    wxFileName                     m_defaultSaveScreenshotFileName;
 
    EDA_3D_CANVAS*                 m_canvas;
    BOARD_ADAPTER                  m_boardAdapter;
    CAMERA&                        m_currentCamera;
    TRACK_BALL                     m_trackBallCamera;
 
    bool                           m_disable_ray_tracing;
 
#ifdef __linux__
    std::unique_ptr<SPNAV_VIEWER_PLUGIN> m_spaceMouse;
#else
    std::unique_ptr<NL_3D_VIEWER_PLUGIN> m_spaceMouse;
#endif

    static const wxChar *m_logTrace;
 
};
 
#endif // EDA_3D_VIEWER_H