kfbxscene.h

Go to the documentation of this file.

#ifndef FBXFILESDK_KFBXPLUGINS_KFBXSCENE_H
#define FBXFILESDK_KFBXPLUGINS_KFBXSCENE_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/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;

    K_DEPRECATED void FillNodeArray(KArrayTemplate<KFbxNode*>& pNodeArray, kFbxClassId classId, bool pDepthFirst=false);



    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;


        K_DEPRECATED KFbxGlobalLightSettings& GetGlobalLightSettings();

        K_DEPRECATED KFbxGlobalCameraSettings& GetGlobalCameraSettings();

        K_DEPRECATED KFbxGlobalTimeSettings& GetGlobalTimeSettings();



        void SetEvaluator(KFbxAnimEvaluator* pEvaluator);

        KFbxAnimEvaluator* GetEvaluator();


//
//  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

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

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

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



    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);


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

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);
    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