tools/toolclipscene/ortoolclipscene_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.
***************************************************************************************/

#include <fbxsdk/scene/fbxscene.h>

//--- Class declaration
#include "ortoolclipscene_tool.h"


//--- Registration defines
#define ORTOOLCLIPSCENE__CLASS  ORTOOLCLIPSCENE__CLASSNAME
#define ORTOOLCLIPSCENE__LABEL  "Story Clip scene exposition"
#define ORTOOLCLIPSCENE__DESC   "FBSDK - Tool Clip Scene Description"

//--- FiLMBOX implementation and registration
FBToolImplementation(   ORTOOLCLIPSCENE__CLASS  );
FBRegisterTool      (   ORTOOLCLIPSCENE__CLASS,
                        ORTOOLCLIPSCENE__LABEL,
                        ORTOOLCLIPSCENE__DESC,
                        FB_DEFAULT_SDK_ICON     );  // Icon filename (default=Open Reality icon)

/************************************************
 *  FiLMBOX Constructor.
 ************************************************/
bool ORToolClipScene::FBCreate()
{
    StartSize[0] = 400;
    StartSize[1] = 700;

    // Configure layout
    AddRegion( "List", "List",  10,     kFBAttachLeft,      "", 1.0,
                                            10,     kFBAttachTop,       "", 1.0,
                                            -10,    kFBAttachRight,     "", 1.0,
                                            25,     kFBAttachNone,  "", 1.0);
    AddRegion( "Tree", "Tree",  10,     kFBAttachLeft,      "", 1.0,
        5,      kFBAttachBottom,        "List", 1.0,
        -10,    kFBAttachRight,     "", 1.0,
        -10,    kFBAttachBottom,    "", 1.0);

    SetControl( "List", mListClips );
    SetControl( "Tree", mClipScene );

    // Add tool callbacks
    OnShow.Add  ( this, (FBCallback) &ORToolClipScene::EventToolShow        );
    OnIdle.Add  ( this, (FBCallback) &ORToolClipScene::EventToolIdle        );
    OnResize.Add( this, (FBCallback) &ORToolClipScene::EventToolResize  );
    OnPaint.Add ( this, (FBCallback) &ORToolClipScene::EventToolPaint       );
    OnInput.Add ( this, (FBCallback) &ORToolClipScene::EventToolInput       );

    ((FBScene*)FBSystem::TheOne().Scene)->OnChange.Add (this, (FBCallback) &ORToolClipScene::EventSceneChange );
    mListClips.OnChange.Add( this, (FBCallback) &ORToolClipScene::EventListChange     );

    return true;
}


/************************************************
 *  FiLMBOX Destruction function.
 ************************************************/
void ORToolClipScene::FBDestroy()
{
    ((FBScene*)FBSystem::TheOne().Scene)->OnChange.Remove (this, (FBCallback) &ORToolClipScene::EventSceneChange );
    mListClips.OnChange.Remove( this, (FBCallback) &ORToolClipScene::EventListChange     );
    
    // Remove tool callbacks
    OnShow.Remove   ( this, (FBCallback) &ORToolClipScene::EventToolShow    );
    OnIdle.Remove   ( this, (FBCallback) &ORToolClipScene::EventToolIdle    );
    OnPaint.Remove  ( this, (FBCallback) &ORToolClipScene::EventToolPaint );
    OnInput.Remove  ( this, (FBCallback) &ORToolClipScene::EventToolInput );
    OnResize.Remove ( this, (FBCallback) &ORToolClipScene::EventToolResize);

    // Free user allocated memory
}

void ORToolClipScene::UIRefresh()
{
    UpdateClipList();
    UpdateClipScene();
}

void ORToolClipScene::UpdateClipList()
{
    FBScene* lScene = (FBScene*)FBSystem::TheOne().Scene;

    int lCount = lScene->Components.GetCount();

    FBStoryClip*    lCurrentClip = GetCurrentClip();
    int             lCurrentIndex = -1;

    mListClips.Items.Clear();
    for( int i = 0; i < lCount; i++ )
    {
        FBComponent* lComp = lScene->Components[i];
        if(FBIS(lComp,FBStoryClip))
        {
            mListClips.Items.Add(lComp->Name, (kReference)lComp);
            if(lCurrentClip == lComp)
            {
                lCurrentIndex = mListClips.Items.GetCount()-1;
            }
        }
    }

    if(lCurrentIndex == -1 && mListClips.Items.GetCount())
    {
        lCurrentIndex = 0;
    }

    mListClips.ItemIndex = lCurrentIndex;
}

void ORToolClipScene::UpdateClipScene()
{
    FBStoryClip* lClip = GetCurrentClip();

    FBXSDK_NAMESPACE::FbxScene* lFbxScene = lClip ? lClip->GetFbxScene() : NULL;
    
    FBTreeNode* lRoot = mClipScene.GetRoot();
    mClipScene.Clear();

    if(lFbxScene)
    {
        int lNodeCount = lFbxScene->GetNodeCount();
        for(int i = 0; i < lNodeCount; i++)
        {
            FBString    lNodeName = lFbxScene->GetNode(i)->GetName();
            mClipScene.InsertLast( lRoot, (char*)lNodeName );
        }
    }
}

FBStoryClip* ORToolClipScene::GetCurrentClip()
{
    FBStoryClip*    lClip = NULL;
    int             lCurrentIndex = mListClips.ItemIndex;

    if(lCurrentIndex != -1 && lCurrentIndex < mListClips.Items.GetCount())
    {
        lClip = (FBStoryClip*)mListClips.Items.GetReferenceAt(lCurrentIndex);
    }

    return lClip;
}


void ORToolClipScene::EventSceneChange( HISender pSender, HKEvent pEvent )
{
    static bool TransactionStarted = false;

    FBEventSceneChange lEvent( pEvent );

    switch( lEvent.Type )
    {
    case kFBSceneChangeTransactionBegin:
        {
            TransactionStarted = true;
        }
        break;

    case kFBSceneChangeTransactionEnd:
        {
            UIRefresh();
            TransactionStarted = false;
        }
        break;

    case kFBSceneChangeAddChild:
    case kFBSceneChangeRename:
    case kFBSceneChangeAttach:
    case kFBSceneChangeRemoveChild:
    case kFBSceneChangeDestroy:
    case kFBSceneChangeDetach:
        {
            if (!TransactionStarted) UIRefresh();
        }
        break;
    }
}

/************************************************
 *  Button click callback.
 ************************************************/
void ORToolClipScene::EventListChange( HISender pSender, HKEvent pEvent )
{
    UpdateClipScene();
}


/************************************************
 *  UI Idle callback.
 ************************************************/
void ORToolClipScene::EventToolIdle( HISender pSender, HKEvent pEvent )
{
}


/************************************************
 *  Handle tool activation (selection/unselection).
 ************************************************/
void ORToolClipScene::EventToolShow( HISender pSender, HKEvent pEvent )
{
    FBEventShow lEvent( pEvent );

    if( lEvent.Shown )
    {
        // Reset the UI here.
        UpdateClipList();
        UpdateClipScene();
    }
    else
    {
    }
}


/************************************************
 *  Paint callback for tool (on expose).
 ************************************************/
void ORToolClipScene::EventToolPaint( HISender pSender, HKEvent pEvent )
{
}


/************************************************
 *  Tool resize callback.
 ************************************************/
void ORToolClipScene::EventToolResize( HISender pSender, HKEvent pEvent )
{
}


/************************************************
 *  Handle input into the tool.
 ************************************************/
void ORToolClipScene::EventToolInput( HISender pSender, HKEvent pEvent )
{
}