ruler.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2018-2022, 2024 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense

 
#ifndef __GUI_WIDGETS_RULER_H__
#define __GUI_WIDGETS_RULER_H__
 
#include "common/dsp/position.h"
#include "common/utils/ui.h"
#include "gui/backend/gtk_widgets/gtk_wrapper.h"
 
constexpr int RW_RULER_MARKER_SIZE = 8;
constexpr int RW_CUE_MARKER_HEIGHT = 12;
constexpr int RW_CUE_MARKER_WIDTH = 7;
constexpr int RW_PLAYHEAD_TRIANGLE_WIDTH = 12;
constexpr int RW_PLAYHEAD_TRIANGLE_HEIGHT = 8;
constexpr int RW_RANGE_HEIGHT_DIVISOR = 4;
 
constexpr int RW_HEIGHT = 42;

constexpr int RW_SCROLL_SPEED = 48;

constexpr double RW_PX_TO_HIDE_BEATS = 40.0;
 
#define RULER_WIDGET_TYPE (ruler_widget_get_type ())
G_DECLARE_FINAL_TYPE (RulerWidget, ruler_widget, Z, RULER_WIDGET, GtkWidget)
 

 
class Position;
class EditorSettings;

#define DEFAULT_PX_PER_TICK 0.03

#define SPACE_BEFORE_START 10
#define SPACE_BEFORE_START_F 10.f
#define SPACE_BEFORE_START_D 10.0

#define RULER_ZOOM_LEVEL_MULTIPLIER 1.28
 
#define MIN_ZOOM_LEVEL 0.04
#define MAX_ZOOM_LEVEL 1800.

enum class RWTarget
{
  Playhead,
  LoopStart,
  LoopEnd,
  PunchIn,
  PunchOut,
  ClipStart,
  Range,     
  LoopRange, 
};
 
enum class RulerWidgetType
{
  Timeline,
  Editor,
};

enum class RulerWidgetRangeType
{
  Start,
  Full,
  End,
};
 
using RulerWidget = struct _RulerWidget
{
  GtkWidget parent_instance;
 
  RulerWidgetType type;
 
  double px_per_beat;
  double px_per_bar;
  double px_per_sixteenth;
  double px_per_tick;
  double px_per_min;
  double px_per_10sec;
  double px_per_sec;
  double px_per_100ms;
  double total_px;

  UiOverlayAction action;

  double start_x;
  double start_y;
  double last_offset_x;
  double last_offset_y;
 
  double hover_x;
  double hover_y;
  bool   hovering;
 
  bool vertical_panning_started;
 
  GtkGestureDrag *  drag;
  GtkGestureClick * click;

  RWTarget target;

  int shift_held;

  bool alt_held;
 
  bool ctrl_held;

  int last_playhead_px;

  int redraw;

  int range1_first;

  int dragging;

  Position range1_start_pos;
  Position range2_start_pos;

  Position last_set_pos;

  Position drag_start_pos;
 
  cairo_t * cached_cr;
 
  cairo_surface_t * cached_surface;

  graphene_rect_t last_rect;
 
  /* layout for drawing text */
  PangoLayout * layout_normal;
  PangoLayout * monospace_layout_small;
  PangoLayout * marker_layout;

  GtkPopoverMenu * popover_menu;
};

bool
ruler_widget_set_zoom_level (RulerWidget * self, double zoom_level);

double
ruler_widget_get_zoom_level (RulerWidget * self);

void
ruler_widget_handle_horizontal_zoom (
  RulerWidget * self,
  double *      x_pos,
  double        dy);

int
ruler_widget_get_beat_interval (RulerWidget * self);

int
ruler_widget_get_sixteenth_interval (RulerWidget * self);

int
ruler_widget_get_10sec_interval (RulerWidget * self);

int
ruler_widget_get_sec_interval (RulerWidget * self);
 
bool
ruler_widget_is_range_hit (
  RulerWidget *        self,
  RulerWidgetRangeType type,
  double               x,
  double               y);

bool
ruler_widget_is_loop_range_hit (
  RulerWidget *        self,
  RulerWidgetRangeType type,
  double               x,
  double               y);
 
void
ruler_widget_px_to_pos (
  RulerWidget * self,
  double        px,
  Position *    pos,
  bool          has_padding);
 
int
ruler_widget_pos_to_px (RulerWidget * self, Position * pos, int use_padding);

EditorSettings *
ruler_widget_get_editor_settings (RulerWidget * self);

void
ruler_widget_get_visible_rect (RulerWidget * self, GdkRectangle * rect);

int
ruler_widget_get_playhead_px (RulerWidget * self, bool after_loops);
 
void
ruler_widget_refresh (RulerWidget * self);

 
#endif