openshot-audio  0.1.7
Classes | Public Member Functions | List of all members
juce::RelativeCoordinate Class Reference

#include <juce_gui_basics.h>

Classes

struct  StandardStrings
 
struct  Strings
 

Public Member Functions

 RelativeCoordinate ()
 
 RelativeCoordinate (const Expression &expression)
 
 RelativeCoordinate (const RelativeCoordinate &)
 
RelativeCoordinateoperator= (const RelativeCoordinate &)
 
 RelativeCoordinate (double absoluteDistanceFromOrigin)
 
 RelativeCoordinate (const String &stringVersion)
 
 ~RelativeCoordinate ()
 
bool operator== (const RelativeCoordinate &) const noexcept
 
bool operator!= (const RelativeCoordinate &) const noexcept
 
double resolve (const Expression::Scope *evaluationScope) const
 
bool references (const String &coordName, const Expression::Scope *evaluationScope) const
 
bool isRecursive (const Expression::Scope *evaluationScope) const
 
bool isDynamic () const
 
void moveToAbsolute (double absoluteTargetPosition, const Expression::Scope *evaluationScope)
 
const ExpressiongetExpression () const
 
String toString () const
 

Detailed Description

Expresses a coordinate as a dynamically evaluated expression.

When using relative coordinates to position components, the following symbols are available:

See the Expression class for details about the operators that are supported, but for example if you wanted to make your component remains centred within its parent with a size of 100, 100, you could express it as:

myComp.setBounds (RelativeBounds ("parent.width / 2 - 50, parent.height / 2 - 50, left + 100, top + 100"));

..or an alternative way to achieve the same thing:

myComp.setBounds (RelativeBounds ("right - 100, bottom - 100, parent.width / 2 + 50, parent.height / 2 + 50"));

Or if you wanted a 100x100 component whose top edge is lined up to a marker called "topMarker" and which is positioned 50 pixels to the right of another component called "otherComp", you could write:

myComp.setBounds (RelativeBounds ("otherComp.right + 50, topMarker, left + 100, top + 100"));

Be careful not to make your coordinate expressions recursive, though, or exceptions and assertions will be thrown!

See also
RelativePoint, RelativeRectangle

Constructor & Destructor Documentation

◆ RelativeCoordinate() [1/5]

RelativeCoordinate::RelativeCoordinate ( )

Creates a zero coordinate.

◆ RelativeCoordinate() [2/5]

RelativeCoordinate::RelativeCoordinate ( const Expression expression)

◆ RelativeCoordinate() [3/5]

RelativeCoordinate::RelativeCoordinate ( const RelativeCoordinate other)

◆ RelativeCoordinate() [4/5]

RelativeCoordinate::RelativeCoordinate ( double  absoluteDistanceFromOrigin)

Creates an absolute position from the parent origin on either the X or Y axis.

Parameters
absoluteDistanceFromOriginthe distance from the origin

◆ RelativeCoordinate() [5/5]

RelativeCoordinate::RelativeCoordinate ( const String stringVersion)

Recreates a coordinate from a string description. The string will be parsed by ExpressionParser::parse().

Parameters
stringVersionthe expression to use
See also
toString

◆ ~RelativeCoordinate()

RelativeCoordinate::~RelativeCoordinate ( )

Destructor.

Member Function Documentation

◆ getExpression()

const Expression& juce::RelativeCoordinate::getExpression ( ) const
inline

Returns the expression that defines this coordinate.

◆ isDynamic()

bool RelativeCoordinate::isDynamic ( ) const

Returns true if this coordinate depends on any other coordinates for its position.

◆ isRecursive()

bool RelativeCoordinate::isRecursive ( const Expression::Scope evaluationScope) const

Returns true if there's a recursive loop when trying to resolve this coordinate's position.

◆ moveToAbsolute()

void RelativeCoordinate::moveToAbsolute ( double  absoluteTargetPosition,
const Expression::Scope evaluationScope 
)

Changes the value of this coord to make it resolve to the specified position.

Calling this will leave the anchor points unchanged, but will set this coordinate's absolute or relative position to whatever value is necessary to make its resultant position match the position that is provided.

◆ operator!=()

bool RelativeCoordinate::operator!= ( const RelativeCoordinate other) const
noexcept

◆ operator=()

RelativeCoordinate & RelativeCoordinate::operator= ( const RelativeCoordinate other)

◆ operator==()

bool RelativeCoordinate::operator== ( const RelativeCoordinate other) const
noexcept

◆ references()

bool juce::RelativeCoordinate::references ( const String coordName,
const Expression::Scope evaluationScope 
) const

Returns true if this coordinate uses the specified coord name at any level in its evaluation. This will recursively check any coordinates upon which this one depends.

◆ resolve()

double RelativeCoordinate::resolve ( const Expression::Scope evaluationScope) const

Calculates the absolute position of this coordinate.

You'll need to provide a suitable Expression::Scope for looking up any coordinates that may be needed to calculate the result.

◆ toString()

String RelativeCoordinate::toString ( ) const

Returns a string which represents this coordinate. For details of the string syntax, see the constructor notes.


The documentation for this class was generated from the following files: