fbscene.h

Go to the documentation of this file.

#ifndef __FBSCENE_H__
#define __FBSCENE_H__
/**************************************************************************
Copyright (c) 1994 - 2009 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 FBSDK_DLL 

#define FBSDK_DLL K_DLLIMPORT
#endif

#include <fbsdk/fbcomponent.h>
#include <fbsdk/fbcore.h>
#include <fbsdk/fbdata.h>
#include <fbsdk/fbfolder.h>
#include <fbsdk/fbrenderer.h>
#include <fbsdk/fbshader.h>
#include <fbsdk/fbmodel.h>
#include <fbsdk/fbhud.h>
#include <fbsdk/fbcamera.h>
#include <fbsdk/fblight.h>
#include <fbsdk/fbvideo.h>
#include <fbsdk/fbmotion.h>
#include <fbsdk/fbgroup.h>
#include <fbsdk/fbfilereference.h>
#include <fbsdk/fbnamespace.h>
#include <fbsdk/fbobjectpose.h>

#if !defined(K_NO_CHARACTER)
#include <fbsdk/fbcharacter.h>
#include <fbsdk/fbcharacterface.h>
#include <fbsdk/fbcharacterpose.h>
#include <fbsdk/fbcharacterextension.h>
#endif

#if !defined(K_NO_DECK)
#include <fbsdk/fbdeck.h>
#endif

#if !defined(K_NO_AUDIO)
#include <fbsdk/fbaudio.h>
#endif

#if !defined(K_NO_MANIPULATOR)
#include <fbsdk/fbmanipulator.h>
#endif

#if !defined(K_NO_NOTE)
#include <fbsdk/fbnote.h>
#endif

#if !defined(K_NO_POSE)
#include <fbsdk/fbpose.h>
#endif

#if !defined(K_NO_STORY)
#include <fbsdk/fbcommand.h>
#endif

#if !defined(K_NO_PROJECTSETTINGS)
#include <fbsdk/fbprojectsettings.h>
#endif

#ifndef FBSDK_LEAN_AND_MEAN
#include <fbsdk/fbuserobject.h>
#endif

#include <fbsdk/fbconstraint.h>
#if !defined(K_NO_OPTICAL)
    #include <fbsdk/fboptical.h>
#endif


#ifdef FBSDKUseNamespace
namespace FBSDKNamespace {;
#endif

// FBSceneEvent
enum FBSceneChangeType
{
    kFBSceneChangeNone,                 
    kFBSceneChangeDestroy,              
    kFBSceneChangeAttach,               
    kFBSceneChangeDetach,               
    kFBSceneChangeAddChild,             
    kFBSceneChangeRemoveChild,          
    kFBSceneChangeSelect,               
    kFBSceneChangeUnselect,             
    kFBSceneChangeRename,               
    kFBSceneChangeRenamePrefix,         
    kFBSceneChangeRenameUnique,         
    kFBSceneChangeRenameUniquePrefix,   
    kFBSceneChangeRenamed,              
    kFBSceneChangeRenamedPrefix,        
    kFBSceneChangeRenamedUnique,        
    kFBSceneChangeRenamedUniquePrefix,  
    kFBSceneChangeSoftSelect,           
    kFBSceneChangeSoftUnselect,         
    kFBSceneChangeHardSelect,           
    kFBSceneChangeActivate,             
    kFBSceneChangeDeactivate,           
    kFBSceneChangeLoadBegin,            
    kFBSceneChangeLoadEnd,              
    kFBSceneChangeClearBegin,           
    kFBSceneChangeClearEnd,             
    kFBSceneChangeTransactionBegin,     
    kFBSceneChangeTransactionEnd,       
    kFBSceneChangeMergeTransactionBegin,
    kFBSceneChangeMergeTransactionEnd,  
    kFBSceneChangeReSelect,             
    kFBSceneChangeChangeName,           
    kFBSceneChangeChangedName,          
    kFBSceneChangePreParent,            
    kFBSceneChangePreUnparent,          
    kFBSceneChangeFocus,                
    kFBSceneChangeChangedParent,        
    kFBSceneChangeReorder,              
    kFBSceneChangeReordered,            
};

FB_DEFINE_ENUM( FBSDK_DLL, SceneChangeType );

__FB_FORWARD( FBEventSceneChange );

class FBSDK_DLL FBEventSceneChange: public FBEvent 
{
public:
    FBEventSceneChange( HKEventBase pEvent );       

    FBPropertySceneChangeType   Type;            
    FBPropertyComponent         Component;       
    FBPropertyComponent         ChildComponent;  
};

// FBEventTakeChange
enum FBTakeChangeType   
{
    kFBTakeChangeAdded,         
    kFBTakeChangeRemoved,       
    kFBTakeChangeOpened,        
    kFBTakeChangeClosed,        
    kFBTakeChangeRenamed,       
    kFBTakeChangeUpdated,       
    kFBTakeChangeMoved,         
    kFBTakeChangeNone           
};

FB_DEFINE_ENUM( FBSDK_DLL, TakeChangeType );

__FB_FORWARD( FBEventTakeChange );

class FBSDK_DLL FBEventTakeChange: public FBEvent 
{
public:

    FBEventTakeChange( HKEventBase pEvent );        

    FBPropertyTakeChangeType    Type;        
    FBPropertyTake              Take;        
};

// FBSceneList
FB_FORWARD      ( FBPropertyListScene );
__FB_FORWARD( FBScene );
FB_DEFINE_LIST  ( FBSDK_DLL, Scene );

class FBSDK_DLL FBPropertyListScene : public FBPropertyBaseList< FBScene* >
{
private:
public:
    virtual int Add( FBScene* pItem );
    virtual void RemoveAt( int pIndex );
    virtual FBScene* operator[](int pIndex);
    virtual int GetCount();
};

// FBScene

class FBSDK_DLL FBScene : public FBComponent {
    __FBClassDeclare( FBScene,FBComponent );

    // We want to disallow the use of the copy constructor and operator for FBScene.
    FBScene( const FBScene* );
    FBScene( const FBScene& );
    FBScene& operator=( const FBScene& );

public:

    FBScene(HIObject pObject);

    virtual void FBDelete();

    void Clear();

    bool Evaluate();

    bool CandidateEvaluationAndResolve();

    bool EvaluateDeformations();

    void GetScriptsPaths( FBStringList& pPathList );


    int NamespaceGetChildrenList(FBStringList& pNamespaceList, const char* pNamespace = NULL, bool pRecursive = true );

    FBFileReference* NamespaceGetOwnerFileReference(const char* pNamespace);

    FBNamespace* NamespaceGet(const char* pNamespace);

    bool NamespaceExist(const char* pNamespace);

    bool NamespaceEmpty(const char* pNamespace);

    void NamespaceGetContentList(FBComponentList& pContentList, const char* pNamespace, FBPlugModificationFlag pModificationFlags = kFBPlugAllContent, bool pRecursive = true, int pTypeInfo = FBPlug::TypeInfo, bool pExactTypeMatch = false);

    void NamespaceSelectContent(const char* pNamespace, bool pSelect, FBPlugModificationFlag pModificationFlags = kFBPlugAllContent, bool pRecursive = true, int pTypeInfo = FBPlug::TypeInfo, bool pExactTypeMatch = false);

    bool NamespaceRename(const char* pNameSpace, const char* pNewNamespace, bool pRecursive = true, int pTypeInfo = FBPlug::TypeInfo, bool pExactTypeMatch = false);

    bool NamespaceDelete(const char* pNamespace);

    bool NamespaceCleanup();

    bool NamespaceDeleteContent(const char* pNamespace, FBPlugModificationFlag pModificationFlags = kFBPlugAllContent, bool pRecursive = true, int pTypeInfo = FBPlug::TypeInfo, bool pExactTypeMatch = false);

    bool NamespaceImport(const char* pNamespace, const char* pFilePath, bool pAsFileReference = false );

    bool NamespaceImportToMultiple(const FBStringList& pDstNamespaceList, const char* pFilePath, bool pAsFileReference = false );

    bool NamespaceExport(const char* pNamespace, const char* pFilePath, bool pASCIIFormat = false);

    int CleanEmptyGroups();

    int CleanEmptySets();

    int CleanUnusedMaterials();

    int CleanUnusedTextures();

    int CleanUnusedShaders();

    int CleanUnusedVideoClips();

    int CleanUnusedAudioClips();

    int CleanInactiveConstraints();

    int CleanRelationConstraintsUnusedBoxes();

    int CleanEmptyRelationConstraints();

#if !defined(K_NO_NAMESPACE_UPGRADE)

    bool NamespaceUpgradeToFileReference(const char* pNamespace, const char* pFilePath, bool pASCIIFormat = false);

    bool NamespaceDowngradeFromFileReference(const char* pNamespace);
#endif


    FBPropertyListTake              Takes;          
    FBPropertyModel                 RootModel;      
    FBPropertyListCamera            Cameras;        
    FBPropertyListMaterial          Materials;      
    FBPropertyListTexture           Textures;       
    FBPropertyListShader            Shaders;        
    FBPropertyListDeformer          Deformers;      
    FBPropertyListDevice            Devices;        
    FBPropertyListConstraint        Constraints;    

    FBPropertyListLight             Lights;         
#if !defined(K_NO_AUDIO)
    FBPropertyListAudioClip         AudioClips;     
#endif
#if !defined(K_NO_VIDEO)
    FBPropertyListVideoClip         VideoClips;     
#endif

    FBPropertyListMotionClip        MotionClips;    

#if !defined(K_NO_FOLDER)
    FBPropertyListFolder            Folders;        
#endif

#if !defined(K_NO_NOTE)
    FBPropertyListNote              Notes;          
#endif

#if !defined(K_NO_POSE)
    FBPropertyListPose              Poses;          
    FBPropertyListObjectPose        ObjectPoses;    
#endif

#if !defined(K_NO_ACTOR)
    FBPropertyListActor             Actors;         
    FBPropertyListActorFace         ActorFaces;     
#endif

#if !defined(K_NO_CHARACTER)
    FBPropertyListMarkerSet         MarkerSets;     
    FBPropertyListCharacterMarkerSet CharacterMarkerSets;       
    FBPropertyListControlSet        ControlSets;    
    FBPropertyListCharacter         Characters;     
    FBPropertyListCharacterFace     CharacterFaces; 
    FBPropertyListCharacterPose     CharacterPoses; 
    FBPropertyListCharacterExtension CharacterExtensions;   
#endif

#ifndef FB_KERNEL 
    FBPropertyListUserObject        UserObjects;    
#endif

#if !defined(K_NO_PROJECTSETTINGS)
    FBPropertyProjectSettings       ProjectSettings;
#endif

    FBPropertyRenderer              Renderer;       
    FBPropertyListComponent         Components;     
    FBPropertyListGroup             Groups;         
    FBPropertyListSet               Sets;           
    FBPropertyListNamespace         Namespaces;     
    FBPropertyListFileReference     FileReferences; 

#ifndef K_NO_UI
    FBPropertyListHandle            Handles;        
#endif
#ifndef K_NO_HUD 
    FBPropertyListHUD               HUDs;           
#endif

    FBPropertyListConstraintSolver      ConstraintSolvers;      
    FBPropertyListPhysicalProperties    PhysicalProperties;     

    FBPropertyString                FilePath;       

    FBPropertyListKeyingGroup       KeyingGroups;   
    FBPropertyListModelSkeleton     ModelSkeletons; 
#ifndef K_NO_OPTICAL
    FBPropertyListModelOptical      ModelOpticals;  
#endif
    FBPropertyEvent                 OnChange;       
    FBPropertyEvent                 OnTakeChange;   
};

#ifndef __FB_COMPONENT_SCENE
#define __FB_COMPONENT_SCENE
FB_DEFINE_COMPONENT( FBSDK_DLL, Scene );
#endif


#ifdef FBSDKUseNamespace
}
#endif
#endif