Packages

 

com.aspose.imaging

Interfaces

Classes

com.aspose.imaging

Class Rectangle



  • public class Rectangle
    extends com.aspose.ms.lang.Struct<Rectangle>

    Stores a set of four integers that represent the location and size of a rectangle.

    • Constructor Summary

      Constructors 
      Constructor and Description
      Rectangle() 
      Rectangle(int x, int y, int width, int height)
      Initializes a new instance of the com.aspose.imaging.Rectangle structure with the specified location and size.
      Rectangle(Point location, Size size)
      Initializes a new instance of the com.aspose.imaging.Rectangle structure with the specified location and size.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      static Rectangle ceiling(RectangleF value)
      Converts the specified com.aspose.imaging.RectangleF structure to a com.aspose.imaging.Rectangle structure by rounding the com.aspose.imaging.RectangleF values to the next higher integer values.
      Rectangle Clone() 
      void CloneTo(Rectangle that) 
      boolean contains(int x, int y)
      Determines if the specified point is contained within this com.aspose.imaging.Rectangle structure.
      boolean contains(Point point)
      Determines if the specified point is contained within this com.aspose.imaging.Rectangle structure.
      boolean contains(Rectangle rect)
      Determines if the rectangular region represented by rect is entirely contained within this com.aspose.imaging.Rectangle structure.
      boolean equals(Object obj)
      Tests whether obj is a com.aspose.imaging.Rectangle structure with the same location and size of this com.aspose.imaging.Rectangle structure.
      static Rectangle fromLeftTopRightBottom(int left, int top, int right, int bottom)
      Creates a com.aspose.imaging.Rectangle structure with the specified edge locations.
      static Rectangle fromPoints(Point point1, Point point2)
      Creates a new Rectangle from two points specified.
      int getBottom()
      Gets or sets the y-coordinate that is the sum of the com.aspose.imaging.Rectangle.Y and com.aspose.imaging.Rectangle.Height property values of this com.aspose.imaging.Rectangle structure.
      static Rectangle getEmpty()
      Gets a new instance of the com.aspose.imaging.Rectangle structure that has com.aspose.imaging.Rectangle.X, com.aspose.imaging.Rectangle.Y, com.aspose.imaging.Rectangle.Width and com.aspose.imaging.Rectangle.Height values set to zero.
      int getHeight()
      Gets or sets the height of this com.aspose.imaging.Rectangle structure.
      int getLeft()
      Gets or sets the x-coordinate of the left edge of this com.aspose.imaging.Rectangle structure.
      Point getLocation()
      Gets or sets the coordinates of the upper-left corner of this com.aspose.imaging.Rectangle structure.
      int getRight()
      Gets or sets the x-coordinate that is the sum of com.aspose.imaging.Rectangle.X and com.aspose.imaging.Rectangle.Width property values of this com.aspose.imaging.Rectangle structure.
      Size getSize()
      Gets or sets the size of this com.aspose.imaging.Rectangle.
      int getTop()
      Gets or sets the y-coordinate of the top edge of this com.aspose.imaging.Rectangle structure.
      int getWidth()
      Gets the width of this com.aspose.imaging.Rectangle structure.
      int getX()
      Gets or sets the x-coordinate of the upper-left corner of this com.aspose.imaging.Rectangle structure.
      int getY()
      Gets or sets the y-coordinate of the upper-left corner of this com.aspose.imaging.Rectangle structure.
      int hashCode()
      Returns the hash code for this com.aspose.imaging.Rectangle structure.
      void inflate(int width, int height)
      Inflates this com.aspose.imaging.Rectangle by the specified amount.
      static Rectangle inflate(Rectangle rect, int x, int y)
      Creates and returns an inflated copy of the specified com.aspose.imaging.Rectangle structure.
      void inflate(Size size)
      Inflates this com.aspose.imaging.Rectangle by the specified amount.
      void intersect(Rectangle rect)
      Replaces this com.aspose.imaging.Rectangle with the intersection of itself and the specified com.aspose.imaging.Rectangle.
      static Rectangle intersect(Rectangle a, Rectangle b)
      Returns a third com.aspose.imaging.Rectangle structure that represents the intersection of two other com.aspose.imaging.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 com.aspose.imaging.Rectangle have values of zero.
      static boolean isEquals(Rectangle obj1, Rectangle obj2) 
      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 com.aspose.imaging.Rectangle structures have equal location and size.
      static boolean op_Inequality(Rectangle left, Rectangle right)
      Tests whether two com.aspose.imaging.Rectangle structures differ in location or size.
      static Rectangle round(RectangleF value)
      Converts the specified com.aspose.imaging.RectangleF to a com.aspose.imaging.Rectangle by rounding the com.aspose.imaging.RectangleF values to the nearest integer values.
      void setBottom(int value)
      Gets or sets the y-coordinate that is the sum of the com.aspose.imaging.Rectangle.Y and com.aspose.imaging.Rectangle.Height property values of this com.aspose.imaging.Rectangle structure.
      void setHeight(int value)
      Gets or sets the height of this com.aspose.imaging.Rectangle structure.
      void setLeft(int value)
      Gets or sets the x-coordinate of the left edge of this com.aspose.imaging.Rectangle structure.
      void setLocation(Point value)
      Gets or sets the coordinates of the upper-left corner of this com.aspose.imaging.Rectangle structure.
      void setRight(int value)
      Gets or sets the x-coordinate that is the sum of com.aspose.imaging.Rectangle.X and com.aspose.imaging.Rectangle.Width property values of this com.aspose.imaging.Rectangle structure.
      void setSize(Size value)
      Gets or sets the size of this com.aspose.imaging.Rectangle.
      void setTop(int value)
      Gets or sets the y-coordinate of the top edge of this com.aspose.imaging.Rectangle structure.
      void setWidth(int value)
      Sets the width of this com.aspose.imaging.Rectangle structure.
      void setX(int value)
      Gets or sets the x-coordinate of the upper-left corner of this com.aspose.imaging.Rectangle structure.
      void setY(int value)
      Gets or sets the y-coordinate of the upper-left corner of this com.aspose.imaging.Rectangle structure.
      String toString()
      Converts the attributes of this com.aspose.imaging.Rectangle to a human-readable string.
      static Rectangle truncate(RectangleF value)
      Converts the specified com.aspose.imaging.RectangleF to a com.aspose.imaging.Rectangle by truncating the com.aspose.imaging.RectangleF values.
      static Rectangle union(Rectangle a, Rectangle b)
      Gets a com.aspose.imaging.Rectangle structure that contains the union of two com.aspose.imaging.Rectangle structures.
    • Constructor Detail

      • Rectangle

        public Rectangle()
      • Rectangle

        public Rectangle(int x,
                         int y,
                         int width,
                         int height)

        Initializes a new instance of the com.aspose.imaging.Rectangle 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.
      • Rectangle

        public Rectangle(Point location,
                         Size size)

        Initializes a new instance of the com.aspose.imaging.Rectangle structure with the specified location and size.

        Parameters:
        location - A com.aspose.imaging.Point that represents the upper-left corner of the rectangular region.
        size - A com.aspose.imaging.Size that represents the width and height of the rectangular region.
    • Method Detail

      • getEmpty

        public static Rectangle getEmpty()

        Gets a new instance of the com.aspose.imaging.Rectangle structure that has com.aspose.imaging.Rectangle.X, com.aspose.imaging.Rectangle.Y, com.aspose.imaging.Rectangle.Width and com.aspose.imaging.Rectangle.Height values set to zero.

      • getLocation

        public Point getLocation()

        Gets or sets the coordinates of the upper-left corner of this com.aspose.imaging.Rectangle structure.

        Returns:
        A com.aspose.imaging.Point that represents the upper-left corner of this com.aspose.imaging.Rectangle structure.
      • setLocation

        public void setLocation(Point value)

        Gets or sets the coordinates of the upper-left corner of this com.aspose.imaging.Rectangle structure.

        Parameters:
        value - A Point that represents the upper-left corner of this com.aspose.imaging.Rectangle structure.
      • getSize

        public Size getSize()

        Gets or sets the size of this com.aspose.imaging.Rectangle.

        Returns:
        A com.aspose.imaging.Size that represents the width and height of this com.aspose.imaging.Rectangle structure.
      • setSize

        public void setSize(Size value)

        Gets or sets the size of this com.aspose.imaging.Rectangle.

        Parameters:
        value - A com.aspose.imaging.Size that represents the width and height of this com.aspose.imaging.Rectangle structure.
      • getX

        public int getX()

        Gets or sets the x-coordinate of the upper-left corner of this com.aspose.imaging.Rectangle structure.

        Returns:
        The x-coordinate of the upper-left corner of this com.aspose.imaging.Rectangle structure.
      • setX

        public void setX(int value)

        Gets or sets the x-coordinate of the upper-left corner of this com.aspose.imaging.Rectangle structure.

        Parameters:
        value - The x-coordinate of the upper-left corner of this com.aspose.imaging.Rectangle structure.
      • getY

        public int getY()

        Gets or sets the y-coordinate of the upper-left corner of this com.aspose.imaging.Rectangle structure.

        Returns:
        The y-coordinate of the upper-left corner of this com.aspose.imaging.Rectangle structure.
      • setY

        public void setY(int value)

        Gets or sets the y-coordinate of the upper-left corner of this com.aspose.imaging.Rectangle structure.

        Parameters:
        value - The y-coordinate of the upper-left corner of this com.aspose.imaging.Rectangle structure.
      • getWidth

        public int getWidth()

        Gets the width of this com.aspose.imaging.Rectangle structure.

        Returns:
        The width of this com.aspose.imaging.Rectangle structure.
      • setWidth

        public void setWidth(int value)

        Sets the width of this com.aspose.imaging.Rectangle structure.

        Parameters:
        value - The width of this com.aspose.imaging.Rectangle structure.
      • getHeight

        public int getHeight()

        Gets or sets the height of this com.aspose.imaging.Rectangle structure.

        Returns:
        The height of this com.aspose.imaging.Rectangle structure.
      • setHeight

        public void setHeight(int value)

        Gets or sets the height of this com.aspose.imaging.Rectangle structure.

        Parameters:
        value - The height of this com.aspose.imaging.Rectangle structure.
      • getLeft

        public int getLeft()

        Gets or sets the x-coordinate of the left edge of this com.aspose.imaging.Rectangle structure.

        Returns:
        The x-coordinate of the left edge of this com.aspose.imaging.Rectangle structure.
      • setLeft

        public void setLeft(int value)

        Gets or sets the x-coordinate of the left edge of this com.aspose.imaging.Rectangle structure.

        Parameters:
        value - The x-coordinate of the left edge of this com.aspose.imaging.Rectangle structure.
      • getTop

        public int getTop()

        Gets or sets the y-coordinate of the top edge of this com.aspose.imaging.Rectangle structure.

        Returns:
        The y-coordinate of the top edge of this com.aspose.imaging.Rectangle structure.
      • setTop

        public void setTop(int value)

        Gets or sets the y-coordinate of the top edge of this com.aspose.imaging.Rectangle structure.

        Parameters:
        value - The y-coordinate of the top edge of this com.aspose.imaging.Rectangle structure.
      • getRight

        public int getRight()

        Gets or sets the x-coordinate that is the sum of com.aspose.imaging.Rectangle.X and com.aspose.imaging.Rectangle.Width property values of this com.aspose.imaging.Rectangle structure.

        Returns:
        The x-coordinate that is the sum of com.aspose.imaging.Rectangle.X and com.aspose.imaging.Rectangle.Width of this com.aspose.imaging.Rectangle.
      • setRight

        public void setRight(int value)

        Gets or sets the x-coordinate that is the sum of com.aspose.imaging.Rectangle.X and com.aspose.imaging.Rectangle.Width property values of this com.aspose.imaging.Rectangle structure.

        Parameters:
        value - The x-coordinate that is the sum of com.aspose.imaging.Rectangle.X and com.aspose.imaging.Rectangle.Width of this com.aspose.imaging.Rectangle.
      • getBottom

        public int getBottom()

        Gets or sets the y-coordinate that is the sum of the com.aspose.imaging.Rectangle.Y and com.aspose.imaging.Rectangle.Height property values of this com.aspose.imaging.Rectangle structure.

        Returns:
        The y-coordinate that is the sum of com.aspose.imaging.Rectangle.Y and com.aspose.imaging.Rectangle.Height of this com.aspose.imaging.Rectangle.
      • setBottom

        public void setBottom(int value)

        Gets or sets the y-coordinate that is the sum of the com.aspose.imaging.Rectangle.Y and com.aspose.imaging.Rectangle.Height property values of this com.aspose.imaging.Rectangle structure.

        Parameters:
        value - The y-coordinate that is the sum of com.aspose.imaging.Rectangle.Y and com.aspose.imaging.Rectangle.Height of this com.aspose.imaging.Rectangle.
      • isEmpty

        public boolean isEmpty()

        Gets a value indicating whether all numeric properties of this com.aspose.imaging.Rectangle have values of zero.

        Returns:
        This property returns true if the com.aspose.imaging.Rectangle.Width, com.aspose.imaging.Rectangle.Height, com.aspose.imaging.Rectangle.X, and com.aspose.imaging.Rectangle.Y properties of this com.aspose.imaging.Rectangle all have values of zero; otherwise, false.
      • fromPoints

        public static Rectangle fromPoints(Point point1,
                                           Point point2)

        Creates a new Rectangle from two points specified. Two verticales of the created Rectangle will be equal to the passed point1 and point2. These would be typically the opposite vertices.

        Parameters:
        point1 - The first Point for the new rectangle.
        point2 - The second Point for the new rectangle.
        Returns:
        A newly created Rectangle.
      • ceiling

        public static Rectangle ceiling(RectangleF value)

        Converts the specified com.aspose.imaging.RectangleF structure to a com.aspose.imaging.Rectangle structure by rounding the com.aspose.imaging.RectangleF values to the next higher integer values.

        Parameters:
        value - The com.aspose.imaging.RectangleF structure to be converted.
        Returns:
        Returns a com.aspose.imaging.Rectangle.
      • truncate

        public static Rectangle truncate(RectangleF value)

        Converts the specified com.aspose.imaging.RectangleF to a com.aspose.imaging.Rectangle by truncating the com.aspose.imaging.RectangleF values.

        Parameters:
        value - The com.aspose.imaging.RectangleF to be converted.
        Returns:
        A new com.aspose.imaging.Rectangle.
      • round

        public static Rectangle round(RectangleF value)

        Converts the specified com.aspose.imaging.RectangleF to a com.aspose.imaging.Rectangle by rounding the com.aspose.imaging.RectangleF values to the nearest integer values.

        Parameters:
        value - The com.aspose.imaging.RectangleF to be converted.
        Returns:
        A new com.aspose.imaging.Rectangle.
      • inflate

        public static Rectangle inflate(Rectangle rect,
                                        int x,
                                        int y)

        Creates and returns an inflated copy of the specified com.aspose.imaging.Rectangle structure. The copy is inflated by the specified amount. The original com.aspose.imaging.Rectangle structure remains unmodified.

        Parameters:
        rect - The com.aspose.imaging.Rectangle with which to start. This rectangle is not modified.
        x - The amount to inflate this com.aspose.imaging.Rectangle horizontally.
        y - The amount to inflate this com.aspose.imaging.Rectangle vertically.
        Returns:
        The inflated com.aspose.imaging.Rectangle.
      • intersect

        public static Rectangle intersect(Rectangle a,
                                          Rectangle b)

        Returns a third com.aspose.imaging.Rectangle structure that represents the intersection of two other com.aspose.imaging.Rectangle structures. If there is no intersection, an empty com.aspose.imaging.Rectangle is returned.

        Parameters:
        a - A first rectangle to intersect.
        b - A second rectangle to intersect.
        Returns:
        A com.aspose.imaging.Rectangle that represents the intersection of a and b.
      • union

        public static Rectangle union(Rectangle a,
                                      Rectangle b)

        Gets a com.aspose.imaging.Rectangle structure that contains the union of two com.aspose.imaging.Rectangle structures.

        Parameters:
        a - A first rectangle to union.
        b - A second rectangle to union.
        Returns:
        A com.aspose.imaging.Rectangle structure that bounds the union of the two com.aspose.imaging.Rectangle structures.
      • op_Equality

        public static boolean op_Equality(Rectangle left,
                                          Rectangle right)

        Tests whether two com.aspose.imaging.Rectangle structures have equal location and size.

        Parameters:
        left - The com.aspose.imaging.Rectangle structure that is to the left of the equality operator.
        right - The com.aspose.imaging.Rectangle structure that is to the right of the equality operator.
        Returns:
        This operator returns true if the two com.aspose.imaging.Rectangle structures have equal com.aspose.imaging.Rectangle.X, com.aspose.imaging.Rectangle.Y, com.aspose.imaging.Rectangle.Width, and com.aspose.imaging.Rectangle.Height properties.
      • op_Inequality

        public static boolean op_Inequality(Rectangle left,
                                            Rectangle right)

        Tests whether two com.aspose.imaging.Rectangle structures differ in location or size.

        Parameters:
        left - The com.aspose.imaging.Rectangle structure that is to the left of the inequality operator.
        right - The com.aspose.imaging.Rectangle structure that is to the right of the inequality operator.
        Returns:
        This operator returns true if any of the com.aspose.imaging.Rectangle.X, com.aspose.imaging.Rectangle.Y, com.aspose.imaging.Rectangle.Width or com.aspose.imaging.Rectangle.Height properties of the two com.aspose.imaging.Rectangle structures are unequal; otherwise false.
      • fromLeftTopRightBottom

        public static Rectangle fromLeftTopRightBottom(int left,
                                                       int top,
                                                       int right,
                                                       int bottom)

        Creates a com.aspose.imaging.Rectangle structure with the specified edge locations.

        Parameters:
        left - The x-coordinate of the upper-left corner of this com.aspose.imaging.Rectangle structure.
        top - The y-coordinate of the upper-left corner of this com.aspose.imaging.Rectangle structure.
        right - The x-coordinate of the lower-right corner of this com.aspose.imaging.Rectangle structure.
        bottom - The y-coordinate of the lower-right corner of this com.aspose.imaging.Rectangle structure.
        Returns:
        The new com.aspose.imaging.Rectangle that this method creates.
      • contains

        public boolean contains(int x,
                                int y)

        Determines if the specified point is contained within this com.aspose.imaging.Rectangle structure.

        Parameters:
        x - The 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 com.aspose.imaging.Rectangle structure; otherwise false.
      • contains

        public boolean contains(Point point)

        Determines if the specified point is contained within this com.aspose.imaging.Rectangle structure.

        Parameters:
        point - The com.aspose.imaging.Point to test.
        Returns:
        This method returns true if the point represented by point is contained within this com.aspose.imaging.Rectangle structure; otherwise false.
      • contains

        public boolean contains(Rectangle rect)

        Determines if the rectangular region represented by rect is entirely contained within this com.aspose.imaging.Rectangle structure.

        Parameters:
        rect - The com.aspose.imaging.Rectangle to test.
        Returns:
        This method returns true if the rectangular region represented by rect is entirely contained within this com.aspose.imaging.Rectangle structure; otherwise false.
      • inflate

        public void inflate(int width,
                            int height)

        Inflates this com.aspose.imaging.Rectangle by the specified amount.

        Parameters:
        width - The amount to inflate this com.aspose.imaging.Rectangle horizontally.
        height - The amount to inflate this com.aspose.imaging.Rectangle vertically.
      • inflate

        public void inflate(Size size)

        Inflates this com.aspose.imaging.Rectangle by the specified amount.

        Parameters:
        size - The amount to inflate this rectangle.
      • intersect

        public void intersect(Rectangle rect)

        Replaces this com.aspose.imaging.Rectangle with the intersection of itself and the specified com.aspose.imaging.Rectangle.

        Parameters:
        rect - The com.aspose.imaging.Rectangle with which to intersect.
      • intersectsWith

        public boolean intersectsWith(Rectangle rect)

        Determines if this rectangle intersects with rect.

        Parameters:
        rect - The rectangle to test.
        Returns:
        This method returns true if there is any intersection, otherwise false.
      • offset

        public void offset(Point pos)

        Adjusts the location of this rectangle by the specified amount.

        Parameters:
        pos - Amount to offset the location.
      • offset

        public void offset(int x,
                           int y)

        Adjusts the location of this rectangle by the specified amount.

        Parameters:
        x - The horizontal offset.
        y - The vertical offset.
      • normalize

        public void normalize()

        Normalizes the rectangle by making it's width and height positive, left less than right and top less than bottom.

      • equals

        public boolean equals(Object obj)

        Tests whether obj is a com.aspose.imaging.Rectangle structure with the same location and size of this com.aspose.imaging.Rectangle structure.

        Overrides:
        equals in class Object
        Parameters:
        obj - The System.Object to test.
        Returns:
        This method returns true if obj is a com.aspose.imaging.Rectangle structure and its com.aspose.imaging.Rectangle.X, com.aspose.imaging.Rectangle.Y, com.aspose.imaging.Rectangle.Width, and com.aspose.imaging.Rectangle.Height properties are equal to the corresponding properties of this com.aspose.imaging.Rectangle structure; otherwise, false.
      • hashCode

        public int hashCode()

        Returns the hash code for this com.aspose.imaging.Rectangle structure.

        Overrides:
        hashCode in class Object
        Returns:
        An integer that represents the hash code for this rectangle.
      • toString

        public String toString()

        Converts the attributes of this com.aspose.imaging.Rectangle to a human-readable string.

        Overrides:
        toString in class Object
        Returns:
        A string that contains the position, width, and height of this com.aspose.imaging.Rectangle structure.
      • CloneTo

        public void CloneTo(Rectangle that)
        Specified by:
        CloneTo in class com.aspose.ms.System.ValueType<Rectangle>
      • Clone

        public Rectangle Clone()
        Specified by:
        Clone in class com.aspose.ms.System.ValueType<Rectangle>