ScatterAccess< K > Class Template Reference

Access trait for multiple, possibly scattered planes. More...

#include <cvb/vpat.hpp>

Classes
class	Column
	A single column. More...
class	Row
	A single row. More...

Public Member Functions
constexpr size_t	PlanesCount () const
	Gets the number of planes stored.
ScatterAccess< K >	NewMoved (const Cvb::Rect< int > newAoi) const noexcept
	Creates a new, moved scatter access object.
bool	Valid () const noexcept
	Gets whether the aggregated access objects are all valid.
	operator bool () const noexcept
	Gets whether the aggregated access objects are all valid.
std::array< const void *, K >	operator() (int x, int y) const noexcept
	Coordinate pixel access operator.
std::array< void *, K >	operator() (int x, int y) noexcept
	Coordinate pixel access operator.
std::array< const void *, K >	operator[] (int idx) const noexcept
	Index pixel access operator.
std::array< void *, K >	operator[] (int idx) noexcept
	Index pixel access operator.
Row	RowAt (int y) const
	Gets the Row at line y.
Column	ColumnAt (int x) const
	Gets the Column at x.

Static Public Member Functions
template<class... ACCESSES>
static ScatterAccess< K >	FromAccess (ACCESSES &&...planeAccesses)
	Creates a ScatterAccess from the given access planes.

Related Symbols
(Note that these are not member symbols.)
template<class... ACCESSES>
auto	MakeStaticScatterAccess (ACCESSES &&...planeAccesses) -> ScatterAccess< sizeof...(ACCESSES)>
	Creates a static scatter access with the given planes.

Detailed Description

template<int K>
class Cvb::ScatterAccess< K >

Access trait for multiple, possibly scattered planes.

Template Parameters

K	Number of planes to aggregate; Dynamic for runtime variable number of planes.

Member Function Documentation

ColumnAt()

template<int K>

Column ColumnAt ( int x ) const

inline

Gets the Column at x.

Parameters

[in]

x

Column to get.

Returns

Column object.

FromAccess()

template<int K>

template<class... ACCESSES>

static ScatterAccess< K > FromAccess ( ACCESSES &&... planeAccesses )

inlinestatic

Creates a ScatterAccess from the given access planes.

Note

The number of objects in the planes parameter pack must be equal to K.

Parameters

[in]

planeAccesses

Plane access objects.

Returns

Newly created ScatterAccess object.

NewMoved()

template<int K>

ScatterAccess< K > NewMoved ( const Cvb::Rect< int > newAoi ) const

inlinenoexcept

Creates a new, moved scatter access object.

Precondition

Valid() == true

Parameters

[in]

newAoi

Offset and new size in pixels to move this scatter access to.

Returns

New ScatterAccess object that is moved by (newAoi.Left(), newAoi.Top()).

operator bool()

template<int K>

operator bool ( ) const

inlineexplicitnoexcept

Gets whether the aggregated access objects are all valid.

Returns

true if all plane access objects are valid; false otherwise.

operator()() [1/2]

template<int K>

std::array< const void *, K > operator() ( int x, int y ) const

inlinenoexcept

Coordinate pixel access operator.

Precondition

Valid() == true

Parameters

[in]	x	X coordinate coefficient in pixels.
[in]	y	Y coordinate coefficient in pixels.

Returns

Array of const pointers to pixel's components.

operator()() [2/2]

template<int K>

std::array< void *, K > operator() ( int x, int y )

inlinenoexcept

Coordinate pixel access operator.

Precondition

Valid() == true

Parameters

[in]	x	X coordinate coefficient in pixels.
[in]	y	Y coordinate coefficient in pixels.

Returns

Array of mutable pointers to pixel's components.

operator[]() [1/2]

template<int K>

std::array< const void *, K > operator[] ( int idx ) const

inlinenoexcept

Index pixel access operator.

Precondition

Valid() == true

Parameters

[in]

idx

Pixel index.

Returns

Array of const pointers to pixel's components.

operator[]() [2/2]

template<int K>

std::array< void *, K > operator[] ( int idx )

inlinenoexcept

Index pixel access operator.

Precondition

Valid() == true

Parameters

[in]

idx

Pixel index.

Returns

Array of mutable pointers to pixel's components.

PlanesCount()

template<int K>

size_t PlanesCount ( ) const

inlineconstexpr

Gets the number of planes stored.

Returns

Effectively returns K.

RowAt()

template<int K>

Row RowAt ( int y ) const

inline

Gets the Row at line y.

Parameters

[in]

y

Line of row to get.

Returns

Row object.

Valid()

template<int K>

bool Valid ( ) const

inlinenoexcept

Gets whether the aggregated access objects are all valid.

Returns

true if all plane access objects are valid; false otherwise.

Friends And Related Symbol Documentation

MakeStaticScatterAccess()

template<class... ACCESSES>

auto MakeStaticScatterAccess ( ACCESSES &&... planeAccesses ) -> ScatterAccess<sizeof...(ACCESSES)>

related

Creates a static scatter access with the given planes.

Parameters

[in]

planeAccesses

Planes to make scatter access of.

Returns

Newly created ScatterAccess object.