diff options
| author | Ninad Sathaye <ninad@nanorex.com> | 2008-09-04 19:58:15 +0000 |
|---|---|---|
| committer | Ninad Sathaye <ninad@nanorex.com> | 2008-09-04 19:58:15 +0000 |
| commit | a16106ad4cd5d2a77d3307866a398126ff7bda46 (patch) | |
| tree | 9f21600be81ed8800f07c0ba6d81da5038f81616 | |
| parent | 05fe7a4cc3d4a4831388c3cb62e68a6465bb58d7 (diff) | |
| download | nanoengineer-theirix-a16106ad4cd5d2a77d3307866a398126ff7bda46.tar.gz nanoengineer-theirix-a16106ad4cd5d2a77d3307866a398126ff7bda46.zip | |
cleanup -- moved LineMode into its own pkg 'Line' (preparation for further cleanup)
| -rw-r--r-- | cad/src/commandSequencer/builtin_command_loaders.py | 2 | ||||
| -rw-r--r-- | cad/src/dna/temporary_commands/DnaLineMode.py | 4 | ||||
| -rw-r--r-- | cad/src/protein/temporary_commands/PeptideLineMode.py | 2 | ||||
| -rw-r--r-- | cad/src/temporary_commands/LineMode.py | 649 | ||||
| -rw-r--r-- | cad/src/temporary_commands/RotateAboutPoint_Command.py | 4 |
5 files changed, 6 insertions, 655 deletions
diff --git a/cad/src/commandSequencer/builtin_command_loaders.py b/cad/src/commandSequencer/builtin_command_loaders.py index ed2d44606..e4b3eedcb 100644 --- a/cad/src/commandSequencer/builtin_command_loaders.py +++ b/cad/src/commandSequencer/builtin_command_loaders.py @@ -56,7 +56,7 @@ from temporary_commands.ZoomToAreaMode import ZoomToAreaMode from temporary_commands.ZoomInOutMode import ZoomInOutMode from temporary_commands.PanMode import PanMode from temporary_commands.RotateMode import RotateMode -from temporary_commands.LineMode import LineMode +from temporary_commands.Line.LineMode import LineMode from temporary_commands.RotateAboutPoint_Command import RotateAboutPoint_Command #Carbon nanotube command imports diff --git a/cad/src/dna/temporary_commands/DnaLineMode.py b/cad/src/dna/temporary_commands/DnaLineMode.py index d204a1ec7..121eb6791 100644 --- a/cad/src/dna/temporary_commands/DnaLineMode.py +++ b/cad/src/dna/temporary_commands/DnaLineMode.py @@ -9,8 +9,8 @@ TODO: - User Preferences for different rubberband line display styles """ -from temporary_commands.LineMode import LineMode -from temporary_commands.LineMode import LineMode_GM +from temporary_commands.Line.LineMode import LineMode +from temporary_commands.Line.LineMode import LineMode_GM from graphics.drawing.drawDnaLadder import drawDnaLadder from graphics.drawing.drawDnaRibbons import drawDnaRibbons diff --git a/cad/src/protein/temporary_commands/PeptideLineMode.py b/cad/src/protein/temporary_commands/PeptideLineMode.py index cb2840880..5a13980c5 100644 --- a/cad/src/protein/temporary_commands/PeptideLineMode.py +++ b/cad/src/protein/temporary_commands/PeptideLineMode.py @@ -9,7 +9,7 @@ """ -from temporary_commands.LineMode import LineMode +from temporary_commands.Line.LineMode import LineMode from graphics.drawing.drawPeptideTrace import drawPeptideTrace, drawPeptideTrace_new diff --git a/cad/src/temporary_commands/LineMode.py b/cad/src/temporary_commands/LineMode.py deleted file mode 100644 index 20b6e06a5..000000000 --- a/cad/src/temporary_commands/LineMode.py +++ /dev/null @@ -1,649 +0,0 @@ -# Copyright 2007-2008 Nanorex, Inc. See LICENSE file for details. -""" -@author: Ninad -@version: $Id$ -@copyright: 2007-2008 Nanorex, Inc. See LICENSE file for details. -@license: GPL - -TODOs: -- Refactor/ expand snap code. Should all the snapping code be in its own module? -- Need to discuss and derive various snap rules - Examples: If 'theta_snap' between dragged line and the two reference enties - is the same, then the snap should use the entity with shortest - distance - Should horizontal/vertical snap checkes always be done before - standard axis snap checks -- guess-- No. The current implementation - however skips the standard axis snap check if the - horizontal/vertical snap checks succeed. - -""" - -from commands.Select.Select_Command import Select_Command -from commands.Select.Select_GraphicsMode import Select_GraphicsMode - -from graphics.drawing.CS_draw_primitives import drawline -from graphics.drawing.CS_draw_primitives import drawsphere -from utilities.constants import black, darkred, blue - -from geometry.VQT import vlen, norm, angleBetween, V, ptonline - -import foundation.env as env -from utilities.prefs_constants import DarkBackgroundContrastColor_prefs_key -from utilities.prefs_constants import cursorTextFontSize_prefs_key - -from utilities.GlobalPreferences import USE_COMMAND_STACK - -STARTPOINT_SPHERE_RADIUS = 1.0 -STARTPOINT_SPHERE_DRAWLEVEL = 2 - -# == GraphicsMode part - -_superclass_for_GM = Select_GraphicsMode - -class LineMode_GM( Select_GraphicsMode ): - """ - Custom GraphicsMode for use as a component of LineMode. - - It's a temporary mode that draws temporary line with mouse click points - as endpoints and then returns to the previous mode when the - mouseClickLimit specified by the user is reached. - - @see: L{DnaLineMode} - - TODO: - -Need further documentation. - """ - - #Initial values of instance variables -- - - #The first end point of the line being drawn. - #It gets initialized during left down -- - endPoint1 = None - #The second endpoint of the line. This gets constantly updated as you - # free drag the mouse (bare motion) - endPoint2 = None - - - #Rubberband line color - rubberband_line_color = env.prefs[DarkBackgroundContrastColor_prefs_key] - rubberband_line_width = 1 #thickness or 'width' for drawer.drawline - - endPoint1_sphereColor = darkred - endPoint1_sphereOpacity = 0.5 - - _snapOn = False - _snapType = '' - _standardAxisVectorForDrawingSnapReference = None - - #Flag that determines whether the cursor text should be rendered in - #self.Draw. Example: This class draws cursor text at the end of the draw - #method. Subclass of this class (say DnaLine_GM) calls this Draw mthod - #and then do some more drawing and then again want to draw the cursor text - #So that subclass can temporarily supress cursor text. - #@see: DnaLine_GM.Draw() - _ok_to_render_cursor_text = True - - #cursor text. ##@@ rename it to 'cursorText' -- Ninad - text = '' - - #the drawing plane on which the line (or the structure in subclasses) - #will be placed. - plane = None - - def Enter_GraphicsMode(self): - _superclass_for_GM.Enter_GraphicsMode(self) - self._ok_to_render_cursor_text = True - - #Set the drawing plane to the one returned by self.getDrawingPlane() - #subclasses override the implementation of self.getDrawingPlane() - #@see self.setDrawingPlane(). - self.plane = self.getDrawingPlane() - - - def getDrawingPlane(self): - """ - Overridden in subclasses. - - Returns the reference plane on which the line will be drawn. - The default immplementation returns None. - @see: DnaDuplex_GraphicsMode.getDrawingPlane() - """ - return self.plane - - - def setDrawingPlane(self, plane): - """ - Sets the plane on which the line will be drawn (in subclasses , this - is the plane on which the structure will be created.) - @see: DnaDuplex_GraphicsMode.jigLeftUp() - @see: DnaDuplex_EditCommand.updateDrawingPlane() - """ - if isinstance(plane, self.win.assy.Plane): - self.plane = plane - else: - self.plane = None - - def isSpecifyPlaneToolActive(self): - """ - Default implementation returns False. Subclasses can override this - method. - @see: DnaDuplex_Graphicsmode.isSpecifyPlaneToolActive() which overrides - this method. - """ - return False - - - def leftDown(self, event): - """ - Event handler for LMB press event. - """ - if self.isSpecifyPlaneToolActive(): - #@@@BUGGY: Ideally _superclass.leftDown should take care of this. - #but Select_GraphicsMode doesn't do that. - obj = self.get_obj_under_cursor(event) - if obj is None: # Cursor over empty space. - self.emptySpaceLeftDown(event) - return - - self.doObjectSpecificLeftDown(obj, event) - return - - self._leftDown_determine_endPoint1(event) - - #NIY code that accepts highlighted atom center as the endPoint instead - ##of always using the glpane depth. To be implemented - ##if self.glpane.selobj is not None: - ##if isinstance(selobj, Atom): - ##self.endPoint1 = self.glpane.selobj.posn() - - if self._snapOn and self.endPoint2 is not None: - # This fixes a bug. Example: Suppose the dna line is snapped to a - # constraint during the bare motion and the second point is clicked - # when this happens, the second clicked point is the new - #'self.endPoint1' which needs to be snapped like we did for - # self.endPoint2 in the bareMotion. Setting self._snapOn to False - # ensures that the cursor is set to the simple Pencil cursor after - # the click -- Ninad 2007-12-04 - self.endPoint1 = self.snapLineEndPoint() - self._snapOn = False - - self.command.mouseClickPoints.append(self.endPoint1) - return - - - def _leftDown_determine_endPoint1(self, event): - """ - Determine the line endpoint (self.endPoint1) during the leftDown - event. Subclasses can override this method. - """ - plane = self.getDrawingPlane() - if plane: - self.endPoint1 = self.dragstart_using_plane_depth( - event, plane ) - else: - #The endPoint1 and self.endPoint2 are the mouse points at the 'water' - #surface. Soon, support will be added so that these are actually points - #on a user specified reference plane. Also, once any temporary mode - # begins supporting highlighting, we can also add feature to use - # coordinates of a highlighted object (e.g. atom center) as endpoints - # of the line - farQ_junk, self.endPoint1 = self.dragstart_using_GL_DEPTH( - event, - always_use_center_of_view = True ) - - - def bareMotion(self, event): - """ - Event handler for simple drag event. (i.e. the free drag without holding - down any mouse button) - @see: self.isSpecifyPlaneToolActive() - @see: self.getDrawingPlane() - @see: DnaDuplex_Graphicsmode.isSpecifyPlaneToolActive() - """ - if not self.isSpecifyPlaneToolActive(): - if len(self.command.mouseClickPoints) > 0: - plane = self.getDrawingPlane() - if plane: - self.endPoint2 = self.dragto( self.endPoint1, - event, - perp = norm(plane.getaxis())) - else: - self.endPoint2 = self.dragto( self.endPoint1, event) - - self.endPoint2 = self.snapLineEndPoint() - self.update_cursor_for_no_MB() - self.glpane.gl_update() - - value = _superclass_for_GM.bareMotion(self,event) - - #Needed to make sure that the cursor is updated properly when - #the mouse is moved after the 'specify reference plane tool is - #activated/deactivated - self.update_cursor() - - return value # russ 080527 - - def snapLineEndPoint(self): - """ - Snap the line to the specified constraints. - To be refactored and expanded. - @return: The new endPoint2 i.e. the moving endpoint of the rubberband - line . This value may be same as previous or snapped so that it - lies on a specified vector (if one exists) - @rtype: B{A} - """ - endPoint2 = self._snapEndPointHorizontalOrVertical() - - if not self._snapOn: - endPoint2 = self._snapEndPointToStandardAxis() - pass - - return endPoint2 - - def _snapEndPointHorizontalOrVertical(self): - """ - Snap the second endpoint of the line (and thus the whole line) to the - screen horizontal or vertical vectors. - @return: The new endPoint2 i.e. the moving endpoint of the rubberband - line . This value may be same as previous or snapped so that - line is horizontal or vertical depending upon the angle it - makes with the horizontal and vertical. - @rtype: B{A} - """ - up = self.glpane.up - down = self.glpane.down - left = self.glpane.left - right = self.glpane.right - - endPoint2 = self.endPoint2 - - snapVector = V(0, 0, 0) - - currentLineVector = norm(self.endPoint2 - self.endPoint1) - - theta_horizontal = angleBetween(right, currentLineVector) - theta_vertical = angleBetween(up, currentLineVector) - - theta_horizontal_old = theta_horizontal - theta_vertical_old = theta_vertical - - if theta_horizontal != 90.0: - theta_horizontal = min(theta_horizontal, - (180.0 - theta_horizontal)) - - if theta_vertical != 90.0: - theta_vertical = min(theta_vertical, - 180.0 - theta_vertical) - - theta = min(theta_horizontal, theta_vertical) - - if theta <= 2.0 and theta != 0.0: - self._snapOn = True - if theta == theta_horizontal: - self._snapType = 'HORIZONTAL' - if theta_horizontal == theta_horizontal_old: - snapVector = right - else: - snapVector = left - elif theta == theta_vertical: - self._snapType = 'VERTICAL' - if theta_vertical == theta_vertical_old: - snapVector = up - else: - snapVector = down - - endPoint2 = self.endPoint1 + \ - vlen(self.endPoint1 - self.endPoint2)*snapVector - - else: - self._snapOn = False - - return endPoint2 - - def _snapEndPointToStandardAxis(self): - """ - Snap the second endpoint of the line so that it lies on the nearest - axis vector. (if its close enough) . This functions keeps the uses the - current rubberband line vector and just extends the second end point - so that it lies at the intersection of the nearest axis vector and the - rcurrent rubberband line vector. - @return: The new endPoint2 i.e. the moving endpoint of the rubberband - line . This value may be same as previous or snapped to lie on - the nearest axis (if one exists) - @rtype: B{A} - """ - x_axis = V(1, 0, 0) - y_axis = V(0, 1, 0) - z_axis = V(0, 0, 1) - - endPoint2 = self.endPoint2 - currentLineVector = norm(self.endPoint2 - self.endPoint1) - - theta_x = angleBetween(x_axis, self.endPoint2) - theta_y = angleBetween(y_axis, self.endPoint2) - theta_z = angleBetween(z_axis, self.endPoint2) - - theta_x = min(theta_x, (180 - theta_x)) - theta_y = min(theta_y, (180 - theta_y)) - theta_z = min(theta_z, (180 - theta_z)) - - theta = min(theta_x, theta_y, theta_z) - - if theta < 2.0: - if theta == theta_x: - self._standardAxisVectorForDrawingSnapReference = x_axis - elif theta == theta_y: - self._standardAxisVectorForDrawingSnapReference = y_axis - elif theta == theta_z: - self._standardAxisVectorForDrawingSnapReference = z_axis - - endPoint2 = ptonline(self.endPoint2, - V(0, 0, 0), - self._standardAxisVectorForDrawingSnapReference) - else: - self._standardAxisVectorForDrawingSnapReference = None - - return endPoint2 - - def _drawSnapReferenceLines(self): - """ - Draw the snap reference lines as dottedt lines. Example, if the - moving end of the rubberband line is 'close enough' to a standard axis - vector, that point is 'snapped' soi that it lies on the axis. When this - is done, program draws a dotted line from origin to the endPoint2 - indicating that the endpoint is snapped to that axis line. - - This method is called inside the self.Draw method. - - @see: self._snapEndPointToStandardAxis - @see: self.Draw - """ - if self.endPoint2 is None: - return - if self._standardAxisVectorForDrawingSnapReference: - drawline(blue, - V(0, 0, 0), - self.endPoint2, - dashEnabled = True, - stipleFactor = 4, - width = 2) - - - def Draw(self): - """ - Draw method for this temporary mode. - """ - _superclass_for_GM.Draw(self) - - #This fixes NFR bug 2803 - #Don't draw the Dna rubberband line if the cursor is over the confirmation - #corner. But make sure to call superclass.Draw method before doing this - #check because we need to draw the rest of the model in the graphics - #mode!. @see: DnaLineMode_GM.Draw() which does similar thing to not - #draw the rubberband line when the cursor is on the confirmation corner - handler = self.o.mouse_event_handler - if handler is not None and handler is self._ccinstance: - self.update_cursor() - return - - if self.endPoint2 is not None: - - if self.endPoint1: - drawsphere(self.endPoint1_sphereColor, - self.endPoint1, - STARTPOINT_SPHERE_RADIUS, - STARTPOINT_SPHERE_DRAWLEVEL, - opacity = self.endPoint1_sphereOpacity - ) - drawline(self.rubberband_line_color, - self.endPoint1, - self.endPoint2, - width = self.rubberband_line_width, - dashEnabled = True) - - self._drawSnapReferenceLines() - - if self._ok_to_render_cursor_text: - self._drawCursorText() - - def _drawCursorText(self): - """ - """ - if self.endPoint1 is None or self.endPoint2 is None: - return - - self.text = '' - textColor = black - - #Draw the text next to the cursor that gives info about - #number of base pairs etc. So this class and its command class needs - #cleanup. e.g. callbackMethodForCursorTextString should be simply - #self.command.getCursorText() and like that. -- Ninad2008-04-17 - if self.command and hasattr(self.command, - 'callbackMethodForCursorTextString'): - self.text, textColor = self.command.callbackMethodForCursorTextString( - self.endPoint1, - self.endPoint2) - else: - vec = self.endPoint2 - self.endPoint1 - theta = self.glpane.get_angle_made_with_screen_right(vec) - dist = vlen(vec) - self.text = "%5.2fA, %5.2f deg"%(dist, theta) - - self.glpane.renderTextNearCursor(self.text, - textColor = textColor, - fontSize = env.prefs[cursorTextFontSize_prefs_key]) - - - def leftUp(self, event): - """ - Event handler for Left Mouse button left-up event - """ - if self.isSpecifyPlaneToolActive(): - if self.cursor_over_when_LMB_pressed == 'Empty Space': - self.emptySpaceLeftUp(event) - return - - obj = self.current_obj - if obj is None: # Nothing dragged (or clicked); return. - return - - self.doObjectSpecificLeftUp(obj, event) - return - - if self.command.mouseClickLimit is None: - if len(self.command.mouseClickPoints) == 2: - self.endPoint2 = None - self.command.restore_gui() - self.glpane.gl_update() - return - - - assert len(self.command.mouseClickPoints) <= self.command.mouseClickLimit - - if len(self.command.mouseClickPoints) == self.command.mouseClickLimit: - self.endPoint2 = None - self._snapOn = False - self._standardAxisVectorForDrawingSnapReference = None - self.glpane.gl_update() - self.command.Done(exit_using_done_or_cancel_button = False) - return - - - def update_cursor_for_no_MB(self): - """ - Update the cursor for this mode. - """ - - #self.glpane.setCursor(self.win.SelectAtomsCursor) - if self._snapOn: - if self._snapType == 'HORIZONTAL': - self.glpane.setCursor(self.win.pencilHorizontalSnapCursor) - elif self._snapType == 'VERTICAL': - self.glpane.setCursor(self.win.pencilVerticalSnapCursor) - else: - self.glpane.setCursor(self.win.colorPencilCursor) - - def resetVariables(self): - """ - Reset instance variables. Typically used by self.command when the - command is exited without the graphics mode knowing about it before hand - Example: You entered line mode, started drawing line, and hit Done - button. This exits the Graphics mode (without the 'leftup' which usually - terminates the command *from Graphics mode') . In the above case, the - command.restore_gui needs to tell its graphics mode about what just - happened , so that all the assigned values get cleared and ready to use - next time this graphicsMode is active. - """ - self.endPoint1 = None - self.endPoint2 = None - -# == Command part - -class LineMode(Select_Command): - """ - Encapsulates the LineMode tool functionality. - """ - # class constants - - commandName = 'LineMode' - featurename = "Line Mode" - # (I don't know if this featurename is ever user-visible; - # if it is, it's probably wrong -- consider overriding - # self.get_featurename() to return the value from the - # prior command, if this is used as a temporary command. - # The default implementation returns this constant - # or (if it's not overridden in subclasses) something - # derived from it. [bruce 071227]) - from utilities.constants import CL_REQUEST - command_level = CL_REQUEST - - GraphicsMode_class = LineMode_GM - - # Initial value for the instance variable. (Note that although it is assigned - # an empty tuple, later it is assigned a list.) Empty tuple is just for - # the safer implementation than an empty list. Also, it is not 'None' - # because in LineMode_GM.bareMotion, it does a check using - # len(mouseClickPoints) - mouseClickPoints = () - - command_can_be_suspended = False - command_should_resume_prevMode = True - command_has_its_own_PM = False - - _results_callback = None #bruce 080801 - - - - def setParams(self, params): - """ - Assign values obtained from the parent mode to the instance variables - of this command object. - """ - # REVIEW: I think this is only called from self.init_gui, - # and ought to be private or inlined. I revised it to accept a tuple - # of length 1 rather than an int. If old code had bugs of calling it - # from the wrong places (which pass tuples of length 5), those are - # now tracebacks, but before were perhaps silent errors (probably - # harmless). So if my analysis of possible callers is wrong, this - # change might cause bugs. [bruce 080801] - assert len(params) == 1 #bruce 080801 - (self.mouseClickLimit,) = params - - - def _results_for_request_command_caller(self): - """ - @return: tuple of results to return to whatever "called" - self as a "request command" - - [overridden in subclasses] - """ - #bruce 080801 split this out of restore_gui - ### REVIEW: make this a Request Command API method?? - return (self.mouseClickPoints,) - - - #START New Command API methods. (used when USE_COMMAND_STACK is True)====== - def command_entered(self): - super(LineMode, self).command_entered() - self._command_enter_effects() - - def _command_enter_effects(self): - """ - common code for Enter and command_entered - """ - #@TODO: merge into command_entered when USE_COMMAND_STACK is - # always true and Enter is removed - #clear the list (for safety) which may still have old data in it - self.mouseClickPoints = [] - self.glpane.gl_update() - - params, results_callback = self._args_and_callback_for_request_command() - if params is not None: - self.setParams(params) - self._results_callback = results_callback - # otherwise we were not called as a request command; - # method above prints something in that case, for now ### - else: - # maybe: set default params? - self._results_callback = None - - - def command_will_exit(self): - super(LineMode, self).command_will_exit() - if self._results_callback: - # note: _results_callback comes from an argument to - # callRequestCommand. - params = self._results_for_request_command_caller() - self._results_callback( params) - - #clear the list [bruce 080801 revision, not fully analyzed: always do this] - self.mouseClickPoints = [] - - self.graphicsMode.resetVariables() - return - - - #END New Command API methods =============================================== - - - #START - OLD command api methods init_gui, restore_gui ===================== - if not USE_COMMAND_STACK: - - def init_gui(self): - """ - Initialize GUI for this mode - """ - #clear the list (for safety) which may still have old data in it - self.mouseClickPoints = [] - self.glpane.gl_update() - - params, results_callback = self._args_and_callback_for_request_command() - if params is not None: - self.setParams(params) - self._results_callback = results_callback - # otherwise we were not called as a request command; - # method above prints something in that case, for now ### - else: - # maybe: set default params? - self._results_callback = None - return - - - def restore_gui(self): - """ - Restore the GUI - """ - if self._results_callback: - # note: _results_callback comes from an argument to - # callRequestCommand. - params = self._results_for_request_command_caller() - self._results_callback( params) - - #clear the list [bruce 080801 revision, not fully analyzed: always do this] - self.mouseClickPoints = [] - - self.graphicsMode.resetVariables() - return - - #END - OLD command api methods init_gui, restore_gui ======================= diff --git a/cad/src/temporary_commands/RotateAboutPoint_Command.py b/cad/src/temporary_commands/RotateAboutPoint_Command.py index 43b32e902..5684be37d 100644 --- a/cad/src/temporary_commands/RotateAboutPoint_Command.py +++ b/cad/src/temporary_commands/RotateAboutPoint_Command.py @@ -13,8 +13,8 @@ conference. This may be revised further. -- Need documentation """ -from temporary_commands.LineMode import LineMode -from temporary_commands.LineMode import LineMode_GM +from temporary_commands.Line.LineMode import LineMode +from temporary_commands.Line.LineMode import LineMode_GM import foundation.env as env from utilities.prefs_constants import atomHighlightColor_prefs_key from model.chem import Atom # for isinstance check as of 2008-04-17 |