OrsOverlayGenerator_d97e48e6d07511e7835c107b441a0862¶
- author:
Dragonfly Team
- contact:
- email:
- organization:
Comet Technologies Canada Inc.
- address:
460 Ste-Catherine Ouest, suite 600, Montréal, Québec, Canada, H3B 1A7
- copyright:
Comet Technologies Canada Inc. All rights reserved 2023.
- date:
Nov 23 2017 12:43
- dragonflyVersion:
3.5.0.407 (D)
- UUID:
d97e48e6d07511e7835c107b441a0862
Class Code¶
- class OrsPythonPlugins.OrsOverlayGenerator_d97e48e6d07511e7835c107b441a0862.OrsOverlayGenerator_d97e48e6d07511e7835c107b441a0862.OrsOverlayGenerator_d97e48e6d07511e7835c107b441a0862(*args, **kwargs)¶
- interfacemethod addAPiPOverlay(viewName: str = None) VisualOverlay¶
Create Picture In Picture (PiP) overlay
- Parameters:
viewName (str) – a view layout genealogical name
- Returns:
overlay (ORSModel.ors.VisualOverlay) – an overlay
- addAPiPOverlayAndPublish()¶
Create a Picture in Picture (PiP) overlay and publish it
- classmethod addAnArrow()¶
Create a default arrow in an overlay
- classmethod addAnImageInAnOverlay()¶
Add an image from a file in an overlay
- interfacemethod addAnOverlayTextBox(viewName: str = None) VisualOverlay¶
Create a default text box in an overlay
- Parameters:
viewName (str) – a view layout genealogical name
- Returns:
overlay (ORSModel.ors.VisualOverlay) – an overlay
- addAnOverlayTextBoxAndPublish()¶
Create a default text box in an overlay and publish it
- 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.
- classmethod getMainFormClass()¶
Gets the class of the main form
- Returns:
output –
- classmethod updateArrow(anOverlay)¶
Edit overlay arrow’s shape :param anOverlay: an ORS Visual Overlay object
- interfacemethod updateOverlayTextBox(anOverlay: VisualOverlay) None¶
Convert text into an image when the overlay text box need to be update
- Parameters:
anOverlay (ORSModel.ors.VisualOverlay) – an ORS Visual Overlay object
