KiCad PCB EDA Suite
EDA_3D_CANVAS Class Reference

Class EDA_3D_CANVAS 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=0, BOARD *aBoard=NULL, CINFO3D_VISU &aSettings=G_null_CINFO3D_VISU, S3D_CACHE *a3DCachePointer=NULL)
 EDA_3D_CANVAS - Creates a new 3D Canvas with a attribute list. More...
 
 ~EDA_3D_CANVAS ()
 
void SetStatusBar (wxStatusBar *aStatusBar)
 
void ReloadRequest (BOARD *aBoard=NULL, S3D_CACHE *aCachePointer=NULL)
 
bool IsReloadRequestPending () const
 IsReloadRequestPending - Query if there is a pending reload request. More...
 
void RenderRaytracingRequest ()
 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...
 
void SetView3D (int keycode)
 SetView3D - Helper function to call view commands. More...
 
void RenderEngineChanged ()
 RenderEngineChanged - Notify that the render engine was changed. More...
 
void DisplayStatus ()
 DisplayStatus - Update the status bar with the position information. More...
 
void Request_refresh (bool aRedrawImmediately=true)
 Request_refresh - Schedule a refresh update of the canvas. More...
 

Private Member Functions

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)
 
void OnPopUpMenu (wxCommandEvent &event)
 
void OnCharHook (wxKeyEvent &event)
 
void OnKeyEvent (wxKeyEvent &event)
 
void OnTimerTimeout_Editing (wxTimerEvent &event)
 
void OnCloseWindow (wxCloseEvent &event)
 OnCloseWindow - called when the frame is closed. More...
 
void OnTimerTimeout_Redraw (wxTimerEvent &event)
 
 DECLARE_EVENT_TABLE ()
 
void stop_editingTimeOut_Timer ()
 stop_editingTimeOut_Timer - stop the editing time, so it will not timeout More...
 
void restart_editingTimeOut_Timer ()
 restart_editingTimeOut_Timer - reset the editing timer More...
 
void request_start_moving_camera (float aMovingSpeed=2.0f, bool aRenderPivot=true)
 request_start_moving_camera - start a camera movement More...
 
void move_pivot_based_on_cur_mouse_position ()
 move_pivot_based_on_cur_mouse_position - This function hits a ray to the board and start a moviment More...
 
void render_pivot (float t, float aScale)
 render_pivot - render the pivot cursor More...
 
bool initializeOpenGL ()
 initializeOpenGL More...
 
void releaseOpenGL ()
 releaseOpenGL - free created targets and openGL context More...
 

Private Attributes

wxGLContext * m_glRC
 current OpenGL context More...
 
wxStatusBar * m_parentStatusBar
 Parent statusbar to report progress. More...
 
wxTimer m_editing_timeout_timer
 Time timeout will expires after some time sinalizing that the mouse / keyboard movements are over. More...
 
wxTimer m_redraw_trigger_timer
 This timer will be used to schedule a redraw event. More...
 
bool m_mouse_is_moving
 true if mouse activity is on progress More...
 
bool m_mouse_was_moved
 true if there was some type of activity, it will be used to render in preview mode More...
 
bool m_camera_is_moving
 true if camera animation is ongoing More...
 
bool m_render_pivot
 activated the render of pivot while camera moving More...
 
float m_camera_moving_speed
 1.0f will be 1:1 More...
 
unsigned m_strtime_camera_movement
 Stores the ticktime when the camera star its movement. More...
 
CINFO3D_VISUm_settings
 Stores all pre-computed 3D information and visualization settings to render the board. More...
 
C3D_RENDER_BASEm_3d_render
 The current render in used for this canvas. More...
 
C3D_RENDER_RAYTRACINGm_3d_render_raytracing
 Raytracing render class. More...
 
C3D_RENDER_OGL_LEGACYm_3d_render_ogl_legacy
 OpenGL legacy render class. More...
 
bool m_is_opengl_initialized
 Flag to store if opengl was initialized already. More...
 
bool m_render_raytracing_was_requested
 Flags that the user requested the current view to be render with raytracing. More...
 

Static Private Attributes

static const float m_delta_move_step_factor = 0.7f
 Step factor to used with cursor on relation to the current zoom. More...
 
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

Class EDA_3D_CANVAS Implement a canvas based on a wxGLCanvas.

Definition at line 53 of file eda_3d_canvas.h.

Constructor & Destructor Documentation

EDA_3D_CANVAS::EDA_3D_CANVAS ( wxWindow *  aParent,
const int *  aAttribList = 0,
BOARD aBoard = NULL,
CINFO3D_VISU aSettings = G_null_CINFO3D_VISU,
S3D_CACHE a3DCachePointer = NULL 
)

EDA_3D_CANVAS - Creates a new 3D Canvas with a attribute list.

Parameters
aParentthe parent creator of this canvas
aAttribLista list of openGL options created by GetOpenGL_AttributesList
aBoardThe board
aSettingsthe settings options to be used by this canvas
EDA_3D_CANVAS::~EDA_3D_CANVAS ( )

Definition at line 149 of file eda_3d_canvas.cpp.

References m_logTrace, and releaseOpenGL().

150 {
151  wxLogTrace( m_logTrace, wxT( "EDA_3D_CANVAS::~EDA_3D_CANVAS" ) );
152 
153  releaseOpenGL();
154 }
void releaseOpenGL()
releaseOpenGL - free created targets and openGL context
static const wxChar * m_logTrace
Trace mask used to enable or disable the trace output of this class.

Member Function Documentation

EDA_3D_CANVAS::DECLARE_EVENT_TABLE ( )
private
void EDA_3D_CANVAS::DisplayStatus ( )

DisplayStatus - Update the status bar with the position information.

Definition at line 247 of file eda_3d_canvas.cpp.

References CINFO3D_VISU::CameraGet(), CCAMERA::GetCameraPos(), m_parentStatusBar, and m_settings.

Referenced by OnMouseMove(), OnMouseWheel(), OnPaint(), EDA_3D_VIEWER::ProcessZoom(), request_start_moving_camera(), and SetView3D().

248 {
249  if( m_parentStatusBar )
250  {
251  wxString msg;
252 
253  msg.Printf( wxT( "dx %3.2f" ), m_settings.CameraGet().GetCameraPos().x );
254  m_parentStatusBar->SetStatusText( msg, 1 );
255 
256  msg.Printf( wxT( "dy %3.2f" ), m_settings.CameraGet().GetCameraPos().y );
257  m_parentStatusBar->SetStatusText( msg, 2 );
258 
259  //msg.Printf( _( "Zoom: %3.1f" ), 50 * m_settings.CameraGet().ZoomGet() );
260  //m_parentStatusBar->SetStatusText( msg, 3 );
261  }
262 }
CINFO3D_VISU & m_settings
Stores all pre-computed 3D information and visualization settings to render the board.
wxStatusBar * m_parentStatusBar
Parent statusbar to report progress.
const SFVEC3F & GetCameraPos() const
Definition: ccamera.h:131
CCAMERA & CameraGet() const
CameraGet - get current camera in use.
Definition: cinfo3d_visu.h:210
void EDA_3D_CANVAS::GetScreenshot ( wxImage &  aDstImage)

Request a screenshot and output it to the aDstImage.

Parameters
aDstImage- Screenshot destination image

Definition at line 214 of file eda_3d_canvas.cpp.

References OGL_GetScreenshot().

Referenced by EDA_3D_VIEWER::takeScreenshot().

215 {
216  OGL_GetScreenshot( aDstImage );
217 }
void OGL_GetScreenshot(wxImage &aDstImage)
OGL_GetScreenshot - got the pixel data of current OpenGL image.
Definition: ogl_utils.cpp:35
bool EDA_3D_CANVAS::initializeOpenGL ( )
private

initializeOpenGL

Returns
if OpenGL initialization succeed

Definition at line 187 of file eda_3d_canvas.cpp.

References FROM_UTF8(), m_is_opengl_initialized, and m_logTrace.

Referenced by OnPaint().

188 {
189  wxLogTrace( m_logTrace, wxT( "EDA_3D_CANVAS::initializeOpenGL" ) );
190 
191  const GLenum err = glewInit();
192 
193  if( GLEW_OK != err )
194  {
195  const wxString msgError = (const char*) glewGetErrorString( err );
196 
197  wxLogMessage( msgError );
198 
199  return false;
200  }
201  else
202  {
203  wxLogTrace( m_logTrace,
204  wxString( wxT( "EDA_3D_CANVAS::initializeOpenGL Using GLEW " ) ) +
205  FROM_UTF8( (char*) glewGetString( GLEW_VERSION ) ) );
206  }
207 
209 
210  return true;
211 }
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes...
Definition: macros.h:53
bool m_is_opengl_initialized
Flag to store if opengl was initialized already.
static const wxChar * m_logTrace
Trace mask used to enable or disable the trace output of this class.
bool EDA_3D_CANVAS::IsReloadRequestPending ( ) const
inline

IsReloadRequestPending - 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 82 of file eda_3d_canvas.h.

References C3D_RENDER_BASE::IsReloadRequestPending(), and m_3d_render.

Referenced by EDA_3D_VIEWER::OnActivate().

83  {
84  if( m_3d_render )
86  else
87  return false;
88  }
bool IsReloadRequestPending() const
IsReloadRequestPending - Query if there is a pending reload request.
C3D_RENDER_BASE * m_3d_render
The current render in used for this canvas.
void EDA_3D_CANVAS::move_pivot_based_on_cur_mouse_position ( )
private

move_pivot_based_on_cur_mouse_position - This function hits a ray to the board and start a moviment

Definition at line 827 of file eda_3d_canvas.cpp.

References RAY::at(), CINFO3D_VISU::CameraGet(), CINFO3D_VISU::GetBBox3DU(), RAY::Init(), INTERPOLATION_BEZIER, CBBOX::Intersect(), m_settings, CCAMERA::MakeRayAtCurrrentMousePosition(), request_start_moving_camera(), CCAMERA::ResetXYpos_T1(), CCAMERA::SetInterpolateMode(), CCAMERA::SetLookAtPos_T1(), and CCAMERA::SetT0_and_T1_current_T().

Referenced by OnMiddleUp(), and SetView3D().

828 {
829  SFVEC3F rayOrigin;
830  SFVEC3F rayDir;
831 
832  // Generate a ray origin and direction based on current mouser position and camera
833  m_settings.CameraGet().MakeRayAtCurrrentMousePosition( rayOrigin, rayDir );
834 
835  RAY mouseRay;
836  mouseRay.Init( rayOrigin, rayDir );
837 
838  float hit_t;
839 
840  // Test it with the board bounding box
841  if( m_settings.GetBBox3DU().Intersect( mouseRay, &hit_t ) )
842  {
845  m_settings.CameraGet().SetLookAtPos_T1( mouseRay.at( hit_t ) );
847 
849  }
850 }
void SetLookAtPos_T1(const SFVEC3F &aLookAtPos)
Definition: ccamera.h:125
void request_start_moving_camera(float aMovingSpeed=2.0f, bool aRenderPivot=true)
request_start_moving_camera - start a camera movement
virtual void SetT0_and_T1_current_T()
SetT0_and_T1_current_T - This will set T0 and T1 with the current values.
Definition: ccamera.cpp:535
CINFO3D_VISU & m_settings
Stores all pre-computed 3D information and visualization settings to render the board.
void ResetXYpos_T1()
Definition: ccamera.cpp:382
void Init(const SFVEC3F &o, const SFVEC3F &d)
Definition: ray.cpp:38
SFVEC3F at(float t) const
Definition: ray.h:65
Definition: ray.h:43
bool Intersect(const RAY &aRay, float *t) const
Function Intersect.
Definition: cbbox_ray.cpp:46
void MakeRayAtCurrrentMousePosition(SFVEC3F &aOutOrigin, SFVEC3F &aOutDirection) const
MakeRayAtCurrrentMousePosition - Make a ray based on the latest mouse position.
Definition: ccamera.cpp:350
CCAMERA & CameraGet() const
CameraGet - get current camera in use.
Definition: cinfo3d_visu.h:210
glm::vec3 SFVEC3F
Definition: xv3d_types.h:47
void SetInterpolateMode(CAMERA_INTERPOLATION aInterpolateMode)
Definition: ccamera.h:198
const CBBOX & GetBBox3DU() const
GetBBox3DU - Get the bbox of the pcb board.
Definition: cinfo3d_visu.h:147
void EDA_3D_CANVAS::OnCharHook ( wxKeyEvent &  event)
private

Definition at line 726 of file eda_3d_canvas.cpp.

727 {
728  //wxLogTrace( m_logTrace, wxT( "EDA_3D_CANVAS::OnCharHook" ) );
729  event.Skip();
730 }
void EDA_3D_CANVAS::OnCloseWindow ( wxCloseEvent &  event)
private

OnCloseWindow - called when the frame is closed.

Parameters
event

Definition at line 179 of file eda_3d_canvas.cpp.

References releaseOpenGL().

180 {
181  releaseOpenGL();
182 
183  event.Skip();
184 }
void releaseOpenGL()
releaseOpenGL - free created targets and openGL context
void EDA_3D_CANVAS::OnEraseBackground ( wxEraseEvent &  event)
private

Definition at line 424 of file eda_3d_canvas.cpp.

References m_logTrace.

425 {
426  wxLogTrace( m_logTrace, wxT( "EDA_3D_CANVAS::OnEraseBackground" ) );
427  // Do nothing, to avoid flashing.
428 }
static const wxChar * m_logTrace
Trace mask used to enable or disable the trace output of this class.
void EDA_3D_CANVAS::OnKeyEvent ( wxKeyEvent &  event)
private

Definition at line 733 of file eda_3d_canvas.cpp.

References m_camera_is_moving, and SetView3D().

734 {
735  //wxLogTrace( m_logTrace, wxT( "EDA_3D_CANVAS::OnKeyEvent" ) );
736 
737  if( m_camera_is_moving )
738  return;
739 
740  SetView3D( event.GetKeyCode() );
741  event.Skip();
742 }
bool m_camera_is_moving
true if camera animation is ongoing
void SetView3D(int keycode)
SetView3D - Helper function to call view commands.
void EDA_3D_CANVAS::OnLeftDown ( wxMouseEvent &  event)
private

Definition at line 549 of file eda_3d_canvas.cpp.

References stop_editingTimeOut_Timer().

550 {
552 }
void stop_editingTimeOut_Timer()
stop_editingTimeOut_Timer - stop the editing time, so it will not timeout
void EDA_3D_CANVAS::OnLeftUp ( wxMouseEvent &  event)
private

Definition at line 555 of file eda_3d_canvas.cpp.

References m_camera_is_moving, m_mouse_is_moving, and restart_editingTimeOut_Timer().

556 {
557  if( m_camera_is_moving )
558  return;
559 
560  if( m_mouse_is_moving )
561  {
562  m_mouse_is_moving = false;
564  }
565 }
bool m_mouse_is_moving
true if mouse activity is on progress
void restart_editingTimeOut_Timer()
restart_editingTimeOut_Timer - reset the editing timer
bool m_camera_is_moving
true if camera animation is ongoing
void EDA_3D_CANVAS::OnMiddleDown ( wxMouseEvent &  event)
private

Definition at line 568 of file eda_3d_canvas.cpp.

References stop_editingTimeOut_Timer().

569 {
571 }
void stop_editingTimeOut_Timer()
stop_editingTimeOut_Timer - stop the editing time, so it will not timeout
void EDA_3D_CANVAS::OnMiddleUp ( wxMouseEvent &  event)
private

Definition at line 574 of file eda_3d_canvas.cpp.

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

575 {
576  if( m_camera_is_moving )
577  return;
578 
579  if( m_mouse_is_moving )
580  {
581  m_mouse_is_moving = false;
583  }
584  else
585  {
587  }
588 }
bool m_mouse_is_moving
true if mouse activity is on progress
void restart_editingTimeOut_Timer()
restart_editingTimeOut_Timer - reset the editing timer
bool m_camera_is_moving
true if camera animation is ongoing
void move_pivot_based_on_cur_mouse_position()
move_pivot_based_on_cur_mouse_position - This function hits a ray to the board and start a moviment ...
void EDA_3D_CANVAS::OnMouseMove ( wxMouseEvent &  event)
private

Definition at line 520 of file eda_3d_canvas.cpp.

References CINFO3D_VISU::CameraGet(), DisplayStatus(), CCAMERA::Drag(), m_camera_is_moving, m_mouse_is_moving, m_mouse_was_moved, m_settings, CCAMERA::Pan(), Request_refresh(), CCAMERA::SetCurMousePosition(), and CCAMERA::SetCurWindowSize().

521 {
522  //wxLogTrace( m_logTrace, wxT( "EDA_3D_CANVAS::OnMouseMove" ) );
523 
524  if( m_camera_is_moving )
525  return;
526 
527  m_settings.CameraGet().SetCurWindowSize( GetClientSize() );
528 
529  if( event.Dragging() )
530  {
531  if( event.LeftIsDown() ) // Drag
532  m_settings.CameraGet().Drag( event.GetPosition() );
533  else if( event.MiddleIsDown() ) // Pan
534  m_settings.CameraGet().Pan( event.GetPosition() );
535 
536  m_mouse_is_moving = true;
537  m_mouse_was_moved = true;
538 
539  // orientation has changed, redraw mesh
540  DisplayStatus();
541  Request_refresh();
542  }
543 
544  const wxPoint eventPosition = event.GetPosition();
545  m_settings.CameraGet().SetCurMousePosition( eventPosition );
546 }
bool m_mouse_is_moving
true if mouse activity is on progress
CINFO3D_VISU & m_settings
Stores all pre-computed 3D information and visualization settings to render the board.
void DisplayStatus()
DisplayStatus - Update the status bar with the position information.
void Request_refresh(bool aRedrawImmediately=true)
Request_refresh - Schedule a refresh update of the canvas.
void SetCurMousePosition(const wxPoint &aPosition)
It updates the current mouse position without make any new recalculations on camera.
Definition: ccamera.cpp:401
bool m_mouse_was_moved
true if there was some type of activity, it will be used to render in preview mode ...
bool m_camera_is_moving
true if camera animation is ongoing
virtual void Drag(const wxPoint &aNewMousePosition)=0
Calculate a new mouse drag position.
bool SetCurWindowSize(const wxSize &aSize)
SetCurWindowSize - update the windows size of the camera.
Definition: ccamera.cpp:428
CCAMERA & CameraGet() const
CameraGet - get current camera in use.
Definition: cinfo3d_visu.h:210
virtual void Pan(const wxPoint &aNewMousePosition)=0
void EDA_3D_CANVAS::OnMouseWheel ( wxMouseEvent &  event)
private

Definition at line 431 of file eda_3d_canvas.cpp.

References CINFO3D_VISU::CameraGet(), DisplayStatus(), FL_MOUSEWHEEL_PANNING, CINFO3D_VISU::GetFlag(), m_camera_is_moving, m_delta_move_step_factor, m_logTrace, m_mouse_is_moving, m_mouse_was_moved, m_settings, CCAMERA::Pan(), Request_refresh(), restart_editingTimeOut_Timer(), CCAMERA::SetCurMousePosition(), CCAMERA::Zoom(), and CCAMERA::ZoomGet().

432 {
433  bool mouseActivity = false;
434 
435  wxLogTrace( m_logTrace, wxT( "EDA_3D_CANVAS::OnMouseWheel" ) );
436 
437  if( m_camera_is_moving )
438  return;
439 
440  float delta_move = m_delta_move_step_factor * m_settings.CameraGet().ZoomGet();
441 
443  delta_move *= (0.01f * event.GetWheelRotation());
444  else
445  if( event.GetWheelRotation() < 0 )
446  delta_move = -delta_move;
447 
448  // mousewheel_panning enabled:
449  // wheel -> pan;
450  // wheel + shift -> horizontal scrolling;
451  // wheel + ctrl -> zooming;
452  // mousewheel_panning disabled:
453  // wheel + shift -> vertical scrolling;
454  // wheel + ctrl -> horizontal scrolling;
455  // wheel -> zooming.
456 
457  if( m_settings.GetFlag( FL_MOUSEWHEEL_PANNING ) && !event.ControlDown() )
458  {
459  if( event.GetWheelAxis() == wxMOUSE_WHEEL_HORIZONTAL || event.ShiftDown() )
460  m_settings.CameraGet().Pan( SFVEC3F( -delta_move, 0.0f, 0.0f ) );
461  else
462  m_settings.CameraGet().Pan( SFVEC3F( 0.0f, -delta_move, 0.0f ) );
463 
464  mouseActivity = true;
465  }
466  else if( event.ShiftDown() && !m_settings.GetFlag( FL_MOUSEWHEEL_PANNING ) )
467  {
468  m_settings.CameraGet().Pan( SFVEC3F( 0.0f, -delta_move, 0.0f ) );
469  mouseActivity = true;
470  }
471  else if( event.ControlDown() && !m_settings.GetFlag( FL_MOUSEWHEEL_PANNING ) )
472  {
473  m_settings.CameraGet().Pan( SFVEC3F( delta_move, 0.0f, 0.0f ) );
474  mouseActivity = true;
475  }
476  else
477  {
478  mouseActivity = m_settings.CameraGet().Zoom( event.GetWheelRotation() > 0 ? 1.1f : 1/1.1f );
479  }
480 
481  // If it results on a camera movement
482  if( mouseActivity )
483  {
484  DisplayStatus();
485  Request_refresh();
486 
487  m_mouse_is_moving = true;
488  m_mouse_was_moved = true;
489 
491  }
492 
493  // Update the cursor current mouse position on the camera
494  m_settings.CameraGet().SetCurMousePosition( event.GetPosition() );
495 }
float ZoomGet() const
Definition: ccamera.cpp:490
bool m_mouse_is_moving
true if mouse activity is on progress
CINFO3D_VISU & m_settings
Stores all pre-computed 3D information and visualization settings to render the board.
void DisplayStatus()
DisplayStatus - Update the status bar with the position information.
void Request_refresh(bool aRedrawImmediately=true)
Request_refresh - Schedule a refresh update of the canvas.
void SetCurMousePosition(const wxPoint &aPosition)
It updates the current mouse position without make any new recalculations on camera.
Definition: ccamera.cpp:401
bool Zoom(float aFactor)
Definition: ccamera.cpp:454
void restart_editingTimeOut_Timer()
restart_editingTimeOut_Timer - reset the editing timer
bool m_mouse_was_moved
true if there was some type of activity, it will be used to render in preview mode ...
bool m_camera_is_moving
true if camera animation is ongoing
bool GetFlag(DISPLAY3D_FLG aFlag) const
GetFlag - get a configuration status of a flag.
CCAMERA & CameraGet() const
CameraGet - get current camera in use.
Definition: cinfo3d_visu.h:210
virtual void Pan(const wxPoint &aNewMousePosition)=0
glm::vec3 SFVEC3F
Definition: xv3d_types.h:47
static const wxChar * m_logTrace
Trace mask used to enable or disable the trace output of this class.
static const float m_delta_move_step_factor
Step factor to used with cursor on relation to the current zoom.
void EDA_3D_CANVAS::OnPaint ( wxPaintEvent &  event)
private

Definition at line 265 of file eda_3d_canvas.cpp.

References CINFO3D_VISU::CameraGet(), GL_CONTEXT_MANAGER::CreateCtx(), DisplayStatus(), Format(), GL_CONTEXT_MANAGER::Get(), GetRunningMicroSecs(), STATUS_TEXT_REPORTER::HasMessage(), initializeOpenGL(), CCAMERA::Interpolate(), GL_CONTEXT_MANAGER::LockCtx(), m_3d_render, m_3d_render_ogl_legacy, m_camera_is_moving, m_camera_moving_speed, m_glRC, m_is_opengl_initialized, m_logTrace, m_mouse_is_moving, m_mouse_was_moved, m_parentStatusBar, m_render_pivot, m_render_raytracing_was_requested, m_settings, m_strtime_camera_movement, min, CCAMERA::ParametersChanged(), C3D_RENDER_BASE::Redraw(), RENDER_ENGINE_OPENGL_LEGACY, render_pivot(), CINFO3D_VISU::RenderEngineGet(), STATUS_TEXT_REPORTER::Report(), Request_refresh(), restart_editingTimeOut_Timer(), scale, C3D_RENDER_BASE::SetCurWindowSize(), CCAMERA::SetCurWindowSize(), GL_CONTEXT_MANAGER::UnlockCtx(), and CCAMERA::ZoomGet().

266 {
267  // Please have a look at:
268  // https://lists.launchpad.net/kicad-developers/msg25149.html
269  // wxPaintDC( this );
270  // event.Skip( false );
271 
272  // SwapBuffer requires the window to be shown before calling
273  if( !IsShownOnScreen() )
274  {
275  wxLogTrace( m_logTrace, wxT( "EDA_3D_CANVAS::OnPaint !IsShown" ) );
276  return;
277  }
278 
279  // Because the board to draw is handled by the parent viewer frame,
280  // ensure this parent is still alive. When it is closed before the viewer
281  // frame, a paint event can be generated after the parent is closed,
282  // therefore with invalid board.
283  // This is dependant of the platform.
284  // Especially on OSX, but also on Windows, it frequently happens
285  if( !GetParent()->GetParent()->IsShown() )
286  return; // The parent board editor frame is no more alive
287 
288  wxString err_messages;
289 
290  // !TODO: implement error reporter
291  //WX_STRING_REPORTER errorReporter( &err_messages );
292  STATUS_TEXT_REPORTER activityReporter( m_parentStatusBar, 0 );
293 
294 
295  unsigned strtime = GetRunningMicroSecs();
296 
297  // "Makes the OpenGL state that is represented by the OpenGL rendering
298  // context context current, i.e. it will be used by all subsequent OpenGL calls.
299  // This function may only be called when the window is shown on screen"
300 
301  // Explicitly create a new rendering context instance for this canvas.
302  if( m_glRC == NULL )
304 
306 
307  // Set the OpenGL viewport according to the client size of this canvas.
308  // This is done here rather than in a wxSizeEvent handler because our
309  // OpenGL rendering context (and thus viewport setting) is used with
310  // multiple canvases: If we updated the viewport in the wxSizeEvent
311  // handler, changing the size of one canvas causes a viewport setting that
312  // is wrong when next another canvas is repainted.
313  wxSize clientSize = GetClientSize();
314 
315  const bool windows_size_changed = m_settings.CameraGet().SetCurWindowSize( clientSize );
316 
317 
318  // Initialize openGL if need
319  // /////////////////////////////////////////////////////////////////////////
321  {
322  if( !initializeOpenGL() )
323  {
325 
326  return;
327  }
328  }
329 
330 
331  // Check if a raytacing was requented and need to switch to raytracing mode
333  {
334  const bool was_camera_changed = m_settings.CameraGet().ParametersChanged();
335 
336  // It reverts back to OpenGL mode if it was requested a raytracing
337  // render of the current scene. AND the mouse / camera is moving
338  if( ( m_mouse_is_moving ||
340  was_camera_changed ||
341  windows_size_changed ) &&
343  {
346  }
347  }
348 
349 
350  float curtime_delta_s = 0.0f;
351 
352  if( m_camera_is_moving )
353  {
354  const unsigned curtime_delta = GetRunningMicroSecs() - m_strtime_camera_movement;
355  curtime_delta_s = (curtime_delta / 1e6) * m_camera_moving_speed;
356  m_settings.CameraGet().Interpolate( curtime_delta_s );
357 
358  if( curtime_delta_s > 1.0f )
359  {
360  m_render_pivot = false;
361  m_camera_is_moving = false;
362  m_mouse_was_moved = true;
363 
365  DisplayStatus();
366  }
367  else
368  {
369  Request_refresh();
370  }
371  }
372 
373 
374  // It will return true if the render request a new redraw
375  bool requested_redraw = false;
376 
377  if( m_3d_render )
378  {
379  m_3d_render->SetCurWindowSize( clientSize );
380 
381  requested_redraw = m_3d_render->Redraw( m_mouse_was_moved || m_camera_is_moving,
382  &activityReporter );
383  }
384 
385  if( m_render_pivot )
386  {
387  const float scale = glm::min( m_settings.CameraGet().ZoomGet(), 1.0f );
388  render_pivot( curtime_delta_s, scale * scale );
389  }
390 
391  // "Swaps the double-buffer of this window, making the back-buffer the
392  // front-buffer and vice versa, so that the output of the previous OpenGL
393  // commands is displayed on the window."
394  SwapBuffers();
395 
397 
398  if( !activityReporter.HasMessage() )
399  {
401  {
402  // Calculation time in miliseconds
403  const double calculation_time = (double)( GetRunningMicroSecs() - strtime) / 1e3;
404 
405  activityReporter.Report( wxString::Format( _( "Render time %.0f ms ( %.1f fps)" ),
406  calculation_time, 1000.0 / calculation_time ) );
407  }
408  }
409 
410  // This will reset the flag of camera parameters changed
412 
413  if( !err_messages.IsEmpty() )
414  wxLogMessage( err_messages );
415 
416  if( (!m_camera_is_moving) && requested_redraw )
417  {
418  m_mouse_was_moved = false;
419  Request_refresh( false );
420  }
421 }
float ZoomGet() const
Definition: ccamera.cpp:490
bool m_mouse_is_moving
true if mouse activity is on progress
CINFO3D_VISU & m_settings
Stores all pre-computed 3D information and visualization settings to render the board.
unsigned m_strtime_camera_movement
Stores the ticktime when the camera star its movement.
wxStatusBar * m_parentStatusBar
Parent statusbar to report progress.
wxGLContext * m_glRC
current OpenGL context
void DisplayStatus()
DisplayStatus - Update the status bar with the position information.
C3D_RENDER_OGL_LEGACY * m_3d_render_ogl_legacy
OpenGL legacy render class.
void Request_refresh(bool aRedrawImmediately=true)
Request_refresh - Schedule a refresh update of the canvas.
void UnlockCtx(wxGLContext *aContext)
Function UnlockCtx allows other canvases to bind an OpenGL context.
float m_camera_moving_speed
1.0f will be 1:1
static GL_CONTEXT_MANAGER & Get()
Function Get returns the GL_CONTEXT_MANAGER instance (singleton).
void restart_editingTimeOut_Timer()
restart_editingTimeOut_Timer - reset the editing timer
bool m_mouse_was_moved
true if there was some type of activity, it will be used to render in preview mode ...
Class STATUS_TEXT_REPORTER is a wrapper for reporting to a wxString in a wxFrame status text...
bool m_camera_is_moving
true if camera animation is ongoing
virtual void Interpolate(float t)
Interpolate - It will update the matrix to interpolate between T0 and T1 values.
Definition: ccamera.cpp:549
bool SetCurWindowSize(const wxSize &aSize)
SetCurWindowSize - update the windows size of the camera.
Definition: ccamera.cpp:428
RENDER_ENGINE RenderEngineGet() const
RenderEngineGet.
Definition: cinfo3d_visu.h:234
void LockCtx(wxGLContext *aContext, wxGLCanvas *aCanvas)
Function LockCtx sets a context as current and prevents other canvases from switching it...
bool m_render_pivot
activated the render of pivot while camera moving
bool m_is_opengl_initialized
Flag to store if opengl was initialized already.
C3D_RENDER_BASE * m_3d_render
The current render in used for this canvas.
virtual bool Redraw(bool aIsMoving, REPORTER *aStatusTextReporter=NULL)=0
Redraw - Ask to redraw the view.
const int scale
bool initializeOpenGL()
initializeOpenGL
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
CCAMERA & CameraGet() const
CameraGet - get current camera in use.
Definition: cinfo3d_visu.h:210
unsigned GetRunningMicroSecs()
Function GetRunningMicroSecs An alternate way to calculate an elapset time (in microsecondes) to clas...
static const wxChar * m_logTrace
Trace mask used to enable or disable the trace output of this class.
wxGLContext * CreateCtx(wxGLCanvas *aCanvas, const wxGLContext *aOther=NULL)
Function CreateCtx creates a managed OpenGL context.
virtual void SetCurWindowSize(const wxSize &aSize)=0
SetCurWindowSize - Before each render, the canvas will tell the render what is the size of its window...
void render_pivot(float t, float aScale)
render_pivot - render the pivot cursor
#define min(a, b)
Definition: auxiliary.h:85
bool ParametersChanged()
Function ParametersChanged.
Definition: ccamera.cpp:567
bool m_render_raytracing_was_requested
Flags that the user requested the current view to be render with raytracing.
void EDA_3D_CANVAS::OnPopUpMenu ( wxCommandEvent &  event)
private

Definition at line 660 of file eda_3d_canvas.cpp.

References ID_POPUP_MOVE3D_DOWN, ID_POPUP_MOVE3D_LEFT, ID_POPUP_MOVE3D_RIGHT, ID_POPUP_MOVE3D_UP, ID_POPUP_VIEW_XNEG, ID_POPUP_VIEW_XPOS, ID_POPUP_VIEW_YNEG, ID_POPUP_VIEW_YPOS, ID_POPUP_VIEW_ZNEG, ID_POPUP_VIEW_ZPOS, ID_POPUP_ZOOMIN, ID_POPUP_ZOOMOUT, m_logTrace, and SetView3D().

661 {
662  int id = event.GetId();
663 
664  wxLogTrace( m_logTrace, wxT( "EDA_3D_CANVAS::OnPopUpMenu id:%d" ), id );
665 
666  int key = 0;
667 
668  switch( id )
669  {
670  case ID_POPUP_ZOOMIN:
671  key = WXK_F1;
672  break;
673 
674  case ID_POPUP_ZOOMOUT:
675  key = WXK_F2;
676  break;
677 
678  case ID_POPUP_VIEW_XPOS:
679  key = 'x';
680  break;
681 
682  case ID_POPUP_VIEW_XNEG:
683  key = 'X';
684  break;
685 
686  case ID_POPUP_VIEW_YPOS:
687  key = 'y';
688  break;
689 
690  case ID_POPUP_VIEW_YNEG:
691  key = 'Y';
692  break;
693 
694  case ID_POPUP_VIEW_ZPOS:
695  key = 'z';
696  break;
697 
698  case ID_POPUP_VIEW_ZNEG:
699  key = 'Z';
700  break;
701 
703  key = WXK_LEFT;
704  break;
705 
707  key = WXK_RIGHT;
708  break;
709 
710  case ID_POPUP_MOVE3D_UP:
711  key = WXK_UP;
712  break;
713 
715  key = WXK_DOWN;
716  break;
717 
718  default:
719  return;
720  }
721 
722  SetView3D( key );
723 }
void SetView3D(int keycode)
SetView3D - Helper function to call view commands.
static const wxChar * m_logTrace
Trace mask used to enable or disable the trace output of this class.
void EDA_3D_CANVAS::OnRightClick ( wxMouseEvent &  event)
private

Definition at line 591 of file eda_3d_canvas.cpp.

References ID_POPUP_MOVE3D_DOWN, ID_POPUP_MOVE3D_LEFT, ID_POPUP_MOVE3D_RIGHT, ID_POPUP_MOVE3D_UP, ID_POPUP_VIEW_XNEG, ID_POPUP_VIEW_XPOS, ID_POPUP_VIEW_YNEG, ID_POPUP_VIEW_YPOS, ID_POPUP_VIEW_ZNEG, ID_POPUP_VIEW_ZPOS, ID_POPUP_ZOOMIN, ID_POPUP_ZOOMOUT, KiBitmap(), m_camera_is_moving, m_logTrace, wxPoint::x, and wxPoint::y.

592 {
593  wxLogTrace( m_logTrace, wxT( "EDA_3D_CANVAS::OnRightClick" ) );
594 
595  if( m_camera_is_moving )
596  return;
597 
598  wxPoint pos;
599  wxMenu PopUpMenu;
600 
601  pos.x = event.GetX();
602  pos.y = event.GetY();
603 
604  wxMenuItem* item = new wxMenuItem( &PopUpMenu, ID_POPUP_ZOOMIN, _( "Zoom +" ) );
605  item->SetBitmap( KiBitmap( zoom_in_xpm ));
606  PopUpMenu.Append( item );
607 
608  item = new wxMenuItem( &PopUpMenu, ID_POPUP_ZOOMOUT, _( "Zoom -" ) );
609  item->SetBitmap( KiBitmap( zoom_out_xpm ));
610  PopUpMenu.Append( item );
611 
612  PopUpMenu.AppendSeparator();
613  item = new wxMenuItem( &PopUpMenu, ID_POPUP_VIEW_ZPOS, _( "Top View" ) );
614  item->SetBitmap( KiBitmap( axis3d_top_xpm ));
615  PopUpMenu.Append( item );
616 
617  item = new wxMenuItem( &PopUpMenu, ID_POPUP_VIEW_ZNEG, _( "Bottom View" ) );
618  item->SetBitmap( KiBitmap( axis3d_bottom_xpm ));
619  PopUpMenu.Append( item );
620 
621  PopUpMenu.AppendSeparator();
622  item = new wxMenuItem( &PopUpMenu, ID_POPUP_VIEW_XPOS, _( "Right View" ) );
623  item->SetBitmap( KiBitmap( axis3d_right_xpm ));
624  PopUpMenu.Append( item );
625 
626  item = new wxMenuItem( &PopUpMenu, ID_POPUP_VIEW_XNEG, _( "Left View" ) );
627  item->SetBitmap( KiBitmap( axis3d_left_xpm ));
628  PopUpMenu.Append( item );
629 
630  PopUpMenu.AppendSeparator();
631  item = new wxMenuItem( &PopUpMenu, ID_POPUP_VIEW_YPOS, _( "Front View" ) );
632  item->SetBitmap( KiBitmap( axis3d_front_xpm ));
633  PopUpMenu.Append( item );
634 
635  item = new wxMenuItem( &PopUpMenu, ID_POPUP_VIEW_YNEG, _( "Back View" ) );
636  item->SetBitmap( KiBitmap( axis3d_back_xpm ));
637  PopUpMenu.Append( item );
638 
639  PopUpMenu.AppendSeparator();
640  item = new wxMenuItem( &PopUpMenu, ID_POPUP_MOVE3D_LEFT, _( "Move left <-" ) );
641  item->SetBitmap( KiBitmap( left_xpm ));
642  PopUpMenu.Append( item );
643 
644  item = new wxMenuItem( &PopUpMenu, ID_POPUP_MOVE3D_RIGHT, _( "Move right ->" ) );
645  item->SetBitmap( KiBitmap( right_xpm ));
646  PopUpMenu.Append( item );
647 
648  item = new wxMenuItem( &PopUpMenu, ID_POPUP_MOVE3D_UP, _( "Move Up ^" ) );
649  item->SetBitmap( KiBitmap( up_xpm ));
650  PopUpMenu.Append( item );
651 
652  item = new wxMenuItem( &PopUpMenu, ID_POPUP_MOVE3D_DOWN, _( "Move Down" ) );
653  item->SetBitmap( KiBitmap( down_xpm ));
654  PopUpMenu.Append( item );
655 
656  PopupMenu( &PopUpMenu, pos );
657 }
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Function KiBitmap constructs a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:36
bool m_camera_is_moving
true if camera animation is ongoing
static const wxChar * m_logTrace
Trace mask used to enable or disable the trace output of this class.
void EDA_3D_CANVAS::OnTimerTimeout_Editing ( wxTimerEvent &  event)
private

Definition at line 745 of file eda_3d_canvas.cpp.

References m_mouse_is_moving, m_mouse_was_moved, and Request_refresh().

Referenced by EVT_MENU_RANGE().

746 {
747  (void)event;
748 
749  m_mouse_is_moving = false;
750  m_mouse_was_moved = false;
751 
752  Request_refresh();
753 }
bool m_mouse_is_moving
true if mouse activity is on progress
void Request_refresh(bool aRedrawImmediately=true)
Request_refresh - Schedule a refresh update of the canvas.
bool m_mouse_was_moved
true if there was some type of activity, it will be used to render in preview mode ...
void EDA_3D_CANVAS::OnTimerTimeout_Redraw ( wxTimerEvent &  event)
private

Definition at line 768 of file eda_3d_canvas.cpp.

Referenced by EVT_MENU_RANGE().

769 {
770  (void)event;
771 
772  //Refresh();
773  //Update();
774 
775  wxPaintEvent redrawEvent;
776  wxPostEvent( this, redrawEvent );
777 }
void EDA_3D_CANVAS::releaseOpenGL ( )
private

releaseOpenGL - free created targets and openGL context

Definition at line 157 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_ogl_legacy, m_3d_render_raytracing, m_glRC, and GL_CONTEXT_MANAGER::UnlockCtx().

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

158 {
159  if( m_glRC )
160  {
162 
163  delete m_3d_render_raytracing;
164  m_3d_render_raytracing = NULL;
165 
166  delete m_3d_render_ogl_legacy;
167  m_3d_render_ogl_legacy = NULL;
168 
169  // This is just a copy of a pointer, can safelly be set to NULL
170  m_3d_render = NULL;
171 
174  m_glRC = NULL;
175  }
176 }
C3D_RENDER_RAYTRACING * m_3d_render_raytracing
Raytracing render class.
wxGLContext * m_glRC
current OpenGL context
C3D_RENDER_OGL_LEGACY * m_3d_render_ogl_legacy
OpenGL legacy render class.
void UnlockCtx(wxGLContext *aContext)
Function UnlockCtx allows other canvases to bind an OpenGL context.
static GL_CONTEXT_MANAGER & Get()
Function Get returns the GL_CONTEXT_MANAGER instance (singleton).
void LockCtx(wxGLContext *aContext, wxGLCanvas *aCanvas)
Function LockCtx sets a context as current and prevents other canvases from switching it...
C3D_RENDER_BASE * m_3d_render
The current render in used for this canvas.
void DestroyCtx(wxGLContext *aContext)
Function DestroyCtx destroys a managed OpenGL context.
void EDA_3D_CANVAS::ReloadRequest ( BOARD aBoard = NULL,
S3D_CACHE aCachePointer = NULL 
)

Definition at line 220 of file eda_3d_canvas.cpp.

References m_3d_render, m_settings, C3D_RENDER_BASE::ReloadRequest(), CINFO3D_VISU::Set3DCacheManager(), and CINFO3D_VISU::SetBoard().

Referenced by EDA_3D_VIEWER::ReloadRequest(), PANEL_PREV_3D::ResetModelData(), PANEL_PREV_3D::SetModelDataIdx(), SetView3D(), PANEL_PREV_3D::UpdateModelName(), and PANEL_PREV_3D::View3DUpdate().

221 {
222  if( aCachePointer != NULL )
223  m_settings.Set3DCacheManager( aCachePointer );
224 
225  if( aBoard != NULL )
226  m_settings.SetBoard( aBoard );
227 
228  if( m_3d_render )
230 }
CINFO3D_VISU & m_settings
Stores all pre-computed 3D information and visualization settings to render the board.
C3D_RENDER_BASE * m_3d_render
The current render in used for this canvas.
void ReloadRequest()
ReloadRequest - !TODO: this must be reviewed to add flags to improve specific render.
void SetBoard(BOARD *aBoard)
SetBoard - Set current board to be rendered.
Definition: cinfo3d_visu.h:122
void Set3DCacheManager(S3D_CACHE *aCachePointer)
Set3DCacheManager - Update the Cache manager pointer.
Definition: cinfo3d_visu.h:82
void EDA_3D_CANVAS::render_pivot ( float  t,
float  aScale 
)
private

render_pivot - render the pivot cursor

Parameters
ttime between 0.0 and 1.0
aScalescale to apply on the cursor

Definition at line 76 of file eda_3d_canvas_pivot.cpp.

References CINFO3D_VISU::CameraGet(), CCAMERA::GetLookAtPos_T1(), CCAMERA::GetProjectionMatrix(), CCAMERA::GetViewMatrix(), m_settings, and pivot_render_triangles().

Referenced by OnPaint().

77 {
78  wxASSERT( aScale >= 0.0f );
79  wxASSERT( t >= 0.0f );
80 
81  if( t > 1.0f )
82  t = 1.0f;
83 
84  const SFVEC3F &lookAtPos = m_settings.CameraGet().GetLookAtPos_T1();
85 
86  glDisable( GL_LIGHTING );
87  glDisable( GL_DEPTH_TEST );
88  glDisable( GL_CULL_FACE );
89 
90  // Set projection and modelview matrixes
91  // /////////////////////////////////////////////////////////////////////////
92  glMatrixMode( GL_PROJECTION );
93  glLoadMatrixf( glm::value_ptr( m_settings.CameraGet().GetProjectionMatrix() ) );
94 
95  glMatrixMode( GL_MODELVIEW );
96  glLoadIdentity();
97  glLoadMatrixf( glm::value_ptr( m_settings.CameraGet().GetViewMatrix() ) );
98 
99  glEnable( GL_COLOR_MATERIAL );
100  glColor4f( 0.0f, 1.0f, 0.0f, 0.75f - t * 0.75f );
101 
102  // Translate to the look at position
103  glTranslatef( lookAtPos.x, lookAtPos.y, lookAtPos.z );
104 
105  glScalef( aScale, aScale, aScale );
106 
107  pivot_render_triangles( t * 0.5f );
108 
109  t = t * 0.80f;
110  glScalef( 1.0f - t, 1.0f - t, 1.0f - t );
111  glColor4f( 0.0f, 1.0f, 0.0f, 0.8f - t );
112 
113  glPushMatrix();
114  glRotatef( t * 90.0f, 0.0f, 0.0f, 1.0f );
115  pivot_render_triangles( t * 0.5f );
116  glPopMatrix();
117 
118  glPushMatrix();
119  glRotatef( -t * 90.0f, 0.0f, 0.0f, 1.0f );
120  pivot_render_triangles( t * 0.5f );
121  glPopMatrix();
122 }
CINFO3D_VISU & m_settings
Stores all pre-computed 3D information and visualization settings to render the board.
const glm::mat4 & GetProjectionMatrix() const
Definition: ccamera.cpp:359
const glm::mat4 & GetViewMatrix() const
Definition: ccamera.cpp:389
const SFVEC3F & GetLookAtPos_T1() const
Definition: ccamera.h:129
CCAMERA & CameraGet() const
CameraGet - get current camera in use.
Definition: cinfo3d_visu.h:210
glm::vec3 SFVEC3F
Definition: xv3d_types.h:47
static void pivot_render_triangles(float t)
void EDA_3D_CANVAS::RenderEngineChanged ( )

RenderEngineChanged - Notify that the render engine was changed.

Definition at line 1026 of file eda_3d_canvas.cpp.

References m_3d_render, m_3d_render_ogl_legacy, m_3d_render_raytracing, m_mouse_was_moved, m_settings, C3D_RENDER_BASE::ReloadRequest(), RENDER_ENGINE_OPENGL_LEGACY, RENDER_ENGINE_RAYTRACING, CINFO3D_VISU::RenderEngineGet(), and Request_refresh().

Referenced by EDA_3D_VIEWER::RenderEngineChanged().

1027 {
1028 
1029  switch( m_settings.RenderEngineGet() )
1030  {
1033  break;
1034 
1037  break;
1038 
1039  default:
1040  m_3d_render = NULL;
1041  break;
1042  }
1043 
1044  if( m_3d_render )
1046 
1047  m_mouse_was_moved = false;
1048 
1049  Request_refresh();
1050 }
C3D_RENDER_RAYTRACING * m_3d_render_raytracing
Raytracing render class.
CINFO3D_VISU & m_settings
Stores all pre-computed 3D information and visualization settings to render the board.
C3D_RENDER_OGL_LEGACY * m_3d_render_ogl_legacy
OpenGL legacy render class.
void Request_refresh(bool aRedrawImmediately=true)
Request_refresh - Schedule a refresh update of the canvas.
bool m_mouse_was_moved
true if there was some type of activity, it will be used to render in preview mode ...
RENDER_ENGINE RenderEngineGet() const
RenderEngineGet.
Definition: cinfo3d_visu.h:234
C3D_RENDER_BASE * m_3d_render
The current render in used for this canvas.
void ReloadRequest()
ReloadRequest - !TODO: this must be reviewed to add flags to improve specific render.
void EDA_3D_CANVAS::RenderRaytracingRequest ( )

RenderRaytracingRequest - Request to render the current view in Raytracing mode.

Definition at line 233 of file eda_3d_canvas.cpp.

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

Referenced by EDA_3D_VIEWER::Process_Special_Functions().

234 {
236 
237  if( m_3d_render )
239 
241  //m_mouse_was_moved = true;
242 
243  Request_refresh();
244 }
C3D_RENDER_RAYTRACING * m_3d_render_raytracing
Raytracing render class.
void Request_refresh(bool aRedrawImmediately=true)
Request_refresh - Schedule a refresh update of the canvas.
C3D_RENDER_BASE * m_3d_render
The current render in used for this canvas.
void ReloadRequest()
ReloadRequest - !TODO: this must be reviewed to add flags to improve specific render.
bool m_render_raytracing_was_requested
Flags that the user requested the current view to be render with raytracing.
void EDA_3D_CANVAS::Request_refresh ( bool  aRedrawImmediately = true)

Request_refresh - 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 780 of file eda_3d_canvas.cpp.

References m_redraw_trigger_timer.

Referenced by EDA_3D_VIEWER::On3DGridSelection(), EDA_3D_VIEWER::OnActivate(), OnMouseMove(), OnMouseWheel(), OnPaint(), OnTimerTimeout_Editing(), EDA_3D_VIEWER::Process_Special_Functions(), EDA_3D_VIEWER::ProcessZoom(), RenderEngineChanged(), RenderRaytracingRequest(), request_start_moving_camera(), PANEL_PREV_3D::ResetModelData(), PANEL_PREV_3D::SetModelDataIdx(), and SetView3D().

781 {
782  if( aRedrawImmediately )
783  {
784  // On some systems, just calling Refresh does not work always
785  // (Issue experienced on Win7 MSYS2)
786  //Refresh();
787  //Update();
788 
789  // Using PostEvent will take priority to other events, like
790  // mouse movements, keys, etc.
791  wxPaintEvent redrawEvent;
792  wxPostEvent( this, redrawEvent );
793 
794  // This behaves the same
795  // wxQueueEvent( this,
796  // From wxWidget documentation: "The heap-allocated and
797  // non-NULL event to queue, the function takes ownership of it."
798  // new wxPaintEvent()
799  // );
800  }
801  else
802  {
803  // Schedule a timed redraw
804  m_redraw_trigger_timer.Start( 10 , wxTIMER_ONE_SHOT );
805  }
806 }
wxTimer m_redraw_trigger_timer
This timer will be used to schedule a redraw event.
void EDA_3D_CANVAS::request_start_moving_camera ( float  aMovingSpeed = 2.0f,
bool  aRenderPivot = true 
)
private

request_start_moving_camera - start a camera movement

Parameters
aMovingSpeedthe time speed
aRenderPivotif it should display pivot cursor while move

Definition at line 809 of file eda_3d_canvas.cpp.

References DisplayStatus(), GetRunningMicroSecs(), m_camera_is_moving, m_camera_moving_speed, m_render_pivot, m_strtime_camera_movement, Request_refresh(), and stop_editingTimeOut_Timer().

Referenced by move_pivot_based_on_cur_mouse_position(), and SetView3D().

810 {
811  wxASSERT( aMovingSpeed > FLT_EPSILON );
812 
813  m_render_pivot = aRenderPivot;
814  m_camera_moving_speed = aMovingSpeed;
815 
817 
818  DisplayStatus();
819  Request_refresh();
820 
821  m_camera_is_moving = true;
822 
824 }
unsigned m_strtime_camera_movement
Stores the ticktime when the camera star its movement.
void stop_editingTimeOut_Timer()
stop_editingTimeOut_Timer - stop the editing time, so it will not timeout
void DisplayStatus()
DisplayStatus - Update the status bar with the position information.
void Request_refresh(bool aRedrawImmediately=true)
Request_refresh - Schedule a refresh update of the canvas.
float m_camera_moving_speed
1.0f will be 1:1
bool m_camera_is_moving
true if camera animation is ongoing
bool m_render_pivot
activated the render of pivot while camera moving
unsigned GetRunningMicroSecs()
Function GetRunningMicroSecs An alternate way to calculate an elapset time (in microsecondes) to clas...
void EDA_3D_CANVAS::restart_editingTimeOut_Timer ( )
private

restart_editingTimeOut_Timer - reset the editing timer

Definition at line 762 of file eda_3d_canvas.cpp.

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

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

763 {
764  m_editing_timeout_timer.Start( m_3d_render->GetWaitForEditingTimeOut() , wxTIMER_ONE_SHOT );
765 }
wxTimer m_editing_timeout_timer
Time timeout will expires after some time sinalizing that the mouse / keyboard movements are over...
virtual int GetWaitForEditingTimeOut()=0
GetWaitForEditingTimeOut - Give the interface the time (in ms) that it should wait for editing or mov...
C3D_RENDER_BASE * m_3d_render
The current render in used for this canvas.
void EDA_3D_CANVAS::SetStatusBar ( wxStatusBar *  aStatusBar)
inline

Definition at line 74 of file eda_3d_canvas.h.

References m_parentStatusBar.

Referenced by EDA_3D_VIEWER::EDA_3D_VIEWER().

74 { m_parentStatusBar = aStatusBar; }
wxStatusBar * m_parentStatusBar
Parent statusbar to report progress.
void EDA_3D_CANVAS::SetView3D ( int  keycode)

SetView3D - Helper function to call view commands.

Parameters
keycodeascii key commands

Definition at line 853 of file eda_3d_canvas.cpp.

References CINFO3D_VISU::CameraGet(), DisplayStatus(), FL_MODULE_ATTRIBUTES_NORMAL, FL_MODULE_ATTRIBUTES_NORMAL_INSERT, FL_MODULE_ATTRIBUTES_VIRTUAL, CINFO3D_VISU::GetFlag(), INTERPOLATION_BEZIER, INTERPOLATION_EASING_IN_OUT, INTERPOLATION_LINEAR, m_camera_is_moving, m_delta_move_step_factor, m_mouse_was_moved, m_settings, max, min, move_pivot_based_on_cur_mouse_position(), CCAMERA::Pan_T1(), ReloadRequest(), Request_refresh(), request_start_moving_camera(), CCAMERA::Reset_T1(), restart_editingTimeOut_Timer(), CCAMERA::RotateX_T1(), CCAMERA::RotateZ_T1(), CINFO3D_VISU::SetFlag(), CCAMERA::SetInterpolateMode(), CCAMERA::SetT0_and_T1_current_T(), CCAMERA::Zoom_T1(), and CCAMERA::ZoomGet().

Referenced by OnKeyEvent(), OnPopUpMenu(), EDA_3D_VIEWER::Process_Special_Functions(), EDA_3D_VIEWER::ProcessZoom(), PANEL_PREV_3D::View3DBack(), PANEL_PREV_3D::View3DBottom(), PANEL_PREV_3D::View3DFront(), PANEL_PREV_3D::View3DLeft(), PANEL_PREV_3D::View3DRight(), and PANEL_PREV_3D::View3DTop().

854 {
855  if( m_camera_is_moving )
856  return;
857 
858  const float delta_move = m_delta_move_step_factor * m_settings.CameraGet().ZoomGet();
859  const float arrow_moving_time_speed = 8.0f;
860 
861  switch( keycode )
862  {
863  case WXK_SPACE:
865  return;
866 
867  case WXK_LEFT:
870  m_settings.CameraGet().Pan_T1( SFVEC3F( -delta_move, 0.0f, 0.0f ) );
871  request_start_moving_camera( arrow_moving_time_speed, false );
872  return;
873 
874  case WXK_RIGHT:
877  m_settings.CameraGet().Pan_T1( SFVEC3F( +delta_move, 0.0f, 0.0f ) );
878  request_start_moving_camera( arrow_moving_time_speed, false );
879  return;
880 
881  case WXK_UP:
884  m_settings.CameraGet().Pan_T1( SFVEC3F( 0.0f, +delta_move, 0.0f ) );
885  request_start_moving_camera( arrow_moving_time_speed, false );
886  return;
887 
888  case WXK_DOWN:
891  m_settings.CameraGet().Pan_T1( SFVEC3F( 0.0f, -delta_move, 0.0f ) );
892  request_start_moving_camera( arrow_moving_time_speed, false );
893  return;
894 
895  case WXK_HOME:
900  return;
901 
902  case WXK_END:
903  break;
904 
905  case WXK_TAB:
908  m_settings.CameraGet().RotateZ_T1( glm::radians( 45.0f ) );
910  break;
911 
912  case WXK_F1:
915  if( m_settings.CameraGet().Zoom_T1( 1.4f ) )
917  return;
918 
919  case WXK_F2:
922  if( m_settings.CameraGet().Zoom_T1( 1/1.4f ) )
924  return;
925 
926  case '+':
927  break;
928 
929  case '-':
930  break;
931 
932  case 't':
933  case 'T':
936  ReloadRequest();
937  break;
938 
939  case 's':
940  case 'S':
943  ReloadRequest();
944  break;
945 
946  case 'v':
947  case 'V':
950  ReloadRequest();
951  break;
952 
953  case 'r':
954  case 'R':
959  return;
960 
961  case 'x':
965  m_settings.CameraGet().RotateZ_T1( glm::radians( -90.0f ) );
966  m_settings.CameraGet().RotateX_T1( glm::radians( -90.0f ) );
968  return;
969 
970  case 'X':
974  m_settings.CameraGet().RotateZ_T1( glm::radians( 90.0f ) );
975  m_settings.CameraGet().RotateX_T1( glm::radians( -90.0f ) );
977  return;
978 
979  case 'y':
983  m_settings.CameraGet().RotateX_T1( glm::radians( -90.0f ) );
985  return;
986 
987  case 'Y':
991  m_settings.CameraGet().RotateX_T1( glm::radians( -90.0f ) );
992  m_settings.CameraGet().RotateZ_T1( glm::radians( -180.0f ) );
994  return;
995 
996  case 'z':
1001  glm::min( glm::max( m_settings.CameraGet().ZoomGet(), 0.5f ), 1.125f ) );
1002  return;
1003 
1004  case 'Z':
1008  m_settings.CameraGet().RotateX_T1( glm::radians( -180.0f ) );
1010  glm::min( glm::max( m_settings.CameraGet().ZoomGet(), 0.5f ), 1.125f ) );
1011  return;
1012 
1013  default:
1014  return;
1015  }
1016 
1017  m_mouse_was_moved = true;
1018 
1020 
1021  DisplayStatus();
1022  Request_refresh();
1023 }
float ZoomGet() const
Definition: ccamera.cpp:490
void request_start_moving_camera(float aMovingSpeed=2.0f, bool aRenderPivot=true)
request_start_moving_camera - start a camera movement
virtual void SetT0_and_T1_current_T()
SetT0_and_T1_current_T - This will set T0 and T1 with the current values.
Definition: ccamera.cpp:535
CINFO3D_VISU & m_settings
Stores all pre-computed 3D information and visualization settings to render the board.
void DisplayStatus()
DisplayStatus - Update the status bar with the position information.
void Request_refresh(bool aRedrawImmediately=true)
Request_refresh - Schedule a refresh update of the canvas.
void ReloadRequest(BOARD *aBoard=NULL, S3D_CACHE *aCachePointer=NULL)
void restart_editingTimeOut_Timer()
restart_editingTimeOut_Timer - reset the editing timer
bool m_mouse_was_moved
true if there was some type of activity, it will be used to render in preview mode ...
bool m_camera_is_moving
true if camera animation is ongoing
bool Zoom_T1(float aFactor)
Definition: ccamera.cpp:473
virtual void Pan_T1(const SFVEC3F &aDeltaOffsetInc)=0
void RotateX_T1(float aAngleInRadians)
Definition: ccamera.cpp:517
virtual void Reset_T1()
Definition: ccamera.cpp:92
bool GetFlag(DISPLAY3D_FLG aFlag) const
GetFlag - get a configuration status of a flag.
void move_pivot_based_on_cur_mouse_position()
move_pivot_based_on_cur_mouse_position - This function hits a ray to the board and start a moviment ...
#define max(a, b)
Definition: auxiliary.h:86
CCAMERA & CameraGet() const
CameraGet - get current camera in use.
Definition: cinfo3d_visu.h:210
glm::vec3 SFVEC3F
Definition: xv3d_types.h:47
void SetFlag(DISPLAY3D_FLG aFlag, bool aState)
SetFlag - set the status of a flag.
void RotateZ_T1(float aAngleInRadians)
Definition: ccamera.cpp:529
static const float m_delta_move_step_factor
Step factor to used with cursor on relation to the current zoom.
void SetInterpolateMode(CAMERA_INTERPOLATION aInterpolateMode)
Definition: ccamera.h:198
#define min(a, b)
Definition: auxiliary.h:85
void EDA_3D_CANVAS::stop_editingTimeOut_Timer ( )
private

stop_editingTimeOut_Timer - stop the editing time, so it will not timeout

Definition at line 756 of file eda_3d_canvas.cpp.

References m_editing_timeout_timer.

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

757 {
759 }
wxTimer m_editing_timeout_timer
Time timeout will expires after some time sinalizing that the mouse / keyboard movements are over...

Member Data Documentation

C3D_RENDER_BASE* EDA_3D_CANVAS::m_3d_render
private

The current render in used for this canvas.

Definition at line 252 of file eda_3d_canvas.h.

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

C3D_RENDER_OGL_LEGACY* EDA_3D_CANVAS::m_3d_render_ogl_legacy
private

OpenGL legacy render class.

Definition at line 258 of file eda_3d_canvas.h.

Referenced by OnPaint(), releaseOpenGL(), and RenderEngineChanged().

C3D_RENDER_RAYTRACING* EDA_3D_CANVAS::m_3d_render_raytracing
private

Raytracing render class.

Definition at line 255 of file eda_3d_canvas.h.

Referenced by releaseOpenGL(), RenderEngineChanged(), and RenderRaytracingRequest().

bool EDA_3D_CANVAS::m_camera_is_moving
private

true if camera animation is ongoing

Definition at line 237 of file eda_3d_canvas.h.

Referenced by OnKeyEvent(), OnLeftUp(), OnMiddleUp(), OnMouseMove(), OnMouseWheel(), OnPaint(), OnRightClick(), request_start_moving_camera(), and SetView3D().

float EDA_3D_CANVAS::m_camera_moving_speed
private

1.0f will be 1:1

Definition at line 243 of file eda_3d_canvas.h.

Referenced by OnPaint(), and request_start_moving_camera().

const float EDA_3D_CANVAS::m_delta_move_step_factor = 0.7f
staticprivate

Step factor to used with cursor on relation to the current zoom.

Definition at line 264 of file eda_3d_canvas.h.

Referenced by OnMouseWheel(), and SetView3D().

wxTimer EDA_3D_CANVAS::m_editing_timeout_timer
private

Time timeout will expires after some time sinalizing that the mouse / keyboard movements are over.

Definition at line 224 of file eda_3d_canvas.h.

Referenced by restart_editingTimeOut_Timer(), and stop_editingTimeOut_Timer().

wxGLContext* EDA_3D_CANVAS::m_glRC
private

current OpenGL context

Definition at line 217 of file eda_3d_canvas.h.

Referenced by OnPaint(), and releaseOpenGL().

bool EDA_3D_CANVAS::m_is_opengl_initialized
private

Flag to store if opengl was initialized already.

Definition at line 261 of file eda_3d_canvas.h.

Referenced by initializeOpenGL(), and OnPaint().

const wxChar * EDA_3D_CANVAS::m_logTrace = wxT( "KI_TRACE_EDA_3D_CANVAS" )
staticprivate

Trace mask used to enable or disable the trace output of this class.

The debug output can be turned on by setting the WXTRACE environment variable to "KI_TRACE_EDA_3D_CANVAS". See the wxWidgets documentation on wxLogTrace for more information.

Definition at line 275 of file eda_3d_canvas.h.

Referenced by initializeOpenGL(), OnEraseBackground(), OnMouseWheel(), OnPaint(), OnPopUpMenu(), OnRightClick(), and ~EDA_3D_CANVAS().

bool EDA_3D_CANVAS::m_mouse_is_moving
private

true if mouse activity is on progress

Definition at line 230 of file eda_3d_canvas.h.

Referenced by OnLeftUp(), OnMiddleUp(), OnMouseMove(), OnMouseWheel(), OnPaint(), and OnTimerTimeout_Editing().

bool EDA_3D_CANVAS::m_mouse_was_moved
private

true if there was some type of activity, it will be used to render in preview mode

Definition at line 234 of file eda_3d_canvas.h.

Referenced by OnMouseMove(), OnMouseWheel(), OnPaint(), OnTimerTimeout_Editing(), RenderEngineChanged(), and SetView3D().

wxStatusBar* EDA_3D_CANVAS::m_parentStatusBar
private

Parent statusbar to report progress.

Definition at line 220 of file eda_3d_canvas.h.

Referenced by DisplayStatus(), OnPaint(), and SetStatusBar().

wxTimer EDA_3D_CANVAS::m_redraw_trigger_timer
private

This timer will be used to schedule a redraw event.

Definition at line 227 of file eda_3d_canvas.h.

Referenced by Request_refresh().

bool EDA_3D_CANVAS::m_render_pivot
private

activated the render of pivot while camera moving

Definition at line 240 of file eda_3d_canvas.h.

Referenced by OnPaint(), and request_start_moving_camera().

bool EDA_3D_CANVAS::m_render_raytracing_was_requested
private

Flags that the user requested the current view to be render with raytracing.

Definition at line 267 of file eda_3d_canvas.h.

Referenced by OnPaint(), and RenderRaytracingRequest().

CINFO3D_VISU& EDA_3D_CANVAS::m_settings
private

Stores all pre-computed 3D information and visualization settings to render the board.

Definition at line 249 of file eda_3d_canvas.h.

Referenced by DisplayStatus(), move_pivot_based_on_cur_mouse_position(), OnMouseMove(), OnMouseWheel(), OnPaint(), ReloadRequest(), render_pivot(), RenderEngineChanged(), and SetView3D().

unsigned EDA_3D_CANVAS::m_strtime_camera_movement
private

Stores the ticktime when the camera star its movement.

Definition at line 246 of file eda_3d_canvas.h.

Referenced by OnPaint(), and request_start_moving_camera().


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