Programming Reference:GraphDisplay Class - Revision history

Mellinger: /* ~GraphDisplay() */

2011-07-07T12:20:39Z

~GraphDisplay()

← Older revision		Revision as of 12:20, 7 July 2011
Line 13:		Line 13:
	Initializes a <tt>GraphDisplay</tt> object such that it is not bound to any device or window.		Initializes a <tt>GraphDisplay</tt> object such that it is not bound to any device or window.
	===~GraphDisplay()===		===~GraphDisplay()===
	The <tt>GraphDisplay</tt> destructor deletes all ~~objects~~ within the display.		The <tt>GraphDisplay</tt> destructor deletes all <tt>GraphObject</tt>s within the display.
	{{GraphDisplayMethods}}		{{GraphDisplayMethods}}

Mellinger: /* Synopsis */

2008-09-12T15:15:47Z

Synopsis

← Older revision		Revision as of 15:15, 12 September 2008
Line 6:		Line 6:

	<tt>GraphDisplay</tt> does not make assumptions on output device (screen, printer) or whether it refers to an entire window, or a rectangle within a larger window.		<tt>GraphDisplay</tt> does not make assumptions on output device (screen, printer) or whether it refers to an entire window, or a rectangle within a larger window.

			{{NamespaceRemark\|namespace=GUI\|class=GraphDisplay}}

	==Methods==		==Methods==

Mellinger: /* Properties */

2008-09-12T13:34:17Z

Properties

← Older revision		Revision as of 13:34, 12 September 2008
Line 15:		Line 15:

	==Properties==		==Properties==
	~~===GUI::DrawContext Context (rw)===~~		{{GraphDisplayProperties}}
	~~The draw context into which a <tt>GraphDisplay</tt> is supposed to render the <tt>GraphObject</tt>s it contains.~~
	~~A draw context consists of a handle to an output device context (HDC in Windows), and a rectangle within that device context's area.~~
	~~===RGBColor Color (rw)===~~
	~~The <tt>GraphDisplay</tt>'s background color.~~

	==See also==		==See also==

Mellinger: /* Methods */

2008-09-12T13:32:21Z

Methods

@@ Line 12: / Line 12: @@
 ===~GraphDisplay()===
 The <tt>GraphDisplay</tt> destructor deletes all objects within the display.
-===Add(GraphObject pointer), Remove(GraphObject pointer)===
+{{GraphDisplayMethods}}
 ==Properties==

Mellinger at 12:40, 12 September 2008

2008-09-12T12:40:50Z

@@ Line 22: / Line 22: @@
 ===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)===
@@ Line 40: / Line 33: @@
 ===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.
 ==Properties==

Mellinger: /* Update() */

2008-09-12T08:38:45Z

Update()

← Older revision		Revision as of 08:38, 12 September 2008
Line 21:		Line 21:
	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 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 ~~Display~~#~~StimulusTime~~\|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.

	===QueueOfGraphObjects ObjectsClicked()===		===QueueOfGraphObjects ObjectsClicked()===

Mellinger: /* GUI::Rect NormalizedToPixelCoordinates(GUI::Rect), GUI::Rect PixelToNormalizedCoordinates(GUI::Rect) */

2008-09-12T08:38:28Z

GUI::Rect NormalizedToPixelCoordinates(GUI::Rect), GUI::Rect PixelToNormalizedCoordinates(GUI::Rect)

← Older revision		Revision as of 08:38, 12 September 2008
Line 30:		Line 30:
	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.		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.

	===GUI::Rect NormalizedToPixelCoordinates(GUI::Rect), GUI::Rect PixelToNormalizedCoordinates(GUI::Rect)===		===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.		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.

Mellinger at 08:37, 12 September 2008

2008-09-12T08:37:18Z

New page

==Location==
<tt>src/shared/gui</tt>

==Synopsis==
An object of type <tt>GraphDisplay</tt> refers to a graphical output rectangle, and a set of [[Programming Reference:GraphObject Class|graphical objects]] that are displayed within that rectangle.

<tt>GraphDisplay</tt> does not make assumptions on output device (screen, printer) or whether it refers to an entire window, or a rectangle within a larger window.

==Methods==
===GraphDisplay()===
Initializes a <tt>GraphDisplay</tt> object such that it is not bound to any device or window.
===~GraphDisplay()===
The <tt>GraphDisplay</tt> destructor deletes all objects within the display.
===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 Display#StimulusTime|StimulusTime]] time stamp.

===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.

===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.

==Properties==
===GUI::DrawContext Context (rw)===
The draw context into which a <tt>GraphDisplay</tt> is supposed to render the <tt>GraphObject</tt>s it contains.
A draw context consists of a handle to an output device context (HDC in Windows), and a rectangle within that device context's area.
===RGBColor Color (rw)===
The <tt>GraphDisplay</tt>'s background color.

==See also==
[[Programming Reference:GraphObject Class]], [[Programming Reference:DisplayWindow Class]]

[[Category:Framework API]][[Category:Development]]