KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Attributes | List of all members
RENDER_3D_BASE Class Referenceabstract

This is a base class to hold data and functions for render targets. More...

#include <render_3d_base.h>

Inheritance diagram for RENDER_3D_BASE:
RENDER_3D_OPENGL RENDER_3D_RAYTRACE_BASE RENDER_3D_RAYTRACE_GL RENDER_3D_RAYTRACE_RAM

Public Member Functions

 RENDER_3D_BASE (BOARD_ADAPTER &aBoardAdapter, CAMERA &aCamera)
 
virtual ~RENDER_3D_BASE ()=0
 
virtual void SetCurWindowSize (const wxSize &aSize)=0
 Before each render, the canvas will tell the render what is the size of its windows, so render can take actions if it changed.
 
virtual bool Redraw (bool aIsMoving)=0
 Redraw the view.
 
void ReloadRequest ()
 
bool IsReloadRequestPending () const
 Query if there is a pending reload request.
 
virtual int GetWaitForEditingTimeOut ()=0
 Give the interface the time (in ms) that it should wait for editing or movements before (this works for display preview mode).
 
virtual void JoinBgWorker ()
 Block until any in-progress background loading has finished.
 
virtual void StopBgWorker ()
 Request stop and join any in-progress background loading.
 
void SetBusyIndicatorFactory (BUSY_INDICATOR::FACTORY aNewFactory)
 Set a new busy indicator factory.
 
void SetReporters (std::shared_ptr< REPORTER > aActivityReporter, std::shared_ptr< REPORTER > aWarningReporter)
 Set the reporters for activity and warning messages.
 

Protected Member Functions

std::unique_ptr< BUSY_INDICATOR > CreateBusyIndicator () const
 Return a created busy indicator, if a factory has been set, else a null pointer.
 

Protected Attributes

BOARD_ADAPTER & m_boardAdapter
 Settings reference in use for this render.
 
CAMERA & m_camera
 
bool m_canvasInitialized
 Flag if the canvas specific for this render was already initialized.
 
bool m_reloadRequested
 
wxSize m_windowSize
 The window size that this camera is working.
 
std::shared_ptr< REPORTER > m_activityReporter
 
std::shared_ptr< REPORTER > m_warningReporter
 

Static Protected Attributes

static const wxChar * m_logTrace = wxT( "KI_TRACE_3D_RENDER" )
 Trace mask used to enable or disable the trace output of this class.
 

Private Attributes

BUSY_INDICATOR::FACTORY m_busyIndicatorFactory
 Factory that returns a suitable busy indicator for the context.
 

Detailed Description

This is a base class to hold data and functions for render targets.

Definition at line 38 of file render_3d_base.h.

Constructor & Destructor Documentation

◆ RENDER_3D_BASE()

RENDER_3D_BASE::RENDER_3D_BASE ( BOARD_ADAPTER & aBoardAdapter,
CAMERA & aCamera )
explicit

Definition at line 43 of file render_3d_base.cpp.

References m_boardAdapter, m_camera, m_canvasInitialized, m_logTrace, m_reloadRequested, and m_windowSize.

Referenced by RENDER_3D_OPENGL::RENDER_3D_OPENGL(), and RENDER_3D_RAYTRACE_BASE::RENDER_3D_RAYTRACE_BASE().

◆ ~RENDER_3D_BASE()

RENDER_3D_BASE::~RENDER_3D_BASE ( )
pure virtual

Definition at line 54 of file render_3d_base.cpp.

Member Function Documentation

◆ CreateBusyIndicator()

std::unique_ptr< BUSY_INDICATOR > RENDER_3D_BASE::CreateBusyIndicator ( ) const
protected

Return a created busy indicator, if a factory has been set, else a null pointer.

Definition at line 65 of file render_3d_base.cpp.

References m_busyIndicatorFactory.

Referenced by RENDER_3D_OPENGL::Redraw(), RENDER_3D_RAYTRACE_GL::Redraw(), and RENDER_3D_RAYTRACE_RAM::Redraw().

◆ GetWaitForEditingTimeOut()

virtual int RENDER_3D_BASE::GetWaitForEditingTimeOut ( )
pure virtual

Give the interface the time (in ms) that it should wait for editing or movements before (this works for display preview mode).

Returns
a value in milliseconds

Implemented in RENDER_3D_OPENGL, and RENDER_3D_RAYTRACE_BASE.

◆ IsReloadRequestPending()

bool RENDER_3D_BASE::IsReloadRequestPending ( ) const
inline

Query if there is a pending reload request.

Returns
true if it wants to reload, false if there is no reload pending

Definition at line 71 of file render_3d_base.h.

References m_reloadRequested.

◆ JoinBgWorker()

virtual void RENDER_3D_BASE::JoinBgWorker ( )
inlinevirtual

Block until any in-progress background loading has finished.

Reimplemented in RENDER_3D_OPENGL.

Definition at line 84 of file render_3d_base.h.

◆ Redraw()

virtual bool RENDER_3D_BASE::Redraw ( bool aIsMoving)
pure virtual

Redraw the view.

Parameters
aIsMovingif the user is moving the scene, it should be render in preview mode.
Returns
true if the render would like to redraw again.

Implemented in RENDER_3D_OPENGL, RENDER_3D_RAYTRACE_GL, and RENDER_3D_RAYTRACE_RAM.

◆ ReloadRequest()

void RENDER_3D_BASE::ReloadRequest ( )
inline
Todo
This must be reviewed to add flags to improve specific render.

Definition at line 64 of file render_3d_base.h.

References m_reloadRequested.

◆ SetBusyIndicatorFactory()

void RENDER_3D_BASE::SetBusyIndicatorFactory ( BUSY_INDICATOR::FACTORY aNewFactory)

Set a new busy indicator factory.

When set, this factory will be used to generate busy indicators when suitable. If not set, no busy indicator will be used.

Definition at line 59 of file render_3d_base.cpp.

References m_busyIndicatorFactory.

◆ SetCurWindowSize()

virtual void RENDER_3D_BASE::SetCurWindowSize ( const wxSize & aSize)
pure virtual

Before each render, the canvas will tell the render what is the size of its windows, so render can take actions if it changed.

Parameters
aSizethe current size of the render window

Implemented in RENDER_3D_OPENGL, RENDER_3D_RAYTRACE_GL, and RENDER_3D_RAYTRACE_RAM.

◆ SetReporters()

void RENDER_3D_BASE::SetReporters ( std::shared_ptr< REPORTER > aActivityReporter,
std::shared_ptr< REPORTER > aWarningReporter )
inline

Set the reporters for activity and warning messages.

Parameters
aActivityReportera shared pointer to the activity reporter.
aWarningReportera shared pointer to the warning reporter.

Definition at line 105 of file render_3d_base.h.

References m_activityReporter, and m_warningReporter.

Referenced by PCBNEW_JOBS_HANDLER::JobExportRender().

◆ StopBgWorker()

virtual void RENDER_3D_BASE::StopBgWorker ( )
inlinevirtual

Request stop and join any in-progress background loading.

Reimplemented in RENDER_3D_OPENGL.

Definition at line 89 of file render_3d_base.h.

Member Data Documentation

◆ m_activityReporter

std::shared_ptr<REPORTER> RENDER_3D_BASE::m_activityReporter
protected

Definition at line 131 of file render_3d_base.h.

Referenced by RENDER_3D_OPENGL::bgWorker(), RENDER_3D_OPENGL::load3dModels(), RENDER_3D_RAYTRACE_BASE::postProcessShading(), RENDER_3D_OPENGL::Redraw(), RENDER_3D_RAYTRACE_GL::Redraw(), RENDER_3D_RAYTRACE_RAM::Redraw(), RENDER_3D_RAYTRACE_BASE::Reload(), RENDER_3D_OPENGL::reload(), RENDER_3D_RAYTRACE_BASE::render(), RENDER_3D_RAYTRACE_BASE::renderTracing(), SetReporters(), and RENDER_3D_OPENGL::StopBgWorker().

◆ m_boardAdapter

BOARD_ADAPTER& RENDER_3D_BASE::m_boardAdapter
protected

Settings reference in use for this render.

Definition at line 118 of file render_3d_base.h.

Referenced by RENDER_3D_RAYTRACE_BASE::addCounterborePlating(), RENDER_3D_RAYTRACE_BASE::addCountersinkPlating(), RENDER_3D_RAYTRACE_BASE::addExtrudedBodyToRaytracer(), RENDER_3D_RAYTRACE_BASE::addModels(), RENDER_3D_OPENGL::addObjectTriangles(), RENDER_3D_RAYTRACE_BASE::addPadsAndVias(), RENDER_3D_OPENGL::appendPostMachiningGeometry(), RENDER_3D_OPENGL::backfillPostMachine(), RENDER_3D_RAYTRACE_BASE::backfillPostMachine(), RENDER_3D_OPENGL::bgWorker(), RENDER_3D_OPENGL::createBoard(), RENDER_3D_RAYTRACE_BASE::createItemsFromContainer(), RENDER_3D_OPENGL::generate3dGrid(), RENDER_3D_OPENGL::generateHoles(), RENDER_3D_OPENGL::generateLayerList(), RENDER_3D_OPENGL::generatePlatedHoleShells(), RENDER_3D_OPENGL::generateViaBarrels(), RENDER_3D_OPENGL::generateViaCovers(), RENDER_3D_OPENGL::generateViasAndPads(), RENDER_3D_OPENGL::get3dModelsFromFootprint(), RENDER_3D_OPENGL::get3dModelsSelected(), RENDER_3D_OPENGL::getLayerZPos(), RENDER_3D_RAYTRACE_BASE::getModelMaterial(), RENDER_3D_RAYTRACE_BASE::insertHole(), RENDER_3D_RAYTRACE_BASE::insertHole(), RENDER_3D_RAYTRACE_BASE::load3DModels(), RENDER_3D_OPENGL::load3dModels(), RENDER_3D_RAYTRACE_BASE::postProcessBlurFinish(), RENDER_3D_RAYTRACE_BASE::postProcessShading(), RENDER_3D_OPENGL::Redraw(), RENDER_3D_RAYTRACE_GL::Redraw(), RENDER_3D_RAYTRACE_BASE::Reload(), RENDER_3D_OPENGL::reload(), RENDER_3D_RAYTRACE_BASE::render(), RENDER_3D_BASE(), RENDER_3D_RAYTRACE_BASE::renderAntiAliasPackets(), RENDER_3D_RAYTRACE_BASE::renderBlockTracing(), RENDER_3D_OPENGL::renderBoardBody(), RENDER_3D_OPENGL::renderExtrudedBodies(), RENDER_3D_OPENGL::renderExtrudedBodies(), RENDER_3D_OPENGL::renderModel(), RENDER_3D_OPENGL::renderOpaqueModels(), RENDER_3D_OPENGL::renderPlaceholderForFootprint(), RENDER_3D_RAYTRACE_BASE::renderPreview(), RENDER_3D_OPENGL::renderSolderMaskLayer(), RENDER_3D_RAYTRACE_BASE::renderTracing(), RENDER_3D_OPENGL::renderTransparentModels(), RENDER_3D_OPENGL::setLayerMaterial(), RENDER_3D_OPENGL::setupMaterials(), RENDER_3D_RAYTRACE_BASE::setupMaterials(), and RENDER_3D_RAYTRACE_BASE::shadeHit().

◆ m_busyIndicatorFactory

BUSY_INDICATOR::FACTORY RENDER_3D_BASE::m_busyIndicatorFactory
private

Factory that returns a suitable busy indicator for the context.

Definition at line 144 of file render_3d_base.h.

Referenced by CreateBusyIndicator(), and SetBusyIndicatorFactory().

◆ m_camera

CAMERA& RENDER_3D_BASE::m_camera
protected

Definition at line 120 of file render_3d_base.h.

Referenced by RENDER_3D_OPENGL::Redraw(), RENDER_3D_RAYTRACE_GL::Redraw(), RENDER_3D_RAYTRACE_RAM::Redraw(), RENDER_3D_RAYTRACE_BASE::Reload(), RENDER_3D_OPENGL::reload(), RENDER_3D_RAYTRACE_BASE::render(), RENDER_3D_BASE(), RENDER_3D_RAYTRACE_BASE::renderBlockTracing(), RENDER_3D_RAYTRACE_BASE::renderPreview(), and RENDER_3D_OPENGL::renderTransparentModels().

◆ m_canvasInitialized

bool RENDER_3D_BASE::m_canvasInitialized
protected

Flag if the canvas specific for this render was already initialized.

Definition at line 123 of file render_3d_base.h.

Referenced by RENDER_3D_OPENGL::freeAllLists(), RENDER_3D_OPENGL::initializeOpenGL(), RENDER_3D_OPENGL::Redraw(), RENDER_3D_RAYTRACE_GL::Redraw(), RENDER_3D_RAYTRACE_RAM::Redraw(), RENDER_3D_BASE(), and RENDER_3D_OPENGL::~RENDER_3D_OPENGL().

◆ m_reloadRequested

bool RENDER_3D_BASE::m_reloadRequested
protected
Todo
This must be reviewed in order to flag change types.

Definition at line 126 of file render_3d_base.h.

Referenced by IsReloadRequestPending(), RENDER_3D_OPENGL::Redraw(), RENDER_3D_RAYTRACE_GL::Redraw(), RENDER_3D_RAYTRACE_RAM::Redraw(), RENDER_3D_RAYTRACE_BASE::Reload(), RENDER_3D_OPENGL::reload(), ReloadRequest(), and RENDER_3D_BASE().

◆ m_warningReporter

std::shared_ptr<REPORTER> RENDER_3D_BASE::m_warningReporter
protected

Definition at line 132 of file render_3d_base.h.

Referenced by RENDER_3D_RAYTRACE_BASE::Reload(), RENDER_3D_OPENGL::reload(), and SetReporters().

◆ m_windowSize

wxSize RENDER_3D_BASE::m_windowSize
protected

The window size that this camera is working.

Definition at line 129 of file render_3d_base.h.

Referenced by RENDER_3D_RAYTRACE_BASE::initializeBlockPositions(), RENDER_3D_OPENGL::Redraw(), RENDER_3D_RAYTRACE_GL::Redraw(), RENDER_3D_RAYTRACE_RAM::Redraw(), RENDER_3D_BASE(), RENDER_3D_RAYTRACE_BASE::renderBlockTracing(), RENDER_3D_RAYTRACE_BASE::renderPreview(), RENDER_3D_OPENGL::SetCurWindowSize(), RENDER_3D_RAYTRACE_GL::SetCurWindowSize(), and RENDER_3D_RAYTRACE_RAM::SetCurWindowSize().

The documentation for this class was generated from the following files: