xvWidgets
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
xv::Image Class Reference

An off-screen image representation native to the selected GUI. More...

#include <Image.hpp>

Inheritance diagram for xv::Image:
xv::Widget

Public Member Functions

void setImage (gui_image_t data)
 load data into the image container
 
gui_image_t getImage ()
 returns stored image data
 
gui_bitmap_t & getBitmap ()
 
void setBestSizeFit (int w, int h)
 Fits the image to a new size using black borders to mantain aspect ratio.
 
gui_point_t Image::getPixelInterpolation (gui_point_t point)
 
void createBitmap (int w, int h)
 Makes the stored image ready for display.
 
- Public Member Functions inherited from xv::Widget
virtual void addChild (Widget &, bool readOnly=true)
 Add a child widget.
 
virtual void onMouseDown (const gui_point_t &)
 The user clicked the left mouse button over the widget.
 
virtual void onMouseMove (const gui_point_t &)
 The user moved the mouse pointer over the widget.
 
virtual void onMouseUp (const gui_point_t &)
 The user released the left mouse button over the widget.
 
void startDragging ()
 Signal that the user started dragging the widget.
 
void stopDragging ()
 Signal that the user stopped dragging the widget.
 
bool isDragging ()
 Check if the user is dragging the widget.
 
virtual void setMouseOver (bool mouseOver)
 Signal that the user placed the mouse pointer over the widget.
 
virtual bool isMouseOver ()
 Check if the mouse pointer is over the widget.
 
virtual bool isReadOnly ()
 Check if Widget is read-only.
 
virtual void setPosition (gui_point_t position)
 Move the widget to a point in an image.
 
virtual gui_point_t position ()
 Get the current position.
 
bool isMouseOverButton (gui_point_t mousePosition, gui_point_t buttonPosition)
 Check if the mouse pointer is over a button.
 
void hide ()
 Make it disappear from an Image.
 

Public Attributes

cv::Mat m_cvMat
 to-do: refactor
 
cv::Mat m_renderMat
 

Static Public Attributes

static const cv::Scalar PADDING_COLOR
 

Additional Inherited Members

- Protected Attributes inherited from xv::Widget
std::list< Widget * > m_children
 Other widgets inside the widget.
 
Widgetm_parent = NULL
 Pointer to the parent image used to display the widget.
 
std::vector< gui_point_t > m_contour
 The contours of area occupied by the widget.
 
bool m_dragging = false
 
bool m_canceling = false
 
bool m_accepting = false
 
bool m_mouseOver = false
 
bool m_undefined = false
 
bool m_positioned = false
 
bool m_readonly = false
 
gui_point_t m_position
 
- Static Protected Attributes inherited from xv::Widget
static const int LINE_THICKNESS
 The thickness of contour lines.
 
static const int MARGIN
 Generic margin around widget.
 
static const int BUTTON_RADIUS
 Used to define the size of buttons.
 
static const gui_point_t OK_POSITION
 Offset of the OK button in relation to the widget position.
 
static const gui_point_t CANCEL_POSITION
 Offset of the Cancel button in relation to the widget position.
 
static const cv::Scalar FOREGROUND_COLOR
 Color used to draw main components of widget.
 
static const cv::Scalar HIGHLIGHT_COLOR
 Color used to draw a few important components of the widget.
 
static const cv::Scalar AFFIRMATIVE_COLOR
 Color associated with OK/accept action.
 
static const cv::Scalar NEGATIVE_COLOR
 Color associated with Cancel/reject action.
 

Detailed Description

An off-screen image representation native to the selected GUI.

Member Function Documentation

gui_point_t xv::Image::Image::getPixelInterpolation ( gui_point_t  point)

Maps a pixel position in the original image to the transformed image, taking scale and padding into consideration

Member Data Documentation

const cv::Scalar xv::Image::PADDING_COLOR
static

the color used to pad the frame when the aspect ratio doesn't fit the container


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