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

This class represents a color (used on the timeline and clips) More...

#include <Color.h>

Public Member Functions

 Color ()
 Default constructor. More...
 
 Color (Keyframe Red, Keyframe Green, Keyframe Blue, Keyframe Alpha)
 Constructor which takes 4 existing Keyframe curves. More...
 
 Color (string color_hex)
 Constructor which takes a HEX color code. More...
 
 Color (unsigned char Red, unsigned char Green, unsigned char Blue, unsigned char Alpha)
 Constructor which takes R,G,B,A. More...
 
string GetColorHex (int64_t frame_number)
 Get the HEX value of a color at a specific frame. More...
 
string Json ()
 Get and Set JSON methods. More...
 
Json::Value JsonValue ()
 Generate Json::JsonValue for this object. More...
 
void SetJson (string value)
 Load JSON string into this object. More...
 
void SetJsonValue (Json::Value root)
 Load Json::JsonValue into this object. More...
 

Static Public Member Functions

static long GetDistance (long R1, long G1, long B1, long R2, long G2, long B2)
 Get the distance between 2 RGB pairs. (0=identical colors, 10=very close colors, 760=very different colors) More...
 

Public Attributes

Keyframe alpha
 Curve representing the alpha value (0 - 255) More...
 
Keyframe blue
 Curve representing the red value (0 - 255) More...
 
Keyframe green
 Curve representing the green value (0 - 255) More...
 
Keyframe red
 Curve representing the red value (0 - 255) More...
 

Detailed Description

This class represents a color (used on the timeline and clips)

Colors are represented by 4 curves, representing red, green, blue, and alpha. The curves can be used to animate colors over time.

Definition at line 42 of file Color.h.

Constructor & Destructor Documentation

◆ Color() [1/4]

openshot::Color::Color ( )
inline

Default constructor.

Definition at line 51 of file Color.h.

◆ Color() [2/4]

Color::Color ( string  color_hex)

Constructor which takes a HEX color code.

Definition at line 53 of file Color.cpp.

◆ Color() [3/4]

Color::Color ( unsigned char  Red,
unsigned char  Green,
unsigned char  Blue,
unsigned char  Alpha 
)

Constructor which takes R,G,B,A.

Definition at line 33 of file Color.cpp.

◆ Color() [4/4]

Color::Color ( Keyframe  Red,
Keyframe  Green,
Keyframe  Blue,
Keyframe  Alpha 
)

Constructor which takes 4 existing Keyframe curves.

Definition at line 43 of file Color.cpp.

Member Function Documentation

◆ GetColorHex()

string Color::GetColorHex ( int64_t  frame_number)

Get the HEX value of a color at a specific frame.

Definition at line 64 of file Color.cpp.

◆ GetDistance()

long Color::GetDistance ( long  R1,
long  G1,
long  B1,
long  R2,
long  G2,
long  B2 
)
static

Get the distance between 2 RGB pairs. (0=identical colors, 10=very close colors, 760=very different colors)

Definition at line 75 of file Color.cpp.

◆ Json()

string Color::Json ( )

Get and Set JSON methods.

Generate JSON string of this object

Definition at line 85 of file Color.cpp.

◆ JsonValue()

Json::Value Color::JsonValue ( )

Generate Json::JsonValue for this object.

Definition at line 92 of file Color.cpp.

◆ SetJson()

void Color::SetJson ( string  value)

Load JSON string into this object.

Definition at line 106 of file Color.cpp.

◆ SetJsonValue()

void Color::SetJsonValue ( Json::Value  root)

Load Json::JsonValue into this object.

Definition at line 129 of file Color.cpp.

Member Data Documentation

◆ alpha

Keyframe openshot::Color::alpha

Curve representing the alpha value (0 - 255)

Definition at line 48 of file Color.h.

◆ blue

Keyframe openshot::Color::blue

Curve representing the red value (0 - 255)

Definition at line 47 of file Color.h.

◆ green

Keyframe openshot::Color::green

Curve representing the green value (0 - 255)

Definition at line 46 of file Color.h.

◆ red

Keyframe openshot::Color::red

Curve representing the red value (0 - 255)

Definition at line 45 of file Color.h.


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