|
JUCE
|
|
JUCE
|
An rectangle stored as a set of RelativeCoordinate values. More...
Public Member Functions | |
| RelativeRectangle () | |
| Creates a zero-size rectangle at the origin. | |
| RelativeRectangle (const Rectangle< float > &rect) | |
| Creates an absolute rectangle, relative to the origin. | |
| RelativeRectangle (const RelativeCoordinate &left, const RelativeCoordinate &right, const RelativeCoordinate &top, const RelativeCoordinate &bottom) | |
| Creates a rectangle from four coordinates. | |
| RelativeRectangle (const String &stringVersion) | |
| Creates a rectangle from a stringified representation. | |
| bool | operator== (const RelativeRectangle &other) const noexcept |
| bool | operator!= (const RelativeRectangle &other) const noexcept |
| const Rectangle< float > | resolve (const Expression::Scope *scope) const |
| Calculates the absolute position of this rectangle. | |
| void | moveToAbsolute (const Rectangle< float > &newPos, const Expression::Scope *scope) |
| Changes the values of this rectangle's coordinates to make it resolve to the specified position. | |
| bool | isDynamic () const |
| Returns true if this rectangle depends on any external symbols for its position. | |
| String | toString () const |
| Returns a string which represents this point. | |
| void | renameSymbol (const Expression::Symbol &oldSymbol, const String &newName, const Expression::Scope &scope) |
| Renames a symbol if it is used by any of the coordinates. | |
| void | applyToComponent (Component &component) const |
| Creates and sets an appropriate Component::Positioner object for the given component, which will keep it positioned with this rectangle. | |
Public Attributes | |
| RelativeCoordinate | left |
| RelativeCoordinate | right |
| RelativeCoordinate | top |
| RelativeCoordinate | bottom |
An rectangle stored as a set of RelativeCoordinate values.
The rectangle's top, left, bottom and right edge positions are each stored as a RelativeCoordinate.
Creates a zero-size rectangle at the origin.
| RelativeRectangle::RelativeRectangle | ( | const Rectangle< float > & | rect | ) | [explicit] |
Creates an absolute rectangle, relative to the origin.
| RelativeRectangle::RelativeRectangle | ( | const RelativeCoordinate & | left, |
| const RelativeCoordinate & | right, | ||
| const RelativeCoordinate & | top, | ||
| const RelativeCoordinate & | bottom | ||
| ) |
Creates a rectangle from four coordinates.
| RelativeRectangle::RelativeRectangle | ( | const String & | stringVersion | ) | [explicit] |
Creates a rectangle from a stringified representation.
The string must contain a sequence of 4 coordinates, separated by commas, in the order left, top, right, bottom. The syntax for the coordinate strings is explained in the RelativeCoordinate class.
| bool RelativeRectangle::operator== | ( | const RelativeRectangle & | other | ) | const |
| bool RelativeRectangle::operator!= | ( | const RelativeRectangle & | other | ) | const |
| const Rectangle<float> RelativeRectangle::resolve | ( | const Expression::Scope * | scope | ) | const |
Calculates the absolute position of this rectangle.
You'll need to provide a suitable Expression::Scope for looking up any coordinates that may be needed to calculate the result.
| void RelativeRectangle::moveToAbsolute | ( | const Rectangle< float > & | newPos, |
| const Expression::Scope * | scope | ||
| ) |
Changes the values of this rectangle's coordinates to make it resolve to the specified position.
Calling this will leave any anchor points unchanged, but will set any absolute or relative positions to whatever values are necessary to make the resultant position match the position that is provided.
| bool RelativeRectangle::isDynamic | ( | ) | const |
Returns true if this rectangle depends on any external symbols for its position.
Coordinates that refer to symbols based on "this" are assumed not to be dynamic.
| String RelativeRectangle::toString | ( | ) | const |
Returns a string which represents this point.
This returns a comma-separated list of coordinates, in the order left, top, right, bottom. For details of the string syntax used by the coordinates, see the RelativeCoordinate constructor notes. The string that is returned can be passed to the RelativeRectangle constructor to recreate the rectangle.
| void RelativeRectangle::renameSymbol | ( | const Expression::Symbol & | oldSymbol, |
| const String & | newName, | ||
| const Expression::Scope & | scope | ||
| ) |
Renames a symbol if it is used by any of the coordinates.
This calls Expression::withRenamedSymbol() on the rectangle's coordinates.
| void RelativeRectangle::applyToComponent | ( | Component & | component | ) | const |
Creates and sets an appropriate Component::Positioner object for the given component, which will keep it positioned with this rectangle.
