"Rx.CluVizNet.Core"

Creates color circle list.

[out] the object. [in] list of circles. The color. true to enable, false to disable the part picking.

Creates color arrow list.

[in,out] If non-null, the object. [in,out] If non-null, list of arrows. true to use picking.

Creates a VBO from a color arrow list.

[out] The Object to store the VBO Data [in] List of arrows. true to use picking.

Create an Overlay based on given EllipseData.

[in] If non-null, information describing the ellipse. [in] If non-null, the colors. true to use picking. The z coordinate position.

Gets or sets a factor that is applied to each vertex. Default is 1.

Default constructor.

A view tool base helper.

The standard VBO moniker

The view control

Loads the provided tool script. You have to override this method in your derived implementation.

Initializes this ViewToolBase

Destructor

Gets or sets the number of edges that describes a circle. The higher the number the slower the drawing. Default: 32.

Detaches this ViewToolBase from the last view control. This resets the loaded script and makes this class invalid.

The detached view control. Can be null

Attaches to the given view control. Detaches from last view control by calling Detach. Loads the provided tool script.

[in] The view control.

Gets the view control that has this ViewToolBase attached.

Gets a value indicating whether this ViewToolBase is valid. This base is valid if ViewToolBase or AttachTo has been called with a valid reference to a ViewCtrl.

Constructor that attaches to the given view control. See .

[in] The view control to attach to.

Default constructor.

To make the instance valid, you have to call AttachTo with a valid reference to a view control. \addtogroup RxNET_CluViz @{

Base implementation of CluViz view tools. This class provides base features to load a certain view tool script into a given CluViz view control and provides capabilities to draw objects into loaded the script.

The handled lock.

Unlocks the assigned mutex manually.

Locks the assigned mutex manually. Throws an exception if a timeout has been given and has been expired.

(Optional) Timeout in milliseconds. -1 will wait infinetly.

Destructor. Unlocks the given lock. If the lock isn't locked, this destructor will do nothing.

Constructor. Locks the given lock until this object gets destroyed. Throws an exception if a timeout has been given and has been expired.

[in] The lock. (Optional) Timeout in milliseconds. -1 will wait infinetly.

A class to provide scope wide lock capabilities. You can create an instance of this class by providing a mutex that is instantly locked. The mutex is automatically unlocked if the object leaves its scope (by default or through an exception).

Unlocks this CRxMutex. If the mutex isn't locked, this function will do nothing.

Tries to lock the mutex for milliseconds. If is equal to -1, this function will wait infinetly.

(optional) Timeout in milliseconds. False on timeout.

Destroys this object.

Creates this object.

(optional) True if initial locked.

Destructor.

Default constructor.

A wrapper class for an operating system mutex. It is based on the waiting object class CRxWaitObject.

The windows handle of the waiting object.

Gets the window handle of this wait object. This can be used in functions like WaitForSingleObject.

The windows handle or null if not created or not on windows.

Waits for all of the given waiting objects.

(optional) Timeout in milliseconds. Returns -1 on timeout and else the index of first signaled event starting with 0.

Wait for arbitrary amount of wait objects until one of them is signaled.

[in] the wait objects. Number of objects. (Optional) timeout in milliseconds. .

Waits for any of the given waiting objects.

(optional) Timeout in milliseconds. Returns -1 on timeout and else the index of first signaled event starting with 0.

Waits until one or all of the specified objects are in the signaled state or the time-out interval elapses.

Array of object handles. The number of object handles in the array pointed to by pvHandles. Wait for all events or any event. (optional) Timeout in milliseconds. If it is -1, the function will return only when the object is signaled. Returns -1 on timeout and else the index of first signaled event starting with 0.

Waits until this object is in the signaled state or the time-out interval elapses.

(optional) Timeout in milliseconds. If it is -1, the function will return only when the object is signaled. True if it succeeds, false if a timeout occurred.

Query if this CRxWaitObject is signaled. This performs a wait with a timeout of 0 and returns immediately.

True if signaled, false if not.

Query if this CRxWaitObject is valid.

True if valid, false if not.

Destructor.

Move constructor.

[in,out] The object to move.

Default constructor.

Waiting object class. Base of all classes that have wait capabilities.

True to enable mouse over and selected appearance, false to disable it. Default is true.

The width of the circle lines in pixels. Default and minimum is 3.

The color of selected circles while mouse over. Default: Blue.

The color of selected circles while not mouse over. Default: Green.

The color of not selected circles while mouse over. Default: Red.

Default constructor.

Parameters determining the visual appearance of drawn circles.

The mean size of the points in pixels. The size varies with the zoom of the visualization. Default is 20.

The color of selected points while mouse over. Default: Blue.

The color of selected points while not mouse over. Default: Green.

The color of not selected points while mouse over. Default: Red.

Default constructor.

Parameters determining the visual appearance of drawn points.

The length of the glow effects on animated line strips. Default is 0.5.

The frequency of glowing effects on animated line strips. The higher the value the higher the number of glow effects. Default is 0.5.

The speed of the movement of glowing effects on animated line strips. Default is 1.

The width of the lines in pixels. Default is 10.

The color of selected line strips while mouse over. Default: Blue.

The color of selected line strips while not mouse over. Default: Green.

The color of not selected line strips while mouse over. Default: Red.

Default constructor.

\addtogroup RxNET_CluViz @{

Parameters determining the visual appearance of drawn line strips.

Sets the given image into the given view.

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

Sets the given image into the given view.

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

Sets the given image into the given view.

The handle of the view. [in] The image.

Destroys all views.

Destroys the view described by iHandle.

The window handled returned by CreateViewImage.

Creates a new view window.

The X position of the window. The Y position of the window. The width of the window. The height of the window. [in] The window title. The handle to the created view.

Finalizes this CluViz Tool.

Initializes the CluViz Tool with a changed environment.

[in] The environment path.

Initializes the CluViz Tool.

Provides methods for showing a CluViz window showing a single image.

Required method for Designer support - do not modify the contents of this method with the code editor.

Required designer variable.

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

The static dictionary that maps a handle to the form.

The last created handle.

The engine instance.

The view control.

Closes the given form using Invoke.

[in] The form to close.

Handler, called when a form must be closed

[in] The form to close.

Destroys all handles.

Destroys the view described by iHandle.

The window handled returned by ShowNew.

Sets the given image into the given view.

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

Creates a new view window.

[in] The creation parameter. The handle of the created view.

Finalizes this CluViz Tool. Destroys all open views.

Initializes the CluViz Tool with a custom environment path.

[in] The custom environment path.

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

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

Clean up any resources being used.

Default constructor.

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

Constructor.

The X position of the form. The Y position of the form. The width of the form. The height of the form. The caption of the form.

The created handle of the form.

The caption of the form.

The height of the form.

The width of the form.

The Y position of the form.

The X position of the form.

Create parameters.

Summary for ToolViewForm.

True if this image is only a moniker for an image data pointer.

The timestamp of the image capture. Is 0.0 if this image has no timestamp.

The image ID.

The image data.

The image format.

Swaps the data between this and the given image.

[in,out] The image to swap with.

Find minimal and maximal value of image and normalize image to range [0,1]. Is currently only implemented for pixel type TPixel_L_f.

True if it succeeds, false if it fails.

Test whether image is of a particular pixel and data type.

The pixel type. The data type. True if of type, false if not.

Converts this image from a custom data type into the corresponding primitive data type. The following conversion are implemented: - EDataType::Custom_10in16_LSB into EDataType::UShort - EDataType::Custom_12in16_LSB into EDataType::UShort.

[out] The target image. This is created within the correct format.

Convert the pSrcMem memory to a different type and store result in memory pTrgMem.

[in] Target memory (must have correct target size). Source memory. The target image format. The source image format. True if it succeeds, false if it fails.

Convert the pSrcImage to a different type and store result in pDstImage.

[in,out] Pointer to target image interface. Pointer to source image interface. The target pixel type. The targer data type. If true, the memory for the target image is created. False if an error occurred, otherwise true.

Convert this image to a different type and store result in xImage.

[in,out] The image instance into which to write the result. The size of this image is adapted to this size. The target pixel type. The target data type. False if an error occurred, otherwise true.

Query if this image is a moniker. A moniker holds an image data pointer but is not responsible for the memory. Thus, destroying an image moniker does not free the memory.

True if this image is a moniker, false if not.

Sets the timestamp and the ID of the image.

The timestamp. The ID.

Sets the timestamp of the image capture.

The timestamp.

Gets the timestamp of the image capture. Is 0.0 if this image has no timestamp.

The timestamp.

Sets the ID of this image.

The ID.

Gets the ID of this image.

The ID of this image.

Gets the image format.

The format.

Return the pointer to the data array.

Null if it fails, else the data pointer.

Return the constant pointer to the data array.

Null if it fails, else the data pointer.

Gets the type of the image.

[out] The pixel type. [out] The data type.

Gets the size of the image.

[out] The width. [out] The height.

Gets the number of bytes of the whole image.

The byte count.

Gets the number of pixels.

The pixel count.

Get number of bytes per pixel.

The bytes per pixel.

Query if this image is valid.

True if valid, false if not.

Destroys this image if one has been created. Resets all internal variables.

True if it succeeds, false if it fails.

Creates copy of the given image. No re-allocation is applied if image is of requested format.

The image. True if it succeeds, false if it fails.

Create an image of given type and size and copy the data from the given pointer. No re-allocation is applied if this is of requested format.

Width of image. Height. Type of the pixel. Type of the data. The data. True if it succeeds, false if it fails.

Create an image of given type and size and reserve the appropriate amount of memory. No re-allocation is applied if this is of requested format.

The width of image. The height of the image. The pixel type. The data type. True if it succeeds, false if it fails.

Creates this image by moving the data of the given image into this image.

[in,out] The image to move. Is invalid after this call.

Creates an image of the given format. This copies only the image data pointer. Does not allocate memory. An images created with this method does never free the memory behind the pointer. The pointer responsibility stays with the caller.

The image format. The image data pointer. (Optional) The timestamp of the image capture. (Optional) The image ID.

Creates a copy of the given image. Only (re)allocates memory if required.

The image to copy.

Creates an image of the given format. Only (re)allocates memory if required. Copies the image data into this image.

The image format. Pointer to the image data.

Creates an image of the given format. Only (re)allocates memory if required.

The image format.

Sets the image data to contain only zeros.

Copies the content of the given image data into this image. Expects that the image formats of the given data pointer and this image are identical.

The image data to copy. True if it succeeds, false if it fails.

Move assignment operator.

[in] The image to move. This is invalid after the call. A shallow copy of this object.

Assignment operator. Copies the contents of the given image.

The image. A shallow copy of this object.

Destructor. All used memory is freed.

Constructor. Creates a valid image within the given format and allocates memory accordingly.

The image format.

Move constructor.

[in] The image to move. This is invalid after the call.

Copy constructor. Creates a copy of the given image

The image to copy.

Default constructor. Creates an invalid image without using any memory.

\addtogroup RxCore_Image * @{

Image class. Implements the interface Interop::Runtime28::IImage. This class implements only the basic functionality for an image like create, delete and convert. All image processing has to be implemented separately. The format of an image is described by the class CRxImageFormat. It consist of an image width, height, a pixel type and a data type. The pixel type defines the number and order of color channels, and the data type specifies the data type of each color channel. For example, the pixel type can be RGBA or BGRA and the data type may be unsigned byte (8bit) or unsigned short (16bit). The various pixel types available are defined in Rx::Interop::Runtime28::EPixelType::ID and the data types in Rx::Interop::Runtime28::EDataType::ID. Note that the values of the data type and pixel type defines are identical to the corresponding OpenGL IDs. All possible pixel and data types are represented by the TPixeltemplate structure. Specializations of this template structure cover all possible combinations of the defined pixel types and data types. The specialization names have the form TPixel_[PixelType]_[Data Type]. For example, the pixel structure for an RGBA unsigned char image is TPixel_RGBA_uc. The main advantage of using the TPixel_* typedefs to access the pixels of an image is, that you can write template functions that work on many different pixel types. The TPixel structure defines functions to access the various color channels that map to the correct element within a pixel. The pointer to the image data can be obtained with the function GetDataPtr().

Returns true if the data type of this image format is one of the custom (non primitive) data types.

True if the data type is custom, false if not.

Gets the total number of bytes allocated by images that are of this image format.

The number of byte.

Gets the pixel count.

The pixel count.

Gets the bytes per pixel.

The bytes per pixel.

Gets the bit depth. This is the number of bits per channel.

The bit depth.

Gets the bytes per channel.

The bytes per channel.

Gets the component count.

The component count.

Query if this CRxImageFormat is bayer pixel type.

True if bayer pixel type, false if not.

Inequality operator.

Describes the format to use. True if the parameters are not considered equivalent.

Equality operator.

Describes the format to use. True if the parameters are considered equivalent.

Converts the given data type to a string.

The data type. The data type as a string.

Converts the given pixel type to a string.

The pixel type. The pixel type as a string.

Convert this CRxImageFormat into a string representation.

This CRxImageFormat as a std::string.

Resets this CRxImageFormat.

Destructor.

Constructor that creates an image format that is equal to the image format of the given image interface.

The image interface pointer.

Default constructor.

Constructor. Defines only the width and the height.

The width in pixels. The height in pixels.

Default constructor.

\addtogroup RxCore_Image * @{

Image format descriptor.

Gets the data pointer.

Null if it fails, else the data pointer.

Gets the data pointer.

Null if it fails, else the data pointer.

Gets the type of this image.

[out] Type of the pixel. [out] Type of the data.

Gets the size of this image.

[out] The width. [out] The height.

Gets the byte count.

The byte count.

Gets the pixel count.

The pixel count.

Gets the bytes per pixel.

The bytes per pixel.

Test whether this image exists.

True if valid, false if not.

Destroy image.

True if it succeeds, false if it fails.

Create image from given image.

The image. True if it succeeds, false if it fails.

Create an image of given type and size and copy the data from the given pointer.

Zero-based index of the width. Zero-based index of the height. Type of the pixel. Type of the data. The data. True if it succeeds, false if it fails.

Create an image of given type and size and reserve the appropriate amount of memory. We can use as input types enums as they stay compatible between module versions even if the enum declarations have different numbers of entries.

Zero-based index of the width. Zero-based index of the height. Type of the pixel. Type of the data. True if it succeeds, false if it fails. \addtogroup RxCore_Image * @{

Interface supported by Raytrix images.

The image pixel types..

Planar YUV with 4:2:0 chroma subsampling 1 Channel per pixel (Bayer pattern GBRG) 1 Channel per pixel (Bayer pattern GRBG) 1 Channel per pixel (Bayer pattern BGGR) 1 Channel per pixel (Bayer pattern RGGB) 2 Channels per pixel (Luminance, Alpha) 1 Channel per pixel (Luminance) 4 Channels per pixel (Blue, Green, Red, Alpha) 3 Channels per pixel (Blue, Green, Red) 4 Channels per pixel (Red, Green, Blue, Alpha) 3 Channels per pixel (Red, Green, Blue)

The image data types.

Double.

Float.

32 bit unsigned.

32 bit signed.

16 bit unsigned.

16 bit signed.

8 bit unsigned.

8 bit signed.

Each pixel has a size of 12 bit. It should be converted into 16 bit.

Each pixel has a size of 10 bit. It should be converted into 16 bit.

The upper 12 bits of a 16 bit unsigned short are used. The lower 4 bits are unused (zero).

The lower 12 bits of a 16 bit unsigned short are used. The upper 4 bits are unused (zero).

The upper 10 bits of a 16 bit unsigned short are used. The lower 6 bits are unused (zero).

The lower 10 bits of a 16 bit unsigned short are used. The upper 6 bits are unused (zero).

Initializes the component.

The components.

Executes the view error event action.

[in,out] If non-null, the provided context.

Test if any mouse button is pressed down.

True if any mouse button is down, false if not.

Executes the view mouse event invoked action.

[in,out] If non-null, the data.

Executes the view mouse event action.

[in,out] If non-null, information describing the pv. [in,out] If non-null, context for the pv.

Query if 'eKey' is input key.

The key. True if input key, false if not.

WndProc.

[in,out] The System::Windows::Forms::Message % to process.

Executes the parent changed action.

[in,out] If non-null, the System::EventArgs^ to process.

Executes the resize action.

[in,out] If non-null, the System::EventArgs^ to process.

Executes the enabled changed action.

[in,out] If non-null, the System::EventArgs^ to process.

Executes the key press action.

[in,out] If non-null, the System::Windows::Forms::KeyPressEventArgs^ to process.

Executes the key up action.

[in,out] If non-null, the System::Windows::Forms::KeyEventArgs^ to process.

Executes the key down action.

[in,out] If non-null, the System::Windows::Forms::KeyEventArgs^ to process.

Executes the mouse move action.

[in,out] If non-null, the System::Windows::Forms::MouseEventArgs^ to process.

Executes the mouse up action.

[in,out] If non-null, the System::Windows::Forms::MouseEventArgs^ to process.

Executes the mouse down action.

[in,out] If non-null, the System::Windows::Forms::MouseEventArgs^ to process.

Executes the lost focus action.

[in,out] If non-null, the System::EventArgs^ to process.

Executes the got focus action.

[in,out] If non-null, the System::EventArgs^ to process.

Executes the mouse leave action.

[in,out] If non-null, the System::EventArgs^ to process.

Executes the mouse enter action.

[in,out] If non-null, the System::EventArgs^ to process.

Executes the paint background action.

[in,out] If non-null, the System::Windows::Forms::PaintEventArgs^ to process.

Paints this window.

[in,out] If non-null, the System::Windows::Forms::PaintEventArgs^ to process.

Translate control key.

[in,out] Zero-based index of the clu key. The key. True if it succeeds, false if forms key isn't a CLUViz key.

Gets the last error.

[in] If non-null, the pre string. Null if it fails, else the last error.

Updates the modifier keys.

Initializes this object.

True to create shared rendering context. The shared rendering context.

Sets the position and the size.

Finalizer. This is called by the garbage collector.

Destructor. This is NOT called by the garbage collector. The destructor is used to free native resources explicitly by calling delete on an instance. This does not free the managed resources used.

Adds the class styles VREDRAW, HREDRAW and OWNDC to support OpenGL rendering.

Forces the control to invalidate its client area and immediately redraw itself.

Sets the value of a CluViz vertex buffer object variable.

[in] The name of the vertex buffer object variable. [in,out] The vertex buffer object.

Sets the value of a CluViz image variable.

[in] The name of the image variable. [in,out] The image.

Sets the value of a CluViz tensor variable.

[in] The name of the tensor. [in,out] The dimensions of the tensor. [in,out] The values of the tensor.

Sets the value of a CluViz color variable.

[in] The name of the color variable. The color.

Sets the value of a CluViz color variable.

[in] The name of the color variable. The color.

Sets the value of a CluViz variable.

[in] The name of the variable. [in] The value of the variable.

Sets the value of a CluViz variable.

[in] The name of the variable. [in] The value of the variable.

Sets the value of a CluViz variable.

[in] The name of the variable. The value of the variable.

Sets the value of a CluViz variable.

[in] The name of the variable. The value of the variable.

Sets the value of a CluViz variable.

[in] The name of the variable. The value of the variable.

Sets the value of a CluViz variable.

[in] The name of the variable. The value of the variable.

Gets the value of a CluViz image variable.

[in] The name of the image variable. [out] The returned image.

Gets the values and dimensions of a CluViz tensor.

[in] The name of the tensor. [out] The returned tensor dimensions. The size of this array is the number of dimensions. [out] The returned tensor values.

Gets the value of a CluViz color variable.

[in] The name of the color variable. [out] The returned color.

Gets the value of a CluViz script variable.

[in] The name of the variable. [out] The returned string. The maximum number of characters that should be returned.

Gets the value of a CluViz script variable.

[in] The name of the variable. [out] The returned string.

Gets the value of a CluViz script variable.

[in] The name of the variable. [out] The returned value.

Gets the value of a CluViz script variable.

[in] The name of the variable. [out] The returned value.

Gets the value of a CluViz script variable.

[in] The name of the variable. [out] The returned value.

Gets the ASCII formatted CluViz scene graph created by the current script. It can be used for debug purposes.

The scene graph as a string.

Gets the script output produced during script execution.

The output.

Gets the script output produced during script execution.

[out] Is true if the output contains error strings. The output.

Gets the script output produced during script execution.

[out] An array of output string. [out] Is true if the output contains error strings.

Makes the shared OpenGL rendering context the current one. This is required if you want to call OpenGL methods using this context by your own.

Updates the visualization.

True to wait for the completion.

Updates the visualization and waits for the completion.

Locks or unlocks the visualization. You must NOT call ExecScript while locked.

True to lock, false to unlock.

Executes the script and sets the internal script variable 'ToolName' to the given string.

[in] The tool name string. [out] Contains any text the script has procuded during execution. Use the following code snippet in your script and call ExecScript("SetBGColorWhite") to change the background color of the script visualization: if (ToolName == "SetBGColorWhite") { _BGColor = White; }

Executes the script and sets the internal script variable 'ToolName' to the given string.

[in] The tool name string. Use the following code snippet in your script and call ExecScript("SetBGColorWhite") to change the background color of the script visualization: if (ToolName == "SetBGColorWhite") { _BGColor = White; }

Loads a script from file.

[in] IThe file name of the CluViz script. [in] The password of the encrypted script.

Loads a script from file.

[in] IThe file name of the CluViz script.

Sets the CluViz script for this control as a string.

[in] The string containing the CluViz script content. True to reset environment variables set by former scripts.

Sets the CluViz script for this control as a string.

[in] The string containing the CluViz script content.

Unloads the script that has been loaded by SetScript or LoadScript and places the given string in the center.

[in] The text to be placed in the center of this control. The background color.

Unloads the script that has been loaded by SetScript or LoadScript and places the given string in the center.

[in] The text to be placed in the center of this control.

Unloads the script that has been loaded by SetScript or LoadScript and places 'CLUViz' in the center.

Pause drawing for short period of time. While paused, all keyboard and mouse events are blocked (and queued) until the pause is disabled.

true to enable, false to disable the pause.

Enables/Disables the drawing of the CLUViz scene graph. The script is still executed when calling ExecScript() or if the user uses any tools.

true to enable, false to disable. true to do redisplay.

Enables/Disables the drawing of the CLUViz scene graph. The script is still executed when calling ExecScript() or if the user uses any tools. Disable the drawing will also disable all Keyboard / Mouse events.

true to enable, false to disable.

Enables/Disables the view error events.

True to enable, false to disable.

Enables/Disables the view mouse events. Must not be called if 'IsLoaded' is false.

True to enable, false to disable.

Resumes layout. This enables resizing of CLU window.

True to perform layout and resize CLU window.

Suspends layout. This disables resizing of CLU window to achieve better performance while performing layout of windows.

Gets a list of CLU view handles that are synchronized with this view control. Mouse events of this view control are also passed to these handles.

Gets the handle of the inner CLU view.

Gets or sets a value indicating whether this control gets the focus on mouse over.

Gets the shared OpenGL rendering context. Is 0 if no shared context has been created.

Occurs when the mouse interaction with the control triggers an action. The listeners of this events are allowed to call arbitrary script executes within the event handler.

Occurs when the internal script throws an error.

Occurs when the mouse interaction with the control triggers an action.

Constructor. Creates a WinForms user control that can be placed on a form. This control allows interaction with a loaded CluViz script that visualizes its content using OpenGL. If you want to place multiple user controls on your form that should share OpenGL resources you must create the first user control with bCreateSharedRC set to true and hGLRC set to 0. This creates a shared rendering context. All further controls must be created with bCreateSharedRC set to false. In this case you must provide the created shared rendering context as the parameter hGLRC. You get the shared rendering context using the property SharedGLRC.

True to create a shared OpenGL rendering context. The shared OpenGL rendering context to use. Is ignored if bCreateSharedRC is true. Provide a 0 to not use a shared rendering context.

Default constructor. Creates a WinForms user control that can be placed on a form. This control allows interaction with a loaded CluViz script that visualizes its content using OpenGL.

Delegate for handling ViewError events.

[out] The occurred exception. [out] The sender.

Delegate for handling ViewMouse events.

[out] Data containing information about the mouse event. \addtogroup RxNET_CluViz @{

CLUViz .NET View Control

Convert this object into a string representation.

This object as a string.

Pointer to internal event data.

The tool name that should be executed after processing the event handler if eMouseEventReturnType is set to ExecScript.

The return type of the event. This defines an action that should be executed and can be set in any event handler.

The mouse button that triggered the event.

The type of the mouse event to identify whether the mouse has been moved, clicked, dragged, etc.

The 3D mouse position offset from the start of the drag action to the current position in the coordinate system of the scene.

The current 3D mouse position while dragging in the coordinate system of the scene.

The 3D mouse position where the drag action has been started in the coordinate system of the scene.

The 3D position offset from the start of the drag action to the current position in the global coordinate system.

The current 3D position while dragging in the global coordinate system.

The 3D position where the drag action has been started in the global coordinate system.

The 3D mouse position offset from the start of the drag action to the current position in the global coordinate system.

The current 3D mouse position while dragging in the global coordinate system.

The 3D mouse position where the drag action has been started in the global coordinate system.

The offset of the current mouse cursor to the last drag start position in Y direction in pixels.

The offset of the current mouse cursor to the last drag start position in X direction in pixels.

The current Y coordinate of the mouse cursor on the screen in pixels.

The current X coordinate of the mouse cursor on the screen in pixels.

True if the alt key is pressed.

True if the shift key is pressed.

True if the control key is pressed.

True if the right mouse button is pressed.

True if the left mouse button is pressed.

The part ID of the picked scene.

A semicolon ';' separated list of scenes that are part of the mouse event.

A value indicating whether a pickable scene has been clicked with the left or right mouse button.

Information about mouse events.

Values that represent the pressed mouse button of a mouse event.

Right mouse button has triggered the event.

Middle mouse button has triggered the event.

Left mouse button has triggered the event.

No mouse button has triggered the event.

Values that represent an action that can be processed after handling mouse events.

Execute the script with a given tool name.

Update the visualization.

Do nothing.

\addtogroup RxNET_CluViz @{

Values that represent the type of the mouse event.

A mouse button has been released.

A mouse button has been pressed.

A mouse button has been clicked.

The mouse button has been released after dragging.

A mouse button has been pressed to drag.

An object has been selected.

Mouse is over an object.

No event type.

Gets the last error.

[in] This string is prepended to the error. Null if it fails, else the last error.

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

Releases the context by calling wglMakeCurrent(0, 0).

Destroys all opened CluVis views.

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

Ends the CluViz engine.

Starts the CluViz engine.

Finalizer.

Destructor.

Default constructor.

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

Gets the width and the height of the view port associated with the given handle.

The handle of the view. [out] The width of the view port. [out] The height of the view port.

Sets the error event handler.

The handle of the view. If non-null, the callback function. [in,out] If non-null, a context pointer.

Function pointer type of the error event callback function.

Function pointer type of the mouse event callback function.

The viewport.

Transposed matrix of the coordinate frame inside the picked scene, i.e. after any automatic translation/rotation applied by the scene.

Transposed matrix of the coordinate frame outside the picked scene.

Transposed projection matrix.

Query if this exception or one of its inner exceptions contains an exception of the given GUID.

[in] The GUID of the exception to look for. True if this exception or one of its inner exceptions contains an exception of the given GUID, false if not.

Gets the inner exception if one is available. Otherwise nullptr is returned.

The inner exception.

Gets the line.

The line number.

Gets the file name.

The file name.

Gets the function name.

The function name.

Gets the name of this exception.

The name of this exception.

Gets the unique identifier of this exception. This is not guaranteed to be the GUID of this exception type.

The unique identifier.

Gets message text.

Null if it fails, else the message text.

Gets the most inner exception.

The most inner exception. If there is no inner exception, this exception is returned.

Convert this exception into a string representation.

True to include all inner exceptions. This exception as a string.

Convert this exception into a string representation.

This exception as a string.

Sets additional exception data.

Sets the given exception as the inner exception.

The exception.

Sets the GUID of this exception. This is not guaranteed to be the GUID of this exception type.

Unique identifier.

Virtual destructor.

Constructor.

The message string. The file. The function. The line. The inner exception.

Constructor.

The message string. The file. The function. The line. The inner exception.

Constructor.

The message string. The file. The function. The line.

Raytrix exception base class. All exceptions are based on this class.

The exception pointer.

Query if this object is valid.

True if valid, false if not.

Gets the exception pointer.

Null if it fails, else the exception pointer.

Destructor. Deletes the assigned exception.

Move assignment operator.

[in,out] The exception safe pointer to move. A moved version of the given pointer.

Copy Constructor. Creates a copy of the given exception.

The exception to copy.

Copy Constructor. Creates a copy of the given exception.

The exception to copy.

Move constructor.

[in,out] The exception safe pointer to move.

Copy constructor. Creates a copy of the exception provided by the given pointer.

The exception safe pointer to copy.

Default constructor.

Container for an Interop::Runtime31::IException pointer that simplifies copying of exceptions.

Defines an alias representing the exception interface of RxRuntime 3.1.

Makes a deep copy of this object.

Null if it fails, else a copy of this object.

Query if this exception or one of its inner exceptions contains an exception of the given GUID.

[in] The GUID of the exception to look for. True if this exception or one of its inner exceptions contains an exception of the given GUID, false if not.

Gets the inner exception if one is available. Otherwise null is returned.

The inner exception.

Gets the unique identifier of this exception. This is not guaranteed to be the GUID of this exception type.

The unique identifier.

Gets the name of this exception.

The name of this exception.

Gets the line.

The line number.

Gets the file name.

The file name.

Gets the function name.

The function name.

Gets message text.

The message text.

Interface class of all exceptions used since RxRuntime 3.1.

Defines an alias representing the exception interface of RxRuntime 3.0.

The inner exception.

Sets an inner exception. Frees currently assigned inner exception.

[in] The inner exception.

Returns the inner exception and yields responsibility.

The inner exception.

Copies this exception. This has to be implemented in each exception type.

A copy of this exception.

Copy this exception to given target Destination.

[in,out] If non-null, target for the.

Gets the inner exception.

Null if there is no inner exception, else the inner exception.

Query if this exception or one of its inner exceptions has the given GUID.

[in] The GUID of the exception to look for. True if this exception or one of its inner exceptions has the given GUID, false if not.

Gets the unique identifier of the type of this exception.

The type unique identifier.

Gets the name of this exception.

The name of this exception.

Gets the line.

The line number.

Gets the file name.

The file name.

Gets the function name.

The function name.

Gets the information string.

The information string.

Convert this CRxExceptionEx into a string representation.

This CRxExceptionEx as a string.

Destructor.

copy Constructor.

[in] The exception to copy.

Default constructor.

Interface for basic exception.

Defines an alias representing the GUID interface of RxRuntime 3.0.

Convert this CGuid into a string representation.

String buffer. Must be of size 40.

Inequality operator.

The reference GUID. True if the parameters are not considered equivalent.

Equality operator.

The reference GUID. True if the parameters are considered equivalent.

Assignment operator. Throws an std::exception if the string parsing failed.

"{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}" or "{XXXXXXXX - XXXX - XXXX - XXXX - XXXXXXXXXXXX}". A new GUID.

Constructor.

"{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}" or "{XXXXXXXX - XXXX - XXXX - XXXX - XXXXXXXXXXXX}".

Default constructor.

Unique identifier.

The line in the source code file The name of the function The source code file name

Convert this CCodeLocation into a string representation.

This CCodeLocation as a CRxString.

Gets the line in the source code file.

The line in the source code file.

Gets the name of the function.

The name of the function.

Gets the source code file name.

The source code file name.

Constructor.

The source code file name. The name of the function. The line in the source code file.

Default constructor.

Holds information about a certain code location. These information are: - The source code file name - The name of the function - The line in the source code file.

CUDA macro. Maps to "__DINL__" for GPU and "" for CPU

CUDA macro. Maps to "__host__ __DINL__" for GPU and "inline" for CPU

CUDA macro. Maps to "__forceinline__" for GPU and "inline" for CPU

Resets this object.

External created Index Buffer Objects.

External created Vertex Buffer Object.

Number of index lists.

Array of corresponding index list lengths.

Array of pointers to index lists.

Pointer to the array of vertices.

Number of vertices in this VBO.

Vertex array mode.

A standard vertex buffer object (VBO).

Padding (reserved for future use).

Edge flag.

Part ID for picking of object parts.

Fog z-component.

RGBA color value.

Normal coordinate vector.

Texture coordinate vector.

Vertex coordinate vector.

A standard vertex.

Image IDs.

The internal data.

Gets the pointer to the internal data.

The pointer.

Gets the pointer to the internal data.

The pointer.

Copies the content of the given source memory into this array. Sets the size of this array to the size of the memory.

The source memory.

Sets the internal memory to zeros.

Clears the array.

Set the size of this array to the given number of elements.

Number of elements.

Set the size of this array to the given number of elements.

Number of elements.

Query if this object is valid. Returns always true.

True if valid, false if not.

Gets the number of elements in this array.

The length.

Gets the size of a single value in this array.

The element size.

Gets the pointer to the internal data.

The pointer.

Gets the pointer to the internal data.

The pointer.

Array indexer operator.

The index. The indexed value.

Array indexer operator.

The index. The indexed value.

Assignment operator.

The array to copy. This array.

Destructor. Removes all elements from this array.

Copy constructor. Creates a copy of the given array.

The array to copy.

Constructor. Creates a new array by splitting the given string at each occurrence of the given separator.

The string to split. The split separator.

Constructor. Creates a new array with the given number of initialized elements.

The number of elements. The initial value of each element in this array.

Constructor. Creates a new array with the given number of uninitialized elements.

The number of elements.

Default constructor. Creates an empty array.

Defines an alias representing the type of the elements in this array.

\addtogroup RxCore_Tools *

An array of strings.

Converts the given string into an unsigned integer value.

[in] The string. [iout] The unsinged integer. The unsigned integer.

Converts the given string into an integer value.

[in] The string. [out] The integer. The integer.

Finalizes this object. Frees both pointer.

Initializes this object. Creates both pointer.

Assumes that this CRxString represents a file name and splits it in path, name and extension.

[out] The directory path. [out] Name of file without extension. [out] Extension of file.

Assigns a new value to the string, replacing its current contents. Copies the first nNumChars characters from the array of characters pointed by pcData.

Pointer to an array of characters. Number of characters to copy.

Replaces all occurrences of pcOld by pcNew and returns the resulting CRxString.

String which should be replaced. This string is used as the replacement. The replaced CRxString.

Determines whether the end of this string instance matches the specified string.

The string to compare to the substring at the end of this instance. True if value matches the end of this instance; otherwise, false.

Query if this CRxString contains the given sxString.

The CRxString to test for containment. True if this string contains the given sString, false if not.

Query if this CRxString contains the given pcString.

The string to test for containment. true if this string contains the given pcString, false if not.

Searches this string for the content specified in either pcString or sxString, and returns the position of the first occurrence in this string.

When nStartIdx is specified the search only includes characters on or after position nStartIdx, ignoring any possible occurrences in previous locations. String to be searched for in this string. The entire content of str must be matched in some part of the string to be considered a match. (optional) Position of the first character in the string to be taken into consideration for possible matches. A value of 0 means that the entire string is considered. The position of the first occurrence in the string of the searched content. If the content is not found, the member value CRxString::npos is returned.

Searches the string for the first character that matches any of the characters specified in its arguments.

When nCount is specified, the search only includes characters at or after position nCount, ignoring any possible occurrences before nCount. String containing the characters to search for in this string. (optional) Position of the first character in the string to be taken into consideration for possible matches. (optional) Length of sequence of characters to search for. The position of the first occurrence in the string of any of the characters searched for. If the content is not found, the member value CRxString::npos is returned.

Returns a newly constructed CRxString object with its value initialized to a copy of a substring of this object. The substring is the portion of the object that starts at character position nStartIdx and spans nCount characters (or until the end of the string, whichever comes first).

Position of the first character to be copied as a substring. If this is equal to the string length, the function returns an empty string. (Optional) Number of characters to include in the substring (if the string is shorter, as many characters as possible are used). A value of -1 indicates all characters until the end of the string. A string object with a substring of this object.

Converts this hexadecimal string with 16 chars to a 8 byte double variable.

The double value.

Convert a 8 byte double variable into a hexadecimal string representation with 16 chars.

The double value. The hexadecimal string.

Converts this CRxString to an unsigned int.

This CRxString as an unsigned int.

Converts this CRxString to an int.

This CRxString as an int.

Converts this CRxString to a c string.

This CRxString as a const char*.

Query if this object is valid.

True if valid, false if not.

Gets the pointer to memory.

The pointer to memory.

Gets the length of this CRxString. This is the number of characters.

The length of this CRxString.

Gets the size in bytes of an element of a string, which is always 1.

The element size.

Less-than comparison operator.

The string to compare with. True if the first parameter is less than the second.

Gets the nIndex-th character from string.

The index. The indexed character.

Appends the given double to this CRxString.

The double. The concatenation of this CRxString with dValue.

Appends the given float to this CRxString.

The float. The concatenation of this CRxString with fValue.

Appends the given size_t element to the string.

The value. This string object.

Appends the given size_t element to the string.

The value. This string object.

Appends the given unsigned integer to this CRxString.

The unsigned integer. The concatenation of this CRxString with uValue.

Appends the given __int64 element to the string.

The value. This string object.

Appends the given string to this CRxString.

The string. The concatenation of this CRxString with sxString.

Appends the given string to this CRxString.

The string. The concatenation of this CRxString with pcString.

Appends the given double to this CRxString.

The double. The concatenation of this CRxString with dValue.

Appends the given float to this CRxString.

The float. The concatenation of this CRxString with fValue.

Addition assignment operator.

The unsigned __int64 value. The concatenation of this CRxString with nValue.

Appends the given unsigned integer to this CRxString.

The unsigned integer. The concatenation of this CRxString with uValue.

Appends the given integer to this CRxString.

The integer. The concatenation of this CRxString with iValue.

Appends the given integer to this CRxString.

The integer. The concatenation of this CRxString with iValue.

Appends the given string to this CRxString.

The string. The concatenation of this CRxString with sxString.

Appends the given string to this CRxString.

The string. The concatenation of this CRxString with pcString.

Inequality operator.

The string. True if the parameters are not considered equivalent.

Inequality operator.

The string. True if the parameters are not considered equivalent.

Equality operator.

The string. True if the parameters are considered equivalent.

Equality operator.

The string. True if the parameters are considered equivalent.

Assignment operator.

Source memory. A CRxString consisting of pSrcMem interpreted as character array.

Move assignment operator.

[in,out] The Raytrix string. Is invalid after this call. A shallow copy of this object.

Assignment operator.

The Raytrix string. A CRxString consisting of Raytrix string sxString.

Assignment operator.

The string. A CRxString consisting of string pcString.

Assignment operator.

The character. A CRxString consisting of character cChar.

Destructor.

Creates a CRxString consisting of pSrcMem interpreted as character array.

Source memory.

Move constructor.

[in,out] The Raytrix string. Is invalid after this call.

Copy constructor.

The Raytrix string.

Creates a CRxString consisting of string pcString.

The string.

Creates a CRxString consisting of character cChar.

The character.

Default constructor.

npos is a static member constant value with the greatest possible value for an element of type size_t. This value, when used as the value for a length parameter in string's member functions, means "until the end of the string". As a return value, it is usually used to indicate no matches. This constant is defined with a value of -1, which because size_t is an unsigned integral type, it is the largest possible representable value for this type.

Basic character string operations.

Raytrix string format precision.

Destructor.

Gets the pointer to the memory block.

The pointer to memory.

Copies the memory block described by pMemory into this memory block. This memory block is automatically resized. The function throws an exception if the element sizes of the given memory block does not agree with the element size of this memory block.

[in] The memory to copy into this memory block.

Reset all values in the memory block. The actual value the elements in the memory block are reset to depends on the implementation.

Deletes this memory block.

Resizes the memory block to the given number of elements. The size of an element is fixed by the implementation and can be read out with the function GetElementSize().

The new number of elements stored in the memory block.

Creates a new memory block of \a nElementCount elements. The size of an element is fixed by the implementation and can be read out with the function GetElementSize().

The new number of elements stored in the memory block.

Common memory interface.

Destructor.

Query if this object is valid. This function returns also true if the object itself is valid but the memory block has size zero.

True if valid, false if not.

Gets the pointer to memory.

The pointer to memory.

Gets the number of elements in the memory block. The total number of bytes allocated by the memory block is given by the length times the element size.

The size in bytes.

Gets the element size. The memory block is made up of blocks of the given number of bytes. The function Length() returns the number of elements in the memory block, where each element is of the size given in GetElementSize(). For example, an array of 10 doubles has element size 8 and length 10.

The element size in bytes.

Interface for memory read operations.