Zivid::BoundingBox Struct Reference

Defines a 2D rectangular bounding box in image coordinates. More...

#include <Zivid/BoundingBox.h>

Public Types
using	ValueType = int
	The type of the coordinate values.

Public Member Functions
	BoundingBox ()=default
constexpr	BoundingBox (int xCoord, int yCoord, int boxWidth, int boxHeight)
	Constructor.
ZIVID_UTILS_EXPORT std::string	toString () const
	Get string representation.
ZIVID_UTILS_EXPORT bool	operator== (const BoundingBox &rhs) const
	Check for equality.
ZIVID_UTILS_EXPORT bool	operator!= (const BoundingBox &rhs) const
	Check for inequality.

Public Attributes
ValueType	x
	Top-left corner x coordinate.
ValueType	y
	Top-left corner y coordinate.
ValueType	width
	Width of the bounding box.
ValueType	height
	Height of the bounding box.

Detailed Description

Defines a 2D rectangular bounding box in image coordinates.

Member Typedef Documentation

ValueType

using Zivid::BoundingBox::ValueType = int

The type of the coordinate values.

summary>Constructor

Constructor & Destructor Documentation

BoundingBox() [1/2]

Zivid::BoundingBox::BoundingBox ( )

default

BoundingBox() [2/2]

Zivid::BoundingBox::BoundingBox ( int xCoord, int yCoord, int boxWidth, int boxHeight )

inlineconstexpr

Constructor.

Member Function Documentation

operator!=()

ZIVID_UTILS_EXPORT bool Zivid::BoundingBox::operator!=

(

const BoundingBox &

rhs

)

const

Check for inequality.

operator==()

ZIVID_UTILS_EXPORT bool Zivid::BoundingBox::operator==

(

const BoundingBox &

rhs

)

const

Check for equality.

toString()

ZIVID_UTILS_EXPORT std::string Zivid::BoundingBox::toString

(

)

const

Get string representation.

Member Data Documentation

height

ValueType Zivid::BoundingBox::height

Height of the bounding box.

width

ValueType Zivid::BoundingBox::width

Width of the bounding box.

x

ValueType Zivid::BoundingBox::x

Top-left corner x coordinate.

y

ValueType Zivid::BoundingBox::y

Top-left corner y coordinate.

---

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

• Zivid/BoundingBox.h