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

#include <eda_3d_canvas.h>

Inheritance diagram for EDA_3D_CANVAS:

Public Member Functions
	EDA_3D_CANVAS (wxWindow aParent, const int aAttribList, BOARD_ADAPTER &aSettings, CAMERA &aCamera, S3D_CACHE *a3DCachePointer)
	Create a new 3D Canvas with an attribute list. More...

	~EDA_3D_CANVAS ()

void	SetEventDispatcher (TOOL_DISPATCHER *aEventDispatcher)
	Set a dispatcher that processes events and forwards them to tools. More...

void	SetStatusBar (wxStatusBar *aStatusBar)

void	SetInfoBar (WX_INFOBAR *aInfoBar)

void	ReloadRequest (BOARD aBoard=nullptr, S3D_CACHE aCachePointer=nullptr)

bool	IsReloadRequestPending () const
	Query if there is a pending reload request. More...

RENDER_3D_BASE *	GetCurrentRender () const

void	RenderRaytracingRequest ()
	Request to render the current view in Raytracing mode. More...

void	GetScreenshot (wxImage &aDstImage)
	Request a screenshot and output it to the aDstImage. More...

bool	SetView3D (int aKeycode)
	Helper function to call view commands. More...

void	SetAnimationEnabled (bool aEnable)
	Enable or disable camera animation when switching to a pre-defined view. More...

bool	GetAnimationEnabled () const

void	SetMovingSpeedMultiplier (int aMultiplier)
	Set the camera animation moving speed multiplier option. More...

int	GetMovingSpeedMultiplier () const

int	GetProjectionMode () const

void	SetProjectionMode (int aMode)

void	RenderEngineChanged ()
	Notify that the render engine was changed. More...

void	DisplayStatus ()
	Update the status bar with the position information. More...

void	Request_refresh (bool aRedrawImmediately=true)
	Schedule a refresh update of the canvas. More...

void	OnEvent (wxEvent &aEvent)
	Used to forward events to the canvas from popups, etc. More...

const BOARD_ADAPTER &	GetBoardAdapter () const
	Get information used to display 3D board. More...

bool	GetRenderPivot ()
	Get a value indicating whether to render the pivot. More...

void	SetRenderPivot (bool aValue)
	Set aValue indicating whether to render the pivot. More...

bool	GetRender3dmousePivot ()
	Get a value indicating whether to render the 3dmouse pivot. More...

void	SetRender3dmousePivot (bool aValue)
	Set aValue indicating whether to render the 3dmouse pivot. More...

void	Set3dmousePivotPos (const SFVEC3F &aPos)
	Set the position of the the 3dmouse pivot. More...

CAMERA *	GetCamera ()
	Get the canvas camera. More...

void	OnMouseMoveCamera (wxMouseEvent &event)

void	OnMouseWheelCamera (wxMouseEvent &event, bool aPan)

virtual wxSize	GetNativePixelSize () const

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

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

double	GetScaleFactor () const
	Get the current scale factor. More...

Public Attributes
bool	m_mouse_is_moving

bool	m_mouse_was_moved

bool	m_camera_is_moving

CAMERA &	m_camera

Static Public Attributes
static const float	m_delta_move_step_factor = 0.7f

Private Member Functions
void	OnPaint (wxPaintEvent &aEvent)
	Called by a wxPaintEvent event. More...

void	DoRePaint ()
	The actual function to repaint the canvas. More...

void	OnEraseBackground (wxEraseEvent &event)

void	OnRefreshRequest (wxEvent &aEvent)

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	OnTimerTimeout_Editing (wxTimerEvent &event)

void	OnCloseWindow (wxCloseEvent &event)

void	OnResize (wxSizeEvent &event)

void	OnTimerTimeout_Redraw (wxTimerEvent &event)

void	stop_editingTimeOut_Timer ()
	Stop the editing time so it will not timeout. More...

void	restart_editingTimeOut_Timer ()
	Reset the editing timer. More...

void	request_start_moving_camera (float aMovingSpeed=2.0f, bool aRenderPivot=true)
	Start a camera movement. More...

void	move_pivot_based_on_cur_mouse_position ()
	This function hits a ray to the board and start a movement. More...

void	render_pivot (float t, float aScale)
	Render the pivot cursor. More...

void	render3dmousePivot (float aScale)
	Render the 3dmouse pivot cursor. More...

bool	initializeOpenGL ()

void	releaseOpenGL ()
	Free created targets and openGL context. More...

RAY	getRayAtCurrentMousePosition ()

Private Attributes
TOOL_DISPATCHER *	m_eventDispatcher

wxStatusBar *	m_parentStatusBar

WX_INFOBAR *	m_parentInfoBar

wxGLContext *	m_glRC

bool	m_is_opengl_initialized

bool	m_is_opengl_version_supported

wxTimer	m_editing_timeout_timer

wxTimer	m_redraw_trigger_timer

std::atomic_flag	m_is_currently_painting

bool	m_render_pivot

float	m_camera_moving_speed

unsigned	m_strtime_camera_movement

bool	m_animation_enabled

int	m_moving_speed_multiplier

BOARD_ADAPTER &	m_boardAdapter

RENDER_3D_BASE *	m_3d_render

RENDER_3D_RAYTRACE *	m_3d_render_raytracing

RENDER_3D_OPENGL *	m_3d_render_opengl

bool	m_opengl_supports_raytracing

bool	m_render_raytracing_was_requested

ACCELERATOR_3D *	m_accelerator3DShapes

BOARD_ITEM *	m_currentRollOverItem

bool	m_render3dmousePivot = false

SFVEC3F	m_3dmousePivotPos

double	m_scale_factor
	The current scale factor (e.g. More...

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

Detailed Description

Implement a canvas based on a wxGLCanvas.

Definition at line 48 of file eda_3d_canvas.h.

Constructor & Destructor Documentation

◆ EDA_3D_CANVAS()

EDA_3D_CANVAS::EDA_3D_CANVAS	(	wxWindow *	aParent,
		const int *	aAttribList,
		BOARD_ADAPTER &	aSettings,
		CAMERA &	aCamera,
		S3D_CACHE *	a3DCachePointer
	)

Create a new 3D Canvas with an attribute list.

Parameters

aParent	the parent creator of this canvas.
aAttribList	a list of openGL options created by GetOpenGL_AttributesList.
aBoard	The board.
aSettings	the settings options to be used by this canvas.

Definition at line 88 of file eda_3d_canvas.cpp.

References OnEvent(), OnTimerTimeout_Editing(), and OnTimerTimeout_Redraw().

◆ ~EDA_3D_CANVAS()

EDA_3D_CANVAS::~EDA_3D_CANVAS ( )

Definition at line 170 of file eda_3d_canvas.cpp.

References m_accelerator3DShapes, m_logTrace, and releaseOpenGL().

Member Function Documentation

◆ DisplayStatus()

void EDA_3D_CANVAS::DisplayStatus ( )

Update the status bar with the position information.

Definition at line 327 of file eda_3d_canvas.cpp.

References CAMERA::GetCameraPos(), HIDPI_GL_3D_CANVAS::m_camera, and m_parentStatusBar.

Referenced by DoRePaint(), EDA_3D_CONTROLLER::doZoomInOut(), OnMouseMove(), OnMouseWheel(), request_start_moving_camera(), SetView3D(), and EDA_3D_CONTROLLER::ZoomFitScreen().

◆ DoRePaint()

void EDA_3D_CANVAS::DoRePaint ( )

private

The actual function to repaint the canvas.

It is usually called by OnPaint() but because it does not use a wxPaintDC it can be called outside a wxPaintEvent

Definition at line 349 of file eda_3d_canvas.cpp.

References _, GL_CONTEXT_MANAGER::CreateCtx(), DisplayStatus(), EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::engine, INFOBAR_REPORTER::Finalize(), GL_CONTEXT_MANAGER::Get(), ADVANCED_CFG::GetCfg(), HIDPI_GL_CANVAS::GetNativePixelSize(), GetRunningMicroSecs(), CAMERA::GetZoom(), STATUSBAR_REPORTER::HasMessage(), initializeOpenGL(), CAMERA::Interpolate(), RENDER_3D_BASE::IsReloadRequestPending(), GL_CONTEXT_MANAGER::LockCtx(), m_3d_render, m_3d_render_opengl, m_3d_render_raytracing, m_boardAdapter, HIDPI_GL_3D_CANVAS::m_camera, HIDPI_GL_3D_CANVAS::m_camera_is_moving, m_camera_moving_speed, BOARD_ADAPTER::m_Cfg, m_glRC, m_is_currently_painting, m_is_opengl_initialized, m_is_opengl_version_supported, m_logTrace, HIDPI_GL_3D_CANVAS::m_mouse_is_moving, HIDPI_GL_3D_CANVAS::m_mouse_was_moved, m_opengl_supports_raytracing, m_parentInfoBar, m_parentStatusBar, EDA_3D_VIEWER_SETTINGS::m_Render, m_render3dmousePivot, m_render_pivot, m_render_raytracing_was_requested, m_strtime_camera_movement, CAMERA::ParametersChanged(), RENDER_3D_BASE::Redraw(), RENDER_3D_RAYTRACE::Reload(), render3dmousePivot(), render_pivot(), STATUSBAR_REPORTER::Report(), INFOBAR_REPORTER::Report(), Request_refresh(), restart_editingTimeOut_Timer(), RPT_SEVERITY_ERROR, scale, CAMERA::SetCurWindowSize(), RENDER_3D_BASE::SetCurWindowSize(), and GL_CONTEXT_MANAGER::UnlockCtx().

Referenced by OnPaint(), and OnRefreshRequest().

◆ GetAnimationEnabled()

bool EDA_3D_CANVAS::GetAnimationEnabled ( ) const

inline

Definition at line 128 of file eda_3d_canvas.h.

References m_animation_enabled.

Referenced by EDA_3D_VIEWER_FRAME::SaveSettings().

◆ GetBoardAdapter()

const BOARD_ADAPTER & EDA_3D_CANVAS::GetBoardAdapter ( ) const

inline

Get information used to display 3D board.

Definition at line 167 of file eda_3d_canvas.h.

References m_boardAdapter.

Referenced by NL_3D_VIEWER_PLUGIN_IMPL::GetHitLookAt(), and NL_3D_VIEWER_PLUGIN_IMPL::GetModelExtents().

◆ GetCamera()

CAMERA * HIDPI_GL_3D_CANVAS::GetCamera ( )

inlineinherited

Get the canvas camera.

Definition at line 66 of file hidpi_gl_3D_canvas.h.

References HIDPI_GL_3D_CANVAS::m_camera.

Referenced by NL_3D_VIEWER_PLUGIN_IMPL::NL_3D_VIEWER_PLUGIN_IMPL().

◆ GetCurrentRender()

RENDER_3D_BASE * EDA_3D_CANVAS::GetCurrentRender ( ) const

inline

Returns: the current render ( a RENDER_3D_RAYTRACE* or a RENDER_3D_OPENGL* render )

Definition at line 102 of file eda_3d_canvas.h.

References m_3d_render.

Referenced by EDA_3D_CONTROLLER::ToggleVisibility().

◆ GetMovingSpeedMultiplier()

int EDA_3D_CANVAS::GetMovingSpeedMultiplier ( ) const

inline

Definition at line 136 of file eda_3d_canvas.h.

References m_moving_speed_multiplier.

Referenced by EDA_3D_VIEWER_FRAME::SaveSettings().

◆ GetNativePixelSize()

wxSize HIDPI_GL_CANVAS::GetNativePixelSize ( ) const

virtualinherited

Definition at line 41 of file hidpi_gl_canvas.cpp.

References HIDPI_GL_CANVAS::GetScaleFactor().

Referenced by DoRePaint(), EDA_3D_MODEL_VIEWER::OnMouseMove(), HIDPI_GL_3D_CANVAS::OnMouseMoveCamera(), EDA_3D_MODEL_VIEWER::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 53 of file hidpi_gl_canvas.cpp.

References HIDPI_GL_CANVAS::GetScaleFactor().

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

◆ GetProjectionMode()

int EDA_3D_CANVAS::GetProjectionMode ( ) const

inline

Definition at line 138 of file eda_3d_canvas.h.

References CAMERA::GetProjection(), and HIDPI_GL_3D_CANVAS::m_camera.

Referenced by EDA_3D_VIEWER_FRAME::SaveSettings().

◆ getRayAtCurrentMousePosition()

RAY EDA_3D_CANVAS::getRayAtCurrentMousePosition ( )

private

Definition at line 1102 of file eda_3d_canvas.cpp.

References RAY::Init(), HIDPI_GL_3D_CANVAS::m_camera, and CAMERA::MakeRayAtCurrentMousePosition().

Referenced by move_pivot_based_on_cur_mouse_position(), OnLeftDown(), and OnMouseMove().

◆ GetRender3dmousePivot()

bool EDA_3D_CANVAS::GetRender3dmousePivot ( )

inline

Get a value indicating whether to render the 3dmouse pivot.

Definition at line 184 of file eda_3d_canvas.h.

References m_render3dmousePivot.

Referenced by NL_3D_VIEWER_PLUGIN_IMPL::GetPivotVisible().

◆ GetRenderPivot()

bool EDA_3D_CANVAS::GetRenderPivot ( )

inline

Get a value indicating whether to render the pivot.

Definition at line 172 of file eda_3d_canvas.h.

References m_render_pivot.

◆ GetScaleFactor()

double HIDPI_GL_CANVAS::GetScaleFactor ( ) const

inherited

Get the current scale factor.

Definition at line 71 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().

◆ GetScreenshot()

void EDA_3D_CANVAS::GetScreenshot ( wxImage & aDstImage )

Request a screenshot and output it to the aDstImage.

Parameters

aDstImage - Screenshot destination image

Definition at line 293 of file eda_3d_canvas.cpp.

References OglGetScreenshot().

Referenced by EDA_3D_VIEWER_FRAME::takeScreenshot().

◆ initializeOpenGL()

bool EDA_3D_CANVAS::initializeOpenGL ( )

private

Returns: true if OpenGL initialization succeeded.

Definition at line 217 of file eda_3d_canvas.cpp.

References FROM_UTF8(), ID_DISABLE_RAY_TRACING, m_is_opengl_initialized, m_is_opengl_version_supported, m_logTrace, m_opengl_supports_raytracing, and GL_UTILS::SetSwapInterval().

Referenced by DoRePaint().

◆ IsReloadRequestPending()

bool EDA_3D_CANVAS::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 91 of file eda_3d_canvas.h.

References RENDER_3D_BASE::IsReloadRequestPending(), and m_3d_render.

Referenced by EDA_3D_VIEWER_FRAME::OnActivate().

◆ move_pivot_based_on_cur_mouse_position()

void EDA_3D_CANVAS::move_pivot_based_on_cur_mouse_position ( )

private

This function hits a ray to the board and start a movement.

Definition at line 900 of file eda_3d_canvas.cpp.

References RAY::at(), BOARD_ADAPTER::GetBBox(), getRayAtCurrentMousePosition(), BBOX_3D::Intersect(), m_boardAdapter, HIDPI_GL_3D_CANVAS::m_camera, request_start_moving_camera(), CAMERA::ResetXYpos_T1(), CAMERA::SetInterpolateMode(), CAMERA::SetLookAtPos_T1(), and CAMERA::SetT0_and_T1_current_T().

Referenced by OnMiddleUp(), and SetView3D().

◆ OnCloseWindow()

void EDA_3D_CANVAS::OnCloseWindow ( wxCloseEvent & event )

private

Definition at line 203 of file eda_3d_canvas.cpp.

References releaseOpenGL().

◆ OnEraseBackground()

void EDA_3D_CANVAS::OnEraseBackground ( wxEraseEvent & event )

private

Definition at line 595 of file eda_3d_canvas.cpp.

References m_logTrace.

◆ OnEvent()

void EDA_3D_CANVAS::OnEvent ( wxEvent & aEvent )

Used to forward events to the canvas from popups, etc.

Definition at line 584 of file eda_3d_canvas.cpp.

References TOOL_DISPATCHER::DispatchWxEvent(), m_eventDispatcher, and Refresh().

Referenced by EDA_3D_CANVAS().

◆ OnLeftDown()

void EDA_3D_CANVAS::OnLeftDown ( wxMouseEvent & event )

private

Definition at line 751 of file eda_3d_canvas.cpp.

References getRayAtCurrentMousePosition(), RENDER_3D_RAYTRACE::IntersectBoardItem(), m_3d_render_raytracing, and stop_editingTimeOut_Timer().

◆ OnLeftUp()

void EDA_3D_CANVAS::OnLeftUp ( wxMouseEvent & event )

private

Definition at line 767 of file eda_3d_canvas.cpp.

References HIDPI_GL_3D_CANVAS::m_camera_is_moving, HIDPI_GL_3D_CANVAS::m_mouse_is_moving, and restart_editingTimeOut_Timer().

◆ OnMiddleDown()

void EDA_3D_CANVAS::OnMiddleDown ( wxMouseEvent & event )

private

Definition at line 780 of file eda_3d_canvas.cpp.

References stop_editingTimeOut_Timer().

◆ OnMiddleUp()

void EDA_3D_CANVAS::OnMiddleUp ( wxMouseEvent & event )

private

Definition at line 787 of file eda_3d_canvas.cpp.

References HIDPI_GL_3D_CANVAS::m_camera_is_moving, HIDPI_GL_3D_CANVAS::m_mouse_is_moving, move_pivot_based_on_cur_mouse_position(), and restart_editingTimeOut_Timer().

◆ OnMouseMove()

void EDA_3D_CANVAS::OnMouseMove ( wxMouseEvent & event )

private

◆ OnMouseMoveCamera()

void HIDPI_GL_3D_CANVAS::OnMouseMoveCamera ( wxMouseEvent & event )

inherited

Definition at line 43 of file hidpi_gl_3D_canvas.cpp.

References CAMERA::Drag(), HIDPI_GL_CANVAS::GetNativePixelSize(), HIDPI_GL_CANVAS::GetNativePosition(), HIDPI_GL_3D_CANVAS::m_camera, HIDPI_GL_3D_CANVAS::m_camera_is_moving, HIDPI_GL_3D_CANVAS::m_mouse_is_moving, HIDPI_GL_3D_CANVAS::m_mouse_was_moved, CAMERA::Pan(), CAMERA::SetCurMousePosition(), and CAMERA::SetCurWindowSize().

Referenced by OnMouseMove().

◆ OnMouseWheel()

void EDA_3D_CANVAS::OnMouseWheel ( wxMouseEvent & event )

private

Definition at line 602 of file eda_3d_canvas.cpp.

References DisplayStatus(), m_boardAdapter, m_logTrace, HIDPI_GL_3D_CANVAS::m_mouse_was_moved, BOARD_ADAPTER::m_MousewheelPanning, HIDPI_GL_3D_CANVAS::OnMouseWheelCamera(), Request_refresh(), and restart_editingTimeOut_Timer().

◆ OnMouseWheelCamera()

void HIDPI_GL_3D_CANVAS::OnMouseWheelCamera	(	wxMouseEvent &	event,
		bool	aPan
	)

inherited

Definition at line 67 of file hidpi_gl_3D_canvas.cpp.

References HIDPI_GL_CANVAS::GetNativePosition(), CAMERA::GetZoom(), HIDPI_GL_3D_CANVAS::m_camera, HIDPI_GL_3D_CANVAS::m_camera_is_moving, HIDPI_GL_3D_CANVAS::m_delta_move_step_factor, HIDPI_GL_3D_CANVAS::m_mouse_is_moving, HIDPI_GL_3D_CANVAS::m_mouse_was_moved, CAMERA::Pan(), CAMERA::SetCurMousePosition(), and CAMERA::Zoom().

Referenced by OnMouseWheel().

◆ OnPaint()

void EDA_3D_CANVAS::OnPaint ( wxPaintEvent & aEvent )

private

Called by a wxPaintEvent event.

Definition at line 342 of file eda_3d_canvas.cpp.

References DoRePaint().

◆ OnRefreshRequest()

void EDA_3D_CANVAS::OnRefreshRequest ( wxEvent & aEvent )

private

Definition at line 844 of file eda_3d_canvas.cpp.

References DoRePaint().

◆ OnResize()

void EDA_3D_CANVAS::OnResize ( wxSizeEvent & event )

private

Definition at line 211 of file eda_3d_canvas.cpp.

References Request_refresh().

◆ OnTimerTimeout_Editing()

void EDA_3D_CANVAS::OnTimerTimeout_Editing ( wxTimerEvent & event )

private

Definition at line 804 of file eda_3d_canvas.cpp.

References m_editing_timeout_timer, HIDPI_GL_3D_CANVAS::m_mouse_is_moving, HIDPI_GL_3D_CANVAS::m_mouse_was_moved, and Request_refresh().

Referenced by EDA_3D_CANVAS().

◆ OnTimerTimeout_Redraw()

void EDA_3D_CANVAS::OnTimerTimeout_Redraw ( wxTimerEvent & event )

private

Definition at line 832 of file eda_3d_canvas.cpp.

References m_redraw_trigger_timer, and Request_refresh().

Referenced by EDA_3D_CANVAS().

◆ releaseOpenGL()

void EDA_3D_CANVAS::releaseOpenGL ( )

private

Free created targets and openGL context.

Definition at line 181 of file eda_3d_canvas.cpp.

References GL_CONTEXT_MANAGER::DestroyCtx(), GL_CONTEXT_MANAGER::Get(), GL_CONTEXT_MANAGER::LockCtx(), m_3d_render, m_3d_render_opengl, m_3d_render_raytracing, m_glRC, and GL_CONTEXT_MANAGER::UnlockCtx().

Referenced by OnCloseWindow(), and ~EDA_3D_CANVAS().

◆ ReloadRequest()

void EDA_3D_CANVAS::ReloadRequest	(	BOARD *	aBoard = `nullptr`,
		S3D_CACHE *	aCachePointer = `nullptr`
	)

Definition at line 299 of file eda_3d_canvas.cpp.

References m_3d_render, m_boardAdapter, BOARD_ADAPTER::ReloadColorSettings(), RENDER_3D_BASE::ReloadRequest(), BOARD_ADAPTER::Set3dCacheManager(), and BOARD_ADAPTER::SetBoard().

Referenced by EDA_3D_VIEWER_FRAME::ReloadRequest(), PANEL_PREVIEW_3D_MODEL::UpdateDummyFootprint(), and PANEL_PREVIEW_3D_MODEL::View3DUpdate().

◆ render3dmousePivot()

void EDA_3D_CANVAS::render3dmousePivot ( float aScale )

private

Render the 3dmouse pivot cursor.

Parameters

aScale scale to apply on the cursor.

Definition at line 123 of file eda_3d_canvas_pivot.cpp.

References CAMERA::GetProjectionMatrix(), CAMERA::GetViewMatrix(), m_3dmousePivotPos, and HIDPI_GL_3D_CANVAS::m_camera.

Referenced by DoRePaint().

◆ render_pivot()

void EDA_3D_CANVAS::render_pivot	(	float	t,
		float	aScale
	)

private

Render the pivot cursor.

Parameters

t	time between 0.0 and 1.0.
aScale	scale to apply on the cursor.

Definition at line 76 of file eda_3d_canvas_pivot.cpp.

References CAMERA::GetLookAtPos_T1(), CAMERA::GetProjectionMatrix(), CAMERA::GetViewMatrix(), HIDPI_GL_3D_CANVAS::m_camera, and pivot_render_triangles().

Referenced by DoRePaint().

◆ RenderEngineChanged()

void EDA_3D_CANVAS::RenderEngineChanged ( )

Notify that the render engine was changed.

Definition at line 1081 of file eda_3d_canvas.cpp.

References EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::engine, SETTINGS_MANAGER::GetAppSettings(), m_3d_render, m_3d_render_opengl, m_3d_render_raytracing, HIDPI_GL_3D_CANVAS::m_mouse_was_moved, EDA_3D_VIEWER_SETTINGS::m_Render, Pgm(), RENDER_3D_BASE::ReloadRequest(), and Request_refresh().

Referenced by EDA_3D_VIEWER_FRAME::RenderEngineChanged().

◆ RenderRaytracingRequest()

void EDA_3D_CANVAS::RenderRaytracingRequest ( )

Request to render the current view in Raytracing mode.

Definition at line 314 of file eda_3d_canvas.cpp.

References m_3d_render, m_3d_render_raytracing, m_render_raytracing_was_requested, RENDER_3D_BASE::ReloadRequest(), and Request_refresh().

Referenced by EDA_3D_VIEWER_FRAME::applyViewport(), EDA_3D_CONTROLLER::RotateView(), EDA_3D_CONTROLLER::ToggleOrtho(), and EDA_3D_CONTROLLER::ToggleVisibility().

◆ Request_refresh()

void EDA_3D_CANVAS::Request_refresh ( bool aRedrawImmediately = true )

Schedule a refresh update of the canvas.

Parameters

aRedrawImmediately true will request a redraw, false will schedule a redraw after a short timeout.

Definition at line 850 of file eda_3d_canvas.cpp.

References ID_CUSTOM_EVENT_1, and m_redraw_trigger_timer.

Referenced by EDA_3D_VIEWER_FRAME::applyViewport(), DoRePaint(), EDA_3D_CONTROLLER::On3DGridSelection(), EDA_3D_VIEWER_FRAME::OnActivate(), OnMouseMove(), OnMouseWheel(), OnResize(), OnTimerTimeout_Editing(), OnTimerTimeout_Redraw(), EDA_3D_VIEWER_FRAME::Redraw(), EDA_3D_VIEWER_FRAME::refreshRender(), RenderEngineChanged(), RenderRaytracingRequest(), request_start_moving_camera(), EDA_3D_CONTROLLER::RotateView(), NL_3D_VIEWER_PLUGIN_IMPL::SetActiveCommand(), EDA_3D_CONTROLLER::SetMaterial(), NL_3D_VIEWER_PLUGIN_IMPL::SetPivotPosition(), NL_3D_VIEWER_PLUGIN_IMPL::SetPivotVisible(), NL_3D_VIEWER_PLUGIN_IMPL::SetTransaction(), SetView3D(), EDA_3D_VIEWER_FRAME::takeScreenshot(), EDA_3D_CONTROLLER::ToggleOrtho(), EDA_3D_CONTROLLER::ToggleVisibility(), PANEL_PREVIEW_3D_MODEL::UpdateDummyFootprint(), and EDA_3D_CONTROLLER::ZoomRedraw().

◆ request_start_moving_camera()

void EDA_3D_CANVAS::request_start_moving_camera	(	float	aMovingSpeed = `2.0f`,
		bool	aRenderPivot = `true`
	)

private

Start a camera movement.

Parameters

aMovingSpeed	the time speed.
aRenderPivot	if it should display pivot cursor while move.

Definition at line 869 of file eda_3d_canvas.cpp.

References DisplayStatus(), GetRunningMicroSecs(), CAMERA::Interpolate(), m_animation_enabled, HIDPI_GL_3D_CANVAS::m_camera, HIDPI_GL_3D_CANVAS::m_camera_is_moving, m_camera_moving_speed, m_moving_speed_multiplier, m_render_pivot, m_strtime_camera_movement, Request_refresh(), and stop_editingTimeOut_Timer().

Referenced by move_pivot_based_on_cur_mouse_position(), and SetView3D().

◆ restart_editingTimeOut_Timer()

void EDA_3D_CANVAS::restart_editingTimeOut_Timer ( )

private

Reset the editing timer.

Definition at line 825 of file eda_3d_canvas.cpp.

References RENDER_3D_BASE::GetWaitForEditingTimeOut(), m_3d_render, and m_editing_timeout_timer.

Referenced by DoRePaint(), OnLeftUp(), OnMiddleUp(), OnMouseWheel(), and SetView3D().

◆ Set3dmousePivotPos()

void EDA_3D_CANVAS::Set3dmousePivotPos ( const SFVEC3F & aPos )

inline

Set the position of the the 3dmouse pivot.

Parameters

aPos	is the position of the 3dmouse rotation pivot

Definition at line 206 of file eda_3d_canvas.h.

References m_3dmousePivotPos.

Referenced by NL_3D_VIEWER_PLUGIN_IMPL::SetPivotPosition().

◆ SetAnimationEnabled()

void EDA_3D_CANVAS::SetAnimationEnabled ( bool aEnable )

inline

Enable or disable camera animation when switching to a pre-defined view.

Definition at line 127 of file eda_3d_canvas.h.

References m_animation_enabled.

Referenced by PANEL_PREVIEW_3D_MODEL::loadSettings(), and EDA_3D_VIEWER_FRAME::LoadSettings().

◆ SetEventDispatcher()

void EDA_3D_CANVAS::SetEventDispatcher ( TOOL_DISPATCHER * aEventDispatcher )

Set a dispatcher that processes events and forwards them to tools.

#DRAW_PANEL_GAL does not take over the ownership. Passing NULL disconnects all event handlers from the DRAW_PANEL_GAL and parent frame.

Parameters

aEventDispatcher is the object that will be used for dispatching events.

Definition at line 578 of file eda_3d_canvas.cpp.

References m_eventDispatcher.

Referenced by PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), and EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME().

◆ SetInfoBar()

void EDA_3D_CANVAS::SetInfoBar ( WX_INFOBAR * aInfoBar )

inline

Definition at line 79 of file eda_3d_canvas.h.

References m_parentInfoBar.

Referenced by PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL().

◆ SetMovingSpeedMultiplier()

void EDA_3D_CANVAS::SetMovingSpeedMultiplier ( int aMultiplier )

inline

Set the camera animation moving speed multiplier option.

Parameters

aMultiplier one of the possible integer options: [1,2,3,4,5].

Definition at line 135 of file eda_3d_canvas.h.

References m_moving_speed_multiplier.

Referenced by PANEL_PREVIEW_3D_MODEL::loadSettings(), and EDA_3D_VIEWER_FRAME::LoadSettings().

◆ SetProjectionMode()

void EDA_3D_CANVAS::SetProjectionMode ( int aMode )

inline

Definition at line 139 of file eda_3d_canvas.h.

References HIDPI_GL_3D_CANVAS::m_camera, and CAMERA::SetProjection().

Referenced by PANEL_PREVIEW_3D_MODEL::loadSettings(), and EDA_3D_VIEWER_FRAME::LoadSettings().

◆ SetRender3dmousePivot()

void EDA_3D_CANVAS::SetRender3dmousePivot ( bool aValue )

inline

Set aValue indicating whether to render the 3dmouse pivot.

Parameters

aValue true will cause the pivot to be rendered on the next redraw.

Definition at line 195 of file eda_3d_canvas.h.

References m_render3dmousePivot.

Referenced by NL_3D_VIEWER_PLUGIN_IMPL::SetPivotVisible().

◆ SetRenderPivot()

void EDA_3D_CANVAS::SetRenderPivot ( bool aValue )

inline

Set aValue indicating whether to render the pivot.

Parameters

aValue true will cause the pivot to be rendered on the next redraw.

Definition at line 179 of file eda_3d_canvas.h.

References m_render_pivot.

◆ SetScaleFactor()

void HIDPI_GL_CANVAS::SetScaleFactor ( double aFactor )

inherited

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

Definition at line 65 of file hidpi_gl_canvas.cpp.

References HIDPI_GL_CANVAS::m_scale_factor.

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

◆ SetStatusBar()

void EDA_3D_CANVAS::SetStatusBar ( wxStatusBar * aStatusBar )

inline

Definition at line 74 of file eda_3d_canvas.h.

References m_parentStatusBar.

◆ SetView3D()

bool EDA_3D_CANVAS::SetView3D ( int aKeycode )

Helper function to call view commands.

Parameters

aKeycode ascii key commands.

Returns: true if the key code was handled, false if no command found for this code.

Definition at line 919 of file eda_3d_canvas.cpp.

References DisplayStatus(), CAMERA::GetZoom(), ID_VIEW3D_BACK, ID_VIEW3D_BOTTOM, ID_VIEW3D_FLIP, ID_VIEW3D_FRONT, ID_VIEW3D_LEFT, ID_VIEW3D_RESET, ID_VIEW3D_RIGHT, ID_VIEW3D_TOP, HIDPI_GL_3D_CANVAS::m_camera, HIDPI_GL_3D_CANVAS::m_camera_is_moving, HIDPI_GL_3D_CANVAS::m_delta_move_step_factor, HIDPI_GL_3D_CANVAS::m_mouse_was_moved, move_pivot_based_on_cur_mouse_position(), CAMERA::Pan_T1(), Request_refresh(), request_start_moving_camera(), CAMERA::Reset_T1(), restart_editingTimeOut_Timer(), CAMERA::RotateX_T1(), CAMERA::RotateY_T1(), CAMERA::RotateZ_T1(), CAMERA::SetInterpolateMode(), CAMERA::SetT0_and_T1_current_T(), and CAMERA::Zoom_T1().

Referenced by EDA_3D_CONTROLLER::doZoomInOut(), EDA_3D_CONTROLLER::PanControl(), PANEL_PREVIEW_3D_MODEL::View3DBack(), PANEL_PREVIEW_3D_MODEL::View3DBottom(), PANEL_PREVIEW_3D_MODEL::View3DFront(), PANEL_PREVIEW_3D_MODEL::View3DLeft(), PANEL_PREVIEW_3D_MODEL::View3DRight(), PANEL_PREVIEW_3D_MODEL::View3DTop(), EDA_3D_CONTROLLER::ViewControl(), and EDA_3D_CONTROLLER::ZoomFitScreen().

◆ stop_editingTimeOut_Timer()

void EDA_3D_CANVAS::stop_editingTimeOut_Timer ( )

private

Stop the editing time so it will not timeout.

Definition at line 819 of file eda_3d_canvas.cpp.

References m_editing_timeout_timer.

Referenced by OnLeftDown(), OnMiddleDown(), and request_start_moving_camera().

Member Data Documentation

◆ m_3d_render

RENDER_3D_BASE* EDA_3D_CANVAS::m_3d_render

private

Definition at line 318 of file eda_3d_canvas.h.

Referenced by DoRePaint(), GetCurrentRender(), IsReloadRequestPending(), releaseOpenGL(), ReloadRequest(), RenderEngineChanged(), RenderRaytracingRequest(), and restart_editingTimeOut_Timer().

◆ m_3d_render_opengl

RENDER_3D_OPENGL* EDA_3D_CANVAS::m_3d_render_opengl

private

Definition at line 320 of file eda_3d_canvas.h.

Referenced by DoRePaint(), OnMouseMove(), releaseOpenGL(), and RenderEngineChanged().

◆ m_3d_render_raytracing

RENDER_3D_RAYTRACE* EDA_3D_CANVAS::m_3d_render_raytracing

private

Definition at line 319 of file eda_3d_canvas.h.

Referenced by DoRePaint(), OnLeftDown(), OnMouseMove(), releaseOpenGL(), RenderEngineChanged(), and RenderRaytracingRequest().

◆ m_3dmousePivotPos

SFVEC3F EDA_3D_CANVAS::m_3dmousePivotPos

private

Definition at line 330 of file eda_3d_canvas.h.

Referenced by render3dmousePivot(), and Set3dmousePivotPos().

◆ m_accelerator3DShapes

ACCELERATOR_3D* EDA_3D_CANVAS::m_accelerator3DShapes

private

Definition at line 325 of file eda_3d_canvas.h.

Referenced by ~EDA_3D_CANVAS().

◆ m_animation_enabled

bool EDA_3D_CANVAS::m_animation_enabled

private

Definition at line 314 of file eda_3d_canvas.h.

Referenced by GetAnimationEnabled(), request_start_moving_camera(), and SetAnimationEnabled().

◆ m_boardAdapter

BOARD_ADAPTER& EDA_3D_CANVAS::m_boardAdapter

private

Definition at line 317 of file eda_3d_canvas.h.

Referenced by DoRePaint(), GetBoardAdapter(), move_pivot_based_on_cur_mouse_position(), OnMouseMove(), OnMouseWheel(), and ReloadRequest().

◆ m_camera

CAMERA& HIDPI_GL_3D_CANVAS::m_camera

inherited

Definition at line 59 of file hidpi_gl_3D_canvas.h.

Referenced by DisplayStatus(), DoRePaint(), HIDPI_GL_3D_CANVAS::GetCamera(), GetProjectionMode(), getRayAtCurrentMousePosition(), move_pivot_based_on_cur_mouse_position(), HIDPI_GL_3D_CANVAS::OnMouseMoveCamera(), HIDPI_GL_3D_CANVAS::OnMouseWheelCamera(), render3dmousePivot(), render_pivot(), request_start_moving_camera(), SetProjectionMode(), and SetView3D().

◆ m_camera_is_moving

bool HIDPI_GL_3D_CANVAS::m_camera_is_moving

inherited

Definition at line 57 of file hidpi_gl_3D_canvas.h.

Referenced by DoRePaint(), OnLeftUp(), OnMiddleUp(), OnMouseMove(), HIDPI_GL_3D_CANVAS::OnMouseMoveCamera(), HIDPI_GL_3D_CANVAS::OnMouseWheelCamera(), request_start_moving_camera(), and SetView3D().

◆ m_camera_moving_speed

float EDA_3D_CANVAS::m_camera_moving_speed

private

Definition at line 312 of file eda_3d_canvas.h.

Referenced by DoRePaint(), and request_start_moving_camera().

◆ m_currentRollOverItem

BOARD_ITEM* EDA_3D_CANVAS::m_currentRollOverItem

private

Definition at line 327 of file eda_3d_canvas.h.

Referenced by OnMouseMove().

◆ m_delta_move_step_factor

const float HIDPI_GL_3D_CANVAS::m_delta_move_step_factor = 0.7f

staticinherited

Definition at line 60 of file hidpi_gl_3D_canvas.h.

Referenced by HIDPI_GL_3D_CANVAS::OnMouseWheelCamera(), and SetView3D().

◆ m_editing_timeout_timer

wxTimer EDA_3D_CANVAS::m_editing_timeout_timer

private

Definition at line 306 of file eda_3d_canvas.h.

Referenced by OnTimerTimeout_Editing(), restart_editingTimeOut_Timer(), and stop_editingTimeOut_Timer().

◆ m_eventDispatcher

TOOL_DISPATCHER* EDA_3D_CANVAS::m_eventDispatcher

private

Definition at line 298 of file eda_3d_canvas.h.

Referenced by OnEvent(), and SetEventDispatcher().

◆ m_glRC

wxGLContext* EDA_3D_CANVAS::m_glRC

private

Definition at line 302 of file eda_3d_canvas.h.

Referenced by DoRePaint(), and releaseOpenGL().

◆ m_is_currently_painting

std::atomic_flag EDA_3D_CANVAS::m_is_currently_painting

private

Definition at line 309 of file eda_3d_canvas.h.

Referenced by DoRePaint().

◆ m_is_opengl_initialized

bool EDA_3D_CANVAS::m_is_opengl_initialized

private

Definition at line 303 of file eda_3d_canvas.h.

Referenced by DoRePaint(), and initializeOpenGL().

◆ m_is_opengl_version_supported

bool EDA_3D_CANVAS::m_is_opengl_version_supported

private

Definition at line 304 of file eda_3d_canvas.h.

Referenced by DoRePaint(), and initializeOpenGL().

◆ m_mouse_is_moving

bool HIDPI_GL_3D_CANVAS::m_mouse_is_moving

inherited

Definition at line 55 of file hidpi_gl_3D_canvas.h.

Referenced by DoRePaint(), OnLeftUp(), OnMiddleUp(), HIDPI_GL_3D_CANVAS::OnMouseMoveCamera(), HIDPI_GL_3D_CANVAS::OnMouseWheelCamera(), and OnTimerTimeout_Editing().

◆ m_mouse_was_moved

bool HIDPI_GL_3D_CANVAS::m_mouse_was_moved

inherited

Definition at line 56 of file hidpi_gl_3D_canvas.h.

Referenced by DoRePaint(), OnMouseMove(), HIDPI_GL_3D_CANVAS::OnMouseMoveCamera(), OnMouseWheel(), HIDPI_GL_3D_CANVAS::OnMouseWheelCamera(), OnTimerTimeout_Editing(), RenderEngineChanged(), and SetView3D().

◆ m_moving_speed_multiplier

int EDA_3D_CANVAS::m_moving_speed_multiplier

private

Definition at line 315 of file eda_3d_canvas.h.

Referenced by GetMovingSpeedMultiplier(), request_start_moving_camera(), and SetMovingSpeedMultiplier().

◆ m_opengl_supports_raytracing

bool EDA_3D_CANVAS::m_opengl_supports_raytracing

private

Definition at line 322 of file eda_3d_canvas.h.

Referenced by DoRePaint(), and initializeOpenGL().

◆ m_parentInfoBar

WX_INFOBAR* EDA_3D_CANVAS::m_parentInfoBar

private

Definition at line 300 of file eda_3d_canvas.h.

Referenced by DoRePaint(), and SetInfoBar().

◆ m_parentStatusBar

wxStatusBar* EDA_3D_CANVAS::m_parentStatusBar

private

Definition at line 299 of file eda_3d_canvas.h.

Referenced by DisplayStatus(), DoRePaint(), OnMouseMove(), and SetStatusBar().

◆ m_redraw_trigger_timer

wxTimer EDA_3D_CANVAS::m_redraw_trigger_timer

private

Definition at line 308 of file eda_3d_canvas.h.

Referenced by OnTimerTimeout_Redraw(), and Request_refresh().

◆ m_render3dmousePivot

bool EDA_3D_CANVAS::m_render3dmousePivot = false

private

Definition at line 329 of file eda_3d_canvas.h.

Referenced by DoRePaint(), GetRender3dmousePivot(), and SetRender3dmousePivot().

◆ m_render_pivot

bool EDA_3D_CANVAS::m_render_pivot

private

Definition at line 311 of file eda_3d_canvas.h.

Referenced by DoRePaint(), GetRenderPivot(), request_start_moving_camera(), and SetRenderPivot().

◆ m_render_raytracing_was_requested

bool EDA_3D_CANVAS::m_render_raytracing_was_requested

private

Definition at line 323 of file eda_3d_canvas.h.

Referenced by DoRePaint(), and RenderRaytracingRequest().

◆ m_scale_factor

double HIDPI_GL_CANVAS::m_scale_factor

privateinherited

The current scale factor (e.g.

for hi-DPI displays)

Definition at line 68 of file hidpi_gl_canvas.h.

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

◆ m_strtime_camera_movement

unsigned EDA_3D_CANVAS::m_strtime_camera_movement

private

Definition at line 313 of file eda_3d_canvas.h.

Referenced by DoRePaint(), and request_start_moving_camera().

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

Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EDA_3D_CANVAS()

◆ ~EDA_3D_CANVAS()

Member Function Documentation

◆ DisplayStatus()

◆ DoRePaint()

◆ GetAnimationEnabled()

◆ GetBoardAdapter()

◆ GetCamera()

◆ GetCurrentRender()

◆ GetMovingSpeedMultiplier()

◆ GetNativePixelSize()

◆ GetNativePosition()

◆ GetProjectionMode()

◆ getRayAtCurrentMousePosition()

◆ GetRender3dmousePivot()

◆ GetRenderPivot()

◆ GetScaleFactor()

◆ GetScreenshot()

◆ initializeOpenGL()

◆ IsReloadRequestPending()

◆ move_pivot_based_on_cur_mouse_position()

◆ OnCloseWindow()

◆ OnEraseBackground()

◆ OnEvent()

◆ OnLeftDown()

◆ OnLeftUp()

◆ OnMiddleDown()

◆ OnMiddleUp()

◆ OnMouseMove()

◆ OnMouseMoveCamera()

◆ OnMouseWheel()

◆ OnMouseWheelCamera()

◆ OnPaint()

◆ OnRefreshRequest()

◆ OnResize()

◆ OnTimerTimeout_Editing()

◆ OnTimerTimeout_Redraw()

◆ releaseOpenGL()

◆ ReloadRequest()

◆ render3dmousePivot()

◆ render_pivot()

◆ RenderEngineChanged()

◆ RenderRaytracingRequest()

◆ Request_refresh()

◆ request_start_moving_camera()

◆ restart_editingTimeOut_Timer()

◆ Set3dmousePivotPos()

◆ SetAnimationEnabled()

◆ SetEventDispatcher()

◆ SetInfoBar()

◆ SetMovingSpeedMultiplier()

◆ SetProjectionMode()

◆ SetRender3dmousePivot()

◆ SetRenderPivot()

◆ SetScaleFactor()

◆ SetStatusBar()

◆ SetView3D()

◆ stop_editingTimeOut_Timer()

Member Data Documentation

◆ m_3d_render

◆ m_3d_render_opengl

◆ m_3d_render_raytracing

◆ m_3dmousePivotPos

◆ m_accelerator3DShapes

◆ m_animation_enabled

◆ m_boardAdapter

◆ m_camera

◆ m_camera_is_moving

◆ m_camera_moving_speed

◆ m_currentRollOverItem

◆ m_delta_move_step_factor

◆ m_editing_timeout_timer