OrsBasicManipulate

Manages the basic user interactions

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:Jun 16 2015 18:10
dragonflyVersion:
 3.0
UUID:b1a3ab10760f11e79f61448a5b5d70c0

Class Code

class OrsPythonPlugins.OrsBasicManipulate.OrsBasicManipulate.OrsBasicManipulate(varname=None)
OrsState3DCursor = 'OrsState3DCursor'
OrsState3DCursorActivation()
OrsState3DCursorActivationCondition(eventData)
OrsStateCine = 'OrsStateCine'
OrsStateCineActivation()
OrsStateCineInfinite = 'OrsStateCineInfinite'
OrsStateCineInfiniteActivation()
OrsStateMoveCameraPivot = 'OrsStateMoveCameraPivot'
OrsStateMoveCameraPivotActivation()
OrsStateObliqueX = 'OrsStateObliqueX'
OrsStateObliqueXActivation()
OrsStateObliqueXAtCenter = 'OrsStateObliqueXAtCenter'
OrsStateObliqueXAtCenterActivation()
OrsStateObliqueXY = 'OrsStateObliqueXY'
OrsStateObliqueXYActivation()
OrsStateObliqueXYOnlyXActivation()
OrsStateObliqueXYOnlyYActivation()
OrsStateObliqueY = 'OrsStateObliqueY'
OrsStateObliqueYActivation()
OrsStateObliqueYAtCenter = 'OrsStateObliqueYAtCenter'
OrsStateObliqueYAtCenterActivation()
OrsStatePan = 'OrsStatePan'
OrsStatePanActivation()
OrsStateRotateCamera = 'OrsStateRotateCamera'
OrsStateRotateCameraActivation()
OrsStateRotateCameraAtCenter = 'OrsStateRotateCameraAtCenter'
OrsStateRotateCameraAtCenterInfinity = 'OrsStateRotateCameraAtCenterInfinity'
OrsStateRotateCameraAtCenterInfinityActivation()
OrsStateShowCameraPivot = 'OrsStateShowCameraPivot'
OrsStateShowCameraPivotActivation()
OrsStateSlabThickness = 'OrsStateSlabThickness'
OrsStateSlabThicknessActivation()
OrsStateTimeStep = 'OrsStateTimeStep'
OrsStateTimeStepActivation()
OrsStateTimeStepInfinite = 'OrsStateTimeStepInfinite'
OrsStateTimeStepInfiniteActivation()
OrsStateTrack = 'OrsStateTrack'
OrsStateTrackActivation()
OrsStateTrackCenter = 'OrsStateTrackCenter'
OrsStateTrackCenterActivation()
OrsStateTrackConstraintHorizontally = 'OrsStateTrackConstraintHorizontally'
OrsStateTrackConstraintHorizontallyActivation()
OrsStateTrackConstraintRotation = 'OrsStateTrackConstraintRotation'
OrsStateTrackConstraintRotationActivation()
OrsStateTrackConstraintVertically = 'OrsStateTrackConstraintVertically'
OrsStateTrackConstraintVerticallyActivation()
OrsStateTrackSpin3D = 'OrsStateTrackSpin3D'
OrsStateTrackSpin3DActivation()
OrsStateZoom = 'OrsStateZoom'
OrsStateZoomActivation()
OrsStateZoomAtCenter = 'OrsStateZoomAtCenter'
OrsStateZoomAtCenterActivation()
OrsStateZoomTrackCenter = 'OrsStateZoomTrackCenter'
OrsStateZoomTrackCenterActivation()
OrsTemporaryStateCine = 'OrsTemporaryStateCine'
OrsTemporaryStateTimeStep = 'OrsTemporaryStateTimeStep'
UIDescriptors = [<ORSServiceClass.OrsPlugin.uidescriptor.UIDescriptor object>]
addLayoutChangeCallback()
canBeInCameraPivotState()
canBeInWalkState()
centerAllViewsOnCurrentViewCenter()
centerOnIntersectionOfViews()
classmethod centerOnIntersectionOfViewsMethod(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, onViewCenter)

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.

enterTemporaryCineAction()
enterTemporaryPanAction()
enterTemporaryShowCameraPivotAction()
enterTemporaryStateTrackConstraintHorizontally()
enterTemporaryStateTrackConstraintRotation()
enterTemporaryStateTrackConstraintVertically()
enterTemporaryTrackAction()
enterTemporaryTrackCenterAction()
enterTemporaryWalkAction()
enterTemporaryZoomAction()
enterTemporaryZoomTrackCenterAction()
fitCurrentViewFromDirection(direction, up)
fitToView()
fitToViewAction()
interfacemethod fitViewFromXMinus(view, box)

Fit the with looking toward x plus

Parameters:
interfacemethod fitViewFromXPlus(view, box)

Fit the with looking toward x minus

Parameters:
interfacemethod fitViewFromYMinus(view, box)

Fit the with looking toward y plus

Parameters:
interfacemethod fitViewFromYPlus(view, box)

Fit the with looking toward y minus

Parameters:
interfacemethod fitViewFromZMinus(view, box)

Fit the with looking toward z plus

Parameters:
interfacemethod fitViewFromZPlus(view, box)

Fit the with looking toward z minus

Parameters:
classmethod getMainFormClass()

Gets the class of the main form

Returns:output –
getShowCine()
getShowFit()
getShowPan()
getShowPivot()
getShowReset()
getShowTrack()
getShowWalk()
getShowZoom()
goToDefaultState()
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
keepAlive = False
lookAtPivot()
lookAtPivotAction()
moveToFirstSlice(event)
moveToFirstSliceAction()
moveToFirstTimeStep(event)
moveToFirstTimeStepAction()
moveToLastSlice(event)
moveToLastSliceAction()
moveToLastTimeStep(event)
moveToLastTimeStepAction()
moveToNextSlice(event, onCurrentDisplay=True)
moveToNextSliceAction()
moveToNextSliceActionAlternate()
moveToNextTimeStep(event, onCurrentDisplay=True)
moveToNextTimeStepAction()
moveToPreviousSlice(event, onCurrentDisplay=True)
moveToPreviousSliceAction()
moveToPreviousSliceActionAlternate()
moveToPreviousTimeStep(event, onCurrentDisplay=True)
moveToPreviousTimeStepAction()
multiple = False
orsCurrentDisplayChange()
pluginClass = 'Control'
resetCurrentHandler()
resetView()
resetViewAction()
rotateOblique_X_Action()
rotateOblique_Y_Action()
savable = True
setCameraFromXMinus()
setCameraFromXMinusAction()
setCameraFromXPlus()
setCameraFromXPlusAction()
setCameraFromYMinus()
setCameraFromYMinusAction()
setCameraFromYPlus()
setCameraFromYPlusAction()
setCameraFromZMinus()
setCameraFromZMinusAction()
setCameraFromZPlus()
setCameraFromZPlusAction()
setShowCine(showStateButtonCine)
setShowFit(showStateButtonFit)
setShowPan(showStateButtonPan)
setShowPivot(showStateButtonPivot)
setShowReset(showStateButtonReset)
setShowTrack(showStateButtonTrack)
setShowWalk(showStateButtonWalk)
setShowZoom(showStateButtonZoom)
show3DCursorOfCurrentDisplay(show)
showHideDisplayWidget(show=True)
stateDescriptors = [<ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>]
stopSpin3DAction()
switchToObliqueX()
switchToObliqueY()
switchToOrsStateCineAction()
switchToOrsStateMoveCameraPivotAction()
switchToOrsStatePanAction()
switchToOrsStateTrackAction()
switchToOrsStateWalkAction()
switchToOrsStateZoomAction()
switchToStateTrackSpin3DAction()
switchToTrackCenter()
switchToZoomTrackCenter()
toggle3DCursorAction()
toggle3DCursorOfCurrentDisplay()
updateButtonAvailability()
updateButtonVisibility()