render_3d_base.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) 1992-2024 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 RENDER_3D_BASE_H
#define RENDER_3D_BASE_H
 
 
#include <pcb_base_frame.h>
#include "3d_canvas/board_adapter.h"
#include <reporter.h>
 
#include <widgets/busy_indicator.h>
 
class RENDER_3D_BASE
{
public:
    explicit RENDER_3D_BASE( BOARD_ADAPTER& aBoardAdapter, CAMERA& aCamera );
 
    virtual ~RENDER_3D_BASE() = 0;
 
    virtual void SetCurWindowSize( const wxSize& aSize ) = 0;
 
    virtual bool Redraw( bool aIsMoving, REPORTER* aStatusReporter = nullptr,
                         REPORTER* aWarningReporter = nullptr ) = 0;
 
    void ReloadRequest() { m_reloadRequested = true; }
 
    bool IsReloadRequestPending() const { return m_reloadRequested; }
 
    virtual int GetWaitForEditingTimeOut() = 0;
 
    void SetBusyIndicatorFactory( BUSY_INDICATOR::FACTORY aNewFactory );
 
protected:
    std::unique_ptr<BUSY_INDICATOR> CreateBusyIndicator() const;
 
    BOARD_ADAPTER& m_boardAdapter;
 
    CAMERA&        m_camera;
 
    bool m_canvasInitialized;
 
    bool m_reloadRequested;
 
    wxSize m_windowSize;
 
    static const wxChar* m_logTrace;
 
private:
    BUSY_INDICATOR::FACTORY m_busyIndicatorFactory;
};
 
#endif // RENDER_3D_BASE_H