Implement a canvas based on a wxGLCanvas. More...

#include <eda_3d_model_viewer.h>

Inheritance diagram for EDA_3D_MODEL_VIEWER:

Public Member Functions
	EDA_3D_MODEL_VIEWER (wxWindow aParent, const wxGLAttributes &aGLAttribs, S3D_CACHE aCacheManager=nullptr)
	Create a new 3D Canvas with a attribute list.

	~EDA_3D_MODEL_VIEWER ()

void	Set3DModel (const S3DMODEL &a3DModel)
	Set this model to be displayed.

void	Set3DModel (const wxString &aModelPathName)
	Set this model to be displayed.

void	Clear3DModel ()
	Unload the displayed 3D model.

virtual wxSize	GetNativePixelSize () const

wxPoint	GetNativePosition (const wxPoint &aPoint) const
	Convert the given point from client coordinates to native pixel coordinates.

void	SetScaleFactor (double aFactor)
	Set the canvas scale factor, probably for a hi-DPI display.

double	GetScaleFactor () const
	Get the current scale factor.

void	SetVcSettings (const KIGFX::VC_SETTINGS &aVcSettings)

Protected Attributes
KIGFX::VC_SETTINGS	m_settings
	< Current VIEW_CONTROLS settings.

Private Member Functions
void	ogl_initialize ()

void	ogl_set_arrow_material ()

void	OnPaint (wxPaintEvent &event)

void	OnEraseBackground (wxEraseEvent &event)

void	OnMouseWheel (wxMouseEvent &event)

void	OnMouseMove (wxMouseEvent &event)

void	OnLeftDown (wxMouseEvent &event)

void	OnLeftUp (wxMouseEvent &event)

void	OnMiddleUp (wxMouseEvent &event)

void	OnMiddleDown (wxMouseEvent &event)

void	OnRightClick (wxMouseEvent &event)

Private Attributes
wxGLContext *	m_glRC
	openGL context

TRACK_BALL	m_trackBallCamera
	Camera used in this canvas.

const S3DMODEL *	m_3d_model
	Original 3d model data.

MODEL_3D *	m_ogl_3dmodel
	Class holder for 3d model to display on openGL.

bool	m_reload_is_needed
	Flag that we have a new model and it need to be reloaded when the paint is called.

bool	m_ogl_initialized
	Flag if open gl was initialized.

double	m_BiuTo3dUnits
	factor to convert the model or any other items to keep it in relation to the +/-RANGE_SCALE_3D (it is named same as the board render for better understanding proposes)

S3D_CACHE *	m_cacheManager
	Optional cache manager.

double	m_scale_factor
	The current scale factor (e.g.

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

Detailed Description

Implement a canvas based on a wxGLCanvas.

Definition at line 45 of file eda_3d_model_viewer.h.

Constructor & Destructor Documentation

◆ EDA_3D_MODEL_VIEWER()

EDA_3D_MODEL_VIEWER::EDA_3D_MODEL_VIEWER	(	wxWindow *	aParent,
		const wxGLAttributes &	aGLAttribs,
		S3D_CACHE *	aCacheManager = `nullptr`
	)

Create a new 3D Canvas with a attribute list.

Parameters

aParent	the parent creator of this canvas.
aGLAttribs	openGL attributes created by OGL_ATT_LIST::GetAttributesList.

Definition at line 88 of file eda_3d_model_viewer.cpp.

References PGM_BASE::GetCommonSettings(), m_3d_model, m_BiuTo3dUnits, m_glRC, m_logTrace, m_ogl_3dmodel, m_ogl_initialized, m_reload_is_needed, Pgm(), and HIDPI_GL_CANVAS::SetScaleFactor().

◆ ~EDA_3D_MODEL_VIEWER()

EDA_3D_MODEL_VIEWER::~EDA_3D_MODEL_VIEWER ( )

Definition at line 113 of file eda_3d_model_viewer.cpp.

References GL_CONTEXT_MANAGER::DestroyCtx(), GL_CONTEXT_MANAGER::Get(), GL_CONTEXT_MANAGER::LockCtx(), m_glRC, m_logTrace, m_ogl_3dmodel, and GL_CONTEXT_MANAGER::UnlockCtx().

Member Function Documentation

◆ Clear3DModel()

void EDA_3D_MODEL_VIEWER::Clear3DModel ( )

Unload the displayed 3D model.

Definition at line 173 of file eda_3d_model_viewer.cpp.

References m_3d_model, m_ogl_3dmodel, m_reload_is_needed, and Refresh().

Referenced by Set3DModel().

◆ GetNativePixelSize()

wxSize HIDPI_GL_CANVAS::GetNativePixelSize ( ) const

virtualinherited

Definition at line 43 of file hidpi_gl_canvas.cpp.

References HIDPI_GL_CANVAS::GetScaleFactor().

Referenced by EDA_3D_CANVAS::DoRePaint(), OnMouseMove(), HIDPI_GL_3D_CANVAS::OnMouseMoveCamera(), OnPaint(), and KIGFX::OPENGL_GAL::OPENGL_GAL().

◆ GetNativePosition()

wxPoint HIDPI_GL_CANVAS::GetNativePosition ( const wxPoint & aPoint ) const

inherited

Convert the given point from client coordinates to native pixel coordinates.

Definition at line 55 of file hidpi_gl_canvas.cpp.

References HIDPI_GL_CANVAS::GetScaleFactor().

Referenced by OnMouseMove(), HIDPI_GL_3D_CANVAS::OnMouseMoveCamera(), and HIDPI_GL_3D_CANVAS::OnMouseWheelCamera().

◆ GetScaleFactor()

double HIDPI_GL_CANVAS::GetScaleFactor ( ) const

inherited

Get the current scale factor.

Definition at line 73 of file hidpi_gl_canvas.cpp.

References HIDPI_GL_CANVAS::m_scale_factor.

Referenced by KIGFX::OPENGL_GAL::BeginDrawing(), KIGFX::OPENGL_GAL::DrawGrid(), KIGFX::PREVIEW::GetConstantGlyphHeight(), HIDPI_GL_CANVAS::GetNativePixelSize(), HIDPI_GL_CANVAS::GetNativePosition(), KIGFX::OPENGL_GAL::getScreenPixelSize(), KIGFX::OPENGL_GAL::ResizeScreen(), and KIGFX::OPENGL_GAL::updatedGalDisplayOptions().

◆ ogl_initialize()

void EDA_3D_MODEL_VIEWER::ogl_initialize ( )

private

Definition at line 187 of file eda_3d_model_viewer.cpp.

References From_UTF8(), m_logTrace, and RANGE_SCALE_3D.

Referenced by OnPaint().

◆ ogl_set_arrow_material()

void EDA_3D_MODEL_VIEWER::ogl_set_arrow_material ( )

private

Definition at line 233 of file eda_3d_model_viewer.cpp.

Referenced by OnPaint().

◆ OnEraseBackground()

void EDA_3D_MODEL_VIEWER::OnEraseBackground ( wxEraseEvent & event )

private

Definition at line 391 of file eda_3d_model_viewer.cpp.

References m_logTrace.

◆ OnLeftDown()

void EDA_3D_MODEL_VIEWER::OnLeftDown ( wxMouseEvent & event )

private

Definition at line 455 of file eda_3d_model_viewer.cpp.

◆ OnLeftUp()

void EDA_3D_MODEL_VIEWER::OnLeftUp ( wxMouseEvent & event )

private

Definition at line 461 of file eda_3d_model_viewer.cpp.

◆ OnMiddleDown()

void EDA_3D_MODEL_VIEWER::OnMiddleDown ( wxMouseEvent & event )

private

Definition at line 467 of file eda_3d_model_viewer.cpp.

◆ OnMiddleUp()

void EDA_3D_MODEL_VIEWER::OnMiddleUp ( wxMouseEvent & event )

private

Definition at line 473 of file eda_3d_model_viewer.cpp.

◆ OnMouseMove()

void EDA_3D_MODEL_VIEWER::OnMouseMove ( wxMouseEvent & event )

private

Definition at line 435 of file eda_3d_model_viewer.cpp.

References TRACK_BALL::Drag(), HIDPI_GL_CANVAS::GetNativePixelSize(), HIDPI_GL_CANVAS::GetNativePosition(), m_trackBallCamera, Refresh(), CAMERA::SetCurMousePosition(), and CAMERA::SetCurWindowSize().

◆ OnMouseWheel()

void EDA_3D_MODEL_VIEWER::OnMouseWheel ( wxMouseEvent & event )

private

Definition at line 398 of file eda_3d_model_viewer.cpp.

References m_logTrace, m_trackBallCamera, Refresh(), CAMERA::SetCurMousePosition(), and CAMERA::Zoom().

◆ OnPaint()

void EDA_3D_MODEL_VIEWER::OnPaint ( wxPaintEvent & event )

private

◆ OnRightClick()

void EDA_3D_MODEL_VIEWER::OnRightClick ( wxMouseEvent & event )

private

Definition at line 479 of file eda_3d_model_viewer.cpp.

◆ Set3DModel() [1/2]

void EDA_3D_MODEL_VIEWER::Set3DModel ( const S3DMODEL & a3DModel )

Set this model to be displayed.

Parameters

a3DModel 3D model data.

Definition at line 130 of file eda_3d_model_viewer.cpp.

References m_3d_model, m_logTrace, S3DMODEL::m_Materials, S3DMODEL::m_MaterialsSize, S3DMODEL::m_Meshes, S3DMODEL::m_MeshesSize, m_ogl_3dmodel, m_reload_is_needed, and Refresh().

Referenced by DIALOG_SELECT_3DMODEL::OnFileActivated(), DIALOG_SELECT_3DMODEL::OnSelectionChanged(), and Set3DModel().

◆ Set3DModel() [2/2]

void EDA_3D_MODEL_VIEWER::Set3DModel ( const wxString & aModelPathName )

Set this model to be displayed.

Parameters

aModelPathName 3D model path name.

Definition at line 157 of file eda_3d_model_viewer.cpp.

References Clear3DModel(), S3D_CACHE::GetModel(), m_cacheManager, m_logTrace, and Set3DModel().

◆ SetScaleFactor()

void HIDPI_GL_CANVAS::SetScaleFactor ( double aFactor )

inherited

Set the canvas scale factor, probably for a hi-DPI display.

Definition at line 67 of file hidpi_gl_canvas.cpp.

References HIDPI_GL_CANVAS::m_scale_factor.

Referenced by EDA_3D_MODEL_VIEWER(), EDA_3D_VIEWER_FRAME::loadCommonSettings(), PANEL_PREVIEW_3D_MODEL::loadSettings(), and KIGFX::OPENGL_GAL::updatedGalDisplayOptions().

◆ SetVcSettings()

void HIDPI_GL_CANVAS::SetVcSettings ( const KIGFX::VC_SETTINGS & aVcSettings )

inlineinherited

Definition at line 67 of file hidpi_gl_canvas.h.

Referenced by EDA_3D_VIEWER_FRAME::applySettings().

Member Data Documentation

◆ m_3d_model

const S3DMODEL* EDA_3D_MODEL_VIEWER::m_3d_model

private

Original 3d model data.

Definition at line 113 of file eda_3d_model_viewer.h.

Referenced by Clear3DModel(), EDA_3D_MODEL_VIEWER(), OnPaint(), and Set3DModel().

◆ m_BiuTo3dUnits

double EDA_3D_MODEL_VIEWER::m_BiuTo3dUnits

private

factor to convert the model or any other items to keep it in relation to the +/-RANGE_SCALE_3D (it is named same as the board render for better understanding proposes)

Definition at line 127 of file eda_3d_model_viewer.h.

Referenced by EDA_3D_MODEL_VIEWER(), and OnPaint().

◆ m_cacheManager

S3D_CACHE* EDA_3D_MODEL_VIEWER::m_cacheManager

private

Optional cache manager.

Definition at line 130 of file eda_3d_model_viewer.h.

Referenced by Set3DModel().

◆ m_glRC

wxGLContext* EDA_3D_MODEL_VIEWER::m_glRC

private

openGL context

Definition at line 107 of file eda_3d_model_viewer.h.

Referenced by EDA_3D_MODEL_VIEWER(), OnPaint(), and ~EDA_3D_MODEL_VIEWER().

◆ m_ogl_3dmodel

MODEL_3D* EDA_3D_MODEL_VIEWER::m_ogl_3dmodel

private

Class holder for 3d model to display on openGL.

Definition at line 116 of file eda_3d_model_viewer.h.

Referenced by Clear3DModel(), EDA_3D_MODEL_VIEWER(), OnPaint(), Set3DModel(), and ~EDA_3D_MODEL_VIEWER().

◆ m_ogl_initialized

bool EDA_3D_MODEL_VIEWER::m_ogl_initialized

private

Flag if open gl was initialized.

Definition at line 122 of file eda_3d_model_viewer.h.

Referenced by EDA_3D_MODEL_VIEWER(), and OnPaint().

◆ m_reload_is_needed

bool EDA_3D_MODEL_VIEWER::m_reload_is_needed

private

Flag that we have a new model and it need to be reloaded when the paint is called.

Definition at line 119 of file eda_3d_model_viewer.h.

Referenced by Clear3DModel(), EDA_3D_MODEL_VIEWER(), OnPaint(), and Set3DModel().

◆ m_scale_factor

double HIDPI_GL_CANVAS::m_scale_factor

privateinherited

The current scale factor (e.g.

for hi-DPI displays)

Definition at line 77 of file hidpi_gl_canvas.h.

Referenced by HIDPI_GL_CANVAS::GetScaleFactor(), and HIDPI_GL_CANVAS::SetScaleFactor().

◆ m_settings

KIGFX::VC_SETTINGS HIDPI_GL_CANVAS::m_settings

protectedinherited

< Current VIEW_CONTROLS settings.

Definition at line 71 of file hidpi_gl_canvas.h.

Referenced by HIDPI_GL_3D_CANVAS::OnMouseWheelCamera().

◆ m_trackBallCamera

TRACK_BALL EDA_3D_MODEL_VIEWER::m_trackBallCamera

private

Camera used in this canvas.

Definition at line 110 of file eda_3d_model_viewer.h.

Referenced by OnMouseMove(), OnMouseWheel(), and OnPaint().

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

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EDA_3D_MODEL_VIEWER()

◆ ~EDA_3D_MODEL_VIEWER()

Member Function Documentation

◆ Clear3DModel()

◆ GetNativePixelSize()

◆ GetNativePosition()

◆ GetScaleFactor()

◆ ogl_initialize()

◆ ogl_set_arrow_material()

◆ OnEraseBackground()

◆ OnLeftDown()

◆ OnLeftUp()

◆ OnMiddleDown()

◆ OnMiddleUp()

◆ OnMouseMove()

◆ OnMouseWheel()

◆ OnPaint()

◆ OnRightClick()

◆ Set3DModel() [1/2]

◆ Set3DModel() [2/2]

◆ SetScaleFactor()

◆ SetVcSettings()

Member Data Documentation

◆ m_3d_model

◆ m_BiuTo3dUnits

◆ m_cacheManager

◆ m_glRC

◆ m_ogl_3dmodel

◆ m_ogl_initialized

◆ m_reload_is_needed

◆ m_scale_factor

◆ m_settings

◆ m_trackBallCamera