Member Function Documentation

RectF::RectF(const Qul::PlatformInterface::Rect &rectangle)

Constructs a RectF rectangle from the given Rect rectangle.

See also toRect().

RectF::RectF(float x, float y, float width, float height)

Constructs a rectangle with (x, y) as its top-left corner and the given width and height.

See also setRect().

RectF::RectF(const Qul::PlatformInterface::PointF &topLeft, const Qul::PlatformInterface::PointF &bottomRight)

Constructs a rectangle with the given topLeft and bottomRight corners.

See also setTopLeft() and setBottomRight().

RectF::RectF(const Qul::PlatformInterface::PointF &topLeft, const Qul::PlatformInterface::SizeF &size)

Constructs a rectangle with the given topLeft corner and the given size.

See also setTopLeft() and setSize().

RectF::RectF()

Constructs a null rectangle.

See also isNull().

void RectF::adjust(float dx1, float dy1, float dx2, float dy2)

Adds dx1, dy1, dx2 and dy2 respectively to the existing coordinates of the rectangle.

See also adjusted() and setRect().

Qul::PlatformInterface::RectF RectF::adjusted(float dx1, float dy1, float dx2, float dy2) const

Returns a new rectangle with dx1, dy1, dx2 and dy2 added respectively to the existing coordinates of this rectangle.

See also adjust().

float RectF::bottom() const

Returns the y-coordinate of the rectangle's bottom edge.

See also setBottom(), bottomLeft(), and bottomRight().

Qul::PlatformInterface::PointF RectF::bottomLeft() const

Returns the position of the rectangle's bottom-left corner.

See also setBottomLeft(), bottom(), and left().

Qul::PlatformInterface::PointF RectF::bottomRight() const

Returns the position of the rectangle's bottom-right corner.

See also setBottomRight(), bottom(), and right().

Qul::PlatformInterface::PointF RectF::center() const

Returns the center point of the rectangle.

See also moveCenter().

bool RectF::contains(const Qul::PlatformInterface::RectF &rectangle) const

This is an overloaded function.

Returns true if the given rectangle is inside this rectangle; otherwise returns false.

bool RectF::contains(const Qul::PlatformInterface::PointF &point) const

This is an overloaded function.

Returns true if the given point is inside or on the edge of the rectangle; otherwise returns false.

See also intersects().

bool RectF::contains(float x, float y) const

This is an overloaded function.

Returns true if the point (x, y) is inside or on the edge of the rectangle; otherwise returns false.

void RectF::getCoords(float *x1, float *y1, float *x2, float *y2) const

Extracts the position of the rectangle's top-left corner to *x1 and *y1, and the position of the bottom-right corner to *x2 and *y2.

See also setCoords() and getRect().

void RectF::getRect(float *x, float *y, float *width, float *height) const

Extracts the position of the rectangle's top-left corner to *x and *y, and its dimensions to *width and *height.

See also setRect() and getCoords().

float RectF::height() const

Returns the height of the rectangle.

See also setHeight(), width(), and size().

Qul::PlatformInterface::RectF RectF::intersected(const Qul::PlatformInterface::RectF &rectangle) const

Returns the intersection of this rectangle and the given rectangle. Note that r.intersected(s) is equivalent to r & s.

See also intersects(), united(), and operator&=().

bool RectF::intersects(const Qul::PlatformInterface::RectF &rectangle) const

Returns true if this rectangle intersects with the given rectangle (i.e. there is a non-empty area of overlap between them), otherwise returns false.

The intersection rectangle can be retrieved using the intersected() function.

See also contains().

bool RectF::isEmpty() const

Returns true if the rectangle is empty, otherwise returns false.

An empty rectangle has width() <= 0 or height() <= 0. An empty rectangle is not valid (i.e., isEmpty() == !isValid()).

Use the normalized() function to retrieve a rectangle where the corners are swapped.

See also isNull(), isValid(), and normalized().

bool RectF::isNull() const

Returns true if the rectangle is a null rectangle, otherwise returns false.

A null rectangle has both the width and the height set to 0. A null rectangle is also empty, and hence not valid.

See also isEmpty() and isValid().

bool RectF::isValid() const

Returns true if the rectangle is valid, otherwise returns false.

A valid rectangle has a width() > 0 and height() > 0. Note that non-trivial operations like intersections are not defined for invalid rectangles. A valid rectangle is not empty (i.e., isValid() == !isEmpty()).

See also isNull(), isEmpty(), and normalized().

float RectF::left() const

Returns the x-coordinate of the rectangle's left edge. Equivalent to x().

See also setLeft(), topLeft(), and bottomLeft().

void RectF::moveBottom(float y)

Moves the rectangle vertically, leaving the rectangle's bottom edge at the given y coordinate. The rectangle's size is unchanged.

See also bottom(), setBottom(), and moveTop().

void RectF::moveBottomLeft(const Qul::PlatformInterface::PointF &position)

Moves the rectangle, leaving the bottom-left corner at the given position. The rectangle's size is unchanged.

See also setBottomLeft(), moveBottom(), and moveLeft().

void RectF::moveBottomRight(const Qul::PlatformInterface::PointF &position)

Moves the rectangle, leaving the bottom-right corner at the given position. The rectangle's size is unchanged.

See also setBottomRight(), moveBottom(), and moveRight().

void RectF::moveCenter(const Qul::PlatformInterface::PointF &position)

Moves the rectangle, leaving the center point at the given position. The rectangle's size is unchanged.

See also center().

void RectF::moveLeft(float x)

Moves the rectangle horizontally, leaving the rectangle's left edge at the given x coordinate. The rectangle's size is unchanged.

See also left(), setLeft(), and moveRight().

void RectF::moveRight(float x)

Moves the rectangle horizontally, leaving the rectangle's right edge at the given x coordinate. The rectangle's size is unchanged.

See also right(), setRight(), and moveLeft().

void RectF::moveTo(float x, float y)

This is an overloaded function.

Moves the rectangle, leaving the top-left corner at the given position (x, y). The rectangle's size is unchanged.

See also translate() and moveTopLeft().

void RectF::moveTo(const Qul::PlatformInterface::PointF &position)

This is an overloaded function.

Moves the rectangle, leaving the top-left corner at the given position.

void RectF::moveTop(float y)

Moves the rectangle vertically, leaving the rectangle's top line at the given y coordinate. The rectangle's size is unchanged.

See also top(), setTop(), and moveBottom().

void RectF::moveTopLeft(const Qul::PlatformInterface::PointF &position)

Moves the rectangle, leaving the top-left corner at the given position. The rectangle's size is unchanged.

See also setTopLeft(), moveTop(), and moveLeft().

void RectF::moveTopRight(const Qul::PlatformInterface::PointF &position)

Moves the rectangle, leaving the top-right corner at the given position. The rectangle's size is unchanged.

See also setTopRight(), moveTop(), and moveRight().

Qul::PlatformInterface::RectF RectF::normalized() const

Returns a normalized rectangle; i.e., a rectangle that has a non-negative width and height.

If width() < 0 the function swaps the left and right corners, and it swaps the top and bottom corners if height() < 0.

See also isValid() and isEmpty().

float RectF::right() const

Returns the x-coordinate of the rectangle's right edge.

See also setRight(), topRight(), and bottomRight().

void RectF::setBottom(float y)

Sets the bottom edge of the rectangle to the given y coordinate. May change the height, but will never change the top edge of the rectangle.

See also bottom() and moveBottom().

void RectF::setBottomLeft(const Qul::PlatformInterface::PointF &position)

Set the bottom-left corner of the rectangle to the given position. May change the size, but will never change the top-right corner of the rectangle.

See also bottomLeft() and moveBottomLeft().

void RectF::setBottomRight(const Qul::PlatformInterface::PointF &position)

Set the bottom-right corner of the rectangle to the given position. May change the size, but will never change the top-left corner of the rectangle.

See also bottomRight() and moveBottomRight().

void RectF::setCoords(float x1, float y1, float x2, float y2)

Sets the coordinates of the rectangle's top-left corner to (x1, y1), and the coordinates of its bottom-right corner to (x2, y2).

See also getCoords() and setRect().

void RectF::setHeight(float height)

Sets the height of the rectangle to the given height. The bottom edge is changed, but not the top one.

See also height() and setSize().

void RectF::setLeft(float x)

Sets the left edge of the rectangle to the given x coordinate. May change the width, but will never change the right edge of the rectangle.

Equivalent to setX().

See also left() and moveLeft().

void RectF::setRect(float x, float y, float width, float height)

Sets the coordinates of the rectangle's top-left corner to (x, y), and its size to the given width and height.

See also getRect() and setCoords().

void RectF::setRight(float x)

Sets the right edge of the rectangle to the given x coordinate. May change the width, but will never change the left edge of the rectangle.

See also right() and moveRight().

void RectF::setSize(const Qul::PlatformInterface::SizeF &size)

Sets the size of the rectangle to the given size. The top-left corner is not moved.

See also size(), setWidth(), and setHeight().

void RectF::setTop(float y)

Sets the top edge of the rectangle to the given y coordinate. May change the height, but will never change the bottom edge of the rectangle.

Equivalent to setY().

See also top() and moveTop().

void RectF::setTopLeft(const Qul::PlatformInterface::PointF &position)

Set the top-left corner of the rectangle to the given position. May change the size, but will never change the bottom-right corner of the rectangle.

See also topLeft() and moveTopLeft().

void RectF::setTopRight(const Qul::PlatformInterface::PointF &position)

Set the top-right corner of the rectangle to the given position. May change the size, but will never change the bottom-left corner of the rectangle.

See also topRight() and moveTopRight().

void RectF::setWidth(float width)

Sets the width of the rectangle to the given width. The right edge is changed, but not the left one.

See also width() and setSize().

void RectF::setX(float x)

Sets the left edge of the rectangle to the given x coordinate. May change the width, but will never change the right edge of the rectangle.

Equivalent to setLeft().

See also x(), setY(), and setTopLeft().

void RectF::setY(float y)

Sets the top edge of the rectangle to the given y coordinate. May change the height, but will never change the bottom edge of the rectangle.

Equivalent to setTop().

See also y(), setX(), and setTopLeft().

Qul::PlatformInterface::SizeF RectF::size() const

Returns the size of the rectangle.

See also setSize(), width(), and height().

Qul::PlatformInterface::Rect RectF::toAlignedRect() const

Returns a Rect based on the values of this rectangle that is the smallest possible integer rectangle that completely contains this rectangle.

See also toRect().

Qul::PlatformInterface::Rect RectF::toRect() const

Returns a Rect based on the values of this rectangle. Note that the coordinates in the returned rectangle are rounded to the nearest integer.

See also RectF() and toAlignedRect().

float RectF::top() const

Returns the y-coordinate of the rectangle's top edge. Equivalent to y().

See also setTop(), topLeft(), and topRight().

Qul::PlatformInterface::PointF RectF::topLeft() const

Returns the position of the rectangle's top-left corner.

See also setTopLeft(), top(), and left().

Qul::PlatformInterface::PointF RectF::topRight() const

Returns the position of the rectangle's top-right corner.

See also setTopRight(), top(), and right().

void RectF::translate(float dx, float dy)

This is an overloaded function.

Moves the rectangle dx along the x-axis and dy along the y-axis, relative to the current position. Positive values move the rectangle to the right and downwards.

See also moveTopLeft(), moveTo(), and translated().

void RectF::translate(const Qul::PlatformInterface::PointF &offset)

This is an overloaded function.

Moves the rectangle offset.x() along the x axis and offset.y() along the y axis, relative to the current position.

Qul::PlatformInterface::RectF RectF::translated(float dx, float dy) const

This is an overloaded function.

Returns a copy of the rectangle that is translated dx along the x axis and dy along the y axis, relative to the current position. Positive values move the rectangle to the right and down.

See also translate().

Qul::PlatformInterface::RectF RectF::translated(const Qul::PlatformInterface::PointF &offset) const

This is an overloaded function.

Returns a copy of the rectangle that is translated offset.x() along the x axis and offset.y() along the y axis, relative to the current position.

Qul::PlatformInterface::RectF RectF::transposed() const

Returns a copy of the rectangle that has its width and height exchanged.

See also SizeF::transposed().

Qul::PlatformInterface::RectF RectF::united(const Qul::PlatformInterface::RectF &rectangle) const

Returns the bounding rectangle of this rectangle and the given rectangle.

See also intersected().

float RectF::width() const

Returns the width of the rectangle.

See also setWidth(), height(), and size().

float RectF::x() const

Returns the x-coordinate of the rectangle's left edge. Equivalent to left().

See also setX(), y(), and topLeft().

float RectF::y() const

Returns the y-coordinate of the rectangle's top edge. Equivalent to top().

See also setY(), x(), and topLeft().

Qul::PlatformInterface::RectF RectF::operator&(const Qul::PlatformInterface::RectF &rectangle) const

Returns the intersection of this rectangle and the given rectangle. Returns an empty rectangle if there is no intersection.

See also operator&=() and intersected().

Qul::PlatformInterface::RectF &RectF::operator&=(const Qul::PlatformInterface::RectF &rectangle)

Intersects this rectangle with the given rectangle.

See also intersected() and operator|=().

Qul::PlatformInterface::RectF RectF::operator|(const Qul::PlatformInterface::RectF &rectangle) const

Returns the bounding rectangle of this rectangle and the given rectangle.

See also united() and operator|=().

Qul::PlatformInterface::RectF &RectF::operator|=(const Qul::PlatformInterface::RectF &rectangle)

Unites this rectangle with the given rectangle.

See also united() and operator|().