mrpt::gui::CDisplayWindow3DLocker Class Reference

Detailed Description

Auxiliary class for safely claiming the 3DScene of a mrpt::gui::CDisplayWindow3D.

The mutex will be hold between ctor and dtor calls of objects of this class, safely releasing the lock upon exceptions. See example usage code in docs of mrpt::gui::CDisplayWindow3D

Note

New in MRPT 1.5.0

Definition at line 437 of file CDisplayWindow3D.h.

#include <mrpt/gui/CDisplayWindow3D.h>

Public Member Functions
	CDisplayWindow3DLocker (CDisplayWindow3D &win, mrpt::opengl::COpenGLScene::Ptr &out_scene_ptr)
	Acquires the lock of the 3D scene of the referenced window, and returns a copy of the smart pointer to it. More...
	CDisplayWindow3DLocker (CDisplayWindow3D &win)
	Acquires the lock of the 3D scene of the referenced window. More...
	~CDisplayWindow3DLocker ()

Private Attributes
CDisplayWindow3D &	m_win

Constructor & Destructor Documentation

CDisplayWindow3DLocker() [1/2]

CDisplayWindow3DLocker::CDisplayWindow3DLocker	(	CDisplayWindow3D &	win,
		mrpt::opengl::COpenGLScene::Ptr &	out_scene_ptr
	)

Acquires the lock of the 3D scene of the referenced window, and returns a copy of the smart pointer to it.

Definition at line 1037 of file CDisplayWindow3D.cpp.

References mrpt::gui::CDisplayWindow3D::get3DSceneAndLock(), and m_win.

Here is the call graph for this function:

CDisplayWindow3DLocker() [2/2]

CDisplayWindow3DLocker::CDisplayWindow3DLocker

(

CDisplayWindow3D &

win

)

Acquires the lock of the 3D scene of the referenced window.

Use this signature when the scene object is not required.

Definition at line 1043 of file CDisplayWindow3D.cpp.

References mrpt::gui::CDisplayWindow3D::get3DSceneAndLock(), and m_win.

Here is the call graph for this function:

~CDisplayWindow3DLocker()

CDisplayWindow3DLocker::~CDisplayWindow3DLocker

(

)

Definition at line 1048 of file CDisplayWindow3D.cpp.

References m_win, and mrpt::gui::CDisplayWindow3D::unlockAccess3DScene().

Here is the call graph for this function:

Member Data Documentation

m_win

CDisplayWindow3D& mrpt::gui::CDisplayWindow3DLocker::m_win

private

Definition at line 450 of file CDisplayWindow3D.h.

Referenced by CDisplayWindow3DLocker(), and ~CDisplayWindow3DLocker().