OpenShot Library | libopenshot
0.2.4
|
A Point is the basic building block of a key-frame curve. More...
#include <Point.h>
Public Member Functions | |
void | Initialize_Handles () |
void | Initialize_LeftHandle (float x, float y) |
Set the left handle to a percent of the primary coordinate (0 to 1) More... | |
void | Initialize_RightHandle (float x, float y) |
Set the right handle to a percent of the primary coordinate (0 to 1) More... | |
std::string | Json () |
Get and Set JSON methods. More... | |
Json::Value | JsonValue () |
Generate Json::JsonValue for this object. More... | |
Point () | |
Default constructor (defaults to 1,0) More... | |
Point (float y) | |
Constructor which creates a single coordinate at X=1. More... | |
Point (float x, float y) | |
Constructor which also creates a Point and sets the X and Y of the Point. More... | |
Point (float x, float y, InterpolationType interpolation) | |
Constructor which also creates a Point and sets the X,Y, and interpolation of the Point. More... | |
Point (Coordinate co) | |
Constructor which takes a coordinate. More... | |
Point (Coordinate co, InterpolationType interpolation) | |
Constructor which takes a coordinate and interpolation mode. More... | |
Point (Coordinate co, InterpolationType interpolation, HandleType handle_type) | |
Constructor which takes a coordinate, interpolation mode, and handle type. More... | |
void | SetJson (std::string value) |
Load JSON string into this object. More... | |
void | SetJsonValue (Json::Value root) |
Load Json::JsonValue into this object. More... | |
Public Attributes | |
Coordinate | co |
This is the primary coordinate. More... | |
Coordinate | handle_left |
This is the left handle coordinate (in percentages from 0 to 1) More... | |
Coordinate | handle_right |
This is the right handle coordinate (in percentages from 0 to 1) More... | |
HandleType | handle_type |
This is the handle mode. More... | |
InterpolationType | interpolation |
This is the interpolation mode. More... | |
A Point is the basic building block of a key-frame curve.
Points have a primary coordinate and a left and right handle coordinate. The handles are used to influence the direction of the curve as it moves between the primary coordinate and the next primary coordinate when the interpolation mode is BEZIER. When using LINEAR or CONSTANT, the handles are ignored.
Please see the following Example Code:
Point::Point | ( | float | y | ) |
Point::Point | ( | float | x, |
float | y | ||
) |
Point::Point | ( | float | x, |
float | y, | ||
InterpolationType | interpolation | ||
) |
Point::Point | ( | Coordinate | co | ) |
Point::Point | ( | Coordinate | co, |
InterpolationType | interpolation | ||
) |
Point::Point | ( | Coordinate | co, |
InterpolationType | interpolation, | ||
HandleType | handle_type | ||
) |
void Point::Initialize_Handles | ( | ) |
void Point::Initialize_LeftHandle | ( | float | x, |
float | y | ||
) |
Set the left handle to a percent of the primary coordinate (0 to 1)
Definition at line 100 of file Point.cpp.
Referenced by Initialize_Handles().
void Point::Initialize_RightHandle | ( | float | x, |
float | y | ||
) |
Set the right handle to a percent of the primary coordinate (0 to 1)
Definition at line 105 of file Point.cpp.
Referenced by Initialize_Handles().
std::string Point::Json | ( | ) |
Json::Value Point::JsonValue | ( | ) |
void Point::SetJson | ( | std::string | value | ) |
void Point::SetJsonValue | ( | Json::Value | root | ) |
Load Json::JsonValue into this object.
Definition at line 164 of file Point.cpp.
Referenced by SetJson(), and openshot::Keyframe::SetJsonValue().
Coordinate openshot::Point::co |
This is the primary coordinate.
Definition at line 84 of file Point.h.
Referenced by openshot::ClipBase::add_property_json(), openshot::Keyframe::AddPoint(), openshot::Keyframe::Contains(), openshot::Keyframe::FindIndex(), openshot::Keyframe::GetClosestPoint(), openshot::QtImageReader::GetFrame(), openshot::FFmpegReader::GetFrame(), openshot::Keyframe::GetMaxPoint(), openshot::Keyframe::GetRepeatFraction(), JsonValue(), Point(), openshot::Keyframe::PrintPoints(), openshot::Keyframe::RemovePoint(), and SetJsonValue().
Coordinate openshot::Point::handle_left |
This is the left handle coordinate (in percentages from 0 to 1)
Definition at line 85 of file Point.h.
Referenced by Initialize_LeftHandle(), JsonValue(), and SetJsonValue().
Coordinate openshot::Point::handle_right |
This is the right handle coordinate (in percentages from 0 to 1)
Definition at line 86 of file Point.h.
Referenced by Initialize_RightHandle(), JsonValue(), and SetJsonValue().
HandleType openshot::Point::handle_type |
This is the handle mode.
Definition at line 88 of file Point.h.
Referenced by JsonValue(), and SetJsonValue().
InterpolationType openshot::Point::interpolation |
This is the interpolation mode.
Definition at line 87 of file Point.h.
Referenced by openshot::ClipBase::add_property_json(), JsonValue(), and SetJsonValue().