Multitouch for Objects in iTGB v1.2

EDIT: Fixed some missing / incorrect information.

You find yourself wishing to touch your iPhone or iPod Touch screen more than once - but try as you must, you simply cannot. A second touch will nullify the first. You feel alone - but you are not. You have officially entered....

THE TORQUE ZONE

*dun dun duuuun*


THE PROBLEM:
iTGB has multitouch capabilities built into it. These actions get passed through the mouse input managers - which is a good thing, as it allows them to make use of all the existing code for mouse callbacks. However, they do not work well. First off, true multitouch actions are getting passed back to the script level - which is okay, however there isn't much you can do with this. Secondly, if you touch a second location on the screen after touching a first, it will nullify your original touch.

So how to fix this? We're going to integrate a full 'ScreenTouch' input manager. With this it will give you the ability to add in the control and functionality you need. There are a lot of changes involved here, so you might want to get a barrel of coffee or tea or something. (Or, if you're a solid game programmer like myself - BEER! Or, Mead, which is my preference.)

Let's get started. First off, make sure you are running iTGB v1.2 - this fix is not guaranteed to work in versions before or after it.

Since there are a lot of files, I am going to list a file name, then the change needed rather than describing it all in detail. I am going to post the area of code it is in. Look for "//DMC - Added for Multitouch". I will also list the line number to add the code near. Here we go!!

game/demoGame.h
Around line 33

public:
   void textureKill();
   void textureResurrect();
   void refreshWindow();

   //virtual int  main(int argc, const char **argv);
   virtual bool mainInit(int argc, const char **argv);
   virtual void mainLoop();
   virtual void mainShutdown();
      
   void processPacketReceiveEvent(PacketReceiveEvent *event);
   void processMouseMoveEvent(MouseMoveEvent *event);
   void processInputEvent(InputEvent *event);
   void processScreenTouchEvent(ScreenTouchEvent *event); //DMC - Added for multitouch
   void processQuitEvent();
   void processTimeEvent(TimeEvent *event);
   void processConsoleEvent(ConsoleEvent *event);
   void processConnectedAcceptEvent(ConnectedAcceptEvent *event);
   void processConnectedReceiveEvent(ConnectedReceiveEvent *event);
   void processConnectedNotifyEvent(ConnectedNotifyEvent *event);
};

gui/core/guiCanvas.h
Around line 268

/// @param   event   Mouse move event to process
   virtual void processMouseMoveEvent(const MouseMoveEvent *event);
	
	virtual void processScreenTouchEvent(const ScreenTouchEvent *event); //DMC - Added for multitouch

   /// @}

gui/core/guiCanvas.h
Around line 312

virtual void rootMouseMove(const GuiEvent &event);
   virtual void rootMouseDragged(const GuiEvent &event);

   virtual void rootScreenTouchUp(const GuiEvent &event); //DMC - Added for Multitouch
   virtual void rootScreenTouchDown(const GuiEvent &event); //DMC - Added for Multitouch
	
   virtual void rootRightMouseDown(const GuiEvent &event);
   virtual void rootRightMouseUp(const GuiEvent &event);

game/main.cc
Around line 613

/// Process a mouse movement event, essentially pass to the canvas for handling
void DemoGame::processMouseMoveEvent(MouseMoveEvent * mEvent)
{
   if (Canvas)
      Canvas->processMouseMoveEvent(mEvent);
}

//DMC - Added for multitouch
void DemoGame::processScreenTouchEvent(ScreenTouchEvent * mEvent)
{
	if (Canvas)
		Canvas->processScreenTouchEvent(mEvent);
}
//DMC - End added for multitouch

/// Process an input event, pass to canvas for handling
void DemoGame::processInputEvent(InputEvent *event)
{
   PROFILE_START(ProcessInputEvent);

platform/event.h
Around line 50

enum EventTypes
{
   InputEventType,
   MouseMoveEventType,
   ScreenTouchEventType, //DMC - Added for multitouch
   PacketReceiveEventType,
   TimeEventType,
   QuitEventType,

platform/event.h
Around line 373

enum InputDeviceTypes
{
   UnknownDeviceType,
   MouseDeviceType,
   KeyboardDeviceType,
   JoystickDeviceType,
   ScreenTouchDeviceType //DMC - Added for Multitouch
};

platform/event.h
Around line 145

//DMC - Added for multitouch
/// Screen Touch Event
struct ScreenTouchEvent : public Event
{
	S32 xPos, yPos;
	U8    action;
	
	ScreenTouchEvent() { type = ScreenTouchEventType; size = sizeof(ScreenTouchEvent); }
};

platform/gameInterface.h
Around line 59

virtual void processEvent(Event *event);

   virtual void processPacketReceiveEvent(PacketReceiveEvent *event);
   virtual void processMouseMoveEvent(MouseMoveEvent *event); 
   virtual void processScreenTouchEvent(ScreenTouchEvent *event); //DMC - Added for multitouch
   virtual void processInputEvent(InputEvent *event);

platform/gameInterface.cc
Around line 138

//DMC - Added for multitouch
void GameInterface::processScreenTouchEvent(ScreenTouchEvent*)
{
	
}

platform/gameInterface.cc
Around line 93

case InputEventType:
         processInputEvent((InputEvent *) event);
         break;
	  case ScreenTouchEventType: //DMC - Added for Multitouch
		 processScreenTouchEvent((ScreenTouchEvent *) event); //DMC - Added for Multitouch
		 break; //DMC - Added for Multitouch
      case QuitEventType:
         processQuitEvent();
         break;

T2D/t2dSceneWindow.cc
Around line 2340
NOTE: This is an EPIC MEGAHACK to the EXTREME. I should probably rewrite this to use a boolean check in the GuiEvent....

}         
      }

	  #ifndef TORQUE_OS_IPHONE //DMC - Added for multitouch
      if( lastObject && lastObject->isProperlyAdded() && bFoundNew == true && lastObject->getUseMouseEvents() )
         lastObject->onMouseEvent( "onMouseLeave" , event, worldMousePoint ); 
	  #endif //DMC - Added for multitouch
   }

   // We have to dance a bit to get onMouseEnter to work
   for( U32 i = 0; i < pickVector.size(); i++ )

gui/core/guiCanvas.cc
Around line 424

return true;
		}
   }
   return false;
}

//DMC - Added for Multitouch
void GuiCanvas::processScreenTouchEvent(const ScreenTouchEvent *event)
{
		//copy the cursor point into the event
		mLastEvent.mousePoint.x = S32(event->xPos);
		mLastEvent.mousePoint.y = S32(event->yPos);
		
		//see if button was pressed
		if (event->action == SI_MAKE)
		{
			U32 curTime = Platform::getVirtualMilliseconds();
			mNextMouseTime = curTime + mInitialMouseDelay;
			
			mLastMouseDownTime = curTime;
			mLastEvent.mouseClickCount = mLastMouseClickCount;
			
			rootScreenTouchDown(mLastEvent);
		}
		//else button was released
		else
		{
			mNextMouseTime = 0xFFFFFFFF;
			rootScreenTouchUp(mLastEvent);
		}
}

void GuiCanvas::processMouseMoveEvent(const MouseMoveEvent *event)
{
   if( cursorON )
   {

gui/core/guiCanvas.cc
Around line 781

if (bool(mMouseControl))
      mMouseControlClicked = true;
}

//DMC - Added for Multitouch
void GuiCanvas::rootScreenTouchDown(const GuiEvent &event)
{
	mPrevMouseTime = Platform::getVirtualMilliseconds();
	mMouseButtonDown = true;

		iterator i;
		i = end();
		while (i != begin())
		{
			i--;
			GuiControl *ctrl = static_cast<GuiControl *>(*i);
			GuiControl *controlHit = ctrl->findHitControl(event.mousePoint);
			
			//see if the controlHit is a modeless dialog...
			if ((! controlHit->mActive) && (! controlHit->mProfile->mModal))
				continue;
			else
			{
				controlHit->onMouseDown(event);
				break;
			}
		}
	
	if (bool(mMouseControl))
		mMouseControlClicked = true;
}

void GuiCanvas::rootScreenTouchUp(const GuiEvent &event)
{
	mPrevMouseTime = Platform::getVirtualMilliseconds();
	mMouseButtonDown = false;

		iterator i;
		i = end();
		while (i != begin())
		{
			i--;
			GuiControl *ctrl = static_cast<GuiControl *>(*i);
			GuiControl *controlHit = ctrl->findHitControl(event.mousePoint);
			
			//see if the controlHit is a modeless dialog...
			if ((! controlHit->mActive) && (! controlHit->mProfile->mModal))
				continue;
			else
			{
				controlHit->onMouseUp(event);
				break;
			}
	}
}

void GuiCanvas::findMouseControl(const GuiEvent &event)
{
   if(size() == 0)
   {

platformiPhone/iPhoneInput.mm
Change the functions 'createMouseMoveEvent','createMouseDownEvent' and 'createMouseUpEvent' to read like the following:

bool createMouseMoveEvent( S32 touchNumber, S32 x, S32 y ) {
	
	ScreenTouchEvent event;
	event.xPos = x;
	event.yPos = y;
	event.action = SI_MAKE;
	
	TouchMoveEvents.push_back( touchEvent( touchNumber, x, y ) );	
	Game->postEvent(event);
	
	return true;//return false if we get bad values or something
}


bool createMouseDownEvent( S32 touchNumber, S32 x, S32 y ) {
	
	ScreenTouchEvent event;
	event.xPos = x;
	event.yPos = y;
	event.action = SI_MAKE;

	TouchDownEvents.push_back( touchEvent( touchNumber, x, y ) );
	Game->postEvent(event);
	
	return true;//return false if we get bad values or something
}

bool createMouseUpEvent( S32 touchNumber, S32 x, S32 y ) {
	
	ScreenTouchEvent event;
	event.xPos = x;
	event.yPos = y;
	event.action = SI_BREAK;

	TouchUpEvents.push_back( touchEvent( touchNumber, x, y ) );	
	Game->postEvent(event);
	
	return true;//return false if we get bad values or something
}

Phew! Okay... now, in your TorqueScript, all you need to do is setup your code like you would be interacting with things through mouse. So onMouseUp, onMouseDown, onMouseMove, onMouseEnter, onMouseLeave and so forth now all work - with multitouch on your iPhone / iPodTouch.

Huzzah!