FlowEngine::MarkerPrinter Class Reference

Utility class to query information and generate tag images to use for marker detection. More...

#include <MarkerPrinter.h>

Static Public Member Functions
static FLE_DLL Index	getNumberOfTagFamilies ()
	Returns the number of available tag families for the marker detection algorithm.
static FLE_DLL Size	getTagFamilySize (Index index)
static FLE_DLL Result	getTagFamily (Index index, StringBuffer tagFamily)
static FLE_DLL Index	getNumberOfTagsForFamily (ConstStringBuffer tagFamily)
static FLE_DLL Result	exportTags (ConstStringBuffer tagFamily, ConstStringBuffer outputDirectory, Index count)

Detailed Description

Utility class to query information and generate tag images to use for marker detection.

Member Function Documentation

exportTags()

Result FlowEngine::MarkerPrinter::exportTags ( ConstStringBuffer  tagFamily, ConstStringBuffer  outputDirectory, Index  count  )

static

Saves tag images to a directory for a given family.

Parameters

[in]	tagFamily	the tag family that will be searched for. See getTagFamily.
[in]	outputDirectory	string buffer containing the path to an existing directory where images will be saved in sequence.
[in]	count	the number of patterns to save. Must be in the range (0, getNumberOfTagsForFamily).

Returns

One of the following result codes:

• Result::Success – if the image(s) were saved successfully.
• Result::InvalidArgument –
  • if tagFamily is not a valid buffer or does not contain a valid tag family. See getTagFamily.
  • if outputDirectory is not a valid string buffer.
  • if count is not in the valid range.
• Result::FileNotFound – if outputDirectory does not point to an existing directory.
• Result::DiskWriteError – if one or more images were not saved successfully due to disk access errors.
• Result::OutOfMemoryError – if the system ran out of memory.
• Result::GenericError – if any other error occurred.

Note

Images are saved with the pattern Markerd.png. Existing images will be overridden;

getNumberOfTagFamilies()

FLE_DLL Index FlowEngine::MarkerPrinter::getNumberOfTagFamilies ( )

static

Returns the number of available tag families for the marker detection algorithm.

getNumberOfTagsForFamily()

Index FlowEngine::MarkerPrinter::getNumberOfTagsForFamily ( ConstStringBuffer  tagFamily )

static

Returns

the number of available tags for a given tag family. May return 0 if the family is not valid.

Parameters

[in]

tagFamily

the tag family that will be searched for. See getTagFamily.

getTagFamily()

FLE_DLL Result FlowEngine::MarkerPrinter::getTagFamily ( Index  index, StringBuffer  tagFamily  )

static

Get the name of a tag family at a given index. param[in] index the index of the tag family. Must be in the range [0, getNumberOfTagFamilies()) param[in, out] family a string buffer big enough to store the tag family name. Use getTagFamilySize to query for the right size.

Returns

One of the following result codes:

• Result::Success – if the name was retrieved correctly.
• Result::InvalidArgument –
  • if index is not in the valid range.
  • if family is not a valid string buffer
• Result::BufferTooSmall – if family is not big enough to receive the full name. See getTagFamilySize.
• Result::GenericError – if any other error occurred.

getTagFamilySize()

FLE_DLL Size FlowEngine::MarkerPrinter::getTagFamilySize ( Index  index )

static

Returns

the length of the tag family at the specified index param[in] index the index of the tag family. Must be in the range [0, getNumberOfTagFamilies())