OpenShot Library | libopenshot  0.3.2
Crop.h
Go to the documentation of this file.
1 
9 // Copyright (c) 2008-2019 OpenShot Studios, LLC
10 //
11 // SPDX-License-Identifier: LGPL-3.0-or-later
12 
13 #ifndef OPENSHOT_CROP_EFFECT_H
14 #define OPENSHOT_CROP_EFFECT_H
15 
16 #include "../EffectBase.h"
17 
18 #include "../Color.h"
19 #include "../Frame.h"
20 #include "../Json.h"
21 #include "../KeyFrame.h"
22 
23 #include <memory>
24 #include <string>
25 
26 
27 namespace openshot
28 {
29 
37  class Crop : public EffectBase
38  {
39  private:
41  void init_effect_details();
42 
43 
44  public:
51 
53  Crop();
54 
64  Keyframe x=0.0, Keyframe y=0.0);
65 
72  std::shared_ptr<openshot::Frame>
73  GetFrame(int64_t frame_number) override {
74  return GetFrame(std::make_shared<openshot::Frame>(), frame_number);
75  }
76 
86  std::shared_ptr<openshot::Frame>
87  GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
88 
89  // Get and Set JSON methods
90  std::string Json() const override;
91  void SetJson(const std::string value) override;
92  Json::Value JsonValue() const override;
93  void SetJsonValue(const Json::Value root) override;
94 
97  std::string PropertiesJSON(int64_t requested_frame) const override;
98  };
99 
100 }
101 
102 #endif
This class crops a frame image (from any side), and can be animated with openshot::Keyframe curves ov...
Definition: Crop.h:38
void SetJson(const std::string value) override
Load JSON string into this object.
Definition: Crop.cpp:140
Keyframe right
Size of right bar.
Definition: Crop.h:47
std::shared_ptr< openshot::Frame > GetFrame(int64_t frame_number) override
This method is required for all derived classes of ClipBase, and returns a new openshot::Frame object...
Definition: Crop.h:73
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Crop.cpp:178
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Crop.cpp:123
Keyframe y
Y-offset.
Definition: Crop.h:50
Keyframe left
Size of left bar.
Definition: Crop.h:45
Keyframe x
X-offset.
Definition: Crop.h:49
Crop()
Blank constructor, useful when using Json to load the effect properties.
Definition: Crop.cpp:26
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition: Crop.cpp:157
Keyframe bottom
Size of bottom bar.
Definition: Crop.h:48
Keyframe top
Size of top bar.
Definition: Crop.h:46
std::string Json() const override
Generate JSON string of this object.
Definition: Crop.cpp:116
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:53
A Keyframe is a collection of Point instances, which is used to vary a number or property over time.
Definition: KeyFrame.h:53
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:29