CLUViz::Net::ToolViewForm Class Reference

Detailed Description

Summary for ToolViewForm.

Inherits Form.

Classes
struct	SCreateParams
	Create parameters. More...

Static Public Member Functions
static void	Destroy (int iHandle)
	Destroys the view described by iHandle. More...
static void	DestroyAll ()
	Destroys all handles. More...
static void	End ()
	Finalizes this CluViz Tool. Destroys all open views. More...
static void	Init (System::String^ sEnvironmentPath)
	Initializes the CluViz Tool with a custom environment path. More...
static void	SetImage (int iHandle, const Rx::Interop::Runtime28::IImage *pxImage, bool bUpdate)
	Sets the given image into the given view. More...
static int	ShowNew (SCreateParams^ xParams)
	Creates a new view window. More...

Protected Member Functions
	ToolViewForm (SCreateParams^ xParams)
	Default constructor. More...
	~ToolViewForm ()
	Clean up any resources being used. More...

Static Protected Member Functions
static void	_ApplicationRun (System::Object^ oParams)
	Creates a new form with the given parameters, adds it to the static dictionary and calls Application::Run(). More...

Protected Attributes
CLUViz::Net::ViewCtrl^	m_xViewCtrl
	The view control. More...

Static Protected Attributes
static Dictionary< int, ToolViewForm^ >^	sm_dictHandleToForm
	The static dictionary that maps a handle to the form. More...
static int	sm_iLastHandle
	The last created handle. More...
static CLUViz::Net::EngineCtrl^	sm_xEngine
	The engine instance. More...
static System::Threading::ManualResetEventSlim^	sm_xEvent
	The event that signals that a form has been created and added to the dictionary. More...

Constructor & Destructor Documentation

CLUViz::Net::ToolViewForm::ToolViewForm ( SCreateParams^  xParams )

inlineprotected

Default constructor.

Parameters

xParams

[in] If non-null, options for controlling the operation.

CLUViz::Net::ToolViewForm::~ToolViewForm ( )

inlineprotected

Clean up any resources being used.

Member Function Documentation

static void CLUViz::Net::ToolViewForm::_ApplicationRun ( System::Object^  oParams )

inlinestaticprotected

Creates a new form with the given parameters, adds it to the static dictionary and calls Application::Run().

Parameters

oParams

[in,out] If non-null, options for controlling the operation.

static void CLUViz::Net::ToolViewForm::Destroy ( int  iHandle )

inlinestatic

Destroys the view described by iHandle.

Parameters

iHandle

The window handled returned by ShowNew.

static void CLUViz::Net::ToolViewForm::DestroyAll ( )

inlinestatic

Destroys all handles.

static void CLUViz::Net::ToolViewForm::End ( )

inlinestatic

Finalizes this CluViz Tool. Destroys all open views.

static void CLUViz::Net::ToolViewForm::Init ( System::String^  sEnvironmentPath )

inlinestatic

Initializes the CluViz Tool with a custom environment path.

Parameters

sEnvironmentPath

[in] The custom environment path.

static void CLUViz::Net::ToolViewForm::SetImage ( int  iHandle, const Rx::Interop::Runtime28::IImage *  pxImage, bool  bUpdate  )

inlinestatic

Sets the given image into the given view.

Parameters

iHandle	The handle of the view.
pxImage	[in] The image.
bUpdate	True to update the image content. False to set a new image with a new image format.

static int CLUViz::Net::ToolViewForm::ShowNew ( SCreateParams^  xParams )

inlinestatic

Creates a new view window.

Parameters

xParams

[in] The creation parameter.

Returns

The handle of the created view.

Member Data Documentation

CLUViz::Net::ViewCtrl ^ CLUViz::Net::ToolViewForm::m_xViewCtrl

protected

The view control.

Dictionary<int, ToolViewForm^> ^ CLUViz::Net::ToolViewForm::sm_dictHandleToForm

staticprotected

The static dictionary that maps a handle to the form.

int CLUViz::Net::ToolViewForm::sm_iLastHandle

staticprotected

The last created handle.

CLUViz::Net::EngineCtrl ^ CLUViz::Net::ToolViewForm::sm_xEngine

staticprotected

The engine instance.

System::Threading::ManualResetEventSlim ^ CLUViz::Net::ToolViewForm::sm_xEvent

staticprotected

The event that signals that a form has been created and added to the dictionary.