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

Detailed Description

A standalone CluViz view shown in its own window.

Public Member Functions

 View ()
 Default constructor. More...
 
 !View ()
 Finalizer. More...
 
 ~View ()
 Destructor. More...
 
void ClearScript ()
 Clears the script and loads a default script. More...
 
void Create (int iX, int iY, int iWidth, int iHeight, String^ sTitle, bool bResizable, bool bCaption, bool bSysMenu, bool bTopMost)
 Creates this view. More...
 
void Create (int iX, int iY, int iWidth, int iHeight, String^ sTitle, unsigned __int64 uIconHandle, bool bResizable, bool bCaption, bool bSysMenu, bool bTopMost, bool bTool)
 Creates this view. More...
 
void CreateDebug (int iX, int iY, int iWidth, int iHeight, String^ sTitle, bool bResizable, bool bCaption, bool bSysMenu, bool bTopMost)
 Creates this view as debug. More...
 
void CreateDebug (int iX, int iY, int iWidth, int iHeight, String^ sTitle, unsigned __int64 uIconHandle, bool bResizable, bool bCaption, bool bSysMenu, bool bTopMost, bool bTool)
 Creates this view as debug. More...
 
void Destroy ()
 Destroys and closes this view. More...
 
void ExecScript (String^ sMessage)
 Executes the script operation. More...
 
void FullScreen (bool bEnable, bool bEnableUserToggle)
 Enables or disables full screen mode. More...
 
unsigned __int64 GetIconHandle (String^ sFilename, bool bModule)
 Loads an icon file and returns the handle to the loaded icon. This handle can be passed to Create to show a window icon. More...
 
void GetVarColor (String^ sVarName, Drawing::Color^ %colValue)
 Gets the value of variable. More...
 
void GetVarImage (String^ sVarName, Rx::InteropNet::Runtime28::IImage^ imgValue)
 Gets the value of variable. More...
 
void GetVarNumber (String^ sVarName, int% iValue)
 Gets the value of variable. More...
 
void GetVarNumber (String^ sVarName, double% dValue)
 Gets the value of variable. More...
 
void GetVarString (String^ sVarName, String^ %sValue)
 Gets the value of variable. More...
 
void GetVarTensor (String^ sVarName, array< int >^%aiDim, array< double >^%adValue)
 Gets the value of variable. More...
 
void Hide ()
 Hides this view. More...
 
void LoadScript (String^ sScriptFile)
 Loads a script. More...
 
void LoadScript (String^ sScriptFile, String^ sPass)
 Loads a script. More...
 
void LoadScript (String^ sScriptFile, String^ sPass, array< String^ >^asArgs)
 Loads a script. More...
 
void SetPosSize (int iX, int iY, int iWidth, int iHeight)
 Sets the position and the size of this view. More...
 
void SetScript (String^ sScript)
 Sets the script as a string. More...
 
void SetVarColor (String^ sVarName, Drawing::Color^ colValue)
 Sets the value of a variable. More...
 
void SetVarImage (String^ sVarName, Rx::InteropNet::Runtime28::IImage^ imgValue)
 Sets the value of a variable. More...
 
void SetVarNumber (String^ sVarName, int iValue)
 Sets the value of a variable. More...
 
void SetVarNumber (String^ sVarName, double dValue)
 Sets the value of a variable. More...
 
void SetVarString (String^ sVarName, String^ sValue)
 Sets the value of a variable. More...
 
void SetVarTensor (String^ sVarName, array< int >^aiDim, array< double >^adData)
 Sets the value of a variable. More...
 
void Show ()
 Shows this view. More...
 
void WaitForVarTrue (String^ sVarName)
 Wait for variable to become "true". More...
 

Protected Member Functions

void SetLastError ()
 Sets the last error. More...
 

Protected Attributes

int m_iHandle
 The internal handle. More...
 
System::Threading::Mutex^ m_Lock
 The internal lock. More...
 

Properties

int AccessTimeout
 Gets or sets the access timeout. If an operation has to wait longer than this value, an exception is thrown. More...
 
bool IsValid [get]
 Gets a value indicating whether this view has been created. More...
 
String^  LastError
 Gets the last error. More...
 

Constructor & Destructor Documentation

CLUViz::Net::View::View ( )

Default constructor.

CLUViz::Net::View::~View ( )

Destructor.

CLUViz::Net::View::!View ( )

Finalizer.

Member Function Documentation

void CLUViz::Net::View::ClearScript ( )

Clears the script and loads a default script.

void CLUViz::Net::View::Create ( int  iX,
int  iY,
int  iWidth,
int  iHeight,
String^  sTitle,
bool  bResizable,
bool  bCaption,
bool  bSysMenu,
bool  bTopMost 
)

Creates this view.

Parameters
iXThe X position of the window on the screen.
iYThe Y position of the window on the screen.
iWidthThe width of the window.
iHeightThe height of the window.
sTitle[in] The window title.
bResizableThe window has a sizing border.
bCaptionThe window has a title bar.
bSysMenuThe window has a window menu on its title bar. The bCaption must also be true.
bTopMostThe window should be placed above all non-topmost windows and should stay above them, even when the window is deactivated.
void CLUViz::Net::View::Create ( int  iX,
int  iY,
int  iWidth,
int  iHeight,
String^  sTitle,
unsigned __int64  uIconHandle,
bool  bResizable,
bool  bCaption,
bool  bSysMenu,
bool  bTopMost,
bool  bTool 
)

Creates this view.

Parameters
iXThe X position of the window on the screen.
iYThe Y position of the window on the screen.
iWidthThe width of the window.
iHeightThe height of the window.
sTitle[in] The window title.
uIconHandleHandle of the icon.
bResizableThe window has a sizing border.
bCaptionThe window has a title bar.
bSysMenuThe window has a window menu on its title bar. The bCaption must also be true.
bTopMostThe window should be placed above all non-topmost windows and should stay above them, even when the window is deactivated.
bToolTrue if the window is a tool window. The window is intended to be used as a floating toolbar. A tool window has a title bar that is shorter than a normal title bar, and the window title is drawn using a smaller font. A tool window does not appear in the task bar or in the dialog that appears when the user presses ALT+TAB. If a tool window has a system menu, its icon is not displayed on the title bar. However, you can display the system menu by right-clicking or by typing ALT+SPACE.
void CLUViz::Net::View::CreateDebug ( int  iX,
int  iY,
int  iWidth,
int  iHeight,
String^  sTitle,
bool  bResizable,
bool  bCaption,
bool  bSysMenu,
bool  bTopMost 
)

Creates this view as debug.

Parameters
iXThe X position of the window on the screen.
iYThe Y position of the window on the screen.
iWidthThe width of the window.
iHeightThe height of the window.
sTitle[in] The window title.
bResizableThe window has a sizing border.
bCaptionThe window has a title bar.
bSysMenuThe window has a window menu on its title bar. The bCaption must also be true.
bTopMostThe window should be placed above all non-topmost windows and should stay above them, even when the window is deactivated.
void CLUViz::Net::View::CreateDebug ( int  iX,
int  iY,
int  iWidth,
int  iHeight,
String^  sTitle,
unsigned __int64  uIconHandle,
bool  bResizable,
bool  bCaption,
bool  bSysMenu,
bool  bTopMost,
bool  bTool 
)

Creates this view as debug.

Parameters
iXThe X position of the window on the screen.
iYThe Y position of the window on the screen.
iWidthThe width of the window.
iHeightThe height of the window.
sTitle[in] The window title.
uIconHandleHandle of the icon.
bResizableThe window has a sizing border.
bCaptionThe window has a title bar.
bSysMenuThe window has a window menu on its title bar. The bCaption must also be true.
bTopMostThe window should be placed above all non-topmost windows and should stay above them, even when the window is deactivated.
bToolTrue if the window is a tool window. The window is intended to be used as a floating toolbar. A tool window has a title bar that is shorter than a normal title bar, and the window title is drawn using a smaller font. A tool window does not appear in the task bar or in the dialog that appears when the user presses ALT+TAB. If a tool window has a system menu, its icon is not displayed on the title bar. However, you can display the system menu by right-clicking or by typing ALT+SPACE.
void CLUViz::Net::View::Destroy ( )

Destroys and closes this view.

void CLUViz::Net::View::ExecScript ( String^  sMessage)

Executes the script operation.

Parameters
sMessage[in] The message to execute.
void CLUViz::Net::View::FullScreen ( bool  bEnable,
bool  bEnableUserToggle 
)

Enables or disables full screen mode.

Parameters
bEnableTrue to enable, false to disable.
bEnableUserToggleTrue to enable disabling of full screen via ESC key.
unsigned __int64 CLUViz::Net::View::GetIconHandle ( String^  sFilename,
bool  bModule 
)

Loads an icon file and returns the handle to the loaded icon. This handle can be passed to Create to show a window icon.

Parameters
sFilename[in] The file name.
bModuleTrue if the given file is a module and not an icon file.
Returns
The icon handle.
void CLUViz::Net::View::GetVarColor ( String^  sVarName,
Drawing::Color^ %  colValue 
)

Gets the value of variable.

Parameters
sVarName[in] The name of the variable.
colValue[out] The value.
void CLUViz::Net::View::GetVarImage ( String^  sVarName,
Rx::InteropNet::Runtime28::IImage imgValue 
)

Gets the value of variable.

Parameters
sVarName[in] The name of the variable.
imgValue[out] The value.
void CLUViz::Net::View::GetVarNumber ( String^  sVarName,
int%  iValue 
)

Gets the value of variable.

Parameters
sVarName[in] The name of the variable.
iValue[out] The value.
void CLUViz::Net::View::GetVarNumber ( String^  sVarName,
double%  dValue 
)

Gets the value of variable.

Parameters
sVarName[in] The name of the variable.
dValue[out] The value.
void CLUViz::Net::View::GetVarString ( String^  sVarName,
String^ %  sValue 
)

Gets the value of variable.

Parameters
sVarName[in] The name of the variable.
sValue[out] The value.
void CLUViz::Net::View::GetVarTensor ( String^  sVarName,
array< int >^%  aiDim,
array< double >^%  adValue 
)

Gets the value of variable.

Parameters
sVarName[in] The name of the variable.
aiDim[out] The dimension of the tensor.
adValue[out] The tensor values.
void CLUViz::Net::View::Hide ( )

Hides this view.

void CLUViz::Net::View::LoadScript ( String^  sScriptFile)

Loads a script.

Parameters
sScriptFile[in] The script file.
void CLUViz::Net::View::LoadScript ( String^  sScriptFile,
String^  sPass 
)

Loads a script.

Parameters
sScriptFile[in] The script file.
sPass[in] The password of the script (if encrypted).
void CLUViz::Net::View::LoadScript ( String^  sScriptFile,
String^  sPass,
array< String^ >^  asArgs 
)

Loads a script.

Parameters
sScriptFile[in] The script file.
sPass[in] The password of the script (if encrypted).
asArgs[in] Array of arguments passed to the script. Can be null.
void CLUViz::Net::View::SetLastError ( )
protected

Sets the last error.

void CLUViz::Net::View::SetPosSize ( int  iX,
int  iY,
int  iWidth,
int  iHeight 
)

Sets the position and the size of this view.

Parameters
iXThe X position of the window on the screen.
iYThe Y position of the window on the screen.
iWidthThe width of the window.
iHeightThe height of the window.
void CLUViz::Net::View::SetScript ( String^  sScript)

Sets the script as a string.

Parameters
sScript[in] The script content.
void CLUViz::Net::View::SetVarColor ( String^  sVarName,
Drawing::Color^  colValue 
)

Sets the value of a variable.

Parameters
sVarName[in] The name of the variable.
colValue[in] The value.
void CLUViz::Net::View::SetVarImage ( String^  sVarName,
Rx::InteropNet::Runtime28::IImage imgValue 
)

Sets the value of a variable.

Parameters
sVarName[in] The name of the variable.
imgValue[in] The value.
void CLUViz::Net::View::SetVarNumber ( String^  sVarName,
int  iValue 
)

Sets the value of a variable.

Parameters
sVarName[in] The name of the variable.
iValue[in] The value.
void CLUViz::Net::View::SetVarNumber ( String^  sVarName,
double  dValue 
)

Sets the value of a variable.

Parameters
sVarName[in] The name of the variable.
dValue[in] The value.
void CLUViz::Net::View::SetVarString ( String^  sVarName,
String^  sValue 
)

Sets the value of a variable.

Parameters
sVarName[in] The name of the variable.
sValue[in] The value.
void CLUViz::Net::View::SetVarTensor ( String^  sVarName,
array< int >^  aiDim,
array< double >^  adData 
)

Sets the value of a variable.

Parameters
sVarName[in] The name of the variable.
aiDim[in] The dimension of the tensor.
adData[in] The values of the tensor.
void CLUViz::Net::View::Show ( )

Shows this view.

void CLUViz::Net::View::WaitForVarTrue ( String^  sVarName)

Wait for variable to become "true".

Parameters
sVarName[in] The name of the variable.

Member Data Documentation

int CLUViz::Net::View::m_iHandle
protected

The internal handle.

System::Threading::Mutex ^ CLUViz::Net::View::m_Lock
protected

The internal lock.

Property Documentation

int CLUViz::Net::View::AccessTimeout

Gets or sets the access timeout. If an operation has to wait longer than this value, an exception is thrown.

bool CLUViz::Net::View::IsValid
get

Gets a value indicating whether this view has been created.

String^ CLUViz::Net::View::LastError

Gets the last error.