Loading...
Searching...
No Matches
Point.cpp
Go to the documentation of this file.
// Copyright (c) 2008-2019 OpenShot Studios, LLC
//
// SPDX-License-Identifier: LGPL-3.0-or-later
#include "Point.h"
#include "Exceptions.h"
using namespace std;
using namespace openshot;
// Default constructor
Point::Point() : Point::Point(Coordinate(1, 0), BEZIER, AUTO) {}
// Constructor which creates a single coordinate at X=1
Point::Point(float y) : Point::Point(Coordinate(1, y), CONSTANT, AUTO) {}
// Constructor which creates a Bezier curve with point at (x, y)
Point::Point(float x, float y) : Point::Point(Coordinate(x, y), BEZIER, AUTO) {}
// Constructor which also creates a Point, setting X,Y, and interpolation.
Point::Point(float x, float y, InterpolationType interpolation)
: Point::Point(Coordinate(x, y), interpolation, AUTO) {}
// Direct Coordinate-accepting constructors
Point::Point(const Coordinate& co) : Point::Point(co, BEZIER, AUTO) {}
Point::Point(const Coordinate& co, InterpolationType interpolation)
: Point::Point(co, interpolation, AUTO) {}
Point::Point(const Coordinate& co, InterpolationType interpolation, HandleType handle_type) :
co(co), interpolation(interpolation), handle_type(handle_type) {
// set handles
Initialize_Handles();
}
void Point::Initialize_Handles() {
// initialize left and right handles (in percentages from 0 to 1)
// default to a smooth curve
Initialize_LeftHandle(0.5, 1.0);
Initialize_RightHandle(0.5, 0.0);
}
void Point::Initialize_LeftHandle(float x, float y) {
// initialize left handle (in percentages from 0 to 1)
handle_left = Coordinate(x, y);
}
void Point::Initialize_RightHandle(float x, float y) {
// initialize right handle (in percentages from 0 to 1)
handle_right = Coordinate(x, y);
}
// Generate JSON string of this object
std::string Point::Json() const {
// Return formatted string
return JsonValue().toStyledString();
}
// Generate Json::Value for this object
Json::Value Point::JsonValue() const {
// Create root json object
Json::Value root;
root["co"] = co.JsonValue();
if (interpolation == BEZIER) {
root["handle_left"] = handle_left.JsonValue();
root["handle_right"] = handle_right.JsonValue();
root["handle_type"] = handle_type;
}
root["interpolation"] = interpolation;
// return JsonValue
return root;
}
// Load JSON string into this object
void Point::SetJson(const std::string value) {
// Parse JSON string into JSON objects
try
{
const Json::Value root = openshot::stringToJson(value);
// Set all values that match
SetJsonValue(root);
}
catch (const std::exception& e)
{
// Error parsing JSON (or missing keys)
throw InvalidJSON("JSON is invalid (missing keys or invalid data types)");
}
}
// Load Json::Value into this object
void Point::SetJsonValue(const Json::Value root) {
if (!root["co"].isNull())
co.SetJsonValue(root["co"]); // update coordinate
if (!root["handle_left"].isNull())
handle_left.SetJsonValue(root["handle_left"]); // update coordinate
if (!root["handle_right"].isNull())
handle_right.SetJsonValue(root["handle_right"]); // update coordinate
if (!root["interpolation"].isNull())
interpolation = (InterpolationType) root["interpolation"].asInt();
if (!root["handle_type"].isNull())
handle_type = (HandleType) root["handle_type"].asInt();
}
Exceptions.h
Header file for all Exception classes.
Point.h
Header file for Point class.
openshot::Coordinate
A Cartesian coordinate (X, Y) used in the Keyframe animation system.
Definition Coordinate.h:38
openshot::InvalidJSON
Exception for invalid JSON.
Definition Exceptions.h:218
openshot::Point::handle_left
Coordinate handle_left
This is the left handle coordinate (in percentages from 0 to 1).
Definition Point.h:67
openshot::Point::SetJson
void SetJson(const std::string value)
Load JSON string into this object.
Definition Point.cpp:87
openshot::Point::JsonValue
Json::Value JsonValue() const
Generate Json::Value for this object.
Definition Point.cpp:70
openshot::Point::Initialize_RightHandle
void Initialize_RightHandle(float x, float y)
Set the right handle to a percent of the primary coordinate (0 to 1).
Definition Point.cpp:57
openshot::Point::Initialize_LeftHandle
void Initialize_LeftHandle(float x, float y)
Set the left handle to a percent of the primary coordinate (0 to 1).
Definition Point.cpp:52
openshot::Point::Initialize_Handles
void Initialize_Handles()
Definition Point.cpp:45
openshot::Point::handle_type
HandleType handle_type
This is the handle mode.
Definition Point.h:70
openshot::Point::co
Coordinate co
This is the primary coordinate.
Definition Point.h:66
openshot::Point::interpolation
InterpolationType interpolation
This is the interpolation mode.
Definition Point.h:69
openshot::Point::handle_right
Coordinate handle_right
This is the right handle coordinate (in percentages from 0 to 1).
Definition Point.h:68
openshot::Point::Point
Point()
Default constructor (defaults to 1,0).
Definition Point.cpp:20
openshot::Point::SetJsonValue
void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
Definition Point.cpp:104
openshot::Point::Json
std::string Json() const
Generate JSON string of this object.
Definition Point.cpp:63
openshot
This namespace is the default namespace for all code in the openshot library.
Definition Compressor.h:29
openshot::HandleType
HandleType
When BEZIER interpolation is used, the point's left and right handles are used to influence the direc...
Definition Point.h:41
openshot::AUTO
@ AUTO
Automatically adjust the handles to achieve the smoothest curve.
Definition Point.h:42
openshot::stringToJson
const Json::Value stringToJson(const std::string value)
Definition Json.cpp:16
openshot::InterpolationType
InterpolationType
This controls how a Keyframe uses this point to interpolate between two points.
Definition Point.h:28
openshot::CONSTANT
@ CONSTANT
Constant curves jump from their previous position to a new one (with no interpolation).
Definition Point.h:31
openshot::BEZIER
@ BEZIER
Bezier curves are quadratic curves, which create a smooth curve.
Definition Point.h:29