Packages

 

com.aspose.imaging

Interfaces

Classes

Exceptions

com.aspose.imaging

Class RectangleF



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

    Stores a set of four floating-point numbers that represent the location and size of a rectangle.

    • Constructor Summary

      Constructors 
      Constructor and Description
      RectangleF() 
      RectangleF(float x, float y, float width, float height)
      Initializes a new instance of the com.aspose.imaging.RectangleF structure with the specified location and size.
      RectangleF(PointF location, SizeF size)
      Initializes a new instance of the com.aspose.imaging.RectangleF structure with the specified location and size.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      RectangleF Clone() 
      void CloneTo(RectangleF that) 
      boolean contains(float x, float y)
      Determines if the specified point is contained within this com.aspose.imaging.RectangleF structure.
      boolean contains(PointF point)
      Determines if the specified point is contained within this com.aspose.imaging.RectangleF structure.
      boolean contains(RectangleF rect)
      Determines if the rectangular region represented by rect is entirely contained within this com.aspose.imaging.RectangleF structure.
      boolean equals(Object obj)
      Tests whether obj is a com.aspose.imaging.RectangleF with the same location and size of this com.aspose.imaging.RectangleF.
      static RectangleF fromLeftTopRightBottom(float left, float top, float right, float bottom)
      Creates a com.aspose.imaging.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 specified.
      float getBottom()
      Gets or sets the y-coordinate that is the sum of com.aspose.imaging.RectangleF.Y and com.aspose.imaging.RectangleF.Height of this com.aspose.imaging.RectangleF structure.
      static RectangleF getEmpty()
      Gets a new instance of the com.aspose.imaging.RectangleF structure that has com.aspose.imaging.RectangleF.X, com.aspose.imaging.RectangleF.Y, com.aspose.imaging.RectangleF.Width and com.aspose.imaging.RectangleF.Height values set to zero.
      float getHeight()
      Gets or sets the height of this com.aspose.imaging.RectangleF structure.
      float getLeft()
      Gets or sets the x-coordinate of the left edge of this com.aspose.imaging.RectangleF structure.
      PointF getLocation()
      Gets or sets the coordinates of the upper-left corner of this com.aspose.imaging.RectangleF structure.
      float getRight()
      Gets or sets the x-coordinate that is the sum of com.aspose.imaging.RectangleF.X and com.aspose.imaging.RectangleF.Width of this com.aspose.imaging.RectangleF structure.
      SizeF getSize()
      Gets or sets the size of this com.aspose.imaging.RectangleF.
      float getTop()
      Gets or sets the y-coordinate of the top edge of this com.aspose.imaging.RectangleF structure.
      float getWidth()
      Gets or sets the width of this com.aspose.imaging.RectangleF structure.
      float getX()
      Gets or sets the x-coordinate of the upper-left corner of this com.aspose.imaging.RectangleF structure.
      float getY()
      Gets or sets the y-coordinate of the upper-left corner of this com.aspose.imaging.RectangleF structure.
      int hashCode()
      Gets the hash code for this com.aspose.imaging.RectangleF structure.
      void inflate(float x, float y)
      Inflates this com.aspose.imaging.RectangleF structure by the specified amount.
      static RectangleF inflate(RectangleF rect, float x, float y)
      Creates and returns an inflated copy of the specified com.aspose.imaging.RectangleF structure.
      void inflate(SizeF size)
      Inflates this com.aspose.imaging.RectangleF by the specified amount.
      void intersect(RectangleF rect)
      Replaces this com.aspose.imaging.RectangleF structure with the intersection of itself and the specified com.aspose.imaging.RectangleF structure.
      static RectangleF intersect(RectangleF a, RectangleF b)
      Returns a com.aspose.imaging.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 com.aspose.imaging.RectangleF.Width or com.aspose.imaging.RectangleF.Height property of this com.aspose.imaging.RectangleF has a value of zero.
      static boolean isEquals(RectangleF obj1, RectangleF 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(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 RectangleF op_Division(RectangleF rectangle, float divider)
      Implements the operator /.
      static boolean op_Equality(RectangleF left, RectangleF right)
      Tests whether two com.aspose.imaging.RectangleF structures have equal location and size.
      static boolean op_Inequality(RectangleF left, RectangleF right)
      Tests whether two com.aspose.imaging.RectangleF structures differ in location or size.
      static RectangleF op_Multiply(RectangleF rectangle, float multiplier)
      Implements the operator *.
      void setBottom(float value)
      Gets or sets the y-coordinate that is the sum of com.aspose.imaging.RectangleF.Y and com.aspose.imaging.RectangleF.Height of this com.aspose.imaging.RectangleF structure.
      void setHeight(float value)
      Gets or sets the height of this com.aspose.imaging.RectangleF structure.
      void setLeft(float value)
      Gets or sets the x-coordinate of the left edge of this com.aspose.imaging.RectangleF structure.
      void setLocation(PointF value)
      Gets or sets the coordinates of the upper-left corner of this com.aspose.imaging.RectangleF structure.
      void setRight(float value)
      Gets or sets the x-coordinate that is the sum of com.aspose.imaging.RectangleF.X and com.aspose.imaging.RectangleF.Width of this com.aspose.imaging.RectangleF structure.
      void setSize(SizeF value)
      Gets or sets the size of this com.aspose.imaging.RectangleF.
      void setTop(float value)
      Gets or sets the y-coordinate of the top edge of this com.aspose.imaging.RectangleF structure.
      void setWidth(float value)
      Gets or sets the width of this com.aspose.imaging.RectangleF structure.
      void setX(float value)
      Gets or sets the x-coordinate of the upper-left corner of this com.aspose.imaging.RectangleF structure.
      void setY(float value)
      Gets or sets the y-coordinate of the upper-left corner of this com.aspose.imaging.RectangleF structure.
      static RectangleF to_RectangleF(Rectangle rect)
      Converts the specified com.aspose.imaging.Rectangle structure to a com.aspose.imaging.RectangleF structure.
      String toString()
      Converts the attributes of this com.aspose.imaging.RectangleF to a human-readable string.
      static RectangleF union(RectangleF a, RectangleF b)
      Creates the smallest possible third rectangle that can contain both of two rectangles that form a union.
    • Constructor Detail

      • RectangleF

        public RectangleF()
      • RectangleF

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

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

        public RectangleF(PointF location,
                          SizeF size)

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

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

      • getEmpty

        public static RectangleF getEmpty()

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

      • getLocation

        public PointF getLocation()

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

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

        public void setLocation(PointF value)

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

      • getSize

        public SizeF getSize()

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

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

        public void setSize(SizeF value)

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

      • getX

        public float getX()

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

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

        public void setX(float value)

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

      • getY

        public float getY()

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

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

        public void setY(float value)

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

      • getWidth

        public float getWidth()

        Gets or sets the width of this com.aspose.imaging.RectangleF structure.

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

        public void setWidth(float value)

        Gets or sets the width of this com.aspose.imaging.RectangleF structure.

      • getHeight

        public float getHeight()

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

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

        public void setHeight(float value)

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

      • getLeft

        public float getLeft()

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

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

        public void setLeft(float value)

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

      • getTop

        public float getTop()

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

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

        public void setTop(float value)

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

      • getRight

        public float getRight()

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

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

        public void setRight(float value)

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

      • getBottom

        public float getBottom()

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

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

        public void setBottom(float value)

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

      • isEmpty

        public boolean isEmpty()

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

        Returns:
        This property returns true if the com.aspose.imaging.RectangleF.Width or com.aspose.imaging.RectangleF.Height property of this com.aspose.imaging.RectangleF has a value of zero; otherwise, false.
      • fromPoints

        public static RectangleF fromPoints(PointF point1,
                                            PointF point2)

        Creates a new Rectangle from 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.

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

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

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

        Parameters:
        rect - The com.aspose.imaging.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 com.aspose.imaging.RectangleF.
      • intersect

        public static RectangleF intersect(RectangleF a,
                                           RectangleF b)

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

        Parameters:
        a - A first rectangle to intersect.
        b - A second rectangle to intersect.
        Returns:
        A third com.aspose.imaging.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 - A first rectangle to union.
        b - A second rectangle to union.
        Returns:
        A third com.aspose.imaging.RectangleF structure that contains both of the two rectangles that form the union.
      • op_Equality

        public static boolean op_Equality(RectangleF left,
                                          RectangleF right)

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

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

        public static boolean op_Inequality(RectangleF left,
                                            RectangleF right)

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

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

        public static RectangleF op_Multiply(RectangleF rectangle,
                                             float multiplier)

        Implements the operator *.

        Parameters:
        rectangle - The rectangle.
        multiplier - The multiplier.
        Returns:
        The result of the operator.
      • op_Division

        public static RectangleF op_Division(RectangleF rectangle,
                                             float divider)

        Implements the operator /.

        Parameters:
        rectangle - The rectangle.
        divider - The divider.
        Returns:
        The result of the operator.
        Throws:
        com.aspose.ms.System.ArgumentOutOfRangeException - divider - Division by zero is not allowed.
      • to_RectangleF

        public static RectangleF to_RectangleF(Rectangle rect)

        Converts the specified com.aspose.imaging.Rectangle structure to a com.aspose.imaging.RectangleF structure.

        Parameters:
        rect - The com.aspose.imaging.Rectangle structure to convert.
        Returns:
        The com.aspose.imaging.RectangleF structure that is converted from the specified com.aspose.imaging.Rectangle structure.
      • fromLeftTopRightBottom

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

        Creates a com.aspose.imaging.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 com.aspose.imaging.RectangleF that this method creates.
      • normalize

        public void normalize()

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

      • contains

        public boolean contains(float x,
                                float y)

        Determines if the specified point is contained within this com.aspose.imaging.RectangleF 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.RectangleF structure; otherwise false.
      • contains

        public boolean contains(PointF point)

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

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

        public boolean contains(RectangleF rect)

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

        Parameters:
        rect - The com.aspose.imaging.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 com.aspose.imaging.RectangleF; otherwise false.
      • inflate

        public void inflate(float x,
                            float y)

        Inflates this com.aspose.imaging.RectangleF structure by the specified amount.

        Parameters:
        x - The amount to inflate this com.aspose.imaging.RectangleF structure horizontally.
        y - The amount to inflate this com.aspose.imaging.RectangleF structure vertically.
      • inflate

        public void inflate(SizeF size)

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

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

        public void intersect(RectangleF rect)

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

        Parameters:
        rect - The rectangle to intersect.
      • intersectsWith

        public 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 void offset(PointF pos)

        Adjusts the location of this rectangle by the specified amount.

        Parameters:
        pos - The amount to offset the location.
      • offset

        public 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.
      • equals

        public boolean equals(Object obj)

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

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

        public int hashCode()

        Gets the hash code for this com.aspose.imaging.RectangleF structure.

        Overrides:
        hashCode in class Object
        Returns:
        The hash code for this com.aspose.imaging.RectangleF.
      • toString

        public String toString()

        Converts the attributes of this com.aspose.imaging.RectangleF 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.RectangleF structure.
      • 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>