Script-Defined ImageMaps Code

by Charlie Patterson · in Torque Game Builder · 05/08/2012 (1:53 pm) · 7 replies · Note: "blogs" and "resources" will not allow a post over 3500 chars. This is 25K!

Index: t2dImageMapDatablock.cc
===================================================================

--- t2dImageMapDatablock.cc	(revision 312)
+++ t2dImageMapDatablock.cc	(revision 337)
@@ -67,6 +67,8 @@
                 { t2dImageMapDatablock::T2D_IMAGEMAP_ERROR_FAIL_SEPERATOR_COLOR,        "Failed to get separator color!" },
                 { t2dImageMapDatablock::T2D_IMAGEMAP_ERROR_NO_FRAMES,                   "No frames have been acquired!" },
                 { t2dImageMapDatablock::T2D_IMAGEMAP_ERROR_INVALID_FRAME_COUNT,         "Number of frames acquired differs from that specified!" },
+                { t2dImageMapDatablock::T2D_IMAGEMAP_ERROR_INVALID_FRAME_DEFINITION,    "At least one frame index missing while building in SCRIPTED mode!" },
+                { t2dImageMapDatablock::T2D_IMAGEMAP_ERROR_NO_DEFINEMAP_METHOD,         "SCRIPTED mode used but method 'onDefineImageMapFrames' not defined!" },
                 { t2dImageMapDatablock::T2D_IMAGEMAP_ERROR_NO_LINKED_IMAGEMAPS,         "No LINK mode image-maps selected!" },
                 { t2dImageMapDatablock::T2D_IMAGEMAP_ERROR_NOT_ENOUGH_LINKED_IMAGEMAPS, "Not enough LINK mode image-maps selected; Must be at least two!" },
                 { t2dImageMapDatablock::T2D_IMAGEMAP_ERROR_INVALID_LINKED_IMAGEMAP,     "Invalid LINK mode image-map selected!" },
@@ -96,10 +98,11 @@
 //-----------------------------------------------------------------------------
 static EnumTable::Enums imageModeLookup[] =
                 {
-                { t2dImageMapDatablock::T2D_IMAGEMODE_FULL, "FULL" },
-                { t2dImageMapDatablock::T2D_IMAGEMODE_KEY,  "KEY" },
-                { t2dImageMapDatablock::T2D_IMAGEMODE_CELL, "CELL" },
-                { t2dImageMapDatablock::T2D_IMAGEMODE_LINK, "LINK" },
+                { t2dImageMapDatablock::T2D_IMAGEMODE_FULL,     "FULL" },
+                { t2dImageMapDatablock::T2D_IMAGEMODE_KEY,      "KEY" },
+                { t2dImageMapDatablock::T2D_IMAGEMODE_CELL,     "CELL" },
+                { t2dImageMapDatablock::T2D_IMAGEMODE_LINK,     "LINK" },
+                { t2dImageMapDatablock::T2D_IMAGEMODE_SCRIPTED, "SCRIPTED" },
                 };
 
 static EnumTable imageModeTable(sizeof(imageModeLookup) / sizeof(EnumTable::Enums), &imageModeLookup[0]);
@@ -249,7 +252,8 @@
                                                 mLockReference(0),
                                                 mTexturesLoaded(false),
 												mImageMapDumpComplete(false),
-												mForce16bit(0)
+												mForce16bit(0),
+                                                mOnDefineFramesScriptRunning(false)
 {
     // Set Vector Associations.
     VECTOR_SET_ASSOCIATION( mVecFrameIn );
@@ -351,9 +355,6 @@
         mLockReference = 1;
     }
 
-    // Compile ImageMap.
-    compileImageMap();
-
     bool valid = getIsValid();
 
     // Call Parent.
@@ -362,6 +363,9 @@
 
     setIsValid(valid);
 
+    // Compile ImageMap.
+    compileImageMap();
+
     // Linked Mode Image-Map?
  	 if ( getImageMapMode() != t2dImageMapDatablock::T2D_IMAGEMODE_LINK )
  	 {
@@ -741,6 +745,13 @@
 
         } break;
 
+        // Defined with Script-Callbacks
+        case T2D_IMAGEMODE_SCRIPTED:
+        {
+            // Calculate Map.
+            CHECK_IMAGEMAP_ERROR( calculateScriptedImageMap() );
+
+        } break;
     };
 
 	//Luma: don't unload the bitmap if we are also preloading... otherwise we end up loading twice (when we load textures for preloading)... SLOW!!!!!!!!!
@@ -1126,7 +1137,42 @@
     return true;
 }
 
+//------------------------------------------------------------------------------
+// Script-Defined ImageMap.
+//
+// Use TorqueScript to define frames.
+//------------------------------------------------------------------------------
+bool t2dImageMapDatablock::calculateScriptedImageMap( void )
+{
+    if ( ! Namespace::global()->lookup(StringTable->insert("onDefineImageMapFrames")) ) {
+        THROW_IMAGEMAP_ERROR( T2D_IMAGEMAP_ERROR_NO_DEFINEMAP_METHOD );
+    }
 
+    // the user script will be called now.
+    // they should call "addFrame(frameIndex, left, top, width, height)" for each frame of this image map before returning from their script
+    mOnDefineFramesScriptRunning = true;
+    Con::executef(3, "onDefineImageMapFrames", getName(), getSrcBitmapName());
+    mOnDefineFramesScriptRunning = false;
+
+    // TODO: need to sort frames? the frame index is a field in each frame, so array order may not matter
+    dQsort( mVecFrameIn.address(), mVecFrameIn.size(), sizeof(cFrameIn), frameInFrameNumberSort );
+
+    for (int i = 0; i < mVecFrameIn.size(); i++) {
+        if (mVecFrameIn[i].mFrame != i) {
+            THROW_IMAGEMAP_ERROR( T2D_IMAGEMAP_ERROR_INVALID_FRAME_DEFINITION );
+        }
+    }
+
+    // Return No Error.
+    return true;
+}
+
+S32 QSORT_CALLBACK t2dImageMapDatablock::frameInFrameNumberSort(const void* a, const void* b)
+{
+    // Ascending frame-number sort.
+    return ((*((cFrameIn*)a)).mFrame) - ((*((cFrameIn*)b)).mFrame);
+}
+
 //------------------------------------------------------------------------------
 // Link ImageMap.
 //
@@ -2452,8 +2498,38 @@
 }
 
 
+//-----------------------------------------------------------------------------
+// Add a Frame in SCRIPTED Mode.
+//-----------------------------------------------------------------------------
+ConsoleMethod(t2dImageMapDatablock, addFrame, void, 7, 7, "(frameIndex, x, y, width, height) Define one frame for an image map.n"
+			  "This may only be called while inside the method 'onDefineImageMapFrames'n"
+			  "@param frameIndex Index of this frame.  Can be in any order but final result should define frames 0..N-1 where N is the number of framesn"
+			  "@param x X value of the top left pixel of this frame within the bitmapn"
+			  "@param y Y value of the top left pixel of this frame within the bitmapn"
+			  "@param width Horizontal count of pixel within this framen"
+			  "@param height Vertical count of pixel within this framen"
+			  "@return No return value.")
+{
+    // only allow calls to this method when we are running from onDefineImageMapFrames user method.
+    if (!object->mOnDefineFramesScriptRunning) {
+        Con::warnf("t2dImageMapDatablock::addFrame() - cannot add frame unless in 'onDefineImageMapFrames' callback!" );
+        return;
+    }
 
+    S32 frame = dAtoi(argv[2]);
+    S32 x = dAtoi(argv[3]);
+    S32 y = dAtoi(argv[4]);
+    S32 width = dAtoi(argv[5]);
+    S32 height = dAtoi(argv[6]);
 
+    t2dImageMapDatablock::cFrameIn frameIn;
+    frameIn.mFrame = frame;
+    frameIn.mOriginalPixelArea.setArea( x, y, width, height );
+
+    object->mVecFrameIn.push_back( frameIn );
+}
+
+
 //------------------------------------------------------------------------------
 
 void t2dImageMapDatablock::packData(BitStream* stream)
Index: t2dImageMapDatablock.h
===================================================================
--- t2dImageMapDatablock.h	(revision 312)
+++ t2dImageMapDatablock.h	(revision 337)
@@ -30,6 +30,7 @@
     // QSorts.
     // --------------------------------------------------------------------------------------
     static S32 QSORT_CALLBACK frameOutFrameNumberSort(const void* a, const void* b);
+    static S32 QSORT_CALLBACK frameInFrameNumberSort(const void* a, const void* b);
     static S32 QSORT_CALLBACK frameInHeightSort(const void* a, const void* b);
 
 
@@ -62,6 +63,8 @@
         T2D_IMAGEMAP_ERROR_NO_LINKED_IMAGEMAPS          = 21,
         T2D_IMAGEMAP_ERROR_NOT_ENOUGH_LINKED_IMAGEMAPS  = 22,
         T2D_IMAGEMAP_ERROR_INVALID_LINKED_IMAGEMAP      = 23,
+        T2D_IMAGEMAP_ERROR_INVALID_FRAME_DEFINITION     = 24,
+        T2D_IMAGEMAP_ERROR_NO_DEFINEMAP_METHOD          = 25,
     };
 
 
@@ -86,6 +89,7 @@
         T2D_IMAGEMODE_KEY,
         T2D_IMAGEMODE_CELL,
         T2D_IMAGEMODE_LINK,
+        T2D_IMAGEMODE_SCRIPTED,
 
         T2D_IMAGEMODE_INVALID,
     };
@@ -253,7 +257,10 @@
 	bool						mForce16bit;				//Luma: control 16bit settings on a per-bitmap basis
 
     /// Frame Packing.
+public:
+    // expose the frame import variable to Console Methods (public)
     static typeFrameIn          mVecFrameIn;
+private:
     typeFrameOut                mVecFrameOut;
     typeTexturePage             mVecTexturePage;
     static typeFrameIn          mVecFrameOverflow;
@@ -263,13 +270,20 @@
     F32                         mTotalTimeTaken;
     U32                         mIterations;
 
+public:
 
+    // private but used from ConsoleMethod
+    bool                        mOnDefineFramesScriptRunning;
+
+private:
+
     /// Calculate Image Map Frames.
     bool calculateFrames( void );
     bool calculateFullImageMap( void );
     bool calculateCellImageMap( void );
     bool calculateKeyImageMap( void );
     bool calculateLinkImageMap( void );
+    bool calculateScriptedImageMap( void );
     bool calculateSrcFrames( void );
     bool validateFrames( void );
     bool calculateDstFrames( void );

Game Development Community

Script-Defined ImageMaps Code

Check out the "documentation"

Patch, patch, patch! Literally

code patches

patch for the torque engine's "engine/source" directory

patch for Torque's main directory (affects "tgb" and "tools")

your project's "common" directory

my personal "loaders.cs" file

About the author

Recent Threads