OrsEvent¶

eventCallback¶

class OrsEvent.eventCallback.EventCallback¶

classmethod addCallbackAddedPlaneToPlaneCollectionEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackChannelDimensionUnitChangeEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have two extra attributes,invoke_immediately:

oldDimensionUnitRegistrationKey: old Dimension Unit Registration Key
newDimensionUnitRegistrationKey: new Dimension Unit Registration Key

classmethod addCallbackChannelMarkSliceModifiedEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have two extra attributes,invoke_immediately:

tIndexOfSlice: T index of the loaded slice
zIndexOfSlice: Z index of the loaded slice

classmethod addCallbackChannelSliceLoadedEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have two extra attributes,invoke_immediately:

tIndexOfSlice: T index of the loaded slice
zIndexOfSlice: Z index of the loaded slice

classmethod addCallbackChildNodeAddedOrRemovedEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have two extra attributes,invoke_immediately:

guidOfChild: guid of child object being added or removed
isBeingAdded: True if child is being added, False otherwise

classmethod addCallbackColorRangeMode2DChangedEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackColorRangeMode3DChangedEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackControlPointSelectionEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have two extra attributes,invoke_immediately:

oldIndex: index of control point being unselected
newIndex: index of control point being selected

classmethod addCallbackCursor3DPositionChangeEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

classmethod addCallbackDisplayDrawEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackDisplayFitEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Callback triggered when a display is fit to any object

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument,invoke_immediately.

EventData will have no extra attributes.

classmethod addCallbackDisplayPlaneChangedEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

classmethod addCallbackDisplayViewModeChangeEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have two extra attributes,invoke_immediately:

oldViewMode: old view mode
newViewMode: new view mode

classmethod addCallbackGamma2DChangedEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackGamma3DChangedEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackHighlightEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have two extra attributes,invoke_immediately:

highlighted: True if object is being highlighted, False otherwise
displayguid: GUID of display

classmethod addCallbackInvalidateDeviceEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackLeveling2DChangedEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackLeveling3DChangedEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackMeshOpacityChangedEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have an extra attribute,invoke_immediately:

opacityFactor: the opacity factor (a float between 0 and 1)

classmethod addCallbackMeshScalarValuesUpdated(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackMultiROILabelSelectedEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

classmethod addCallbackObjectDeletedEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

anORSObject – object being subscribed to
callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument,invoke_immediately.

EventData will have no extra attributes.

classmethod addCallbackOpacityFactor2DChangedEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackOpacityFactor3DChangedEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackOpacityGainChangedEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackOpacityMode2DChangedEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackOpacityMode3DChangedEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackOverlayOpacityChangedEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have an extra attribute,invoke_immediately:

opacityFactor: the opacity factor (a float between 0 and 1)

classmethod addCallbackPickEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have these extra attributes,invoke_immediately:

uValue: a float for the U value of the pick point
vValue: a float for the V value of the pick point
wValue: a float for the W value of the pick point
uModelValue: a float for the U model value of the pick point
vModelValue: a float for the V model value of the pick point
wModelValue: a float for the W model value of the pick point
xOrigin: a float for the X value of the pick point origin
yOrigin: a float for the Y value of the pick point origin
zOrigin: a float for the Z value of the pick point origin
x: a float for the X value of the pick point
y: a float for the Y value of the pick point
z: a float for the Z value of the pick point

classmethod addCallbackPostAddObjectToGroupEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have an extra attribute,invoke_immediately:

guid: GUID of object being added to group

classmethod addCallbackPostPresentEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have two extra attributes,invoke_immediately:

directXDC: DirectX device context
displayguid: GUID of display where object is presented

classmethod addCallbackPostRemoveObjectFromGroupEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have two extra attributes,invoke_immediately:

guid: GUID of object being removed from group
index: index of object being removed from group

classmethod addCallbackPostRenderEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have two extra attributes,invoke_immediately:

directXDC: DirectX device context
displayguid: GUID of display where object is rendered

classmethod addCallbackPreAddObjectToGroupEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have an extra attribute,invoke_immediately:

guid: GUID of object being added to group

classmethod addCallbackPrePresentEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have two extra attributes,invoke_immediately:

directXDC: DirectX device context
displayguid: GUID of display where object is presented

classmethod addCallbackPreRemoveObjectFromGroupEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have two extra attributes,invoke_immediately:

guid: GUID of object being removed from group
index: index of object being removed from group

classmethod addCallbackPreRenderEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have two extra attributes,invoke_immediately:

directXDC: DirectX device context
displayguid: GUID of display where object is rendered

classmethod addCallbackPropagateChildrenNodesOrganizationDirtyEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackPropagateDataDirtyEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackPropagateDirtyEvent(anORSObject, callbackid, function, dirtyFlags=None, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.
dirtyFlags – Dirty Flags of interest (str or list),invoke_immediately.

EventData will have no extra attributes.

classmethod addCallbackPropagateGeometryDirtyEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackPropagateHighlightDirtyEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackPropagatePropertyDirtyEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackPropagateVisibilityDirtyEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackRangeSelectionlevelingChangedEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackRangeSelectionlevelingEnabledEvent(aVisualChannel, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have one extra attributes,invoke_immediately:

True if the plane

classmethod addCallbackRemovedPlaneToPlaneCollectionEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackSetCameraEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackSetPlaneToPlaneCollectionEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackStreamDataReadyEvent(anORSObject, callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have the following extra attributes:

data: Data buffer to be written/read to/from the stream
size: Size of data
resultPtr: Pointer to a boolean to receive the result of the read/write operation

classmethod addCallbackTitleChangedEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackUpdateViewSizeEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackUserInfoChangedEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackUserInfoElementChangedEvent(anORSObject, userInfoKey, callbackid, function, invoke_immediately=False)¶

Parameters:

userInfoKey – user info key that will trigger the callback
callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes

classmethod addCallbackViewCineModeChangeEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

classmethod addCallbackViewSlabThicknessChangeEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

classmethod addCallbackVisualBoxChangedEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackVisualPlaneChangedEvent(anORSObject, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes,invoke_immediately.

classmethod addCallbackVisualPlaneEnabledEvent(aVisualPlane, callbackid, function, invoke_immediately=False)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have one extra attributes,invoke_immediately:

True if the plane

classmethod addClassCallbackMultiROILabelSelectedEvent(callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

classmethod addClassCallbackObjectDeletedEvent(classProgID, callbackid, function)¶

Parameters:

classProgID –
callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addClassCallbackObjectPublishedEvent(classProgID, callbackid, function)¶

Parameters:

classProgID –
callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addClassCallbackPostAddObjectToGroupEvent(classProgID, callbackid, function)¶

Parameters:

classProgID –
callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have an extra attribute:

guid: GUID of object being added to group

classmethod addClassCallbackPostCopyEvent(classProgID, callbackid, function)¶

Parameters:

classProgID –
callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have an extra attribute:

sourceObjectGUID: GUID of object used as the source of the copy

classmethod addClassCallbackPostLoadEvent(classProgID, callbackid, function)¶

Parameters:

classProgID –
callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

classmethod addClassCallbackPostRemoveObjectFromGroupEvent(classProgID, callbackid, function)¶

Parameters:

classProgID –
callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have two extra attributes:

guid: GUID of object being removed from group
index: index of object being removed from group

classmethod addClassCallbackPreAddObjectToGroupEvent(classProgID, callbackid, function)¶

Parameters:

classProgID –
callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have an extra attribute:

guid: GUID of object being added to group

classmethod addClassCallbackPreRemoveObjectFromGroupEvent(classProgID, callbackid, function)¶

Parameters:

classProgID –
callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have two extra attributes:

guid: GUID of object being removed from group
index: index of object being removed from group

classmethod addClassCallbackPropagateChildrenNodesOrganizationDirtyEvent(classProgID, callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addClassCallbackPropagateDataDirtyEvent(classProgID, callbackid, function)¶

Parameters:

classProgID –
callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addClassCallbackPropagateDirtyEvent(classProgID, callbackid, function, dirtyFlags=None)¶

Parameters:

classProgID –
callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.
dirtyFlags – Dirty Flags of interest (str or list).

EventData will have no extra attributes.

classmethod addClassCallbackPropagateGeometryDirtyEvent(classProgID, callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addClassCallbackPropagateHighlightDirtyEvent(classProgID, callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addClassCallbackPropagatePropertyDirtyEvent(classProgID, callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addClassCallbackPropagateVisibilityDirtyEvent(classProgID, callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addClassCallbackTitleChangedEvent(classProgID, callbackid, function)¶

Parameters:

classProgID –
callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

classmethod addClassCallbackViewLayoutPropertiesChangeEvent(callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addClassCallbackVisibilityChangedEvent(classProgID, callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have two attributes:

viewGUID: if the View is none, then the visibility changed in all views, otherwise, the visibility changed in the one view
visible: true if the VisualObject is visible

classmethod addGlobalCallbackChannelLoadedEvent(callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addGlobalCallbackChannelModifiedEvent(callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addGlobalCallbackCreateDatasetGroup(callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addGlobalCallbackDeleteDatasetGroup(callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addGlobalCallbackDisplayPostRenderEvent(callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addGlobalCallbackDisplayPreRenderEvent(callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addGlobalCallbackDisplayViewModeChangeEvent(callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addGlobalCallbackLayoutUpdatedEvent(callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addGlobalCallbackNewSessionEvent(callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addGlobalCallbackOrsViewSizeChangeEvent(callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addGlobalCallbackPreferencesChangedEvent(callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addGlobalCallbackProgressHasBeenCancelledEvent(callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addGlobalCallbackProgressResetEvent(callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addGlobalCallbackProgressStartedEvent(callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addGlobalCallbackProgressStoppedEvent(callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addGlobalCallbackProgressTextChangedEvent(callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addGlobalCallbackProgressUpdatedEvent(callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addGlobalCallbackUpdateDatasetGroup(callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod addGlobalCallbackVisualChannelFourQuadrantEvent(callbackid, function)¶

Parameters:

callbackid – callback id, should be unique
function – function called when callback is triggered. Function must have a single eventData argument.

EventData will have no extra attributes.

classmethod setCallbackAddedPlaneToPlaneCollectionEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackAddedPlaneToPlaneCollectionEvent

classmethod setCallbackChannelDimensionUnitChangeEvent(anORSObject, callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addCallbackChannelDimensionUnitChangeEvent
enabled –

classmethod setCallbackChannelMarkSliceModifiedEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addCallbackChannelSliceLoadedEvent
enabled –

classmethod setCallbackChannelSliceLoadedEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addCallbackChannelSliceLoadedEvent
enabled –

classmethod setCallbackChildNodeAddedOrRemovedEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addCallbackChildNodeAddedOrRemovedEvent
enabled –

classmethod setCallbackColorRangeMode2DChangedEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackColorRangeMode2DChangedEvent

classmethod setCallbackColorRangeMode3DChangedEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackColorRangeMode3DChangedEvent

classmethod setCallbackControlPointSelectionEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackControlPointSelectionEvent

classmethod setCallbackCursor3DPositionChangeEnabled(anORSObject, callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addCallbackCursor3DSetPositionEvent
enabled –

classmethod setCallbackDisplayDrawEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addCallbackDisplayDrawEvent
enabled –

classmethod setCallbackDisplayFitEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackDisplayFitEvent

classmethod setCallbackDisplayPlaneChangedEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackDisplayPlaneChangedEvent

classmethod setCallbackDisplayViewModeChangeEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackDisplayViewModeChangeEvent

classmethod setCallbackGamma2DChangedEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackGamma2DChangedEvent

classmethod setCallbackGamma3DChangedEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackGamma3DChangedEvent

classmethod setCallbackHighlightEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackHighlightEvent

classmethod setCallbackInvalidateDeviceEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackInvalidateDeviceEvent

classmethod setCallbackLeveling2DChangedEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackLeveling2DChangedEvent

classmethod setCallbackLeveling3DChangedEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackLeveling3DChangedEvent

classmethod setCallbackMeshOpacityChangedEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackMeshOpacityChangedEvent

classmethod setCallbackMeshScalarValuesUpdatedEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackMeshScalarValuesUpdated

classmethod setCallbackMultiROILabelSelectedEnabled(anORSObject, callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addCallbackMultiROILabelSelectedEvent
enabled –

classmethod setCallbackObjectDeletedEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addCallbackObjectDeletedEvent
enabled –

classmethod setCallbackOpacityFactor2DChangedEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackOpacityFactor2DChangedEvent

classmethod setCallbackOpacityFactor3DChangedEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackOpacityFactor3DChangedEvent

classmethod setCallbackOpacityGainChangedEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackOpacityGainChangedEvent

classmethod setCallbackOpacityMode2DChangedEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackOpacityMode2DChangedEvent

classmethod setCallbackOpacityMode3DChangedEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackOpacityMode3DChangedEvent

classmethod setCallbackOverlayOpacityChangedEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackOverlayOpacityChangedEvent

classmethod setCallbackPickEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackPickEvent

classmethod setCallbackPostAddObjectToGroupEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackPostAddObjectToGroupEvent

classmethod setCallbackPostPresentEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackPostPresentEvent

classmethod setCallbackPostRemoveObjectFromGroupEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackPostRemoveObjectFromGroupEvent

classmethod setCallbackPostRenderEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackPostRenderEvent

classmethod setCallbackPreAddObjectToGroupEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackPreAddObjectToGroupEvent

classmethod setCallbackPrePresentEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackPrePresentEvent

classmethod setCallbackPreRemoveObjectFromGroupEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackPreRemoveObjectFromGroupEvent

classmethod setCallbackPreRenderEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackPreRenderEvent

classmethod setCallbackPropagateChildrenNodesOrganizationDirtyEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackPropagateChildrenNodesOrganizationDirtyEvent

classmethod setCallbackPropagateDataDirtyEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackPropagateDataDirtyEvent

classmethod setCallbackPropagateDirtyEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackPropagateDirtyEvent

classmethod setCallbackPropagateGeometryDirtyEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackPropagateGeometryDirtyEvent

classmethod setCallbackPropagateHighlightDirtyEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackPropagateHighlightDirtyEvent

classmethod setCallbackPropagatePropertyDirtyEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackPropagatePropertyDirtyEvent

classmethod setCallbackPropagateVisibilityDirtyEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackPropagateVisibilityDirtyEvent

classmethod setCallbackRangeSelectionlevelingChangedEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackRangeSelectionlevelingChangedEvent

classmethod setCallbackRangeSelectionlevelingEnabledEnabled(aVisualChannel, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackRangeSelectionlevelingEnabledEvent

classmethod setCallbackRemovedPlaneToPlaneCollectionEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackRemovedPlaneToPlaneCollectionEvent

classmethod setCallbackSetCameraEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackSetCameraEvent

classmethod setCallbackSetPlaneToPlaneCollectionEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackSetPlaneToPlaneCollectionEvent

classmethod setCallbackStreamDataReadyEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addCallbackStreamDataReadyEvent
enabled –

classmethod setCallbackTitleChangedEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackTitleChangedEvent

classmethod setCallbackUpdateViewSizeEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackUpdateViewSizeEvent

classmethod setCallbackUserInfoChangedEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackUserInfoChangedEvent

classmethod setCallbackUserInfoElementChangedEventEnabled(anORSObject, userInfoKey, callbackid, enabled)¶

Parameters:

userInfoKey – user info key that will trigger the callback
callbackid – callback id, should match a prior call to addCallbackUserInfoChangedEvent

classmethod setCallbackViewCineModeChangeEnabled(anORSObject, callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addCallbackViewCineModeChangedEvent
enabled –

classmethod setCallbackViewSlabThicknessChangeEvent(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackViewSlabThicknessChangeEvent

classmethod setCallbackVisualBoxChangedEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackVisualBoxChangedEvent

classmethod setCallbackVisualPlaneChangedEventEnabled(anORSObject, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackVisualPlaneChangedEvent

classmethod setCallbackVisualPlaneEnabledEventEnabled(aVisualPlane, callbackid, enabled)¶

Parameters:: callbackid – callback id, should match a prior call to addCallbackVisualPlaneEnabledEvent

classmethod setClassCallbackMultiROILabelSelectedEnabled(callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addClassCallbackMultiROILabelSelectedEvent
enabled –

classmethod setClassCallbackObjectDeletedEventEnabled(classProgID, callbackid, enabled)¶

Parameters:

classProgID –
callbackid – callback id, should match a prior call to addClassCallbackObjectDeletedEvent
enabled –

classmethod setClassCallbackObjectPublishedEventEnabled(classProgID, callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addClassCallbackObjectPublishedEvent
enabled –

classmethod setClassCallbackPostAddObjectToGroupEventEnabled(classProgID, callbackid, enabled)¶

Parameters:

classProgID –
callbackid – callback id, should match a prior call to addClassCallbackPostAddObjectToGroupEvent

classmethod setClassCallbackPostCopyEventEnabled(classProgID, callbackid, enabled)¶

Parameters:

classProgID –
callbackid – callback id, should match a prior call to addClassCallbackPostCopyEvent
enabled –

classmethod setClassCallbackPostLoadEventEnabled(classProgID, callbackid, enabled)¶

Parameters:

classProgID –
callbackid – callback id, should match a prior call to addClassCallbackPostLoadEvent
enabled –

classmethod setClassCallbackPostRemoveObjectFromGroupEventEnabled(classProgID, callbackid, enabled)¶

Parameters:

classProgID –
callbackid – callback id, should match a prior call to addClassCallbackPostRemoveObjectFromGroupEvent

classmethod setClassCallbackPreAddObjectToGroupEventEnabled(classProgID, callbackid, enabled)¶

Parameters:

classProgID –
callbackid – callback id, should match a prior call to addClassCallbackPreAddObjectToGroupEvent

classmethod setClassCallbackPreRemoveObjectFromGroupEventEnabled(classProgID, callbackid, enabled)¶

Parameters:

classProgID –
callbackid – callback id, should match a prior call to addClassCallbackPreRemoveObjectFromGroupEvent

classmethod setClassCallbackPropagateChildrenNodesOrganizationDirtyEventEnabled(classProgID, callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addClassCallbackPropagateChildrenNodesOrganizationDirtyEvent
enabled –

classmethod setClassCallbackPropagateDataDirtyEventEnabled(classProgID, callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addClassCallbackPropagateDataDirtyEvent
enabled –

classmethod setClassCallbackPropagateDirtyEventEnabled(classProgID, callbackid, enabled)¶

Parameters:

classProgID –
callbackid – callback id, should match a prior call to addClassCallbackPropagateDirtyEvent
enabled –

classmethod setClassCallbackPropagateGeometryDirtyEventEnabled(classProgID, callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addClassCallbackPropagateGeometryDirtyEvent
enabled –

classmethod setClassCallbackPropagateHighlightDirtyEventEnabled(classProgID, callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addClassCallbackPropagateHighlightDirtyEvent
enabled –

classmethod setClassCallbackPropagatePropertyDirtyEventEnabled(classProgID, callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addClassCallbackPropagatePropertyDirtyEvent
enabled –

classmethod setClassCallbackPropagateVisibilityDirtyEventEnabled(classProgID, callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addClassCallbackPropagateVisibilityDirtyEvent
enabled –

classmethod setClassCallbackTitleChangedEventEnabled(classProgID, callbackid, enabled)¶

Parameters:

classProgID –
callbackid – callback id, should match a prior call to addClassCallbackTitleChangedEvent
enabled –

classmethod setClassCallbackViewLayoutPropertiesChangeEventEnabled(callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addClassCallbackViewLayoutPropertiesChangeEvent
enabled –

classmethod setClassCallbackVisibilityChangedEventEnabled(classProgID, callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addClassCallbackVisibilityChangedEvent
enabled –

classmethod setGlobalCallbackChannelLoadedEventEnabled(callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addGlobalCallbackChannelLoadedEvent
enabled –

classmethod setGlobalCallbackChannelModifiedEventEnabled(callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addGlobalCallbackChannelModifiedEvent
enabled –

classmethod setGlobalCallbackCreateDatasetGroupEnabled(callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addGlobalCallbackCreateDatasetGroup
enabled –

classmethod setGlobalCallbackDeleteDatasetGroupEnabled(callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addGlobalCallbackDeleteDatasetGroup
enabled –

classmethod setGlobalCallbackDisplayPostRenderEventEnabled(callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addGlobalCallbackDisplayPostRenderEvent
enabled –

classmethod setGlobalCallbackDisplayPreRenderEventEnabled(callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addGlobalCallbackDisplayPreRenderEvent
enabled –

classmethod setGlobalCallbackDisplayViewModeChangeEventEnabled(callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addGlobalCallbackDisplayViewModeChangeEvent
enabled –

classmethod setGlobalCallbackLayoutUpdatedEventEnabled(callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addGlobalCallbackLayoutUpdatedEvent
enabled –

classmethod setGlobalCallbackNewSessionEventEnabled(callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addGlobalCallbackNewSessionEvent
enabled –

classmethod setGlobalCallbackPreferencesChangedEventEnabled(callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addGlobalCallbackPreferencesChangedEvent
enabled –

classmethod setGlobalCallbackProgressBarResetEvent(callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addGlobalCallbackProgressHasBeenResetEvent
enabled –

classmethod setGlobalCallbackProgressBarStartedEvent(callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addGlobalCallbackProgressHasBeenStartedEvent
enabled –

classmethod setGlobalCallbackProgressBarStoppedEvent(callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addGlobalCallbackProgressHasBeenStoppedEvent
enabled –

classmethod setGlobalCallbackProgressBarTextChangedEvent(callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addGlobalCallbackProgressHasBeenExtraTextChangedEvent
enabled –

classmethod setGlobalCallbackProgressBarUpdatedEvent(callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addGlobalCallbackProgressHasBeenUpdatedEvent
enabled –

classmethod setGlobalCallbackProgressHasBeenCancelledEventEnabled(callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addGlobalCallbackProgressHasBeenCancelledEvent
enabled –

classmethod setGlobalCallbackUpdateDatasetGroupEnabled(callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addGlobalCallbackUpdateDatasetGroup
enabled –

classmethod setGlobalCallbackViewSizeChangeEventEnabled(callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addGlobalCallbackOrsViewSizeChangeEvent
enabled –

classmethod setGlobalCallbackVisualChannelFourQuadrantEventEnabled(callbackid, enabled)¶

Parameters:

callbackid – callback id, should match a prior call to addGlobalCallbackVisualChannelFourQuadrantEvent
enabled –

eventdata¶

class OrsEvent.eventdata.CallbackData(eventname='', originatorguid='', callbackname='')¶

Bases: object

getOriginatorGUID()¶

Gets the GUID of the instance at the origin of the callback

Returns:: output (str) – GUID of the instance at the origin of the callback

OrsEvent¶

eventCallback¶

eventdata¶

Table of Contents

Previous topic

Next topic

This Page