fbconsole.h

Go to the documentation of this file.

#ifndef __FBCONSOLE_H__
#define __FBCONSOLE_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

#include <fbsdk/fbcomponent.h>

#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif

enum FBConsoleChannelType {
    kFBConsoleNull,             
    kFBConsoleButton,           
    kFBConsoleSlider,           
    kFBConsoleTransport,        
    kFBConsoleEncoder,          
    kFBConsoleKey,              
    kFBConsoleDisplay,          
    kFBConsoleJoystick          
};
FB_DEFINE_ENUM( FBSDK_DLL, ConsoleChannelType );

__FB_FORWARD( FBConsoleChannel );

class FBSDK_DLL FBConsoleChannel : public FBComponent {
    __FBClassDeclare( FBConsoleChannel,FBComponent );
public:
    FBConsoleChannel(const char *pName);

    //--- Properties ---
    FBPropertyString                Name;           
    FBPropertyString                Description;    
    FBPropertyString                Group;          
    FBPropertyConsoleChannelType    Type;           
    FBPropertyDouble                Value;          
    FBPropertyDouble                Min;            
    FBPropertyDouble                Max;            
    FBPropertyDouble                Step;           
};
FB_DEFINE_ARRAY ( FBSDK_DLL, ConsoleChannel );

// FBPropertyListConsoleChannel

class FBSDK_DLL FBPropertyListConsoleChannel : public FBPropertyBaseList< FBConsoleChannel* >
{
private:
    FBArrayTemplate<FBConsoleChannel*> mItems;          

    virtual int  Add    ( FBConsoleChannel* pItem );    

public:
    virtual void RemoveAt( int pIndex );                

    virtual FBConsoleChannel* operator[](int pIndex);   

    virtual int  GetCount();                            

public:
    virtual int  Add    ( const char *pName );
   
    FBConsoleChannel* Find(const char *pName);
};

/*-------------------------------------------------------------------------
  Class FBConsole: Console base class
 -------------------------------------------------------------------------*/
__FB_FORWARD( FBConsole );
FB_FORWARD( FBFbxObject );

class FBSDK_DLL FBConsole : public FBComponent {
    __FBClassDeclare( FBConsole,FBComponent );
  private:

  public:
    FBConsole(const char *pName=NULL, HIObject pObject=NULL);

    FBPropertyListConsoleChannel        Channels;           
    FBPropertyBool                      IsTransportControl; 


    virtual bool FbxStore(FBFbxObject* pFbxObject,kFbxObjectStore pStoreWhat);
    virtual bool FbxRetrieve(FBFbxObject* pFbxObject,kFbxObjectStore pStoreWhat);

    // Re-implemented from FBComponent.
    virtual bool FBCreate();
    virtual void FBDestroy();

    virtual bool Open()         = 0;

    virtual bool Close()        = 0;

    virtual bool Initialize()   = 0;

    virtual bool FetchData()    = 0;
};
#define IJLCooper_Declare(IsPure)\
  public:\
    /* LCD screen */    \
 \
    virtual void LCDClearScreen     ( )                                             IsPure;\
 \
    virtual void LCDSendString      ( const char* pMessage, int pX = 0, int pY = 0 )IsPure;\
 \
    virtual void LCDSendChar        ( char pChar, int pX = 0, int pY = 0 )          IsPure;\
 \
    virtual void LCDSetCursorBlink  ( bool pState = true )                          IsPure;\
    /* TimeCode */  \
 \
    virtual void TCSetTime          ( FBTime pTime )                                IsPure;\


K_INTERFACE( IJLCooper, 100103033 );

__FB_FORWARD( FBJLCooper );

class FBSDK_DLL FBJLCooper : public FBComponent
{
  private:
    __FBClassDeclare( FBJLCooper, FBComponent );
  public:
    FBJLCooper          ( int pIndex = 0 );

    IJLCooper_Declare   ( K_IMPLEMENTATION );
};

    
#ifdef FBSDKUseNamespace
}
#endif
#endif