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

This class crops a frame image (from any side), and can be animated with openshot::Keyframe curves over time. More...

#include <Crop.h>

Inheritance diagram for openshot::Crop:
openshot::EffectBase openshot::ClipBase

Public Member Functions

 Crop ()
 Blank constructor, useful when using Json to load the effect properties. More...
 
 Crop (Keyframe left, Keyframe top, Keyframe right, Keyframe bottom)
 
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...
 
std::string Json () const override
 Get and Set JSON methods. More...
 
Json::Value JsonValue () const override
 Generate Json::Value for this object. More...
 
std::string PropertiesJSON (int64_t requested_frame) const override
 
void SetJson (const std::string value)
 Load JSON string into this object. More...
 
void SetJsonValue (const Json::Value root)
 Load Json::Value into this object. More...
 
- 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 () const
 Generate JSON object of meta data / info. More...
 
int Order () const
 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...
 
virtual ~EffectBase ()=default
 
- Public Member Functions inherited from openshot::ClipBase
 ClipBase ()
 Constructor for the base clip. More...
 
void Id (std::string value)
 Set basic properties. More...
 
bool operator< (ClipBase &a)
 
bool operator<= (ClipBase &a)
 
bool operator> (ClipBase &a)
 
bool operator>= (ClipBase &a)
 
virtual ~ClipBase ()=default
 

Public Attributes

Keyframe bottom
 Size of bottom bar. More...
 
Color color
 Color of bars. More...
 
Keyframe left
 Size of left bar. More...
 
Keyframe right
 Size of right bar. More...
 
Keyframe top
 Size of top bar. 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 (std::string name, int value, int selected_value) const
 Generate JSON choice for a property (dropdown properties) More...
 
Json::Value add_property_json (std::string name, float value, std::string type, std::string memo, const Keyframe *keyframe, float min_value, float max_value, bool readonly, int64_t requested_frame) const
 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...
 
std::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...
 
float position
 The position on the timeline where this clip should start playing. More...
 
std::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 crops a frame image (from any side), and can be animated with openshot::Keyframe curves over time.

Cropping images can be useful when wanting to remove a border around an image or video, and animating the crop can create some very interesting effects.

Definition at line 54 of file Crop.h.

Constructor & Destructor Documentation

◆ Crop() [1/2]

Crop::Crop ( )

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

Definition at line 36 of file Crop.cpp.

◆ Crop() [2/2]

Crop::Crop ( Keyframe  left,
Keyframe  top,
Keyframe  right,
Keyframe  bottom 
)

Default constructor, which takes 4 curves. These curves animate the crop over time.

Parameters
leftThe curve to adjust the left bar size (between 0 and 1)
topThe curve to adjust the top bar size (between 0 and 1)
rightThe curve to adjust the right bar size (between 0 and 1)
bottomThe curve to adjust the bottom bar size (between 0 and 1)

Definition at line 42 of file Crop.cpp.

Member Function Documentation

◆ GetFrame()

std::shared_ptr< Frame > Crop::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 its 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 65 of file Crop.cpp.

◆ Json()

std::string Crop::Json ( ) const
overridevirtual

Get and Set JSON methods.

Generate JSON string of this object

Implements openshot::EffectBase.

Definition at line 117 of file Crop.cpp.

◆ JsonValue()

Json::Value Crop::JsonValue ( ) const
overridevirtual

Generate Json::Value for this object.

Implements openshot::EffectBase.

Definition at line 124 of file Crop.cpp.

Referenced by Json().

◆ PropertiesJSON()

std::string Crop::PropertiesJSON ( int64_t  requested_frame) const
overridevirtual

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 173 of file Crop.cpp.

◆ SetJson()

void Crop::SetJson ( const std::string  value)
virtual

Load JSON string into this object.

Implements openshot::EffectBase.

Definition at line 139 of file Crop.cpp.

◆ SetJsonValue()

void Crop::SetJsonValue ( const Json::Value  root)
virtual

Load Json::Value into this object.

Implements openshot::EffectBase.

Definition at line 156 of file Crop.cpp.

Referenced by SetJson().

Member Data Documentation

◆ bottom

Keyframe openshot::Crop::bottom

Size of bottom bar.

Definition at line 66 of file Crop.h.

Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().

◆ color

Color openshot::Crop::color

Color of bars.

Definition at line 62 of file Crop.h.

◆ left

Keyframe openshot::Crop::left

Size of left bar.

Definition at line 63 of file Crop.h.

Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().

◆ right

Keyframe openshot::Crop::right

Size of right bar.

Definition at line 65 of file Crop.h.

Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().

◆ top

Keyframe openshot::Crop::top

Size of top bar.

Definition at line 64 of file Crop.h.

Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().


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