stable/c_api/_sc_tracked_object_map_8h_source.html

#ifndef SC_TRACKED_OBJECT_MAP_H_

#define SC_TRACKED_OBJECT_MAP_H_


#include <Scandit/ScTrackedObject.h>


SC_EXTERN_C_BEGIN


typedef struct ScOpaqueTrackedObjectMap ScTrackedObjectMap;


SC_EXPORT

void sc_tracked_object_map_release(ScTrackedObjectMap const *map);


SC_EXPORT

ScTrackedObject *sc_tracked_object_map_get_item_at(ScTrackedObjectMap const *map, uint32_t id);


SC_EXPORT

uint32_t sc_tracked_object_map_get_size(ScTrackedObjectMap const *map);


SC_EXPORT

uint32_t const *sc_tracked_object_map_get_ids(ScTrackedObjectMap const *map);


SC_EXTERN_C_END


#endif // SC_TRACKED_OBJECT_MAP_H_

SC_EXTERN_C_BEGIN
#define SC_EXTERN_C_BEGIN
Start of external C code.
Definition: ScConfig.h:19

SC_EXTERN_C_END
#define SC_EXTERN_C_END
End of external C code.
Definition: ScConfig.h:28

ScTrackedObject.h
API for tracking objects across frames.

ScTrackedObject
Opaque pointer type for a tracked object.

ScTrackedObjectMap
A container that stores tracked objects in association with their corresponding ID.

ScTrackedObjectMap::sc_tracked_object_map_get_size
uint32_t sc_tracked_object_map_get_size(ScTrackedObjectMap const *map)
Get the number of objects in the map.

ScTrackedObjectMap::sc_tracked_object_map_get_item_at
ScTrackedObject * sc_tracked_object_map_get_item_at(ScTrackedObjectMap const *map, uint32_t id)
Get a specific element in a map of tracked objects.

ScTrackedObjectMap::sc_tracked_object_map_release
void sc_tracked_object_map_release(ScTrackedObjectMap const *map)
Decrease reference count the map by one.

ScTrackedObjectMap::sc_tracked_object_map_get_ids
uint32_t const * sc_tracked_object_map_get_ids(ScTrackedObjectMap const *map)
Get an array of all object IDs in a map. Since object IDs are unique, the size of the array can be qu...