| | Class | Description |
|---|
 | AbortButtonPressedEvent |
The event is triggered when the abort button in the execution panel is pressed.
|
| AbortJobEvent |
The event commands RAYGUIDE to abort an executing job. Event
JobAbortedEvent
will be sent as response.
|
| ActiveJobChangedEvent |
The event is triggered when the active job changes, either by selecting
another tab or by loading a job; the latter could be caused by event
OpenJobEvent.
Parameter:
- JobDefinition JobDefinition:
The job definition which is now active.
|
| AddPenSetEvent |
The event commands RAYGUIDE to add a new pen set. It is fired when the
"+" button in the pen set configuration dialog is pressed.
Parameter:
ConfigurationLevel configurationLevel:
The configurationLevel for which the pen set is added.
|
| AddRootJobElementEvent |
The event commands RAYGUIDE to add a new job element holder to the
currently active job.
Parameter: A duple containing:
- JobElementHolder holder: The JobElementHolder object to be added.
- Mementos: The compound mementos. Use null if no compound is needed.
|
| AddTemplatedRootJobElementEvent |
The event commands RAYGUIDE to add a new job element, based on a
template, to the currently active job. It is triggered e. g. by
menu item "Objects/Circle/Default".
Parameter: A duple containing:
- string TemplateName: The name of the template to be added.
- Metadata Meta data: Its meta data;
|
| AlignJobItemsEvent |
The event commands RAYGUIDE to align the selected objects to the chosen alignment type
of the workspace. It is triggered when the sub menu item of "Align"
in a job object's context menu is pressed.
|
| AllJobsClosedEvent |
The event is triggered when all jobs are closed.
|
| ApplyFillingTemplateEvent |
The event commands RAYGUIDE to apply a filling template to the
selected object.
Parameter: A duple containing:
- string TemplateName: The filling template's name as shown in RAYGUIDE.
- bool ClearFillings: If true, potentially already applied templates are
removed before applying the new filling.
|
| ArmLaserEvent |
The event commands RAYGUIDE to arm the laser. Event
LaserArmedEvent
will be sent with parameter true as response.
|
| AsBitmapRenderedEvent |
The event is triggered when the current workspace is saved as a raster
graphic. It will be sent as response to
event RenderAsBitmapEvent.
|
| AsByteArrayRenderedEvent |
The event is triggered when the current workspace is saved as a raster
graphic. It will be sent as response to
event RenderAsBitmapEvent.
|
| AssignScanHeadsEvent |
The event commands RAYGUIDE to assign one or two scan heads to a
scan controller
Parameter: A tuple containing:
- string: The short name of the scan controller.
- string: The short name of the scan controller's first scan head.
- string: The short name of the scan controller's second scan head.
If a scan head's name is null or an empty string a
possibly connected scan head will be removed.
Event
ScanHeadsAssignedEvent is
triggered as response.
|
| BlockGuiEvent |
The event commands RAYGUIDE to block the GUI. The command can be
triggered by the Remote Interface to avoid concurrent usage.
Send event
UnblockGuiEvent
to unblock.
Parameter: allowGuiToUnblock:
If true the blocked state can be unblocked in the GUI, if false the
unblock event must be sent.
|
| BlockWorkspaceUpdateEvent |
The event sets if the workspace update should be enabled or not.
Disabling can be useful to keep windows open while getting points from the workspace.
Parameter:
- bool: If true, the workspace does not update, if false it behaves like default again.
|
| CenterCalibrationFinishedEvent |
The event is triggered when the user finishes the Click & Teach
camera center calibration.
Parameter: isAborted:
If true, the procedure is aborted, if false the procedure has been
finished regularly and the calibration data is set.
|
| CenterCalibrationGuideLinesSetEvent |
The event is triggered when the Click & Teach center calibration is
finished and the calibration data (i. e. means the position of the
calibration guide lines) is set.
Parameter: A duple containing:
- x: The x position of the first guide line.
- y: The y position of the second guide line.
|
| CenterJobItemEvent |
The event commands RAYGUIDE to move the selected objects to the center
of the workspace. It is triggered when the menu item "Center"
in a job object's context menu is pressed.
|
| ChangeActiveJobEvent |
The event commands RAYGUIDE to switch the current job to the one
with the label given in the parameter.
Parameter:
string jobLabel: The label of the job to be activated.
|
| ChangeActiveJobFromPathEvent | |
| ChangeJobVisibilityEvent |
The event commands RAYGUIDE to show or to hide all job elements in
the workspace.
Parameter: isToShow:
If true the job elements are shown and hidden if set to false.
|
| ChangeMarkingTitleEvent |
The event commands RAYGUIDE to set the title of the GUI's execution
panel.
Parameter: string title: The new title.
|
| ChangePenEvent |
The event commands RAYGUIDE to assign the provided pen current (tree) selection.
|
| ChangePensTitleEvent |
The event commands RAYGUIDE to set the title of the GUI's pen set
panel. There is no effect on further data.
Parameter: string title: The new title.
|
| ChangeTransformationTitleEvent |
The event commands RAYGUIDE to set the title of the GUI's
transformation panel.
Parameter: string title: The new title.
|
| ClickAndTeachSelectionRectangleCalculatedEvent |
The event is triggered when Click & Teach has detected that the
user has clicked somewhere in the workspace or has created a
selection rectangle.
Parameter: A duple containing:
- posWorld: The middle of the selection rectangle or the position
where the user has clicked. This value is in the workspace's world
coordinates; i. e. the origin may have an offset to the center.
- posScannerWorld: The middle of the selection rectangle or the
position where the user has clicked. This value is in world coordinates,
but relative tot the scanner's coordinate system that is associated with
currently active camera; i. e. the origin is in the center.
- size: The size of the selection rectangle in world
coordinates. In case the user has just picked, the size is null.
|
| ClickAndTeachTilingOrCalibratingEvent |
The event is triggered when the Click & Teach tiling or auto calibration
process is started or ended.
Parameter: isStarted:
Set to true when the process is started and false when it is ended.
|
| CloseJobEvent |
The event commands RAYGUIDE to close a job; it is triggered e. g. if
menu item "File/Close..." is used. The event
ActiveJobChangedEvent is
triggered as response.
Parameter: A duple containing:
- JobDefinition JobDefinition: The job definition instance to be closed, null closes all jobs;
- bool NeedConfirmation: If true, a confirmation message appears before
closing.
|
| ConditionalShutdownRayguideEvent |
The event commands RAYGUIDE to shutdown itself. The shutdown is automatically cancelled if there is a running process or a dirty job.
|
| ConfigureDevicesClosedEvent |
The events is called when the device configuration dialog has been closed.
|
| ConfigureJobEvent |
The event commands RAYGUIDE to open the job settings dialog; it is
triggered e. g. if menu item "Job/Settings..." is used.
|
| ConfigureJobPresetsEvent |
The event commands RAYGUIDE to open the job defaults dialog; it is
triggered e. g. if menu item "Job/Defaults..." is used.
|
| ControlVisibilityChangedEvent |
The event is triggered if one of the GUI panels has switched from hidden
to shown or vice versa.
Parameter: IDictionary<string, bool> dic: The dictionary of all panels, containing the panel's name
as key and its visibility as value.
|
| ConvertJobItemToVectorGraphicEvent |
The event commands RAYGUIDE to convert the selected objects into vector
graphic objects. It is triggered when the menu item "To vector graphic"
in a job object's context menu is pressed.
|
| CopyJobItemEvent |
The event commands RAYGUIDE to copy the selected job elements into the
job element clipboard. It is triggered when the menu item "Copy" in a
job object's context menu or the corresponding icon in the tool bar
is clicked or Ctrl+C on the keyboard is pressed.
|
| CreateJobEvent |
The event commands RAYGUIDE to create a new job; it is triggered e. g.
if menu item "File/New" is executed or RAYGUIDE is starting. The event
ActiveJobChangedEvent is
triggered as response.
Parameter: bool checkOnDefaultJob: If set to true no
blank job will be created but the default job if it is available and
activated in the user preferences.
|
| CreateOrDeleteCenterCalibrationGuideLinesEvent |
The event commands RAYGUIDE to show or to hide the guide lines needed
for the center calibration in the Click & Teach module.
Parameter: A tuple containing:
- bool: If true, the guide lines are shown, if false they are removed.
- width: The camera's field width in world coordinates.
- height: The camera's field height in world coordinates.
- centerPos: The last used center position for positioning the guide lines.
|
| CreateOrDeleteRectificationCalibrationGuideLinesEvent |
The event commands RAYGUIDE to show or to hide the guide lines needed
for the rectification calibration in the Click & Teach module.
Parameter: positions: the four positions where the eight guide
lines cross each other.
If null the guide lines will be removed.
|
| CreateOrDeleteResolutionCalibrationGuideLinesEvent |
The event commands RAYGUIDE to show or to hide the guide lines needed
for the resolution calibration in the Click & Teach module.
Parameter: xPositions:
A dvec2 object with xPosition.x the x position of the first
guide line and xPosition.y the position of the second guideline;
both are to be given in world coordinates.
If null the guide lines will be removed.
|
| CreateOrDeleteWaveLengthCalibrationGuideLinesEvent |
The event commands RAYGUIDE to show or to hide the guide lines needed
for the wave length calibration in the Click & Teach module.
Parameter: position: the position where the two guide
lines cross each other.
If null the guide lines will be removed.
|
| CutJobItemEvent |
The event commands RAYGUIDE to delete the selected job elements from
the job and to copy it into the job element clipboard. It is triggered
when the menu item "Cut" in a job object's context menu or the
corresponding icon in the tool bar is clicked or Ctrl+X on the keyboard
is pressed.
|
| DeleteJobItemEvent |
The event commands RAYGUIDE to delete the selected job elements. It is
triggered when the menu item "Delete" in a job object's context menu
is clicked or the "Del" key on the keyboard is pressed.
|
| DeviceDeletedEvent |
The event is triggered when a device is deleted from the system.
Parameter:
BaseDeviceController baseDeviceController: The deleted device object.
|
| DevicesChangedEvent |
The event is triggered when the device configuration has changed.
I. e. when a device is added, removed or cloned.
|
| DisablePointerEvent |
The event commands RAYGUIDE to disable the pointer. Event
PointerEnabledEvent
will be sent with parameter false as response.
|
| DisarmLaserEvent |
The event commands RAYGUIDE to disarm the laser. Event
LaserArmedEvent
will be sent with parameter false as response.
|
| DownloadJobEvent |
The event commands RAYGUIDE to download the current job to the scan
controller card. Event
JobDownloadedEvent
will be sent as response.
|
| DrawJobElementEvent |
The event commands RAYGUIDE to enter job element drawing mode
Parameter: A tuple containing:
- DrawingMode Mode: The shape to draw.
- Action Callback: The callback passed the two points to set the metric properties of the job element.
|
| DrawPersistentVectorGraphicEvent |
The event commands RAYGUIDE to enter persistent vector graphic drawing mode
Parameter: Action callback: The callback passed the point to create a new path
|
| EnableOrDisableExecutionButtonEvent |
The event commands RAYGUIDE to enable or disable the GUI's execution
and preview button.
Parameter: enableExecution:
If true the buttons are enabled, if false disabled.
|
| EnablePointerEvent |
The event commands RAYGUIDE to enable the pointer. Event
PointerEnabledEvent
will be sent with parameter true as response.
|
| ExecuteShortCutEvent |
The event commands RAYGUIDE to execute the command assigned to the
given key, e. g. F3 opens the Preferences dialog.
Attention: Only a single key is accepted. Combinations with other
keys, e. g. with Ctrl or Shift, are not possible.
Parameter: Key: A Key object, e. g. System.Windows.Input.Key.F3.
|
| ExecutionErrorEvent |
The event is triggered when the execution of the given job caused an exception.
Parameter: A tuple containing:
- JobDefinition JobDefinition: The job that is aborted.
- ScanControllerError Error: Type of the scan controller error. Null if exception is not caused by scan controller.
- BaseScanController ScanController: Scan controller causing the exception. Null if not caused by any scan controller. /// |
| ExecutionTimeChangedEvent |
The event is triggered each time a job is rendered in the canvas
to report changes in the job's predicted execution time.
|
| ExecutorModeChangedEvent |
The event is triggered when the executor mode (active, all)
has been changed.
Parameter: int 0 => active, 1 => all
|
| ExecutorModeSetEvent |
The event is triggered when the executor mode has been set. It will be
sent as response to event
Parameter: int 0 => active, 1 => all
|
| ExecutorTypeSetEvent |
The event is triggered when the executor type has been set. It will be
sent as response to event
SetExecutorTypeEvent.
Parameter:
Type type: One of typeof(OnHostJobExecutor),
typeof(QuickJobExecutor) or
typeof(OnCardJobExecutor).
|
| ExportDeviceConfigurationEvent |
The event commands RAYGUIDE to save the current device configuration
into a file with the given file name.
Parameter: string filePath: The file where to save the configuration into.
|
| ExportJobEvent |
The event commands RAYGUIDE to export the current job into the given
file. The file extension controls the file type to write.
Supported extensions are .dxf, .plt, .pdf, .cgm, .emf and .wmf.
Parameter: A triple containing:
- JobDefinition JobDefinition:
The job definition instance to be saved.
- string FilePath: The path and file name to be used for saving.
If it is null or empty the currently active job's file name is used. If
the currently active job has no name yet the file select dialog is shown.
- bool NeedConfirmation: If true, the file select dialog is shown.
|
| FillingTemplateAddedEvent |
The event is triggered after a filling template has been saved.
|
| FindPenUsageEvent |
The event commands RAYGUIDE to search for the given pens in the given
pen set in the current job. It is triggered when the "Find selected
pens" button is pressed in the pen sets panel or if the pen selection
changes while the feature is switched on.
Parameter: A duple containing:
- PenSet PenSet: The pen set of which the pens are searched.
- ISet<int> PenNumbers: The pen numbers to be searched for.
|
| GetJobElementResolvedModelMatrixEvent |
Event for querying the resolved model matrix of a provided JobElementHolder.
|
| GetJobElementTransformationEvent |
The event commands RAYGUIDE to get the transformation of the job
element with the given short label in the current job.
- ShortLabel shortLabel: The short label of the job element. Is short label is empty, you will get data of all job elements.
|
| GetProcessTransformationEvent |
Event for querying the current process transformation.
Event ProcessTransformationReceivedEvent
will be sent as response.
|
| GlobalScalingChangedEvent | |
| GroupJobItemsEvent |
The event commands RAYGUIDE to put the selected objects into a group.
It is triggered when the menu item "Group" in a job object's context
menu is pressed.
|
| GuiBlockedEvent |
The event is triggered as response to event
BlockGuiEvent.
|
| GuiUnblockedEvent |
The event is triggered as response to event
UnblockGuiEvent.
|
| HandleErrorEvent |
Handles scan controller errors by using the configuration of ShowErrorHandlingEvent.
|
| ImportDeviceConfigurationEvent |
The event commands RAYGUIDE to load the current device configuration
from the file with the given file name.
Parameter: string filePath: The file from where the configuration is to be loaded.
|
| InitializePermissionEvent | |
| JobAbortedEvent |
The event is triggered when the execution of the given job is aborted.
It will be sent as response to event
AbortJobEvent.
Parameter: A duple containing:
- JobDefinition JobDefinition: The job that is aborted.
- BaseScanController ScanController: The currently used scan controller.
|
| JobChangedEvent |
The event is triggered when the currently active job changes; i. e. if
the user chooses another job tab, loads a new job or closes a job. In
difference to ActiveJobChangedEvent
no job definition needs to be transferred.
|
| JobClosedEvent |
The event is triggered when a job is closed.
|
| JobDownloadedEvent |
The event is triggered when a job is successfully downloaded to the
scan controller card. It will be sent as response to
event DownloadJobEvent.
|
| JobElementExecutionFinishedEvent |
The event is triggered each time a job element has finished executing.
Parameter: A triple containing:
- JobDefinition JobDefinition: The job that is executing.
- BaseScanController ScanController: The currently used scan controller.
- ProcessingHolder ProcessingHolder: A wrapper to identify a job element based on its
location and process.
|
| JobElementExecutionStartedEvent |
The event is triggered each time a job element is about being
executed.
Parameter: A triple containing:
- JobDefinition JobDefinition: The job that is executing.
- BaseScanController ScanController: The currently used scan controller.
- ProcessingHolder ProcessingHolder: A wrapper to identify a job element based on its
location and process.
|
| JobElementUIClosing | |
| JobElementUICreating | |
| JobExecutorChangedEvent |
The event is triggered when the executor type (on host, quick, on card)
has been changed.
Parameter: bool loopIterationSync: false, if on card executor is
active, true otherwise.
|
| JobFinishedEvent |
The event is triggered when the execution of the given job has finished.
Parameter: A duple containing:
- JobDefinition JobDefinition: The job that has finished executing.
- BaseScanController ScanController: The currently used scan controller.
|
| JobItemCutCopyPasteChangedEvent |
The event is triggered when copy paste operations have been executed.
It is used to enable and disable the GUI elements e. g. dependent on
the clipboard content.
|
| JobItemReplacedEventT |
The event is triggered during undo operations when
deleted job elements needs to be restored.
For internal use only.
|
| JobLabelChangedEvent |
The event is triggered when a job is loaded or saved.
Parameter: string label: The string contains the job's label, i. e. the
file name without the ".rg" extension and without the path.
|
| JobOptimizationChangedEvent | |
| JobParameterEvent |
The event commands RAYGUIDE to set parameters for active job (e.g. use process transformation queue).
|
| JobProcessingDataEvent | |
| JobSavedEvent |
The event is triggered when a job was saved.
|
| JobScanControllerChangedEvent |
The event is triggered when a scan controller is added to the system
and the current job has still no scan controller assigned, or if a new
job is created and the default scan controller is assigned to it, or
if the job is assigned new set of scan controllers.
|
| JobSettingsUpdatedEvent |
The event is triggered when the job settings dialog is closed
with OK.
|
| JobStartedEvent |
The event is triggered when the job returned as parameter has started
to execute.
Parameter: A duple containing:
- JobDefinition JobDefinition: The job that starts executing.
- bool IsOnCard: If true, the job is executing on card.
|
| JobValidationEvent | |
| LaserArmedEvent |
The event is triggered when the laser is armed or disarmed. It will
be sent as response to events
ArmLaserEvent and
DisarmLaserEvent.
Parameter: bool isArmed: true if the laser has been armed or false if disarmed.
|
| LaserControllerChanged | |
| LayoutFilePathErrorDetectedEvent |
The event is triggered when a layout file is to be loaded which
does not exist. RAYGUIDE shows an error message and removes the
file path from the recent list if it is found there.
Parameter: string filePath: Contains the path of the layout file which
could not be loaded.
|
| LockWorkspaceEvent |
The event commands RAYGUIDE to lock or unlock manipulation of the canvas as
is done with menu item "View/Lock workspace".
Parameter: bool isToLock: If true canvas will be locked.
|
| LoginRayguideEvent | |
| MeasureDistanceEvent |
The event commands RAYGUIDE to switch into the distance measuring mode.
It is triggered when the user clicks the corresponding button in the
tool bar.
|
| MetafileCommandAddedEvent |
The event is triggered when a new meta file command was added. This will update the tree and the undo manager.
Parameter: A tuple containing:
- BaseMetafileCommand Command: The added command.
- VectorGraphicPath TargetPath: The target path.
- JobElementHolder TargetJobElementHolder: The holder of the targeted vector graphic.
|
| MetafileCommandPropertiesChangedEvent |
The event is triggered when in a vector graphic object a thumb has been
moved with the mouse; it is used to update the data in the
corresponding settings dialog if it is currently open.
|
| OpenDeviceConfigurationEvent |
The event commands RAYGUIDE to open the device configuration dialog.
|
| OpenJobEvent |
The event commands RAYGUIDE to load a job file; it is triggered e. g. if
menu item "File/Open..." is used. If successful the event
ActiveJobChangedEvent is
triggered as response.
Parameter: string fileName: The string contains the job
files's name and path. If it is null or empty RAYGUIDE shows a file select
dialog.
|
| OpenLayoutEvent |
The event commands RAYGUIDE to load a GUI layout file; it is triggered
e. g. when menu item "View/Layout/Open..." is used.
Parameter: string fileName: The string contains the layout files's name and path. If it
is null or empty RAYGUIDE shows a file select dialog.
|
| OptimizeJobItemVectorEvent |
The event commands RAYGUIDE to do some optimizations on the selected
vector graphics elements.
Parameter:
OptimizationSettings optimizationSettings:
The object controls the kind of optimizations to be done.
|
| OutlineChangedEvent |
The event is triggered when in a vector graphic a thumb point is moved
in the canvas.
To be more precisely: If the thumb has been moved with the mouse, the
event is triggered as soon as the left mouse button is released, if the
thumb is moved with the cursor keys it is triggered when the key is
pressed.
|
| PasteJobItemEvent |
The event commands RAYGUIDE to paste the job elements currently in the
clipboard into the job. It is triggered when the menu item "Paste" in a
job object's context menu or the corresponding icon in the tool bar is
clicked or Ctrl+V on the keyboard is pressed.
Parameter:
dvec3 point:
A point with the coordinates the object is to
be inserted.
|
| PenAddedEvent |
The event is triggered when a new pen has been created or a pen has
been copied from the pen clipboard to the pen set.
|
| PenCopiedEvent |
The event is triggered when a pen is copied into the pen clipboard.
|
| PenDeletedEvent |
The event is triggered when a pen is deleted from a pen set or cut from
a pen set into the pen clipboard.
|
| PenMovedEvent |
The event is triggered when a pen's ID number is changed.
|
| PenSetChangedEvent |
The event is triggered when the pen set configuration dialog is closed
with OK or the Apply button is pressed.
|
| PointerEnabledEvent |
The event is triggered when the pointer is enabled or disabled. It will
be sent as response to events
EnablePointerEvent and
DisablePointerEvent.
Parameter: bool isEnabled: true if the pointer has been enabled or false if disabled.
|
| PreferencesUpdatedEvent |
The event is triggered when
- the preferences dialog has been closed with OK or the Apply button has been pressed,
- the library pen sets configuration dialog has been closed with OK or the Apply button has been pressed or
- the thickness slider in the tool bar has been moved.
|
| PreviewFinishedEvent |
The event is triggered when the preview is switched off and all
pending preview tasks are done.
|
| PreviewParametersSetEvent |
The event is triggered when the preview parameters have been set.
It is the response to event
SetPreviewParametersEvent.
|
| PreviewToggledEvent |
The event is triggered when the preview is switched on or off.
Parameter: bool isOn: true if the preview is currently
switched on, false otherwise.
|
| ProcessTransformationChangedEvent |
The event is triggered when the process transformation has been changed.
It will be sent as response to
event SetProcessTransformationEvent.
Parameter: A triple containing:
- dvec3 Offset: The offset in x, y and z direction.
- dvec3 Scale: The scale in x, y and z direction.
- double Rotation: the rotation angle in rad.
|
| ProcessTransformationReceivedEvent |
The event will be sent as response to event
GetProcessTransformationEvent.
Parameter: A triple containing:
- dvec3 Offset: The offset in x, y and z direction.
- dvec3 Scale: The scale in x, y and z direction.
- double Rotation: the rotation angle in rad.
|
| ProcessVariablesChangedEvent |
There is the process adjustment panel in RAYGUIDE with settings for
power scale, speed scale, rotation, scale and offset, which can be
changed at any time. These settings can be automatically be reset
when starting RAYGUIDE, when starting execution or never, according
to the setting in the system preferences. This event is triggered
when the reset has been done.
|
| QuickExecutionParameterEvent |
The event commands RAYGUIDE to set parameters for quick executor (e.g. only selected).
|
| RecentDocumentsChangedEvent |
The event is triggered if a job or layout file has been loaded and
the list of recent jobs or layouts is changed.
Parameter: string filePath: The path and file name of the file causing the change.
|
| RectificationCalibrationFinishedEvent |
The event is triggered when the user finishes the Click & Teach
rectification calibration.
Parameter: isAborted:
If true, the procedure is aborted, if false the procedure has been
finished regularly and the calibration data is set.
|
| RectificationCalibrationGuideLinesSetEvent |
The event is triggered when the Click & Teach rectification calibration
is finished and the calibration data (i. e. means the position of the
calibration guide lines) is set.
Parameter: The positions where the eight guide lines cross.
|
| RedoEvent |
The event commands RAYGUIDE to redo the last undo operation.
It is triggered when the undo icon is clicked or Ctrl-Y is
pressed.
|
| RefreshCurrentSharedPenSetEvent |
The event commands RAYGUIDE to update the current pen set of the current
job. It is fired when pen settings of the job has been changed.
|
| RefreshJobEvent |
The event commands RAYGUIDE to refresh the current job. I. e. all
changes possibly made to the job's settings, e. g. labels of
elements, are propagated.
Parameter: bool clearSelection: If true the current
selection of job elements is cleared.
|
| RefreshJobPenSetFromBaseEvent |
The event commands RAYGUIDE to update the current pen set of the current
job with values from its base pen set. It is fired when the refresh button is pressed..
|
| RefreshJobSettingsEvent |
The event commands RAYGUIDE to update the settings of the currently
active job due to changes in its settings; it is triggered e. g.
if a device is added to the job's scan controller.
|
| RefreshMetafileCommandListEvent |
The event commands RAYGUIDE to refresh the given vector graphic. This
is done by rebuilding the complete structure of paths and layers.
Parameter:
BaseMarkableVectorGraphic
baseMarkableVectorGraphic: The vector graphic element to refresh.
|
| RefreshMousePositionEvent |
The event commands RAYGUIDE to refresh the mouse position shown in the status bar.
Parameter:
dvec2 point:
A point with the current mouse coordinates relative to RAYGUIDE's canvas in micrometers.
|
| RefreshPreviewPositionEvent |
The event commands RAYGUIDE to refresh the thumb preview.
Parameter:
dvec2 point:
A point with the current thumb coordinates relative to RAYGUIDE's canvas in micrometers.
|
| RefreshVariablesEvent | |
| RefreshWorkspaceEvent |
The event commands RAYGUIDE to refresh the canvas.
Parameter: A duple containing:
- bool ForceRerender: If true the internal cache is cleared.
- bool OnlyUpdateSelection: If true only the selected objects are refreshed.
|
| RenderAsBitmapEvent |
The event commands RAYGUIDE to save the current job in its workspace as
a raster graphic in a data format defined by the file extension. The
allowed extensions are ".bmp", ".gif", ".jpeg", ".jpg", ".png", ".tiff"
and ".wmp".
Parameter: A duple containing:
string filePath: The path and file name the raster graphic will
be saved.
int imageSize: The number of pixels the larger side (width or
height) of the workspace will have in the saved image.
|
| RenderAsByteArrayEvent |
The event commands RAYGUIDE to save the current job in its workspace as
a raster graphic in a data format defined by the file extension. The
allowed extensions are ".bmp", ".gif", ".jpeg", ".jpg", ".png", ".tiff"
and ".wmp".
Parameter: A duple containing:
string filePath: The path and file name the raster graphic will
be saved.
int imageSize: The number of pixels the larger side (width or
height) of the workspace will have in the saved image.
|
| RequestExecutorTypeEvent |
The event commands RAYGUIDE to retrieve the currently active executor
type. Event
ExecutorTypeGotEvent
will be sent as response.
Action<type>: A callback method that gets the response in its parameter.
Type type: One of typeof(OnHostJobExecutor),
typeof(QuickJobExecutor) or
typeof(OnCardJobExecutor).
|
| RequestJobElementsEvent |
The event commands RAYGUIDE to retrieve a list of all the short labels
of the currently active job.
Parameter:
Action<string>: A callback method that gets the response in its parameter.
|
| RequestJobPensEvent |
The event commands RAYGUIDE to retrieve a list of the data of all
pens that are used by the currently active job.
Parameter:
Action<string>: A callback method that gets the response in its parameter.
|
| RequestPenNumbersEvent |
The event commands RAYGUIDE to retrieve a list of all pen numbers that
are used by the job element with the given label in the currently
active job.
Parameter: A duple containing:
string jobElementLabel: The label of the job element where the
pen numbers are to be retrieved.
Action<string> callback method: A method that will be called
when the data is retrieved; the requested data will be in its parameter.
|
| RequestPensEvent |
The event commands RAYGUIDE to retrieve a list of the data of all
pens that are used by the job element with the given label in the
currently active job.
Parameter: A duple containing:
string jobElementLabel: The label of the job element where the
pen numbers are to be retrieved.
Action<string> callback method: A method that will be called
when the data is retrieved; the requested data will be in its parameter.
|
| ResetOverrideCursorEvent |
Resets the application's override cursor to the one as it was
when the SetOverrideCursorEvent has been triggered the last
time.
|
| ResolutionCalibrationFinishedEvent |
The event is triggered when the user finishes the Click & Teach
camera resolution calibration.
Parameter: isAborted:
If true, the procedure is aborted, if false the procedure has been
finished regularly and the calibration data is set.
|
| ResolutionCalibrationGuideLinesSetEvent |
The event is triggered when the Click & Teach resolution calibration is
finished and the calibration data (i. e. means the distance of the
calibration guide lines to each other) is set.
Parameter: A duple containing:
- x1: The x position of the first guide line.
- x2: The x position of the second guide line.
|
| RestartRayguideEvent |
The event commands RAYGUIDE to restart itself. Necessary if the
user interface's language has been changed.
|
| RotationChangedEvent |
The event is triggered when the rotation in the transformation panel
has been changed, but only if there is a multiple selection.
Parameter: The angle of the rotation in degrees.
|
| SaveApplicationConfigurationEvent |
The event commands RAYGUIDE to save the given application
configuration.
Parameter: A duple containing:
- ApplicationConfiguration ApplicationConfiguration: The configuration to be saved.
- ConfigurationLevel ConfigurationLevel: System or user level.
|
| SaveJobElementAsTemplateEvent |
The event commands RAYGUIDE to show the "Save template" dialog. It is
triggered when the menu item "Save as template" in a job object's
context menu is clicked.
|
| SaveJobEvent |
The event commands RAYGUIDE to save a job; it is triggered e. g. if
menu item "File/Save" or "File/Save as..." is used.
Parameter: A triple containing:
- JobDefinition JobDefinition:
The job definition instance to be saved.
- string FilePath: The path and file name to be used for saving.
If it is null or empty the currently active job's file name is used. If
the currently active job has no name yet the file select dialog is shown.
- bool NeedConfirmation: If true, the file select dialog is shown.
|
| SaveLayoutEvent |
The event commands RAYGUIDE to save the current GUI layout into a
file; it is triggered e. g. when menu item "View/Layout/Save"
is used.
Parameter: A duple containing:
- string FilePath: The path and file name to be used for saving. If it is null
or empty the file select dialog is shown.
- bool NeedConfirmation: If true, the file select dialog is shown.
|
| ScanHeadChanged | |
| ScanHeadsAssignedEvent |
The event is triggered as response to event
AssignScanHeadsEvent.
Parameter:
- string: "OK" if assigning of scan heads successful, an error
message otherwise.
|
| SelectAllJobElementsEvent |
The event commands RAYGUIDE to select all job elements.
|
| SelectedJobItemChangedEvent |
The event is triggered when the set of selected job elements is
changed, i. e. if an element is selected or deselected.
|
| SelectedSliceChanged | |
| SelectionRectangleCreatedEvent |
The event is triggered when the user has done a selection in the
workspace with the mouse.
Parameter: A duple containing:
- startPos: The position of the selection's start corner in
workspace coordinates.
- endPos: The position of the selection's end corner in
workspace coordinates.
|
| SelectRectangleModeJobElementEvent |
The event commands RAYGUIDE to switch into the rectangle job element mode.
It is triggered when the user clicks the corresponding button in the
element dialog (on/off)
|
| SetBackgroundImageOpacityEvent |
The event commands RAYGUIDE to change the opacity of the background images.
Parameter: opacity:
0: the background image is completely hidden.
1: the background image is completely visible
|
| SetExecutorTypeEvent |
The event commands RAYGUIDE to set the executor type to the given one. Event
ExecutorTypeSetEvent
will be sent as response.
Parameter:
Type type: One of typeof(OnHostJobExecutor),
typeof(QuickJobExecutor) or
typeof(OnCardJobExecutor).
|
| SetGlobalScalingEvent | |
| SetJobElementTransformationDoneEvent | |
| SetJobElementTransformationEvent |
The event commands RAYGUIDE to change the transformation of the job
element with the given short label in the current job.
Parameter: A tuple containing:
- ShortLabel shortLabel: The short label of the job element to be changed.
- dvec3 Offset: The offset in x, y and z direction.
- dvec3 Scale: The scale in x, y and z direction.
- double Rotation: The rotation angle in rad.
|
| SetJobElementTransformationsEvent | |
| SetOverrideCursorEvent |
Sets the application's override cursor.
Parameter: The wanted cursor shape.
|
| SetPenEvent |
The event commands RAYGUIDE to retrieve a list of the data of all
pens that should be changed for the currently active job.
Parameter: A duple containing:
string jobElementLabel: The label of the job element where the
pen numbers are to be retrieved.
Action<string> callback method: A method that will be called
when the data is retrieved; the requested data will be in its parameter.
|
| SetPreviewParametersEvent |
The event commands RAYGUIDE to set the preview parameters.
Parameter: A triple containing:
- bool bool isAll: If true all objects in the job will be marked,
if false only the selected ones.
- int previewMode: The following modes are defined:
- 0 (JobElement): A job element is completely previewed.
- 1 (Outlined): No fillings are previewed, only the outline; bitmaps
as rectangles.
- 2 (BoundingRectangle): Only he bounding rectangle of a job element
is previewed.
- 3 (ConvexHull): The convex hull of a job element is previewed; e. g.
a star with six tips will be previewed as hexagon.
- 4 (Thumb): The preview point tracks a selected thumb while it is
moved manually.
- double previewSpeed: The preview speed in m/s.
RAYGUIDE sends
PreviewToggledEvent as
response.
|
| SetProcessTransformationEvent |
The event commands RAYGUIDE to set the process transformation.
Parameter: A triple containing:
- dvec3 Offset: The offset in x, y and z direction.
- dvec3 Scale: The scale in x, y and z direction.
- double Rotation: the rotation angle in rad.
|
| SetWorkspaceBackgroundMapEvent |
The event commands RAYGUIDE to change the background list of the workspace
canvas. Used by the Click & Teach module.
Parameter:
A list of duples, containing two tuples. The first tuple contains the
following elements:
- string: name: The short label of the scan controller the scan head
belongs to the camera is linked to.
- int: width: The width of the scan field image taken by the camera in pixel.
- int: height: The height of the scan field image taken by the camera in pixel.
- int: numberOfChannels: The number of color channels used in the image:
1: gray scale or 3: BGR (not RGB).
- IntPtr: A pointer to the raw data of the image. The image is organized
in lines (number: height) of width pixels. Each pixel consumes numberOfChannels
bytes. In case of numberOfChannels is 1, one gray value byte follows the next. In
case of numberOfChannels is 3, the sequence is BGRBGRBGR... with B: blue byte,
G: green byte, R: red byte.
The second tuple contains the following elements:
- dvec3: position: The position of the cross hair's. It is null if no cross hair's
are to be drawn.
- double: crossHairsSize: The cross hair's length in world coordinates.
- double: crossHairsWidth: The width of each cross hair in world coordinates.
- SKColor: crossHairsColor: The color used for the cross hairs.
If there is only one scan controller and only one camera therefore
the list contains only one duple.
|
| SetZoomViewerTooltipTextEvent |
The event commands RAYGUIDE to set the tool tip of the workspace's
zoom viewer object. Needed to show different tool tips dependent on
the move mode phase.
|
| ShowBitmapManagerEvent |
The event commands RAYGUIDE to show the bitmap manager dialog.
Not used yet in RAYGUIDE.
|
| ShowControlPanelEvent |
The event commands RAYGUIDE to show or to hide a control panel as is
done with the menu items in "View/Panels". The panel is toggled, i. e.
it is shown if its currently hidden and vice versa.
Parameter: string name: The name of the panel to show. The following strings are
allowed:
- "ClickAndTeach",
- "CustomUI".
- "Job",
- "JobElements",
- "Marking",
- "Notifications",
- "Pens",
- "ProcessMonitor",
- "ProcessTransformation",
- "TemplateManager",
- "Transformation",
- "VectorList",
If the given name is not known nothing happens.
|
| ShowErrorHandlingEvent |
The event commands RAYGUIDE to show the Error handling dialog;
|
| ShowFocusTesterEvent |
The event commands RAYGUIDE to show the focus tester dialog; it
is triggered
|
| ShowGridEvent |
The event commands RAYGUIDE to show or to hide the grid in the canvas as
is done with menu item "View/Grid".
Parameter: bool isToShow: If true the grid will be shown, if false it will be hidden.
|
| ShowGuideLinesEvent |
The event commands RAYGUIDE to show or to hide the guide lines
in the canvas as is done with menu item "View/Guide lines".
Parameter: If true the guide lines will be shown, if false not.
|
| ShowHelpEvent |
This event commands RAYGUIDE to show the help section in the user
manual defined by the parameter.
Parameter: string s: A label assigned to the
corresponding section in the manual.
|
| ShowJobElementPropertiesEvent |
The event commands RAYGUIDE to show the settings dialog of the
selected element.
Parameter: bool showJobElement: If true the settings dialog of the
selected job element is shown; if false and a path element of a vector
graphic is selected, the settings dialog of the selected vector graphic
element is shown.
|
| ShowJumpVectorsEvent |
The event commands RAYGUIDE to show or to hide the vector jumps in the
canvas as is done with menu item "View/Jump vectors".
Parameter: bool isToShow: If true the jump vectors will be shown, if false they will
be hidden.
|
| ShowLaserDiagnosticsEvent |
The event commands RAYGUIDE to show the Laser diagnostics dialog; it
is triggered e. g. if menu item "System/Devices/Laser diagnostics..."
is used.
|
| ShowNewJobElementSettingsEvent |
The event commands RAYGUIDE to show the settings dialog of a new job
element, when clicking an object in the objects panel.
Parameter:
Metadata meta data:
The prepared meta data object for the object to be created.
|
| ShowParameterFinderEvent | |
| ShowParameterFinderMotfEvent | |
| ShowPenSetSettingsEvent |
The event commands RAYGUIDE to open the pen set dialog showing the
given pen set.
Parameter:
PenSet penSet:
The pen set to be shown in the dialog.
|
| ShowSharpCornersEvent |
The event commands RAYGUIDE to show or to hide the marks of sharp corners
in the canvas as is done with menu item "View/Sharp corners".
Parameter: If true the sharp corners will be marked, if false not.
|
| ShowStandAloneManagerEvent |
The event commands RAYGUIDE to show the Stand-Alone dialog; it is
triggered e. g. if menu item "System/Stand-Alone" is used.
|
| ShowVectorTipsEvent |
The event commands RAYGUIDE to show or to hide the vector tips in the
canvas as is done with menu item "View/Vector tips".
Parameter: bool isToShow: If true the vector tips will be shown, if false they will
be hidden.
|
| ShutdownRayguideEvent |
The event commands RAYGUIDE to shutdown itself. If a job is still
running a confirmation message is shown before aborting.
Parameter: int code: An exit code transferred to the shell which has
started RAYGUIDE.
|
| SliceCountChanged | |
| SliceStartedEvent | |
| SplitAtPlaneEvent |
The event commands RAYGUIDE to split the selected job elements at the given coordinates.
|
| SplitJobElementEvent |
The event commands RAYGUIDE to switch into the split job element mode.
It is triggered when the user clicks the corresponding button in the
tool bar.
|
| StartJobEvent |
The event commands RAYGUIDE to mark the current job with the current
executor.
|
| StartJobExecutorEvent |
The event commands RAYGUIDE to start the given job with the given
profile.
Parameter: A duple containing:
- JobDefinition JobDefinition: The job that is to be executed.
- BaseJobExecutorProfile JobExecutorProfile: The executor profile to be used.
|
| StartPreviewEvent |
The event commands RAYGUIDE to start the preview with the current
preview parameters. RAYGUIDE sends event
PreviewToggledEvent as
response. The parameters can be set with
SetPreviewParameters.
|
| StopPreviewEvent |
The event commands RAYGUIDE to stop a running preview. RAYGUIDE sends
event
PreviewToggledEvent as
response.
|
| TerminateLoopEvent |
The event commands RAYGUIDE to stop an executing job after the current loop iteration.
|
| TogglePreviewEvent |
The event commands RAYGUIDE to switch the preview on and off. It is
fired when the F8 key is pressed or the Click & Teach simulation mode
is started.
Parameter: If the flag is set to true, the event is
fired by the Click & Teach simulation button.
|
| TransformationCenterChangedEvent |
The event is triggered when the transformation center in the
transformation panel has been changed. It is used to update the canvas.
Parameter:
dvec3 point:
A point with the world coordinates of the new center.
|
| TransformationChangedEvent |
The event is triggered each time the transformation of a job element
has changed, i. e. when it is moved, scaled, rotated or mirrored, and
when the transformation center has changed.
|
| UnblockGuiEvent |
The event commands RAYGUIDE to unblock the GUI in case it is in the
blocked state. The command should be used by the Remote Interface in
case it has sent the
BlockGuiEvent
before.
|
| UndoEvent |
The event commands RAYGUIDE to undo the last operation on the undo
stack. It is triggered when the undo icon is clicked or Ctrl-Z is
pressed.
|
| UndoRedoStackChangedEvent |
The event is triggered when the undo stack changes; i. e. on each change
on the job.
|
| UndoRedoStackPermissionTypeChangedEvent |
The event is triggered when the undo permission mode has changed:
If an operation is suspicious to consume a lot of memory, RAYGUIDE
asks the user if the operation should be done allowing undo or not.
This is the permission type.
|
| UpdateLayoutFilePath |
The event is triggered two times while RAYGUIDE is initializing.
Parameter: string filePath: The first time the string is empty, the second time
the string contains the path of the current layout file.
|
| UserPenSetChangedEvent |
The event is triggered when a job is opened and causes a refresh of
the pen set panel.
|
| UserPermissionsChangedEvent |
The event is triggered when the currently active user permissions have
changed. This can happen if the permissions have been changed by the
user in the permissions configuration dialog or e. g. when a job has
been started because it is forbidden to change it while executing.
|
| WaveLengthCalibrationFinishedEvent |
The event is triggered when the user finishes the Click & Teach
wave length calibration.
Parameter: isAborted:
If true, the procedure is aborted, if false the procedure has been
finished regularly and the calibration data is set.
|
| WaveLengthCalibrationGuideLinesSetEvent |
The event is triggered when the Click & Teach wave length calibration
is finished and the calibration data (i. e. means the position of the
calibration guide lines) is set.
Parameter: The position where the two guide lines cross.
|
| WorkspaceFocusRequestedEvent |
The event is triggered when a new job element is created by
clicking on one of the elements in the object panel and the
settings dialog is closed with OK.
|
| WorkspaceMouseClickedEvent |
The event is triggered when the user clicks into the workspace.
Parameter:
dvec3 point:
A point with the mouse position in world coordinates.
|
| WorkspaceRefreshedEvent |
The event is triggered when the canvas has been refreshed.
Parameter: string label: The label of the job just refreshed.
|
| ZoomToRectangleEvent |
The event commands RAYGUIDE to zoom the workspace to the given
rectangle in world coordinates.
Parameter: rect: The rectangle to zoom to.
|
Classes
