fbstory.h

Go to the documentation of this file.

#ifndef __FBSTORY_H__
#define __FBSTORY_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/fbvideo.h>
#include <fbsdk/fbmodel.h>
#include <fbsdk/fbcamera.h>
 
#ifndef FBXSDK_NAMESPACE
    #define FBXSDK_NAMESPACE fbxsdk
#endif
 
namespace FBXSDK_NAMESPACE {
    class FbxScene;
}
 
#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif
 
__FB_FORWARD( FBStory );
__FB_FORWARD( FBStoryFolder );
__FB_FORWARD( FBStoryTrack );
__FB_FORWARD( FBStoryClip );
__FB_FORWARD( FBStoryGroupClip );
FB_DEFINE_COMPONENT( FBSDK_DLL, Story );
FB_DEFINE_COMPONENT( FBSDK_DLL, StoryFolder );
FB_DEFINE_COMPONENT( FBSDK_DLL, StoryTrack );
FB_DEFINE_COMPONENT( FBSDK_DLL, StoryClip );
FB_DEFINE_COMPONENT( FBSDK_DLL, StoryGroupClip );
FB_DEFINE_COMPONENT( FBSDK_DLL, AnimationNode );
FB_DEFINE_COMPONENT( FBSDK_DLL, Video );
FB_DEFINE_COMPONENT( FBSDK_DLL, AudioClip );
 
enum FBStoryTrackType {
    kFBStoryTrackAnimation,     
    kFBStoryTrackCamera,        
    kFBStoryTrackCharacter,     
    kFBStoryTrackConstraint,    
    kFBStoryTrackCommand,       
    kFBStoryTrackShot,          
    kFBStoryTrackAudio,         
    kFBStoryTrackVideo          
};
 
enum FBStoryTrackRefMode {
    kFBStoryTrackOverride,  
    kFBStoryTrackAdditive   
};
 
enum FBStoryTrackBodyPart {
    kFBStoryTrackBodyPartNone = 0,
 
    kFBStoryTrackBodyPartHead           = 1 << 0,
 
    kFBStoryTrackBodyPartLeftShoulder   = 1 << 1,
    kFBStoryTrackBodyPartLeftHand       = 1 << 2,
    kFBStoryTrackBodyPartLeftArm        = 1 << 3 | kFBStoryTrackBodyPartLeftShoulder | kFBStoryTrackBodyPartLeftHand,
    kFBStoryTrackBodyPartRightShoulder  = 1 << 4,
    kFBStoryTrackBodyPartRightHand      = 1 << 5,
    kFBStoryTrackBodyPartRightArm       = 1 << 6 | kFBStoryTrackBodyPartRightShoulder | kFBStoryTrackBodyPartRightHand,
 
    kFBStoryTrackBodyPartLeftFoot       = 1 << 7,
    kFBStoryTrackBodyPartLeftLeg        = 1 << 8 | kFBStoryTrackBodyPartLeftFoot,
    kFBStoryTrackBodyPartRightFoot      = 1 << 9,
    kFBStoryTrackBodyPartRightLeg       = 1 << 10| kFBStoryTrackBodyPartRightFoot,
 
    kFBStoryTrackBodyPartProps          = 1 << 11,
    kFBStoryTrackBodyPartExtensions     = 1 << 12,
 
    kFBStoryTrackBodyPartSpine          = 1 << 13,
 
    kFBStoryTrackBodyPartUpperBody      = kFBStoryTrackBodyPartHead | kFBStoryTrackBodyPartSpine |
                                          kFBStoryTrackBodyPartLeftArm | kFBStoryTrackBodyPartLeftShoulder | kFBStoryTrackBodyPartLeftHand |
                                          kFBStoryTrackBodyPartRightArm | kFBStoryTrackBodyPartRightShoulder | kFBStoryTrackBodyPartRightHand,
 
    kFBStoryTrackBodyPartLowerBody      = kFBStoryTrackBodyPartLeftLeg | kFBStoryTrackBodyPartLeftFoot | kFBStoryTrackBodyPartRightLeg | kFBStoryTrackBodyPartRightFoot,
 
    kFBStoryTrackBodyPartAll            = kFBStoryTrackBodyPartUpperBody | kFBStoryTrackBodyPartLowerBody,
};
 
enum FBStoryTrackGhostShowMode {
    kFBStoryTrackShowAllClips,                  
    kFBStoryTrackShowCurrentTimeAdjacentClips   
};
 
enum FBStoryClipShowGhostMode {
    kFBStoryClipAlways,     
    kFBStoryClipTimeCursor, 
    kFBStoryClipTimeCustom  
};
 
enum FBStoryClipGhostTimeMode {
    kFBStoryClipGhostCurrent,   
    kFBStoryClipGhostStart,     
    kFBStoryClipGhostStop,      
    kFBStoryClipGhostCustom     
};
 
enum FBStoryClipNodeFunction {
    kFBStoryClipNodeAverage,                
    kFBStoryClipNodeFloorProjection,        
    kFBStoryClipNodeNone                    
};
 
enum FBStoryClipSolveMode {
    kFBStoryClipRetargetSkeleton,   
    kFBStoryClipAnimSkeleton,       
    kFBStoryClipAnimFkIk,           
    kFBStoryClipAnimSkeletonIk      
};
 
enum FBStoryClipMirrorPlane {
    kFBStoryClipMirrorPlaneXY,  
    kFBStoryClipMirrorPlaneZY,  
    kFBStoryClipMirrorPlaneXZ   
};
 
enum FBStoryClipCompMode {
    kFBStoryClipOff,    
    kFBStoryClipAuto,   
    kFBStoryClipUser    
};
 
enum FBStoryClipMatchingTimeType
{
    kFBStoryClipMatchingTimeCurrentTime,                        
    kFBStoryClipMatchingTimeStartOfSelectedClip,                
    kFBStoryClipMatchingTimeBetweenPreviousAndSelectedClip,     
    kFBStoryClipMatchingTimeEndOfPreviousClip,                  
    kFBStoryClipMatchingTimeStartOfNextClip,                    
    kFBStoryClipMatchingTimeBetweenSelectedAndNextClip,         
    kFBStoryClipMatchingTimeEndOfSelectedClip,                  
    kFBStoryClipMatchingTimeDefault,                            
};
 
enum FBStoryClipMatchingTranslationType
{
    kFBStoryClipMatchingTranslationNone,            
    kFBStoryClipMatchingTranslationXYZ,             
    kFBStoryClipMatchingTranslationGravityXZ,       
    kFBStoryClipMatchingTranslationDefault,         
};
 
enum FBStoryClipMatchingRotationType
{
    kFBStoryClipMatchingRotationNone,               
    kFBStoryClipMatchingRotationXYZ,                
    kFBStoryClipMatchingRotationGravityXZ,          
    kFBStoryClipMatchingRotationDefault,            
};
 
 
enum FBStoryClipAlignmentType {
    kFBStoryClipAlignmentCurrentTimeline,           
    kFBStoryClipAlignmentEndPrevious,               
    kFBStoryClipAlignmentEndPreviousAllAligned,     
    kFBStoryClipAlignmentBeginningNext,             
    kFBStoryClipAlignmentBeginningNextAllAligned,   
    kFBStoryClipAlignmentCurrentTimelineWithOffset, 
    kFBStoryClipAlignmentEndPreviousWithOffset,     
    kFBStoryClipAlignmentBeginningNextWithOffset    
};
 
enum FBStoryGroupClipAlignmentType {
    kFBStoryGroupClipAlignmentCurrentTimeline,          
    kFBStoryGroupClipAlignmentEndPreviousWithOffset,        
    kFBStoryGroupClipAlignmentBeginningNextWithOffset,  
};
 
enum FBStoryClipChangeType {
    kFBStoryClipNotSet,     
    kFBStoryClipMoveClip,   
    kFBStoryClipMoveData,   
    kFBStoryClipMoveBlend,  
    kFBStoryClipUpdateUI,   
    kFBStoryClipRemoved     
};
 
enum FBStoryClipTimeWarpInterpolatorType {
    kFBStoryClipTimeWarpInterpolatorCustom,                 
    kFBStoryClipTimeWarpInterpolatorLinear,                 
    kFBStoryClipTimeWarpInterpolatorSmoothedEnds,           
    kFBStoryClipTimeWarpInterpolatorGoingFaster,            
    kFBStoryClipTimeWarpInterpolatorSlowingDown,            
    kFBStoryClipTimeWarpInterpolatorLinearReversed,         
    kFBStoryClipTimeWarpInterpolatorSmoothedEndsReversed,   
    kFBStoryClipTimeWarpInterpolatorGoingFasterReversed,    
    kFBStoryClipTimeWarpInterpolatorSlowingDownReversed     
};
 
FB_DEFINE_ENUM(FBSDK_DLL, StoryClipChangeType );
FB_DEFINE_ENUM(FBSDK_DLL, StoryTrackType);
FB_DEFINE_ENUM(FBSDK_DLL, StoryTrackRefMode);
FB_DEFINE_ENUM(FBSDK_DLL, StoryTrackGhostShowMode);
FB_DEFINE_ENUM(FBSDK_DLL, StoryClipShowGhostMode);
FB_DEFINE_ENUM(FBSDK_DLL, StoryClipGhostTimeMode);
FB_DEFINE_ENUM(FBSDK_DLL, StoryClipNodeFunction);
FB_DEFINE_ENUM(FBSDK_DLL, StoryClipSolveMode);
FB_DEFINE_ENUM(FBSDK_DLL, StoryClipMirrorPlane);
FB_DEFINE_ENUM(FBSDK_DLL, StoryClipCompMode);
FB_DEFINE_ENUM(FBSDK_DLL, StoryClipAlignmentType);
FB_DEFINE_ENUM(FBSDK_DLL, StoryClipTimeWarpInterpolatorType);
 
 
// FBClipEvent
 
__FB_FORWARD( FBEventClipChange );
 
class FBSDK_DLL FBEventClipChange: public FBEvent 
{
    public:
        FBEventClipChange( HKEventBase pEvent );        
 
        FBPropertyStoryClipChangeType   Type;            
};
 
FB_FORWARD( FBPropertyListStoryFolder );
class FBSDK_DLL FBPropertyListStoryFolder : public FBPropertyListComponentBase
{
public:
    virtual int Add(FBStoryFolder* pItem);
 
    virtual int Remove(FBStoryFolder* pItem);
 
    virtual void RemoveAt(int pIndex);
 
    virtual FBStoryFolder* operator[](int pIndex);
 
    virtual int GetCount();
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    inline virtual FBComponent* GetAt(int pIndex) { return (FBComponent*)operator[](pIndex); }
private:
    inline virtual int Add  ( FBComponent* pItem ) { return Add((FBStoryFolder*)pItem); }
#endif
};
 
FB_FORWARD( FBPropertyListStoryTrack );
class FBSDK_DLL FBPropertyListStoryTrack : public FBPropertyListComponentBase
{
public:
    virtual int Add(FBStoryTrack* pItem);
 
    virtual int Remove(FBStoryTrack* pItem);
 
    virtual void RemoveAt(int pIndex);
 
    virtual FBStoryTrack* operator[](int pIndex);
 
    virtual int GetCount();
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    inline virtual FBComponent* GetAt(int pIndex) { return (FBComponent*)operator[](pIndex); }
private:
    inline virtual int Add  ( FBComponent* pItem ) { return Add((FBStoryTrack*)pItem); }
#endif
};
 
FB_FORWARD( FBPropertyListStorySubTrack );
class FBSDK_DLL FBPropertyListStorySubTrack : public FBPropertyListComponentBase
{
public:
    virtual int Add(FBStoryTrack* pItem);
 
    virtual int Remove(FBStoryTrack* pItem);
 
    virtual void RemoveAt(int pIndex);
 
    virtual FBStoryTrack* operator[](int pIndex);
 
    virtual int GetCount();
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    inline virtual FBComponent* GetAt(int pIndex) { return (FBComponent*)operator[](pIndex); }
private:
    inline virtual int Add  ( FBComponent* pItem ) { return Add((FBStoryTrack*)pItem); }
#endif
};
 
FB_FORWARD( FBPropertyListStoryClip );
class FBSDK_DLL FBPropertyListStoryClip : public FBPropertyListComponentBase
{
public:
    virtual int Add(FBStoryClip* pItem);
 
    virtual int Remove(FBStoryClip* pItem);
 
    virtual void RemoveAt(int pIndex);
 
    virtual FBStoryClip* operator[](int pIndex);
 
    virtual int GetCount();
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    inline virtual FBComponent* GetAt(int pIndex) { return (FBComponent*)operator[](pIndex); }
private:
    inline virtual int Add  ( FBComponent* pItem ) { return Add((FBStoryClip*)pItem); }
#endif
};
 
FB_FORWARD( FBPropertyListStoryDetails );
class FBSDK_DLL FBPropertyListStoryDetails : public FBPropertyListComponentBase
{
public:
    virtual int Add(FBComponent* pItem);
 
    virtual int Remove(FBComponent* pItem);
 
    virtual void RemoveAt(int pIndex);
 
    virtual FBComponent* operator[](int pIndex);
 
    virtual int GetCount();
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    inline virtual FBComponent* GetAt(int pIndex) { return (FBComponent*)operator[](pIndex); }
#endif
};
 
FB_FORWARD( FBPropertyListPivot );
class FBSDK_DLL FBPropertyListPivot : public FBPropertyListComponentBase
{
public:
    virtual int Add(FBModel* pItem);
 
    virtual int Remove(FBModel* pItem);
 
    virtual void RemoveAt(int pIndex);
 
    virtual FBModel* operator[](int pIndex);
 
    virtual int GetCount();
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    inline virtual FBComponent* GetAt(int pIndex) { return (FBComponent*)operator[](pIndex); }
private:
    inline virtual int Add  ( FBComponent* pItem ) { return Add((FBModel*)pItem); }
#endif
};
 
// FBStory
 
class FBSDK_DLL FBStory : public FBComponent 
{
    //--- Open Reality declaration.
    __FBClassDeclare(FBStory, FBComponent);
 
public:
    FBStory();
    FBPropertyBool          Mute;                       
    FBPropertyBool          LockedShot;                 
    FBPropertyBool          MaintainShotAndClipShotLengthsSynced; 
    FBPropertyBool          SummaryClip;                
    FBPropertyBool          RecordToDisk;               
    FBPropertyBool          NoneBlockingPostprocess;    
    FBPropertyBool          ClipsTextsVisible;          
    FBPropertyBool          DisplayShotClipsExpanded;   
    FBPropertyStoryFolder   RootFolder;                 
    FBPropertyStoryFolder   RootEditFolder;             
 
    int CleanEmptyTracksAndFolders();
 
    bool PlotAllShotTracksToCameraSwitcher( FBTake* pTake );
 
    static FBStory& TheOne();
 
};
 
// FBStoryFolder
 
class FBSDK_DLL FBStoryFolder : public FBComponent
{
    //--- Open Reality declaration.
    __FBClassDeclare(FBStoryFolder, FBComponent);
public:
 
    FBStoryFolder(FBStoryFolder* pParentFolder=NULL, HIObject pObject=NULL);
 
    virtual void FBDelete() override;
 
    void Load(bool pLoad);
 
    FBPropertyString            Label;              
    FBPropertyBool              Collapsed;          
    FBPropertyBool              Solo;               
    FBPropertyBool              Mute;               
    FBPropertyString            RecordClipPath;     
    FBPropertyStoryFolder       Parent;     
    FBPropertyListStoryFolder   Childs;     
    FBPropertyListStoryTrack    Tracks;     
 
    void AlignSelectedClips(FBStoryClipAlignmentType pType, FBComponent* pReferenceClip);
 
    void AlignSelectedClipsGroup(FBStoryGroupClipAlignmentType pType);
 
    void ExpandSelectedClips(bool pPreserveOverlap);
 
    void ConvertClipsToReadOnly(bool pSelected, char* pFilePath);
 
    void ExpandSelectedClipsGroup(bool pPreserveOverlap);
};
 
// FBStoryTrack
 
class FBSDK_DLL FBStoryTrack : public FBConstraint
{
    //--- Open Reality declaration.
    __FBClassDeclare(FBStoryTrack, FBConstraint);
public:
 
    FBStoryTrack(FBStoryTrackType pTrackType, FBStoryFolder* pFolder=NULL, HIObject pObject=NULL);
 
    FBStoryTrack(FBComponent* pSource, FBStoryFolder* pFolder=NULL, HIObject pObject=NULL);
 
    virtual void FBDelete() override;
 
    void ChangeDetailsBegin();
 
    void ChangeDetailsEnd();
 
    //--- Animation track functions -----------------------------------------------------------------------------------------------------
    FBStoryClip* CopyTakeIntoTrack(FBTimeSpan& pTimeSpan, FBTake* pTake, FBTime pOutputOffset = 0, bool pMakeUndoable = false);
 
    FBStoryClip* CopyTakeIntoTrack(FBTimeSpan& pTimeSpan, FBTake* pTake, bool pConnectToCurrentTake, FBTime pOutputOffset = FBTime( 0 ), bool pMakeUndoable = false);
 
    //--- Character track functions -----------------------------------------------------------------------------------------------------
    void EnableBodyPart(FBStoryTrackBodyPart pPart, bool pEnable);
 
    bool IsBodyPartEnabled(FBStoryTrackBodyPart pPart);
 
    //--- Shot track functions -----------------------------------------------------------------------------------------------------
    bool PlotToCameraSwitcher( FBTake* pTake );
 
    void AddClip(FBComponent* pClip, FBTime pTime);
 
    FBStoryTrack* CreateSubTrack(FBStoryTrackType pTrackType, FBStoryTrackRefMode pRefMode);
 
    void Load(bool pLoad);
 
    //--- All track properties ----------------------------------------------------------------------------------------------------------
    FBPropertyStoryTrackType    Type;           
    FBPropertyString            Label;          
    FBPropertyBool              Mute;           
    FBPropertyBool              Solo;           
    FBPropertyString            RecordClipPath; 
    FBPropertyString            ClipNameConvention;
    FBPropertyBool              RecordTrack;    
    FBPropertyStoryFolder       ParentFolder;   
    FBPropertyStoryTrack        ParentTrack;    
    FBPropertyListStorySubTrack SubTracks;      
    FBPropertyListStoryClip     Clips;          
    FBPropertyListStoryDetails  Details;        
 
    //--- Animation and Constraint track properties -------------------------------------------------------------------------------------
    FBPropertyAnimatableDouble  Weight;         
 
    //--- Animation track properties ----------------------------------------------------------------------------------------------------
    FBPropertyBool              Ghost;          
    FBPropertyBool              GhostModel;     
    FBPropertyBool              GhostTravelling;
    FBPropertyBool              GhostPivot;     
    FBPropertyStoryTrackGhostShowMode   GhostShowTrackMode; 
    FBPropertyBool              AcceptKey;      
    FBPropertyStoryTrackRefMode ReferenceMode;  
    FBPropertyBool              OffsetEnable;   
    FBPropertyBool              PassThrough;    
 
    //--- Character track properties ----------------------------------------------------------------------------------------------------
    FBPropertyCharacter         Character;      
    FBPropertyInt               CharacterIndex; 
 
    //--- Shot track properties ---------------------------------------------------------------------------------------------------------
    FBPropertyBool              ShowBackplate;  
    FBPropertyBool              ShowFrontplate; 
 
    //--- Audio track properties --------------------------------------------------------------------------------------------------------
    FBPropertyInt               AudioOutIndex;  
 
    //--- Video track properties --------------------------------------------------------------------------------------------------------
    FBPropertyVideo             TrackVideo;     
private:
    void FBStoryTrackInitProperties();
};
 
// FBStoryClip
 
class FBSDK_DLL FBStoryClip : public FBComponent
{
    //--- Open Reality declaration.
    __FBClassDeclare(FBStoryClip, FBComponent);
public:
 
    FBStoryClip(FBComponent* pClipObject, FBStoryTrack* pTrack, FBTime pTime, HIObject pObject=NULL);
 
    FBStoryClip(const char* pFilePath, FBStoryTrack* pTrack, FBTime pTime, HIObject pObject=NULL);
 
    FBStoryClip(const char* pFilePath, FBStoryTrack* pTrack, FBTime pTime, FBTime pTimeOffset, HIObject pObject=NULL);
 
    virtual void FBDelete() override;
 
    FBStoryClip* Clone();
 
    FBTime Move(FBTime pDelta, bool pForce=true);
 
    FBTime MoveTo(FBTime pTime, bool pForce=true);
 
    FBStoryClip* Razor(FBTime pTime);
 
    //--- Animation clip functions ------------------------------------------------------------------------------------------------------
    void Match();
 
    void Match
    (
        FBString                            pObjectName,
        FBStoryClipMatchingTimeType         pTimeType,
        FBStoryClipMatchingTranslationType  pTranslationType,
        FBStoryClipMatchingRotationType     pRotationType
    );
 
    bool ExportToFile(FBString pOutputFile);
    
    bool GetReadOnly();
 
    bool SetReadOnly(bool pMakeClipReadOnly, FBString pOutputFile = FBString());
 
    bool MakeWritable();
 
    void GetAffectedObjects( FBArrayTemplate<FBComponent*>* pAffectedObjects );
 
    void GetAffectedAnimationNodes( FBArrayTemplate<FBAnimationNode*>* pAffectedAnimationNodes, FBComponent* pClipObject );
 
    bool DestinationSetObject( const char* pSrcName, FBComponent* pObject );
 
    void SetTime( FBTime *pSourceIn = NULL, FBTime *pSourceOut = NULL, FBTime *pDestinationIn = NULL, FBTime *pDestinationOut = NULL, bool pUseAlternateSrcInProp = false );
 
    bool CanAssignSourcesToDestinations();
 
    K_DEPRECATED_2023 void GetAssignSourcesToDestinationsInfo( FBStringList& pSrcList, FBStringList& pAvailableDstList, FBStringList& pDefaultDstList, FBStringList& pEffectiveDstList );
 
    void GetAssignSourcesToDestinationsInfo( FBStringList& pSrcList, FBArrayBool& pValidAnimatedSrc, FBStringList& pAvailableDstList, FBArrayBool& pValidAnimatedDst, FBStringList& pDefaultDstList, FBStringList& pEffectiveDstList );
 
    bool SetAssignSourcesToDestinationsInfo( FBStringList& pEffectiveDstList );
 
    FBXSDK_NAMESPACE::FbxScene* GetFbxScene();
 
    bool UpdateFromCurrentTake();
    
    FBTime GetSourceTimeFromDestinationTime( FBTime pDestinationTime, int* pLoopNumber = nullptr );
 
    //--- All clip properties -----------------------------------------------------------------------------------------------------------
    FBPropertyColor     Color;          
    FBPropertyTime      Start;          
    FBPropertyTime      Stop;           
    FBPropertyTime      MarkIn;         
    FBPropertyTime      MarkOut;        
    FBPropertyTimeSpan  PreBlend;       
    FBPropertyTimeSpan  PostBlend;      
    FBPropertyTime      Offset;         
    FBPropertyDouble    Speed;          
    FBPropertyBool      StartStopLocked;
 
    //--- Shot clip properties ----------------------------------------------------------------------------------------------------------
    FBPropertyCamera    ShotCamera;         
    FBPropertyVideo     ShotBackplate;      
    FBPropertyVideo     ShotFrontplate;     
    FBPropertyBool      ShowBackplate;      
    FBPropertyBool      ShowFrontplate;     
    FBPropertyTime      ShotActionStart;    
    FBPropertyTime      ShotActionStop;     
    FBPropertyBool      ShotStartStopLocked;
 
    //--- Audio clip properties ---------------------------------------------------------------------------------------------------------
    FBPropertyAudioClip AudioClip;      
    FBPropertyString    ClipAudioPath;  
    FBPropertyDouble    ClipPitch;      
    FBPropertyBool      LockPitchToSpeed;   
 
    //--- Video clip properties ---------------------------------------------------------------------------------------------------------
    FBPropertyString        ClipVideoPath;        
    FBPropertyBool          ImageSequence;        
    FBPropertyBool          UseSystemFrameRate;   
    FBPropertyDouble        FrameRate;            
    K_DEPRECATED_2024 FBPropertyBool          ShowEmbeddedTimecode; 
 
    //--- Animation clip properties -----------------------------------------------------------------------------------------------------
    FBPropertyString                    ClipAnimationPath;  
    FBPropertyDouble                    Scale;              
    FBPropertyVector3d                  Translation;        
    FBPropertyVector3d                  Rotation;           
    FBPropertyVector3d                  LoopTranslation;    
    FBPropertyBool                      AutoLoop;           
    FBPropertyBool                      Loop;               
    FBPropertyBool                      Ghost;              
    FBPropertyBool                      GhostModel;         
    FBPropertyBool                      GhostTravelling;    
    FBPropertyBool                      GhostPivot;         
    FBPropertyStoryClipShowGhostMode    ShowGhostClipMode;  
    FBPropertyTime                      GhostCustomTime;    
    FBPropertyAnimationNode             PreBlendData;       
    FBPropertyAnimationNode             PostBlendData;      
    FBPropertyListPivot                 Pivots;             
    FBPropertyBool                      Loaded;             
    FBPropertyVector3d                  GhostManipulatorOffset; 
    FBPropertyListObject                TravellingNode;     
    FBPropertyStoryClipNodeFunction     TravellingNodeFunction; 
    FBPropertyStoryClipGhostTimeMode    GhostManipulatorMode;   
    FBPropertyTime                      GhostManipulatorCustomTime; 
    FBPropertyBool                      ConnectedToTake;    
 
    //--- Character clip properties -----------------------------------------------------------------------------------------------------
    FBPropertyStoryClipSolveMode        SolvingMode;        
    FBPropertyBool                      MirrorAnimation;    
    FBPropertyStoryClipMirrorPlane      MirrorPlane;        
 
    FBPropertyEvent                     OnChange;           
 
    //--- Character and shot clip properties -----------------------------------------------------------------------------------------------------
    FBPropertyBool                              TimeWarpEnabled;            
    FBPropertyStoryClipTimeWarpInterpolatorType TimeWarpInterpolatorType;   
    FBPropertyBool                              TimeWarpReverse;            
    FBPropertyAnimationNode                     CustomTimeWarp;             
 
private:
    void FBStoryClipInitProperties();
};
 
// FBStoryGroupClip
 
class FBSDK_DLL FBStoryGroupClip : public FBComponent
{
    //--- Open Reality declaration.
    __FBClassDeclare(FBStoryGroupClip, FBComponent);
public:
 
    FBStoryGroupClip(FBArrayTemplate<FBStoryClip*>* pAffectedClipObject, HIObject pObject=NULL);
 
    virtual void FBDelete() override;
 
    FBTime Move(FBTime pDelta, bool pForce=true);
 
    FBTime MoveTo(FBTime pTime, bool pForce=true);
 
    void Razor(FBTime pTime);
 
    FBPropertyTime      Start;          
    FBPropertyTime      Stop;           
    FBPropertyBool      StartStopLocked;
    FBPropertyListObject DependentClips;
 
private:
    void FBStoryClipInitProperties();
};
 
#ifdef FBSDKUseNamespace
    }
#endif
#endif /* this must be the last line of this file */