fbxcallbacks.h

Go to the documentation of this file.

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

   Copyright (C) 2019 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_FILEIO_CALLBACKS_H_
#define _FBXSDK_FILEIO_CALLBACKS_H_

#include <fbxsdk/fbxsdk_def.h>
#include <fbxsdk/core/fbxclassid.h>
#include <fbxsdk/core/fbxobject.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

#define FBXCALLBACK_FUNCTION(x) FbxHandle(x)
#define FBXCALLBACK_USERDATA(x) FbxHandle((void*)(x))
class FBXSDK_DLL FbxCallback : public FbxObject
{
    FBXSDK_ABSTRACT_OBJECT_DECLARE(FbxCallback, FbxObject);

public:
    enum State {
        eFailure = 0,      // The callback function failed for whatever reason
        eNotHandled = 1,   // The callback function did not handled the data
        eHandled = 2       // The callback function handled the data
    };

    void SetDataHint(FbxClassId pDataHint);

    bool GetCallback(int pId, FbxHandle& pFunction, FbxHandle& pUserData);

protected:
    int AddCallback(FbxHandle pFunction, FbxHandle pUserData = FBXCALLBACK_USERDATA(nullptr));

    /*****************************************************************************************************************************
    ** WARNING! Anything beyond these lines is for internal use, may not be documented and is subject to change without notice! **
    *****************************************************************************************************************************/
#ifndef DOXYGEN_SHOULD_SKIP_THIS
protected:
    FbxArray<FbxHandle>  mCallbackFunctions;
    FbxArray<FbxHandle>  mUserData;
    FbxClassId mDataHint;

    void Construct(const FbxObject* pFrom) override;
    void Destruct(bool pRecursive) override;
#endif
};

class FBXSDK_DLL FbxEmbeddedFileCallback : public FbxCallback
{
    FBXSDK_OBJECT_DECLARE(FbxEmbeddedFileCallback, FbxCallback);

public:
    typedef FbxCallback::State (*ReadCBFunction)(void* pUserData, FbxClassId pDataHint,
        const char* pFileName, const void* pFileBuffer, size_t pSizeInBytes);

    int RegisterReadFunction(ReadCBFunction pFunction, void* pUserData = nullptr);

    FbxCallback::State Trigger(const char* pFileName, const void* pFileBuffer, size_t pSizeInBytes);

    typedef FbxCallback::State (*WriteCBFunction)(void* pUserData, FbxClassId pDataHint,
        const char* pFileName, const void** pFileBuffer, size_t* pSizeInBytes);

    int RegisterWriteFunction(WriteCBFunction pFunction, void* pUserData = nullptr);

    FbxCallback::State Trigger(const char* pFileName, const void** pFileBuffer, size_t* pSizeInBytes);

    /*****************************************************************************************************************************
    ** WARNING! Anything beyond these lines is for internal use, may not be documented and is subject to change without notice! **
    *****************************************************************************************************************************/
#ifndef DOXYGEN_SHOULD_SKIP_THIS
protected:
    void Construct(const FbxObject* pFrom) override;
private:
    int mReadFctId;
    int mWriteFctId;
public:
    FbxObject& Copy(const FbxObject& pObject) override;
#endif
};

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_FILEIO_CALLBACKS_H_ */