tools/toolplugs/ortoolplugs_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 "ortoolplugs_tool.h"

//--- Registration defines
#define ORTOOLPLUGS__CLASS  ORTOOLPLUGS__CLASSNAME
#define ORTOOLPLUGS__LABEL  "Plugs"
#define ORTOOLPLUGS__DESC   "FBSDK - Tool Plugs Description"

//--- FiLMBOX implementation and registration
FBToolImplementation(   ORTOOLPLUGS__CLASS  );
FBRegisterTool      (   ORTOOLPLUGS__CLASS,
                        ORTOOLPLUGS__LABEL,
                        ORTOOLPLUGS__DESC,
                        FB_DEFAULT_SDK_ICON     );  // Icon filename (default=Open Reality icon)

#define MAX_BUFFER_LINE 15  //Used to determine the maximum line count in the memo

/************************************************
 *  FiLMBOX Constructor.
 ************************************************/
bool ORToolPlugs::FBCreate()
{
    StartSize[1] = 415;

    // Configure layout
    AddRegion("ConnNotifyLabel", NULL,  5,  kFBAttachLeft,  "", 1.0,
                                        3,  kFBAttachTop,   "", 1.0,
                                        -5, kFBAttachRight, "", 1.0,
                                        18, kFBAttachNone,  "", 1.0);
    SetControl("ConnNotifyLabel", mConnNotifyLabel);
    mConnNotifyLabel.Caption = "Connection Notify Events:";

    AddRegion("ConnNotify", NULL,   5,      kFBAttachLeft,      "",                 1.0,
                                    3,      kFBAttachBottom,    "ConnNotifyLabel",  1.0,
                                    -5,     kFBAttachRight,     "",                 1.0,
                                    100,    kFBAttachNone,      "",                 1.0);
    SetControl("ConnNotify", mConnNotify);

    AddRegion("ConnStateNotifyLabel", NULL, 5,  kFBAttachLeft,      "",             1.0,
                                            10, kFBAttachBottom,    "ConnNotify",   1.0,
                                            -5, kFBAttachRight,     "",             1.0,
                                            18, kFBAttachNone,      "",             1.0);
    SetControl("ConnStateNotifyLabel", mConnStateNotifyLabel);
    mConnStateNotifyLabel.Caption = "Connection State Notify Events:";

    AddRegion("ConnStateNotify", NULL,  5,      kFBAttachLeft,      "",                     1.0,
                                        3,      kFBAttachBottom,    "ConnStateNotifyLabel", 1.0,
                                        -5,     kFBAttachRight,     "",                     1.0,
                                        100,    kFBAttachNone,      "",                     1.0);
    SetControl("ConnStateNotify", mConnStateNotify);

    AddRegion("ConnDataNotifyLabel", NULL,  5,  kFBAttachLeft,      "",                 1.0,
                                            10, kFBAttachBottom,    "ConnStateNotify",  1.0,
                                            -5, kFBAttachRight,     "",                 1.0,
                                            18, kFBAttachNone,      "",                 1.0);
    SetControl("ConnDataNotifyLabel", mConnDataNotifyLabel);
    mConnDataNotifyLabel.Caption = "Connection Data Notify Events:";

    AddRegion("ConnDataNotify", NULL,   5,      kFBAttachLeft,      "",                     1.0,
                                        3,      kFBAttachBottom,    "ConnDataNotifyLabel",  1.0,
                                        -5,     kFBAttachRight,     "",                     1.0,
                                        100,    kFBAttachNone,      "",                     1.0);
    SetControl("ConnDataNotify", mConnDataNotify);

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

    return true;
}


/************************************************
 *  FiLMBOX Destruction function.
 ************************************************/
void ORToolPlugs::FBDestroy()
{
    // Remove tool callbacks
    OnShow.Remove   ( this, (FBCallback) &ORToolPlugs::EventToolShow    );
    OnIdle.Remove   ( this, (FBCallback) &ORToolPlugs::EventToolIdle    );
    OnPaint.Remove  ( this, (FBCallback) &ORToolPlugs::EventToolPaint );
    OnInput.Remove  ( this, (FBCallback) &ORToolPlugs::EventToolInput );
    OnResize.Remove ( this, (FBCallback) &ORToolPlugs::EventToolResize);

    // Free user allocated memory
}

void ORToolPlugs::EventConnNotify(HISender pSender, HKEvent pEvent)
{
    FBEventConnectionNotify     lEvent(pEvent);
    FBString                    lText;
    char                        lTmp[32];
    FBPlug*                     lPlug;
    static int                  lCounter = 0;

    sprintf( lTmp, "%d", lCounter );
    lText += lTmp;
    lText += ": Action=";
    lText += FBGetConnectionActionString(lEvent.Action);
    if (lEvent.SrcPlug)
    {
        if (lEvent.SrcPlug->Is(FBProperty::TypeInfo))
        {
            lPlug = lEvent.SrcPlug->GetOwner();
            lText += ",  Src=";
            lText += ((FBComponent*)lPlug)->Name;
            lText += ".";
            lPlug = lEvent.SrcPlug;
            lText += ((FBProperty*)lPlug)->GetName();
            lText += "(";
            sprintf( lTmp, "%d", (int)lEvent.SrcIndex );
            lText += lTmp;
            lText += ")";
        }
        else if (lEvent.SrcPlug->Is(FBComponent::TypeInfo))
        {
            lPlug = lEvent.SrcPlug;
            lText += ",  Src=";
            lText += ((FBComponent*)lPlug)->Name;
            lText += "(";
            sprintf( lTmp, "%d", (int)lEvent.SrcIndex );
            lText += lTmp;
            lText += ")";
        }
    }

    if (lEvent.DstPlug)
    {
        if (lEvent.DstPlug->Is(FBProperty::TypeInfo))
        {
            lPlug = lEvent.DstPlug->GetOwner();
            lText += ",  Dst=";
            lText += ((FBComponent*)lPlug)->Name;
            lText += ".";
            lPlug = lEvent.DstPlug;
            lText += ((FBProperty*)lPlug)->GetName();
        }
        else if (lEvent.DstPlug->Is(FBComponent::TypeInfo))
        {
            lPlug = lEvent.DstPlug;
            lText += ",  Dst=";
            lText += ((FBComponent*)lPlug)->Name;
        }
    }

    if (lEvent.NewPlug)
    {
        if (lEvent.NewPlug->Is(FBProperty::TypeInfo))
        {
            lPlug = lEvent.NewPlug->GetOwner();
            lText += ",  New=";
            lText += ((FBComponent*)lPlug)->Name;
            lText += ".";
            lPlug = lEvent.NewPlug;
            lText += ((FBProperty*)lPlug)->GetName();
        }
        else if (lEvent.NewPlug->Is(FBComponent::TypeInfo))
        {
            lPlug = lEvent.NewPlug;
            lText += ",  New=";
            lText += ((FBComponent*)lPlug)->Name;
        }
    }

    lText += ",  Type=";
    lText += FBGetConnectionTypeString(lEvent.ConnectionType);
    lText += "\n";

    FBStringList lLines;
    mConnNotify.GetStrings(&lLines);
    if( lLines.GetCount() >= MAX_BUFFER_LINE ) lLines.Remove(lLines.GetAt(0));  //Limit memo line count
    lLines.Add(lText);
    mConnNotify.SetStrings(&lLines);

    lCounter++;
    mConnNotify.Refresh();
}

void ORToolPlugs::EventConnStateNotify(HISender pSender, HKEvent pEvent)
{
    FBEventConnectionStateNotify    lEvent(pEvent);
    FBString                        lText;
    char                            lTmp[32];
    FBPlug*                         lPlug;
    static int                      lCounter = 0;
    
    sprintf( lTmp, "%d", lCounter );
    lText += lTmp;
    lText += ": Action=";
    lText += FBGetConnectionActionString(lEvent.Action);

    if (lEvent.Plug)
    {
        if (lEvent.Plug->Is(FBProperty::TypeInfo))
        {
            lPlug = lEvent.Plug->GetOwner();
            lText += ",  Plug=";
            lText += ((FBComponent*)lPlug)->Name;
            lText += ".";
            lPlug = lEvent.Plug;
            lText += ((FBProperty*)lPlug)->GetName();
        }
        else if (lEvent.Plug->Is(FBComponent::TypeInfo))
        {
            lPlug = lEvent.Plug;
            lText += ",  Plug=";
            lText += ((FBComponent*)lPlug)->Name;
        }
    }

    lText += ",  Data=";
    sprintf(lTmp, "0x%lX", lEvent.GetData());
    lText += lTmp;
    lText += ",  OldData=";
    sprintf(lTmp, "0x%lX", lEvent.GetOldData());
    lText += lTmp;

    FBStringList lLines;
    mConnStateNotify.GetStrings(&lLines);
    if( lLines.GetCount() >= MAX_BUFFER_LINE ) lLines.Remove(lLines.GetAt(0));  //Limit memo line count
    lLines.Add(lText);
    mConnStateNotify.SetStrings(&lLines);

    lCounter++;
    mConnStateNotify.Refresh();
}

void ORToolPlugs::EventConnDataNotify(HISender pSender, HKEvent pEvent)
{
    FBEventConnectionDataNotify lEvent(pEvent);
    FBString                    lText;
    char                        lTmp[32];
    FBPlug*                     lPlug;
    static int                  lCounter = 0;
    
    sprintf( lTmp, "%d", lCounter );
    lText += lTmp;
    lText += ": Action=";
    lText += FBGetConnectionActionString(lEvent.Action);
    if( lEvent.Plug )
    {
        if (lEvent.Plug->Is(FBProperty::TypeInfo))
        {
            lPlug = lEvent.Plug->GetOwner();
            lText += ",  Plug=";
            lText += ((FBComponent*)lPlug)->Name;
            lText += ".";
            lPlug = lEvent.Plug;
            lText += ((FBProperty*)lPlug)->GetName();
        }
        else if (lEvent.Plug->Is(FBComponent::TypeInfo))
        {
            lPlug = lEvent.Plug;
            lText += ",  Plug=";
            lText += ((FBComponent*)lPlug)->Name;
        }
    }
    lText += ",  Data=";
    sprintf(lTmp, "0x%lX", lEvent.GetData());
    lText += lTmp;
    lText += ",  OldData=";
    sprintf(lTmp, "0x%lX", lEvent.GetOldData());
    lText += lTmp;

    FBStringList lLines;
    mConnDataNotify.GetStrings(&lLines);
    if( lLines.GetCount() >= MAX_BUFFER_LINE ) lLines.Remove(lLines.GetAt(0));  //Limit memo line count
    lLines.Add(lText);
    mConnDataNotify.SetStrings(&lLines);

    lCounter++;
    mConnDataNotify.Refresh();
}


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


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

    if( lEvent.Shown )
    {
        // Add plugs events callbacks
        FBSystem::TheOne().OnConnectionNotify.Add(this, (FBCallback)&ORToolPlugs::EventConnNotify);
        FBSystem::TheOne().OnConnectionStateNotify.Add(this, (FBCallback)&ORToolPlugs::EventConnStateNotify);
        FBSystem::TheOne().OnConnectionDataNotify.Add(this, (FBCallback)&ORToolPlugs::EventConnDataNotify);
    }
    else
    {
        FBSystem::TheOne().OnConnectionNotify.Remove(this, (FBCallback)&ORToolPlugs::EventConnNotify);
        FBSystem::TheOne().OnConnectionStateNotify.Remove(this, (FBCallback)&ORToolPlugs::EventConnStateNotify);
        FBSystem::TheOne().OnConnectionDataNotify.Remove(this, (FBCallback)&ORToolPlugs::EventConnDataNotify);
    }
}


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


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


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


/************************************************
 *  FBX Storage.
 ************************************************/
bool ORToolPlugs::FbxStore  ( FBFbxObject* pFbxObject, kFbxObjectStore pStoreWhat )
{
    pFbxObject->FieldWriteBegin( "ORToolPlugsSection" );
    {
    }
    pFbxObject->FieldWriteEnd();

    return true;
}

/************************************************
 *  FBX Retrieval.
 ************************************************/
bool ORToolPlugs::FbxRetrieve( FBFbxObject* pFbxObject, kFbxObjectStore pStoreWhat )
{
    pFbxObject->FieldReadBegin( "ORToolPlugsSection" );
    {
    }
    pFbxObject->FieldReadEnd();

    return true;
}