Image Component Library (ICL)
Public Member Functions | Private Attributes | List of all members
icl::markers::TiltedQuad Class Reference

Utility class that represents a tilted quad in an image. More...

#include <TiltedQuad.h>

Public Member Functions

 TiltedQuad ()
 creates a null-instance More...
 
 TiltedQuad (const utils::Point32f &a, const utils::Point32f &b, const utils::Point32f &c, const utils::Point32f &d, const cv::ImageRegion r)
 creates a TiltedQuad instance with given 4 corners and given ImageRegion More...
 
 TiltedQuad (const utils::Point32f *ps, cv::ImageRegion r)
 creates a TiltedQuad instance with given 4D array of points and image region More...
 
utils::Point32foperator[] (int i)
 accesses the i-th corner point More...
 
const utils::Point32foperator[] (int i) const
 accesses the i-th corner point (const) More...
 
cv::ImageRegion getRegion () const
 returns the associated image region (always const) More...
 
void setRegion (cv::ImageRegion region)
 sets the image region (this is usually not used explicitly) More...
 
 operator bool () const
 returns whether the image region had been set before More...
 
const utils::Point32fdata () const
 returns the internal utils::Point-data pointer More...
 

Private Attributes

utils::Point32f ps [4]
 list of points (usually sorted in clock-wise order) More...
 
cv::ImageRegion region
 associated image region More...
 

Detailed Description

Utility class that represents a tilted quad in an image.

A tilted quad is represented by It's for corner points The class provides access to these points using the index operator

Constructor & Destructor Documentation

◆ TiltedQuad() [1/3]

icl::markers::TiltedQuad::TiltedQuad ( )
inline

creates a null-instance

◆ TiltedQuad() [2/3]

icl::markers::TiltedQuad::TiltedQuad ( const utils::Point32f a,
const utils::Point32f b,
const utils::Point32f c,
const utils::Point32f d,
const cv::ImageRegion  r 
)
inline

creates a TiltedQuad instance with given 4 corners and given ImageRegion

◆ TiltedQuad() [3/3]

icl::markers::TiltedQuad::TiltedQuad ( const utils::Point32f ps,
cv::ImageRegion  r 
)
inline

creates a TiltedQuad instance with given 4D array of points and image region

Member Function Documentation

◆ data()

const utils::Point32f* icl::markers::TiltedQuad::data ( ) const
inline

returns the internal utils::Point-data pointer

◆ getRegion()

cv::ImageRegion icl::markers::TiltedQuad::getRegion ( ) const
inline

returns the associated image region (always const)

◆ operator bool()

icl::markers::TiltedQuad::operator bool ( ) const
inline

returns whether the image region had been set before

◆ operator[]() [1/2]

utils::Point32f& icl::markers::TiltedQuad::operator[] ( int  i)
inline

accesses the i-th corner point

◆ operator[]() [2/2]

const utils::Point32f& icl::markers::TiltedQuad::operator[] ( int  i) const
inline

accesses the i-th corner point (const)

◆ setRegion()

void icl::markers::TiltedQuad::setRegion ( cv::ImageRegion  region)
inline

sets the image region (this is usually not used explicitly)

Member Data Documentation

◆ ps

utils::Point32f icl::markers::TiltedQuad::ps[4]
private

list of points (usually sorted in clock-wise order)

◆ region

cv::ImageRegion icl::markers::TiltedQuad::region
private

associated image region


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