tools/toolpersistent/ortoolpersistent_tool.cxx

/***************************************************************************************
 Autodesk(R) Open Reality(R) Samples
 
 (C) 2009 Autodesk, Inc. and/or its licensors
 All rights reserved.
 
 AUTODESK SOFTWARE LICENSE AGREEMENT
 Autodesk, Inc. licenses this Software to you only upon the condition that 
 you accept all of the terms contained in the Software License Agreement ("Agreement") 
 that is embedded in or that is delivered with this Software. By selecting 
 the "I ACCEPT" button at the end of the Agreement or by copying, installing, 
 uploading, accessing or using all or any portion of the Software you agree 
 to enter into the Agreement. A contract is then formed between Autodesk and 
 either you personally, if you acquire the Software for yourself, or the company 
 or other legal entity for which you are acquiring the software.
 
 AUTODESK, INC., MAKES NO WARRANTY, EITHER EXPRESS OR IMPLIED, INCLUDING BUT 
 NOT LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR 
 PURPOSE REGARDING THESE MATERIALS, AND MAKES SUCH MATERIALS AVAILABLE SOLELY ON AN 
 "AS-IS" BASIS.
 
 IN NO EVENT SHALL AUTODESK, INC., BE LIABLE TO ANYONE FOR SPECIAL, COLLATERAL, 
 INCIDENTAL, OR CONSEQUENTIAL DAMAGES IN CONNECTION WITH OR ARISING OUT OF PURCHASE 
 OR USE OF THESE MATERIALS. THE SOLE AND EXCLUSIVE LIABILITY TO AUTODESK, INC., 
 REGARDLESS OF THE FORM OF ACTION, SHALL NOT EXCEED THE PURCHASE PRICE OF THE 
 MATERIALS DESCRIBED HEREIN.
 
 Autodesk, Inc., reserves the right to revise and improve its products as it sees fit.
 
 Autodesk and Open Reality are registered trademarks or trademarks of Autodesk, Inc., 
 in the U.S.A. and/or other countries. All other brand names, product names, or 
 trademarks belong to their respective holders. 
 
 GOVERNMENT USE
 Use, duplication, or disclosure by the U.S. Government is subject to restrictions as 
 set forth in FAR 12.212 (Commercial Computer Software-Restricted Rights) and 
 DFAR 227.7202 (Rights in Technical Data and Computer Software), as applicable. 
 Manufacturer is Autodesk, Inc., 10 Duke Street, Montreal, Quebec, Canada, H3C 2L7.
***************************************************************************************/

// Class declaration
#include "ortoolpersistent_tool.h"
#include "ortoolpersistent_data.h"

//--- Registration defines
#define ORTOOLPERSISTENT__CLASS     ORTOOLPERSISTENT__CLASSNAME
#define ORTOOLPERSISTENT__LABEL     "Persistent"
#define ORTOOLPERSISTENT__DESC      "OR - Persistent Tool Description"

//--- FiLMBOX Registration & Implementation.
FBToolImplementation(   ORTOOLPERSISTENT__CLASS );
FBRegisterTool      (   ORTOOLPERSISTENT__CLASS,
                        ORTOOLPERSISTENT__LABEL,
                        ORTOOLPERSISTENT__DESC,
                        FB_DEFAULT_SDK_ICON     );  // Icon filename (default=Open Reality icon)


/************************************************
 *  FiLMBOX Constructor.
 ************************************************/
bool ORToolPersistent::FBCreate()
{

    StartSize[0] = 175;
    StartSize[1] = 95;

    UICreate    ();
    UIConfigure ();
    UIReset     ();

    OnShow.Add( this, (FBCallback) &ORToolPersistent::EventToolShow );
    OnIdle.Add( this, (FBCallback) &ORToolPersistent::EventToolIdle );

    mApplication.OnFileExit.Add         ( this, (FBCallback) &ORToolPersistent::EventOnFileExit );
    mApplication.OnFileNew.Add          ( this, (FBCallback) &ORToolPersistent::EventOnFileNew );
    mApplication.OnFileNewCompleted.Add ( this, (FBCallback) &ORToolPersistent::EventOnFileNewCompleted );
    mApplication.OnFileOpen.Add         ( this, (FBCallback) &ORToolPersistent::EventOnFileOpen );
    mApplication.OnFileOpenCompleted.Add( this, (FBCallback) &ORToolPersistent::EventOnFileOpenCompleted );
    mApplication.OnFileSave.Add         ( this, (FBCallback) &ORToolPersistent::EventOnFileSave );
    mApplication.OnFileSaveCompleted.Add( this, (FBCallback) &ORToolPersistent::EventOnFileSaveCompleted );

    return true;
}


/************************************************
 *  FiLMBOX Destructor.
 ************************************************/
void ORToolPersistent::FBDestroy()
{
    OnShow.Remove( this, (FBCallback) &ORToolPersistent::EventToolShow );
    OnIdle.Remove( this, (FBCallback) &ORToolPersistent::EventToolIdle );

    mApplication.OnFileExit.Remove          ( this, (FBCallback) &ORToolPersistent::EventOnFileExit );
    mApplication.OnFileNew.Remove           ( this, (FBCallback) &ORToolPersistent::EventOnFileNew );
    mApplication.OnFileNewCompleted.Remove  ( this, (FBCallback) &ORToolPersistent::EventOnFileNewCompleted );
    mApplication.OnFileOpen.Remove          ( this, (FBCallback) &ORToolPersistent::EventOnFileOpen );
    mApplication.OnFileOpenCompleted.Remove ( this, (FBCallback) &ORToolPersistent::EventOnFileOpenCompleted );
    mApplication.OnFileSave.Remove          ( this, (FBCallback) &ORToolPersistent::EventOnFileSave );
    mApplication.OnFileSaveCompleted.Remove ( this, (FBCallback) &ORToolPersistent::EventOnFileSaveCompleted );
}


/************************************************
 *  Create the UI.
 ************************************************/
void ORToolPersistent::UICreate()
{
    int lS = 4;
    int lW = 100;
    int lH = 18;

    // Create regions
    AddRegion( "LabelDirections",           "LabelDirections",
                                            lS, kFBAttachLeft,  "",     1.0,
                                            lS, kFBAttachTop,   "",     1.0,
                                            -lS,kFBAttachRight, "",     1.0,
                                            30, kFBAttachNone,  NULL,   1.0 );
    AddRegion( "PersistentText",            "PersistentText",
                                            lS, kFBAttachLeft,  "",     1.0,
                                            lS, kFBAttachBottom,"LabelDirections",1.0,
                                            lW, kFBAttachNone,  NULL,   1.0,
                                            lH, kFBAttachNone,  NULL,   1.0);
    // Assign regions
    SetControl( "LabelDirections",          mLabelDirections            );
    SetControl( "PersistentText",           mPersistentText             );
}


/************************************************
 *  .
 ************************************************/
void ORToolPersistent::UIConfigure()
{
    // Configuration
    mLabelDirections.Caption        = "Create persistent data for the\n"
                                      "tool by entering some text:";
    mPersistentText.Text            = GetPersistentData();

    // Callbacks
    mPersistentText.OnChange.Add        ( this, (FBCallback) &ORToolPersistent::EventTextChanged        );
}


/************************************************
 *  .
 ************************************************/
void ORToolPersistent::UIReset()
{

}


/************************************************
 *  .
 ************************************************/
void ORToolPersistent::UIRefresh()
{

}


/************************************************
 *  Create actor button callback.
 ************************************************/
void ORToolPersistent::EventTextChanged( HISender pSender, HKEvent pEvent   )
{
    SetPersistentData( (FBString)mPersistentText.Text );
}

/************************************************
 *  FBApplication callbacks.
 ************************************************/

void ORToolPersistent::EventOnFileExit( HISender pSender, HKEvent pEvent    )
{
    // nothing to do...
}

void ORToolPersistent::EventOnFileNew( HISender pSender, HKEvent pEvent )
{
    // nothing to do...
}

void ORToolPersistent::EventOnFileNewCompleted( HISender pSender, HKEvent pEvent    )
{
    // nothing to do...
}

void ORToolPersistent::EventOnFileOpen( HISender pSender, HKEvent pEvent )
{
    // nothing to do...
}

void ORToolPersistent::EventOnFileOpenCompleted( HISender pSender, HKEvent pEvent    )
{
    // Now that the file open, we want to see if there is already some
    // persistent data for us in the scene. If not, we use the current value.
}

void ORToolPersistent::EventOnFileSave( HISender pSender, HKEvent pEvent )
{
    // nothing to do...
}

void ORToolPersistent::EventOnFileSaveCompleted( HISender pSender, HKEvent pEvent    )
{
    // nothing to do...
}


/************************************************
 *  Show event.
 ************************************************/
void ORToolPersistent::EventToolShow( HISender pSender, HKEvent pEvent )
{
    FBEventShow lEvent( pEvent );

    if( lEvent.Shown )
    {
        UIReset();
    }
    else
    {
    }
}

/************************************************
 *  UI Idle event.
 ************************************************/
void ORToolPersistent::EventToolIdle( HISender pSender, HKEvent pEvent )
{
    UIRefresh();
}


/************************************************
 *  
 ************************************************/
ORToolPersistentData* ORToolPersistent::FindPersistentData( bool pCreate )
{
    // First we want to see if there is any infos for this tool present in the scene
    FBScene* lScene = mSystem.Scene;
    int lIdx = 0;
    
    for( lIdx = 0; lIdx < lScene->UserObjects.GetCount(); ++lIdx ) {
        FBUserObject* lObject = lScene->UserObjects[lIdx];
        if( lObject->Is( ORToolPersistentData::TypeInfo )) {
            return (ORToolPersistentData*)lObject;
        }
    }

    ORToolPersistentData* lData = 0;

    if( pCreate ) {
        lData = new ORToolPersistentData( "ORToolPersistentData" );
        lData->mText = "Default";
    }
    
    return lData;
}

void ORToolPersistent::DeletePersistentData()
{
    ORToolPersistentData* lData = FindPersistentData( false );
    if( lData ) {
        lData->FBDelete();
    }
}

FBString ORToolPersistent::GetPersistentData()
{
    return FindPersistentData( true )->mText;
}

void ORToolPersistent::SetPersistentData( FBString pText )
{
    FindPersistentData( true )->mText = pText;
}