Detailed Description

Render interface.

See also: NVXIO APIs

Definition at line 73 of file Render.hpp.

Data Structures
struct	CircleStyle
	Defines circle style. More...

struct	DetectedObjectStyle
	Defines the detected object's rectangle style. More...

struct	FeatureStyle
	Defines the features parameters. More...

struct	LineStyle
	Defines line style. More...

struct	MotionFieldStyle
	Defines motion field style. More...

struct	TextBoxStyle
	Defines the text box parameters. More...

Public Types
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...

Public Member Functions
virtual void	close ()=0
	Closes the render. More...

virtual bool	flush ()=0
	Renders all primitives. More...

std::string	getRenderName () const
	Gets the render name. More...

TargetType	getTargetType () const
	Gets the target type. More...

virtual vx_uint32	getViewportHeight () const =0
	Gets the viewport height. More...

virtual vx_uint32	getViewportWidth () const =0
	Gets the viewport 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	putConvexPolygon (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	putFeatures (vx_array location, vx_array styles)=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	putTextViewport (const std::string &text, const TextBoxStyle &style)=0
	Puts a message box on the viewport. 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...

Protected Member Functions
	Render (TargetType type=Render::UNKNOWN_RENDER, std::string name="Undefined")

Protected Attributes
const std::string	renderName

const TargetType	targetType

Member Typedef Documentation

typedef void(* nvxio::Render::OnKeyboardEventCallback)(void *context, vx_char key, vx_uint32 x, vx_uint32 y)

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 179 of file Render.hpp.

typedef void(* nvxio::Render::OnMouseEventCallback)(void *context, MouseButtonEvent event, vx_uint32 x, vx_uint32 y)

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 188 of file Render.hpp.

Member Enumeration Documentation

enum nvxio::Render::MouseButtonEvent

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 161 of file Render.hpp.

enum nvxio::Render::TargetType

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 80 of file Render.hpp.

Constructor & Destructor Documentation

virtual nvxio::Render::~Render ( )

inlinevirtual

Destructor.

Definition at line 326 of file Render.hpp.

nvxio::Render::Render	(	TargetType	type = `Render::UNKNOWN_RENDER`,
		std::string	name = `"Undefined"`
	)

inlineprotected

Definition at line 331 of file Render.hpp.

Member Function Documentation

virtual void nvxio::Render::close ( )

pure virtual

Closes the render.

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.

std::string nvxio::Render::getRenderName ( ) const

inline

Gets the render name.

Returns: Render name.

Definition at line 306 of file Render.hpp.

TargetType nvxio::Render::getTargetType ( ) const

inline

Gets the target type.

See also: TargetType.

Returns: Target type.

Definition at line 297 of file Render.hpp.

virtual vx_uint32 nvxio::Render::getViewportHeight ( ) const

pure virtual

Gets the viewport height.

Returns: Height.

virtual vx_uint32 nvxio::Render::getViewportWidth ( ) const

pure virtual

Gets the viewport width.

Returns: Width.

virtual void nvxio::Render::putArrows	(	vx_array	old_points,
		vx_array	new_points,
		const LineStyle &	style
	)

pure virtual

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 void nvxio::Render::putCircles	(	vx_array	circles,
		const CircleStyle &	style
	)

pure virtual

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.

virtual void nvxio::Render::putConvexPolygon	(	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 (vx_coordinates2d_t).
[in]	style	A reference to the style of the polygon.

virtual void nvxio::Render::putFeatures	(	vx_array	location,
		const FeatureStyle &	style
	)

pure virtual

Puts features on the image.

Parameters

[in]	location	Specifies an array of vx_keypoint_t, nvx_point2f_t or nvx_keypointf_t structures.
[in]	style	A reference to the style for the features.

virtual void nvxio::Render::putFeatures	(	vx_array	location,
		vx_array	styles
	)

pure virtual

Puts features on the image.

Parameters

[in]	location	Specifies an array of vx_keypoint_t, nvx_point2f_t or nvx_keypointf_t structures.
[in]	styles	A reference to the array of Render::FeatureStyle for the features.

Example Code: // register nvxio::Render::FeatureStyle as a user struct

vx_enum featureStyleID = vxRegisterUserStruct(context, sizeof(nvxio::Render::FeatureStyle));

vx_size size = 0;

NVXIO_SAFE_CALL( vxQueryArray(features, VX_ARRAY_ATTRIBUTE_NUMITEMS, (void *)&size, sizeof(size)) );

// create array

vx_array styles = vxCreateArray(context, featureStyleID, size);

NVXIO_CHECK_REFERENCE(styles);

// fill array

for (vx_size i = 0; i < size; ++i)

{

vx_uint8 color = i % 255;

nvxio::Render::FeatureStyle style { { color, 0, 0, 255 }, i % 5 + 3.0f };

NVXIO_SAFE_CALL( vxAddArrayItems(styles, 1, &style, sizeof(nvxio::Render::FeatureStyle)) );

}

// render each feature with custom style

render->putFeatures(features, styles);

// release array

NVXIO_SAFE_CALL( vxReleaseArray(&styles) );

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::putLines	(	vx_array	lines,
		const LineStyle &	style
	)

pure virtual

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::putMotionField	(	vx_image	field,
		const MotionFieldStyle &	style
	)

pure virtual

Puts motion field on the image.

Parameters

[in]	field	Specfies a 2-channel image (NVX_DF_IMAGE_2F32), each pixel corresponding to vector of motion.
[in]	style	A reference to the style of the motion field.

virtual void nvxio::Render::putObjectLocation	(	const vx_rectangle_t &	location,
		const DetectedObjectStyle &	style
	)

pure virtual

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.

virtual void nvxio::Render::putTextViewport	(	const std::string &	text,
		const TextBoxStyle &	style
	)

pure virtual

Puts a message box on the viewport.

Parameters

[in]	text	A reference to the text of the message.
[in]	style	A reference to the style of the message box.

virtual void nvxio::Render::setOnKeyboardEventCallback	(	OnKeyboardEventCallback	callback,
		void *	context
	)

pure virtual

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.

Field Documentation

const std::string nvxio::Render::renderName

protected

Definition at line 337 of file Render.hpp.

const TargetType nvxio::Render::targetType

protected

Definition at line 336 of file Render.hpp.

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

NVXIO/Render.hpp

VisionWorks Toolkit Reference

April 8, 2016 | 1.4 Release

Detailed Description

Data Structures

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation