CLUViz::Net::EngineCtrl Class Reference

Detailed Description

CluViz engine class that is required for initializing and finalizing of CluViz in a single thread environment.

Public Member Functions
	EngineCtrl ()
	Default constructor. More...
	!EngineCtrl ()
	Finalizer. More...
virtual	~EngineCtrl ()
	Destructor. More...
void	DestroyAllViews ()
	Destroys all opened CluVis views. More...
void	End ()
	Ends the CluViz engine. More...
void	GetKey (array< long >^%aKey)
	Gets the internal license key. This function is only for compatibility. More...
void	SetStandardScriptPath ()
	Sets the script path to the default script path of this runtime environment. More...
void	Start ()
	Starts the CluViz engine. More...
void	Start (System::String^ sEnvPath)
	Starts the CluViz engine. More...
void	Start (System::String^ sEnvPath, System::String^ sLicenceKey)
	Starts the CluViz engine. More...
void	Start (System::String^ sEnvPath, array< long >^alLicenceKey)
	Starts the CluViz engine. More...

Properties
System::String^	ScriptPath [get, set]
	Gets or sets the script path. This path is used as the root path for loading scripts. More...

Constructor & Destructor Documentation

CLUViz::Net::EngineCtrl::EngineCtrl

(

)

Default constructor.

virtual CLUViz::Net::EngineCtrl::~EngineCtrl ( )

virtual

Destructor.

CLUViz::Net::EngineCtrl::!EngineCtrl

(

)

Finalizer.

Member Function Documentation

void CLUViz::Net::EngineCtrl::DestroyAllViews

(

)

Destroys all opened CluVis views.

void CLUViz::Net::EngineCtrl::End

(

)

Ends the CluViz engine.

void CLUViz::Net::EngineCtrl::GetKey

(

array< long >^%

aKey

)

Gets the internal license key. This function is only for compatibility.

Parameters

aKey	[out] The array that should store the returned key. Must be of length 4.

void CLUViz::Net::EngineCtrl::SetStandardScriptPath

(

)

Sets the script path to the default script path of this runtime environment.

void CLUViz::Net::EngineCtrl::Start

(

)

Starts the CluViz engine.

void CLUViz::Net::EngineCtrl::Start

(

System::String^

sEnvPath

)

Starts the CluViz engine.

Parameters

sEnvPath

[in] The environment path. Should be "". This parameter is only for compatibility.

void CLUViz::Net::EngineCtrl::Start	(	System::String^	sEnvPath,
		System::String^	sLicenceKey
	)

Starts the CluViz engine.

Parameters

sEnvPath	[in] The environment path. Should be "". This parameter is only for compatibility.
sLicenceKey	[in] The license key. Should be "". This parameter is only for compatibility.

void CLUViz::Net::EngineCtrl::Start	(	System::String^	sEnvPath,
		array< long >^	alLicenceKey
	)

Starts the CluViz engine.

Parameters

sEnvPath	[in] The environment path. Should be "". This parameter is only for compatibility.
alLicenceKey	[in] The license key. Should be empty but not null. This parameter is only for compatibility.

Property Documentation

System:: String^ CLUViz::Net::EngineCtrl::ScriptPath

getset

Gets or sets the script path. This path is used as the root path for loading scripts.