Torque2D/engine/source/gui/guiBitmapCtrl.cc

//-----------------------------------------------------------------------------
// Copyright (c) 2013 GarageGames, LLC
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
//-----------------------------------------------------------------------------

#include "console/console.h"
#include "console/consoleTypes.h"
#include "graphics/dgl.h"

#include "gui/guiBitmapCtrl.h"

IMPLEMENT_CONOBJECT(GuiBitmapCtrl);

GuiBitmapCtrl::GuiBitmapCtrl(void)
{
    mBitmapName = StringTable->EmptyString;
    startPoint.set(0, 0);
    mWrap = false;

    //Luma:	Ability to specify source rect for image UVs
    mUseSourceRect = false;
    mSourceRect.set(0, 0, 0, 0);
}

bool GuiBitmapCtrl::setBitmapName( void *obj, const char *data )
{
   // Prior to this, you couldn't do bitmap.bitmap = "foo.jpg" and have it work.
   // With protected console types you can now call the setBitmap function and
   // make it load the image.
   static_cast<GuiBitmapCtrl *>( obj )->setBitmap( data );

   // Return false because the setBitmap method will assign 'mBitmapName' to the
   // argument we are specifying in the call.
   return false;
}

void GuiBitmapCtrl::initPersistFields()
{
   Parent::initPersistFields();
   addGroup("GuiBitmapCtrl");		
   addProtectedField( "bitmap", TypeFilename, Offset( mBitmapName, GuiBitmapCtrl ), &setBitmapName, &defaultProtectedGetFn, "" );
   //addField("bitmap", TypeFilename, Offset(mBitmapName, GuiBitmapCtrl));
   addField("wrap",   TypeBool,     Offset(mWrap,       GuiBitmapCtrl));
   endGroup("GuiBitmapCtrl");		

   //Luma:	ability to specify source rect for image UVs
   addGroup("Misc");
   //ability to specify source rect for image UVs
   addField( "useSourceRect", TypeBool, Offset( mUseSourceRect, GuiBitmapCtrl ));
   addField( "sourceRect", TypeRectI, Offset( mSourceRect, GuiBitmapCtrl ));
   endGroup("Misc");	
}

ConsoleMethod( GuiBitmapCtrl, setValue, void, 4, 4, "(int xAxis, int yAxis)"
              "Set the offset of the bitmap.\n"
              "@return No return value."
              )
{
   object->setValue(dAtoi(argv[2]), dAtoi(argv[3]));
}

ConsoleMethod( GuiBitmapCtrl, setBitmap, void, 3, 3, "( pathName ) Use the setBitmap method to change the bitmap this control uses.\n"
                                                                "@param pathName A path to a new texture for this control. Limited to 256x256.\n"
                                                                "@return No return value")
{
   object->setBitmap(argv[2]);
}

ConsoleMethod(GuiBitmapCtrl, getTextureWidth, S32, 2, 2, "Gets the Width of the Texture.\n"
              "@return Texture Width"
              )
{
   return object->getWidth();
}

ConsoleMethod(GuiBitmapCtrl, getTextureHeight, S32, 2, 2, "Gets the Height of the Texture.\n"
              "@return Texture Height"
              )
{
   return object->getHeight();
}

bool GuiBitmapCtrl::onWake()
{
   if (! Parent::onWake())
      return false;
   setActive(true);
   setBitmap(mBitmapName);
   return true;
}

void GuiBitmapCtrl::onSleep()
{
   mTextureHandle = NULL;
   Parent::onSleep();
}

//-------------------------------------
void GuiBitmapCtrl::inspectPostApply()
{
   // if the extent is set to (0,0) in the gui editor and appy hit, this control will
   // set it's extent to be exactly the size of the bitmap (if present)
   Parent::inspectPostApply();

   if (!mWrap && (mBounds.extent.x == 0) && (mBounds.extent.y == 0) && mTextureHandle)
   {
      TextureObject *texture = (TextureObject *) mTextureHandle;
      mBounds.extent.x = texture->getBitmapWidth();
      mBounds.extent.y = texture->getBitmapHeight();
   }
}

void GuiBitmapCtrl::setBitmap(const char *name, bool resize)
{
   mBitmapName = StringTable->insert(name);
   if (*mBitmapName) {
      mTextureHandle = TextureHandle(mBitmapName, TextureHandle::BitmapTexture, true);

      // Resize the control to fit the bitmap
      if (resize) {
         TextureObject* texture = (TextureObject *) mTextureHandle;
         mBounds.extent.x = texture->getBitmapWidth();
         mBounds.extent.y = texture->getBitmapHeight();
         GuiControl *parent = getParent();
         if( !parent ) {
             Con::errorf( "GuiBitmapCtrl::setBitmap( %s ), trying to resize but object has no parent.", name ) ;
         } else {
             Point2I extent = parent->getExtent();
         parentResized(extent,extent);
      }
   }
   }
   else
      mTextureHandle = NULL;
   setUpdate();
}


void GuiBitmapCtrl::setBitmap(const TextureHandle &handle, bool resize)
{
   mTextureHandle = handle;

   // Resize the control to fit the bitmap
   if (resize) {
      TextureObject* texture = (TextureObject *) mTextureHandle;
      mBounds.extent.x = texture->getBitmapWidth();
      mBounds.extent.y = texture->getBitmapHeight();
      Point2I extent = getParent()->getExtent();
      parentResized(extent,extent);
   }
}


void GuiBitmapCtrl::onRender(Point2I offset, const RectI &updateRect)
{
   if (mTextureHandle)
   {
      dglClearBitmapModulation();
        if(mWrap)
        {
         // We manually draw each repeat because non power of two textures will 
         // not tile correctly when rendered with dglDrawBitmapTile(). The non POT
         // bitmap will be padded by the hardware, and we'll see lots of slack
         // in the texture. So... lets do what we must: draw each repeat by itself:
         TextureObject* texture = (TextureObject *) mTextureHandle;
            RectI srcRegion;
            RectI dstRegion;
            float xdone = ((float)mBounds.extent.x/(float)texture->getBitmapWidth())+1;
            float ydone = ((float)mBounds.extent.y/(float)texture->getBitmapHeight())+1;

            int xshift = startPoint.x%texture->getBitmapWidth();
            int yshift = startPoint.y%texture->getBitmapHeight();
            for(int y = 0; y < ydone; ++y)
                for(int x = 0; x < xdone; ++x)
                {
                    //Luma:	ability to specify source rect for image UVs
                    if(mUseSourceRect && mSourceRect.isValidRect())
                    {
                        srcRegion = mSourceRect;
                    }
                    else
                    {
                        srcRegion.set(0,0,texture->getBitmapWidth(),texture->getBitmapHeight());
                    }
                    dstRegion.set( ((texture->getBitmapWidth()*x)+offset.x)-xshift,
                                      ((texture->getBitmapHeight()*y)+offset.y)-yshift,
                                      texture->getBitmapWidth(),	
                                      texture->getBitmapHeight());
                dglDrawBitmapStretchSR(texture,dstRegion, srcRegion, false);
                }
        }
        else
      {
         RectI rect(offset, mBounds.extent);
        
         //Luma:	ability to specify source rect for image UVs
         if(mUseSourceRect && mSourceRect.isValidRect() )
         {
            RectI srcRegion;
            srcRegion = mSourceRect;
            dglDrawBitmapStretchSR(mTextureHandle,rect, srcRegion, false);
        }
        else
        {
            dglDrawBitmapStretch(mTextureHandle, rect);
        }
      }
   }

   if (mProfile->mBorder || !mTextureHandle)
   {
      RectI rect(offset.x, offset.y, mBounds.extent.x, mBounds.extent.y);
      dglDrawRect(rect, mProfile->mBorderColor);
   }

   renderChildControls(offset, updateRect);
}

void GuiBitmapCtrl::setValue(S32 x, S32 y)
{
   if (mTextureHandle)
   {
        TextureObject* texture = (TextureObject *) mTextureHandle;
        x+=texture->getBitmapWidth()/2;
        y+=texture->getBitmapHeight()/2;
    }
    while (x < 0)
        x += 256;
    startPoint.x = x % 256;
                
    while (y < 0)
        y += 256;
    startPoint.y = y % 256;
}

//Luma:	ability to specify source rect for image UVs
void GuiBitmapCtrl::setSourceRect(U32 x, U32 y, U32 width, U32 height) 
{ 
    mSourceRect.set(x, y, width, height); 
} 
void GuiBitmapCtrl::setUseSourceRect(bool bUse)
{
    mUseSourceRect = bUse;
}