fbxevent.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2012 Autodesk, Inc.
   All rights reserved.
 
   Use of this software is subject to the terms of the Autodesk license agreement
   provided at the time of installation or download, or which otherwise accompanies
   this software in either electronic or hard copy form.
 
****************************************************************************************/

#ifndef _FBXSDK_CORE_EVENT_H_
#define _FBXSDK_CORE_EVENT_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/core/fbxpropertytypes.h>
#include <fbxsdk/core/fbxdatatypes.h>
#include <fbxsdk/core/sync/fbxsync.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

class FBXSDK_DLL FbxEventBase
{
  public:

     virtual ~FbxEventBase();

     virtual int GetTypeId() const = 0;

     virtual const char* GetEventName() const = 0;   

    protected:
     static int GetStaticTypeId(char const*);
};

// Force events to declare a name by using an abstract method, and force them to use 
// the proper name by making the call from FbxEvent<> go through the private static
// method.
#define FBXSDK_EVENT_DECLARE(Class)                                             \
    public: virtual const char* GetEventName() const { return FbxEventName(); } \
    private: static const char* FbxEventName() { return #Class; }               \
    friend class FbxEvent<Class>;                                               \

//
// Similar to above, but to be used when you've got an event template, and the
// type is something know to FBX
//
#define FBXSDK_EVENT_TYPE_DECLARE(Class, FBXType)                                  \
  public: virtual const char* GetEventName() const { return FbxEventName(); }      \
  private:                                                                         \
     static const char* FbxEventName() {                                           \
     static FbxString lEventName = FbxString(#Class) + FbxString("<") +                  \
     FbxGetDataTypeFromEnum(FbxTypeOf(*((FBXType const*)0))).GetName() + ">";               \
                                                                                   \
     return lEventName.Buffer();                                                   \
  }                                                                                \
  friend class FbxEvent< Class<FBXType> >;



//This is for templates classes that will uses non fbxtypes in their templates
//We force the the creation of an UNIQUE string for each types so that we can
//retrieve the event within multiple DLLs

//to be able to use this, the char EventName[] = "uniqueEventName"; must be declared
//globally.

#define FBXSDK_EVENT_TEMPLATE_HEADER(ClassName, TemplateName)\
template < class TemplateName, const char* T > \
class ClassName: public  FbxEvent< ClassName <TemplateName,T> >\
{\
    public: virtual const char* GetEventName() const {return FbxEventName();}\
    private: static const char* FbxEventName() {\
    static FbxString lEventName = (FbxString(#ClassName) +"<"+ FbxString(T) +">");\
    return lEventName.Buffer();\
    }\
    friend class FbxEvent< ClassName<TemplateName, T> >;


//This is the footer macro, to put at the end to close the template class
//created by FBXSDK_EVENT_TEMPLATE_HEADER
#define FBXSDK_EVENT_TEMPLATE_FOOTER()\
};

//---------------------------------------------------
// T : We use the curiously recurring template pattern
//          to initialize the typeId of each event type
template<typename T> class FbxEvent : public FbxEventBase
{
public:
    virtual ~FbxEvent(){}

    static void ForceTypeId(int pTypeId)
    {
        // This is to handle specific cases where the type ID must be hard coded
        // It is useful for shared event across DLL. We can then guarantee that
        // The ID of a certain type will always have the same ID
        smTypeId = pTypeId;
    }

    virtual int GetTypeId() const 
    {
        return GetStaticTypeId();
    }

    static int GetStaticTypeId() 
    {
        if( !smTypeId )
        {
            if( !smTypeId )
            {
                // If this does not compile, you need to add 
                // FBXSDK_EVENT_DECLARE(YourEventClassName) to your class declaration
                smTypeId  = FbxEventBase::GetStaticTypeId(T::FbxEventName());
            }
        }

       return smTypeId;
    }

private:
    static int smTypeId;
};

// Static members implementation
template<typename T> int FbxEvent<T>::smTypeId = 0;

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_CORE_EVENT_H_ */