GuiControl::onMouseEnterBounds

Motivation:

You've got a container control and you want to know when the mouse leaves or enters its boundary.
However, the container has say a button on it.
When the mouse transitions from being over just the container to being over both the container and the buton, the container will receive an onMouseLeave(). Similarly when you mouse off the button back onto just the container, the container gets an onMouseEnter.

The Resource seems to work fairly well,
including the case where the child control is right at the edge of the parent.

Let me know i'm overlooking something.


code:

guiControl.h

after "S32 mVertSizing; ///< Set from vertSizingOptions.:, add:

bool mMouseInBounds;

after "virtual void onMouseLeave(const GuiEvent &event);", add:

/// these don't trigger due to transitions with child controls:
    virtual void onMouseEnterBounds (const GuiEvent &event);
    virtual void onMouseLeaveBounds (const GuiEvent &event);
    virtual void tryMouseEnterBounds(const GuiEvent &event);
    virtual void tryMouseLeaveBounds(const GuiEvent &event);

guiControl.cc
after "mVertSizing = vertResizeBottom;", add:

mMouseInBounds = false;

after the function onMouseLeave, add:

void GuiControl::tryMouseEnterBounds(const GuiEvent &event)
{
   if (!mMouseInBounds) {
      mMouseInBounds = true;
      onMouseEnterBounds(event);
      GuiControl *parent = getParent();
      if ( parent )
         parent->tryMouseEnterBounds( event );
   }
}

void GuiControl::tryMouseLeaveBounds(const GuiEvent &event)
{
   if (mMouseInBounds) {
      if (!cursorInControl()) {
         mMouseInBounds = !true;
         onMouseLeaveBounds(event);
         GuiControl *parent = getParent();
         if ( parent ) {
            parent->tryMouseLeaveBounds( event );
         }
      }
   }
}

void GuiControl::onMouseEnterBounds(const GuiEvent &event)
{
}


void GuiControl::onMouseLeaveBounds(const GuiEvent &event)
{
}

guiCanvas.cc
Two additional calls in the function findMouseControl() are shown in bold:

void GuiCanvas::findMouseControl(const GuiEvent &event)
{
   if(size() == 0)
   {
      mMouseControl = NULL;
      return;
   }
   GuiControl *controlHit = findHitControl(event.mousePoint);
   if(controlHit != static_cast<GuiControl*>(mMouseControl))
   {
      if(bool(mMouseControl)) {
         mMouseControl->onMouseLeave(event);
         [b]mMouseControl->tryMouseLeaveBounds(event);[/b]
      }
      mMouseControl = controlHit;
      mMouseControl->onMouseEnter(event);
      [b]mMouseControl->tryMouseEnterBounds(event);[/b]
   }
}