org.bytedeco.opencv.opencv_core

Class Rect

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.IntPointer

org.bytedeco.opencv.opencv_core.Rect

All Implemented Interfaces:

AutoCloseable

@Name(value="cv::Rect_<int>")
 @NoOffset
 @Properties(inherit=opencv_core.class)
public class Rect
extends IntPointer

\brief Template class for 2D rectangles

described by the following parameters: - Coordinates of the top-left corner. This is a default interpretation of Rect_::x and Rect_::y in OpenCV. Though, in your algorithms you may count x and y from the bottom-left corner. - Rectangle width and height.

OpenCV typically assumes that the top and left boundary of the rectangle are inclusive, while the right and bottom boundaries are not. For example, the method Rect_::contains returns true if

 \[x  \leq pt.x < x+width,
      y  \leq pt.y < y+height\]

Virtually every loop over an image ROI in OpenCV (where ROI is specified by Rect_\ ) is implemented as:

    for(int y = roi.y; y < roi.y + roi.height; y++)
        for(int x = roi.x; x < roi.x + roi.width; x++)
        {
            // ...
        }

In addition to the class members, the following operations on rectangles are implemented: - \texttt{rect} = \texttt{rect} \pm \texttt{point} (shifting a rectangle by a certain offset) - \texttt{rect} = \texttt{rect} \pm \texttt{size} (expanding or shrinking a rectangle by a certain amount) - rect += point, rect -= point, rect += size, rect -= size (augmenting operations) - rect = rect1 & rect2 (rectangle intersection) - rect = rect1 | rect2 (minimum area rectangle containing rect1 and rect2 ) - rect &= rect1, rect |= rect1 (and the corresponding augmenting operations) - rect == rect1, rect != rect1 (rectangle comparison)

This is an example how the partial ordering on rectangles can be established (rect1 \subseteq rect2):

    template<typename _Tp> inline bool
    operator <= (const Rect_<_Tp>& r1, const Rect_<_Tp>& r2)
    {
        return (r1 & r2) == r1;
    }

For your convenience, the Rect_\<\> alias is available: cv::Rect

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
Rect() default constructor
Rect(int _x, int _y, int _width, int _height)
Rect(long size) Native array allocator.
Rect(Pointer p) Pointer cast constructor.
Rect(Point pt1, Point pt2)
Rect(Point org, Size sz)
Rect(Rect r)

Method Summary

Modifier and Type	Method and Description
int	area() area (width*height) of the rectangle
Point	br() the bottom-right corner
boolean	contains(Point pt) checks whether the rectangle contains the point
boolean	empty() true if empty
Rect	getPointer(long i)
int	height() height of the rectangle
Rect	height(int setter)
Rect	position(long position)
Rect	put(Rect r)
Size	size() size (width, height) of the rectangle
Point	tl() the top-left corner
int	width() width of the rectangle
Rect	width(int setter)
int	x() x coordinate of the top-left corner
Rect	x(int setter)
int	y() y coordinate of the top-left corner
Rect	y(int setter)

Methods inherited from class org.bytedeco.javacpp.IntPointer

asBuffer, capacity, get, get, get, get, getString, getStringCodePoints, limit, put, put, put, put, putString, sizeof

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asByteBuffer, availablePhysicalBytes, calloc, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Rect

public Rect(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Rect

public Rect(long size)

Native array allocator. Access with Pointer.position(long).

Rect

public Rect()

default constructor

Rect

public Rect(int _x,
            int _y,
            int _width,
            int _height)

Rect

public Rect(@Const @ByRef
            Rect r)

Rect

public Rect(@Const @ByRef
            Point org,
            @Const @ByRef
            Size sz)

Rect

public Rect(@Const @ByRef
            Point pt1,
            @Const @ByRef
            Point pt2)

Method Detail

position

public Rect position(long position)

Overrides:

position in class IntPointer

getPointer

public Rect getPointer(long i)

Overrides:

getPointer in class IntPointer

put

@ByRef
 @Name(value="operator =")
public Rect put(@Const @ByRef
                                                    Rect r)

tl

@ByVal
public Point tl()

the top-left corner

br

@ByVal
public Point br()

the bottom-right corner

size

@ByVal
public Size size()

size (width, height) of the rectangle

area

public int area()

area (width*height) of the rectangle

empty

@Cast(value="bool")
public boolean empty()

true if empty

contains

@Cast(value="bool")
public boolean contains(@Const @ByRef
                                             Point pt)

checks whether the rectangle contains the point

x

public int x()

x coordinate of the top-left corner

x

public Rect x(int setter)

y

public int y()

y coordinate of the top-left corner

y

public Rect y(int setter)

width

public int width()

width of the rectangle

width

public Rect width(int setter)

height

public int height()

height of the rectangle

height

public Rect height(int setter)