fbfbxoptions.h

Go to the documentation of this file.

#ifndef __FBFBXOPTIONS_H__
#define __FBFBXOPTIONS_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>

#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif



enum FBElementAction { 
    kFBElementActionSave   ,       
    kFBElementActionAppend ,       
    kFBElementActionMerge  ,       
    kFBElementActionDiscard,       
};
FB_DEFINE_ENUM( FBSDK_DLL, ElementAction ); // FBPropertyElementAction

enum FBTakeSpanOnLoad { 
    kFBLeaveAsIs     , 
    kFBImportFromFile, 
    kFBFrameAnimation, 
};
FB_DEFINE_ENUM( FBSDK_DLL, TakeSpanOnLoad ); // FBPropertyTakeSpanOnLoad

enum FBCharacterLoadAnimationMethod { 
    kFBCharacterLoadConnect       , 
    kFBCharacterLoadCopy          , 
    kFBCharacterLoadRetarget      , 
    kFBCharacterLoadPlotIfSampled , 
    kFBCharacterLoadPlot            
};
FB_DEFINE_ENUM(FBSDK_DLL, CharacterLoadAnimationMethod);

enum FBFileFormatAndVersion
{
    kFBFBX2010,                             
    kFBFBX2011,                             
    kFBFBX2012,                             
    kFBFBX2013,                             
    kFBFBX2014_2015,                        
    kFBFBX2016,                             
    kFBDefaultFormatAndVersion = kFBFBX2016 
};
FB_DEFINE_ENUM(FBSDK_DLL, FileFormatAndVersion);


enum FBOptionsContext { 
    kFBOptionsContextSave ,         
    kFBOptionsContextSaveSelection ,
    kFBOptionsContextLoad ,         
    kFBOptionsContextMultiLoad ,    
    kFBOptionsContextMerge,         
};

__FB_FORWARD( FBFbxOptions );

class FBSDK_DLL FBFbxOptions : public FBComponent {
    __FBClassDeclare( FBFbxOptions, FBComponent );
public:
    FBFbxOptions( bool pLoad, const char * pFilePathToLoad = NULL, HIObject pObject = NULL);

    void SetAll( FBElementAction pElementAction, bool pAnimation );

    void SaveToString(FBString& pString, FBOptionsContext context );

    void SetFromString( const char* pString, FBOptionsContext context );

    FBPropertyBool  UpdateRecentFiles;     

    FBPropertyTakeSpanOnLoad    TakeSpan;               



    FBPropertyFileFormatAndVersion FileFormatAndVersion;
    FBPropertyBool              EmbedMedia;             
    FBPropertyBool              SaveSelectedModelsOnly; 
    FBPropertyBool              KeepTransformHierarchy; 
    FBPropertyBool              UseASCIIFormat;         
    FBPropertyInt               CacheSize;              
    FBPropertyBool              CompressArray;          
    FBPropertyInt               CompressMinSize;        
    FBPropertyInt               CompressLevel;          



    FBPropertyBool              BaseCameras;            
    FBPropertyBool              CameraSwitcherSettings; 
    FBPropertyBool              CurrentCameraSettings;  
    FBPropertyBool              GlobalLightingSettings; 
    FBPropertyBool              TransportSettings;      


    FBPropertyBool              FileReference;          
    FBPropertyBool              FileReferenceEdit;      
    FBPropertyString            NamespaceList;          


    FBPropertyBool              RemoveEmptyLayer;           
    FBPropertyBool              ConsiderMuteSolo;           


    FBPropertyElementAction     Actors;               
    FBPropertyElementAction     ActorFaces;           
    FBPropertyElementAction     Audio;                
    FBPropertyElementAction     Bones;                
    FBPropertyElementAction     Cameras;              
    FBPropertyElementAction     Characters;           
    FBPropertyElementAction     CharacterFaces;       
    FBPropertyElementAction     CharacterExtensions;  
    FBPropertyElementAction     Constraints;          
    FBPropertyElementAction     Devices;              
    FBPropertyElementAction     FileReferences;       
    FBPropertyElementAction     Groups;               
    FBPropertyElementAction     KeyingGroups;         
    FBPropertyElementAction     Lights;               
    FBPropertyElementAction     Materials;            
    FBPropertyElementAction     Models;               
    FBPropertyElementAction     Notes;                
    FBPropertyElementAction     OpticalData;          
    FBPropertyElementAction     PhysicalProperties;   
    FBPropertyElementAction     Poses;                
    FBPropertyElementAction     Scripts;              
    FBPropertyElementAction     Sets;                 
    FBPropertyElementAction     Shaders;              
    FBPropertyElementAction     Solvers;              
    FBPropertyElementAction     Story;                
    FBPropertyElementAction     Textures;             
    FBPropertyElementAction     Video;                



    FBPropertyBool   ActorFacesAnimation;        
    FBPropertyBool   BonesAnimation;             
    FBPropertyBool   CamerasAnimation;           
    FBPropertyBool   CharactersAnimation;        
    FBPropertyBool   CharacterFacesAnimation;    
    FBPropertyBool   ConstraintsAnimation;       
    FBPropertyBool   DevicesAnimation;           
    FBPropertyBool   LightsAnimation;            
    FBPropertyBool   MaterialsAnimation;         
    FBPropertyBool   ModelsAnimation;            
    FBPropertyBool   NotesAnimation;             
    FBPropertyBool   PhysicalPropertiesAnimation;   
    FBPropertyBool   ShadersAnimation;           
    FBPropertyBool   SolversAnimation;           
    FBPropertyBool   StoryAnimation;             
    FBPropertyBool   TexturesAnimation;          


    FBPropertyBool  SaveCharacter;                  
    FBPropertyBool  SaveControlSet;                 
    FBPropertyBool  SaveCharacterExtensions;        
    FBPropertyBool  ClearSelectionBeforeSave;                




    FBPropertyCharacterLoadAnimationMethod  TransferMethod;                 
    FBPropertyBool  ProcessAnimationOnExtension;    
    FBPropertyBool  ReplaceControlSet;              
    FBPropertyBool  ResetDOF;                       
    FBPropertyBool  ResetHierarchy;                 
    FBPropertyBool  RemoveConstraintReference;      
    FBPropertyBool  CopyCharacterExtensions;        
    FBPropertyBool  RetargetOnBaseLayer;            
    FBPropertyBool  IgnoreConflicts;                


    FBPropertyBool  ShowFileDialog;                  
    FBPropertyBool  ShowOptionsDialog;               
    FBPropertyBool  SetPropertyStaticIfPossible;     



    int GetTakeCount() const;                  
    
    bool GetTakeSelect(int pTakeIndex) const;

    void SetTakeSelect(int pTakeIndex, bool pSelect);

     const char* GetTakeName(int pTakeIndex) const;

    void SetTakeName(int pTakeIndex,  const char* pName);

    const char* GetTakeDescription(int pTakeIndex) const;

    void SetTakeDescription(int pTakeIndex,  const char* pDescription);

     const char* GetTakeDestinationName(int pTakeIndex) const;

    void SetTakeDestinationName(int pTakeIndex,  const char* pDestinationName);

    void SetNamespaceList(const FBStringList& pNamespaceList);

    FBStringList GetNamespaceList();

    
    void SetObjectsToSave( FBArrayTemplate<FBComponent *> *pObjectsToSave );

    void SetMultiLoadNamespaceList( const FBStringList& pMultiLoadNamespaceList );

    FBStringList GetMultiLoadNamespaceList();
};

#ifdef FBSDKUseNamespace
    }
#endif

#endif