ImFusion::OpticalTrackingMarkerIO Namespace Reference

Reading and writing OpticalTrackingMarker instances to/from various file formats. More...

Detailed Description

Reading and writing OpticalTrackingMarker instances to/from various file formats.

This namespace provides functions to serialize and deserialize optical tracking markers using different file formats. Supported formats include JSON, INI, and ROM (binary). The file format is automatically determined by the file extension.

Example usage:

OpticalTrackingMarker marker;
// ... configure marker ...
 
// Save to file (format determined by extension)
OpticalTrackingMarkerIO::saveToFile(marker, "marker.ini");
 
// Load from file
auto loadedMarker = OpticalTrackingMarkerIO::loadFromFile("marker.ini");
if (loadedMarker) {
    // Use marker
}

Typedefs
using	SaveHandler = std::function<bool(const OpticalTrackingMarker&, const Filesystem::Path&)>
	Function type for saving a marker to a file.
using	LoadHandler = std::function<std::unique_ptr<OpticalTrackingMarker>(const Filesystem::Path&)>
	Function type for loading a marker from a file.

Functions
bool	saveToFile (const OpticalTrackingMarker &marker, const Filesystem::Path &filename)
	Saves a marker to a file.
std::unique_ptr< OpticalTrackingMarker >	loadFromFile (const Filesystem::Path &filename)
	Loads a marker from a file.
void	registerFileFormat (const std::string &extension, SaveHandler saveHandler, LoadHandler loadHandler)
	Registers a file format handler for a specific extension.
bool	isFileFormatSupported (const std::string &extension)
	Checks if a file format handler is registered for the given extension.
std::vector< std::string >	supportedFileExtensions ()
	Returns a list of all supported file extensions.

Function Documentation

saveToFile()

bool ImFusion::OpticalTrackingMarkerIO::saveToFile	(	const OpticalTrackingMarker &	marker,
		const Filesystem::Path &	filename )

Saves a marker to a file.

Format is determined by file extension.

Parameters

marker	The marker to save
filename	Path to the output file

Returns

True if successful, false otherwise

loadFromFile()

std::unique_ptr< OpticalTrackingMarker > ImFusion::OpticalTrackingMarkerIO::loadFromFile

(

const Filesystem::Path &

filename

)

Loads a marker from a file.

Format is determined by file extension.

Parameters

filename

Path to the input file

Returns

Unique pointer to loaded marker, or nullptr on failure

registerFileFormat()

void ImFusion::OpticalTrackingMarkerIO::registerFileFormat	(	const std::string &	extension,
		SaveHandler	saveHandler,
		LoadHandler	loadHandler )

Registers a file format handler for a specific extension.

Parameters

extension	File extension (e.g., "ini", "rom", "json") without the dot
saveHandler	Function to save marker to file
loadHandler	Function to load marker from file

isFileFormatSupported()

bool ImFusion::OpticalTrackingMarkerIO::isFileFormatSupported

(

const std::string &

extension

)

Checks if a file format handler is registered for the given extension.

Parameters

extension

File extension without the dot

Returns

True if handler is registered