[T3D1.2] Turrets Control Vehicles (for Tank Turrets, etc.)

Basically this allows a TurretShape (the included Turret class from T3D 1.2) to be a "Controlling Object," which means you can use %turretObject.setControlObject(%someVehicle); to make a Turret the "pilot" of another object.

Check out a quick video of the Cheetah with a fully mobile turret:
www.youtube.com/watch?v=oVuhlVgyTXw

Download:
dl.dropbox.com/u/45455626/turretShape.zip
Replace your existing T3D/turret/turretShape.cpp and .h with the included files.

Do-it-yourself instructions:
Relatively simple code changes. All the code used is copied from player.cpp since the desired functionality is identical. You could pop this code into ShapeBase if you wanted, but I couldn't think of any other object type that would need it.

A couple changes in T3DturretturretShape.h.
Add this pointer that holds the object the turret is controlling to class TurretShape:

// [HNT] Turret Control Object
   SimObjectPtr<ShapeBase> mControlObject; ///< Controlling object
   // [/HNT]

You can put it wherever you like in theory, but I put it in protected right after TurretShapeData* mDataBlock;

Now all the new functions. I placed these all at the end of the class declaration, right before "DECLARE_CONOBJECT(TurretShape);"

// [HNT] Turret Control Object
   // Object control
   void setControlObject(ShapeBase *obj);
   ShapeBase* getControlObject();
   /// Set which client is controlling this player
   void setControllingClient(GameConnection* client);
   void onCameraScopeQuery(NetConnection *cr, CameraScopeQuery *);
   // [/HNT]

Now changes in T3D/turret/turretShape.cpp. Be aware that the line numbers I've included assume a clean turretShape.cpp and that you're making the changes in order. I've also described the locations in case your line numbers don't match.

Initialize our new variable in TurretShape::TurretShape (about line 276).

// [HNT] Turret Control Object
   mControlObject = 0;
   // [/HNT]

Unset the control object if this object is deleted in TurretShape::Remove (about line 321).

// [HNT] Turret Control Object
   setControlObject(0);
   // [/HNT]

Add these new functions (wherever you like -- I put them at about line 558, right before TurretShape::processTick as that's where they were in player.cpp):

// [HNT] Turret Control Object
//----------------------------------------------------------------------------

void TurretShape::setControllingClient(GameConnection* client)
{
   Parent::setControllingClient(client);
   if (mControlObject)
      mControlObject->setControllingClient(client);
}

void TurretShape::setControlObject(ShapeBase* obj)
{
   if (mControlObject == obj)
      return;

   if (mControlObject) {
      mControlObject->setControllingObject(0);
      mControlObject->setControllingClient(0);
   }
   if (obj == this || obj == 0)
      mControlObject = 0;
   else {
      if (ShapeBase* coo = obj->getControllingObject())
         coo->setControlObject(0);
      if (GameConnection* con = obj->getControllingClient())
         con->setControlObject(0);

      mControlObject = obj;
      mControlObject->setControllingObject(this);
      mControlObject->setControllingClient(getControllingClient());
   }
}

void TurretShape::onCameraScopeQuery(NetConnection *connection, CameraScopeQuery *query)
{
   // First, we are certainly in scope, and whatever we're riding is too...
   if(mControlObject.isNull())// || mControlObject == mMount.object)
      Parent::onCameraScopeQuery(connection, query);
   else
   {
      connection->objectInScope(this);
      if (isMounted())
         connection->objectInScope(mMount.object);
      mControlObject->onCameraScopeQuery(connection, query);
   }
}

ShapeBase* TurretShape::getControlObject()
{
   return mControlObject;
}
// [/HNT]

Right below there in processTick, add this bit of code right before "Parent::processTick(move);" at about 657:

// [HNT] Turrets can control other objects
   // Manage the control object and filter moves for the player
   Move pMove,cMove;
   if (mControlObject) {
      if (!move)
         mControlObject->processTick(0);
      else {
         pMove = NullMove;
         cMove = *move;
         //if (isMounted()) {
            // Filter Jump trigger if mounted
            //pMove.trigger[2] = move->trigger[2];
            //cMove.trigger[2] = false;
         //}
         if (move->freeLook) {
            // Filter yaw/picth/roll when freelooking.
            pMove.yaw = move->yaw;
            pMove.pitch = move->pitch;
            pMove.roll = move->roll;
            pMove.freeLook = true;
            cMove.freeLook = false;
            cMove.yaw = cMove.pitch = cMove.roll = 0.0f;
         }
         mControlObject->processTick((mDamageState == Enabled)? &cMove: &NullMove);
         move = &pMove;
      }
   }
   // [/HNT]

Then in TurretShape::InterpolateTick put this at the start of the function (~719):

// [HNT]
   if (mControlObject)
   mControlObject->interpolateTick(dt);
   // [/HNT]

Similar bit in TurretShape::advanceTime, this time right before Parent::advanceTime at about 763:

// [HNT] Turret Control Object
   if (mControlObject)
      mControlObject->advanceTime(dt);
   // [/HNT]

This goes at the end of TurretShape::writePacketData (~1131):

// [HNT] Turret Control Object
   if (mControlObject) {
      S32 gIndex = connection->getGhostIndex(mControlObject);
      if (stream->writeFlag(gIndex != -1)) {
         stream->writeInt(gIndex,NetConnection::GhostIdBitSize);
         mControlObject->writePacketData(connection, stream);
      }
   }
   else
      stream->writeFlag(false);
   // [/HNT]

And at the end of TurretShape::readPacketData (~1157):

// [HNT] Turret Control Object
   if (stream->readFlag()) {
      S32 gIndex = stream->readInt(NetConnection::GhostIdBitSize);
      ShapeBase* obj = static_cast<ShapeBase*>(connection->resolveGhost(gIndex));
      setControlObject(obj);
      obj->readPacketData(connection, stream);
   }
   else
      setControlObject(0);
   // [/HNT]

And to finish off this file put these new console functions at the end of turretShape.cpp:

// [HNT] Turret Control Object
DefineEngineMethod( TurretShape, setControlObject, bool, ( ShapeBase* obj ),,
   "@brief Set the object to be controlled by this player\n\n"

   "It is possible to have the moves sent to the Player object from the "
   "GameConnection to be passed along to another object.  This happens, for example "
   "when a player is mounted to a vehicle.  The move commands pass through the Player "
   "and on to the vehicle (while the player remains stationary within the vehicle).  "
   "With setControlObject() you can have the Player pass along its moves to any object.  "
   "One possible use is for a player to move a remote controlled vehicle.  In this case "
   "the player does not mount the vehicle directly, but still wants to be able to control it.\n"

   "@param obj Object to control with this player\n"
   "@return True if the object is valid, false if not\n"

   "@see getControlObject()\n"
   "@see clearControlObject()\n"
   "@see GameConnection::setControlObject()")
{
   if (obj) {
      object->setControlObject(obj);
      return true;
   }
   else
      object->setControlObject(0);
   return false;
}

DefineEngineMethod( TurretShape, getControlObject, S32, (),,
   "@brief Get the current object we are controlling.\n\n"
   "@return ID of the ShapeBase object we control, or 0 if not controlling an "
   "object.\n"
   "@see setControlObject()\n"
   "@see clearControlObject()")
{
   ShapeBase* controlObject = object->getControlObject();
   return controlObject ? controlObject->getId(): 0;
}

DefineEngineMethod( TurretShape, clearControlObject, void, (),,
   "@brief Clears the player's current control object.\n\n"
   "Returns control to the player. This internally calls "
   "Player::setControlObject(0).\n"
   "@tsexample\n"
		"%player.clearControlObject();\n"
      "echo(%player.getControlObject()); //<-- Returns 0, player assumes control\n"
      "%player.setControlObject(%vehicle);\n"
      "echo(%player.getControlObject()); //<-- Returns %vehicle, player controls the vehicle now.\n"
	"@endtsexample\n"
   "@note If the player does not have a control object, the player will receive all moves "
   "from its GameConnection.  If you're looking to remove control from the player itself "
   "(i.e. stop sending moves to the player) use GameConnection::setControlObject() to transfer "
   "control to another object, such as a camera.\n"
   "@see setControlObject()\n"
   "@see getControlObject()\n"
   "@see GameConnection::setControlObject()\n")
{
   object->setControlObject(0);
}
// [/HNT]

You can remove the original usage info if you like, or at least update it to not reference Player.

And you can now make a turret control a vehicle (or anything else in theory) using "%someTurret.setControlObject(%someVehicle);"

I may update the resource with some basic example implementation later, but for now if you want to try out the functionality you will need: A vehicle with a mount point, and a TurretShape object with an "eye" node (or else it'll use the origin). Load a mission and follow these steps:
-Create a Vehicle and a TurretShape (not an AITurretShape).
-Mount the TurretShape to the Vehicle like this: vehicleID.mountObject(turretID, mountPoint);
-Set the TurretShape's control object to be the vehicle: turretID.setControlObject(vehicleID);
-Set your client's control object to be the turret: playerID.client.setControlObject(turretID);

You should now be looking out from the TurretShape's eye node but controlling the vehicle. If you want to move the turret, use the freelook key (default 'V') and move the mouse.

A couple known issues I'll try to solve (or maybe someone else can spot them):
-Wheels don't spin for you when you're driving from the turret. SOLVED
-Turret rotation is a little stuttery if you have vsync on, even if you're at a stable 60fps. Not really related to this code but kind of an annoying issue with the turrets in general.
-Turrets themselves kind of stutter when mounted to an object that another object is controlling (ie a player is driving the vehicle a turret is mounted to). This is also not related to this code but needs to be fixed, so I'll be looking into it.
-Turret/Vehicle combos look like they're using big spikes of bandwidth. This appears to be connected to the second issue above (stutter w/ vsync) and isn't actually an issue with excessive bandwidth usage. Apparently with vsync on something is causing the turret's updates (network or tick processing, don't know) to stack up and happen all at once. So instead of calling a network update every tick, it's saving up like 10 of them and calling them 3-4 times a second. So still not an issue with this code, but again needs to be fixed.

And finally one note about the old Paul Dana turrets and this code: I think it should work. Just find equivalent spots in that code to slot in the bits above and I imagine it'll work just fine.