OrsLayoutManager

Manages all aspects of view and scene layouts

author:

Dragonfly Team

contact:

https://dragonfly.comet.tech

email:

support.dragonfly@comet.tech

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:

Dec 20 2015 21:15

dragonflyVersion:

3.0

UUID:

6bbcba26761511e78fd4448a5b5d70c0

Class Code

class OrsPythonPlugins.OrsLayoutManager.OrsLayoutManager.OrsLayoutManager(*args, **kwargs)
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.

interfacemethod create2DSingleView(replacingLayoutGenealogicalName: str) → None

The input scene is replaced with a 2D single scene

Parameters:

replacingLayoutGenealogicalName (str) – a layout name

interfacemethod create3DSingleView(replacingLayoutGenealogicalName: str) → None

The input scene is replaced with a 3D single scene

Parameters:

replacingLayoutGenealogicalName (str) – a layout name

interfacemethod createHDoubleView(replacingLayoutGenealogicalName: str) → None

The input scene is replaced with a horizontal double scene

Parameters:

replacingLayoutGenealogicalName (str) – a layout name

interfacemethod createHSingleTripleView(replacingLayoutGenealogicalName: str) → None

The input scene is replaced with a single plus horizontal triple scene

Parameters:

replacingLayoutGenealogicalName (str) – a layout name

interfacemethod createHTripleView(replacingLayoutGenealogicalName: str) → None

The input scene is replaced with a horizontal triple scene

Parameters:

replacingLayoutGenealogicalName (str) – a layout name

interfacemethod createQuadView3dRight(replacingLayoutGenealogicalName: str) → None

The input scene is replaced with a quadruple view scene with 3D on the upper right

Parameters:

replacingLayoutGenealogicalName (str) – a layout name

interfacemethod createVDoubleView(replacingLayoutGenealogicalName: str) → None

The input scene is replaced with a vertical double scene

Parameters:

replacingLayoutGenealogicalName (str) – a layout name

interfacemethod createVSingleTripleView(replacingLayoutGenealogicalName: str) → None

The input scene is replaced with a single plus vertical triple scene

Parameters:

replacingLayoutGenealogicalName (str) – a layout name

interfacemethod createVTripleView(replacingLayoutGenealogicalName: str) → None

The input scene is replaced with a vertical triple scene

Parameters:

replacingLayoutGenealogicalName (str) – a layout name

interfacemethod createnQuadView(replacingLayoutGenealogicalName: str) → None

The input scene is replaced with a quadruple view scene

Parameters:

replacingLayoutGenealogicalName (str) – a layout name

classmethod getMainFormClass()

Gets the class of the main form

Returns:

output –

interfacemethod nSimpleScene(newScenelayoutClass: str = 'Layout1xXY', count: int = 2, vertical: bool = True, sceneWeights: List[int] = None, createDefaultTextPresenters: bool = True) → None

Set the count of scene in the current context top layout

Parameters:

  • newScenelayoutClass (str) – a layout helper class name

  • count (int) – scene count

  • vertical (bool) – scene orientation

  • sceneWeights (int) [count=[0, None]] – scene weights

  • createDefaultTextPresenters (bool) – if True, the default text presenters will be created for all views in the new layout (unless already present); otherwise, no new text presenter will be created.

interfacemethod nmSimpleScene(newScenelayoutClass: str = 'Layout1xXY', count: int = 0, row: int = 1, col: int = 1, createDefaultTextPresenters: bool = True) → None

Set the count of scene in the current context top layout

Parameters:

  • newScenelayoutClass (str) – a layout helper class name

  • count (int) – total scene count - if left at 0, count will be col x row

  • row (int) – scene row count

  • col (int) – scene col count

  • createDefaultTextPresenters (bool) – if True, the default text presenters will be created for all views in the new layout (unless already present); otherwise, no new text presenter will be created.

interfacemethod orthogonalizedAllOther2DView(layoutGenealogicalName: str) → None

Orthogonalize all the other 2D views from the view selected

Parameters:

layoutGenealogicalName (str) – a display layout name

refreshUIFromModel()

Calls the UI to be updated based on the implementation

classmethod startupDefault(openMainForm=True)

Creates an instance of the plugin class and opens the main form (if required) at the default position.

Returns:

output (AbstractPlugin) – plugin instance

interfacemethod switchTo2DSingleView() → None

The input scene is replaced with a 2D single scene

interfacemethod switchTo3DSingleView() → None

The input scene is replaced with a 3D single scene