C# Class OpenCvSharp.Window

Wrapper of HighGUI window

Inheritance: DisposableObject

Mostra file Open project: shimat/opencvsharp Class Usage Examples

Private Properties

Property	Type	Description
DefaultName	string

Public Methods

Method	Description
Close ( ) : void	Destroys this window.
CreateTrackbar ( string name, CvTrackbarCallback2 callback ) : OpenCvSharp.CvTrackbar	Creates the trackbar and attaches it to this window
CreateTrackbar ( string name, int value, int max, CvTrackbarCallback2 callback ) : OpenCvSharp.CvTrackbar	Creates the trackbar and attaches it to this window
CreateTrackbar2 ( string name, int value, int max, CvTrackbarCallback2 callback, object userdata ) : OpenCvSharp.CvTrackbar	Creates the trackbar and attaches it to this window
DestroyAllWindows ( ) : void	Destroys all the opened HighGUI windows.
DisplayOverlay ( string text, int delayms ) : void	Display text on the window's image as an overlay for delay milliseconds. This is not editing the image's data. The text is display on the top of the image.
DisplayStatusBar ( string text, int delayms ) : void
GetProperty ( WindowProperty propId ) : double	Get Property of the window
GetWindowByName ( string name ) : Window	Retrieves a created window by name
LoadWindowParameters ( ) : void	Load parameters of the window.
Move ( int x, int y ) : void	Sets window position
Resize ( int width, int height ) : void	Sets window size
SaveWindowParameters ( ) : void	Save parameters of the window.
SetProperty ( WindowProperty propId, double propValue ) : void	Set Property of the window
ShowImage ( OpenCvSharp.Mat img ) : void	Shows the image in this window
ShowImages ( ) : void
ShowImages ( IEnumerable images, IEnumerable names ) : void
WaitKey ( ) : int	Waits for a pressed key
WaitKey ( int delay ) : int	Waits for a pressed key
Window ( ) : System	Creates a window with a random name
Window ( OpenCvSharp.Mat image ) : System	Creates a window with a random name and a specified image
Window ( WindowMode flags, OpenCvSharp.Mat image ) : System	Creates a window with a specified image and flag
Window ( string name ) : System	Creates a window
Window ( string name, OpenCvSharp.Mat image ) : System	Creates a window
Window ( string name, WindowMode flags ) : System	Creates a window
Window ( string name, WindowMode flags, OpenCvSharp.Mat image ) : System	Creates a window

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Clean up any resources being used.

Private Methods

Method	Description
DefaultName ( ) : string	ウィンドウ名が指定されなかったときに、適当な名前を作成して返す.

Method Details

Close() public method

Destroys this window.

public Close ( ) : void
return	void

CreateTrackbar() public method

Creates the trackbar and attaches it to this window

public CreateTrackbar ( string name, CvTrackbarCallback2 callback ) : OpenCvSharp.CvTrackbar
name	string	Name of created trackbar.
callback	CvTrackbarCallback2	the function to be called every time the slider changes the position. This function should be prototyped as void Foo(int);
return	OpenCvSharp.CvTrackbar

CreateTrackbar() public method

Creates the trackbar and attaches it to this window

public CreateTrackbar ( string name, int value, int max, CvTrackbarCallback2 callback ) : OpenCvSharp.CvTrackbar
name	string	Name of created trackbar.
value	int	The position of the slider
max	int	Maximal position of the slider. Minimal position is always 0.
callback	CvTrackbarCallback2	the function to be called every time the slider changes the position. This function should be prototyped as void Foo(int);
return	OpenCvSharp.CvTrackbar

CreateTrackbar2() public method

Creates the trackbar and attaches it to this window

public CreateTrackbar2 ( string name, int value, int max, CvTrackbarCallback2 callback, object userdata ) : OpenCvSharp.CvTrackbar
name	string	Name of created trackbar.
value	int	The position of the slider
max	int	Maximal position of the slider. Minimal position is always 0.
callback	CvTrackbarCallback2	the function to be called every time the slider changes the position. This function should be prototyped as void Foo(int);
userdata	object
return	OpenCvSharp.CvTrackbar

DestroyAllWindows() public static method

Destroys all the opened HighGUI windows.

public static DestroyAllWindows ( ) : void
return	void

DisplayOverlay() public method

Display text on the window's image as an overlay for delay milliseconds. This is not editing the image's data. The text is display on the top of the image.

public DisplayOverlay ( string text, int delayms ) : void
text	string	Overlay text to write on the window’s image
delayms	int	Delay to display the overlay text. If this function is called before the previous overlay text time out, the timer is restarted and the text updated. . If this value is zero, the text never disapers.
return	void

DisplayStatusBar() public method

public DisplayStatusBar ( string text, int delayms ) : void
text	string	Text to write on the window’s statusbar
delayms	int	Delay to display the text. If this function is called before the previous text time out, the timer is restarted and the text updated. If this value is zero, the text never disapers.
return	void

Dispose() protected method

Clean up any resources being used.

protected Dispose ( bool disposing ) : void
disposing	bool	/// If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. /// If false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed. ///
return	void

GetProperty() public method

Get Property of the window

public GetProperty ( WindowProperty propId ) : double
propId	WindowProperty	Property identifier
return	double

GetWindowByName() public static method

Retrieves a created window by name

public static GetWindowByName ( string name ) : Window
name	string
return	Window

LoadWindowParameters() public method

Load parameters of the window.

public LoadWindowParameters ( ) : void
return	void

Move() public method

Sets window position

public Move ( int x, int y ) : void
x	int	New x coordinate of top-left corner
y	int	New y coordinate of top-left corner
return	void

Resize() public method

Sets window size

public Resize ( int width, int height ) : void
width	int	New width
height	int	New height
return	void

SaveWindowParameters() public method

Save parameters of the window.

public SaveWindowParameters ( ) : void
return	void

SetProperty() public method

Set Property of the window

public SetProperty ( WindowProperty propId, double propValue ) : void
propId	WindowProperty	Property identifier
propValue	double	New value of the specified property
return	void

ShowImage() public method

Shows the image in this window

public ShowImage ( OpenCvSharp.Mat img ) : void
img	OpenCvSharp.Mat	Image to be shown.
return	void

ShowImages() public static method

public static ShowImages ( ) : void
return	void

ShowImages() public static method

public static ShowImages ( IEnumerable images, IEnumerable names ) : void
images	IEnumerable
names	IEnumerable
return	void

WaitKey() public static method

Waits for a pressed key

public static WaitKey ( ) : int
return	int

WaitKey() public static method

Waits for a pressed key

public static WaitKey ( int delay ) : int
delay	int	Delay in milliseconds.
return	int

Window() public method

Creates a window with a random name

public Window ( ) : System
return	System

Window() public method

Creates a window with a random name and a specified image

public Window ( OpenCvSharp.Mat image ) : System
image	OpenCvSharp.Mat
return	System

Window() public method

Creates a window with a specified image and flag

public Window ( WindowMode flags, OpenCvSharp.Mat image ) : System
flags	WindowMode	Flags of the window. Currently the only supported flag is WindowMode.AutoSize. /// If it is set, window size is automatically adjusted to fit the displayed image (see cvShowImage), while user can not change the window size manually.
image	OpenCvSharp.Mat
return	System

Window() public method

Creates a window

public Window ( string name ) : System
name	string	Name of the window which is used as window identifier and appears in the window caption.
return	System

Window() public method

Creates a window

public Window ( string name, OpenCvSharp.Mat image ) : System
name	string	Name of the window which is used as window identifier and appears in the window caption.
image	OpenCvSharp.Mat	Image to be shown.
return	System

Window() public method

Creates a window

public Window ( string name, WindowMode flags ) : System
name	string	Name of the window which is used as window identifier and appears in the window caption.
flags	WindowMode	Flags of the window. Currently the only supported flag is WindowMode.AutoSize. /// If it is set, window size is automatically adjusted to fit the displayed image (see cvShowImage), while user can not change the window size manually.
return	System

Window() public method

Creates a window

public Window ( string name, WindowMode flags, OpenCvSharp.Mat image ) : System
name	string	Name of the window which is used as window identifier and appears in the window caption.
flags	WindowMode	Flags of the window. Currently the only supported flag is WindowMode.AutoSize. /// If it is set, window size is automatically adjusted to fit the displayed image (see cvShowImage), while user can not change the window size manually.
image	OpenCvSharp.Mat	Image to be shown.
return	System