OrsPrimitiveManipulator

Manages handling all annotations (rulers, angles, etc)

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 2018.
date:Jun 23 2015 12:03
dragonflyVersion:
 3.0
UUID:296cfd24761911e7b8ad448a5b5d70c0

Class Code

class OrsPythonPlugins.OrsPrimitiveManipulator.OrsPrimitiveManipulator.OrsPrimitiveManipulator(varname=None, managed=True)
OrsHandleAngleActivation()
OrsHandleAngleEditActivation()
OrsHandleAngleSplitActivation()
OrsHandleAngleSplitEditActivation()
OrsHandleArrowActivation()
OrsHandleArrowEditActivation()
OrsHandlePathActivation()
OrsHandlePathEditActivation()
OrsHandlePlaneEditActivation()
OrsHandlePointsActivation()
OrsHandlePointsEditActivation()
OrsHandleRegionEllipseActivation()
OrsHandleRegionEllipseEditActivation()
OrsHandleRegionFreehandActivation()
OrsHandleRegionFreehandEditActivation()
OrsHandleRegionPolygonalActivation()
OrsHandleRegionPolygonalEditActivation()
OrsHandleRegionRectangleActivation()
OrsHandleRegionRectangleEditActivation()
OrsHandleRulerActivation()
OrsHandleRulerEditActivation()
OrsHandleRulerHorizontalActivation()
OrsHandleRulerHorizontalEditActivation()
OrsHandleRulerVerticalActivation()
OrsHandleRulerVerticalEditActivation()
OrsHandleSmartPathActivation()
OrsHandleSmartPathEditActivation()
OrsStateAngle = 'OrsStateAngle'
OrsStateAngleEdit = 'OrsStateAngleEdit'
OrsStateAngleSplit = 'OrsStateAngleSplit'
OrsStateAngleSplitEdit = 'OrsStateAngleSplitEdit'
OrsStateArrow = 'OrsStateArrow'
OrsStateArrowEdit = 'OrsStateArrowEdit'
OrsStateCircle = 'OrsStateCircle'
OrsStateCircleActivation()
OrsStateCircleEdit = 'OrsStateCircleEdit'
OrsStateCircleEditActivation()
OrsStatePath = 'OrsStatePath'
OrsStatePathEdit = 'OrsStatePathEdit'
OrsStatePathEditAdd = 'OrsStatePathEditAdd'
OrsStatePathEditAddActivation()
OrsStatePlane = 'OrsStatePlane'
OrsStatePlaneEdit = 'OrsStatePlaneEdit'
OrsStatePoints = 'OrsStatePoints'
OrsStatePointsEdit = 'OrsStatePointsEdit'
OrsStateRegionEllipse = 'OrsStateRegionEllipse'
OrsStateRegionEllipseEdit = 'OrsStateRegionEllipseEdit'
OrsStateRegionFreehand = 'OrsStateRegionFreehand'
OrsStateRegionFreehandEdit = 'OrsStateRegionFreehandEdit'
OrsStateRegionPolygonal = 'OrsStateRegionPolygonal'
OrsStateRegionPolygonalEdit = 'OrsStateRegionPolygonalEdit'
OrsStateRegionRectangle = 'OrsStateRegionRectangle'
OrsStateRegionRectangleEdit = 'OrsStateRegionRectangleEdit'
OrsStateRuler = 'OrsStateRuler'
OrsStateRulerEdit = 'OrsStateRulerEdit'
OrsStateRulerHorizontal = 'OrsStateRulerHorizontal'
OrsStateRulerHorizontalEdit = 'OrsStateRulerHorizontalEdit'
OrsStateRulerVertical = 'OrsStateRulerVertical'
OrsStateRulerVerticalEdit = 'OrsStateRulerVerticalEdit'
OrsStateSmartPath = 'OrsStateSmartPath'
OrsStateSmartPathEdit = 'OrsStateSmartPathEdit'
OrsStateSquare = 'OrsStateSquare'
OrsStateSquareActivation()
OrsStateSquareEdit = 'OrsStateSquareEdit'
OrsStateSquareEditActivation()
UIDescriptors = [<ORSServiceClass.OrsPlugin.uidescriptor.UIDescriptor object>]
classmethod addControlPoint(anAnnotation, timeStep, position)
addRemoveControlPointAction(event)
addRemoveControlPointToPathOrRegion()
closable = False
closeWidget(name)
contextualMenu(context)
classmethod createPrimitive(primitiveClass, aLayoutName, associatedState)
classmethod deletePrimitive(anAnnotation)
classmethod deselectControlPoint(anAnnotation, controlPointIndex, timeStep)
enterAction()
enterStatePathEditAdd()
enterStatePathEditAddFromEdit()
enterTemporaryCircleStateAction()
enterTemporaryHorizontalRulerStateAction()
enterTemporarySquareStateAction()
enterTemporaryVerticalRulerStateAction()
handleChanged(oldHandleName, newHandleName)

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
classmethod insertControlPoint(index, anAnnotation, timeStep, position)
keepAlive = False
multiple = False
openWidget(name, dock=None, tab=None, x=-1, y=-1, w=-1, l=-1, order=-1)
classmethod removeControlPoint(anAnnotation, controlPointIndex, timeStep)
resetHandler()
savable = True
classmethod selectControlPoint(anAnnotation, controlPointIndex, timeStep)
classmethod setControlPointPosition(anAnnotation, controlPointIndex, timeStep, position)
showPrimitive(primitive)
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>, <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>]
switchToAngleStateAction()
switchToArrowStateAction()
switchToEllipseRegionStateAction()
switchToFreehandRegionStateAction()
switchToPathStateAction()
switchToPointStateAction()
switchToPolygonalRegionStateAction()
switchToRectangleRegionStateAction()
switchToRulerStateAction()
switchToSmartPathStateAction()
switchToUnlockAngleStateAction()
classmethod translatePrimitive(anAnnotation, timeStep, xOffset, yOffset, zOffset)