OpenShot Library | libopenshot  0.2.2
Public Member Functions | Public Attributes | List of all members
openshot::Shift Class Reference

This class shifts the pixels of an image up, down, left, or right, and can be animated with openshot::Keyframe curves over time. More...

#include <Shift.h>

Inheritance diagram for openshot::Shift:
openshot::EffectBase openshot::ClipBase

Public Member Functions

std::shared_ptr< FrameGetFrame (std::shared_ptr< Frame > frame, int64_t frame_number)
 This method is required for all derived classes of EffectBase, and returns a modified openshot::Frame object. More...
 
string Json ()
 Get and Set JSON methods. More...
 
Json::Value JsonValue ()
 Generate Json::JsonValue for this object. More...
 
string PropertiesJSON (int64_t requested_frame)
 
void SetJson (string value)
 Load JSON string into this object. More...
 
void SetJsonValue (Json::Value root)
 Load Json::JsonValue into this object. More...
 
 Shift ()
 Blank constructor, useful when using Json to load the effect properties. More...
 
 Shift (Keyframe x, Keyframe y)
 
- Public Member Functions inherited from openshot::EffectBase
int constrain (int color_value)
 Constrain a color value from 0 to 255. More...
 
void DisplayInfo ()
 Display effect information in the standard output stream (stdout) More...
 
void InitEffectInfo ()
 
Json::Value JsonInfo ()
 Generate JSON object of meta data / info. More...
 
int Order ()
 Get the order that this effect should be executed. More...
 
void Order (int new_order)
 Set the order that this effect should be executed. More...
 
- Public Member Functions inherited from openshot::ClipBase
 ClipBase ()
 Constructor for the base clip. More...
 
void Id (string value)
 Set basic properties. More...
 
bool operator< (ClipBase &a)
 
bool operator<= (ClipBase &a)
 
bool operator> (ClipBase &a)
 
bool operator>= (ClipBase &a)
 
void SetMaxSize (int width, int height)
 Set Max Image Size (used for performance optimization) More...
 

Public Attributes

Keyframe x
 Shift the X coordinates (left or right) More...
 
Keyframe y
 Shift the Y coordinates (up or down) More...
 
- Public Attributes inherited from openshot::EffectBase
EffectInfoStruct info
 Information about the current effect. More...
 

Additional Inherited Members

- Protected Member Functions inherited from openshot::ClipBase
Json::Value add_property_choice_json (string name, int value, int selected_value)
 Generate JSON choice for a property (dropdown properties) More...
 
Json::Value add_property_json (string name, float value, string type, string memo, Keyframe *keyframe, float min_value, float max_value, bool readonly, int64_t requested_frame)
 Generate JSON for a property. More...
 
- Protected Attributes inherited from openshot::ClipBase
float end
 The position in seconds to end playing (used to trim the ending of a clip) More...
 
string id
 ID Property for all derived Clip and Effect classes. More...
 
int layer
 The layer this clip is on. Lower clips are covered up by higher clips. More...
 
int max_height
 The maximium image height needed by this clip (used for optimizations) More...
 
int max_width
 The maximum image width needed by this clip (used for optimizations) More...
 
float position
 The position on the timeline where this clip should start playing. More...
 
string previous_properties
 This string contains the previous JSON properties. More...
 
float start
 The position in seconds to start playing (used to trim the beginning of a clip) More...
 

Detailed Description

This class shifts the pixels of an image up, down, left, or right, and can be animated with openshot::Keyframe curves over time.

Shifting pixels can be used in many interesting ways, especially when animating the movement of the pixels. The pixels wrap around the image (the pixels drop off one side and appear on the other side of the image).

Definition at line 52 of file Shift.h.

Constructor & Destructor Documentation

◆ Shift() [1/2]

Shift::Shift ( )

Blank constructor, useful when using Json to load the effect properties.

Definition at line 33 of file Shift.cpp.

◆ Shift() [2/2]

Shift::Shift ( Keyframe  x,
Keyframe  y 
)

Default constructor, which takes 2 curve. The curves will shift the pixels up, down, left, or right

Parameters
xThe curve to adjust the x shift (between -1 and 1, percentage)
yThe curve to adjust the y shift (between -1 and 1, percentage)

Definition at line 39 of file Shift.cpp.

Member Function Documentation

◆ GetFrame()

std::shared_ptr< Frame > Shift::GetFrame ( std::shared_ptr< Frame frame,
int64_t  frame_number 
)
virtual

This method is required for all derived classes of EffectBase, and returns a modified openshot::Frame object.

The frame object is passed into this method, and a frame_number is passed in which tells the effect which settings to use from it's keyframes (starting at 1).

Returns
The modified openshot::Frame object
Parameters
frameThe frame object that needs the effect applied to it
frame_numberThe frame number (starting at 1) of the effect on the timeline.

Implements openshot::EffectBase.

Definition at line 61 of file Shift.cpp.

◆ Json()

string Shift::Json ( )
virtual

Get and Set JSON methods.

Generate JSON string of this object

Implements openshot::EffectBase.

Definition at line 133 of file Shift.cpp.

◆ JsonValue()

Json::Value Shift::JsonValue ( )
virtual

Generate Json::JsonValue for this object.

Implements openshot::EffectBase.

Definition at line 140 of file Shift.cpp.

◆ PropertiesJSON()

string Shift::PropertiesJSON ( int64_t  requested_frame)
virtual

Get all properties for a specific frame (perfect for a UI to display the current state of all properties at any time)

Implements openshot::ClipBase.

Definition at line 189 of file Shift.cpp.

◆ SetJson()

void Shift::SetJson ( string  value)
virtual

Load JSON string into this object.

Implements openshot::EffectBase.

Definition at line 153 of file Shift.cpp.

◆ SetJsonValue()

void Shift::SetJsonValue ( Json::Value  root)
virtual

Load Json::JsonValue into this object.

Implements openshot::EffectBase.

Definition at line 176 of file Shift.cpp.

Member Data Documentation

◆ x

Keyframe openshot::Shift::x

Shift the X coordinates (left or right)

Definition at line 60 of file Shift.h.

◆ y

Keyframe openshot::Shift::y

Shift the Y coordinates (up or down)

Definition at line 61 of file Shift.h.


The documentation for this class was generated from the following files: