kfbxplug.h

Go to the documentation of this file.

#ifndef FBXFILESDK_KFBXPLUGINS_KFBXPLUG_H
#define FBXFILESDK_KFBXPLUGINS_KFBXPLUG_H

/**************************************************************************************

 Copyright (C) 2001 - 2010 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 <fbxfilesdk/fbxfilesdk_def.h>

#include <fbxfilesdk/kfbxevents/kfbxemitter.h>
#include <fbxfilesdk/fbxfilesdk_new.h>

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFbxPlug;
class KFbxSdkManager;
class KFbxClassIdInfo;
class KFbxObject;
class KFbxPropertyHandle;

typedef KFbxPlug* (*kFbxPlugConstructor)(KFbxSdkManager& pManager, const char* pName, const KFbxPlug* pFrom, const char* pFBXType, const char* pFBXSubType);

class KFBX_DLL kFbxClassId
{
public:
    kFbxClassId();

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

    void Destroy();

    const char* GetName() const;

    kFbxClassId GetParent() const;

    KFbxPlug* Create(KFbxSdkManager& pManager, const char* pName, const KFbxPlug* pFrom);

    bool Override(kFbxPlugConstructor pConstructor);

    bool Is(kFbxClassId const pId) const;

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

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

#ifndef DOXYGEN_SHOULD_SKIP_THIS

    inline KFbxClassIdInfo* GetClassIdInfo() { return mClassInfo; }

    inline const KFbxClassIdInfo* 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();
   
    KFbxPropertyHandle* 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:
    kFbxClassId(KFbxClassIdInfo* mClassInfo);

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

    KFbxClassIdInfo* mClassInfo;

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

#define KFBXPLUG_DECLARE(Class)                                                                 \
public:                                                                                         \
    KFBXNEW_DECLARE_FRIEND                                                                      \
    static kFbxClassId ClassId;                                                                 \
    static Class* Create(KFbxSdkManager *pManager, const char *pName);                          \
    static Class* SdkManagerCreate(KFbxSdkManager *pManager, const char *pName, Class* pFrom)   \
    {                                                                                           \
        Class* lClass = FbxSdkNew< Class >(*pManager, pName);                                   \
        lClass->Construct(pFrom);                                                               \
        return lClass;                                                                          \
    }                                                                                           \
    virtual kFbxClassId GetClassId() const { return ClassId; }                                  \
    friend class FBXFILESDK_NAMESPACE::KFbxSdkManager;                                          \


#define KFBXPLUG_DECLARE_ABSTRACT(Class)                                                        \
public:                                                                                         \
    static kFbxClassId ClassId;                                                                 \
    static Class* Create(KFbxSdkManager *pManager, const char *pName);                          \
    static kFbxPlugConstructor SdkManagerCreate;                                                \
    virtual kFbxClassId GetClassId() const { return ClassId; }                                  \
    friend class FBXFILESDK_NAMESPACE::KFbxSdkManager;                                          \


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

#define KFBXPLUG_IMPLEMENT_ABSTRACT(Class)                                                      \
    kFbxClassId Class::ClassId;                                                                 \
    kFbxPlugConstructor Class::SdkManagerCreate = 0;                                            \
    Class* Class::Create(KFbxSdkManager *pManager, const char *pName)                           \
    {                                                                                           \
        Class* ClassPtr;                                                                        \
        ClassPtr = 0;                                                                           \
        return (Class*)pManager->CreateNewObjectFromClassId(Class::ClassId, pName);             \
    }                                                                                           \
    

class KFBX_DLL KFbxPlug : public kfbxevents::KFbxEmitter
{
    KFBXPLUG_DECLARE(KFbxPlug);

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

    virtual KFbxSdkManager* GetFbxSdkManager() const { return 0; }

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

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

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

    virtual bool SetRuntimeClassId(kFbxClassId pClassId);

    virtual kFbxClassId 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) { KFbxPlug::sgWipeMode = pState; }
    inline static bool GetWipeMode() { return KFbxPlug::sgWipeMode; }

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

protected:
    inline KFbxPlug() {}
    inline KFbxPlug(KFbxSdkManager& pManager, const char* pName) {}
    virtual ~KFbxPlug() {}

    virtual void Construct(const KFbxPlug* pFrom);
    virtual void Destruct(bool pRecursive, bool pDependents);
    friend class KFbxProperty;
    friend class KFbxObject;
#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
};

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

#define FBX_CLASSID(class) (class::ClassId)

template < class T > inline T* KFbxCast(KFbxPlug *pPlug)
{
    return pPlug && pPlug->Is(FBX_CLASSID(T)) ? (T *)pPlug : 0;
}

template < class T > inline T const* KFbxCast(KFbxPlug const*pPlug)
{
    return pPlug && pPlug->Is(FBX_CLASSID(T)) ? (T const*)pPlug : 0;
}

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXPLUGINS_KFBXPLUG_H