fbdevicelayout.h

Go to the documentation of this file.

#ifndef __FBDEVICELAYOUT_H__
#define __FBDEVICELAYOUT_H__
/**************************************************************************
 Copyright (c) 1994 - 2009 Autodesk, Inc. and/or its licensors.
 All Rights Reserved.
 
 The coded instructions, statements, computer programs, and/or related 
 material (collectively the "Data") in these files contain unpublished 
 information proprietary to Autodesk, Inc. and/or its licensors, which is 
 protected by Canada and United States of America federal copyright law 
 and by international treaties.
 
 The Data may not be disclosed or distributed to third parties, in whole 
 or in part, without the prior written consent of Autodesk, Inc. 
 ("Autodesk").
 
 THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
 ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO 
 WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR 
 ARISING BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES 
 OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR 
 PURPOSE OR USE. WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT 
 WARRANT THAT THE OPERATION OF THE DATA WILL BE UNINTERRUPTED OR ERROR 
 FREE.
 
 IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS 
 OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR 
 EXPENSES OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE 
 DAMAGES OR OTHER SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS 
 OF PROFITS, REVENUE OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR 
 DAMAGES OF ANY KIND), HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF 
 LIABILITY, WHETHER DERIVED FROM CONTRACT, TORT (INCLUDING, BUT NOT 
 LIMITED TO, NEGLIGENCE), OR OTHERWISE, ARISING OUT OF OR RELATING TO THE 
 DATA OR ITS USE OR ANY OTHER PERFORMANCE, WHETHER OR NOT AUTODESK HAS 
 BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.
 
**************************************************************************/

#include <kaydaradef.h>
#ifndef FBSDK_DLL

    #define FBSDK_DLL K_DLLIMPORT
#endif

// Core includes
#include <fbsdk/fbcore.h>   // FBPropertyDevice

// UI includes
#include <fbcontrols/fbcontrols.h>

// Namespace declaration
#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif

#ifndef FB_KERNEL
    FB_FORWARD( FBDeviceCameraInstrument );
    FB_FORWARD( FBDeviceCamera );
#endif

#if !defined(K_NO_OPTICAL)
    FB_FORWARD( FBDeviceOptical );
#endif

#define FBRegisterDeviceLayout( ClassName,UniqueNameStr, IconFilename ) \
    HIObject RegisterDeviceLayout##ClassName( HIObject /*pOwner*/,const char * /*pName*/,void *pData) \
    {\
        ClassName *Class = new ClassName( (FBDevice*)FBGetFBObject((HIObject)pData) ); \
        Class->mAllocated = true; \
        if (Class->FBCreate()) { \
            return Class->GetHIObject(); \
        } else { \
            delete Class; \
            return NULL; \
        } \
    } \
    FBLibraryModule( ClassName )    \
    {   \
        FBRegisterObject( ClassName,"UI_Associated_ClassName",UniqueNameStr,UniqueNameStr" Device Layout",RegisterDeviceLayout##ClassName, true, IconFilename );\
    }

#define FBDeviceLayoutDeclare( ClassName,Parent ) \
    FBClassDeclare( ClassName,Parent ); \
  public: \
    ClassName(FBDevice* pDevice):Parent(pDevice) { FBClassInit; } \
  private:

#define FBDeviceLayoutImplementation( ThisComponent ) \
    FBClassImplementation( ThisComponent )

// FBDeviceLayout
__FB_FORWARD( FBDeviceLayout );

class FBSDK_DLL FBDeviceLayout :    public FBLayout {
    __FBClassDeclare( FBDeviceLayout,FBLayout );

public:
    FBDeviceLayout( FBDevice* pDevice = NULL );

    FBPropertyDevice    Device;                 
};

#if !defined(K_NO_OPTICAL)
// FBDeviceOpticalLayout
__FB_FORWARD( FBDeviceOpticalLayout);

class FBSDK_DLL FBDeviceOpticalLayout : public FBDeviceLayout
{
    // Basic declaration macros
    __FBClassDeclare( FBDeviceOpticalLayout , FBDeviceLayout);

  public:
    enum FBDeviceOpticalGUIOptions  { 
        kGUIModelOpticalList        = 1<<0,     
        kGUIModelOpticalCreate      = 1<<1,     
        kGUIModelOpticalDampingTime = 1<<2,     
        kGUIDeviceStatus            = 1<<3,     
        kGUIDeviceReset             = 1<<4,     
        kGUIViewer                  = 1<<5      
    };
    
    FBDeviceOpticalLayout( FBDevice* pDevice = NULL );

    //---- See base class ----
    // Standard device virtual functions creation
    virtual bool FBCreate();

  public:
    FBDeviceOptical*        mDeviceOptical;         
    FBPropertyInt           GenericUIOptions;       
};
#endif

#ifndef FB_KERNEL
/**************************************************************************
 **************************************************************************/
__FB_FORWARD( FBDeviceCameraLayout);
#define FBTRACKER_NO_LENSFILE   "-- no lens file --"

class FBSDK_DLL FBDeviceCameraLayout : public FBDeviceLayout
{
    //--- Open Reality declaration.
    __FBClassDeclare( FBDeviceCameraLayout, FBDeviceLayout );
  public: 
    FBDeviceCameraLayout(FBDevice* pDevice);

    //--- Open Reality Creation/Destruction.
    virtual bool FBCreate();        
    virtual void FBDestroy();       
                                                    
public:
    //--- UI Management
    virtual void    UICreate                            ();     
    virtual void        UICreateLayoutInstruments       ();     
    virtual void        UICreateLayoutCommunication     ();     
    virtual void        UICreateLayoutInfo              ();     
    virtual void        UICreateLayoutCustom            ();     
    virtual void    UIConfigure                         ();     
    virtual void        UIConfigureLayoutInstruments    ();     
    virtual void        UIConfigureLayoutCommunication  ();     
    virtual void        UIConfigureLayoutInfo           ();     
    virtual void        UIConfigureLayoutCustom         ();     
    virtual void    UIRefresh                           ();     
    virtual void        UIRefreshLayoutInstruments      ();     
    virtual void        UIRefreshLayoutCommunications   ();     
    virtual void        UIRefreshLayoutCustom           ();     
    virtual void    UIUpdateEnabled                     ();     
    virtual void    UIReset                             ();     
    virtual void        UIResetLayoutInstruments        ();     
    virtual void        UIResetLayoutCommunications     ();     
    virtual void        UIResetLayoutCustom             ();     

    virtual FBDeviceCameraInstrument* GetCurrentInstrument();

protected:
    FBTabPanel          mTabPanel;                      

    FBLayout            mLayoutInstruments;             
        FBList              mListInstruments;           
        FBButton            mButtonActive;              

        // Fov
        FBButton            mButtonManualFov;           
        FBLabel             mLabelFovX;                 
        FBLabel             mLabelFovY;                 
        FBSlider            mSliderFovX;                
        FBSlider            mSliderFovY;                
        FBEditNumber        mEditNumberFovX;            
        FBEditNumber        mEditNumberFovY;            

        // Optical Center
        FBButton            mButtonManualCenter;        
        FBLabel             mLabelCenterX;              
        FBLabel             mLabelCenterY;              
        FBSlider            mSliderCenterX;             
        FBSlider            mSliderCenterY;             
        FBEditNumber        mEditNumberCenterX;         
        FBEditNumber        mEditNumberCenterY;         

        // Offsets
        FBLabel             mLabelOffsetT;              
        FBLabel             mLabelOffsetR;              
        FBEditVector        mEditVectorOffsetT;         
        FBEditVector        mEditVectorOffsetR;         

        // Lens Calibration
        FBButton            mButtonLoadLensfile;        
        FBButton            mButtonResetLensfile;       
        FBLabel             mLabelLensfileName;         
        FBLabel             mLabelInversion;            
        FBButton            mButtonInvertZoom;          
        FBButton            mButtonInvertFocus;         
        FBLabel             mLabelFovUnits;             
        FBButton            mButtonFovUnitsDeg;         
        FBButton            mButtonFovUnitsRad;         
        FBLabel             mLabelNodalX;               
        FBSlider            mSliderNodalX;              
        FBEditNumber        mEditNumberNodalX;          
        FBLabel             mLabelZoomX;                
        FBSlider            mSliderZoomX;               
        FBEditNumber        mEditNumberZoomX;           

        // Video format
        FBLabel             mLabelAspectRatio;          
        FBSlider            mSliderAspectRatio;         
        FBEditNumber        mEditNumberAspectRatio;     
        FBLabel             mLabelAspectRatioPresets;   
        FBList              mListAspectRatioPresets;    

    FBLayout            mLayoutCommunication;           
        // Sync
        FBLabel             mLabelSyncDelay;            
        FBSlider            mSliderSyncDelay;           
        FBEditNumber        mEditNumberSyncDelay;       
        FBButton            mButtonSyncInfo;            
    
        // Serial port
        FBButton            mButtonEnableSerial;        
            FBLabel             mLabelSerialPort;       
            FBList              mListSerialPort;        
            FBLabel             mLabelSerialBaudRate;   
            FBList              mListSerialBaudRate;    

        // Network
        FBButton            mButtonEnableNetwork;       
            FBLabel             mLabelNetworkAddress;   
            FBEdit              mEditNetworkAddress;    
            FBLabel             mLabelNetworkPort;      
            FBEdit              mEditNetworkPort;       
            FBLabel             mLabelNetworkProtocol;  
            FBList              mListNetworkProtocol;   

        // Shared Memory
        FBButton            mButtonEnableSharedMemory;  
            FBLabel             mLabelHandle;           
            FBEdit              mEditHandle;            
            FBLabel             mLabelAddress;          
            FBEdit              mEditAddress;           

        // Simulator
        FBButton            mButtonEnableSimulator;             
            FBLabel             mLabelSimulatorFrequency;       
            FBSlider            mSliderSimulatorFrequency;      
            FBEditNumber        mEditNumberSimulatorFrequency;  
            FBLabel             mLabelSimulatorAmplitude;       
            FBSlider            mSliderSimulatorAmplitude;      
            FBEditNumber        mEditNumberSimulatorAmplitude;  
            FBLabel             mLabelSimulatorZoom;            
            FBSlider            mSliderSimulatorZoom;           
            FBEditNumber        mEditNumberSimulatorZoom;       
            FBLabel             mLabelSimulatorFocus;           
            FBSlider            mSliderSimulatorFocus;          
            FBEditNumber        mEditNumberSimulatorFocus;      

    FBLayout            mLayoutInfo;                    
        FBSpread            mSpreadInfo;                

    FBLayout            mLayoutCustom;                  

public:
    // Device/Idle callbacks
    virtual void    OnDeviceStatusChange        ( HISender pSender, HKEvent pEvent );       
    virtual void    OnUIIdle                    ( HISender pSender, HKEvent pEvent );       

    // Base UI manipulation callbacks
    virtual void    OnTabPanelChange            ( HISender pSender, HKEvent pEvent );       
    virtual void    OnListInstrumentsChange     ( HISender pSender, HKEvent pEvent );       

    // Instrument/lens
    // These should be fine
    virtual void    OnButtonActiveClick             ( HISender pSender, HKEvent pEvent );               
    virtual void    OnButtonManualChange                        ( HISender pSender, HKEvent pEvent );   
    virtual void        OnButtonManualFovClick                  ( HISender pSender, HKEvent pEvent );   
    virtual void        OnButtonManualCenterClick               ( HISender pSender, HKEvent pEvent );   
    virtual void    OnFovChange                     ( HISender pSender, HKEvent pEvent );               
    virtual void        OnFovXSliderChange                      ( HISender pSender, HKEvent pEvent );   
    virtual void        OnFovYSliderChange                      ( HISender pSender, HKEvent pEvent );   
    virtual void        OnFovXEditNumberChange                  ( HISender pSender, HKEvent pEvent );   
    virtual void        OnFovYEditNumberChange                  ( HISender pSender, HKEvent pEvent );   
    virtual void    OnCenterChange                  ( HISender pSender, HKEvent pEvent );               
    virtual void        OnCenterXSliderChange                   ( HISender pSender, HKEvent pEvent );   
    virtual void        OnCenterYSliderChange                   ( HISender pSender, HKEvent pEvent );   
    virtual void        OnCenterXEditNumberChange               ( HISender pSender, HKEvent pEvent );   
    virtual void        OnCenterYEditNumberChange               ( HISender pSender, HKEvent pEvent );   
    virtual void    OnOffsetChange                  ( HISender pSender, HKEvent pEvent );               
    virtual void        OnOffsetTChange                         ( HISender pSender, HKEvent pEvent );   
    virtual void        OnOffsetRChange                         ( HISender pSender, HKEvent pEvent );   
    virtual void    OnLensfileChange                ( HISender pSender, HKEvent pEvent );               
    virtual void    OnButtonLoadLensfileClick       ( HISender pSender, HKEvent pEvent );               
    virtual void    OnButtonResetLensfileClick      ( HISender pSender, HKEvent pEvent );               
    virtual void    OnInvertChange                  ( HISender pSender, HKEvent pEvent );               
    virtual void        OnInvertFocusClick                      ( HISender pSender, HKEvent pEvent );   
    virtual void        OnInvertZoomClick                       ( HISender pSender, HKEvent pEvent );   
    virtual void    OnFovUnitsChange                ( HISender pSender, HKEvent pEvent );               
    virtual void        OnFovUnitsDegClick                      ( HISender pSender, HKEvent pEvent );   
    virtual void        OnFovUnitsRadClick                      ( HISender pSender, HKEvent pEvent );   
    virtual void    OnNodalXChange                  ( HISender pSender, HKEvent pEvent );               
    virtual void        OnNodalXSliderChange                    ( HISender pSender, HKEvent pEvent );   
    virtual void        OnNodalXEditNumberChange                ( HISender pSender, HKEvent pEvent );   
    virtual void    OnZoomXChange                   ( HISender pSender, HKEvent pEvent );               
    virtual void        OnZoomXSliderChange                     ( HISender pSender, HKEvent pEvent );   
    virtual void        OnZoomXEditNumberChange                 ( HISender pSender, HKEvent pEvent );   
    virtual void    OnAspectRatioChange             ( HISender pSender, HKEvent pEvent );               
    virtual void        OnAspectRatioSliderChange               ( HISender pSender, HKEvent pEvent );   
    virtual void        OnAspectRatioEditNumberChange           ( HISender pSender, HKEvent pEvent );   
    virtual void        OnAspectRatioPresetChange               ( HISender pSender, HKEvent pEvent );   

    // Communications
    // These need to be overloaded.
    virtual void    OnSyncDelayChange               ( HISender pSender, HKEvent pEvent );               
    virtual void        OnSyncDelaySliderChange                 ( HISender pSender, HKEvent pEvent );   
    virtual void        OnSyncDelayEditNumberChange             ( HISender pSender, HKEvent pEvent );   
    virtual void    OnButtonSyncInfoClick           ( HISender pSender, HKEvent pEvent );               

    virtual void    OnEnableChange                  ( HISender pSender, HKEvent pEvent );               
    virtual void        OnEnableSerialClick                     ( HISender pSender, HKEvent pEvent );   
    virtual void        OnEnableSimulatorClick                  ( HISender pSender, HKEvent pEvent );   
    virtual void        OnEnableNetworkClick                    ( HISender pSender, HKEvent pEvent );   
    virtual void        OnEnableSharedMemoryClick               ( HISender pSender, HKEvent pEvent );   

    virtual void    OnSerialChange                  ( HISender pSender, HKEvent pEvent );               
    virtual void        OnSerialPortChange                      ( HISender pSender, HKEvent pEvent );   
    virtual void        OnSerialBaudRateChange                  ( HISender pSender, HKEvent pEvent );   
    virtual void    OnNetworkChange                 ( HISender pSender, HKEvent pEvent );               
    virtual void        OnNetworkAddressChange                  ( HISender pSender, HKEvent pEvent );   
    virtual void        OnNetworkPortChange                     ( HISender pSender, HKEvent pEvent );   
    virtual void        OnNetworkProtocolChange                 ( HISender pSender, HKEvent pEvent );   
    virtual void    OnSimulatorChange               ( HISender pSender, HKEvent pEvent );               
    virtual void        OnSimulatorAmplitudeEditNumberChange    ( HISender pSender, HKEvent pEvent );   
    virtual void        OnSimulatorAmplitudeSliderChange        ( HISender pSender, HKEvent pEvent );   
    virtual void        OnSimulatorFrequencyEditNumberChange    ( HISender pSender, HKEvent pEvent );   
    virtual void        OnSimulatorFrequencySliderChange        ( HISender pSender, HKEvent pEvent );   
    virtual void        OnSimulatorZoomEditNumberChange         ( HISender pSender, HKEvent pEvent );   
    virtual void        OnSimulatorZoomSliderChange             ( HISender pSender, HKEvent pEvent );   
    virtual void        OnSimulatorFocusEditNumberChange        ( HISender pSender, HKEvent pEvent );   
    virtual void        OnSimulatorFocusSliderChange            ( HISender pSender, HKEvent pEvent );   
    virtual void    OnSharedMemoryChange            ( HISender pSender, HKEvent pEvent );               
    virtual void        OnSharedMemoryHandleChange              ( HISender pSender, HKEvent pEvent );   
    virtual void        OnSharedMemoryAddressChange             ( HISender pSender, HKEvent pEvent );   

protected:  
    FBDeviceCamera*     mDeviceCamera;          
    FBPropertyInt       SupportedCommTypes;     
    FBPropertyBool      CustomLayout;           
};
#endif

#ifdef FBSDKUseNamespace
    }
#endif
#endif