OpenShot Library | libopenshot  0.4.0
Hue.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_HUE_EFFECT_H
14 #define OPENSHOT_HUE_EFFECT_H
15 
16 #include "../EffectBase.h"
17 
18 #include "../Frame.h"
19 #include "../Json.h"
20 #include "../KeyFrame.h"
21 
22 #include <string>
23 #include <memory>
24 
25 
26 namespace openshot
27 {
28 
35  class Hue : public EffectBase
36  {
37  private:
39  void init_effect_details();
40 
41 
42  public:
44 
46  Hue();
47 
51  Hue(Keyframe hue);
52 
59  std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override { return GetFrame(std::make_shared<openshot::Frame>(), frame_number); }
60 
70  std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
71 
72  // Get and Set JSON methods
73  std::string Json() const override;
74  void SetJson(const std::string value) override;
75  Json::Value JsonValue() const override;
76  void SetJsonValue(const Json::Value root) override;
77 
80  std::string PropertiesJSON(int64_t requested_frame) const override;
81  };
82 
83 }
84 
85 #endif
openshot::EffectBase
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:53
openshot
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:28
openshot::Hue::SetJsonValue
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition: Hue.cpp:133
openshot::Hue::JsonValue
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Hue.cpp:104
openshot::Hue::PropertiesJSON
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Hue.cpp:144
openshot::Hue::hue
Keyframe hue
Shift the hue coordinates (left or right)
Definition: Hue.h:43
openshot::Keyframe
A Keyframe is a collection of Point instances, which is used to vary a number or property over time.
Definition: KeyFrame.h:53
openshot::Hue::GetFrame
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: Hue.h:59
openshot::Hue::Json
std::string Json() const override
Generate JSON string of this object.
Definition: Hue.cpp:97
openshot::Hue::Hue
Hue()
Default constructor, useful when using Json to load the effect properties.
Definition: Hue.cpp:19
openshot::Hue
This class shifts the hue of an image, and can be animated with openshot::Keyframe curves over time.
Definition: Hue.h:35
openshot::Hue::SetJson
void SetJson(const std::string value) override
Load JSON string into this object.
Definition: Hue.cpp:116