OrsBasicManipulate¶
Manages the basic user interactions
- 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:
Jun 16 2015 18:10
- dragonflyVersion:
3.0
- UUID:
b1a3ab10760f11e79f61448a5b5d70c0
Class Code¶
- class OrsPythonPlugins.OrsBasicManipulate.OrsBasicManipulate.OrsBasicManipulate(*args, **kwargs)¶
- classmethod centerOnIntersectionOfViewsMethod(view: View, onViewCenter)¶
Center 2D views of a Layout pre condition: len(view2D) == 3
- Parameters:
view (ORSModel.ors.View) – the main view
onViewCenter (bool) – on the center of the provided view
- interfacemethod centerOnIntersectionOfViewsMethodFromGenealogicalName(name: str, onViewCenter: bool) None¶
Center 2D views of a Layout pre condition: len(view2D) == 3
- Parameters:
name (str) – the main view layout name
onViewCenter (bool) – on the center of the provided view
- 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 fitViewFromXMinus(view: View, box: Box) None¶
Fit the with looking toward x plus
- Parameters:
view (ORSModel.ors.View) – the view to fit
box (ORSModel.ors.Box) – box to look at
- interfacemethod fitViewFromXPlus(view: View, box: Box) None¶
Fit the with looking toward x minus
- Parameters:
view (ORSModel.ors.View) – the view to fit
box (ORSModel.ors.Box) – box to look at
- interfacemethod fitViewFromYMinus(view: View, box: Box) None¶
Fit the with looking toward y plus
- Parameters:
view (ORSModel.ors.View) – the view to fit
box (ORSModel.ors.Box) – box to look at
- interfacemethod fitViewFromYPlus(view: View, box: Box) None¶
Fit the with looking toward y minus
- Parameters:
view (ORSModel.ors.View) – the view to fit
box (ORSModel.ors.Box) – box to look at
- interfacemethod fitViewFromZMinus(view: View, box: Box) None¶
Fit the with looking toward z plus
- Parameters:
view (ORSModel.ors.View) – the view to fit
box (ORSModel.ors.Box) – box to look at
- interfacemethod fitViewFromZPlus(view: View, box: Box) None¶
Fit the with looking toward z minus
- Parameters:
view (ORSModel.ors.View) – the view to fit
box (ORSModel.ors.Box) – box to look at
- interfacemethod fitViewWithGenealogicalNameFromDirection(name: str, normal: Vector3, up: Vector3, box: Box) None¶
fit the view with name using normal, up and a box to fit to
- Parameters:
name (str) – the main view layout name
normal (ORSModel.ors.Vector3) – a normal direction
up (ORSModel.ors.Vector3) – a normal direction
box (ORSModel.ors.Box) – a box to fit
- classmethod getMainFormClass()¶
Gets the class of the main form
- Returns:
output –
- handleChanged(oldState, newState)¶
This method is called when the state of the application is changed.
- Parameters:
oldState (str) – name of the old (previous) state
newState (str) – name of the new (current) state
- handleTriggered(eventdata)¶
This method is called on every user input (mouse move, mouse click, key press, …) when the current state of the application is one of those declared by the plugin. This method can be used to perform specific tasks even if no action is currently in progress.
- Parameters:
eventData (OrsEvent.eventdata.InputEventData) – the event data
- updateRotationViewHighlight(oldState, newState)¶
Update highlightRotational of the cursor views based on state changes