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 <effects/ColorShift.h>

Inheritance diagram for openshot::ColorShift:

[legend]

Collaboration diagram for openshot::ColorShift:

[legend]

Public Member Functions
	ColorShift ()
	Blank constructor, useful when using Json to load the effect properties. More...

	ColorShift (Keyframe red_x, Keyframe red_y, Keyframe green_x, Keyframe green_y, Keyframe blue_x, Keyframe blue_y, Keyframe alpha_x, Keyframe alpha_y)

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. All Clip keyframes and effects are resolved into pixels. More...

std::shared_ptr< openshot::Frame >	GetFrame (std::shared_ptr< openshot::Frame > frame, int64_t frame_number) override
	This method is required for all derived classes of ClipBase, and returns a modified openshot::Frame object. More...

std::string	Json () const override
	Generate JSON string of this object. 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) override
	Load JSON string into this object. More...

void	SetJsonValue (const Json::Value root) override
	Load Json::Value into this object. More...

Public Member Functions inherited from openshot::EffectBase
Json::Value	BasePropertiesJSON (int64_t requested_frame) const
	Generate JSON object of base properties (recommended to be used by all effects) More...

int	constrain (int color_value)
	Constrain a color value from 0 to 255. More...

void	DisplayInfo (std::ostream *out=&std::cout)
	Display effect information in the standard output stream (stdout) More...

virtual std::string	GetVisibleObjects (int64_t frame_number) const
	Get the indexes and IDs of all visible objects in the given frame. More...

void	InitEffectInfo ()

virtual std::string	Json (int64_t requested_frame) const

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...

openshot::ClipBase *	ParentClip ()
	Parent clip object of this effect (which can be unparented and NULL) More...

void	ParentClip (openshot::ClipBase *new_clip)
	Set parent clip object of this effect. More...

std::string	ParentClipId () const
	Return the ID of this effect's parent clip. More...

virtual void	SetJson (int64_t requested_frame, const std::string value)

void	SetParentEffect (std::string parentEffect_id)
	Set the parent effect from which this properties will be set to. More...

virtual	~EffectBase ()=default

Public Member Functions inherited from openshot::ClipBase
	ClipBase ()
	Constructor for the base clip. More...

virtual void	End (float value)
	Set end position (in seconds) of clip (trim end of video) More...

void	Id (std::string value)

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)

void	Position (float value)
	Set the Id of this clip object More...

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

virtual	~ClipBase ()=default

Public Attributes
Keyframe	alpha_x
	Shift the Alpha X coordinates (left or right) More...

Keyframe	alpha_y
	Shift the Alpha Y coordinates (up or down) More...

Keyframe	blue_x
	Shift the Blue X coordinates (left or right) More...

Keyframe	blue_y
	Shift the Blue Y coordinates (up or down) More...

Keyframe	green_x
	Shift the Green X coordinates (left or right) More...

Keyframe	green_y
	Shift the Green Y coordinates (up or down) More...

Keyframe	red_x
	Shift the Red X coordinates (left or right) More...

Keyframe	red_y
	Shift the Red Y coordinates (up or down) More...

Public Attributes inherited from openshot::EffectBase
EffectInfoStruct	info
	Information about the current effect. More...

EffectBase *	parentEffect
	Parent effect (which properties will set this effect properties) More...

std::map< int, std::shared_ptr< openshot::TrackedObjectBase > >	trackedObjects
	Map of Tracked Object's by their indices (used by Effects that track objects on clips) 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::EffectBase
openshot::ClipBase *	clip
	Pointer to the parent clip instance (if any) 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...

openshot::TimelineBase *	timeline
	Pointer to the parent timeline instance (if any) 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 35 of file ColorShift.h.

Constructor & Destructor Documentation

◆ ColorShift() [1/2]

ColorShift::ColorShift ( )

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

Definition at line 19 of file ColorShift.cpp.

◆ ColorShift() [2/2]

ColorShift::ColorShift	(	Keyframe	red_x,
		Keyframe	red_y,
		Keyframe	green_x,
		Keyframe	green_y,
		Keyframe	blue_x,
		Keyframe	blue_y,
		Keyframe	alpha_x,
		Keyframe	alpha_y
	)

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

Parameters

red_x	The curve to adjust the Red x shift (between -1 and 1, percentage)
red_y	The curve to adjust the Red y shift (between -1 and 1, percentage)
green_x	The curve to adjust the Green x shift (between -1 and 1, percentage)
green_y	The curve to adjust the Green y shift (between -1 and 1, percentage)
blue_x	The curve to adjust the Blue x shift (between -1 and 1, percentage)
blue_y	The curve to adjust the Blue y shift (between -1 and 1, percentage)
alpha_x	The curve to adjust the Alpha x shift (between -1 and 1, percentage)
alpha_y	The curve to adjust the Alpha y shift (between -1 and 1, percentage)

Definition at line 25 of file ColorShift.cpp.

Member Function Documentation

◆ GetFrame() [1/2]

std::shared_ptr<openshot::Frame> openshot::ColorShift::GetFrame ( int64_t frame_number )

inlineoverridevirtual

This method is required for all derived classes of ClipBase, and returns a new openshot::Frame object. All Clip keyframes and effects are resolved into pixels.

Returns: A new openshot::Frame object

Parameters

frame_number The frame number (starting at 1) of the clip or effect on the timeline.

Implements openshot::ClipBase.

Definition at line 72 of file ColorShift.h.

Referenced by GetFrame().

◆ GetFrame() [2/2]

std::shared_ptr< openshot::Frame > ColorShift::GetFrame	(	std::shared_ptr< openshot::Frame >	frame,
		int64_t	frame_number
	)

overridevirtual

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

The frame object is passed into this method and used as a starting point (pixels and audio). All Clip keyframes and effects are resolved into pixels.

Returns: The modified openshot::Frame object

Parameters

frame	The frame object that needs the clip or effect applied to it
frame_number	The frame number (starting at 1) of the clip or effect on the timeline.

Implements openshot::ClipBase.

Definition at line 48 of file ColorShift.cpp.

◆ Json()

std::string ColorShift::Json ( ) const

overridevirtual

Generate JSON string of this object.

Reimplemented from openshot::EffectBase.

Definition at line 178 of file ColorShift.cpp.

◆ JsonValue()

Json::Value ColorShift::JsonValue ( ) const

overridevirtual

Generate Json::Value for this object.

Reimplemented from openshot::EffectBase.

Definition at line 185 of file ColorShift.cpp.

Referenced by Json().

◆ PropertiesJSON()

std::string ColorShift::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 246 of file ColorShift.cpp.

◆ SetJson()

void ColorShift::SetJson ( const std::string value )

overridevirtual

Load JSON string into this object.

Reimplemented from openshot::EffectBase.

Definition at line 204 of file ColorShift.cpp.

◆ SetJsonValue()

void ColorShift::SetJsonValue ( const Json::Value root )

overridevirtual

Load Json::Value into this object.

Reimplemented from openshot::EffectBase.

Definition at line 221 of file ColorShift.cpp.

Referenced by SetJson().

Member Data Documentation

◆ alpha_x

Keyframe openshot::ColorShift::alpha_x

Shift the Alpha X coordinates (left or right)

Definition at line 48 of file ColorShift.h.

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

◆ alpha_y

Keyframe openshot::ColorShift::alpha_y

Shift the Alpha Y coordinates (up or down)

Definition at line 49 of file ColorShift.h.

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

◆ blue_x

Keyframe openshot::ColorShift::blue_x

Shift the Blue X coordinates (left or right)

Definition at line 46 of file ColorShift.h.

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

◆ blue_y

Keyframe openshot::ColorShift::blue_y

Shift the Blue Y coordinates (up or down)

Definition at line 47 of file ColorShift.h.

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

◆ green_x

Keyframe openshot::ColorShift::green_x

Shift the Green X coordinates (left or right)

Definition at line 44 of file ColorShift.h.

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

◆ green_y

Keyframe openshot::ColorShift::green_y

Shift the Green Y coordinates (up or down)

Definition at line 45 of file ColorShift.h.

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

◆ red_x

Keyframe openshot::ColorShift::red_x

Shift the Red X coordinates (left or right)

Definition at line 42 of file ColorShift.h.

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

◆ red_y

Keyframe openshot::ColorShift::red_y

Shift the Red Y coordinates (up or down)

Definition at line 43 of file ColorShift.h.

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

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

effects/ColorShift.h
effects/ColorShift.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ColorShift() [1/2]

◆ ColorShift() [2/2]

Member Function Documentation

◆ GetFrame() [1/2]

◆ GetFrame() [2/2]

◆ Json()

◆ JsonValue()

◆ PropertiesJSON()

◆ SetJson()

◆ SetJsonValue()

Member Data Documentation

◆ alpha_x

◆ alpha_y

◆ blue_x

◆ blue_y

◆ green_x

◆ green_y

◆ red_x

◆ red_y