Jetson Inference: glWidget Class Reference

| | Jetson Inference

DNN Vision Library |

glWidget Class Reference Utilities Library (jetson-utils) » OpenGL

OpenGL graphics widget for rendering moveable/resizable shapes. More...

#include <glWidget.h>

Classes

Public Types

| | enum | Shape { Rect, Line, Ellipse } | | | Shape enum. More...
| | | | typedef bool(* | glWidgetEventHandler) (glWidget *widget, uint16_t event, int a, int b, void *user) | | | Event message handler callback for recieving UI messages from widgets. More...
| | |

Public Member Functions

Protected Types

| | enum | DragState {
DragNone, DragMove, DragResizeN, DragResizeNW,
DragResizeNE, DragResizeS, DragResizeSW, DragResizeSE,
DragResizeW, DragResizeE
} | | |

Protected Member Functions

Protected Attributes

Friends

Detailed Description

OpenGL graphics widget for rendering moveable/resizable shapes.

Member Typedef Documentation

◆glWidgetEventHandler

| typedef bool(* glWidget::glWidgetEventHandler) (glWidget *widget, uint16_t event, int a, int b, void *user) |

Event message handler callback for recieving UI messages from widgets.

Recieves 4 parameters - the widget that sent the event, the event type, a & b message values (

See alsoglEventType from glEvents.h), and a user-specified pointer from registration.

Event message handlers should return true if the message was handled, or false if the message was skipped or not handled.

Member Enumeration Documentation

◆DragState

| enum glWidget::DragState |

| protected |

Enumerator
DragNone
DragMove
DragResizeN
DragResizeNW
DragResizeNE
DragResizeS
DragResizeSW
DragResizeSE
DragResizeW
DragResizeE

◆Shape

| enum glWidget::Shape |

Shape enum.

Enumerator
Rect
Line
Ellipse

Constructor & Destructor Documentation

◆glWidget() [1/2]

Constructor.

◆glWidget() [2/2]

Constructor.

◆~glWidget()

| virtual glWidget::~glWidget | ( | | ) | |

| virtual |

Destructor.

Member Function Documentation

◆AddEventHandler()

Parameters

| callback | function pointer to the event message handler callback | | user | optional user-specified pointer that will be passed to all invocations of this event handler (typically an object) |

◆Contains()

| bool glWidget::Contains | ( | float | x, | | | | float | y | | | ) | | const |

Test if the point is inside the widget.

◆coordToBorder()

| DragState glWidget::coordToBorder | ( | float | x, | | | | float | y, | | | | float | max_distance = 10.0f | | | ) | | |

| protected |

◆dispatchEvent()

| void glWidget::dispatchEvent | ( | uint16_t | msg, | | | | int | a, | | | | int | b | | | ) | | |

| protected |

◆GetCoords()

| void glWidget::GetCoords | ( | float * | x1, | | | | float * | y1, | | | | float * | x2, | | | | float * | y2 | | | ) | | const |

| inline |

Get the bounding coordinates of the widget.

◆GetDisplay()

| glDisplay* glWidget::GetDisplay | ( | | ) | const |

| inline |

Get the root window of the widget.

◆GetIndex()

| int glWidget::GetIndex | ( | | ) | const |

Get the index of the widget in the window (or -1 if none)

◆GetPosition()

| void glWidget::GetPosition | ( | float * | x, | | | | float * | y | | | ) | | const |

| inline |

Get position of widget in global window coordinates.

◆GetShape()

| Shape glWidget::GetShape | ( | | ) | const |

| inline |

Get the shape.

◆GetSize()

| inline |

Get the widget's size.

◆GetUserData()

| void* glWidget::GetUserData | ( | | ) | const |

| inline |

Retrieve user data.

◆GlobalToLocal()

Convert from global window coordinates to local widget offset.

◆Height()

| float glWidget::Height | ( | | ) | const |

| inline |

Get the widget's height.

◆initDefaults()

| void glWidget::initDefaults | ( | | ) | |

| protected |

◆IsMoveable()

| bool glWidget::IsMoveable | ( | | ) | const |

| inline |

Is the widget moveable/draggable by the user?

◆IsResizeable()

| bool glWidget::IsResizeable | ( | | ) | const |

| inline |

Is the widget resizeable by the user?

◆IsSelected()

| bool glWidget::IsSelected | ( | | ) | const |

| inline |

Is the widget selected?

◆IsVisible()

| bool glWidget::IsVisible | ( | | ) | const |

| inline |

Is the widget visible.

◆LocalToGlobal()

Convert from local widget offset to global window coordinates.

◆Move()

| void glWidget::Move | ( | float | x, | | | | float | y | | | ) | | |

| inline |

Move the widget's position by the specified offset.

◆OnEvent()

| bool glWidget::OnEvent | ( | uint16_t | event, | | | | int | a, | | | | int | b, | | | | void * | user | | | ) | | |

◆RemoveEventHandler()

Remove an event message handler from being called by the widget.

RemoveEventHandler() will search for previously registered event handlers that have the same function pointer and/or user pointer, and remove them for being called again in the future.

◆Render()

| void glWidget::Render | ( | | ) | |

Render (automatically called by parent)

◆SetCoords()

| void glWidget::SetCoords | ( | float | x1, | | | | float | y1, | | | | float | x2, | | | | float | y2 | | | ) | | |

| inline |

Set the bounding coordinates of the widget.

◆setCursor()

| protected |

◆setDisplay()

| protected |

◆SetFillAlpha()

| void glWidget::SetFillAlpha | ( | float | a | ) | |

| inline |

Set fill alpha.

◆SetFillColor()

| void glWidget::SetFillColor | ( | float | r, | | | | float | g, | | | | float | b, | | | | float | a = 1.0f | | | ) | | |

| inline |

Set fill color.

◆SetHeight()

| inline |

Set the widget's height.

◆SetLineAlpha()

| void glWidget::SetLineAlpha | ( | float | a | ) | |

| inline |

Set outline alpha.

◆SetLineColor()

| void glWidget::SetLineColor | ( | float | r, | | | | float | g, | | | | float | b, | | | | float | a = 1.0f | | | ) | | |

| inline |

Set outline color.

◆SetLineWidth()

| inline |

Set outline width.

◆SetMoveable()

| inline |

Toggle if the user can move/drag the widget.

◆SetPosition()

| void glWidget::SetPosition | ( | float | x, | | | | float | y | | | ) | | |

| inline |

Set position of widget in global window coordinates.

◆SetResizeable()

| inline |

Toggle if the user can resize the widget.

◆SetSelected()

| inline |

Select/de-select the widget.

◆SetSelectedFillColor()

| void glWidget::SetSelectedFillColor | ( | float | r, | | | | float | g, | | | | float | b, | | | | float | a = 1.0f | | | ) | | |

| inline |

Set selected fill color.

◆SetSelectedLineColor()

| void glWidget::SetSelectedLineColor | ( | float | r, | | | | float | g, | | | | float | b, | | | | float | a = 1.0f | | | ) | | |

| inline |

Set selected outline color.

◆SetShape()

| inline |

Set the shape.

◆SetSize()

| inline |

Set the widget's size.

◆SetUserData()

| inline |

Set user-defined data.

◆SetVisible()

| inline |

Show/hide the widget.

◆SetWidth()

| inline |

Set the widget's width.

◆SetX()

| void glWidget::SetX | ( | float | x | ) | |

| inline |

Set the widget's X coordinate.

◆SetY()

| void glWidget::SetY | ( | float | y | ) | |

| inline |

Set the widget's Y coordinate.

◆Width()

| float glWidget::Width | ( | | ) | const |

| inline |

Get the widget's width.

◆X()

| float glWidget::X | ( | | ) | const |

| inline |

Get the widget's X coordinate.

◆Y()

| float glWidget::Y | ( | | ) | const |

| inline |

Get the widget's Y coordinate.

◆glDisplay

| friend class glDisplay |

| friend |

Member Data Documentation

◆mDisplay

| glDisplay* glWidget::mDisplay |

| protected |

◆mDragState

| DragState glWidget::mDragState |

| protected |

◆mEventHandlers

| std::vector<eventHandler> glWidget::mEventHandlers |

| protected |

◆mFillColor

| float glWidget::mFillColor[4] |

| protected |

◆mHeight

| float glWidget::mHeight |

| protected |

◆mLineColor

| float glWidget::mLineColor[4] |

| protected |

◆mLineWidth

| float glWidget::mLineWidth |

| protected |

◆mMoveable

| bool glWidget::mMoveable |

| protected |

◆mResizeable

| bool glWidget::mResizeable |

| protected |

◆mSelected

| bool glWidget::mSelected |

| protected |

◆mSelectedFillColor

| float glWidget::mSelectedFillColor[4] |

| protected |

◆mSelectedLineColor

| float glWidget::mSelectedLineColor[4] |

| protected |

◆mShape

| Shape glWidget::mShape |

| protected |

◆mUserData

| void* glWidget::mUserData |

| protected |

◆mVisible

| bool glWidget::mVisible |

| protected |

◆mWidth

| float glWidget::mWidth |

| protected |

◆mX

| float glWidget::mX |

| protected |

◆mY

| float glWidget::mY |

| protected |

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

jetson-utils/glWidget.h
glWidget
Generated on Fri Mar 17 2023 14:29:30 for Jetson Inference by 1.8.17

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆glWidgetEventHandler

Member Enumeration Documentation

◆DragState

◆Shape

Constructor & Destructor Documentation

◆glWidget() [1/2]

◆glWidget() [2/2]

◆~glWidget()

Member Function Documentation

◆AddEventHandler()

◆Contains()

◆coordToBorder()

◆dispatchEvent()

◆GetCoords()

◆GetDisplay()

◆GetIndex()

◆GetPosition()

◆GetShape()

◆GetSize()

◆GetUserData()

◆GlobalToLocal()

◆Height()

◆initDefaults()

◆IsMoveable()

◆IsResizeable()

◆IsSelected()

◆IsVisible()

◆LocalToGlobal()

◆Move()

◆OnEvent()

◆RemoveEventHandler()

◆Render()

◆SetCoords()

◆setCursor()

◆setDisplay()

◆SetFillAlpha()

◆SetFillColor()

◆SetHeight()

◆SetLineAlpha()

◆SetLineColor()

◆SetLineWidth()

◆SetMoveable()

◆SetPosition()

◆SetResizeable()

◆SetSelected()

◆SetSelectedFillColor()

◆SetSelectedLineColor()

◆SetShape()

◆SetSize()

◆SetUserData()

◆SetVisible()

◆SetWidth()

◆SetX()

◆SetY()

◆Width()

◆X()

◆Y()

Friends And Related Function Documentation

◆glDisplay

Member Data Documentation

◆mDisplay

◆mDragState

◆mEventHandlers

◆mFillColor

◆mHeight

◆mLineColor

◆mLineWidth

◆mMoveable

◆mResizeable

◆mSelected