OpenShot Library | libopenshot 0.3.3
Loading...
Searching...
No Matches
Wave.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_WAVE_EFFECT_H
14#define OPENSHOT_WAVE_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{
28
35 class Wave : public EffectBase
36 {
37 private:
38 //unsigned char *perm;
39
41 void init_effect_details();
42
43 public:
49
51 Wave();
52
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:54
A Keyframe is a collection of Point instances, which is used to vary a number or property over time.
Definition KeyFrame.h:53
This class distorts an image using a wave pattern.
Definition Wave.h:36
Keyframe shift_x
Amount to shift X-axis.
Definition Wave.h:47
Wave()
Default constructor, useful when using Json to load the effect properties.
Definition Wave.cpp:19
std::string PropertiesJSON(int64_t requested_frame) const override
Definition Wave.cpp:154
std::string Json() const override
Generate JSON string of this object.
Definition Wave.cpp:95
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition Wave.cpp:135
void SetJson(const std::string value) override
Load JSON string into this object.
Definition Wave.cpp:118
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition Wave.cpp:102
Keyframe amplitude
The height of the wave.
Definition Wave.h:45
Keyframe wavelength
The length of the wave.
Definition Wave.h:44
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 Wave.h:68
Keyframe multiplier
Amount to multiply the wave (make it bigger)
Definition Wave.h:46
Keyframe speed_y
Speed of the wave on the Y-axis.
Definition Wave.h:48
This namespace is the default namespace for all code in the openshot library.
Definition Compressor.h:29