kfbxeventhandler.h

Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXEVENTS_KFBXEVENTHANDLER_H
00005 #define FBXFILESDK_KFBXEVENTS_KFBXEVENTHANDLER_H
00006 
00007 /**************************************************************************************
00008 
00009  Copyright (C) 2001 - 2010 Autodesk, Inc. and/or its licensors.
00010  All Rights Reserved.
00011 
00012  The coded instructions, statements, computer programs, and/or related material 
00013  (collectively the "Data") in these files contain unpublished information 
00014  proprietary to Autodesk, Inc. and/or its licensors, which is protected by 
00015  Canada and United States of America federal copyright law and by international 
00016  treaties. 
00017  
00018  The Data may not be disclosed or distributed to third parties, in whole or in
00019  part, without the prior written consent of Autodesk, Inc. ("Autodesk").
00020 
00021  THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
00022  ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
00023  WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR ARISING
00024  BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES OF TITLE, 
00025  NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE. 
00026  WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT WARRANT THAT THE OPERATION
00027  OF THE DATA WILL BE UNINTERRUPTED OR ERROR FREE. 
00028  
00029  IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
00030  OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR EXPENSES
00031  OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE DAMAGES OR OTHER
00032  SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS OF PROFITS, REVENUE
00033  OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR DAMAGES OF ANY KIND),
00034  HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF LIABILITY, WHETHER DERIVED
00035  FROM CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO, NEGLIGENCE), OR OTHERWISE,
00036  ARISING OUT OF OR RELATING TO THE DATA OR ITS USE OR ANY OTHER PERFORMANCE,
00037  WHETHER OR NOT AUTODESK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS
00038  OR DAMAGE. 
00039 
00040 **************************************************************************************/
00041 #include <fbxfilesdk/fbxfilesdk_def.h>
00042 
00043 // Local includes
00044 #include <fbxfilesdk/kfbxevents/kfbxevents.h>
00045 
00046 // FBX include
00047 #include <fbxfilesdk/components/kbaselib/klib/kintrusivelist.h>
00048 
00049 // FBX namespace begin
00050 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00051 namespace kfbxevents
00052 {
00053     class KFbxListener;
00054 
00055     //-----------------------------------------------------------------
00072     class KFbxEventHandler
00073     {
00074     public:
00075         enum
00076         {
00077             eNODE_LISTENER = 0,
00078             eNODE_EMITTER,
00079             eNODE_COUNT
00080         };
00081 
00084         KFbxEventHandler(){}
00085 
00088         virtual ~KFbxEventHandler(){}
00089 
00090         // Handler handles a certain type of event.
00094         virtual int GetHandlerEventType() = 0;
00095 
00100         virtual void FunctionCall(const KFbxEventBase& pEvent) = 0;
00101 
00105         virtual KFbxListener* GetListener() = 0;
00106 
00107         KFBX_LISTNODE(KFbxEventHandler, eNODE_COUNT);
00108     };
00109 
00111 //
00112 //  WARNING!
00113 //
00114 //  Anything beyond these lines may not be documented accurately and is
00115 //  subject to change without notice.
00116 //
00118 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00119     //-----------------------------------------------------------------
00120     template <typename EventType, typename ListenerType>
00121     class KFbxMemberFuncEventHandler : public KFbxEventHandler
00122     {
00123     // VC6Note: There's no reason why the callback is a (const EventType*) it is obvious that it should be
00124     //           a (const EventType&) but because of a VC6 template limitation, we put  a pointer. 
00125     typedef void (ListenerType::*CBFunction)(const EventType*);
00126 
00127     public:
00128         KFbxMemberFuncEventHandler(ListenerType* pListenerInstance, CBFunction pFunc) :
00129             mListener(pListenerInstance),
00130             mFunc(pFunc)
00131         {
00132         }
00133 
00134         // From KFbxEventHandler
00135         virtual int GetHandlerEventType(){ return EventType::GetStaticTypeId(); }  
00136         virtual void FunctionCall(const KFbxEventBase& pEvent){ (*mListener.*mFunc)(reinterpret_cast<const EventType*>(&pEvent)); } 
00137         virtual KFbxListener* GetListener(){ return mListener;}
00138     private:
00139         ListenerType* mListener;
00140 
00141         // The callback function
00142         CBFunction mFunc;
00143     };
00144 
00145     //-----------------------------------------------------------------
00146     template <typename EventType, typename ListenerType>
00147     class KFbxConstMemberFuncEventHandler : public KFbxEventHandler
00148     {
00149 
00150     // VC6Note: There's no reason why the callback is a (const EventType*) it is obvious that it should be
00151     //           a (const EventType&) but because of a VC6 template limitation, we put  a pointer. 
00152     typedef void (ListenerType::*CBFunction)(const EventType*)const;
00153 
00154     public:
00155         KFbxConstMemberFuncEventHandler(ListenerType* pListenerInstance, CBFunction pFunc) :
00156             mListener(pListenerInstance),
00157             mFunc(pFunc)
00158         {
00159         }
00160 
00161         // From KFbxEventHandler
00162         virtual int GetHandlerEventType(){ return EventType::GetStaticTypeId(); }    
00163         virtual void FunctionCall(const KFbxEventBase& pEvent){ (*mListener.*mFunc)(reinterpret_cast<const EventType*>(&pEvent)); }
00164         virtual KFbxListener* GetListener(){ return mListener;}
00165     private:
00166         ListenerType* mListener;
00167 
00168         // The callback function
00169         CBFunction mFunc;
00170     };
00171 
00172     //-----------------------------------------------------------------
00173     template <typename EventType>
00174     class KFbxFuncEventHandler : public KFbxEventHandler
00175     {
00176     // VC6Note: There's no reason why the callback is a (const EventType*,KFbxListener*) it is obvious that it should be
00177     //           a (const EventType&,KFbxListener*) but because of a VC6 template limitation, we put  a pointer.
00178     typedef void (*CBFunction)(const EventType*,KFbxListener*);
00179 
00180     public:
00181         KFbxFuncEventHandler(KFbxListener* pListener, CBFunction pFunc) :
00182             mListener(pListener),
00183             mFunc(pFunc)
00184         {
00185         }
00186 
00187         // From KFbxEventHandler
00188         virtual int GetHandlerEventType(){ return EventType::GetStaticTypeId(); }   
00189         virtual void FunctionCall(const KFbxEventBase& pEvent){ (*mFunc)(reinterpret_cast<const EventType*>(&pEvent),mListener); }
00190         virtual KFbxListener* GetListener(){ return mListener; }
00191     private:
00192         KFbxListener* mListener;
00193 
00194         // The callback function
00195         CBFunction mFunc;
00196     };
00197 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00198 }
00199 // FBX namespace end
00200 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00201 
00202 #endif // FBXFILESDK_KFBXEVENTS_KFBXEVENTHANDLER_H
00203