Loading...
Searching...
No Matches
Wave.h
Go to the documentation of this file.
// Copyright (c) 2008-2019 OpenShot Studios, LLC
//
// SPDX-License-Identifier: LGPL-3.0-or-later
#ifndef OPENSHOT_WAVE_EFFECT_H
#define OPENSHOT_WAVE_EFFECT_H
#include "../EffectBase.h"
#include "../Frame.h"
#include "../Json.h"
#include "../KeyFrame.h"
#include <string>
#include <memory>
namespace openshot
{
class Wave : public EffectBase
{
private:
//unsigned char *perm;
void init_effect_details();
public:
Keyframe wavelength;
Keyframe amplitude;
Keyframe multiplier;
Keyframe shift_x;
Keyframe speed_y;
Wave();
Wave(Keyframe wavelength, Keyframe amplitude, Keyframe multiplier, Keyframe shift_x, Keyframe speed_y);
std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override { return GetFrame(std::make_shared<openshot::Frame>(), frame_number); }
std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
// Get and Set JSON methods
std::string Json() const override;
void SetJson(const std::string value) override;
Json::Value JsonValue() const override;
void SetJsonValue(const Json::Value root) override;
std::string PropertiesJSON(int64_t requested_frame) const override;
};
}
#endif
openshot::EffectBase
This abstract class is the base class, used by all effects in libopenshot.
Definition EffectBase.h:54
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::Wave
This class distorts an image using a wave pattern.
Definition Wave.h:36
openshot::Wave::shift_x
Keyframe shift_x
Amount to shift X-axis.
Definition Wave.h:47
openshot::Wave::Wave
Wave()
Default constructor, useful when using Json to load the effect properties.
Definition Wave.cpp:19
openshot::Wave::PropertiesJSON
std::string PropertiesJSON(int64_t requested_frame) const override
Definition Wave.cpp:154
openshot::Wave::Json
std::string Json() const override
Generate JSON string of this object.
Definition Wave.cpp:95
openshot::Wave::SetJsonValue
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition Wave.cpp:135
openshot::Wave::SetJson
void SetJson(const std::string value) override
Load JSON string into this object.
Definition Wave.cpp:118
openshot::Wave::JsonValue
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition Wave.cpp:102
openshot::Wave::amplitude
Keyframe amplitude
The height of the wave.
Definition Wave.h:45
openshot::Wave::wavelength
Keyframe wavelength
The length of the wave.
Definition Wave.h:44
openshot::Wave::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 Wave.h:68
openshot::Wave::multiplier
Keyframe multiplier
Amount to multiply the wave (make it bigger)
Definition Wave.h:46
openshot::Wave::speed_y
Keyframe speed_y
Speed of the wave on the Y-axis.
Definition Wave.h:48
openshot
This namespace is the default namespace for all code in the openshot library.
Definition Compressor.h:29