ScTrackedObjectMap Struct Reference
Public Member Functions | |
| void | sc_tracked_object_map_release (ScTrackedObjectMap *map) |
| ScTrackedObject * | sc_tracked_object_map_get_item_at (ScTrackedObjectMap const *map, uint32_t id) |
| uint32_t | sc_tracked_object_map_get_size (ScTrackedObjectMap const *map) |
| uint32_t const * | sc_tracked_object_map_get_ids (ScTrackedObjectMap const *map) |
Detailed Description
An container that stores tracked objects in association with their corresponding ID.
- Since
- 7.0
- Examples:
- CommandLineMatrixScanCameraSample.c.
Member Function Documentation
| void sc_tracked_object_map_release | ( | ScTrackedObjectMap * | map | ) |
Decrease reference count the map by one.
When the reference count drops to zero, the map is deallocated.
- Parameters
-
map The map. May be null.
- Since
- 7.0
- Examples:
- CommandLineMatrixScanCameraSample.c.
| ScTrackedObject * sc_tracked_object_map_get_item_at | ( | ScTrackedObjectMap const * | map, |
| uint32_t | id | ||
| ) |
Get a specific element in a map of tracked objects.
- Parameters
-
map The map of tracked objects. Must not be null. id The id of the tracked object to retrieve.
- Returns
- The tracked object for a given ID. In case the ID does not exist in the map, a nullptr will be returned.
- Since
- 7.0
- Examples:
- CommandLineMatrixScanCameraSample.c.
| uint32_t sc_tracked_object_map_get_size | ( | ScTrackedObjectMap const * | map | ) |
Get the number of objects in the map.
- Parameters
-
map The map. Must not be null.
- Returns
- The number of tracked objects.
- Since
- 7.0
- Examples:
- CommandLineMatrixScanCameraSample.c.
| 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 queried using sc_tracked_object_map_get_size().
- Parameters
-
map The map. Must not be null.
- Returns
- Pointer to the array of object IDs.
- Since
- 7.0
- Examples:
- CommandLineMatrixScanCameraSample.c.
The documentation for this struct was generated from the following file: