org.bytedeco.javacpp

Class opencv_core.Rect

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.IntPointer

org.bytedeco.javacpp.opencv_core.Rect

All Implemented Interfaces:

AutoCloseable

Enclosing class:

opencv_core

@Name(value="cv::Rect_<int>")
 @NoOffset
public static class opencv_core.Rect
extends org.bytedeco.javacpp.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

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

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: - \f$\texttt{rect} = \texttt{rect} \pm \texttt{point}\f$ (shifting a rectangle by a certain offset) - \f$\texttt{rect} = \texttt{rect} \pm \texttt{size}\f$ (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 \f$\subseteq\f$ 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

org.bytedeco.javacpp.Pointer.CustomDeallocator, org.bytedeco.javacpp.Pointer.Deallocator, org.bytedeco.javacpp.Pointer.NativeDeallocator

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(opencv_core.Point pt1, opencv_core.Point pt2)
Rect(opencv_core.Point org, opencv_core.Size sz)
Rect(opencv_core.Rect r)
Rect(org.bytedeco.javacpp.Pointer p) Pointer cast constructor.

Method Summary

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

Methods inherited from class org.bytedeco.javacpp.IntPointer

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

Methods inherited from class org.bytedeco.javacpp.Pointer

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Rect

public Rect(org.bytedeco.javacpp.Pointer p)

Pointer cast constructor. Invokes Pointer.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
            opencv_core.Rect r)

Rect

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

Rect

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

Method Detail

position

public opencv_core.Rect position(long position)

Overrides:

position in class org.bytedeco.javacpp.IntPointer

put

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

tl

@ByVal
public opencv_core.Point tl()

the top-left corner

br

@ByVal
public opencv_core.Point br()

the bottom-right corner

size

@ByVal
public opencv_core.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
                                            opencv_core.Point pt)

checks whether the rectangle contains the point

x

public int x()

x coordinate of the top-left corner

x

public opencv_core.Rect x(int x)

y

public int y()

y coordinate of the top-left corner

y

public opencv_core.Rect y(int y)

width

public int width()

width of the rectangle

width

public opencv_core.Rect width(int width)

height

public int height()

height of the rectangle

height

public opencv_core.Rect height(int height)