MtFootageData Class Reference

#include <lib_motiontracker.h>

Detailed Description

Provides basic information about the footage that has been loaded into the motion tracker.

Includes frame range, aspect ratio information, source filename, and downsampling settings.

Public Member Functions
Filename	GetFootageName () const
Int32	GetFirstFrameNumber () const
Int32	GetLastFrameNumber () const
Int32	GetResolutionWidthPix (Bool originalRes) const
Int32	GetResolutionHeightPix (Bool originalRes) const
Float	GetResolutionAspectRatio () const
Float	GetImageAspectRatio () const
Float	GetPixelAspectRatio () const
Float	GetDownsamplingFactor () const

Static Public Member Functions
static MtFootageData *	Alloc ()
static void	Free (MtFootageData *&p)

Private Member Functions
	MtFootageData ()
	~MtFootageData ()

Constructor & Destructor Documentation

MtFootageData()

MtFootageData ( )

private

~MtFootageData()

~MtFootageData ( )

private

Member Function Documentation

GetFootageName()

Filename GetFootageName

(

)

const

Retrieves the filename of the footage (the first frame if an image sequence).

Returns

The filename.

GetFirstFrameNumber()

Int32 GetFirstFrameNumber

(

)

const

Retrieves the frame number of the first frame in the footage.

Returns

The first frame number. -1 if no footage loaded.

GetLastFrameNumber()

Int32 GetLastFrameNumber

(

)

const

Retrieves the frame number of the last frame in the footage.

Returns

The last frame number. -1 if no footage loaded.

GetResolutionWidthPix()

Int32 GetResolutionWidthPix

(

Bool

originalRes

)

const

Queries the width in pixels of the footage.

Parameters

[in]

originalRes

If true, the returned pixel coordinates are for the original footage. If false, the returned pixel coordinates are for the downsampled footage.

Returns

The width of footage in pixels.

GetResolutionHeightPix()

Int32 GetResolutionHeightPix

(

Bool

originalRes

)

const

Queries the height in pixels of the footage.

Parameters

[in]

originalRes

If true, the returned pixel coordinates are for the original footage. If false, the returned pixel coordinates are for the downsampled footage.

Returns

The height of footage in pixels.

GetResolutionAspectRatio()

Float GetResolutionAspectRatio

(

)

const

Queries the aspect ratio of the horizontal to vertical resolution. Ignores pixel aspect ratio.

Returns

The aspect ratio from resolution.

GetImageAspectRatio()

Float GetImageAspectRatio

(

)

const

Queries the aspect ratio of the footage including effects of pixel aspect ratio.

Note

GetImageAspectRatio() == GetResolutionAspectRatio() * GetPixelAspectRatio()

Returns

The aspect ratio of footage.

GetPixelAspectRatio()

Float GetPixelAspectRatio

(

)

const

Queries the pixel aspect ratio of the footage.

Returns

The pixel aspect ratio.

GetDownsamplingFactor()

Float GetDownsamplingFactor

(

)

const

Queries the downsampling factor used for the footage.

Returns

The downsampling factor.

Alloc()

static MtFootageData* Alloc ( )

static

Internal.

Free()

static void Free ( MtFootageData *&  p )

static

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

Parameters

[in,out]

p

The MtFootageData to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.