Rectangle Class

Namespace: id3.Devices

Definition

Represents a rectangle or a quadrangle.

Python

class Rectangle

Dart

class Rectangle implements Finalizable

C#

public partial class Rectangle

Java

public class Rectangle implements AutoCloseable, Serializable

C

typedef struct id3DevicesRectangle *ID3_DEVICES_RECTANGLE;

Usage

Python

rectangleInstance = id3devices.Rectangle()

Explicit destruction

# ...
del rectangleInstance

Dart

final rectangleInstance = sdk.Rectangle();
// ...

Explicit destruction

// ...
rectangleInstance.dispose()

C#

using (var rectangleInstance = new Rectangle())
{
   // ...
}

Explicit destruction

var rectangleInstance = new Rectangle()
// ...
rectangleInstance.Dispose()

Java

try (Rectangle rectangleInstance = new Rectangle()) {
// ...
}

Explicit destruction

Rectangle rectangleInstance = new Rectangle();
// ...
rectangleInstance.close();

C

ID3_DEVICES_RECTANGLE hRectangle{};
int err = id3DevicesRectangle_Initialize(&hRectangle);
if (err == ID3_SUCCESS) {
    // ...
    id3DevicesRectangle_Dispose(&hRectangle);
}

Properties

Name	Type	Description
bottomLeft	Point	Bottom-left corner of the rectangle.
bottomRight	Point	Bottom-right corner of the rectangle.
topLeft	Point	Top-left corner of the rectangle.
topRight	Point	Top-right corner of the rectangle.

Static Methods

Name	Description
fromPoints	Creates a quadrangle from 4 points.
fromXywh	Creates an aligned rectangle from the top-left point and the width/height.
fromXyxy	Creates an aligned rectangle from 2 points (top-left and bottom right) coordinates.

Methods

Name	Description
clipInsideImage	Clip a rectangle to be fully inside an image.
clone	Clones the Rectangle object.
extend	Extends the rectangle by an amount in pixels on each side. Use on aligned rectangle only.
getEnglobingRectangle	Returns the englobing aligned rectangle around the given quadrangle.
getHeight	Returns the height of the rectangle. Use on aligned rectangle only.
getWidth	Returns the width of the rectangle. Use on aligned rectangle only.
getX	Returns the x-coord of the TopLeft corner. Use on aligned rectangle only.
getY	Returns the y-coord of the TopLeft corner. Use on aligned rectangle only.
isAligned	Return True if the rectangle is aligned, False if it’s a quadrangle.
resize	Applies a scale factor to the rectangle.