kfbxscene.h

Go to the documentation of this file.

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

   Copyright (C) 2010 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 FBXFILESDK_KFBXPLUGINS_KFBXSCENE_H
#define FBXFILESDK_KFBXPLUGINS_KFBXSCENE_H


#include <fbxfilesdk/fbxfilesdk_def.h>

#include <fbxfilesdk/fbxcore/fbxcollection/kfbxdocument.h>

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

#include <fbxfilesdk/components/kbaselib/klib/karrayul.h>
#include <fbxfilesdk/components/kbaselib/klib/kerror.h>
#include <fbxfilesdk/components/kbaselib/klib/kstring.h>
#include <fbxfilesdk/components/kbaselib/klib/kcharptrset.h>

#include <fbxfilesdk/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 KFbxDocumentInfo;
class KFbxTakeInfo;
class KFbxGlobalSettings;
class KFbxGenericNode;
class KFbxConstraint;
class KFbxGeometry;
class KFbxLayerContainer;
class KSet;

class KFbxGlobalLightSettings;
class KFbxGlobalCameraSettings;
class KFbxGlobalTimeSettings;


class KFBX_DLL KFbxScene : public KFbxDocument
{
    KFBXOBJECT_DECLARE(KFbxScene, KFbxDocument);

public:

    void Clear();


    KFbxNode* GetRootNode() const;


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

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



    int             GetGenericNodeCount() const;

    KFbxGenericNode* GetGenericNode(int pIndex);

    KFbxGenericNode* GetGenericNode(char* pName);

    bool             AddGenericNode(KFbxGenericNode* pGenericNode);

    bool             RemoveGenericNode(KFbxGenericNode* pGenericNode);




    int GetCharacterCount() const;

    KFbxCharacter* GetCharacter(int pIndex);

    int CreateCharacter(char* pName);

    void DestroyCharacter(int pIndex);



    int GetControlSetPlugCount() const;

    KFbxControlSetPlug* GetControlSetPlug(int pIndex);

    int CreateControlSetPlug(char* pName);

    void DestroyControlSetPlug(int pIndex);



    int GetCharacterPoseCount() const;

    KFbxCharacterPose* GetCharacterPose(int pIndex);

    int CreateCharacterPose(char* pName);

    void DestroyCharacterPose(int pIndex);



    int GetPoseCount() const;

    KFbxPose* GetPose(int pIndex);

    bool AddPose(KFbxPose* pPose);

    bool RemovePose(KFbxPose* pPose);

    bool RemovePose(int pIndex);




    inline KFbxDocumentInfo* GetSceneInfo() { return GetDocumentInfo(); }

    inline void SetSceneInfo(KFbxDocumentInfo* pSceneInfo) { SetDocumentInfo(pSceneInfo); }



    KFbxGlobalSettings& GetGlobalSettings();

    const KFbxGlobalSettings& GetGlobalSettings() const;


        void SetEvaluator(KFbxAnimEvaluator* pEvaluator);

        KFbxAnimEvaluator* GetEvaluator();


    K_DEPRECATED void FillNodeArray(KArrayTemplate<KFbxNode*>& pNodeArray);

    void FillPoseArray(KArrayTemplate<KFbxPose*>& pPoseArray);



    int                     GetMaterialCount            () const;

    KFbxSurfaceMaterial*            GetMaterial                 (int pIndex);

    KFbxSurfaceMaterial*            GetMaterial                 (char* pName);

    bool                    AddMaterial                 (KFbxSurfaceMaterial* pMaterial);

    bool                    RemoveMaterial              (KFbxSurfaceMaterial* pMaterial);



    int                     GetTextureCount             () const;

    KFbxTexture*            GetTexture                  (int pIndex);

    KFbxTexture*            GetTexture                  (char* pName);

    bool                    AddTexture                  (KFbxTexture* pTexture);

    bool                    RemoveTexture               (KFbxTexture* pTexture);



    int                     GetNodeCount                () const;

    KFbxNode*               GetNode                     (int pIndex);

    bool                    AddNode                     (KFbxNode* pNode);

    bool                    RemoveNode                  (KFbxNode* pNode);

    int                     GetCurveOnSurfaceCount      ();

    KFbxNode*               FindNodeByName              ( const KString& pName );



    int                     GetGeometryCount            () const;

    KFbxGeometry*           GetGeometry                 (int pIndex);

    bool                    AddGeometry                 (KFbxGeometry* pGeometry);

    bool                    RemoveGeometry              (KFbxGeometry* pGeometry);



    int                     GetVideoCount               () const;

    KFbxVideo*              GetVideo                    (int pIndex);

    bool                    AddVideo                    (KFbxVideo* pVideo);

    bool                    RemoveVideo                 (KFbxVideo* pVideo);


    void SyncShowPropertyForInstance();

//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is
//  subject to change without notice.
//
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    virtual KFbxObject& Copy(const KFbxObject& pObject);

    void ConnectMaterials();

    void BuildMaterialLayersDirectArray();
    void ReindexMaterialConnections(); // called to make sure that eINDEX is remapped to eINDEX_TO_DIRECT

    KSet* AddTakeTimeWarpSet(char *pTakeName);
    KSet* GetTakeTimeWarpSet(char *pTakeName);

    // This function will destroy the scene (and all the objects directly connected to it) without sending 
    // the Connect notifications nor trying to disconnect the objects first. This is a bypass of the intended
    // workflow and should be used with care.
    void ForceKill();

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

    virtual void Construct(const KFbxScene* pFrom);
    virtual void Destruct(bool pRecursive, bool pDependents);

    // Don't mark it as DEPRECATED to avoid useless warning. This method is only called by
    // FillNodeArray() and the method is already makred as deprecated. When FillNodeArray is going to 
    // be removed, FillNodeArrayRecursive will be too.
    void FillNodeArrayRecursive(KArrayTemplate<KFbxNode*>& pNodeArray, kFbxClassId classId, KFbxNode* pNode);

    void ConnectTextureLayerElement(KFbxLayerContainer* pLayerContainer,
                                    KFbxLayerElement::ELayerElementType pLayerType,
                                    KFbxNode* pParentNode);

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

public:
    void ConvertNurbsSurfaceToNurb();
    void ConvertMeshNormals();
    void ConvertNurbCurvesToNulls();
    void ConnectTextures();
    void BuildTextureLayersDirectArray();
    void FixInheritType(KFbxNode *pNode);

    void UpdateScaleCompensate(KFbxNode *pNode, KFbxIOSettings& pIOS);

    kFbxClassId ConvertAttributeTypeToClassID(KFbxNodeAttribute::EAttributeType pAttributeType);

    KFbxGlobalLightSettings&  GlobalLightSettings()  { return *mGlobalLightSettings; }
    KFbxGlobalCameraSettings& GlobalCameraSettings() { return *mGlobalCameraSettings; }
    KFbxGlobalTimeSettings&   GlobalTimeSettings()   { return *mGlobalTimeSettings; }

private:
    KFbxNode*                           mRootNode;

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

    KFbxAnimEvaluator*                  mEvaluator;

    KCharPtrSet                         mTakeTimeWarpSet;

    friend class KFbxLayerContainer;
    friend class KFbxNodeFinderDuplicateName;
#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
};

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

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXPLUGINS_KFBXSCENE_H