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 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 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 ) = 0;

    void ReloadRequest() { m_reloadRequested = true; }

    bool IsReloadRequestPending() const { return m_reloadRequested; }

    virtual int GetWaitForEditingTimeOut() = 0;

    virtual void JoinBgWorker() {}

    virtual void StopBgWorker() {}

    void SetBusyIndicatorFactory( BUSY_INDICATOR::FACTORY aNewFactory );

    void SetReporters( std::shared_ptr<REPORTER> aActivityReporter, std::shared_ptr<REPORTER> aWarningReporter )
    {
        m_activityReporter = aActivityReporter;
        m_warningReporter = aWarningReporter;
    }
 
protected:
    std::unique_ptr<BUSY_INDICATOR> CreateBusyIndicator() const;

    BOARD_ADAPTER& m_boardAdapter;
 
    CAMERA&        m_camera;

    bool m_canvasInitialized;

    bool m_reloadRequested;

    wxSize m_windowSize;
 
    std::shared_ptr<REPORTER> m_activityReporter;
    std::shared_ptr<REPORTER> m_warningReporter;

    static const wxChar* m_logTrace;
 
private:
    BUSY_INDICATOR::FACTORY m_busyIndicatorFactory;
};
 
#endif // RENDER_3D_BASE_H