ScTrackedObject Struct Reference

Public Member Functions

ScTrackedObjectType sc_tracked_object_get_type (const ScTrackedObject *object)
 
uint32_t sc_tracked_object_get_id (const ScTrackedObject *object)
 
ScQuadrilateral sc_tracked_object_get_location (const ScTrackedObject *object)
 
void sc_tracked_object_release (ScTrackedObject *object)
 
void sc_tracked_object_retain (ScTrackedObject *object)
 

Detailed Description

Opaque pointer type for an object tracker.

Examples:
CommandLineMatrixScanCameraSample.c.

Member Function Documentation

ScTrackedObjectType sc_tracked_object_get_type ( const ScTrackedObject object)

Get type of the tracked object.

Parameters
objectObject for which to retrieve the type. Must not be null.
Returns
The type of the object.
Since
5.8.0
uint32_t sc_tracked_object_get_id ( const ScTrackedObject object)

Retrieve unique id for the tracked object.

The id is unique for each type of object, e.g. for barcodes. The same id may be reused once the object is lost for another object.

Parameters
objectThe object for which to retrieve the id. Must not be null.
Returns
The unique id.
Since
5.8.0
Examples:
CommandLineMatrixScanCameraSample.c.
ScQuadrilateral sc_tracked_object_get_location ( const ScTrackedObject object)

Get the location quadrilateral of the tracked object.

Parameters
objectThe tracked object. Must not be null.
Returns
the quadrilateral of the object location.
Since
5.8.0
void sc_tracked_object_release ( ScTrackedObject object)

Decrease reference count of tracked object by one.

When the reference count drops to zero, the tracked object is deallocated.

Parameters
objectThe tracked object. May be null.
Since
5.9.0
void sc_tracked_object_retain ( ScTrackedObject object)

Increase reference count of the tracked object by one.

Parameters
objectThe tracked object. Must not be null.
Since
5.9.0

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