OpenShot Library | libopenshot  0.2.3
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...
 
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...
 
- 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...
 
float Duration ()
 Get the length of this clip (in seconds) More...
 
float End ()
 Get end position (in seconds) of clip (trim end of video) More...
 
void End (float value)
 Set end position (in seconds) of clip (trim end of video) More...
 
string Id ()
 Get basic properties. More...
 
void Id (string value)
 Set basic properties. More...
 
int Layer ()
 Get layer of clip on timeline (lower number is covered by higher numbers) More...
 
void Layer (int value)
 Set layer of clip on timeline (lower number is covered by higher numbers) More...
 
bool operator< (ClipBase &a)
 
bool operator<= (ClipBase &a)
 
bool operator> (ClipBase &a)
 
bool operator>= (ClipBase &a)
 
float Position ()
 Get position on timeline (in seconds) More...
 
void Position (float value)
 

Set the Id of this clip object

More...
 
float Start ()
 Get start position (in seconds) of clip (trim start of video) More...
 
void Start (float value)
 Set start position (in seconds) of clip (trim start of video) More...
 

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 (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...
 
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 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 53 of file Crop.h.

Constructor & Destructor Documentation

Crop::Crop ( )

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

Definition at line 33 of file Crop.cpp.

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

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

Parameters
colorThe curve to adjust the color of bars
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 39 of file Crop.cpp.

Member Function Documentation

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

string Crop::Json ( )
virtual

Get and Set JSON methods.

Generate JSON string of this object

Implements openshot::EffectBase.

Definition at line 114 of file Crop.cpp.

Json::Value Crop::JsonValue ( )
virtual

Generate Json::JsonValue for this object.

Implements openshot::EffectBase.

Definition at line 121 of file Crop.cpp.

string Crop::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 176 of file Crop.cpp.

void Crop::SetJson ( string  value)
virtual

Load JSON string into this object.

Implements openshot::EffectBase.

Definition at line 136 of file Crop.cpp.

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

Load Json::JsonValue into this object.

Implements openshot::EffectBase.

Definition at line 159 of file Crop.cpp.

Member Data Documentation

Keyframe openshot::Crop::bottom

Size of bottom bar.

Definition at line 65 of file Crop.h.

Color openshot::Crop::color

Color of bars.

Definition at line 61 of file Crop.h.

Keyframe openshot::Crop::left

Size of left bar.

Definition at line 62 of file Crop.h.

Keyframe openshot::Crop::right

Size of right bar.

Definition at line 64 of file Crop.h.

Keyframe openshot::Crop::top

Size of top bar.

Definition at line 63 of file Crop.h.


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