1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
|
/* File: gui_sketch_overlay.h; Copyright and License: see below */
#ifndef GUI_SKETCH_OVERLAY_H
#define GUI_SKETCH_OVERLAY_H
/* public file for the doxygen documentation: */
/*!
* \file
* \brief Draws graphical elements on top of diagrams
*/
#include "sketch/gui_sketch_card.h"
#include "sketch/gui_sketch_nav_tree.h"
#include "sketch/gui_sketch_drag_state.h"
#include "gui_tool.h"
#include <gtk/gtk.h>
/*!
* \brief attributes of the sketch overlay
*/
struct gui_sketch_overlay_struct {
double overlay_std_red; /*!< standard overlay color */
double overlay_std_green; /*!< standard overlay color */
double overlay_std_blue; /*!< standard overlay color */
double overlay_std_alpha; /*!< standard overlay opaqueness */
};
typedef struct gui_sketch_overlay_struct gui_sketch_overlay_t;
/*!
* \brief initializes the sketch overlay
*
* \param this_ pointer to own object attributes
*/
void gui_sketch_overlay_init( gui_sketch_overlay_t *this_ );
/*!
* \brief destroys the sketch overlay
*
* \param this_ pointer to own object attributes
*/
void gui_sketch_overlay_destroy( gui_sketch_overlay_t *this_ );
/*!
* \brief draws overlay graphics to the cairo context
*
* \param this_ pointer to own object attributes
* \param selected_tool currently selected tool/edit-mode
* \param drag_state current dragging status
* \param card_under_mouse the sketch card under the current mouse position or NULL if no card there
* \param nav_tree the navigation tree, not NULL
* \param marked_objects the focused and highighted objects
* \param cr cairo drawing context
*/
void gui_sketch_overlay_draw( gui_sketch_overlay_t *this_,
gui_tool_t selected_tool,
const gui_sketch_drag_state_t *drag_state,
const gui_sketch_card_t *card_under_mouse,
const gui_sketch_nav_tree_t *nav_tree,
gui_marked_set_t *marked_objects,
cairo_t *cr
);
/*!
* \brief draws overlay graphics for GUI_TOOL_NAVIGATE mode to the cairo context
*
* \param this_ pointer to own object attributes
* \param drag_state current dragging status
* \param nav_tree the navigation tree, not NULL
* \param cr cairo drawing context
*/
void gui_sketch_overlay_private_draw_nav_mode( gui_sketch_overlay_t *this_,
const gui_sketch_drag_state_t *drag_state,
const gui_sketch_nav_tree_t *nav_tree,
cairo_t *cr
);
/*!
* \brief draws overlay graphics for GUI_TOOL_EDIT mode to the cairo context
*
* \param this_ pointer to own object attributes
* \param drag_state current dragging status
* \param card_under_mouse the sketch card under the current mouse position or NULL if no card there
* \param cr cairo drawing context
*/
void gui_sketch_overlay_private_draw_edit_mode( gui_sketch_overlay_t *this_,
const gui_sketch_drag_state_t *drag_state,
const gui_sketch_card_t *card_under_mouse,
cairo_t *cr
);
/*!
* \brief draws overlay graphics for GUI_TOOL_CREATE mode to the cairo context
*
* \param this_ pointer to own object attributes
* \param drag_state current dragging status
* \param card_under_mouse the sketch card under the current mouse position or NULL if no card there
* \param highlighted_object_table the object's type (table) the mouse is hovering on
* \param cr cairo drawing context
*/
void gui_sketch_overlay_private_draw_create_mode( gui_sketch_overlay_t *this_,
const gui_sketch_drag_state_t *drag_state,
const gui_sketch_card_t *card_under_mouse,
data_table_t highlighted_object_table,
cairo_t *cr
);
/*!
* \brief draws an overlay arrow for GUI_TOOL_CREATE mode to the cairo context
*
* \param this_ pointer to own object attributes
* \param from_x source x coordinate of the mouse pointer
* \param from_y source y coordinate of the mouse pointer
* \param to_x destination x coordinate of the mouse pointer
* \param to_y destination y coordinate of the mouse pointer
* \param cr cairo drawing context
*/
void gui_sketch_overlay_private_draw_arrow( gui_sketch_overlay_t *this_,
int32_t from_x,
int32_t from_y,
int32_t to_x,
int32_t to_y,
cairo_t *cr
);
/*!
* \brief draws an overlay icon for GUI_TOOL_CREATE mode to the cairo context
*
* \param this_ pointer to own object attributes
* \param x x coordinate of the mouse pointer
* \param y y coordinate of the mouse pointer
* \param with_arrow_option true if arrow and feature box shall be shown, false for classifier-box
* \param cr cairo drawing context
*/
void gui_sketch_overlay_private_draw_create_icon( gui_sketch_overlay_t *this_,
int32_t x,
int32_t y,
bool with_arrow_option,
cairo_t *cr
);
/*!
* \brief draws overlay graphics to visualize the grid to the cairo context
*
* \param this_ pointer to own object attributes
* \param card_under_mouse the sketch card under the current mouse position, not NULL
* \param cr cairo drawing context
*/
void gui_sketch_overlay_private_draw_grid( gui_sketch_overlay_t *this_,
const gui_sketch_card_t *card_under_mouse,
cairo_t *cr
);
/*!
* \brief draws overlay graphics to visualize the snapped-to-grid to the cairo context
*
* \param this_ pointer to own object attributes
* \param card_under_mouse the sketch card under the current mouse position, not NULL
* \param snapped flags indicating if the current cursor position is snapped
* \param x actual pointer position
* \param y actual pointer position
* \param cr cairo drawing context
*/
void gui_sketch_overlay_private_draw_snap_indicator( gui_sketch_overlay_t *this_,
const gui_sketch_card_t *card_under_mouse,
gui_sketch_snap_state_t snapped,
int32_t x,
int32_t y,
cairo_t *cr
);
#endif /* GUI_SKETCH_OVERLAY_H */
/*
Copyright 2017-2023 Andreas Warnke
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
|