kfbxscene.h

Go to the documentation of this file.

#ifndef _FBXSDK_SCENE_H_
#define _FBXSDK_SCENE_H_

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

 Copyright © 2001 - 2007 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 <kaydaradef.h>
#ifndef KFBX_DLL 
    #define KFBX_DLL K_DLLIMPORT
#endif

#include <kaydara.h>

#include <kfbxplugins/kfbxdeformer.h>
#include <kfbxplugins/kfbxsubdeformer.h>
#include <kfbxplugins/kfbxlayer.h>
#include <kfbxplugins/kfbxnodeattribute.h>
#include <kfbxplugins/kfbxglobalsettings.h>

#include <klib/karrayul.h>
#include <klib/kerror.h>
#include <klib/kstring.h>

#include <fbxfilesdk_nsbegin.h>

class KFbxSdkManager;
class KFbxObject;
class KFbxNode;
class KFbxVideo;
class KFbxTexture;
class KFbxSurfaceMaterial;
class KFbxMarkerSet;
class KFbxActor;
class KFbxCharacter;
class KFbxControlSetPlug;
class KFbxCharacterPose;
class KFbxPose;
class KFbxSceneInfo;
class KFbxTakeInfo;
class KFbxGlobalLightSettings;
class KFbxGlobalCameraSettings;
class KFbxGlobalTimeSettings;
class KFbxGlobalSettings;
class KFbxGenericNode;
class KFbxConstraint;
class KFbxGeometry;
class KFbxTakeNodeContainer;
class KFbxLayerContainer;

class KFbxScene_internal;
class KFBX_DLL KFbxScene : public KFbxObject
{
    KFBXOBJECT_DECLARE(KFbxScene);

public:
    void Clear();


    KFbxNode* GetRootNode();

    KFbxNode* GetCameraSwitcher();

    void FillNodeArray(KArrayTemplate<KFbxNode*>& pNodeArray, 
                       KFbxNodeAttribute::EAttributeType pAttributeType,
                       bool pDepthFirst = false);



//  void FillVideoArray(KArrayTemplate<KFbxVideo*>& pVideoArray);

    void FillTextureArray(KArrayTemplate<KFbxTexture*>& pTextureArray);

    void FillMaterialArray(KArrayTemplate<KFbxSurfaceMaterial*>& pMaterialArray);
    


    int             GetGenericNodeCount();

    KFbxGenericNode* GetGenericNode(int pIndex);

    KFbxGenericNode* GetGenericNode(char* pName);

    bool             AddGenericNode(KFbxGenericNode* pGenericNode);

    bool             RemoveGenericNode(KFbxGenericNode* pGenericNode);
    



    int GetCharacterCount();

    KFbxCharacter* GetCharacter(int pIndex);

    int CreateCharacter(char* pName);

    void DestroyCharacter(int pIndex);



    int GetControlSetPlugCount();

    KFbxControlSetPlug* GetControlSetPlug(int pIndex);

    int CreateControlSetPlug(char* pName);

    void DestroyControlSetPlug(int pIndex);



    int GetCharacterPoseCount();

    KFbxCharacterPose* GetCharacterPose(int pIndex);

    int CreateCharacterPose(char* pName);

    void DestroyCharacterPose(int pIndex);



    int GetPoseCount();

    KFbxPose* GetPose(int pIndex);

    bool AddPose(KFbxPose* pPose);
    
    bool RemovePose(KFbxPose* pPose);

    bool RemovePose(int pIndex);




    KFbxSceneInfo* GetSceneInfo();

    void SetSceneInfo(KFbxSceneInfo* pSceneInfo);



    KFbxGlobalLightSettings& GetGlobalLightSettings();

    KFbxGlobalCameraSettings& GetGlobalCameraSettings();

    KFbxGlobalTimeSettings& GetGlobalTimeSettings();

    KFbxGlobalSettings& GetGlobalSettings();

    const KFbxGlobalSettings& GetGlobalSettings() const;



    bool CreateTake(char* pName);

    bool RemoveTake(char* pName);

    bool SetCurrentTake(char* pName);

    char* GetCurrentTakeName();

    void FillTakeNameArray(KArrayTemplate<KString*>& pNameArray);



    bool SetTakeInfo(const KFbxTakeInfo& pTakeInfo);

    KFbxTakeInfo* GetTakeInfo(const KString& pTakeName);



    KError& GetError();
    
    typedef enum 
    {
        eTAKE_ERROR,
        eKFBX_OBJECT_IS_NULL,
        eKFBX_OBJECT_ALREADY_OWNED,
        eKFBX_OBJECT_UNKNOWN,
        eERROR_COUNT
    } EError;
    
    EError GetLastErrorID();

    char* GetLastErrorString();


//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is 
//  subject to change without notice.
//

#ifndef DOXYGEN_SHOULD_SKIP_THIS

    void FillNodeArray(KArrayTemplate<KFbxNode*>& pNodeArray);
    
    void FillPoseArray(KArrayTemplate<KFbxPose*>& pPoseArray);
    
    void                ReplaceCameraSwitcher(KFbxNode* pNode);

    virtual KFbxObject::ENameSpace GetNameSpace() const;

    virtual KObject* GetFbxObject_internal();
    virtual KObject const*  GetFbxObject_internal() const;

    // Clone
    virtual KFbxObject* Clone(KFbxObject::ECloneType pCloneType) const;



    int                     GetMaterialCount            ();

    KFbxSurfaceMaterial*            GetMaterial                 (int pIndex);

    KFbxSurfaceMaterial*            GetMaterial                 (char* pName);

    bool                    AddMaterial                 (KFbxSurfaceMaterial* pMaterial);

    bool                    RemoveMaterial              (KFbxSurfaceMaterial* pMaterial);



    int                     GetTextureCount             ();

    KFbxTexture*            GetTexture                  (int pIndex);

    KFbxTexture*            GetTexture                  (char* pName);

    bool                    AddTexture                  (KFbxTexture* pTexture);

    bool                    RemoveTexture               (KFbxTexture* pTexture);



    int                     GetNodeCount                ();

    KFbxNode*               GetNode                     (int pIndex);

    bool                    AddNode                     (KFbxNode* pNode);

    bool                    RemoveNode                  (KFbxNode* pNode);

    int                     GetCurveOnSurfaceCount      (); 

    KFbxNode*               FindNodeByName              ( const KString& pName );
    


    int                     GetGeometryCount            ();

    KFbxGeometry*           GetGeometry                 (int pIndex);

    bool                    AddGeometry                 (KFbxGeometry* pGeometry);

    bool                    RemoveGeometry              (KFbxGeometry* pGeometry);



    int                     GetVideoCount               ();

    KFbxVideo*              GetVideo                    (int pIndex);

    bool                    AddVideo                    (KFbxVideo* pVideo);

    bool                    RemoveVideo                 (KFbxVideo* pVideo);


    int                     GetTakeNodeContainerCount   ();
    KFbxTakeNodeContainer*  GetTakeNodeContainer        (int pIndex);
    bool                    AddTakeNodeContainer        (KFbxTakeNodeContainer* pTakeNodeContainer);
    bool                    RemoveTakeNodeContainer     (KFbxTakeNodeContainer* pTakeNodeContainer);

private:
    static char const* GetNamePrefix() { return 0; }

    KFbxScene(KFbxSdkManager& pManager, char const* pName);
    ~KFbxScene();

    bool FbxPlugNotify(KFbxPlugEvent const &pEvent);


    virtual void Destruct(bool pRecursive, bool pDependents);

    KFbxScene& operator=(KFbxScene const& pScene); 

    bool FindTakeName(const KString& pTakeName);

    void FillNodeArrayRecursive(KArrayTemplate<KFbxNode*>& pNodeArray, 
                                KFbxNodeAttribute::EAttributeType pAttributeType,
                                KFbxNode* pNode);

    void ConnectMaterials();
    void ConnectTextures();
    void ConnectTextureLayerElement(KFbxLayerContainer* pLayerContainer, 
                                    KFbxLayerElement::ELayerElementType pLayerType);
    void ConnectVideos();

    void BuildMaterialLayersDirectArray();
    void BuildTextureLayersDirectArray();
    void BuildTextureLayersDirectArrayForLayerType(KFbxLayerContainer* pLayerContainer, 
                                                   KFbxLayerElement::ELayerElementType pLayerType);

    void FixInheritType(KFbxNode *pNode);

    void ConvertNurbsSurfaceToNurb();
    void ConvertMeshNormals();
    void ConvertNurbCurvesToNulls();

    KFbxScene_internal*                 mPH;

    KFbxSdkManager*                     mSdkManager;
    KFbxNode*                           mCameraSwitcher;
    KFbxNode*                           mRootNode;

    KFbxGlobalLightSettings*            mGlobalLightSettings;
    KFbxGlobalCameraSettings*           mGlobalCameraSettings;
    KFbxGlobalTimeSettings*             mGlobalTimeSettings;

    KString                             mCurrentTakeName;   
    KArrayTemplate<KFbxTakeInfo *>      mTakeInfoArray;
    KFbxSceneInfo*                      mSceneInfo;

    KError                              mError;

    friend class KFbxLayerContainer;
    friend class KFbxNodeFinderDuplicateName;

    friend class KFbxWriterFbx;
    friend class KFbxWriterFbx6;
    friend class KFbxReaderFbx;
    friend class KFbxReaderFbx6;

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS 

};

typedef  class KFBX_DLL KArrayTemplate<KFbxTakeInfo *>          KArrayKFbxTakeInfo;
typedef KFbxScene* HKFbxScene;

#include <fbxfilesdk_nsend.h>

#endif // #ifndef _FBXSDK_SCENE_H_