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) 1992-2022 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 KICAD7_3DMODEL_DIR wxT( "KICAD7_3DMODEL_DIR" )
 
 
#define KICAD_DEFAULT_3D_DRAWFRAME_STYLE (wxDEFAULT_FRAME_STYLE | wxWANTS_CHARS)
 
// Forward declarations
class NL_3D_VIEWER_PLUGIN;
 
enum EDA_3D_VIEWER_STATUSBAR
{
 ACTIVITY = 0,
 HOVERED_ITEM,
 X_POS,
 Y_POS,
};
 
class EDA_3D_VIEWER_FRAME : public EDA_3D_BOARD_HOLDER, 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() override { return m_boardAdapter; }
 CAMERA& GetCurrentCamera() override { return m_currentCamera; }
 
 EDA_3D_CANVAS* GetCanvas() { return m_canvas; }
 
 std::vector<VIEWPORT3D> GetUserViewports() const;
 void SetUserViewports( std::vector<VIEWPORT3D>& aViewportList );
 
 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
 
 void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;
 
protected:
 void setupUIConditions() override;
 
 void handleIconizeEvent( wxIconizeEvent& aEvent ) override;
 
 void applyViewport( const wxString& aViewportName );
 
private:
 void Exit3DFrame( wxCommandEvent& event );
 
 void OnCloseWindow( wxCloseEvent& event );
 
 bool TryBefore( wxEvent& aEvent ) override;
 
 void Process_Special_Functions( wxCommandEvent& event );
 
 void onRenderEngineSelection( wxCommandEvent& event );
 void onDisableRayTracing( wxCommandEvent& aEvent );
 void onViewportChanged( wxCommandEvent& aEvent );
 void onUpdateViewportsCb( wxUpdateUIEvent& aEvent );
 
 void OnActivate( wxActivateEvent& event );
 void OnSetFocus( wxFocusEvent& event );
 void passOnFocus();
 
 void CreateMenuBar();
 void ReCreateMainToolbar();
 
 void takeScreenshot( wxCommandEvent& event );
 
 void RenderEngineChanged();
 
 void refreshRender();
 
 DECLARE_EVENT_TABLE()
 
 
 void loadCommonSettings();
 
private:
 wxFileName m_defaultSaveScreenshotFileName;
 
 ACTION_TOOLBAR* m_mainToolBar;
 wxStaticText* m_viewportsLabel;
 wxChoice* m_cbViewports;
 EDA_3D_CANVAS* m_canvas;
 BOARD_ADAPTER m_boardAdapter;
 CAMERA& m_currentCamera;
 TRACK_BALL m_trackBallCamera;
 
 bool m_disable_ray_tracing;
 
 NL_3D_VIEWER_PLUGIN* m_spaceMouse;
 
 std::map<wxString, VIEWPORT3D> m_viewports;
 VIEWPORT3D* m_lastSelectedViewport;
 wxArrayString m_viewportMRU;
 
 static const wxChar *m_logTrace;
 
};
 
#endif // EDA_3D_VIEWER_H