OrsMultiScreenshots

Tool to manage multiple screeshots at once

author:ORS Team
contact:http://theobjects.com
email:info@theobjects.com
organization:Object Research Systems (ORS), Inc.
address:760 St-Paul West, suite 101, Montréal, Québec, Canada, H3C 1M4
copyright:Object Research Systems (ORS), Inc. All rights reserved 2020.
date:Feb 09 2017 11:53
dragonflyVersion:
 2.1.0.223 (D)
UUID:4f473540eee811e69a99448a5bd787f8

Class Code

class OrsPythonPlugins.OrsMultiScreenshots.OrsMultiScreenshots.OrsMultiScreenshots(varname=None, managed=True)
UIDescriptors = [<ORSServiceClass.OrsPlugin.uidescriptor.UIDescriptor object>]
addImageFromView(aView)
interfacemethod addViewSnapshotInImageCollection(viewName, resolution, imageCollection)

Creates an image as the snapshot of a view and adds it to the ImageCollection

Parameters:
  • viewName (str) – a genealogical name of a view
  • resolution (int) – size in pixels of the largest view dimension. The size in the other dimension is determined by keeping the aspect ratio of the view.
  • imageCollection (ORSModel.ors.ImageCollection) – the image collection where the image should be added
Returns:

snapshotImage (ORSModel.ors.Image) – the snapshot image

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.

closable = True
closeWidget(name)
exportAllImages()
getCurrentImage()
getImageCaption(anImage)
getImageCollection()
getImageCount()
getImageNote(anImage)
getImageTitle(anImage)
getResolution2D()
getResolution3D()
getShowButtonDefineImageMetadata()
getVisibleImageIndex()
keepAlive = False
multiple = False
openWidget(name, dock=None, tab=None, x=-1, y=-1, w=-1, l=-1, order=-1)
removeAllImages()
removeCurrentImage()
savable = True
interfacemethod setImageMetadata(anImage, imageTitle, imageCaption, imageNote)

Sets the meta data of an image

Parameters:
  • anImage (ORSModel.ors.Image) – the image to define
  • imageTitle (str) – image title
  • imageCaption (str) – image caption
  • imageNote (str) – image note
setResolution2D(resolution2D)
setResolution3D(resolution3D)
setShowButtonDefineImageMetadata(showButtonDefineImageMetadata)
setVisibleImageIndex(visibleImageIndex)