PCL
Rectangle Classification Functions

Functions

template<typename T >
bool pcl::IsHorizontalLine (T x0, T y0, T x1, T y1)
 
template<typename T >
bool pcl::IsLine (T x0, T y0, T x1, T y1)
 
template<typename T >
bool pcl::IsNormalRect (T x0, T y0, T x1, T y1)
 
template<typename T >
bool pcl::IsOrderedRect (T x0, T y0, T x1, T y1)
 
template<typename T >
bool pcl::IsPoint (T x0, T y0, T x1, T y1)
 
template<typename T >
bool pcl::IsPointOrLine (T x0, T y0, T x1, T y1)
 
template<typename T >
bool pcl::IsRect (T x0, T y0, T x1, T y1)
 
template<typename T >
bool pcl::IsVerticalLine (T x0, T y0, T x1, T y1)
 
template<typename T >
void pcl::OrderRect (T &x0, T &y0, T &x1, T &y1)
 

Detailed Description

Function Documentation

◆ IsHorizontalLine()

template<typename T >
bool pcl::IsHorizontalLine ( x0,
y0,
x1,
y1 
)
inline

Returns true iff a set of rectangle coordinates define a horizontal line.

Parameters
x0,y0Upper left corner coordinates.
x1,y1Lower right corner coordinates.

The specified coordinates define a horizontal line if and only if y0 = y1 and x0 != x1.

Definition at line 159 of file Rectangle.h.

Referenced by pcl::GenericRectangle< T >::IsHorizontalLine().

◆ IsLine()

template<typename T >
bool pcl::IsLine ( x0,
y0,
x1,
y1 
)
inline

Returns true iff a set of rectangle coordinates define a line.

Parameters
x0,y0Upper left corner coordinates.
x1,y1Lower right corner coordinates.

The specified coordinates define a line if any of two conditions hold: x0 = x1 or y0 = y1, but not both conditions, that is, if the coordinates don't define a point.

Definition at line 142 of file Rectangle.h.

Referenced by pcl::GenericRectangle< T >::IsLine().

◆ IsNormalRect()

template<typename T >
bool pcl::IsNormalRect ( x0,
y0,
x1,
y1 
)
inline

Returns true iff a set of rectangle coordinates define a normal rectangle.

Parameters
x0,y0Upper left corner coordinates.
x1,y1Lower right corner coordinates.

A normal rectangle requires that x0 < x1 and y0 < y1.

Definition at line 226 of file Rectangle.h.

Referenced by pcl::GenericRectangle< T >::IsNormal().

◆ IsOrderedRect()

template<typename T >
bool pcl::IsOrderedRect ( x0,
y0,
x1,
y1 
)
inline

Returns true iff a set of rectangle coordinates define an ordered rectangle.

Parameters
x0,y0Upper left corner coordinates.
x1,y1Lower right corner coordinates.

An ordered rectangle requires that x0 <= x1 and y0 <= y1, that is, it can be a normal rectangle, a line, or a point.

Definition at line 243 of file Rectangle.h.

Referenced by pcl::GenericRectangle< T >::IsOrdered().

◆ IsPoint()

template<typename T >
bool pcl::IsPoint ( x0,
y0,
x1,
y1 
)
inline

Returns true iff a set of rectangle coordinates correspond to a point.

Parameters
x0,y0Upper left corner coordinates.
x1,y1Lower right corner coordinates.

The specified coordinates define a point if and only if x0 = x1 and y0 = y1.

Definition at line 124 of file Rectangle.h.

Referenced by pcl::GenericRectangle< T >::IsPoint().

◆ IsPointOrLine()

template<typename T >
bool pcl::IsPointOrLine ( x0,
y0,
x1,
y1 
)
inline

Returns true iff a set of rectangle coordinates define a point or a line.

Parameters
x0,y0Upper left corner coordinates.
x1,y1Lower right corner coordinates.

The specified coordinates define a point or line if either x0 = x1 or y0 = y1.

Definition at line 193 of file Rectangle.h.

Referenced by pcl::GenericRectangle< T >::IsPointOrLine().

◆ IsRect()

template<typename T >
bool pcl::IsRect ( x0,
y0,
x1,
y1 
)
inline

Returns true iff a set of rectangle coordinates define a rectangle.

Parameters
x0,y0Upper left corner coordinates.
x1,y1Lower right corner coordinates.

The specified coordinates define a rectangle if and only if x0 != x1 and y0 != y1.

Definition at line 210 of file Rectangle.h.

Referenced by pcl::GenericRectangle< T >::Intersect(), pcl::GenericRectangle< T >::IntersectFast(), and pcl::GenericRectangle< T >::IsRect().

◆ IsVerticalLine()

template<typename T >
bool pcl::IsVerticalLine ( x0,
y0,
x1,
y1 
)
inline

Returns true iff a set of rectangle coordinates define a vertical line.

Parameters
x0,y0Upper left corner coordinates.
x1,y1Lower right corner coordinates.

The specified coordinates define a vertical line if and only if x0 = x1 and y0 != y1.

Definition at line 176 of file Rectangle.h.

Referenced by pcl::GenericRectangle< T >::IsVerticalLine().

◆ OrderRect()

template<typename T >
void pcl::OrderRect ( T &  x0,
T &  y0,
T &  x1,
T &  y1 
)
inline

Orders a set of rectangle coordinates to define an ordered rectangle.

Parameters
[out]x0,y0References to the upper left corner coordinates.
[out]x1,y1References to the lower right corner coordinates.

This function ensures that x0 <= x1 and y0 <= y1, by exchanging coordinates if necessary.

Definition at line 260 of file Rectangle.h.

Referenced by pcl::GenericRectangle< T >::Intersects(), and pcl::GenericRectangle< T >::Order().