Render
interface.
- See also
- NVXIO APIs
Definition at line 61 of file Render.hpp.
|
enum | MouseButtonEvent {
LeftButtonDown,
LeftButtonUp,
MiddleButtonDown,
MiddleButtonUp,
RightButtonDown,
RightButtonUp,
MouseMove
} |
| Defines mouse events. More...
|
|
typedef void(* | OnKeyboardEventCallback )(void *context, vx_char key, vx_uint32 x, vx_uint32 y) |
| Callback for keyboard events. More...
|
|
typedef void(* | OnMouseEventCallback )(void *context, MouseButtonEvent event, vx_uint32 x, vx_uint32 y) |
| Callback for mouse events. More...
|
|
enum | TargetType {
UNKNOWN_RENDER,
WINDOW_RENDER,
VIDEO_RENDER,
IMAGE_RENDER
} |
| Defines the Render types. More...
|
|
|
virtual void | close ()=0 |
| Closes the render. More...
|
|
virtual bool | flush ()=0 |
| Renders all primitives. More...
|
|
virtual vx_uint32 | getHeight () const =0 |
| Gets the height. More...
|
|
std::string | getRenderName () const |
| Gets the render name. More...
|
|
TargetType | getTargetType () const |
| Gets the target type. More...
|
|
virtual vx_uint32 | getWidth () const =0 |
| Gets the width. More...
|
|
virtual void | putArrows (vx_array old_points, vx_array new_points, const LineStyle &style)=0 |
| Puts arrows on the image. More...
|
|
virtual void | putCircles (vx_array circles, const CircleStyle &style)=0 |
| Puts circles on the image. More...
|
|
virtual void | putConvexPoligon (vx_array vertices, const LineStyle &style)=0 |
| Puts a convex polygon on the image. More...
|
|
virtual void | putFeatures (vx_array location, const FeatureStyle &style)=0 |
| Puts features on the image. More...
|
|
virtual void | putImage (vx_image image)=0 |
| Puts the image to the render. More...
|
|
virtual void | putLines (vx_array lines, const LineStyle &style)=0 |
| Puts lines on the image. More...
|
|
virtual void | putMotionField (vx_image field, const MotionFieldStyle &style)=0 |
| Puts motion field on the image. More...
|
|
virtual void | putObjectLocation (const vx_rectangle_t &location, const DetectedObjectStyle &style)=0 |
| Puts object location on the image. More...
|
|
virtual void | putText (const std::string &text, const TextBoxStyle &style)=0 |
| Puts a message box on the image. More...
|
|
virtual void | setOnKeyboardEventCallback (OnKeyboardEventCallback callback, void *context)=0 |
| Sets the keyboard event callback. More...
|
|
virtual void | setOnMouseEventCallback (OnMouseEventCallback callback, void *context)=0 |
| Sets mouse event callback. More...
|
|
virtual | ~Render () |
| Destructor. More...
|
|
Callback for keyboard events.
- Parameters
-
[in] | context | A pointer to data to be passed to the callback. |
[in] | key | Specifies the keyboard key that corresponds to the event. |
[in] | x | Specifies the x-coordinate of the mouse position. |
[in] | y | Specifies the y-coordinate of the mouse position. |
Definition at line 164 of file Render.hpp.
Callback for mouse events.
- Parameters
-
[in] | context | A pointer to data to be passed to the callback. |
[in] | event | Specifies the mouse event. |
[in] | x | Specifies the x-coordinate of the mouse position. |
[in] | y | Specifies the y-coordinate of the mouse position. |
Definition at line 173 of file Render.hpp.
Defines the Render types.
Enumerator |
---|
UNKNOWN_RENDER |
Indicates a stub render.
|
WINDOW_RENDER |
Indicates a window render.
|
VIDEO_RENDER |
Indicates a render for video writing.
|
IMAGE_RENDER |
Indicates a render for image writing.
|
Definition at line 68 of file Render.hpp.
Defines mouse events.
Enumerator |
---|
LeftButtonDown |
Indicates the left mouse button has been pressed down.
|
LeftButtonUp |
Indicates the left mouse button has been released.
|
MiddleButtonDown |
Indicates a middle mouse button has been pressed down.
|
MiddleButtonUp |
Indicates the middle mouse button has been released.
|
RightButtonDown |
Indicates the right mouse button has been pressed down.
|
RightButtonUp |
Indicates the right mouse button has been released.
|
MouseMove |
Indicates the mouse has been moved.
|
Definition at line 146 of file Render.hpp.
virtual nvxio::Render::~Render |
( |
| ) |
|
|
inlinevirtual |
Sets the keyboard event callback.
- Parameters
-
[in] | callback | Specifies the callback to set. |
[in] | context | A pointer to data to be passed to the callback. |
virtual void nvxio::Render::setOnMouseEventCallback |
( |
OnMouseEventCallback |
callback, |
|
|
void * |
context |
|
) |
| |
|
pure virtual |
Sets mouse event callback.
- Parameters
-
[in] | callback | Callback. |
[in] | context | A pointer to data to be passed to the callback. |
virtual void nvxio::Render::putImage |
( |
vx_image |
image | ) |
|
|
pure virtual |
Puts the image to the render.
- Parameters
-
[in] | image | Specifies the image. |
virtual void nvxio::Render::putText |
( |
const std::string & |
text, |
|
|
const TextBoxStyle & |
style |
|
) |
| |
|
pure virtual |
Puts a message box on the image.
- Parameters
-
[in] | text | A reference to the text of the message. |
[in] | style | A reference to the style of the message box. |
Puts features on the image.
- Parameters
-
Puts lines on the image.
- Parameters
-
[in] | lines | Specifies an array of lines. Each line is encoded as nvx_point4f_t (x1,y1,x2,y2). |
[in] | style | A reference to the style of the lines. |
virtual void nvxio::Render::putConvexPoligon |
( |
vx_array |
vertices, |
|
|
const LineStyle & |
style |
|
) |
| |
|
pure virtual |
Puts a convex polygon on the image.
- Parameters
-
[in] | vertices | Specifies an array of poligon's vertices. |
[in] | style | A reference to the style of the polygon. |
Puts motion field on the image.
- Parameters
-
[in] | field | Specfies a 2-channel image, each pixel corresponding to vector of motion. |
[in] | style | A reference to the style of the motion field. |
Puts object location on the image.
- Parameters
-
[in] | location | A reference to the rectangle. |
[in] | style | A reference to the style of the object location. |
Puts circles on the image.
- Parameters
-
[in] | circles | Specifies an array of circles. Each circle is encoded as a nvx_point3f_t (x, y, radius). |
[in] | style | A reference to the style of the object location. |
Puts arrows on the image.
- Parameters
-
[in] | old_points | Specifies an array of arrow start points. |
[in] | new_points | Specifies an array of arrow end points. |
[in] | style | Specifies the style of the arrows's lines. |
virtual bool nvxio::Render::flush |
( |
| ) |
|
|
pure virtual |
Renders all primitives.
- Returns
- Status of the operation. Returns
true
if rendering procedure is successful; returns false
if render is not initialized properly or has been closed by the user.
virtual void nvxio::Render::close |
( |
| ) |
|
|
pure virtual |
std::string nvxio::Render::getRenderName |
( |
| ) |
const |
|
inline |
virtual vx_uint32 nvxio::Render::getWidth |
( |
| ) |
const |
|
pure virtual |
Gets the width.
- Returns
- Width.
virtual vx_uint32 nvxio::Render::getHeight |
( |
| ) |
const |
|
pure virtual |
Gets the height.
- Returns
- Height.
const std::string nvxio::Render::renderName |
|
protected |
The documentation for this class was generated from the following file: