devices/deviceskeleton/ordeviceskeleton_device.h

#ifndef __ORDEVICE_SKELETON_DEVICE_H__
#define __ORDEVICE_SKELETON_DEVICE_H__
/***************************************************************************************
 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.
***************************************************************************************/

//--- SDK include
#include <fbsdk/fbsdk.h>

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

//--- Registration defines
#define ORDEVICESKELETON_CLASSNAME      ORDeviceSkeleton
#define ORDEVICESKELETON_CLASSSTR       "ORDeviceSkeleton"

class DataChannel
{
public:
    DataChannel()
    {
        mTAnimNode      = NULL;
        mRAnimNode      = NULL;
        mModelTemplate  = NULL;
    }

    ~DataChannel()
    {
    }

public:
    FBAnimationNode*    mTAnimNode;         
    FBAnimationNode*    mRAnimNode;         
    FBModelTemplate*    mModelTemplate;     
};


class ORDeviceSkeleton : public FBDevice
{
    //--- Declaration
    FBDeviceDeclare( ORDeviceSkeleton, FBDevice );

public:
    virtual bool FBCreate() override;
    virtual void FBDestroy() override;

    //--- Standard device virtual functions evaluation
    virtual bool DeviceOperation    ( kDeviceOperations pOperation                                  ) override;     
    virtual bool AnimationNodeNotify( FBAnimationNode* pAnimationNode,FBEvaluateInfo* pEvaluateInfo ) override;     
    virtual void DeviceIONotify     ( kDeviceIOs  pAction, FBDeviceNotifyInfo &pDeviceNotifyInfo    ) override;     
    virtual void DeviceTransportNotify( kTransportMode pMode, FBTime pTime, FBTime pSystem ) override;              

    //--- Recording of frame information
    virtual void    RecordingDoneAnimation( FBAnimationNode* pAnimationNode) override;
    void    DeviceRecordFrame           (FBTime &pTime,FBDeviceNotifyInfo &pDeviceNotifyInfo);

    //--- Load/Save.
    virtual bool FbxStore   ( FBFbxObject* pFbxObject, kFbxObjectStore pStoreWhat ) override;   
    virtual bool FbxRetrieve( FBFbxObject* pFbxObject, kFbxObjectStore pStoreWhat ) override;   

    //--- Initialisation/Shutdown
    bool    Init    ();     
    bool    Start   ();     
    bool    Stop    ();     
    bool    Reset   ();     
    bool    Done    ();     

    //--- Attributes management
    void    SetNetworkUse(bool pUse)                    { mHardware.SetNetworkUse( pUse );              }
    bool    GetNetworkUse()                             { return mHardware.GetNetworkUse();             }
    void    SetNetworkAddress   (const char* pIPAddress){ mHardware.SetNetworkAddress(pIPAddress);      }
    const char* GetNetworkAddress   ()                  { return mHardware.GetNetworkAddress();         }
    void    SetNetworkPort      (int pPort)             { mHardware.SetNetworkPort(pPort);              }
    int     GetNetworkPort      ()                      { return mHardware.GetNetworkPort();            }

    //--- Get data from hardware.
    double GetDataTX(int pChannelIndex)         {   return mHardware.GetDataTX(pChannelIndex);      }
    double GetDataTY(int pChannelIndex)         {   return mHardware.GetDataTY(pChannelIndex);      }
    double GetDataTZ(int pChannelIndex)         {   return mHardware.GetDataTZ(pChannelIndex);      }
    double GetDataRX(int pChannelIndex)         {   return mHardware.GetDataRX(pChannelIndex);      }
    double GetDataRY(int pChannelIndex)         {   return mHardware.GetDataRY(pChannelIndex);      }
    double GetDataRZ(int pChannelIndex)         {   return mHardware.GetDataRZ(pChannelIndex);      }

    //--- Marker set management.
    void    DefineHierarchy             ();             
    void    Bind();                                     
    void    UnBind();                                   

    //--- Channel list manipulation.
    int     GetChannelCount()                   {   return mHardware.GetChannelCount();             }
    int     GetChannelParent(int pMarkerIndex)  {   return mHardware.GetChannelParent(pMarkerIndex);}
    const char* GetChannelName(int pMarkerIndex){   return mHardware.GetChannelName(pMarkerIndex);  }

    virtual bool ModelTemplateUnBindNotify( int pIndex, FBModelTemplate* pModelTemplate );                          

    bool    ReadyForCharacterize        ();             

    //--- Stop displaying process to local message on model unbind
    void    EventUIIdle( HISender pSender, HKEvent pEvent );

    ORDeviceSkeletonHardware    mHardware;                  
    FBModelTemplate*            mRootTemplate;              
private:
    DataChannel                 mChannels[sSKDataBuffer::ChannelCount]; 
    FBPropertyBool              UseReferenceTransformation; // !< Apply reference transformation on incoming global data.
    bool                        mHierarchyIsDefined;        

    FBPlayerControl             mPlayerControl;             
    FBSystem                    mSystem;
    FBApplication               mApplication;
    bool                        mHasAnimationToTranspose;
    bool                        mPlotting;

    // Process global data on template models to local
    void        ProcessGlobalToLocal();
    void SetupLocalGlobal(bool pGlobal);
};

#endif /* __ORDEVICE_SKELETON_DEVICE_H__ */