Add simple crosshair using native mouse cursors (fix #1236)

data/pref.xml

@@ -77,6 +77,10 @@
       <value id="HORIZONTAL" value="1" />
       <value id="VERTICAL" value="2" />
     </enum>
+    <enum id="PaintingCursorType">
+      <value id="SIMPLE_CROSSHAIR" value="0" />
+      <value id="CROSSHAIR_ON_SPRITE" value="1" />
+    </enum>
   </types>
 
   <global>
@@ -110,6 +114,7 @@
       <option id="use_native_cursor" type="bool" default="false" migrate="experimental.use_native_cursor" />
       <option id="cursor_scale" type="int" default="1" />
       <option id="cursor_color" type="app::Color" default="app::Color::fromMask()" migrate="editor.cursor_color" />
+      <option id="painting_cursor_type" type="PaintingCursorType" default="PaintingCursorType::CROSSHAIR_ON_SPRITE" />
       <option id="brush_preview" type="BrushPreview" default="BrushPreview::FULL" migrate="editor.brush_preview" />
     </section>
     <section id="preview" text="Preview">

data/skins/default/skin.xml

@@ -109,6 +109,7 @@
   <cursors>
     <cursor id="normal"         x="80" y="0" w="16" h="16"      focusx="0" focusy="0" />
     <cursor id="normal_add"     x="80" y="16" w="16" h="16"     focusx="0" focusy="0" />
+    <cursor id="crosshair"      x="96" y="32" w="16" h="16"     focusx="7" focusy="7" />
     <cursor id="forbidden"      x="80" y="32" w="16" h="16"     focusx="0" focusy="0" />
     <cursor id="hand"           x="80" y="48" w="16" h="16"     focusx="5" focusy="3" />
     <cursor id="scroll"         x="80" y="64" w="16" h="16"     focusx="8" focusy="8" />

data/widgets/options.xml

@@ -96,21 +96,30 @@
           </hbox>
 
           <separator text="Painting Cursors" horizontal="true" />
-          <label text="Precise Cursor Color:" />
-	  <hbox>
+
+          <grid columns="2">
+            <label text="Crosshair Type:" />
+            <combobox id="painting_cursor_type">
+	      <listitem text="Simple Crosshair" value="0" />
+	      <listitem text="Crosshair on Sprite" value="1" />
+            </combobox>
+
+	    <label text="Brush Preview:" />
+            <combobox id="brush_preview">
+              <listitem text="None" value="0" />
+              <listitem text="Brush Edges" value="1" />
+              <listitem text="Full Real-time Brush Preview" value="2" />
+            </combobox>
+
+	    <label text="Crosshair &amp; Brush Edges Color:" />
 	    <combobox group="1" id="cursor_color_type">
 	      <listitem text="Negative Black and White" value="0" />
 	      <listitem text="Specific Color" value="1" />
 	    </combobox>
-	    <box id="cursor_color_placeholder" /><!-- custom widget -->
-	  </hbox>
 
-	  <label text="Brush Preview:" />
-          <combobox id="brush_preview">
-            <listitem text="None" value="0" />
-            <listitem text="Brush Edges" value="1" />
-            <listitem text="Full Real-time Brush Preview" value="2" />
-          </combobox>
+	    <boxfiller />
+	    <box id="cursor_color_placeholder" /><!-- custom widget -->
+	  </grid>
         </vbox>
 
         <!-- Grid & background -->

src/app/commands/cmd_options.cpp

@@ -78,6 +78,7 @@ public:
     sectionListbox()->Change.connect(base::Bind<void>(&OptionsWindow::onChangeSection, this));
 
     // Cursor
+    paintingCursorType()->setSelectedItemIndex(int(m_pref.cursor.paintingCursorType()));
     cursorColorPlaceholder()->addChild(m_cursorColor);
 
     if (m_cursorColor->getColor().getType() == app::Color::MaskType) {
@@ -269,6 +270,7 @@ public:
     m_pref.editor.zoomWithSlide(slideZoom()->isSelected());
 #endif
     m_pref.editor.rightClickMode(static_cast<app::gen::RightClickMode>(rightClickBehavior()->getSelectedItemIndex()));
+    m_pref.cursor.paintingCursorType(static_cast<app::gen::PaintingCursorType>(paintingCursorType()->getSelectedItemIndex()));
     m_pref.cursor.cursorColor(m_cursorColor->getColor());
     m_pref.cursor.brushPreview(static_cast<app::gen::BrushPreview>(brushPreview()->getSelectedItemIndex()));
     m_pref.cursor.useNativeCursor(nativeCursor()->isSelected());

src/app/ui/editor/brush_preview.cpp

@@ -32,6 +32,9 @@
 #include "doc/layer.h"
 #include "doc/primitives.h"
 #include "doc/site.h"
+#include "she/display.h"
+#include "ui/manager.h"
+#include "ui/system.h"
 
 namespace app {
 
@@ -39,8 +42,9 @@ using namespace doc;
 
 BrushPreview::BrushPreview(Editor* editor)
   : m_editor(editor)
-  , m_type(CROSS)
+  , m_type(CROSSHAIR)
   , m_onScreen(false)
+  , m_withModifiedPixels(false)
   , m_withRealPreview(false)
   , m_screenPosition(0, 0)
   , m_editorPosition(0, 0)
@@ -77,6 +81,9 @@ color_t BrushPreview::getBrushColor(Sprite* sprite, Layer* layer)
 // Draws the brush cursor in the specified absolute mouse position
 // given in 'pos' param.  Warning: You should clean the cursor before
 // to use this routine with other editor.
+//
+// TODO the logic in this function is really complex, we should think
+//      a way to simplify all possibilities
 void BrushPreview::show(const gfx::Point& screenPos)
 {
   if (m_onScreen)
@@ -96,9 +103,8 @@ void BrushPreview::show(const gfx::Point& screenPos)
 
   // Get cursor color
   const auto& pref = Preferences::instance();
-  app::Color app_cursor_color = pref.cursor.cursorColor();
-  gfx::Color ui_cursor_color = color_utils::color_for_ui(app_cursor_color);
-  m_blackAndWhiteNegative = (app_cursor_color.getType() == app::Color::MaskType);
+  app::Color appCursorColor = pref.cursor.cursorColor();
+  m_blackAndWhiteNegative = (appCursorColor.getType() == app::Color::MaskType);
 
   // Cursor in the screen (view)
   m_screenPosition = screenPos;
@@ -118,7 +124,7 @@ void BrushPreview::show(const gfx::Point& screenPos)
   color_t mask_index = sprite->transparentColor();
 
   if (ink->isSelection() || ink->isSlice()) {
-    m_type = SELECTION_CROSS;
+    m_type = SELECTION_CROSSHAIR;
   }
   else if (
     (brush->type() == kImageBrushType ||
@@ -134,33 +140,43 @@ void BrushPreview::show(const gfx::Point& screenPos)
     m_type = BRUSH_BOUNDARIES;
   }
   else {
-    m_type = CROSS;
+    m_type = CROSSHAIR;
   }
 
-  bool usePreview = false;
-
+  bool showPreview = false;
   auto brushPreview = pref.cursor.brushPreview();
   if (!m_editor->docPref().show.brushPreview())
     brushPreview = app::gen::BrushPreview::NONE;
 
   switch (brushPreview) {
     case app::gen::BrushPreview::NONE:
-      m_type = CROSS;
+      m_type = CROSSHAIR;
       break;
     case app::gen::BrushPreview::EDGES:
       m_type = BRUSH_BOUNDARIES;
       break;
     case app::gen::BrushPreview::FULL:
-      usePreview = m_editor->getState()->requireBrushPreview();
+      showPreview = m_editor->getState()->requireBrushPreview();
       break;
   }
 
+  if (m_type & SELECTION_CROSSHAIR)
+    showPreview = false;
+
+  // Use a simple cross
+  if (pref.cursor.paintingCursorType() == gen::PaintingCursorType::SIMPLE_CROSSHAIR) {
+    m_type &= ~(CROSSHAIR | SELECTION_CROSSHAIR);
+    m_type |= NATIVE_CROSSHAIR;
+  }
+
   // For cursor type 'bounds' we have to generate cursor boundaries
-  if (m_type & BRUSH_BOUNDARIES)
+  if (m_type & BRUSH_BOUNDARIES) {
+    showPreview = false;
     generateBoundaries();
+  }
 
   // Draw pixel/brush preview
-  if ((m_type & CROSS) && usePreview) {
+  if (showPreview) {
     gfx::Rect origBrushBounds = (isFloodfill ? gfx::Rect(0, 0, 1, 1): brush->bounds());
     gfx::Rect brushBounds = origBrushBounds;
     brushBounds.offset(spritePos);
@@ -222,12 +238,16 @@ void BrushPreview::show(const gfx::Point& screenPos)
   }
 
   // Save area and draw the cursor
-  {
+  if (!(m_type & NATIVE_CROSSHAIR) ||
+      (m_type & BRUSH_BOUNDARIES)) {
     ui::ScreenGraphics g;
     ui::SetClip clip(&g, gfx::Rect(0, 0, g.width(), g.height()));
+    gfx::Color uiCursorColor = color_utils::color_for_ui(appCursorColor);
 
-    forEachBrushPixel(&g, m_screenPosition, spritePos, ui_cursor_color, &BrushPreview::savePixelDelegate);
-    forEachBrushPixel(&g, m_screenPosition, spritePos, ui_cursor_color, &BrushPreview::drawPixelDelegate);
+    forEachBrushPixel(&g, m_screenPosition, spritePos, uiCursorColor, &BrushPreview::savePixelDelegate);
+    forEachBrushPixel(&g, m_screenPosition, spritePos, uiCursorColor, &BrushPreview::drawPixelDelegate);
+
+    m_withModifiedPixels = true;
   }
 
   // Cursor in the editor (model)
@@ -236,6 +256,9 @@ void BrushPreview::show(const gfx::Point& screenPos)
 
   // Save the clipping-region to know where to clean the pixels
   m_oldClippingRegion = m_clippingRegion;
+
+  if (m_type & NATIVE_CROSSHAIR)
+    ui::set_mouse_cursor(ui::kCrosshairCursor);
 }
 
 // Cleans the brush cursor from the specified editor.
@@ -259,7 +282,7 @@ void BrushPreview::hide()
   m_clippingRegion.createSubtraction(m_clippingRegion,
                                      m_editor->getUpdateRegion());
 
-  {
+  if (m_withModifiedPixels) {
     // Restore pixels
     ui::ScreenGraphics g;
     ui::SetClip clip(&g, gfx::Rect(0, 0, g.width(), g.height()));
@@ -347,10 +370,10 @@ void BrushPreview::forEachBrushPixel(
 {
   m_savedPixelsIterator = 0;
 
-  if (m_type & CROSS)
+  if (m_type & CROSSHAIR)
     traceCrossPixels(g, screenPos, color, pixelDelegate);
 
-  if (m_type & SELECTION_CROSS)
+  if (m_type & SELECTION_CROSSHAIR)
     traceSelectionCrossPixels(g, spritePos, color, 1, pixelDelegate);
 
   if (m_type & BRUSH_BOUNDARIES)
@@ -358,8 +381,10 @@ void BrushPreview::forEachBrushPixel(
 
   // Depending on the editor zoom, maybe we need subpixel movement (a
   // little dot inside the active pixel)
-  if (m_editor->zoom().scale() >= 4.0)
+  if (!(m_type & NATIVE_CROSSHAIR) &&
+      m_editor->zoom().scale() >= 4.0) {
     (this->*pixelDelegate)(g, screenPos, color);
+  }
 
   m_savedPixelsLimit = m_savedPixelsIterator;
 }
@@ -480,7 +505,7 @@ void BrushPreview::drawPixelDelegate(ui::Graphics* gfx, const gfx::Point& pt, gf
   if (m_savedPixelsIterator < (int)m_savedPixels.size() &&
       m_clippingRegion.contains(pt)) {
     if (m_blackAndWhiteNegative) {
-      int c = m_savedPixels[m_savedPixelsIterator++];
+      int c = m_savedPixels[m_savedPixelsIterator];
       int r = gfx::getr(c);
       int g = gfx::getg(c);
       int b = gfx::getb(c);
@@ -490,6 +515,7 @@ void BrushPreview::drawPixelDelegate(ui::Graphics* gfx, const gfx::Point& pt, gf
     else {
       gfx->putPixel(color, pt.x, pt.y);
     }
+    ++m_savedPixelsIterator;
   }
 }
 

src/app/ui/editor/brush_preview.h

@@ -1,5 +1,5 @@
 // Aseprite
-// Copyright (C) 2001-2015  David Capello
+// Copyright (C) 2001-2016  David Capello
 //
 // This program is distributed under the terms of
 // the End-User License Agreement for Aseprite.
@@ -37,9 +37,10 @@ namespace app {
   public:
     // Brush type
     enum {
-      CROSS            = 1,
-      SELECTION_CROSS  = 2,
-      BRUSH_BOUNDARIES = 4,
+      CROSSHAIR           = 1,
+      SELECTION_CROSSHAIR = 2,
+      BRUSH_BOUNDARIES    = 4,
+      NATIVE_CROSSHAIR    = 8,
     };
 
     BrushPreview(Editor* editor);
@@ -85,6 +86,7 @@ namespace app {
 
     // The brush preview is on the screen.
     bool m_onScreen;
+    bool m_withModifiedPixels;
     bool m_withRealPreview;
     gfx::Point m_screenPosition; // Position in the screen (view)
     gfx::Point m_editorPosition; // Position in the editor (model)

src/app/ui/skin/skin_theme.cpp

@@ -103,6 +103,7 @@ static const char* cursor_names[kCursorTypes] = {
   "null",                       // kNoCursor
   "normal",                     // kArrowCursor
   "normal_add",                 // kArrowPlusCursor
+  "crosshair",                  // kCrosshairCursor
   "forbidden",                  // kForbiddenCursor
   "hand",                       // kHandCursor
   "scroll",                     // kScrollCursor

src/she/alleg4/alleg_display.cpp

@@ -558,6 +558,7 @@ bool Alleg4Display::setNativeMouseCursor(NativeCursor cursor)
       newCursor = MOUSE_CURSOR_QUESTION;
       break;
 #ifdef ALLEGRO4_WITH_EXTRA_CURSORS
+    case kCrosshairCursor: newCursor = MOUSE_CURSOR_CROSS; break;
     case kForbiddenCursor: newCursor = MOUSE_CURSOR_FORBIDDEN; break;
     case kMoveCursor: newCursor = MOUSE_CURSOR_MOVE; break;
     case kLinkCursor: newCursor = MOUSE_CURSOR_LINK; break;

src/she/native_cursor.h

@@ -15,6 +15,7 @@ namespace she {
   enum NativeCursor {
     kNoCursor,
     kArrowCursor,
+    kCrosshairCursor,
     kIBeamCursor,
     kWaitCursor,
     kLinkCursor,

src/she/osx/window.mm

@@ -120,6 +120,9 @@ using namespace she;
     case kSizeSWCursor:
       nsCursor = [NSCursor arrowCursor];
       break;
+    case kCrosshairCursor:
+      nsCursor = [NSCursor crosshairCursor];
+      break;
     case kIBeamCursor:
       nsCursor = [NSCursor IBeamCursor];
       break;

src/she/win/window.h

@@ -141,6 +141,9 @@ namespace she {
         case kArrowCursor:
           hcursor = LoadCursor(NULL, IDC_ARROW);
           break;
+        case kCrosshairCursor:
+          hcursor = LoadCursor(NULL, IDC_CROSS);
+          break;
         case kIBeamCursor:
           hcursor = LoadCursor(NULL, IDC_IBEAM);
           break;

src/ui/cursor_type.h

@@ -17,6 +17,7 @@ namespace ui {
     kNoCursor = 0,
     kArrowCursor,
     kArrowPlusCursor,
+    kCrosshairCursor,
     kForbiddenCursor,
     kHandCursor,
     kScrollCursor,

src/ui/system.cpp

@@ -111,6 +111,9 @@ static void update_mouse_cursor()
       case ui::kArrowPlusCursor:
         nativeCursor = she::kArrowCursor;
         break;
+      case ui::kCrosshairCursor:
+        nativeCursor = she::kCrosshairCursor;
+        break;
       case ui::kForbiddenCursor:
         nativeCursor = she::kForbiddenCursor;
         break;