Open Search
    Public Member Functions | Static Public Member Functions | Private Member Functions | List of all members
    Mt2dTrack Class Reference
    Library » Motion Tracker

    #include <lib_motiontracker.h>

    Detailed Description

    Represents a single 2D track.

    Contains a set of image positions for a set of frames. Provides information about which frames the track exists for, the status of the track, and position data for the frames on which the track exists.

    This data represents the 2D motion of a single feature within the footage.

    Public Member Functions

    String GetName () const
     
    MtTrkGid * GetId () const
     
    Mt2dTrackStatus GetStatus () const
     
    BaseSelect * GetFramesWithTrackData () const
     
    MtData * GetDataForFrame (Int32 frameNum) const
     
    MtData * GetDataForCurrentFrame () const
     

    Static Public Member Functions

    static Mt2dTrack * Alloc ()
     
    static void Free (Mt2dTrack *&p)
     

    Private Member Functions

     Mt2dTrack ()
     
     ~Mt2dTrack ()
     

    Constructor & Destructor Documentation

    ◆ Mt2dTrack()

    Mt2dTrack ( )
    		private

    ◆ ~Mt2dTrack()

    ~Mt2dTrack ( )
    		private

    Member Function Documentation

    ◆ Alloc()

    static Mt2dTrack* Alloc ( )
    		static

    Internal.

    ◆ Free()

    static void Free ( Mt2dTrack *&  p)
    		static

    Destructs Mt2dTracks allocated with Alloc(). Use AutoAlloc to automate the allocation and destruction based on scope.

    Parameters
    [in,out]pThe Mt2dTrack to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

    ◆ GetName()

    String GetName ( ) const

    Queries the track name.

    Returns
    The track name.

    ◆ GetId()

    MtTrkGid* GetId ( ) const

    Queries the track global ID.

    Warning
    Caller is responsible for calling Free() on the returned track ID when it is no longer needed.
    Returns
    The track ID.
    A copy of the track ID, or nullptr. The caller owns the pointed MtTrkGid.

    ◆ GetStatus()

    Mt2dTrackStatus GetStatus ( ) const

    Queries the track status.

    Returns
    The track status.

    ◆ GetFramesWithTrackData()

    BaseSelect* GetFramesWithTrackData ( ) const

    Retrieves a BaseSelect containing the set of frames for which 2D tracking data exists.

    Warning
    Caller is responsible for calling Free() on the returned selection when it is no longer needed.
    Returns
    A copy of the BaseSelect of frames. The caller owns the pointed BaseSelect.

    ◆ GetDataForFrame()

    MtData* GetDataForFrame ( Int32  frameNum) const

    Retrieves the tracking data for given frame number.

    Warning
    Caller is responsible for calling Free() on the returned tracking data when it is no longer needed. Returns a pointer to a copy of the data. Caller is owner, and is responsible for calling Free on the pointer when no longer needed.
    Returns
    A copy of the tracking data, or nullptr if it does not exists for requested frame. The caller owns the pointed MtData.

    ◆ GetDataForCurrentFrame()

    MtData* GetDataForCurrentFrame ( ) const

    Retrieves the tracking data for current frame of active document.

    Warning
    Caller is responsible for calling Free() on the returned tracking data when it is no longer needed.
    Note
    Normally GetDataForFrame() should be used instead with the frame number passed explicitly.
    Returns
    A copy of the current frame tracking data, or nullptr if it does not exists. The caller owns the pointed MtData.