Raytrix Light Field SDK  v3.0
Logo
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events Groups Pages
CLUViz::Net::Engine Class Reference

Detailed Description

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

Public Member Functions

 Engine ()
 Default constructor. More...
 
 !Engine ()
 Finalizer. More...
 
 ~Engine ()
 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 Start ()
 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

bool IsRunning [get]
 Gets a value indicating whether the engine has been started or not. More...
 
System::String^  LastError
 Contains the error of the last function that has thrown an exception. More...
 
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::Engine::Engine ( )

Default constructor.

CLUViz::Net::Engine::~Engine ( )

Destructor.

CLUViz::Net::Engine::!Engine ( )

Finalizer.

Member Function Documentation

void CLUViz::Net::Engine::DestroyAllViews ( )

Destroys all opened CluVis views.

void CLUViz::Net::Engine::End ( )

Ends the CluViz engine.

void CLUViz::Net::Engine::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::Engine::Start ( )

Starts the CluViz engine.

void CLUViz::Net::Engine::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::Engine::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

bool CLUViz::Net::Engine::IsRunning
get

Gets a value indicating whether the engine has been started or not.

System:: String^ CLUViz::Net::Engine::LastError

Contains the error of the last function that has thrown an exception.

System:: String^ CLUViz::Net::Engine::ScriptPath
getset

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