panel_preview_3d_model.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2016 Mario Luzeiro <[email protected]>
 * Copyright (C) 2015 Cirilo Bernardo <[email protected]>
 * 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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef PANEL_PREVIEW_3D_MODEL_H
#define PANEL_PREVIEW_3D_MODEL_H
 
#include "panel_preview_3d_model_base.h"
 
#include <vector>
#include <widgets/unit_binder.h>
#include <tool/tools_holder.h>
#include <3d_canvas/eda_3d_canvas.h>
#include <3d_viewer_id.h>
#include <3d_model_align.h>
#include <3d_rendering/track_ball.h>
#include <wx/event.h>
#include <wx/timer.h>
#include <array>
#include <limits>
#include <map>
#include <math/vector3.h>
 
// Define min and max parameter values
#define MAX_SCALE          10000.0
#define MAX_ROTATION       180.0
#define MAX_OFFSET         1000.0
 
#define SCALE_INCREMENT_FINE       0.02
#define SCALE_INCREMENT            0.1
 
#define ROTATION_INCREMENT 90      // in degrees
#define ROTATION_INCREMENT_FINE 1  // in degrees
 
#define OFFSET_INCREMENT_MM        0.5
#define OFFSET_INCREMENT_MM_FINE   0.1
 
#define OFFSET_INCREMENT_MIL       25.0
#define OFFSET_INCREMENT_MIL_FINE  5.0
 
wxDECLARE_EVENT( wxCUSTOM_PANEL_SHOWN_EVENT, wxCommandEvent );
 
// Declared classes to create pointers
class WX_INFOBAR;
class S3D_CACHE;
class FILENAME_RESOLVER;
class EMBEDDED_FILES;
class BOARD;
class BOARD_ADAPTER;
class FOOTPRINT;
class EXTRUDED_3D_BODY;
#if defined(__linux__) || defined(__FreeBSD__)
class SPNAV_VIEWER_PLUGIN;
#else
class NL_FOOTPRINT_PROPERTIES_PLUGIN;
#endif
 
#define PANEL_PREVIEW_3D_MODEL_ID  wxID_HIGHEST + 1244
 
class PANEL_PREVIEW_3D_MODEL: public TOOLS_HOLDER, public PANEL_PREVIEW_3D_MODEL_BASE
{
public:
    PANEL_PREVIEW_3D_MODEL( wxWindow* aParent, PCB_BASE_FRAME* aFrame, FOOTPRINT* aFootprint,
                            std::vector<FP_3DMODEL>* aParentModelList );
 
    ~PANEL_PREVIEW_3D_MODEL();

    void OnMenuEvent( wxMenuEvent& aEvent );
 
    wxWindow* GetToolCanvas() const override { return m_previewPane; }
 
    BOARD_ADAPTER& GetAdapter() { return m_boardAdapter; }
    CAMERA& GetCurrentCamera() { return m_currentCamera; }

    void SetSelectedModel( int idx );

    void UpdateDummyFootprint( bool aRelaodRequired = true );
 
    void SetEmbeddedFilesDelegate( EMBEDDED_FILES* aDelegate );

    FOOTPRINT* GetDummyFootprint() const { return m_dummyFootprint; }
 
    void SetExtrusionTransformMode( EXTRUDED_3D_BODY* aBody );
 
private:
    enum class ALIGN_STATE { IDLE, PICK_MODEL, PICK_FOOTPRINT, SOLVED };
 
    void onAlign( wxCommandEvent& aEvent ) override;
    void onAlignUpdateUI( wxUpdateUIEvent& aEvent ) override;
    void onAlignKey( wxKeyEvent& aEvent );
    void onAlignAnimation( wxTimerEvent& aEvent );
    void tickAlignmentAnimation();
    bool canAlign() const;
    bool pickAlignment( const RAY& aRay );
    void hoverAlignment( const std::optional<RAY>& aRay );
    const S3DMODEL* alignmentModel();
    void dismissAlignmentInfoBar();
    void cancelAlignment();
    void restoreAlignmentView();
    void stopPicking();
    void refreshAlignmentView();
    void applyAlignment();

    std::optional<size_t> alignmentRegionAt( const RAY& aRay );

    std::vector<SFVEC3F> alignmentRegionTriangles( size_t aRegion ) const;

    std::vector<SFVEC3F> alignmentPadTriangles( const PAD& aPad ) const;

    glm::mat4 alignmentModelMatrix() const;

    void updateAlignmentOverlays();

    void startAlignmentAnimation( const VECTOR3D& aRotation, const VECTOR3D& aOffset );
    void stopAlignmentAnimation();

    void loadSettings();

    void updateOrientation( wxCommandEvent& event ) override;
 
    void onMouseWheelScale( wxMouseEvent& event ) override;
    void onMouseWheelRot( wxMouseEvent& event ) override;
    void onMouseWheelOffset( wxMouseEvent& event ) override;
 
    void onIncrementRot( wxSpinEvent& event ) override
    {
        doIncrementRotation( event, 1.0 );
    }
    void onDecrementRot( wxSpinEvent& event ) override
    {
        doIncrementRotation( event, -1.0 );
    }
    void onIncrementScale( wxSpinEvent& event ) override
    {
        doIncrementScale( event, 1.0 );
    }
    void onDecrementScale( wxSpinEvent& event ) override
    {
        doIncrementScale( event, -1.0 );
    }
    void onIncrementOffset( wxSpinEvent& event ) override
    {
        doIncrementOffset( event, 1.0 );
    }
    void onDecrementOffset( wxSpinEvent& event ) override
    {
        doIncrementOffset( event, -1.0 );
    }
 
    void onOpacitySlider( wxCommandEvent& event ) override;
 
    void doIncrementScale( wxSpinEvent& aEvent, double aSign );
    void doIncrementRotation( wxSpinEvent& aEvent, double aSign );
    void doIncrementOffset( wxSpinEvent& aEvent, double aSign );
 
    void onUnitsChanged( wxCommandEvent& aEvent );
    void onPanelShownEvent( wxCommandEvent& aEvent );
 
    wxString formatScaleValue( double aValue );
    wxString formatRotationValue( double aValue );
    wxString formatOffsetValue( double aValue );
 
    void evalRotationValue( TEXT_CTRL_EVAL* aRotationControl );
 
    void View3DISO( wxCommandEvent& event ) override
    {
        m_currentCamera.ToggleProjection();
        m_previewPane->Refresh();
    }
 
    // turn ON or OFF options to show the board body. If OFF, solder paste, soldermask
    // and board body are hidden, to allows a good view of the 3D model and its pads.
    // Useful for 3D model placement
    void setBodyStyleView( wxCommandEvent& event ) override;
 
    void View3DLeft( wxCommandEvent& event ) override
    {
        m_previewPane->SetView3D( VIEW3D_TYPE::VIEW3D_LEFT );
    }
 
    void View3DFront( wxCommandEvent& event ) override
    {
        m_previewPane->SetView3D( VIEW3D_TYPE::VIEW3D_FRONT );
    }
 
    void View3DTop( wxCommandEvent& event ) override
    {
        m_previewPane->SetView3D( VIEW3D_TYPE::VIEW3D_TOP );
    }
 
    void View3DUpdate( wxCommandEvent& event ) override
    {
        cancelAlignment();
        m_previewPane->ReloadRequest();
        m_previewPane->Refresh();
    }
 
    void View3DSettings( wxCommandEvent& event ) override;
 
    void View3DRight( wxCommandEvent& event ) override
    {
        m_previewPane->SetView3D( VIEW3D_TYPE::VIEW3D_RIGHT );
    }
 
    void View3DBack( wxCommandEvent& event ) override
    {
        m_previewPane->SetView3D( VIEW3D_TYPE::VIEW3D_BACK );
    }
 
    void View3DBottom( wxCommandEvent& event ) override
    {
        m_previewPane->SetView3D( VIEW3D_TYPE::VIEW3D_BOTTOM );
    }
 
    void onModify();
    
    void syncLocalEmbeddedFiles();
 
private:
    PCB_BASE_FRAME*          m_parentFrame;
    EDA_3D_CANVAS*           m_previewPane;
    WX_INFOBAR*              m_infobar;
    WX_INFOBAR*              m_alignmentInfoBar;
    BOARD_ADAPTER            m_boardAdapter;
    CAMERA&                  m_currentCamera;
    TRACK_BALL               m_trackBallCamera;
 
    BOARD*                   m_dummyBoard;
    FOOTPRINT*               m_dummyFootprint;
 
    std::vector<FP_3DMODEL>* m_parentModelList;
    int                      m_selected;            
 
    ALIGN_STATE m_alignState = ALIGN_STATE::IDLE;
    bool m_alignUpdating = false;
    std::optional<std::bitset<LAYER_3D_END>> m_alignLayers;
    std::optional<bool> m_alignBodyShown;
    std::vector<MODEL_ALIGN::REGION> m_alignRegions;
    std::vector<MODEL_ALIGN::ALIGN_SOLUTION> m_alignSolutions;
    const S3DMODEL* m_alignGeometry = nullptr;
    std::map<std::array<unsigned int, 2>, size_t> m_alignTriangleRegions;
    size_t m_alignSeed = 0;
    size_t m_alignSolution = 0;
 
    std::vector<SFVEC3F> m_alignFaceTriangles;  
    std::optional<size_t> m_alignHoverRegion;
    const PAD* m_alignHoverPad = nullptr;
 
    wxTimer  m_alignAnimTimer;
    int64_t  m_alignAnimStart = 0;
    VECTOR3D m_alignAnimFromRotation;
    VECTOR3D m_alignAnimFromOffset;
    VECTOR3D m_alignAnimRotation;
    VECTOR3D m_alignAnimOffset;
    bool     m_alignAnimating = false;
    size_t   m_dummySelectedModel = std::numeric_limits<size_t>::max();  
 
    EDA_UNITS                m_userUnits;
    EXTRUDED_3D_BODY*        m_extrudedBody = nullptr;
    EMBEDDED_FILES*          m_localEmbeddedFiles = nullptr;

    EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS          m_initialRender;
 
#if defined(__linux__) || defined(__FreeBSD__)
    std::unique_ptr<SPNAV_VIEWER_PLUGIN> m_spaceMouse;
#else
    std::unique_ptr<NL_FOOTPRINT_PROPERTIES_PLUGIN>  m_spaceMouse;
#endif
};
 
#endif  // PANEL_PREVIEW_3D_MODEL_H