Visualization Library 2.0.0-b3

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vlQt5::Qt5Widget Class Reference

The Qt5Widget class implements an OpenGLContext using the Qt5 API. More...

#include <Qt5Widget.hpp>

+ Inheritance diagram for vlQt5::Qt5Widget:

Public Member Functions

 Qt5Widget (QWidget *parent=NULL, const QGLWidget *shareWidget=NULL, Qt::WindowFlags f=0)
 
 ~Qt5Widget ()
 
void dragEnterEvent (QDragEnterEvent *ev)
 
void dropEvent (QDropEvent *ev)
 
bool initQt5Widget (const vl::String &title, const vl::OpenGLContextFormat &info, const QGLContext *shareContext=0, int x=0, int y=0, int width=640, int height=480)
 
virtual void setContinuousUpdate (bool continuous)
 If the OpenGL context is a widget this function sets whether its area is continuously updated at each frame. More...
 
void setRefreshRate (int msec)
 
int refreshRate ()
 
void initializeGL ()
 
void resizeGL (int width, int height)
 
void paintGL ()
 
void update ()
 If the OpenGLContext is a widget this function requests a redraw and generates an updateEvent(). More...
 
virtual void setWindowTitle (const vl::String &title)
 If the OpenGL context is a top window this function sets its title. More...
 
virtual bool setFullscreen (bool fullscreen)
 If the OpenGL context is a widget this function requests a maximization to fullscreen. More...
 
virtual void quitApplication ()
 Asks to the windowing system that is managing the OpenGLContext to quit the application. More...
 
virtual void show ()
 If the OpenGL context is a widget this function makes it visible to the user. More...
 
virtual void hide ()
 If the OpenGL context is a widget this function makes it invisible to the user. More...
 
virtual void setPosition (int x, int y)
 If the OpenGL context is a widget this function sets its position. More...
 
virtual vl::ivec2 position () const
 If the OpenGL context is a widget this function returns its position. More...
 
virtual void setSize (int w, int h)
 If the OpenGL context is a widget this function sets its size. More...
 
virtual vl::ivec2 size () const
 
void swapBuffers ()
 Swaps the back and front buffers to present the last rendering. More...
 
void makeCurrent ()
 Sets the OpenGL context as current for the calling thread. More...
 
void setMousePosition (int x, int y)
 If the OpenGL context is a widget this function sets the mouse position. More...
 
void mouseMoveEvent (QMouseEvent *ev)
 
void mousePressEvent (QMouseEvent *ev)
 
void mouseReleaseEvent (QMouseEvent *ev)
 
void wheelEvent (QWheelEvent *ev)
 
void keyPressEvent (QKeyEvent *ev)
 
void keyReleaseEvent (QKeyEvent *ev)
 
virtual void setMouseVisible (bool visible)
 If the OpenGL context is a widget this function sets whether the mouse is visible over it or not. More...
 
virtual void getFocus ()
 If the OpenGL context is a widget this function requests the mouse focus on it. More...
 
- Public Member Functions inherited from vl::OpenGLContext
 OpenGLContext (int w=0, int h=0)
 Constructor. More...
 
 ~OpenGLContext ()
 Destructor. More...
 
bool initGLContext (bool log=true)
 Initializes the supported OpenGL extensions. More...
 
void logOpenGLInfo ()
 Logs some information about the OpenGL context. More...
 
const std::string & extensions () const
 Returns the list of OpenGL extensions supported separated by '|' characters. More...
 
bool isExtensionSupported (const char *ext_name)
 Returns true if the given extension is supported. More...
 
void * getProcAddress (const char *function_name)
 Returns the address of an OpenGL extension function. More...
 
FramebufferleftFramebuffer ()
 The render target representing the default left framebuffer. More...
 
const FramebufferleftFramebuffer () const
 The render target representing the default left framebuffer. More...
 
FramebufferrightFramebuffer ()
 The render target representing the default right framebuffer (if a stereo OpenGL context is present). More...
 
const FramebufferrightFramebuffer () const
 The render target representing the default right framebuffer (if a stereo OpenGL context is present). More...
 
Framebufferframebuffer ()
 The default render target (always returns leftFramebuffer()). More...
 
const Framebufferframebuffer () const
 The default render target (always returns leftFramebuffer()). More...
 
ref< FramebufferObjectcreateFramebufferObject ()
 Equivalent to "createFramebufferObject(0,0);". More...
 
ref< FramebufferObjectcreateFramebufferObject (int width, int height, EReadDrawBuffer draw_buffer=RDB_COLOR_ATTACHMENT0, EReadDrawBuffer read_buffer=RDB_COLOR_ATTACHMENT0)
 Creates a new FramebufferObject (framebuffer object Framebuffer). More...
 
void destroyFramebufferObject (FramebufferObject *fbort)
 Destroys the specified FramebufferObject. More...
 
void destroyAllFramebufferObjects ()
 Removes all FramebufferObjects belonging to an OpenGLContext. More...
 
void destroyAllOpenGLResources ()
 Removes all OpenGL resources handled by the OpenGLContext. More...
 
virtual bool fullscreen () const
 If the OpenGL context is a widget this function returns whether it has been maximized to fullscreen. More...
 
int width () const
 Returns the width in pixels of an OpenGLContext. More...
 
int height () const
 Returns the height in pixels of an OpenGLContext. More...
 
virtual bool mouseVisible () const
 If the OpenGL context is a widget this function returns whether the mouse is visible over it or not. More...
 
void setVSyncEnabled (bool enable)
 If the OpenGL context is a widget this function enabled/disables double buffer swapping to the monitor's vertical synch. More...
 
bool vsyncEnabled () const
 If the OpenGL context is a widget this function returns whether vsync is enabled or not. More...
 
bool continuousUpdate () const
 If the OpenGL context is a widget this function returns whether its area is continuously updated at each frame. More...
 
void addEventListener (UIEventListener *el)
 Adds an UIEventListener to be notified of OpenGLContext related events. More...
 
void removeEventListener (UIEventListener *el)
 Removes an UIEventListener. More...
 
void eraseAllEventListeners ()
 Removes all UIEventListener previously registered. More...
 
const std::vector< ref< UIEventListener > > & eventListeners () const
 The currently UIEventListener registered to be notified of OpenGLContext related events. More...
 
const UIEventListenereventListener (int i) const
 Returns the i-th UIEventListener registered to an OpenGLContext. More...
 
UIEventListenereventListener (int i)
 Returns the i-th UIEventListener registered to an OpenGLContext. More...
 
int eventListenerCount () const
 Returns the number of UIEventListener registered to an OpenGLContext. More...
 
const OpenGLContextFormatopenglContextInfo () const
 Returns an OpenGLContextFormat structure describing an OpenGLContext. More...
 
void setOpenGLContextInfo (const OpenGLContextFormat &info)
 Sets the OpenGLContextFormat associated to an OpenGLContext. More...
 
void ignoreNextMouseMoveEvent ()
 Requests not to dispatch the next mouse move event. More...
 
void dispatchResizeEvent (int w, int h)
 Dispatches the UIEventListener::resizeEvent() notification to the subscribed UIEventListener objects. More...
 
void dispatchMouseMoveEvent (int x, int y)
 Dispatches the UIEventListener::mouseMoveEvent() notification to the subscribed UIEventListener objects. More...
 
void dispatchMouseUpEvent (EMouseButton button, int x, int y)
 Dispatches the UIEventListener::mouseUpEvent() notification to the subscribed UIEventListener objects. More...
 
void dispatchMouseDownEvent (EMouseButton button, int x, int y)
 Dispatches the UIEventListener::mouseDownEvent() notification to the subscribed UIEventListener objects. More...
 
void dispatchMouseWheelEvent (int n)
 Dispatches the UIEventListener::mouseWheelEvent() notification to the subscribed UIEventListener objects. More...
 
void dispatchKeyPressEvent (unsigned short unicode_ch, EKey key)
 Dispatches the UIEventListener::keyPressEvent() notification to the subscribed UIEventListener objects. More...
 
void dispatchKeyReleaseEvent (unsigned short unicode_ch, EKey key)
 Dispatches the UIEventListener::keyReleaseEvent() notification to the subscribed UIEventListener objects. More...
 
void dispatchDestroyEvent ()
 Dispatches the UIEventListener::destroyEvent() notification to the subscribed UIEventListener(s), calls destroyAllOpenGLResources() and eraseAllEventListeners() This event must be issued just before the actual GL context is destroyed. More...
 
void dispatchUpdateEvent ()
 Dispatches the UIEventListener::updateEvent() notification to the subscribed UIEventListener objects. More...
 
void dispatchVisibilityEvent (bool visible)
 Dispatches the UIEventListener::visibilityEvent() notification to the subscribed UIEventListener objects. More...
 
void dispatchInitEvent ()
 Dispatches the UIEventListener::initEvent() notification to the subscribed UIEventListener objects. More...
 
void dispatchFileDroppedEvent (const std::vector< String > &files)
 Dispatches the UIEventListener::fileDroppedEvent() notification to the subscribed UIEventListener objects. More...
 
const std::set< EKey > & keyboard () const
 Returns the std::set containing the currently pressed keys. More...
 
bool isKeyPressed (EKey key) const
 Returns true if the given key is pressed. More...
 
void keyPress (EKey key)
 Inserts the specified key in the set of currently active keys - For internal use only. More...
 
void keyRelease (EKey key)
 Removes the specified key from the set of currently active keys - For internal use only. More...
 
bool isInitialized () const
 Returns true if the OpenGLContext is in an initialized state. More...
 
int vertexAttribCount () const
 The number (clamped to VA_MaxAttribCount) of generic vertex attributes as returned by glGet(GL_MAX_VERTEX_ATTRIBS) More...
 
int textureImageUnitCount () const
 The number (clamped to VL_MAX_TEXTURE_IMAGE_UNITS) of texture image units supported by the current hardware. More...
 
int textureCoordCount () const
 The number (clamped to VL_MAX_LEGACY_TEXTURE_UNITS) of fixed function pipeline texture units supported by the current hardware. More...
 
bool hasDoubleBuffer () const
 Returns true if an OpenGLContext supports double buffering. More...
 
void useGLSLProgram (const GLSLProgram *glsl)
 Activates the given GLSLProgram or unbinds the current one if glsl is NULL. More...
 
void bindVAS (const IVertexAttribSet *vas, bool use_vbo, bool force)
 Activates the specified vertex attribute set - For internal use only. More...
 
void bindVAS_Attribs (const IVertexAttribSet *vas, bool use_vbo)
 
void bindVAS_Fixed (const IVertexAttribSet *vas, bool use_vbo)
 
void bindVAS_Reset ()
 
void applyEnables (const EnableSet *cur)
 Applies an EnableSet to an OpenGLContext - Typically for internal use only. More...
 
void applyRenderStates (const RenderStateSet *cur, const Camera *camera)
 Applies a RenderStateSet to an OpenGLContext - Typically for internal use only. More...
 
void resetEnables ()
 Resets all the interanal enable-tables - For internal use only. More...
 
void resetRenderStates ()
 Resets all the interanal render-states-tables - For internal use only. More...
 
void setDefaultRenderState (const RenderStateSlot &rs_slot)
 Defines the default render state slot to be used by the opengl context. More...
 
const RenderStateSlotdefaultRenderState (ERenderState rs)
 Returns the default render state slot used by VL when a specific render state type is left undefined. More...
 
void resetContextStates (EResetContextStates start_or_finish)
 Resets the OpenGL states necessary to begin and finish a rendering. - For internal use only. More...
 
void setTexUnitBinding (int unit_i, ETextureDimension target)
 Declares that texture unit unit_i is currently bound to the specified texture target. - For internal use only. More...
 
ETextureDimension texUnitBinding (int unit_i) const
 Returnes the texture target currently active for the specified texture unit. - For internal use only. More...
 
const GLSLProgramglslProgram () const
 
GLSLProgramglslProgram ()
 
bool isCleanState (bool verbose)
 Checks whether the OpenGL state is clean or not. More...
 
const fvec3normal () const
 
const fvec4color () const
 
const fvec3secondaryColor () const
 
const fvec4vertexAttribValue (int i) const
 
- Public Member Functions inherited from vl::Object
 Object ()
 Constructor. More...
 
 Object (const Object &other)
 Copy constructor: copies the name, ref count mutex and user data. More...
 
Objectoperator= (const Object &other)
 Copy operator: copies the object's name, ref count mutex and user data. More...
 
const std::string & objectName () const
 The name of the object, by default set to the object's class name. More...
 
void setObjectName (const char *name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setObjectName (const std::string &name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setRefCountMutex (IMutex *mutex)
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
IMutexrefCountMutex ()
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
const IMutexrefCountMutex () const
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
int referenceCount () const
 Returns the number of references of an object. More...
 
void incReference () const
 Increments the reference count of an object. More...
 
void decReference ()
 Decrements the reference count of an object and deletes it if both automaticDelete() is true the count reaches 0. More...
 
void setAutomaticDelete (bool autodel_on)
 If set to true the Object is deleted when its reference count reaches 0. More...
 
bool automaticDelete () const
 If set to true the Object is deleted when its reference count reaches 0. More...
 
template<class T >
T * as ()
 Casts an Object to the specified class. More...
 
template<class T >
const T * as () const
 Casts an Object to the specified class. More...
 

Protected Member Functions

void translateKeyEvent (QKeyEvent *ev, unsigned short &unicode_out, vl::EKey &key_out)
 
- Protected Member Functions inherited from vl::Object
virtual ~Object ()
 

Protected Attributes

int mRefresh
 
QTimer mUpdateTimer
 
- Protected Attributes inherited from vl::OpenGLContext
ref< FramebuffermLeftFramebuffer
 
ref< FramebuffermRightFramebuffer
 
std::vector< ref< FramebufferObject > > mFramebufferObject
 
std::vector< ref< UIEventListener > > mEventListeners
 
std::set< EKeymKeyboard
 
OpenGLContextFormat mGLContextInfo
 
int mVertexAttribCount
 
int mTextureImageUnitCount
 
int mTextureCoordCount
 
bool mMouseVisible
 
bool mContinuousUpdate
 
bool mIgnoreNextMouseMoveEvent
 
bool mFullscreen
 
bool mHasDoubleBuffer
 
bool mIsInitialized
 
std::string mExtensions
 
RenderStateSlot mDefaultRenderStates [RS_RenderStateCount]
 
ref< NaryQuickMap< EEnable, EEnable, EN_EnableCount > > mCurrentEnableSet
 
ref< NaryQuickMap< EEnable, EEnable, EN_EnableCount > > mNewEnableSet
 
ref< NaryQuickMap< ERenderState, RenderStateSlot, RS_RenderStateCount > > mCurrentRenderStateSet
 
ref< NaryQuickMap< ERenderState, RenderStateSlot, RS_RenderStateCount > > mNewRenderStateSet
 
ETextureDimension mTexUnitBinding [VL_MAX_TEXTURE_IMAGE_UNITS]
 
ref< GLSLProgrammGLSLProgram
 
bool mGLSLUpdated
 
const IVertexAttribSetmCurVAS
 
VertexArrayInfo mVertexArray
 
VertexArrayInfo mNormalArray
 
VertexArrayInfo mColorArray
 
VertexArrayInfo mSecondaryColorArray
 
VertexArrayInfo mFogArray
 
VertexArrayInfo mTexCoordArray [VA_MaxTexCoordCount]
 
VertexArrayInfo mVertexAttrib [VA_MaxAttribCount]
 
fvec3 mNormal
 
fvec4 mColor
 
fvec3 mSecondaryColor
 
fvec4 mVertexAttribValue [VA_MaxAttribCount]
 
GLuint mDefaultVAO
 
- Protected Attributes inherited from vl::Object
std::string mObjectName
 
IMutexmRefCountMutex
 
int mReferenceCount
 
bool mAutomaticDelete
 

Additional Inherited Members

- Static Public Member Functions inherited from vl::OpenGLContext
static bool areUniformsColliding (const UniformSet *u1, const UniformSet *u2)
 Returns true if the two UniformSet contain at least one Uniform variable with the same name. More...
 

Detailed Description

The Qt5Widget class implements an OpenGLContext using the Qt5 API.

Definition at line 54 of file Qt5Widget.hpp.

Constructor & Destructor Documentation

◆ Qt5Widget()

vlQt5::Qt5Widget::Qt5Widget ( QWidget *  parent = NULL,
const QGLWidget *  shareWidget = NULL,
Qt::WindowFlags  f = 0 
)
inline

Definition at line 62 of file Qt5Widget.hpp.

References vl::Object::setAutomaticDelete().

◆ ~Qt5Widget()

vlQt5::Qt5Widget::~Qt5Widget ( )
inline

Definition at line 74 of file Qt5Widget.hpp.

Member Function Documentation

◆ dragEnterEvent()

void vlQt5::Qt5Widget::dragEnterEvent ( QDragEnterEvent *  ev)
inline

Definition at line 79 of file Qt5Widget.hpp.

◆ dropEvent()

void vlQt5::Qt5Widget::dropEvent ( QDropEvent *  ev)
inline

Definition at line 85 of file Qt5Widget.hpp.

◆ getFocus()

virtual void vlQt5::Qt5Widget::getFocus ( )
inlinevirtual

If the OpenGL context is a widget this function requests the mouse focus on it.

Reimplemented from vl::OpenGLContext.

Definition at line 409 of file Qt5Widget.hpp.

References vlEGL::translateKeyEvent().

◆ hide()

virtual void vlQt5::Qt5Widget::hide ( )
inlinevirtual

If the OpenGL context is a widget this function makes it invisible to the user.

Reimplemented from vl::OpenGLContext.

Definition at line 302 of file Qt5Widget.hpp.

◆ initializeGL()

void vlQt5::Qt5Widget::initializeGL ( )
inline

Definition at line 252 of file Qt5Widget.hpp.

◆ initQt5Widget()

bool vlQt5::Qt5Widget::initQt5Widget ( const vl::String title,
const vl::OpenGLContextFormat info,
const QGLContext *  shareContext = 0,
int  x = 0,
int  y = 0,
int  width = 640,
int  height = 480 
)
inline

◆ keyPressEvent()

void vlQt5::Qt5Widget::keyPressEvent ( QKeyEvent *  ev)
inline

Definition at line 384 of file Qt5Widget.hpp.

References vl::Key_None, and vlEGL::translateKeyEvent().

◆ keyReleaseEvent()

void vlQt5::Qt5Widget::keyReleaseEvent ( QKeyEvent *  ev)
inline

Definition at line 392 of file Qt5Widget.hpp.

References vl::Key_None, and vlEGL::translateKeyEvent().

◆ makeCurrent()

void vlQt5::Qt5Widget::makeCurrent ( )
inlinevirtual

Sets the OpenGL context as current for the calling thread.

Implements vl::OpenGLContext.

Definition at line 334 of file Qt5Widget.hpp.

◆ mouseMoveEvent()

void vlQt5::Qt5Widget::mouseMoveEvent ( QMouseEvent *  ev)
inline

Definition at line 344 of file Qt5Widget.hpp.

◆ mousePressEvent()

void vlQt5::Qt5Widget::mousePressEvent ( QMouseEvent *  ev)
inline

◆ mouseReleaseEvent()

void vlQt5::Qt5Widget::mouseReleaseEvent ( QMouseEvent *  ev)
inline

◆ paintGL()

void vlQt5::Qt5Widget::paintGL ( )
inline

Definition at line 265 of file Qt5Widget.hpp.

◆ position()

virtual vl::ivec2 vlQt5::Qt5Widget::position ( ) const
inlinevirtual

If the OpenGL context is a widget this function returns its position.

Reimplemented from vl::OpenGLContext.

Definition at line 312 of file Qt5Widget.hpp.

◆ quitApplication()

virtual void vlQt5::Qt5Widget::quitApplication ( )
inlinevirtual

Asks to the windowing system that is managing the OpenGLContext to quit the application.

Reimplemented from vl::OpenGLContext.

Definition at line 291 of file Qt5Widget.hpp.

◆ refreshRate()

int vlQt5::Qt5Widget::refreshRate ( )
inline

Definition at line 247 of file Qt5Widget.hpp.

◆ resizeGL()

void vlQt5::Qt5Widget::resizeGL ( int  width,
int  height 
)
inline

Definition at line 260 of file Qt5Widget.hpp.

◆ setContinuousUpdate()

virtual void vlQt5::Qt5Widget::setContinuousUpdate ( bool  continuous)
inlinevirtual

If the OpenGL context is a widget this function sets whether its area is continuously updated at each frame.

Reimplemented from vl::OpenGLContext.

Definition at line 223 of file Qt5Widget.hpp.

◆ setFullscreen()

virtual bool vlQt5::Qt5Widget::setFullscreen ( bool  )
inlinevirtual

If the OpenGL context is a widget this function requests a maximization to fullscreen.

Reimplemented from vl::OpenGLContext.

Definition at line 281 of file Qt5Widget.hpp.

◆ setMousePosition()

void vlQt5::Qt5Widget::setMousePosition ( int  ,
int   
)
inlinevirtual

If the OpenGL context is a widget this function sets the mouse position.

Reimplemented from vl::OpenGLContext.

Definition at line 339 of file Qt5Widget.hpp.

◆ setMouseVisible()

virtual void vlQt5::Qt5Widget::setMouseVisible ( bool  )
inlinevirtual

If the OpenGL context is a widget this function sets whether the mouse is visible over it or not.

Reimplemented from vl::OpenGLContext.

Definition at line 400 of file Qt5Widget.hpp.

◆ setPosition()

virtual void vlQt5::Qt5Widget::setPosition ( int  ,
int   
)
inlinevirtual

If the OpenGL context is a widget this function sets its position.

Reimplemented from vl::OpenGLContext.

Definition at line 307 of file Qt5Widget.hpp.

◆ setRefreshRate()

void vlQt5::Qt5Widget::setRefreshRate ( int  msec)
inline

Definition at line 241 of file Qt5Widget.hpp.

◆ setSize()

virtual void vlQt5::Qt5Widget::setSize ( int  ,
int   
)
inlinevirtual

If the OpenGL context is a widget this function sets its size.

Reimplemented from vl::OpenGLContext.

Definition at line 317 of file Qt5Widget.hpp.

◆ setWindowTitle()

virtual void vlQt5::Qt5Widget::setWindowTitle ( const vl::String )
inlinevirtual

If the OpenGL context is a top window this function sets its title.

Reimplemented from vl::OpenGLContext.

Definition at line 276 of file Qt5Widget.hpp.

References vl::String::toStdString().

◆ show()

virtual void vlQt5::Qt5Widget::show ( )
inlinevirtual

If the OpenGL context is a widget this function makes it visible to the user.

Reimplemented from vl::OpenGLContext.

Definition at line 297 of file Qt5Widget.hpp.

◆ size()

virtual vl::ivec2 vlQt5::Qt5Widget::size ( ) const
inlinevirtual

Definition at line 323 of file Qt5Widget.hpp.

◆ swapBuffers()

void vlQt5::Qt5Widget::swapBuffers ( )
inlinevirtual

Swaps the back and front buffers to present the last rendering.

Implements vl::OpenGLContext.

Definition at line 329 of file Qt5Widget.hpp.

◆ translateKeyEvent()

void Qt5Widget::translateKeyEvent ( QKeyEvent *  ev,
unsigned short &  unicode_out,
vl::EKey key_out 
)
protected

◆ update()

void vlQt5::Qt5Widget::update ( )
inlinevirtual

If the OpenGLContext is a widget this function requests a redraw and generates an updateEvent().

Implements vl::OpenGLContext.

Definition at line 270 of file Qt5Widget.hpp.

◆ wheelEvent()

void vlQt5::Qt5Widget::wheelEvent ( QWheelEvent *  ev)
inline

Definition at line 379 of file Qt5Widget.hpp.

Member Data Documentation

◆ mRefresh

int vlQt5::Qt5Widget::mRefresh
protected

Definition at line 418 of file Qt5Widget.hpp.

◆ mUpdateTimer

QTimer vlQt5::Qt5Widget::mUpdateTimer
protected

Definition at line 419 of file Qt5Widget.hpp.


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