C3D_MODEL_VIEWER Class Reference

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

#include <3d_model_viewer.h>

Inheritance diagram for C3D_MODEL_VIEWER:

Public Member Functions
	C3D_MODEL_VIEWER (wxWindow *aParent, const int *aAttribList=0, S3D_CACHE *aCacheManager=nullptr)
	Create a new 3D Canvas with a attribute list. More...
	~C3D_MODEL_VIEWER ()
void	Set3DModel (const S3DMODEL &a3DModel)
	Set this model to be displayed. More...
void	Set3DModel (wxString const &aModelPathName)
	Set this model to be displayed. More...
void	Clear3DModel ()
	Unload the displayed 3D model. More...
virtual wxSize	GetNativePixelSize () const
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...

Private Member Functions
void	ogl_initialize ()
void	ogl_set_arrow_material ()
void	OnPaint (wxPaintEvent &event)
void	OnEraseBackground (wxEraseEvent &event)
void	OnMouseWheel (wxMouseEvent &event)
void	OnMouseMove (wxMouseEvent &event)
void	OnLeftDown (wxMouseEvent &event)
void	OnLeftUp (wxMouseEvent &event)
void	OnMiddleUp (wxMouseEvent &event)
void	OnMiddleDown (wxMouseEvent &event)
void	OnRightClick (wxMouseEvent &event)

Private Attributes
wxGLContext *	m_glRC
	openGL context More...
TRACK_BALL	m_trackBallCamera
	Camera used in this canvas. More...
const S3DMODEL *	m_3d_model
	Original 3d model data. More...
MODEL_3D *	m_ogl_3dmodel
	Class holder for 3d model to display on openGL. More...
bool	m_reload_is_needed
	Flag that we have a new model and it need to be reloaded when the paint is called. More...
bool	m_ogl_initialized
	Flag if open gl was initialized. More...
double	m_BiuTo3dUnits
	factor to convert the model or any other items to keep it in relation to the +/-RANGE_SCALE_3D (it is named same as the board render for better understanding proposes) More...
S3D_CACHE *	m_cacheManager
	Optional cache manager. More...

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

Detailed Description

Implement a canvas based on a wxGLCanvas.

Definition at line 45 of file 3d_model_viewer.h.

Constructor & Destructor Documentation

C3D_MODEL_VIEWER()

C3D_MODEL_VIEWER::C3D_MODEL_VIEWER	(	wxWindow *	aParent,
		const int *	aAttribList = 0,
		S3D_CACHE *	aCacheManager = nullptr
	)

Create a new 3D Canvas with a attribute list.

Parameters

aParent	the parent creator of this canvas.
aAttribList	a list of openGL options created by OGL_ATT_LIST::GetAttributesList.

Definition at line 85 of file 3d_model_viewer.cpp.

                                                               :
        HIDPI_GL_CANVAS( aParent, wxID_ANY, aAttribList, wxDefaultPosition, wxDefaultSize,
                         wxFULL_REPAINT_ON_RESIZE ),
        m_trackBallCamera( RANGE_SCALE_3D * 2.0f ), m_cacheManager( aCacheManager )
{
    wxLogTrace( m_logTrace, wxT( "C3D_MODEL_VIEWER::C3D_MODEL_VIEWER" ) );

    m_ogl_initialized = false;
    m_reload_is_needed = false;
    m_ogl_3dmodel = nullptr;
    m_3d_model = nullptr;
    m_BiuTo3dUnits = 1.0;

    m_glRC = nullptr;
}

References m_3d_model, m_BiuTo3dUnits, m_glRC, m_logTrace, m_ogl_3dmodel, m_ogl_initialized, and m_reload_is_needed.

~C3D_MODEL_VIEWER()

C3D_MODEL_VIEWER::~C3D_MODEL_VIEWER

(

)

Definition at line 103 of file 3d_model_viewer.cpp.

{
    wxLogTrace( m_logTrace, wxT( "C3D_MODEL_VIEWER::~C3D_MODEL_VIEWER" ) );

    if( m_glRC )
    {
        GL_CONTEXT_MANAGER::Get().LockCtx( m_glRC, this );

        delete m_ogl_3dmodel;
        m_ogl_3dmodel = nullptr;

        GL_CONTEXT_MANAGER::Get().UnlockCtx( m_glRC );
        GL_CONTEXT_MANAGER::Get().DestroyCtx( m_glRC );
    }
}

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

Member Function Documentation

Clear3DModel()

void C3D_MODEL_VIEWER::Clear3DModel

(

)

Unload the displayed 3D model.

Definition at line 163 of file 3d_model_viewer.cpp.

{
    // Delete the old model
    m_reload_is_needed = false;

    delete m_ogl_3dmodel;
    m_ogl_3dmodel = nullptr;

    m_3d_model = nullptr;

    Refresh();
}

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

Referenced by Set3DModel().

GetNativePixelSize()

wxSize HIDPI_GL_CANVAS::GetNativePixelSize ( ) const

virtualinherited

Definition at line 46 of file hidpi_gl_canvas.cpp.

{
    wxSize size = wxGLCanvas::GetClientSize();

    const double scaleFactor = GetScaleFactor();
    size.x *= scaleFactor;
    size.y *= scaleFactor;

    return size;
}

References HIDPI_GL_CANVAS::GetScaleFactor().

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

GetScaleFactor()

double HIDPI_GL_CANVAS::GetScaleFactor ( ) const

inherited

Get the current scale factor.

Definition at line 64 of file hidpi_gl_canvas.cpp.

{
    return m_scale_factor;
}

References HIDPI_GL_CANVAS::m_scale_factor.

Referenced by KIGFX::OPENGL_GAL::beginDrawing(), KIGFX::OPENGL_GAL::DrawGrid(), HIDPI_GL_CANVAS::GetNativePixelSize(), KIGFX::OPENGL_GAL::getScreenPixelSize(), KIGFX::OPENGL_GAL::ResizeScreen(), KIGFX::PREVIEW::SetConstantGlyphHeight(), and KIGFX::OPENGL_GAL::updatedGalDisplayOptions().

ogl_initialize()

void C3D_MODEL_VIEWER::ogl_initialize ( )

private

Definition at line 177 of file 3d_model_viewer.cpp.

{
    glHint( GL_PERSPECTIVE_CORRECTION_HINT, GL_NICEST );
    glHint( GL_LINE_SMOOTH_HINT, GL_NICEST );
    glHint( GL_POLYGON_SMOOTH_HINT, GL_NICEST );

    glPolygonMode( GL_FRONT_AND_BACK, GL_FILL );
    glEnable( GL_DEPTH_TEST );
    glEnable( GL_CULL_FACE );
    glShadeModel( GL_SMOOTH );
    glEnable( GL_LINE_SMOOTH );
    glEnable( GL_NORMALIZE );

    // Setup light
    // https://www.opengl.org/sdk/docs/man2/xhtml/glLight.xml
    const GLfloat ambient[]  = { 0.01f, 0.01f, 0.01f, 1.0f };
    const GLfloat diffuse[]  = { 1.0f, 1.0f, 1.0f, 1.0f };
    const GLfloat specular[] = { 1.0f, 1.0f, 1.0f, 1.0f };

    // defines a directional light that points along the negative z-axis
    const GLfloat position[] = { 0.0f, 0.0f, 2.0f * RANGE_SCALE_3D, 0.0f };

    const GLfloat lmodel_ambient[] = { 0.0f, 0.0f, 0.0f, 1.0f };

    glLightfv( GL_LIGHT0, GL_AMBIENT,  ambient );
    glLightfv( GL_LIGHT0, GL_DIFFUSE,  diffuse );
    glLightfv( GL_LIGHT0, GL_SPECULAR, specular );
    glLightfv( GL_LIGHT0, GL_POSITION, position );
    glLightModelfv( GL_LIGHT_MODEL_AMBIENT, lmodel_ambient );
}

References RANGE_SCALE_3D.

Referenced by OnPaint().

ogl_set_arrow_material()

void C3D_MODEL_VIEWER::ogl_set_arrow_material ( )

private

Definition at line 209 of file 3d_model_viewer.cpp.

{
    glEnable( GL_COLOR_MATERIAL );
    glColorMaterial( GL_FRONT_AND_BACK, GL_AMBIENT_AND_DIFFUSE );

    const SFVEC4F specular = SFVEC4F( 0.1f, 0.1f, 0.1f, 1.0f );

    glMaterialfv( GL_FRONT_AND_BACK, GL_SPECULAR, &specular.r );
    glMaterialf(  GL_FRONT_AND_BACK, GL_SHININESS, 96.0f );
}

Referenced by OnPaint().

OnEraseBackground()

void C3D_MODEL_VIEWER::OnEraseBackground ( wxEraseEvent &  event )

private

Definition at line 352 of file 3d_model_viewer.cpp.

{
    wxLogTrace( m_logTrace, wxT( "C3D_MODEL_VIEWER::OnEraseBackground" ) );
    // Do nothing, to avoid flashing.
}

References m_logTrace.

OnLeftDown()

void C3D_MODEL_VIEWER::OnLeftDown ( wxMouseEvent &  event )

private

Definition at line 413 of file 3d_model_viewer.cpp.

{
    event.Skip();
}

OnLeftUp()

void C3D_MODEL_VIEWER::OnLeftUp ( wxMouseEvent &  event )

private

Definition at line 419 of file 3d_model_viewer.cpp.

{
    event.Skip();
}

OnMiddleDown()

void C3D_MODEL_VIEWER::OnMiddleDown ( wxMouseEvent &  event )

private

Definition at line 425 of file 3d_model_viewer.cpp.

{
    event.Skip();
}

OnMiddleUp()

void C3D_MODEL_VIEWER::OnMiddleUp ( wxMouseEvent &  event )

private

Definition at line 431 of file 3d_model_viewer.cpp.

{
    event.Skip();
}

OnMouseMove()

void C3D_MODEL_VIEWER::OnMouseMove ( wxMouseEvent &  event )

private

Definition at line 396 of file 3d_model_viewer.cpp.

{
    m_trackBallCamera.SetCurWindowSize( GetClientSize() );

    if( event.Dragging() )
    {
        if( event.LeftIsDown() )            // Drag
            m_trackBallCamera.Drag( event.GetPosition() );

        // orientation has changed, redraw mesh
        Refresh( false );
    }

    m_trackBallCamera.SetCurMousePosition( event.GetPosition() );
}

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

OnMouseWheel()

void C3D_MODEL_VIEWER::OnMouseWheel ( wxMouseEvent &  event )

private

Definition at line 359 of file 3d_model_viewer.cpp.

{
    wxLogTrace( m_logTrace, wxT( "C3D_MODEL_VIEWER::OnMouseWheel" ) );

    if( event.ShiftDown() )
    {
        //if( event.GetWheelRotation() < 0 )
            //SetView3D( WXK_UP );    // move up
        //else
            //SetView3D( WXK_DOWN );  // move down
    }
    else if( event.ControlDown() )
    {
        //if( event.GetWheelRotation() > 0 )
            //SetView3D( WXK_RIGHT ); // move right
        //else
            //SetView3D( WXK_LEFT );  // move left
    }
    else
    {
        m_trackBallCamera.Zoom( event.GetWheelRotation() > 0 ? 1.1f : 1/1.1f );

        //DisplayStatus();
        Refresh( false );
    }

    m_trackBallCamera.SetCurMousePosition( event.GetPosition() );
}

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

OnPaint()

void C3D_MODEL_VIEWER::OnPaint ( wxPaintEvent &  event )

private

Definition at line 221 of file 3d_model_viewer.cpp.

{
    event.Skip( false );

    // SwapBuffer requires the window to be shown before calling
    if( !IsShownOnScreen() )
    {
        wxLogTrace( m_logTrace, wxT( "C3D_MODEL_VIEWER::OnPaint !IsShown" ) );
        return;
    }

    // "Makes the OpenGL state that is represented by the OpenGL rendering
    //  context context current, i.e. it will be used by all subsequent OpenGL calls.
    //  This function may only be called when the window is shown on screen"
    if( m_glRC == nullptr )
        m_glRC = GL_CONTEXT_MANAGER::Get().CreateCtx( this );

    GL_CONTEXT_MANAGER::Get().LockCtx( m_glRC, this );

    // Set the OpenGL viewport according to the client size of this canvas.
    // This is done here rather than in a wxSizeEvent handler because our
    // OpenGL rendering context (and thus viewport setting) is used with
    // multiple canvases: If we updated the viewport in the wxSizeEvent
    // handler, changing the size of one canvas causes a viewport setting that
    // is wrong when next another canvas is repainted.
    wxSize clientSize = GetClientSize();

    if( !m_ogl_initialized )
    {
        m_ogl_initialized = true;
        ogl_initialize();
    }

    if( m_reload_is_needed )
    {
        wxLogTrace( m_logTrace, wxT( "C3D_MODEL_VIEWER::OnPaint m_reload_is_needed" ) );

        m_reload_is_needed = false;
        m_ogl_3dmodel      = new MODEL_3D( *m_3d_model, MATERIAL_MODE::NORMAL );

        // It convert a model as it was a board, so get the max size dimension of the board
        // and compute the conversion scale
        m_BiuTo3dUnits =
                (double) RANGE_SCALE_3D
                / ( (double) m_ogl_3dmodel->GetBBox().GetMaxDimension() * UNITS3D_TO_UNITSPCB );
    }

    glViewport( 0, 0, clientSize.x, clientSize.y );

    m_trackBallCamera.SetCurWindowSize( clientSize );

    // clear color and depth buffers
    glEnable( GL_DEPTH_TEST );
    glClearColor( 0.0f, 0.0f, 0.0f, 1.0f );
    glClearDepth( 1.0f );
    glClear( GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT );

    // Set projection and modelview matrices
    glMatrixMode( GL_PROJECTION );
    glLoadMatrixf( glm::value_ptr( m_trackBallCamera.GetProjectionMatrix() ) );
    glMatrixMode( GL_MODELVIEW );
    glLoadMatrixf( glm::value_ptr( m_trackBallCamera.GetViewMatrix() ) );
    glEnable( GL_LIGHTING );
    glEnable( GL_LIGHT0 );

    // Render Model
    if( m_ogl_3dmodel )
    {
        glPushMatrix();

        double modelunit_to_3d_units_factor = m_BiuTo3dUnits * UNITS3D_TO_UNITSPCB;

        glScaled( modelunit_to_3d_units_factor, modelunit_to_3d_units_factor,
                  modelunit_to_3d_units_factor );

        // Center model in the render viewport
        const SFVEC3F model_center = m_ogl_3dmodel->GetBBox().GetCenter();

        glTranslatef( -model_center.x, -model_center.y, -model_center.z );

        m_ogl_3dmodel->BeginDrawMulti( true );

        m_ogl_3dmodel->DrawOpaque( false );
        m_ogl_3dmodel->DrawTransparent( 1.0f, false );

        m_ogl_3dmodel->EndDrawMulti();

        glPopMatrix();
    }

    // YxY squared view port
    glViewport( 0, 0, clientSize.y / 8 , clientSize.y / 8 );
    glClear( GL_DEPTH_BUFFER_BIT );

    glMatrixMode( GL_PROJECTION );
    glLoadIdentity();
    gluPerspective( 45.0f, 1.0f, 0.01f, RANGE_SCALE_3D * 2.0f );

    glMatrixMode( GL_MODELVIEW );
    glLoadIdentity();

    const glm::mat4 TranslationMatrix = glm::translate( glm::mat4(1.0f),
                                                        SFVEC3F( 0.0f, 0.0f, -RANGE_SCALE_3D ) );

    const glm::mat4 ViewMatrix = TranslationMatrix * m_trackBallCamera.GetRotationMatrix();

    glLoadMatrixf( glm::value_ptr( ViewMatrix ) );

    ogl_set_arrow_material();

    glColor3f( 0.9f, 0.0f, 0.0f );
    DrawRoundArrow( SFVEC3F( 0.0f, 0.0f, 0.0f ), SFVEC3F( RANGE_SCALE_3D / 2.65f, 0.0f, 0.0f ),
                    0.275f );

    glColor3f( 0.0f, 0.9f, 0.0f );
    DrawRoundArrow( SFVEC3F( 0.0f, 0.0f, 0.0f ), SFVEC3F( 0.0f, RANGE_SCALE_3D / 2.65f, 0.0f ),
                    0.275f );

    glColor3f( 0.0f, 0.0f, 0.9f );
    DrawRoundArrow( SFVEC3F( 0.0f, 0.0f, 0.0f ), SFVEC3F( 0.0f, 0.0f, RANGE_SCALE_3D / 2.65f ),
                    0.275f );

    // "Swaps the double-buffer of this window, making the back-buffer the
    //  front-buffer and vice versa, so that the output of the previous OpenGL
    //  commands is displayed on the window."
    SwapBuffers();

    GL_CONTEXT_MANAGER::Get().UnlockCtx( m_glRC );
}

References MODEL_3D::BeginDrawMulti(), GL_CONTEXT_MANAGER::CreateCtx(), MODEL_3D::DrawOpaque(), DrawRoundArrow(), MODEL_3D::DrawTransparent(), MODEL_3D::EndDrawMulti(), GL_CONTEXT_MANAGER::Get(), MODEL_3D::GetBBox(), BBOX_3D::GetCenter(), BBOX_3D::GetMaxDimension(), CAMERA::GetProjectionMatrix(), CAMERA::GetRotationMatrix(), CAMERA::GetViewMatrix(), GL_CONTEXT_MANAGER::LockCtx(), m_3d_model, m_BiuTo3dUnits, m_glRC, m_logTrace, m_ogl_3dmodel, m_ogl_initialized, m_reload_is_needed, m_trackBallCamera, NORMAL, ogl_initialize(), ogl_set_arrow_material(), RANGE_SCALE_3D, CAMERA::SetCurWindowSize(), UNITS3D_TO_UNITSPCB, and GL_CONTEXT_MANAGER::UnlockCtx().

OnRightClick()

void C3D_MODEL_VIEWER::OnRightClick ( wxMouseEvent &  event )

private

Definition at line 437 of file 3d_model_viewer.cpp.

{
    event.Skip();
}

Set3DModel() [1/2]

void C3D_MODEL_VIEWER::Set3DModel

(

const S3DMODEL &

a3DModel

)

Set this model to be displayed.

Parameters

a3DModel

3D model data.

Definition at line 120 of file 3d_model_viewer.cpp.

{
    wxLogTrace( m_logTrace, wxT( "C3D_MODEL_VIEWER::Set3DModel with a S3DMODEL" ) );

    // Validate a3DModel pointers
    wxASSERT( a3DModel.m_Materials != nullptr );
    wxASSERT( a3DModel.m_Meshes != nullptr );
    wxASSERT( a3DModel.m_MaterialsSize > 0 );
    wxASSERT( a3DModel.m_MeshesSize > 0 );

    // Delete the old model
    delete m_ogl_3dmodel;
    m_ogl_3dmodel = nullptr;

    m_3d_model = nullptr;

    if( ( a3DModel.m_Materials != nullptr ) && ( a3DModel.m_Meshes != nullptr )
      && ( a3DModel.m_MaterialsSize > 0 ) && ( a3DModel.m_MeshesSize > 0 ) )
    {
        m_3d_model = &a3DModel;
        m_reload_is_needed = true;
    }

    Refresh();
}

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

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

Set3DModel() [2/2]

void C3D_MODEL_VIEWER::Set3DModel

(

wxString const &

aModelPathName

)

Set this model to be displayed.

Parameters

aModelPathName

3D model path name.

Definition at line 147 of file 3d_model_viewer.cpp.

{
    wxLogTrace( m_logTrace, wxT( "C3D_MODEL_VIEWER::Set3DModel with a wxString" ) );

    if( m_cacheManager )
    {
        const S3DMODEL* model = m_cacheManager->GetModel( aModelPathName );

        if( model )
            Set3DModel( (const S3DMODEL &)*model );
        else
            Clear3DModel();
    }
}

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

SetScaleFactor()

void HIDPI_GL_CANVAS::SetScaleFactor ( double  aFactor )

inherited

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

Definition at line 58 of file hidpi_gl_canvas.cpp.

{
    m_scale_factor = aNewScaleFactor;
}

References HIDPI_GL_CANVAS::m_scale_factor.

Referenced by PANEL_PREV_3D::loadCommonSettings(), EDA_3D_VIEWER::loadCommonSettings(), and KIGFX::OPENGL_GAL::updatedGalDisplayOptions().

Member Data Documentation

m_3d_model

const S3DMODEL* C3D_MODEL_VIEWER::m_3d_model

private

Original 3d model data.

Definition at line 113 of file 3d_model_viewer.h.

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

m_BiuTo3dUnits

double C3D_MODEL_VIEWER::m_BiuTo3dUnits

private

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

Definition at line 127 of file 3d_model_viewer.h.

Referenced by C3D_MODEL_VIEWER(), and OnPaint().

m_cacheManager

S3D_CACHE* C3D_MODEL_VIEWER::m_cacheManager

private

Optional cache manager.

Definition at line 130 of file 3d_model_viewer.h.

Referenced by Set3DModel().

m_glRC

wxGLContext* C3D_MODEL_VIEWER::m_glRC

private

openGL context

Definition at line 107 of file 3d_model_viewer.h.

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

m_ogl_3dmodel

MODEL_3D* C3D_MODEL_VIEWER::m_ogl_3dmodel

private

Class holder for 3d model to display on openGL.

Definition at line 116 of file 3d_model_viewer.h.

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

m_ogl_initialized

bool C3D_MODEL_VIEWER::m_ogl_initialized

private

Flag if open gl was initialized.

Definition at line 122 of file 3d_model_viewer.h.

Referenced by C3D_MODEL_VIEWER(), and OnPaint().

m_reload_is_needed

bool C3D_MODEL_VIEWER::m_reload_is_needed

private

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

Definition at line 119 of file 3d_model_viewer.h.

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

m_trackBallCamera

TRACK_BALL C3D_MODEL_VIEWER::m_trackBallCamera

private

Camera used in this canvas.

Definition at line 110 of file 3d_model_viewer.h.

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

---

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

• 3d_model_viewer.h
• 3d_model_viewer.cpp