OrsVolumeROIVisibilityManager

author:ORS Team
contact:http://theobjects.com
email:info@theobjects.com
organization:Object Research Systems (ORS), Inc.
address:460 Ste-Catherine Ouest, suite 600, Montréal, Québec, Canada, H3B 1A7
copyright:Object Research Systems (ORS), Inc. All rights reserved 2021.
date:Feb 16 2016 12:15
dragonflyVersion:
 3.0
UUID:84da1d5ee44311e89d54448a5b5d70c0

Class Code

class OrsPythonPlugins.OrsVolumeROIVisibilityManager.OrsVolumeROIVisibilityManager.OrsVolumeROIVisibilityManager(varname=None)
VOLUME_ROI_CHANNEL_TITLE = 'volume_roi_channel'
addViewCallbacks()
canBeGenericallyOpened = False
cleanup()

Deletes the variables managed by the plugin. It is the place to remove callbacks and other references to Python objects that would prevent them to be garbage collected. This method is called during the process of deletion of the plugin. It calls for the cleanup and deletion of the forms.

enableGlobalCallbacks(enable_callback)
findDisplayer(aROI, aView, createNew)
getDisplayerDict(aROI, createNew=True)
getDisplayerForChannelGUID(channel_guid)
getState()

This method is called when saving a plugin instance in a session to obtain the information required to set up the plugin at the loading of the session.

The plugin needs to be savable (see ORSServiceClass.OrsPlugin.abstractPlugin.AbstractPlugin.savable).

Return:a string of information that will be sent back to the setState method
Rtype:str

Note

The usage of the character " is not permitted, unless escaped.

keepAlive = False
multiple = False
onLoadInfo(channel_guid)
onROIDataDirty(guid)
onROIDeleted(guid)
onROIGeometryDirty(guid)
onROIPropertyDirty(guid)
onROIVisibilityDirty(guid)
onSaveInfo(channel_guid)
savable = True
setState(state)

This method is called to set up the plugin when loading a session.

Note

This method is called only if the string returned by ORSServiceClass.OrsPlugin.orsPlugin.OrsPlugin.getState() at the saving of the session was not empty.

Parameters:state (str) – string of information as provided by the getState during the saving of the session
validate_3D_channel()