OpenShot Library | libopenshot 0.6.0
Loading...
Searching...
No Matches
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
26namespace openshot
27{
32
39 class Hue : public EffectBase
40 {
41 private:
43 void init_effect_details();
44
45 protected:
46 bool UseCustomMaskBlend(int64_t frame_number) const override;
47 void ApplyCustomMaskBlend(std::shared_ptr<QImage> original_image, std::shared_ptr<QImage> effected_image,
48 std::shared_ptr<QImage> mask_image, int64_t frame_number) const override;
49
50 public:
53
55 Hue();
56
61
68 std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override { return GetFrame(std::make_shared<openshot::Frame>(), frame_number); }
69
79 std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
80
81 // Get and Set JSON methods
82 std::string Json() const override;
83 void SetJson(const std::string value) override;
84 Json::Value JsonValue() const override;
85 void SetJsonValue(const Json::Value root) override;
86
89 std::string PropertiesJSON(int64_t requested_frame) const override;
90 };
91
92}
93
94#endif
This abstract class is the base class, used by all effects in libopenshot.
Definition EffectBase.h:57
This class shifts the hue of an image, and can be animated with openshot::Keyframe curves over time.
Definition Hue.h:40
Keyframe hue
Shift the hue coordinates (left or right)
Definition Hue.h:51
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition Hue.cpp:171
int mask_mode
Mask behavior mode for this effect.
Definition Hue.h:52
Hue()
Default constructor, useful when using Json to load the effect properties.
Definition Hue.cpp:19
void SetJson(const std::string value) override
Load JSON string into this object.
Definition Hue.cpp:154
std::string PropertiesJSON(int64_t requested_frame) const override
Definition Hue.cpp:184
void ApplyCustomMaskBlend(std::shared_ptr< QImage > original_image, std::shared_ptr< QImage > effected_image, std::shared_ptr< QImage > mask_image, int64_t frame_number) const override
Optional override for effects with custom mask implementation.
Definition Hue.cpp:101
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:68
std::string Json() const override
Generate JSON string of this object.
Definition Hue.cpp:134
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition Hue.cpp:141
bool UseCustomMaskBlend(int64_t frame_number) const override
Optional override for effects that need custom mask behavior.
Definition Hue.cpp:96
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
HueMaskMode
Definition Hue.h:28
@ HUE_MASK_LIMIT_TO_AREA
Definition Hue.h:29
@ HUE_MASK_VARY_STRENGTH
Definition Hue.h:30