|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.aspose.imaging.Rectangle
public class Rectangle
Stores a set of four integers that represent the location and size of a rectangle.
Constructor Summary | |
---|---|
Rectangle()
|
|
Rectangle(int x,
int y,
int width,
int height)
Initializes a new instance of the Rectangle structure with the specified location and size. |
|
Rectangle(Point location,
Size size)
Initializes a new instance of the Rectangle structure with the specified location and size. |
Method Summary | |
---|---|
static Rectangle |
ceiling(RectangleF value)
Converts the specified RectangleF structure to a Rectangle structure by rounding the RectangleF values to the next higher integer values. |
java.lang.Object |
clone()
|
Rectangle |
Clone()
|
void |
CloneTo(Rectangle that)
|
boolean |
contains(int x,
int y)
Determines if the specified point is contained within this Rectangle structure. |
boolean |
contains(Point point)
Determines if the specified point is contained within this Rectangle structure. |
boolean |
contains(Rectangle rect)
Determines if the rectangular region represented by rect is entirely contained within this Rectangle structure. |
boolean |
equals(java.lang.Object obj)
Tests whether obj is a Rectangle structure with the same location and size of this Rectangle structure. |
static boolean |
equals(Rectangle obj1,
Rectangle obj2)
|
static Rectangle |
fromLeftTopRightBottom(int left,
int top,
int right,
int bottom)
Creates a Rectangle structure with the specified edge locations. |
static Rectangle |
fromPoints(Point point1,
Point point2)
Creates a new Rectangle froms two points specified. |
int |
getBottom()
Gets the y-coordinate that is the sum of the Rectangle.Y and Rectangle.Height property values of this Rectangle structure. |
static Rectangle |
getEmpty()
Gets a new instance of the Rectangle structure that has Rectangle.X , Rectangle.Y , Rectangle.Width and Rectangle.Height values set to zero. |
int |
getHeight()
Gets the height of this Rectangle structure. |
int |
getLeft()
Gets the x-coordinate of the left edge of this Rectangle structure. |
Point |
getLocation()
Gets the coordinates of the upper-left corner of this Rectangle structure. |
int |
getRight()
Gets the x-coordinate that is the sum of Rectangle.X and Rectangle.Width property values of this Rectangle structure. |
Size |
getSize()
Gets the size of this Rectangle . |
int |
getTop()
Gets the y-coordinate of the top edge of this Rectangle structure. |
int |
getWidth()
Gets the width of this Rectangle structure. |
int |
getX()
Gets the x-coordinate of the upper-left corner of this Rectangle structure. |
int |
getY()
Gets the y-coordinate of the upper-left corner of this Rectangle structure. |
int |
hashCode()
Returns the hash code for this Rectangle structure. |
void |
inflate(int width,
int height)
Inflates this Rectangle by the specified amount. |
static Rectangle |
inflate(Rectangle rect,
int x,
int y)
Creates and returns an inflated copy of the specified Rectangle structure. |
void |
inflate(Size size)
Inflates this Rectangle by the specified amount. |
void |
intersect(Rectangle rect)
Replaces this Rectangle with the intersection of itself and the specified Rectangle . |
static Rectangle |
intersect(Rectangle a,
Rectangle b)
Returns a third Rectangle structure that represents the intersection of two other Rectangle structures. |
boolean |
intersectsWith(Rectangle rect)
Determines if this rectangle intersects with rect . |
boolean |
isEmpty()
Gets a value indicating whether all numeric properties of this Rectangle have values of zero. |
void |
normalize()
Normalizes the rectangle by making it's width and height positive, left less than right and top less than bottom. |
void |
offset(int x,
int y)
Adjusts the location of this rectangle by the specified amount. |
void |
offset(Point pos)
Adjusts the location of this rectangle by the specified amount. |
static boolean |
op_Equality(Rectangle left,
Rectangle right)
Tests whether two Rectangle structures have equal location and size. |
static boolean |
op_Inequality(Rectangle left,
Rectangle right)
Tests whether two Rectangle structures differ in location or size. |
static Rectangle |
round(RectangleF value)
Converts the specified RectangleF to a Rectangle by rounding the RectangleF values to the nearest integer values. |
void |
setBottom(int value)
Sets the y-coordinate that is the sum of the Rectangle.Y and Rectangle.Height property values of this Rectangle structure. |
void |
setHeight(int value)
Sets the height of this Rectangle structure. |
void |
setLeft(int value)
Sets the x-coordinate of the left edge of this Rectangle structure. |
void |
setLocation(Point value)
Sets the coordinates of the upper-left corner of this Rectangle structure. |
void |
setRight(int value)
Sets the x-coordinate that is the sum of Rectangle.X and Rectangle.Width property values of this Rectangle structure. |
void |
setSize(Size value)
Sets the size of this Rectangle . |
void |
setTop(int value)
Sets the y-coordinate of the top edge of this Rectangle structure. |
void |
setWidth(int value)
Sets the width of this Rectangle structure. |
void |
setX(int value)
Sets the x-coordinate of the upper-left corner of this Rectangle structure. |
void |
setY(int value)
Sets the y-coordinate of the upper-left corner of this Rectangle structure. |
java.lang.String |
toString()
Converts the attributes of this Rectangle to a human-readable string. |
static Rectangle |
truncate(RectangleF value)
Converts the specified RectangleF to a Rectangle by truncating the RectangleF values. |
static Rectangle |
union(Rectangle a,
Rectangle b)
Gets a Rectangle structure that contains the union of two Rectangle structures. |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Rectangle()
public Rectangle(int x, int y, int width, int height)
Initializes a new instance of the Rectangle
structure with the specified location and size.
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.public Rectangle(Point location, Size size)
Initializes a new instance of the Rectangle
structure with the specified location and size.
location
- A Point
that represents the upper-left corner of the rectangular region.size
- A Size
that represents the width and height of the rectangular region.Method Detail |
---|
public static Rectangle ceiling(RectangleF value)
Converts the specified RectangleF
structure to a Rectangle
structure by rounding the RectangleF
values to the next higher integer values.
value
- The RectangleF
structure to be converted.
Rectangle
.public java.lang.Object clone()
public Rectangle Clone()
public void CloneTo(Rectangle that)
public boolean contains(int x, int y)
Determines if the specified point is contained within this Rectangle
structure.
x
- The x-coordinate of the point to test.y
- The y-coordinate of the point to test.
x
and y
is contained within this Rectangle
structure; otherwise false.public boolean contains(Point point)
Determines if the specified point is contained within this Rectangle
structure.
point
- The Point
to test.
point
is contained within this Rectangle
structure; otherwise false.public boolean contains(Rectangle rect)
Determines if the rectangular region represented by rect
is entirely contained within this Rectangle
structure.
rect
- The Rectangle
to test.
rect
is entirely contained within this Rectangle
structure; otherwise false.public boolean equals(java.lang.Object obj)
Tests whether obj
is a Rectangle
structure with the same location and size of this Rectangle
structure.
obj
- The System.Object
to test.
obj
is a Rectangle
structure and its Rectangle.X
, Rectangle.Y
, Rectangle.Width
, and Rectangle.Height
properties are equal to the corresponding properties of this Rectangle
structure; otherwise, false.public static boolean equals(Rectangle obj1, Rectangle obj2)
public static Rectangle fromLeftTopRightBottom(int left, int top, int right, int bottom)
Creates a Rectangle
structure with the specified edge locations.
left
- The x-coordinate of the upper-left corner of this Rectangle
structure.top
- The y-coordinate of the upper-left corner of this Rectangle
structure.right
- The x-coordinate of the lower-right corner of this Rectangle
structure.bottom
- The y-coordinate of the lower-right corner of this Rectangle
structure.
Rectangle
that this method creates.public static Rectangle fromPoints(Point point1, Point point2)
Creates a new Rectangle
froms two points specified. Two verticles of the created Rectangle
will be equal to the passed point1
and point2
. These would be typically the opposite vertices.
point1
- The first Point
for the new rectangle.point2
- The second Point
for the new rectangle.
Rectangle
.public int getBottom()
Gets the y-coordinate that is the sum of the Rectangle.Y
and Rectangle.Height
property values of this Rectangle
structure.
Rectangle.Y
and Rectangle.Height
of this Rectangle
.
public static Rectangle getEmpty()
Gets a new instance of the Rectangle
structure that has Rectangle.X
, Rectangle.Y
, Rectangle.Width
and Rectangle.Height
values set to zero.
public int getHeight()
Gets the height of this Rectangle
structure.
Rectangle
structure.public int getLeft()
Gets the x-coordinate of the left edge of this Rectangle
structure.
Rectangle
structure.
public Point getLocation()
Gets the coordinates of the upper-left corner of this Rectangle
structure.
Point
that represents the upper-left corner of this Rectangle
structure.
public int getRight()
Gets the x-coordinate that is the sum of Rectangle.X
and Rectangle.Width
property values of this Rectangle
structure.
Rectangle.X
and Rectangle.Width
of this Rectangle
.
public Size getSize()
Gets the size of this Rectangle
.
Size
that represents the width and height of this Rectangle
structure.
public int getTop()
Gets the y-coordinate of the top edge of this Rectangle
structure.
Rectangle
structure.
public int getWidth()
Gets the width of this Rectangle
structure.
Rectangle
structure.public int getX()
Gets the x-coordinate of the upper-left corner of this Rectangle
structure.
Rectangle
structure.
public int getY()
Gets the y-coordinate of the upper-left corner of this Rectangle
structure.
Rectangle
structure.
public int hashCode()
Returns the hash code for this Rectangle
structure.
public void inflate(int width, int height)
Inflates this Rectangle
by the specified amount.
width
- The amount to inflate this Rectangle
horizontally.height
- The amount to inflate this Rectangle
vertically.public static Rectangle inflate(Rectangle rect, int x, int y)
Creates and returns an inflated copy of the specified Rectangle
structure. The copy is inflated by the specified amount. The original Rectangle
structure remains unmodified.
rect
- The Rectangle
with which to start. This rectangle is not modified.x
- The amount to inflate this Rectangle
horizontally.y
- The amount to inflate this Rectangle
vertically.
Rectangle
.public void inflate(Size size)
Inflates this Rectangle
by the specified amount.
size
- The amount to inflate this rectangle.public void intersect(Rectangle rect)
Replaces this Rectangle
with the intersection of itself and the specified Rectangle
.
rect
- The Rectangle
with which to intersect.public static Rectangle intersect(Rectangle a, Rectangle b)
Returns a third Rectangle
structure that represents the intersection of two other Rectangle
structures. If there is no intersection, an empty Rectangle
is returned.
a
- A first rectangle to intersect.b
- A second rectangle to intersect.
Rectangle
that represents the intersection of a
and b
.public boolean intersectsWith(Rectangle rect)
Determines if this rectangle intersects with rect
.
rect
- The rectangle to test.
public boolean isEmpty()
Gets a value indicating whether all numeric properties of this Rectangle
have values of zero.
Rectangle.Width
, Rectangle.Height
, Rectangle.X
, and Rectangle.Y
properties of this Rectangle
all have values of zero; otherwise, false.
public void normalize()
Normalizes the rectangle by making it's width and height positive, left less than right and top less than bottom.
public void offset(int x, int y)
Adjusts the location of this rectangle by the specified amount.
x
- The horizontal offset.y
- The vertical offset.public void offset(Point pos)
Adjusts the location of this rectangle by the specified amount.
pos
- Amount to offset the location.public static boolean op_Equality(Rectangle left, Rectangle right)
Tests whether two Rectangle
structures have equal location and size.
left
- The Rectangle
structure that is to the left of the equality operator.right
- The Rectangle
structure that is to the right of the equality operator.
Rectangle
structures have equal Rectangle.X
, Rectangle.Y
, Rectangle.Width
, and Rectangle.Height
properties.public static boolean op_Inequality(Rectangle left, Rectangle right)
Tests whether two Rectangle
structures differ in location or size.
left
- The Rectangle
structure that is to the left of the inequality operator.right
- The Rectangle
structure that is to the right of the inequality operator.
Rectangle.X
, Rectangle.Y
, Rectangle.Width
or Rectangle.Height
properties of the two Rectangle
structures are unequal; otherwise false.public static Rectangle round(RectangleF value)
Converts the specified RectangleF
to a Rectangle
by rounding the RectangleF
values to the nearest integer values.
value
- The RectangleF
to be converted.
Rectangle
.public void setBottom(int value)
Sets the y-coordinate that is the sum of the Rectangle.Y
and Rectangle.Height
property values of this Rectangle
structure.
Rectangle.Y
and Rectangle.Height
of this Rectangle
.
public void setHeight(int value)
Sets the height of this Rectangle
structure.
public void setLeft(int value)
Sets the x-coordinate of the left edge of this Rectangle
structure.
Rectangle
structure.
public void setLocation(Point value)
Sets the coordinates of the upper-left corner of this Rectangle
structure.
Point
that represents the upper-left corner of this Rectangle
structure.
public void setRight(int value)
Sets the x-coordinate that is the sum of Rectangle.X
and Rectangle.Width
property values of this Rectangle
structure.
Rectangle.X
and Rectangle.Width
of this Rectangle
.
public void setSize(Size value)
Sets the size of this Rectangle
.
Size
that represents the width and height of this Rectangle
structure.
public void setTop(int value)
Sets the y-coordinate of the top edge of this Rectangle
structure.
Rectangle
structure.
public void setWidth(int value)
Sets the width of this Rectangle
structure.
public void setX(int value)
Sets the x-coordinate of the upper-left corner of this Rectangle
structure.
Rectangle
structure.
public void setY(int value)
Sets the y-coordinate of the upper-left corner of this Rectangle
structure.
Rectangle
structure.
public java.lang.String toString()
Converts the attributes of this Rectangle
to a human-readable string.
Rectangle
structure.public static Rectangle truncate(RectangleF value)
Converts the specified RectangleF
to a Rectangle
by truncating the RectangleF
values.
value
- The RectangleF
to be converted.
Rectangle
.public static Rectangle union(Rectangle a, Rectangle b)
Gets a Rectangle
structure that contains the union of two Rectangle
structures.
a
- A first rectangle to union.b
- A second rectangle to union.
Rectangle
structure that bounds the union of the two Rectangle
structures.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |