OpenShot Library | libopenshot
0.2.4
|
This class crops a frame image (from any side), and can be animated with openshot::Keyframe curves over time. More...
#include <Crop.h>
Public Member Functions | |
Crop () | |
Blank constructor, useful when using Json to load the effect properties. More... | |
Crop (Keyframe left, Keyframe top, Keyframe right, Keyframe bottom) | |
std::shared_ptr< Frame > | GetFrame (std::shared_ptr< Frame > frame, int64_t frame_number) |
This method is required for all derived classes of EffectBase, and returns a modified openshot::Frame object. More... | |
std::string | Json () |
Get and Set JSON methods. More... | |
Json::Value | JsonValue () |
Generate Json::JsonValue for this object. More... | |
std::string | PropertiesJSON (int64_t requested_frame) |
void | SetJson (std::string value) |
Load JSON string into this object. More... | |
void | SetJsonValue (Json::Value root) |
Load Json::JsonValue into this object. More... | |
![]() | |
int | constrain (int color_value) |
Constrain a color value from 0 to 255. More... | |
void | DisplayInfo () |
Display effect information in the standard output stream (stdout) More... | |
virtual std::shared_ptr< openshot::Frame > | GetFrame (std::shared_ptr< openshot::Frame > frame, int64_t frame_number)=0 |
This method is required for all derived classes of EffectBase, and returns a modified openshot::Frame object. More... | |
void | InitEffectInfo () |
Json::Value | JsonInfo () |
Generate JSON object of meta data / info. More... | |
int | Order () |
Get the order that this effect should be executed. More... | |
void | Order (int new_order) |
Set the order that this effect should be executed. More... | |
virtual | ~EffectBase ()=default |
![]() | |
ClipBase () | |
Constructor for the base clip. More... | |
float | Duration () |
Get the length of this clip (in seconds) More... | |
float | End () |
Get end position (in seconds) of clip (trim end of video) More... | |
void | End (float value) |
Set end position (in seconds) of clip (trim end of video) More... | |
std::string | Id () |
Get basic properties. More... | |
void | Id (std::string value) |
Set basic properties. More... | |
int | Layer () |
Get layer of clip on timeline (lower number is covered by higher numbers) More... | |
void | Layer (int value) |
Set layer of clip on timeline (lower number is covered by higher numbers) More... | |
bool | operator< (ClipBase &a) |
bool | operator<= (ClipBase &a) |
bool | operator> (ClipBase &a) |
bool | operator>= (ClipBase &a) |
float | Position () |
Get position on timeline (in seconds) More... | |
void | Position (float value) |
More... | |
float | Start () |
Get start position (in seconds) of clip (trim start of video) More... | |
void | Start (float value) |
Set start position (in seconds) of clip (trim start of video) More... | |
virtual | ~ClipBase ()=default |
Public Attributes | |
Keyframe | bottom |
Size of bottom bar. More... | |
Color | color |
Color of bars. More... | |
Keyframe | left |
Size of left bar. More... | |
Keyframe | right |
Size of right bar. More... | |
Keyframe | top |
Size of top bar. More... | |
![]() | |
EffectInfoStruct | info |
Information about the current effect. More... | |
Additional Inherited Members | |
![]() | |
Json::Value | add_property_choice_json (std::string name, int value, int selected_value) |
Generate JSON choice for a property (dropdown properties) More... | |
Json::Value | add_property_json (std::string name, float value, std::string type, std::string memo, Keyframe *keyframe, float min_value, float max_value, bool readonly, int64_t requested_frame) |
Generate JSON for a property. More... | |
![]() | |
float | end |
The position in seconds to end playing (used to trim the ending of a clip) More... | |
std::string | id |
ID Property for all derived Clip and Effect classes. More... | |
int | layer |
The layer this clip is on. Lower clips are covered up by higher clips. More... | |
float | position |
The position on the timeline where this clip should start playing. More... | |
std::string | previous_properties |
This string contains the previous JSON properties. More... | |
float | start |
The position in seconds to start playing (used to trim the beginning of a clip) More... | |
This class crops a frame image (from any side), and can be animated with openshot::Keyframe curves over time.
Cropping images can be useful when wanting to remove a border around an image or video, and animating the crop can create some very interesting effects.
Crop::Crop | ( | ) |
Default constructor, which takes 4 curves. These curves animate the crop over time.
left | The curve to adjust the left bar size (between 0 and 1) |
top | The curve to adjust the top bar size (between 0 and 1) |
right | The curve to adjust the right bar size (between 0 and 1) |
bottom | The curve to adjust the bottom bar size (between 0 and 1) |
This method is required for all derived classes of EffectBase, and returns a modified openshot::Frame object.
The frame object is passed into this method, and a frame_number is passed in which tells the effect which settings to use from its keyframes (starting at 1).
frame | The frame object that needs the effect applied to it |
frame_number | The frame number (starting at 1) of the effect on the timeline. |
|
virtual |
|
virtual |
Generate Json::JsonValue for this object.
Implements openshot::EffectBase.
Definition at line 124 of file Crop.cpp.
Referenced by Json().
|
virtual |
Get all properties for a specific frame (perfect for a UI to display the current state of all properties at any time)
Implements openshot::ClipBase.
|
virtual |
Load JSON string into this object.
Implements openshot::EffectBase.
|
virtual |
Load Json::JsonValue into this object.
Implements openshot::EffectBase.
Definition at line 168 of file Crop.cpp.
Referenced by SetJson().
Keyframe openshot::Crop::bottom |
Size of bottom bar.
Definition at line 66 of file Crop.h.
Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().
Keyframe openshot::Crop::left |
Size of left bar.
Definition at line 63 of file Crop.h.
Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().
Keyframe openshot::Crop::right |
Size of right bar.
Definition at line 65 of file Crop.h.
Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().
Keyframe openshot::Crop::top |
Size of top bar.
Definition at line 64 of file Crop.h.
Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().