fbxplug.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_PLUG_H_
#define _FBXSDK_CORE_PLUG_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/core/fbxemitter.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

class FbxPlug;
class FbxManager;
class FbxClassIdInfo;
class FbxObject;
class FbxPropertyHandle;

typedef FbxPlug* (*FbxPlugCreateProc)(FbxManager& pManager, const char* pName, const FbxPlug* pFrom, const char* pFBXType, const char* pFBXSubType);

class FBXSDK_DLL FbxClassId
{
public:
    FbxClassId();

    FbxClassId(const char* pClassName, const FbxClassId& pParentClassId, FbxPlugCreateProc pConstructor=0, const char* pFBXType=NULL, const char* pFBXSubType=NULL);

    void Destroy();

    const char* GetName() const;

    FbxClassId GetParent() const;

    FbxPlug* Create(FbxManager& pManager, const char* pName, const FbxPlug* pFrom);

    bool Override(FbxPlugCreateProc pConstructor);

    bool Is(FbxClassId const pId) const;

    bool operator==(const FbxClassId& pClassId) const;

    bool operator!=(const FbxClassId& pClassId) const;

#ifndef DOXYGEN_SHOULD_SKIP_THIS

    inline FbxClassIdInfo* GetClassIdInfo() { return mClassInfo; }

    inline const FbxClassIdInfo* GetClassIdInfo() const { return mClassInfo; }
#endif 
    
    const char* GetFbxFileTypeName(bool pAskParent=false) const;

    const char* GetFbxFileSubTypeName() const;

    inline bool IsValid() const { return mClassInfo ? true : false; }
    
    void SetObjectTypePrefix(const char* pObjectTypePrefix);

    const char* GetObjectTypePrefix();
   
    FbxPropertyHandle* GetRootClassDefaultPropertyHandle();

    int ClassInstanceIncRef();

    int ClassInstanceDecRef();
     
    int GetInstanceRef();

//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is 
//  subject to change without notice.
//
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
    FbxClassId(FbxClassIdInfo* mClassInfo);

    bool SetFbxFileTypeName(const char* pName);
    bool SetFbxFileSubTypeName(const char* pName);

    FbxClassIdInfo* mClassInfo;

    friend class FbxManager;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
};

#define FBXSDK_PLUG_DECLARE(Class)                                                      \
public:                                                                                 \
    FBXSDK_FRIEND_NEW();                                                                \
    static FbxClassId ClassId;                                                          \
    static Class* Create(FbxManager* pManager, const char* pName);                      \
    static Class* ManagerCreate(FbxManager* pManager, const char* pName, Class* pFrom)  \
    {                                                                                   \
        Class* lClass = FbxNew< Class >(*pManager, pName);                              \
        lClass->Construct(pFrom);                                                       \
        return lClass;                                                                  \
    }                                                                                   \
    virtual FbxClassId GetClassId() const { return ClassId; }                           \
    friend class FBXSDK_NAMESPACE::FbxManager;                                          \


#define FBXSDK_ABSTRACT_PLUG_DECLARE(Class)                                             \
public:                                                                                 \
    static FbxClassId ClassId;                                                          \
    static Class* Create(FbxManager* pManager, const char* pName);                      \
    static FbxPlugCreateProc ManagerCreate;                                             \
    virtual FbxClassId  GetClassId() const { return ClassId; }                          \
    friend class FBXSDK_NAMESPACE::FbxManager;                                          \


#define FBXSDK_PLUG_IMPLEMENT(Class)                                                    \
    FbxClassId Class::ClassId;                                                          \
    Class* Class::Create(FbxManager* pManager, const char* pName)                       \
    {                                                                                   \
        Class* ClassPtr;                                                                \
        ClassPtr = 0;                                                                   \
        return (Class*)pManager->CreateNewObjectFromClassId(Class::ClassId, pName);     \
    }                                                                                   \
    

#define FBXSDK_ABSTRACT_PLUG_IMPLEMENT(Class)                                           \
    FbxClassId Class::ClassId;                                                          \
    FbxPlugCreateProc Class::ManagerCreate = 0;                                         \
    Class* Class::Create(FbxManager* pManager, const char* pName)                       \
    {                                                                                   \
        Class* ClassPtr;                                                                \
        ClassPtr = 0;                                                                   \
        return (Class*)pManager->CreateNewObjectFromClassId(Class::ClassId, pName);     \
    }                                                                                   \
    

class FBXSDK_DLL FbxPlug : public FbxEmitter
{
    FBXSDK_PLUG_DECLARE(FbxPlug);

public:
    virtual void Destroy(bool pRecursive=false, bool pDependents=false);

    virtual FbxManager* GetFbxManager() const { return 0; }

    virtual bool Is(FbxClassId pClassId) const { return GetClassId().Is(pClassId); }

    template < class T >inline bool Is(T* pFBX_TYPE) const                  { return Is(T::ClassId); }

    virtual bool IsRuntime(FbxClassId pClassId) const { return GetRuntimeClassId().Is(pClassId); }

    virtual bool SetRuntimeClassId(FbxClassId pClassId);

    virtual FbxClassId GetRuntimeClassId() const;

    virtual bool IsRuntimePlug() const { return !( GetRuntimeClassId() == GetClassId() ); }

//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is 
//  subject to change without notice.
//
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    inline static void SetWipeMode(bool pState) { FbxPlug::sgWipeMode = pState; }
    inline static bool GetWipeMode() { return FbxPlug::sgWipeMode; }

private:
    // used as global flag to modify the behavior of FbxObject::Destruct() during a ForceKill() on the scene.
    // This is for internal use
    static bool sgWipeMode;

protected:
    inline FbxPlug() {}
    inline FbxPlug(FbxManager& /*pManager*/, const char* /*pName*/) {}
    virtual ~FbxPlug() {}

    virtual void Construct(const FbxPlug* pFrom);
    virtual void Destruct(bool pRecursive, bool pDependents);
    friend class FbxProperty;
    friend class FbxObject;
#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
};

#define FBX_TYPE(class) ((const class*)0)

template < class T > inline T* FbxCast(FbxPlug* pPlug)
{
    return pPlug && pPlug->Is(T::ClassId) ? (T*)pPlug : 0;
}

template < class T > inline const T* FbxCast(const FbxPlug* pPlug)
{
    return pPlug && pPlug->Is(T::ClassId) ? (const T*)pPlug : 0;
}

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_CORE_PLUG_H_ */