com.aspose.drawing

Class RectangleF

java.lang.Object

com.aspose.ms.System.ValueType<T>

com.aspose.ms.lang.Struct<RectangleF>

com.aspose.drawing.RectangleF

All Implemented Interfaces:

com.aspose.ms.System.IEquatable<RectangleF>, Cloneable

public class RectangleF
extends com.aspose.ms.lang.Struct<RectangleF>
implements com.aspose.ms.System.IEquatable<RectangleF>, Cloneable

Stores a set of four floating-point numbers that represent the location and size of a rectangle. For more advanced region functions, use a Region object.

Constructor Summary

Constructors

Constructor and Description
RectangleF()
RectangleF(float x, float y, float width, float height) Initializes a new instance of the RectangleF structure with the specified location and size.
RectangleF(PointF location, SizeF size) Initializes a new instance of the RectangleF structure with the specified location and size.

Method Summary

Modifier and Type	Method and Description
Object	clone()
RectangleF	Clone()
void	CloneTo(RectangleF that)
boolean	contains(float x, float y) Determines if the specified point is contained within this RectangleF structure.
boolean	contains(PointF pt) Determines if the specified point is contained within this RectangleF structure.
boolean	contains(RectangleF rect) Determines if the rectangular region represented by rect is entirely contained within this RectangleF structure.
boolean	equals(Object obj) Determines whether the specified Object, is equal to this instance.
boolean	equals(RectangleF other) Tests whether other RectangleF structure has the same location and size of this RectangleF structure.
static RectangleF	fromLTRB(float left, float top, float right, float bottom) Creates a RectangleF structure with upper-left corner and lower-right corner at the specified locations.
static RectangleF	fromPoints(PointF point1, PointF point2) Creates a new rectangle from two points.
float	getBottom() Gets the y-coordinate that is the sum of Y and Height of this RectangleF structure.
static RectangleF	getEmpty()
float	getHeight() Gets the height of this RectangleF structure.
float	getLeft() Gets the x-coordinate of the left edge of this RectangleF structure.
PointF	getLocation() Gets the coordinates of the upper-left corner of this RectangleF structure.
float	getRight() Gets the x-coordinate that is the sum of X and Width of this RectangleF structure.
SizeF	getSize() Gets the size of this RectangleF.
float	getTop() Gets the y-coordinate of the top edge of this RectangleF structure.
float	getWidth() Gets the width of this RectangleF structure.
float	getX() Gets the x-coordinate of the upper-left corner of this RectangleF structure.
float	getY() Gets the x-coordinate of the upper-left corner of this RectangleF structure.
int	hashCode() Returns a hash code for this instance.
void	inflate(float x, float y) Inflates this RectangleF structure by the specified amount.
static RectangleF	inflate(RectangleF rect, float x, float y) Creates and returns an inflated copy of the specified RectangleF structure.
void	inflate(SizeF size) Inflates this RectangleF by the specified amount.
void	intersect(RectangleF rect) Replaces this RectangleF structure with the intersection of itself and the specified RectangleF structure.
static RectangleF	intersect(RectangleF a, RectangleF b) Returns a RectangleF structure that represents the intersection of two rectangles.
boolean	intersectsWith(RectangleF rect) Determines if this rectangle intersects with rect.
boolean	isEmpty() Gets a value indicating whether the RectangleF.Width or RectangleF.Height property of this RectangleF has a value of zero.
static boolean	isEquals(RectangleF obj1, RectangleF obj2)
void	offset(float x, float y) Adjusts the location of this rectangle by the specified amount.
void	offset(PointF pos) Adjusts the location of this rectangle by the specified amount.
static boolean	op_Equality(RectangleF left, RectangleF right) Tests whether two RectangleF structures have equal location and size.
static boolean	op_Inequality(RectangleF left, RectangleF right) Tests whether two RectangleF structures differ in location or size.
void	setHeight(float value) Sets the height of this RectangleF structure.
void	setLocation(PointF value) Sets the coordinates of the upper-left corner of this RectangleF structure.
void	setSize(SizeF value) Sets the size of this RectangleF.
void	setWidth(float value) Sets the width of this RectangleF structure.
void	setX(float value) Sets the x-coordinate of the upper-left corner of this RectangleF structure.
void	setY(float value) Sets the x-coordinate of the upper-left corner of this RectangleF structure.
static RectangleF	to_RectangleF(Rectangle r) Converts the specified Rectangle structure to a RectangleF structure.
String	toString()
static RectangleF	union(RectangleF a, RectangleF b) Creates the smallest possible third rectangle that can contain both of two rectangles that form a union.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RectangleF

public RectangleF()

RectangleF

public RectangleF(PointF location,
                  SizeF size)

Initializes a new instance of the RectangleF structure with the specified location and size.

Parameters:

location - A PointF that represents the upper-left corner of the rectangular region.

size - A SizeF that represents the width and height of the rectangular region.

RectangleF

public RectangleF(float x,
                  float y,
                  float width,
                  float height)

Initializes a new instance of the RectangleF structure with the specified location and size.

Parameters:

x - The x-coordinate of the upper-left corner of the rectangle.

y - The y-coordinate of the upper-left corner of the rectangle.

width - The width of the rectangle.

height - The height of the rectangle.

Method Detail

fromPoints

public static RectangleF fromPoints(PointF point1,
                                    PointF point2)

Creates a new rectangle from two points. The created rectangle will be normalized with (left,top) lower than (right,bottom).

Parameters:

point1 - The first point.

point2 - The second point.

Returns:

A newly created rectangle.

to_RectangleF

public static RectangleF to_RectangleF(Rectangle r)

Converts the specified Rectangle structure to a RectangleF structure.

Parameters:

r - The Rectangle structure to convert.

Returns:

The RectangleF structure that is converted from the specified Rectangle structure.

op_Equality

public static boolean op_Equality(RectangleF left,
                                  RectangleF right)

Tests whether two RectangleF structures have equal location and size.

Parameters:

left - The RectangleF structure that is to the left of the equality operator.

right - The RectangleF structure that is to the right of the equality operator.

Returns:

This operator returns true if the two specified RectangleF structures have equal RectangleF.X, RectangleF.Y, RectangleF.Width, and RectangleF.Height properties.

op_Inequality

public static boolean op_Inequality(RectangleF left,
                                    RectangleF right)

Tests whether two RectangleF structures differ in location or size.

Parameters:

left - The RectangleF structure that is to the left of the inequality operator.

right - The RectangleF structure that is to the right of the inequality operator.

Returns:

This operator returns true if any of the RectangleF.X, RectangleF.Y, RectangleF.Width, or RectangleF.Height properties of the two Rectangle structures are unequal; otherwise false.

fromLTRB

public static RectangleF fromLTRB(float left,
                                  float top,
                                  float right,
                                  float bottom)

Creates a RectangleF structure with upper-left corner and lower-right corner at the specified locations.

Parameters:

left - The x-coordinate of the upper-left corner of the rectangular region.

top - The y-coordinate of the upper-left corner of the rectangular region.

right - The x-coordinate of the lower-right corner of the rectangular region.

bottom - The y-coordinate of the lower-right corner of the rectangular region.

Returns:

The new RectangleF that this method creates.

inflate

public static RectangleF inflate(RectangleF rect,
                                 float x,
                                 float y)

Creates and returns an inflated copy of the specified RectangleF structure. The copy is inflated by the specified amount. The original rectangle remains unmodified.

Parameters:

rect - The RectangleF to be copied. This rectangle is not modified.

x - The amount to inflate the copy of the rectangle horizontally.

y - The amount to inflate the copy of the rectangle vertically.

Returns:

The inflated RectangleF.

intersect

public static RectangleF intersect(RectangleF a,
                                   RectangleF b)

Returns a RectangleF structure that represents the intersection of two rectangles. If there is no intersection, and empty RectangleF is returned.

Parameters:

a - First rectangle to intersect.

b - Second rectangle to intersect.

Returns:

A third RectangleF structure the size of which represents the overlapped area of the two specified rectangles.

union

public static RectangleF union(RectangleF a,
                               RectangleF b)

Creates the smallest possible third rectangle that can contain both of two rectangles that form a union.

Parameters:

a - First rectangle to union.

b - Second rectangle to union.

Returns:

A third RectangleF structure that contains both of the two rectangles that form the union.

isEquals

public static boolean isEquals(RectangleF obj1,
                               RectangleF obj2)

getEmpty

public static RectangleF getEmpty()

isEmpty

public final boolean isEmpty()

Gets a value indicating whether the RectangleF.Width or RectangleF.Height property of this RectangleF has a value of zero.

Returns:

This property returns true if the RectangleF.Width or P:RectangleF.Height property of this RectangleF has a value of zero; otherwise, false.

getX

public final float getX()

Gets the x-coordinate of the upper-left corner of this RectangleF structure.

Returns:

the x-coordinate of the upper-left corner of this RectangleF structure.

setX

public final void setX(float value)

Sets the x-coordinate of the upper-left corner of this RectangleF structure.

Parameters:

value - the x-coordinate of the upper-left corner of this RectangleF structure.

getY

public final float getY()

Gets the x-coordinate of the upper-left corner of this RectangleF structure.

Returns:

the x-coordinate of the upper-left corner of this RectangleF structure.

setY

public final void setY(float value)

Sets the x-coordinate of the upper-left corner of this RectangleF structure.

Parameters:

value - the x-coordinate of the upper-left corner of this RectangleF structure.

getLocation

public final PointF getLocation()

Gets the coordinates of the upper-left corner of this RectangleF structure.

Returns:

A PointF that represents the upper-left corner of this RectangleF structure.

setLocation

public final void setLocation(PointF value)

Sets the coordinates of the upper-left corner of this RectangleF structure.

Parameters:

value - the coordinates of the upper-left corner of this RectangleF structure.

getWidth

public final float getWidth()

Gets the width of this RectangleF structure.

Returns:

the width of this RectangleF structure.

setWidth

public final void setWidth(float value)

Sets the width of this RectangleF structure.

Parameters:

value - the width of this RectangleF structure.

getHeight

public final float getHeight()

Gets the height of this RectangleF structure.

Returns:

the height of this RectangleF structure.

setHeight

public final void setHeight(float value)

Sets the height of this RectangleF structure.

Parameters:

value - the height of this RectangleF structure.

getSize

public final SizeF getSize()

Gets the size of this RectangleF.

Returns:

A SizeF that represents the width and height of this RectangleF structure.

setSize

public final void setSize(SizeF value)

Sets the size of this RectangleF.

Parameters:

value - the size of this RectangleF.

getLeft

public final float getLeft()

Gets the x-coordinate of the left edge of this RectangleF structure.

Returns:

the x-coordinate of the left edge of this RectangleF structure.

getTop

public final float getTop()

Gets the y-coordinate of the top edge of this RectangleF structure.

Returns:

the y-coordinate of the top edge of this RectangleF structure.

getRight

public final float getRight()

Gets the x-coordinate that is the sum of X and Width of this RectangleF structure.

Returns:

the x-coordinate that is the sum of X and Width of this RectangleF structure.

getBottom

public final float getBottom()

Gets the y-coordinate that is the sum of Y and Height of this RectangleF structure.

Returns:

the y-coordinate that is the sum of Y and Height of this RectangleF structure.

toString

public String toString()

Overrides:

toString in class Object

inflate

public final void inflate(float x,
                          float y)

Inflates this RectangleF structure by the specified amount.

Parameters:

x - The amount to inflate this RectangleF structure horizontally.

y - The amount to inflate this RectangleF structure vertically.

inflate

public final void inflate(SizeF size)

Inflates this RectangleF by the specified amount.

Parameters:

size - The amount to inflate this rectangle.

intersect

public final void intersect(RectangleF rect)

Replaces this RectangleF structure with the intersection of itself and the specified RectangleF structure.

Parameters:

rect - The rectangle to intersect.

intersectsWith

public final boolean intersectsWith(RectangleF rect)

Determines if this rectangle intersects with rect.

Parameters:

rect - The rectangle to test.

Returns:

This method returns true if there is any intersection.

offset

public final void offset(PointF pos)

Adjusts the location of this rectangle by the specified amount.

Parameters:

pos - The amount to offset the location.

offset

public final void offset(float x,
                         float y)

Adjusts the location of this rectangle by the specified amount.

Parameters:

x - The amount to offset the location horizontally.

y - The amount to offset the location vertically.

contains

public final boolean contains(float x,
                              float y)

Determines if the specified point is contained within this RectangleF structure.

Parameters:

x - he x-coordinate of the point to test.

y - The y-coordinate of the point to test.

Returns:

This method returns true if the point defined by x and y is contained within this RectangleF structure; otherwise false.

contains

public final boolean contains(PointF pt)

Determines if the specified point is contained within this RectangleF structure.

Parameters:

pt - The PointF to test.

Returns:

This method returns true if the point represented by the pt parameter is contained within this RectangleF structure; otherwise false.

contains

public final boolean contains(RectangleF rect)

Determines if the rectangular region represented by rect is entirely contained within this RectangleF structure.

Parameters:

rect - The RectangleF to test.

Returns:

This method returns true if the rectangular region represented by rect is entirely contained within the rectangular region represented by this RectangleF; otherwise false.

equals

public boolean equals(Object obj)

Determines whether the specified Object, is equal to this instance.

Specified by:

equals in interface com.aspose.ms.System.IEquatable<RectangleF>

Overrides:

equals in class Object

Parameters:

obj - The Object to compare with this instance.

Returns:

true if the specified Object is equal to this instance; otherwise, false.

hashCode

public int hashCode()

Returns a hash code for this instance.

Overrides:

hashCode in class Object

Returns:

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

equals

public final boolean equals(RectangleF other)

Tests whether other RectangleF structure has the same location and size of this RectangleF structure.

Parameters:

other - Other rectangle to test

Returns:

This method returns true if other RectangleF structure and its X, Y, Width, and Height properties are equal to the corresponding properties of this RectangleF structure; otherwise, false.

CloneTo

public void CloneTo(RectangleF that)

Specified by:

CloneTo in class com.aspose.ms.System.ValueType<RectangleF>

Clone

public RectangleF Clone()

Specified by:

Clone in class com.aspose.ms.System.ValueType<RectangleF>

clone

public Object clone()

Overrides:

clone in class Object