Template:GraphDisplayMethods - Revision history

Mellinger: /* InvalidateRect(GUI::Rect) */

2011-10-13T19:04:19Z

InvalidateRect(GUI::Rect)

← Older revision		Revision as of 19:04, 13 October 2011
Line 9:		Line 9:
	Marks the entire <tt>GraphDisplay</tt> area for repainting.		Marks the entire <tt>GraphDisplay</tt> area for repainting.
	===InvalidateRect(GUI::Rect)===		===InvalidateRect(GUI::Rect)===
	Marks a rectangle within the <tt>GraphDisplay</tt> for repainting. The rectangle is given in normalized coordinates.		Marks a rectangle within the <tt>GraphDisplay</tt> for repainting. The rectangle is given in screen pixel coordinates.

			'''NOTE:''' The use of pixel coordinates has been introduced in [http://www.bci2000.org/tracproj/changeset/3599 rev 3599] to avoid artifacts from converting forth and back between normalized and pixel coordinates. Originally, the rectangle was specified in normalized coordinates.

	===Update()===		===Update()===
	Forces an immediate repaint of all invalidated areas in the <tt>GraphDisplay</tt>, making sure that changes in <tt>GraphObject</tt> state are reflected in the device's frame buffer. In BCI2000 application modules, this function should be called immediately before setting the [[User_Reference:Timing#Measuring_Source-to-Stimulus_Delay\|StimulusTime]] time stamp.		Forces an immediate repaint of all invalidated areas in the <tt>GraphDisplay</tt>, making sure that changes in <tt>GraphObject</tt> state are reflected in the device's frame buffer. In BCI2000 application modules, this function should be called immediately before setting the [[User_Reference:Timing#Measuring_Source-to-Stimulus_Delay\|StimulusTime]] time stamp.

Mellinger: /* DeleteObjects() */

2011-07-07T12:21:00Z

DeleteObjects()

← Older revision		Revision as of 12:21, 7 July 2011
Line 4:		Line 4:
	-->		-->
	===DeleteObjects()===		===DeleteObjects()===
	Removes and deletes all ~~object~~ instances contained in the <tt>GraphDisplay</tt>.		Removes and deletes all <tt>GraphObject</tt> instances contained in the <tt>GraphDisplay</tt>.

	===Invalidate()===		===Invalidate()===
	Marks the entire <tt>GraphDisplay</tt> area for repainting.		Marks the entire <tt>GraphDisplay</tt> area for repainting.

Mellinger at 12:19, 7 July 2011

2011-07-07T12:19:55Z

← Older revision		Revision as of 12:19, 7 July 2011
Line 1:		Line 1:
			<!--Add and Remove are now private to avoid inconsistency of GraphObject::mDisplay
	===Add(GraphObject pointer), Remove(GraphObject pointer)===		===Add(GraphObject pointer), Remove(GraphObject pointer)===
	Adds or removes the specified <tt>GraphObject</tt> from the <tt>GraphDisplay</tt>.		Adds or removes the specified <tt>GraphObject</tt> from the <tt>GraphDisplay</tt>.
			-->
	===DeleteObjects()===		===DeleteObjects()===
	Removes and deletes all object instances contained in the <tt>GraphDisplay</tt>.		Removes and deletes all object instances contained in the <tt>GraphDisplay</tt>.

Mellinger at 13:32, 12 September 2008

2008-09-12T13:32:04Z

New page

===Add(GraphObject pointer), Remove(GraphObject pointer)===
Adds or removes the specified <tt>GraphObject</tt> from the <tt>GraphDisplay</tt>.
===DeleteObjects()===
Removes and deletes all object instances contained in the <tt>GraphDisplay</tt>.
===Invalidate()===
Marks the entire <tt>GraphDisplay</tt> area for repainting.
===InvalidateRect(GUI::Rect)===
Marks a rectangle within the <tt>GraphDisplay</tt> for repainting. The rectangle is given in normalized coordinates.
===Update()===
Forces an immediate repaint of all invalidated areas in the <tt>GraphDisplay</tt>, making sure that changes in <tt>GraphObject</tt> state are reflected in the device's frame buffer. In BCI2000 application modules, this function should be called immediately before setting the [[User_Reference:Timing#Measuring_Source-to-Stimulus_Delay|StimulusTime]] time stamp.

===GUI::Rect NormalizedToPixelCoordinates(GUI::Rect)===
===GUI::Rect PixelToNormalizedCoordinates(GUI::Rect)===
These functions are used to convert between pixel/device coordinates, and normalized coordinates. Note that, from application code, <tt>GraphObject</tt>s are positioned and sized using normalized coordinates relative to the <tt>GraphDisplay</tt>'s screen rectangle; in their <tt>OnPaint</tt> handlers, they are provided with pixel coordinates.

===Paint(RegionHandle=NULL)===
Triggers a repaint of the <tt>GraphDisplay</tt>'s contents. When a region handle is specified, it is used as a clip during the paint operation, saving redraw of the entire <tt>GraphDisplay</tt> area when only a subregion has become invalid.
===Change()===
Triggers a <tt>Change</tt> event for all <tt>GraphObjects</tt> that are part of the display. For modifications in size or draw context, this function is called automatically.
===Click(int x, int y)===
Triggers a <tt>Click</tt> event for all <tt>GraphObjects</tt> that are part of the display. Unlike <tt>GraphObject::OnClick()</tt>, coordinates are pixel coordinates.

===QueueOfGraphObjects ObjectsClicked()===
When the user clicks inside a <tt>GraphDisplay</tt>, all objects' <tt>Click</tt> events are called to determine which of them were below the mouse pointer when clicking. Objects that consider themselves clicked are added to a queue, which is of type <tt>std::queue<GraphObject*></tt>. This queue is accessible from the <tt>ObjectsClicked</tt> function; from the queue, clicked objects may be retrieved using its <tt>pop()</tt> member function.
===ClearClicks()===
Empties the queue of clicked objects.
===BitmapImage BitmapData(width=0, height=0)===
Returns the display's content, resampled to the specified target resolution, as a [[Programming Reference:BitmapImage Class|<tt>BitmapImage</tt>]]. When both width and height are 0 (the default), the image is returned in its original size, and no resampling takes place.