juce_RelativeCoordinate.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  RelativeCoordinate
{
public:
    //==============================================================================
    RelativeCoordinate();
    RelativeCoordinate (const Expression& expression);
    RelativeCoordinate (const RelativeCoordinate&);
    RelativeCoordinate& operator= (const RelativeCoordinate&);
    RelativeCoordinate (RelativeCoordinate&&) noexcept;
    RelativeCoordinate& operator= (RelativeCoordinate&&) noexcept;

    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 Expression& getExpression() const         { return term; }
 
 
    //==============================================================================
    String toString() const;
 
    //==============================================================================
    struct Strings
    {
        static const String parent;         
        static const String left;           
        static const String right;          
        static const String top;            
        static const String bottom;         
        static const String x;              
        static const String y;              
        static const String width;          
        static const String height;         
    };

    struct StandardStrings
    {
        enum Type
        {
            left, right, top, bottom,
            x, y, width, height,
            parent,
            unknown
        };
 
        static Type getTypeOf (const String& s) noexcept;
    };
 
private:
    //==============================================================================
    Expression term;
};
 
} // namespace juce