OpenShot Library | libopenshot 0.2.7
Shift.h
Go to the documentation of this file.
1/**
2 * @file
3 * @brief Header file for Shift effect class
4 * @author Jonathan Thomas <jonathan@openshot.org>
5 *
6 * @ref License
7 */
8
9/* LICENSE
10 *
11 * Copyright (c) 2008-2019 OpenShot Studios, LLC
12 * <http://www.openshotstudios.com/>. This file is part of
13 * OpenShot Library (libopenshot), an open-source project dedicated to
14 * delivering high quality video editing and animation solutions to the
15 * world. For more information visit <http://www.openshot.org/>.
16 *
17 * OpenShot Library (libopenshot) is free software: you can redistribute it
18 * and/or modify it under the terms of the GNU Lesser General Public License
19 * as published by the Free Software Foundation, either version 3 of the
20 * License, or (at your option) any later version.
21 *
22 * OpenShot Library (libopenshot) is distributed in the hope that it will be
23 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU Lesser General Public License for more details.
26 *
27 * You should have received a copy of the GNU Lesser General Public License
28 * along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
29 */
30
31#ifndef OPENSHOT_SHIFT_EFFECT_H
32#define OPENSHOT_SHIFT_EFFECT_H
33
34#include "../EffectBase.h"
35
36#include "../Frame.h"
37#include "../Json.h"
38#include "../KeyFrame.h"
39
40#include <string>
41#include <memory>
42
43
44namespace openshot
45{
46
47 /**
48 * @brief This class shifts the pixels of an image up, down, left, or right, and can be animated
49 * with openshot::Keyframe curves over time.
50 *
51 * Shifting pixels can be used in many interesting ways, especially when animating the movement of the pixels.
52 * The pixels wrap around the image (the pixels drop off one side and appear on the other side of the image).
53 */
54 class Shift : public EffectBase
55 {
56 private:
57 /// Init effect settings
58 void init_effect_details();
59
60
61 public:
62 Keyframe x; ///< Shift the X coordinates (left or right)
63 Keyframe y; ///< Shift the Y coordinates (up or down)
64
65 /// Blank constructor, useful when using Json to load the effect properties
66 Shift();
67
68 /// Default constructor, which takes 2 curve. The curves will shift the pixels up, down, left, or right
69 ///
70 /// @param x The curve to adjust the x shift (between -1 and 1, percentage)
71 /// @param y The curve to adjust the y shift (between -1 and 1, percentage)
73
74 /// @brief This method is required for all derived classes of ClipBase, and returns a
75 /// new openshot::Frame object. All Clip keyframes and effects are resolved into
76 /// pixels.
77 ///
78 /// @returns A new openshot::Frame object
79 /// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline.
80 std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override { return GetFrame(std::make_shared<openshot::Frame>(), frame_number); }
81
82 /// @brief This method is required for all derived classes of ClipBase, and returns a
83 /// modified openshot::Frame object
84 ///
85 /// The frame object is passed into this method and used as a starting point (pixels and audio).
86 /// All Clip keyframes and effects are resolved into pixels.
87 ///
88 /// @returns The modified openshot::Frame object
89 /// @param frame The frame object that needs the clip or effect applied to it
90 /// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline.
91 std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
92
93 // Get and Set JSON methods
94 std::string Json() const override; ///< Generate JSON string of this object
95 void SetJson(const std::string value) override; ///< Load JSON string into this object
96 Json::Value JsonValue() const override; ///< Generate Json::Value for this object
97 void SetJsonValue(const Json::Value root) override; ///< Load Json::Value into this object
98
99 /// Get all properties for a specific frame (perfect for a UI to display the current state
100 /// of all properties at any time)
101 std::string PropertiesJSON(int64_t requested_frame) const override;
102 };
103
104}
105
106#endif
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:71
A Keyframe is a collection of Point instances, which is used to vary a number or property over time.
Definition: KeyFrame.h:72
This class shifts the pixels of an image up, down, left, or right, and can be animated with openshot:...
Definition: Shift.h:55
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: Shift.h:80
Keyframe y
Shift the Y coordinates (up or down)
Definition: Shift.h:63
std::string Json() const override
Generate JSON string of this object.
Definition: Shift.cpp:137
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Shift.cpp:144
Keyframe x
Shift the X coordinates (left or right)
Definition: Shift.h:62
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition: Shift.cpp:174
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Shift.cpp:187
Shift()
Blank constructor, useful when using Json to load the effect properties.
Definition: Shift.cpp:37
void SetJson(const std::string value) override
Load JSON string into this object.
Definition: Shift.cpp:157
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:47