2 Copyright (C) 2003 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __ardour_imageframe_time_axis_group_h__
21 #define __ardour_imageframe_time_axis_group_h__
26 #include <gdkmm/color.h>
28 #include <jack/jack.h>
29 #include "ardour/types.h"
30 #include "imageframe_time_axis_view.h"
33 class ImageFrameView ;
36 * ImageFrameTimeAxisGroup defines a group/scene of ImageFrame view that can appear upon a time axis
37 * At the moment this is a bit bare, we really want to add some kind of time constraints upon
38 * items atht are added to the group, ie bounded by the start and end of the scene, which itself
40 * A viewable object may also be useful...
43 class ImageFrameTimeAxisGroup : public sigc::trackable
46 //---------------------------------------------------------------------------------------//
47 // Constructor / Desctructor
50 * Constructs a new ImageFrameTimeAxisGroup.
52 * @param iftav the parent ImageFrameTimeAxis of this view helper
53 * @param group_id the unique name/id of this group
55 ImageFrameTimeAxisGroup(ImageFrameTimeAxisView& iftav, const std::string & group_id) ;
59 * Responsible for destroying any Items that may have been added to this group
62 virtual ~ImageFrameTimeAxisGroup() ;
65 //---------------------------------------------------------------------------------------//
66 // Name/Id Accessors/Mutators
69 * Set the name/Id of this group.
71 * @param new_name the new name of this group
72 * @param src the identity of the object that initiated the change
74 void set_group_name(const std::string & new_name, void* src) ;
77 * Returns the id of this group
78 * The group id must be unique upon a time axis
80 * @return the id of this group
82 std::string get_group_name() const ;
85 //---------------------------------------------------------------------------------------//
86 // Parent/Child helper object accessors
89 * Returns the TimeAxisView thatt his object is acting as a helper for
91 * @return the TimeAxisView that this object is acting as a view helper for
93 ImageFrameTimeAxisView& get_view() const { return _view_helper ; }
97 //---------------------------------------------------------------------------------------//
101 * Sets the height of the time axis view and the item upon it
103 * @param height the new height
105 int set_item_heights(gdouble) ;
107 int set_item_frames_per_pixel (double);
110 * Sets the color of the items contained uopn this view helper
112 * @param color the new base color
114 void apply_item_color(Gdk::Color&) ;
117 //---------------------------------------------------------------------------------------//
118 // child ImageFrameView methods
121 * Adds an ImageFrameView to the list of items upon this time axis view helper
122 * the new ImageFrameView is returned
124 * @param item_id the unique id of the new item
125 * @param image_id the id/name of the image data we are usin
126 * @param start the position the new item should be placed upon the time line
127 * @param duration the duration the new item should be placed upon the timeline
128 * @param rgb_data the rgb data of the image
129 * @param width the original image width of the rgb_data (not the size to display)
130 * @param height the irigianl height of the rgb_data
131 * @param num_channels the number of channles within the rgb_data
132 * @param src the identity of the object that initiated the change
134 ImageFrameView* add_imageframe_item(const std::string & item_id, nframes_t start, nframes_t duration, unsigned char* rgb_data, uint32_t width, uint32_t height, uint32_t num_channels, void* src) ;
137 * Returns the named ImageFrameView or 0 if the named view does not exist on this view helper
139 * @param item_id the unique id of the item to search for
140 * @return the named ImageFrameView, or 0 if it is not held upon this view
142 ImageFrameView* get_named_imageframe_item(const std::string & item_id) ;
145 * Removes the currently selected ImageFrameView
147 * @param src the identity of the object that initiated the change
148 * @see add_imageframe_view
150 void remove_selected_imageframe_item(void* src) ;
153 * Removes and returns the named ImageFrameView from the list of ImageFrameViews held by this view helper
155 * @param item_id the ImageFrameView unique id to remove
156 * @param src the identity of the object that initiated the change
157 * @see add_imageframe_view
159 ImageFrameView* remove_named_imageframe_item(const std::string & item_id, void* src) ;
162 * Removes ifv from the list of ImageFrameViews upon this TimeAxis.
163 * if ifv is not upon this TimeAxis, this method takes no action
165 * @param ifv the ImageFrameView to remove
167 void remove_imageframe_item(ImageFrameView*, void* src) ;
170 //---------------------------------------------------------------------------------------//
171 // Selected group methods
174 // removed in favour of a track level selectewd item
175 // this is simply easier to manage a singularly selected item, rather than
176 // a selected item within each group
179 * Sets the currently selected item upon this time axis
181 * @param ifv the item to set selected
183 //void set_selected_imageframe_item(ImageFrameView* ifv) ;
186 * Sets the currently selected item upon this time axis to the named item
188 * @param item_id the name/id of the item to set selected
190 //void set_selected_imageframe_item(std::string item_id) ;
193 * Returns the currently selected item upon this time axis
195 * @return the currently selected item pon this time axis
197 //ImageFrameView* get_selected_imageframe_item() ;
200 * Returns whether this grou pis currently selected
202 * @returns true if this group is currently selected
204 bool get_selected() const ;
207 * Sets he selected state of this group
209 * @param yn set true if this group is selected, false otherwise
211 void set_selected(bool yn) ;
213 //---------------------------------------------------------------------------------------//
214 // Handle group removal
217 * Handles the Removal of this VisualTimeAxis
218 * This _needs_ to be called to alert others of the removal properly, ie where the source
219 * of the removal came from.
221 * XXX Although im not too happy about this method of doing things, I cant think of a cleaner method
222 * just now to capture the source of the removal
224 * @param src the identity of the object that initiated the change
226 virtual void remove_this_group(void* src) ;
228 //---------------------------------------------------------------------------------//
231 static sigc::signal<void,ImageFrameTimeAxisGroup*> CatchDeletion;
234 * Emitted when this Group has been removed
235 * This is different to the CatchDeletion signal in that this signal
236 * is emitted during the deletion of this Time Axis, and not during
237 * the destructor, this allows us to capture the source of the deletion
240 sigc::signal<void,std::string,void*> GroupRemoved ;
242 /** Emitted when we have changed the name of this TimeAxis */
243 sigc::signal<void,std::string,std::string,void*> NameChanged ;
245 /** Emitted when an ImageFrameView is added to this group */
246 sigc::signal<void, ImageFrameView*, void*> ImageFrameAdded ;
248 /** Emitted when an ImageFrameView is removed from this group */
249 sigc::signal<void, const std::string &, const std::string &, const std::string &, void*> ImageFrameRemoved ;
256 * convenience method to re-get the samples per unit and tell items upon this view
259 void reset_frames_per_pixel ();
262 * Callback used to remove this group during the gtk idle loop
263 * This is used to avoid deleting the obejct while inside the remove_this_group
266 * @param group the ImageFrameTimeAxisGroup to remove
267 * @param src the identity of the object that initiated the change
269 static gint idle_remove_this_group(ImageFrameTimeAxisGroup* group, void* src) ;
271 /** The list of ImageFrameViews held by this view helper */
272 typedef std::list<ImageFrameView *> ImageFrameViewList ;
273 ImageFrameViewList imageframe_views ;
275 /** the currently selected time axis item upon this time axis */
276 ImageFrameView* selected_imageframe_item ;
278 /** the view helper that this object is acting as a container upon on */
279 ImageFrameTimeAxisView& _view_helper ;
281 /** the is of this group */
282 std::string _group_id ;
284 /* XXX why are these different? */
285 Gdk::Color region_color ;
286 uint32_t stream_base_color ;
288 /** indicates if this group is currently selected */
291 } ; /* class ImageFrameTimeAxisGroup */
293 #endif /* __ardour_imageframe_time_axis_group_h__ */