OrsHighlightManager

Manages highlighting objects

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 26 2015 18:04
dragonflyVersion:
 3.0
UUID:8e6fe528761411e79b91448a5b5d70c0

Class Code

class OrsPythonPlugins.OrsHighlightManager.OrsHighlightManager.OrsHighlightManager(varname=None, managed=True)
closable = False
getHandleActivation(handleName)

Gets the name of the (action) method of the given state activation

Parameters:state (str) – name of the state
Return:name of the method of the given state activation
Rtype:str
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
keepAlive = False
minimumTimeInSeconds = 0.05
multiple = False
orsDisplayUnderCursorChange()
savable = True
setCursor(handlename)

Sets the current cursor

Parameters:state (str) – state associated to the cursor to set
setHandleActivation(handleName, activationName)

Sets the name of the method of the given state activation

Parameters:
  • state (str) – name of the state. This state should be among those defined by the plugin.
  • activation (str) – name of the method of the given state activation
stateDescriptors = [<ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>]