libdcp
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
dcp::Text Class Reference
Inheritance diagram for dcp::Text:
dcp::TextImage dcp::TextString

Public Member Functions

Time in () const
 
Time out () const
 
float h_position () const
 
HAlign h_align () const
 
float v_position () const
 
VAlign v_align () const
 
float z_position () const
 
Time fade_up_time () const
 
Time fade_down_time () const
 
void set_in (Time i)
 
void set_out (Time o)
 
void set_h_position (float p)
 
void set_v_position (float p)
 
void set_z_position (float z)
 
void set_fade_up_time (Time t)
 
void set_fade_down_time (Time t)
 
virtual bool equals (std::shared_ptr< const dcp::Text > other, EqualityOptions const &options, NoteHandler note) const
 

Protected Member Functions

 Text (Time in, Time out, float h_position, HAlign h_align, float v_position, VAlign v_align, float z_position, Time fade_up_time, Time fade_down_time)
 

Protected Attributes

Time _in
 
Time _out
 
float _h_position = 0
 
HAlign _h_align = HAlign::CENTER
 
float _v_position = 0
 
VAlign _v_align = VAlign::CENTER
 
float _z_position = 0
 
Time _fade_up_time
 
Time _fade_down_time
 

Detailed Description

Definition at line 55 of file text.h.

Constructor & Destructor Documentation

◆ Text()

Text::Text ( Time  in,
Time  out,
float  h_position,
HAlign  h_align,
float  v_position,
VAlign  v_align,
float  z_position,
Time  fade_up_time,
Time  fade_down_time 
)
protected
Parameters
v_positionVertical position as a fraction of the screen height (between 0 and 1) from v_align

Definition at line 51 of file text.cc.

Member Function Documentation

◆ in()

Time dcp::Text::in ( ) const
inline
Returns
text start time (relative to the start of the reel)

Definition at line 61 of file text.h.

◆ out()

Time dcp::Text::out ( ) const
inline
Returns
text finish time (relative to the start of the reel)

Definition at line 66 of file text.h.

◆ set_v_position()

void dcp::Text::set_v_position ( float  p)
inline
Parameters
pNew vertical position as a proportion of the screen height from the top (between 0 and 1)

Definition at line 117 of file text.h.

◆ v_position()

float dcp::Text::v_position ( ) const
inline
Returns
vertical position as a proportion of the screen height from the vertical alignment point. (between 0 and 1)

Definition at line 82 of file text.h.

Member Data Documentation

◆ _h_position

float dcp::Text::_h_position = 0
protected

Horizontal position as a proportion of the screen width from the _h_align (between 0 and 1)

Definition at line 154 of file text.h.

◆ _v_position

float dcp::Text::_v_position = 0
protected

Vertical position as a proportion of the screen height from the _v_align (between 0 and 1)

Definition at line 159 of file text.h.


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