Merge lp:~unity-team/compiz/showmouse-guides into lp:compiz/0.9.12

[Marco Trevisan (Treviño)]

showmouse: add mouse vertical and horizontal guides

Added vertical and horizontal mouse guides to the showmouse plugin.
With this, the user can set the number of circular emiters to zero, and
add thickness to the bars. When activated (mod4-k), compiz can draw
the circular emmiters, the guides, or both.

Hi all compiz people.

We at hypra are preparing a desktop, based on debian/mate, aimed at providing maximum accessibility for impaired people.
We use compiz, for visual features related to visual impairement.

[Marco Trevisan (Treviño) (3v1n0)]

Ok, thanks for the contribution.

review: Approve

=== modified file 'plugins/showmouse/showmouse.xml.in'
--- plugins/showmouse/showmouse.xml.in	2013-01-22 21:05:49 +0000
+++ plugins/showmouse/showmouse.xml.in	2016-05-31 17:33:30 +0000
@@ -34,6 +34,32 @@
 					<_long>Toggle the mouse pointer trail.</_long>
 					<default/>
 				</option>
+				<option name="guide_thickness" type="int">
+					<_short>Guide thickness</_short>
+					<_long>How thick mouse guides should be, in pixels.</_long>
+					<default>0</default>
+					<min>0</min>
+					<max>20</max><!-- search for "XML" in showmouse.cpp -->
+					<precision>1</precision>
+				</option>
+				<option name="guide_empty_radius" type="int">
+					<_short>Guide empty radius</_short>
+					<_long>Radius of the disk around the cursor which doesn't contain guides.</_long>
+					<default>20</default>
+					<min>0</min>
+					<max>100</max>
+					<precision>1</precision>
+				</option>
+				<option name="guide_color" type="color">
+					<_short>Guide Color</_short>
+					<_long>Guide color.</_long>
+					<default>
+					  <red>0xffff</red>
+					  <green>0x0</green>
+					  <blue>0x0</blue>
+					  <alpha>0x9999</alpha>
+					</default>
+				</option>
 				<option name="rotation_speed" type="float">
 					<_short>Rotation speed</_short>
 					<_long>Rotation speed.</_long>
@@ -51,9 +77,9 @@
 				</option>
 				<option name="emitters" type="int">
 					<_short>Emitters</_short>
-					<_long>Number of particle emitters.</_long>
+					<_long>Number of particle emitters (0 to disable).</_long>
 					<default>3</default>
-					<min>1</min>
+					<min>0</min>
 					<max>10</max>
 				</option>
 			</group>
 
=== modified file 'plugins/showmouse/src/showmouse.cpp'
--- plugins/showmouse/src/showmouse.cpp	2013-05-09 13:43:07 +0000
+++ plugins/showmouse/src/showmouse.cpp	2016-05-31 17:33:30 +0000
@@ -11,6 +11,9 @@
  * Copyright : (C) 2009 by Sam Spilsbury
  * E-mail    : [e-mail]
  *
+ * Copyright (C) 2016 by Hypra
+ * E-mail    [e-mail]
+ * Added mouse guides.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -350,6 +353,12 @@
 void
 ShowmouseScreen::genNewParticles (int f_time)
 {
+    unsigned int nE = optionGetEmitters ();
+    if (nE == 0)
+    {
+      ps.active = true; // Don't stop drawing: we may have guides.
+      return;
+    }
     bool rColor     = optionGetRandom ();
     float life      = optionGetLife ();
     float lifeNeg   = 1 - life;
@@ -373,7 +382,6 @@
     unsigned int i, j;
 
     float pos[10][2];
-    unsigned int nE = optionGetEmitters ();
     float rA     = (2 * M_PI) / nE;
     int radius   = optionGetRadius ();
 
@@ -562,11 +570,65 @@
 
     sTransform.toScreenSpace (output, -DEFAULT_Z_CAMERA);
 
-    ps.drawParticles (sTransform);
+    drawGuides (sTransform);
+
+    if (optionGetEmitters () > 0)
+      ps.drawParticles (sTransform);
 
     return status;
 }
 
+void
+ShowmouseScreen::drawLine (const GLMatrix &transform,
+                           double x1, double y1, double x2, double y2,
+                           unsigned short *color)
+{
+  GLVertexBuffer *stream = GLVertexBuffer::streamingBuffer ();
+  GLfloat vertices[6] =
+    {GLfloat(x1), GLfloat(y1), GLfloat(0), GLfloat(x2), GLfloat(y2), GLfloat(0)};
+
+  stream->begin (GL_LINES);
+  stream->addColors (1, color);
+  stream->addVertices (2, vertices);
+  if (stream->end ())
+    stream->render (transform);
+}
+
+void
+ShowmouseScreen::drawGuides (const GLMatrix &transform)
+{
+  unsigned short *color = optionGetGuideColor ();
+  float x = mousePos.x ();
+  float y = mousePos.y ();
+  float thickness = optionGetGuideThickness ();
+  float r = optionGetGuideEmptyRadius ();
+
+  // If the thickness is zero we don't have to draw, but we should
+  // still mark the region where the guides should be as damaged --
+  // this is useful when thickness has just been changed.
+
+  if (thickness > 0)
+  {
+    glLineWidth (thickness);
+    glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
+    glEnable (GL_BLEND);
+    drawLine (transform, x, 0, x, y - r, color);
+    drawLine (transform, x, y + r, x, screen->height (), color);
+    drawLine (transform, 0, y, x - r, y, color);
+    drawLine (transform, x + r, y, screen->width (), y, color);
+    glDisable (GL_BLEND);
+  }
+
+  // This has to be manually synchronized with the maximum value in
+  // showmouse.xml.in.  The code generated from the XML file keeps
+  // the value private.
+  thickness = 20;
+  cScreen->damageRegion (CompRegion(0, y - thickness / 2 - 1,
+                                    screen->width (), thickness + 1));
+  cScreen->damageRegion (CompRegion(x - thickness / 2 - 1, 0,
+                                    thickness + 1, screen->height ()));
+}
+
 bool
 ShowmouseScreen::terminate (CompAction         *action,
 			    CompAction::State  state,
 
=== modified file 'plugins/showmouse/src/showmouse.h'
--- plugins/showmouse/src/showmouse.h	2013-04-21 23:32:04 +0000
+++ plugins/showmouse/src/showmouse.h	2016-05-31 17:33:30 +0000
@@ -7,6 +7,7 @@
  * Copyright : (C) 2008 by Dennis Kasprzyk
  * E-mail    : [e-mail]
  *
+ * Updated in 2016 by Hypra ([e-mail]): mouse guides support.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -110,6 +111,16 @@
     public CompositeScreenInterface,
     public GLScreenInterface
 {
+    private:
+
+        void
+        drawGuides (const GLMatrix &transform);
+
+        void
+        drawLine (const GLMatrix &transform,
+                  double x1, double y1, double x2, double y2,
+                  unsigned short *color);
+
     public:
 
 	ShowmouseScreen (CompScreen *);