Grok 20.3.2
Public Member Functions | Public Attributes | List of all members
grk::Rect< T > Struct Template Reference

#include <geometry.h>

Public Member Functions

 Rect (T origin_x0, T origin_y0, T x0, T y0, T x1, T y1)
 Rect (T x0, T y0, T x1, T y1)
 Rect (const Rect &rhs)
 Rect (const Rect *rhs)
 Rect (void)
virtual ~Rect ()=default
Rect< T > & setOrigin (T origx, T origy, bool absolute)
Rect< T > & setOrigin (const Rect< T > &rhs, bool absolute)
Rect< T > & setOrigin (const Rect< T > *rhs, bool absolute)
Rect< T > & toRelative (void)
Rect< T > & toAbsolute (void)
virtual void print (void) const
bool valid (void) const
bool empty (void) const
bool contains (Point< T > pt)
bool contains (T x, T y)
Rect< T > & operator= (const Rect &rhs)
Rect< T > & operator= (const Rect *rhs)
bool operator!= (const Rect &other) const
bool operator== (const Rect &rhs) const
void setRect (const Rect *rhs)
void setRect (const Rect &rhs)
Rect< T > scaleDownCeil (uint32_t den) const
Rect< T > scale (uint32_t scalex, uint32_t scaley) const
Rect< T > scaleDown (uint64_t denx, uint64_t deny) const
Rect< T > scaleDownPow2 (uint8_t powx, uint8_t powy) const
Rect< T > scaleDownPow2 (Point8 pow) const
Rect< T > scaleDownCeil (uint64_t denx, uint64_t deny) const
Rect< T > scaleDownCeilPow2 (uint8_t power) const
Rect< T > scaleDownCeilPow2 (uint8_t powx, uint8_t powy) const
Rect< T > intersection (const Rect< T > &rhs) const
Rect< T > clip (const Rect *rhs) const
Rect< T > clip (const Rect32_16 &rhs) const
Rect< T > clip (const Rect32_16 *rhs) const
Rect< T > clip (const Rect &rhs) const
Rect< T > & clip_IN_PLACE (const Rect &rhs)
Rect< T > intersection (const Rect *rhs) const
bool nonEmptyIntersection (const Rect *rhs) const
bool nonEmptyIntersection (const Rect32_16 *rhs) const
Rect< T > rectUnion (const Rect *rhs) const
Rect< T > rectUnion (const Rect &rhs) const
uint64_t area (void) const
T width () const
T height () const
Line< T > dimX () const
Line< T > dimY () const
Rect< T > pan (int64_t x, int64_t y) const
Rect< T > & pan_IN_PLACE (int64_t x, int64_t y)
Rect< T > & grow_IN_PLACE (T boundary)
Rect< T > & grow_IN_PLACE (T boundaryx, T boundaryy)
Rect< T > & grow_IN_PLACE (T boundary, T maxX, T maxY)
Rect< T > & grow_IN_PLACE (T boundaryx, T boundaryy, T maxX, T maxY)
Rect< T > & grow_IN_PLACE (T boundary, const Rect< T > &bounds)
Rect< T > & grow_IN_PLACE (T boundaryx, T boundaryy, Rect bounds)

Public Attributes

bool absoluteCoordinates
T origin_x0
T origin_y0
T x0
T y0
T x1
T y1

Constructor & Destructor Documentation

◆ Rect() [1/5]

template<typename T>
grk::Rect< T >::Rect ( T origin_x0,
T origin_y0,
T x0,
T y0,
T x1,
T y1 )
inline

◆ Rect() [2/5]

template<typename T>
grk::Rect< T >::Rect ( T x0,
T y0,
T x1,
T y1 )
inline

◆ Rect() [3/5]

template<typename T>
grk::Rect< T >::Rect ( const Rect< T > & rhs)
inline

◆ Rect() [4/5]

template<typename T>
grk::Rect< T >::Rect ( const Rect< T > * rhs)
inlineexplicit

◆ Rect() [5/5]

template<typename T>
grk::Rect< T >::Rect ( void )
inline

Referenced by grk::Rect< uint32_t >::clip(), grk::Rect< uint32_t >::clip(), grk::Rect< uint32_t >::clip_IN_PLACE(), grk::Rect< uint32_t >::intersection(), grk::Rect< uint32_t >::rectUnion(), grk::Rect< uint32_t >::scale(), grk::Rect< uint32_t >::scaleDown(), grk::Rect< uint32_t >::scaleDownCeil(), grk::Rect< uint32_t >::scaleDownCeil(), grk::Rect< uint32_t >::scaleDownCeilPow2(), grk::Rect< uint32_t >::scaleDownCeilPow2(), and grk::Rect< uint32_t >::scaleDownPow2().

◆ ~Rect()

template<typename T>
virtual grk::Rect< T >::~Rect ( )
virtualdefault

Member Function Documentation

◆ area()

template<typename T>
uint64_t grk::Rect< T >::area ( void ) const
inline

◆ clip() [1/4]

template<typename T>
Rect< T > grk::Rect< T >::clip ( const Rect< T > & rhs) const
inline

◆ clip() [2/4]

template<typename T>
Rect< T > grk::Rect< T >::clip ( const Rect< T > * rhs) const
inline

Referenced by grk::Rect< uint32_t >::clip(), and grk::Rect< uint32_t >::clip().

◆ clip() [3/4]

template<typename T>
Rect< T > grk::Rect< T >::clip ( const Rect32_16 & rhs) const
inline

◆ clip() [4/4]

template<typename T>
Rect< T > grk::Rect< T >::clip ( const Rect32_16 * rhs) const
inline

◆ clip_IN_PLACE()

template<typename T>
Rect< T > & grk::Rect< T >::clip_IN_PLACE ( const Rect< T > & rhs)
inline

Referenced by grk::ResWindow< T >::getPaddedBandWindow(), and grk::ResPrecinctInfo::init().

◆ contains() [1/2]

template<typename T>
bool grk::Rect< T >::contains ( Point< T > pt)
inline

Referenced by grk::Rect< uint32_t >::contains().

◆ contains() [2/2]

template<typename T>
bool grk::Rect< T >::contains ( T x,
T y )
inline

◆ dimX()

template<typename T>
Line< T > grk::Rect< T >::dimX ( ) const
inline

Referenced by grk::WaveletReverse::partial_tile().

◆ dimY()

template<typename T>
Line< T > grk::Rect< T >::dimY ( ) const
inline

Referenced by grk::WaveletReverse::partial_tile().

◆ empty()

template<typename T>
bool grk::Rect< T >::empty ( void ) const
inline

Referenced by grk::TileWindow::init(), and grk::TileWindow::slate().

◆ grow_IN_PLACE() [1/6]

template<typename T>
Rect< T > & grk::Rect< T >::grow_IN_PLACE ( T boundary)
inline

Referenced by grk::TileComponent::allocRegionWindow(), grk::ResWindow< T >::getPaddedBandWindow(), grk::Rect< uint32_t >::grow_IN_PLACE(), grk::Rect< uint32_t >::grow_IN_PLACE(), grk::Rect< uint32_t >::grow_IN_PLACE(), grk::Rect< uint32_t >::grow_IN_PLACE(), grk::Rect< uint32_t >::grow_IN_PLACE(), and grk::ResPrecinctInfo::init().

◆ grow_IN_PLACE() [2/6]

template<typename T>
Rect< T > & grk::Rect< T >::grow_IN_PLACE ( T boundary,
const Rect< T > & bounds )
inline

◆ grow_IN_PLACE() [3/6]

template<typename T>
Rect< T > & grk::Rect< T >::grow_IN_PLACE ( T boundary,
T maxX,
T maxY )
inline

◆ grow_IN_PLACE() [4/6]

template<typename T>
Rect< T > & grk::Rect< T >::grow_IN_PLACE ( T boundaryx,
T boundaryy )
inline

◆ grow_IN_PLACE() [5/6]

template<typename T>
Rect< T > & grk::Rect< T >::grow_IN_PLACE ( T boundaryx,
T boundaryy,
Rect< T > bounds )
inline

◆ grow_IN_PLACE() [6/6]

template<typename T>
Rect< T > & grk::Rect< T >::grow_IN_PLACE ( T boundaryx,
T boundaryy,
T maxX,
T maxY )
inline

◆ height()

template<typename T>
T grk::Rect< T >::height ( ) const
inline

Referenced by grk::PartialBandInfo< FILTER_WIDTH >::alloc(), grk::Buffer2d< T, AllocatorAligned >::Buffer2d(), grk::GrkImage::compositeInterleaved(), grk::GrkImage::compositePlanar(), grk::WaveletReverse::partial_tile(), and grk::SparseCanvas< T, LBW, LBH >::readWrite().

◆ intersection() [1/2]

template<typename T>
Rect< T > grk::Rect< T >::intersection ( const Rect< T > * rhs) const
inline

◆ intersection() [2/2]

template<typename T>
Rect< T > grk::Rect< T >::intersection ( const Rect< T > & rhs) const
inline

Referenced by grk::GrkImage::generateCompositeBounds(), grk::ResWindow< T >::getPaddedBandWindow(), grk::Rect< uint32_t >::intersection(), and grk::TileComponentWindowBase< T >::TileComponentWindowBase().

◆ nonEmptyIntersection() [1/2]

template<typename T>
bool grk::Rect< T >::nonEmptyIntersection ( const Rect< T > * rhs) const
inline

◆ nonEmptyIntersection() [2/2]

template<typename T>
bool grk::Rect< T >::nonEmptyIntersection ( const Rect32_16 * rhs) const
inline

◆ operator!=()

template<typename T>
bool grk::Rect< T >::operator!= ( const Rect< T > & other) const
inline

◆ operator=() [1/2]

template<typename T>
Rect< T > & grk::Rect< T >::operator= ( const Rect< T > & rhs)
inline

◆ operator=() [2/2]

template<typename T>
Rect< T > & grk::Rect< T >::operator= ( const Rect< T > * rhs)
inline

◆ operator==()

template<typename T>
bool grk::Rect< T >::operator== ( const Rect< T > & rhs) const
inline

◆ pan()

template<typename T>
Rect< T > grk::Rect< T >::pan ( int64_t x,
int64_t y ) const
inline

Referenced by grk::GrkImage::generateCompositeBounds().

◆ pan_IN_PLACE()

template<typename T>
Rect< T > & grk::Rect< T >::pan_IN_PLACE ( int64_t x,
int64_t y )
inline

Referenced by grk::Rect< uint32_t >::pan(), grk::Rect< uint32_t >::toAbsolute(), and grk::Rect< uint32_t >::toRelative().

◆ print()

template<typename T>
virtual void grk::Rect< T >::print ( void ) const
inlinevirtual

Reimplemented in grk::Resolution, and grk::Subband.

◆ rectUnion() [1/2]

template<typename T>
Rect< T > grk::Rect< T >::rectUnion ( const Rect< T > & rhs) const
inline

◆ rectUnion() [2/2]

template<typename T>
Rect< T > grk::Rect< T >::rectUnion ( const Rect< T > * rhs) const
inline

Referenced by grk::TileComponent::allocRegionWindow(), and grk::Rect< uint32_t >::rectUnion().

◆ scale()

template<typename T>
Rect< T > grk::Rect< T >::scale ( uint32_t scalex,
uint32_t scaley ) const
inline

◆ scaleDown()

template<typename T>
Rect< T > grk::Rect< T >::scaleDown ( uint64_t denx,
uint64_t deny ) const
inline

◆ scaleDownCeil() [1/2]

template<typename T>
Rect< T > grk::Rect< T >::scaleDownCeil ( uint32_t den) const
inline

Referenced by grk::PacketManager::getParams(), and grk::ResPrecinctInfo::init().

◆ scaleDownCeil() [2/2]

template<typename T>
Rect< T > grk::Rect< T >::scaleDownCeil ( uint64_t denx,
uint64_t deny ) const
inline

◆ scaleDownCeilPow2() [1/2]

template<typename T>
Rect< T > grk::Rect< T >::scaleDownCeilPow2 ( uint8_t power) const
inline

Referenced by grk::TileComponentWindowBase< T >::TileComponentWindowBase().

◆ scaleDownCeilPow2() [2/2]

template<typename T>
Rect< T > grk::Rect< T >::scaleDownCeilPow2 ( uint8_t powx,
uint8_t powy ) const
inline

◆ scaleDownPow2() [1/2]

template<typename T>
Rect< T > grk::Rect< T >::scaleDownPow2 ( Point8 pow) const
inline

◆ scaleDownPow2() [2/2]

template<typename T>
Rect< T > grk::Rect< T >::scaleDownPow2 ( uint8_t powx,
uint8_t powy ) const
inline

Referenced by grk::Rect< uint32_t >::scaleDownPow2().

◆ setOrigin() [1/3]

template<typename T>
Rect< T > & grk::Rect< T >::setOrigin ( const Rect< T > & rhs,
bool absolute )
inline

◆ setOrigin() [2/3]

template<typename T>
Rect< T > & grk::Rect< T >::setOrigin ( const Rect< T > * rhs,
bool absolute )
inline

◆ setOrigin() [3/3]

template<typename T>
Rect< T > & grk::Rect< T >::setOrigin ( T origx,
T origy,
bool absolute )
inline

Referenced by grk::ResWindow< T >::getPaddedBandWindow(), and grk::Rect< uint32_t >::setOrigin().

◆ setRect() [1/2]

template<typename T>
void grk::Rect< T >::setRect ( const Rect< T > & rhs)
inline

◆ setRect() [2/2]

template<typename T>
void grk::Rect< T >::setRect ( const Rect< T > * rhs)
inline

Referenced by grk::Rect< uint32_t >::setRect().

◆ toAbsolute()

template<typename T>
Rect< T > & grk::Rect< T >::toAbsolute ( void )
inline

Referenced by grk::ResWindow< T >::genSplitWindowBuffers().

◆ toRelative()

template<typename T>
Rect< T > & grk::Rect< T >::toRelative ( void )
inline

Referenced by grk::ResWindow< T >::genSplitWindowBuffers().

◆ valid()

template<typename T>
bool grk::Rect< T >::valid ( void ) const
inline

Referenced by grk::SparseCanvas< T, LBW, LBH >::readWrite().

◆ width()

template<typename T>
T grk::Rect< T >::width ( ) const
inline

Referenced by grk::PartialBandInfo< FILTER_WIDTH >::alloc(), grk::GrkImage::compositeInterleaved(), grk::GrkImage::compositePlanar(), and grk::WaveletReverse::partial_tile().

Member Data Documentation

◆ absoluteCoordinates

template<typename T>
bool grk::Rect< T >::absoluteCoordinates

Referenced by grk::Rect< uint32_t >::clip(), grk::Rect< uint32_t >::clip_IN_PLACE(), grk::Rect< uint32_t >::intersection(), grk::Rect< uint32_t >::intersection(), grk::Rect< uint32_t >::nonEmptyIntersection(), grk::Rect< uint32_t >::operator=(), grk::Rect< uint32_t >::operator==(), grk::Rect< uint32_t >::Rect(), and grk::Rect< uint32_t >::rectUnion().

◆ origin_x0

template<typename T>
T grk::Rect< T >::origin_x0

Referenced by grk::ResSimple::getBandWindow(), grk::Rect< uint32_t >::operator=(), grk::Rect< uint32_t >::operator==(), and grk::Rect< uint32_t >::setOrigin().

◆ origin_y0

template<typename T>
T grk::Rect< T >::origin_y0

Referenced by grk::ResSimple::getBandWindow(), grk::Rect< uint32_t >::operator=(), grk::Rect< uint32_t >::operator==(), and grk::Rect< uint32_t >::setOrigin().

◆ x0

template<typename T>
T grk::Rect< T >::x0

Referenced by grk::SparseCanvas< T, LBW, LBH >::alloc(), grk::Rect< uint32_t >::clip(), grk::Rect< uint32_t >::clip_IN_PLACE(), grk::GrkImage::compositeInterleaved(), grk::GrkImage::compositePlanar(), grk::Buffer2d< T, AllocatorAligned >::copyFrom(), grk::Buffer2d< T, AllocatorAligned >::copyFromNarrow(), grk::GrkImage::extractFrom(), grk::Subband::generateBandPrecinctBounds(), grk::Resolution::genPrecinctPartition(), grk::ResWindow< T >::genSplitWindowBuffers(), grk::ResSimple::getBandWindow(), grk::CodingParams::getTileBounds(), grk::Rect< uint32_t >::grow_IN_PLACE(), grk::PacketIter::init(), grk::intersect(), grk::Rect< uint32_t >::intersection(), grk::SparseCanvas< T, LBW, LBH >::isWindowValid(), grk::Rect< uint32_t >::nonEmptyIntersection(), grk::Rect< uint32_t >::operator=(), grk::Rect< uint32_t >::operator==(), grk::WaveletReverse::partial_tile(), grk::SparseCanvas< T, LBW, LBH >::readWrite(), grk::Rect< uint32_t >::rectUnion(), grk::CodeStreamDecompress::setDecompressRegion(), grk::TileWindow::slate(), grk::GrkImage::subsampleAndReduce(), grk::TileCompletion::TileCompletion(), and grk::PacketManager::updateCompressTcpProgressions().

◆ x1

template<typename T>
T grk::Rect< T >::x1

Referenced by grk::SparseCanvas< T, LBW, LBH >::alloc(), grk::Rect< uint32_t >::clip(), grk::Rect< uint32_t >::clip_IN_PLACE(), grk::GrkImage::extractFrom(), grk::Resolution::genPrecinctPartition(), grk::ResWindow< T >::genSplitWindowBuffers(), grk::ResSimple::getBandWindow(), grk::CodingParams::getTileBounds(), grk::Rect< uint32_t >::grow_IN_PLACE(), grk::PacketIter::init(), grk::intersect(), grk::Rect< uint32_t >::intersection(), grk::SparseCanvas< T, LBW, LBH >::isWindowValid(), grk::Rect< uint32_t >::nonEmptyIntersection(), grk::Rect< uint32_t >::operator=(), grk::Rect< uint32_t >::operator==(), grk::WaveletReverse::partial_tile(), grk::SparseCanvas< T, LBW, LBH >::readWrite(), grk::Rect< uint32_t >::rectUnion(), grk::CodeStreamDecompress::setDecompressRegion(), grk::TileWindow::slate(), grk::TileCompletion::TileCompletion(), and grk::PacketManager::updateCompressTcpProgressions().

◆ y0

template<typename T>
T grk::Rect< T >::y0

Referenced by grk::SparseCanvas< T, LBW, LBH >::alloc(), grk::Rect< uint32_t >::clip(), grk::Rect< uint32_t >::clip_IN_PLACE(), grk::GrkImage::compositeInterleaved(), grk::GrkImage::compositePlanar(), grk::Buffer2d< T, AllocatorAligned >::copyFrom(), grk::Buffer2d< T, AllocatorAligned >::copyFromNarrow(), grk::GrkImage::extractFrom(), grk::Subband::generateBandPrecinctBounds(), grk::Resolution::genPrecinctPartition(), grk::ResWindow< T >::genSplitWindowBuffers(), grk::ResSimple::getBandWindow(), grk::CodingParams::getTileBounds(), grk::Rect< uint32_t >::grow_IN_PLACE(), grk::PacketIter::init(), grk::intersect(), grk::Rect< uint32_t >::intersection(), grk::SparseCanvas< T, LBW, LBH >::isWindowValid(), grk::Rect< uint32_t >::nonEmptyIntersection(), grk::Rect< uint32_t >::operator=(), grk::Rect< uint32_t >::operator==(), grk::WaveletReverse::partial_tile(), grk::SparseCanvas< T, LBW, LBH >::readWrite(), grk::Rect< uint32_t >::rectUnion(), grk::ResWindow< T >::ResWindow(), grk::CodeStreamDecompress::setDecompressRegion(), grk::TileWindow::slate(), grk::GrkImage::subsampleAndReduce(), grk::TileCompletion::TileCompletion(), and grk::PacketManager::updateCompressTcpProgressions().

◆ y1

template<typename T>
T grk::Rect< T >::y1

Referenced by grk::SparseCanvas< T, LBW, LBH >::alloc(), grk::Rect< uint32_t >::clip(), grk::Rect< uint32_t >::clip_IN_PLACE(), grk::GrkImage::extractFrom(), grk::Resolution::genPrecinctPartition(), grk::ResWindow< T >::genSplitWindowBuffers(), grk::ResSimple::getBandWindow(), grk::CodingParams::getTileBounds(), grk::Rect< uint32_t >::grow_IN_PLACE(), grk::PacketIter::init(), grk::intersect(), grk::Rect< uint32_t >::intersection(), grk::SparseCanvas< T, LBW, LBH >::isWindowValid(), grk::Rect< uint32_t >::nonEmptyIntersection(), grk::Rect< uint32_t >::operator=(), grk::Rect< uint32_t >::operator==(), grk::WaveletReverse::partial_tile(), grk::SparseCanvas< T, LBW, LBH >::readWrite(), grk::Rect< uint32_t >::rectUnion(), grk::ResWindow< T >::ResWindow(), grk::CodeStreamDecompress::setDecompressRegion(), grk::TileWindow::slate(), grk::TileCompletion::TileCompletion(), and grk::PacketManager::updateCompressTcpProgressions().

The documentation for this struct was generated from the following file:
Generated by doxygen 1.17.0