NTV2FrameSize Class Reference

Describes the horizontal and vertical size dimensions of a raster, bitmap, frame or image. More...

#include <ntv2publicinterface.h>

Public Member Functions
	NTV2FrameSize (const ULWord inWidth=0, const ULWord inHeight=0)
	My constructor. More...
	NTV2FrameSize (const NTV2FrameGeometry inFG)
ULWord	width (void) const
ULWord	height (void) const
bool	isValid (void) const
bool	operator== (const NTV2FrameSize &rhs) const
bool	operator< (const NTV2FrameSize &rhs) const
	operator bool () const
	operator NTV2FrameGeometry () const
NTV2FrameSize &	setWidth (const ULWord inValue)
	Sets my width dimension. More...
NTV2FrameSize &	setHeight (const ULWord inValue)
	Sets my height dimension. More...
NTV2FrameSize &	set (const ULWord inWidth, const ULWord inHeight)
	Sets my dimension values. More...
NTV2FrameSize &	operator= (const NTV2FrameGeometry &rhs)
	Assigns me from an NTV2FrameGeometry. More...
NTV2FrameSize &	reset (void)
	Sets both my width and height to zero (an invalid state). More...
NTV2FrameSize &	swap (void)
	Swaps my width and height. More...
ULWord	GetWidth (void) const
ULWord	GetHeight (void) const
ULWord	Width (void) const
ULWord	Height (void) const
bool	IsValid (void) const
NTV2FrameSize &	SetWidth (const ULWord v)
NTV2FrameSize &	SetHeight (const ULWord v)
NTV2FrameSize &	Set (const ULWord w, const ULWord h)
NTV2FrameSize &	Reset (void)

Static Public Member Functions
static ULWord	FGWidth (const NTV2FrameGeometry fg)
static ULWord	FGHeight (const NTV2FrameGeometry fg)

Protected Types
typedef std::map< NTV2FrameGeometry, ULWord >	FGSizesMap
typedef FGSizesMap::const_iterator	FGSizesMapCI

Protected Member Functions
uint64_t	magnitude (void) const

Detailed Description

Describes the horizontal and vertical size dimensions of a raster, bitmap, frame or image.

Note

Renamed in SDK 17.5 from NTV2FrameDimensions to NTV2FrameSize.

Definition at line 5848 of file ntv2publicinterface.h.

Member Typedef Documentation

FGSizesMap

typedef std::map<NTV2FrameGeometry, ULWord> NTV2FrameSize::FGSizesMap

protected

Definition at line 5925 of file ntv2publicinterface.h.

FGSizesMapCI

typedef FGSizesMap::const_iterator NTV2FrameSize::FGSizesMapCI

protected

Definition at line 5926 of file ntv2publicinterface.h.

Constructor & Destructor Documentation

NTV2FrameSize() [1/2]

NTV2FrameSize::NTV2FrameSize ( const ULWord  inWidth = 0, const ULWord  inHeight = 0  )

inlineexplicit

My constructor.

Parameters

[in]	inWidth	Optionally specifies my initial width dimension, in pixels. Defaults to zero.
[in]	inHeight	Optionally specifies my initial height dimension, in lines. Defaults to zero.

Definition at line 5857 of file ntv2publicinterface.h.

NTV2FrameSize() [2/2]

NTV2FrameSize::NTV2FrameSize ( const NTV2FrameGeometry  inFG )

inlineexplicit

Definition at line 5858 of file ntv2publicinterface.h.

Member Function Documentation

FGHeight()

ULWord NTV2FrameSize::FGHeight ( const NTV2FrameGeometry  fg )

static

Definition at line 1551 of file ntv2publicinterface.cpp.

FGWidth()

ULWord NTV2FrameSize::FGWidth ( const NTV2FrameGeometry  fg )

static

Definition at line 1525 of file ntv2publicinterface.cpp.

GetHeight()

ULWord NTV2FrameSize::GetHeight ( void  ) const

inline

Deprecated:

Use height() instead

Definition at line 5910 of file ntv2publicinterface.h.

GetWidth()

ULWord NTV2FrameSize::GetWidth ( void  ) const

inline

Deprecated:

Use width() instead

Definition at line 5909 of file ntv2publicinterface.h.

height()

ULWord NTV2FrameSize::height ( void  ) const

inline

Returns

My height, in lines/rows.

Definition at line 5860 of file ntv2publicinterface.h.

Height()

ULWord NTV2FrameSize::Height ( void  ) const

inline

Deprecated:

Use height() instead

Definition at line 5912 of file ntv2publicinterface.h.

isValid()

bool NTV2FrameSize::isValid ( void  ) const

inline

Returns

True if both my width and height are non-zero.

Definition at line 5861 of file ntv2publicinterface.h.

IsValid()

bool NTV2FrameSize::IsValid ( void  ) const

inline

Deprecated:

Use isValid() instead

Definition at line 5913 of file ntv2publicinterface.h.

magnitude()

uint64_t NTV2FrameSize::magnitude ( void  ) const

inlineprotected

Definition at line 5924 of file ntv2publicinterface.h.

operator bool()

NTV2FrameSize::operator bool ( ) const

inline

Returns

True if I'm valid (cast to bool)

Definition at line 5864 of file ntv2publicinterface.h.

operator NTV2FrameGeometry()

NTV2FrameSize::operator NTV2FrameGeometry

(

)

const

Returns

my NTV2FrameGeometry or NTV2_FG_INVALID if invalid or non-SMPTE

Definition at line 1520 of file ntv2publicinterface.cpp.

operator<()

bool NTV2FrameSize::operator< ( const NTV2FrameSize &  rhs ) const

inline

Returns

True if I precede the rhs argument

Definition at line 5863 of file ntv2publicinterface.h.

operator=()

NTV2FrameSize& NTV2FrameSize::operator= ( const NTV2FrameGeometry &  rhs )

inline

Assigns me from an NTV2FrameGeometry.

Parameters

[in]

rhs

Specifies the NTV2FrameGeometry.

Returns

A non-constant reference to me.

Definition at line 5894 of file ntv2publicinterface.h.

operator==()

bool NTV2FrameSize::operator== ( const NTV2FrameSize &  rhs ) const

inline

Returns

True if I'm equal to the rhs argument

Definition at line 5862 of file ntv2publicinterface.h.

reset()

NTV2FrameSize& NTV2FrameSize::reset ( void  )

inline

Sets both my width and height to zero (an invalid state).

Returns

A non-constant reference to me.

Definition at line 5900 of file ntv2publicinterface.h.

Reset()

NTV2FrameSize& NTV2FrameSize::Reset ( void  )

inline

Deprecated:

Use reset() instead

Definition at line 5917 of file ntv2publicinterface.h.

set()

NTV2FrameSize& NTV2FrameSize::set ( const ULWord  inWidth, const ULWord  inHeight  )

inline

Sets my dimension values.

Parameters

[in]	inWidth	Specifies the new width dimension, in pixels.
[in]	inHeight	Specifies the new height dimension, in lines.

Returns

A non-constant reference to me.

Definition at line 5887 of file ntv2publicinterface.h.

Set()

NTV2FrameSize& NTV2FrameSize::Set ( const ULWord  w, const ULWord  h  )

inline

Deprecated:

Use set() instead

Definition at line 5916 of file ntv2publicinterface.h.

setHeight()

NTV2FrameSize& NTV2FrameSize::setHeight ( const ULWord  inValue )

inline

Sets my height dimension.

Parameters

[in]

inValue

Specifies the new height dimension, in lines.

Returns

A non-constant reference to me.

Definition at line 5879 of file ntv2publicinterface.h.

SetHeight()

NTV2FrameSize& NTV2FrameSize::SetHeight ( const ULWord  v )

inline

Deprecated:

Use setHeight() instead

Definition at line 5915 of file ntv2publicinterface.h.

setWidth()

NTV2FrameSize& NTV2FrameSize::setWidth ( const ULWord  inValue )

inline

Sets my width dimension.

Parameters

[in]

inValue

Specifies the new width dimension, in pixels.

Returns

A non-constant reference to me.

Definition at line 5872 of file ntv2publicinterface.h.

SetWidth()

NTV2FrameSize& NTV2FrameSize::SetWidth ( const ULWord  v )

inline

Deprecated:

Use setWidth() instead

Definition at line 5914 of file ntv2publicinterface.h.

swap()

NTV2FrameSize& NTV2FrameSize::swap ( void  )

inline

Swaps my width and height.

Returns

A non-constant reference to me.

Definition at line 5906 of file ntv2publicinterface.h.

width()

ULWord NTV2FrameSize::width ( void  ) const

inline

Returns

My width, in pixels.

Definition at line 5859 of file ntv2publicinterface.h.

Width()

ULWord NTV2FrameSize::Width ( void  ) const

inline

Deprecated:

Use width() instead

Definition at line 5911 of file ntv2publicinterface.h.

---

The documentation for this class was generated from the following files:

• /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/includes/ntv2publicinterface.h
• /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2publicinterface.cpp