KeyFrame.h

Go to the documentation of this file.

 
// Copyright (c) 2008-2019 OpenShot Studios, LLC
//
// SPDX-License-Identifier: LGPL-3.0-or-later
 
#ifndef OPENSHOT_KEYFRAME_H
#define OPENSHOT_KEYFRAME_H
 
#include <iostream>
#include <vector>
 
#include "Point.h"
#include "Json.h"
 
namespace openshot {
 
    bool IsPointBeforeX(Point const & p, double const x);
 
    double InterpolateLinearCurve(Point const & left, Point const & right, double const target);
 
    double InterpolateBezierCurve(Point const & left, Point const & right, double const target, double const allowed_error);
 
    double InterpolateBetween(Point const & left, Point const & right, double target, double allowed_error);
 
    class Keyframe {
    
 
    private:
        std::vector<Point> Points;  
 
    public:
        Keyframe() = default;
 
        Keyframe(double value);
 
        Keyframe(const std::vector<openshot::Point>& points);
 
        ~Keyframe();
 
        void AddPoint(Point p);
 
        void AddPoint(double x, double y, InterpolationType interpolate=BEZIER);
 
        bool Contains(Point p) const;
 
        void FlipPoints();
 
        int64_t FindIndex(Point p) const;
 
        double GetValue(int64_t index) const;
 
        int GetInt(int64_t index) const;
 
        int64_t GetLong(int64_t index) const;
 
        double GetDelta(int64_t index) const;
 
        Point const & GetPoint(int64_t index) const;
 
        Point GetClosestPoint(Point p) const;
 
        Point GetClosestPoint(Point p, bool useLeft) const;
 
        Point GetPreviousPoint(Point p) const;
 
        Point GetMaxPoint() const;
 
        // Get the number of values (i.e. coordinates on the X axis)
        int64_t GetLength() const;
 
        int64_t GetCount() const;
 
        bool IsIncreasing(int index) const;
 
        // Get and Set JSON methods
        std::string Json() const; 
        Json::Value JsonValue() const; 
        void SetJson(const std::string value); 
        void SetJsonValue(const Json::Value root); 
 
        void RemovePoint(Point p);
 
        void RemovePoint(int64_t index);
 
        void ScalePoints(double scale);
 
        void UpdatePoint(int64_t index, Point p);
 
        void PrintPoints(std::ostream* out=&std::cout) const;
 
        void PrintValues(std::ostream* out=&std::cout) const;
 
    };
 
}
 
#endif