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>   // FBBox
#include <fbsdk/fbvideo.h>  // FBPropertyVideo
#include <fbsdk/fbmodel.h>  // FBPropertyCamera


#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif

__FB_FORWARD( FBStory );
__FB_FORWARD( FBStoryFolder );
__FB_FORWARD( FBStoryTrack );
__FB_FORWARD( FBStoryClip );
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, 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,

    kFBStoryTrackBodyPartUpperBody      = kFBStoryTrackBodyPartHead | 
                                          kFBStoryTrackBodyPartLeftArm | kFBStoryTrackBodyPartLeftShoulder | kFBStoryTrackBodyPartLeftHand |
                                          kFBStoryTrackBodyPartRightArm | kFBStoryTrackBodyPartRightShoulder | kFBStoryTrackBodyPartRightHand,

    kFBStoryTrackBodyPartLeftFoot       = 1 << 7,
    kFBStoryTrackBodyPartLeftLeg        = 1 << 8 | kFBStoryTrackBodyPartLeftFoot,
    kFBStoryTrackBodyPartRightFoot      = 1 << 9,
    kFBStoryTrackBodyPartRightLeg       = 1 << 10| kFBStoryTrackBodyPartRightFoot,

    kFBStoryTrackBodyPartLowerBody      = kFBStoryTrackBodyPartLeftLeg | kFBStoryTrackBodyPartLeftFoot | kFBStoryTrackBodyPartRightLeg | kFBStoryTrackBodyPartRightFoot,

    kFBStoryTrackBodyPartAll            = kFBStoryTrackBodyPartUpperBody | kFBStoryTrackBodyPartLowerBody,

    kFBStoryTrackBodyPartProps          = 1 << 11,
    kFBStoryTrackBodyPartExtensions     = 1 << 12
};

enum FBStoryClipShowGhostMode {
    kFBStoryClipAlways,     
    kFBStoryClipTimeCursor  
};

enum FBStoryClipSolveMode {
    kFBStoryClipRetargetSkeleton,   
    kFBStoryClipAnimSkeleton,       
    kFBStoryClipAnimFkIk,           
    kFBStoryClipAnimSkeletonIk      
};

enum FBStoryClipCompMode {
    kFBStoryClipOff,    
    kFBStoryClipAuto,   
    kFBStoryClipUser    
};

FB_DEFINE_ENUM(FBSDK_DLL, StoryTrackType);
FB_DEFINE_ENUM(FBSDK_DLL, StoryTrackRefMode);
FB_DEFINE_ENUM(FBSDK_DLL, StoryClipShowGhostMode);
FB_DEFINE_ENUM(FBSDK_DLL, StoryClipSolveMode);
FB_DEFINE_ENUM(FBSDK_DLL, StoryClipCompMode);

FB_FORWARD( FBPropertyListStoryFolder );
class FBSDK_DLL FBPropertyListStoryFolder : public FBPropertyListComponentBase
{
public:
    virtual int Add(HFBStoryFolder pItem);

    virtual int Remove(HFBStoryFolder pItem);

    virtual void RemoveAt(int pIndex);

    virtual HFBStoryFolder 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(HFBStoryTrack pItem);

    virtual int Remove(HFBStoryTrack pItem);

    virtual void RemoveAt(int pIndex);

    virtual HFBStoryTrack 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(HFBStoryTrack pItem);

    virtual int Remove(HFBStoryTrack pItem);

    virtual void RemoveAt(int pIndex);

    virtual HFBStoryTrack 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(HFBStoryClip pItem);

    virtual int Remove(HFBStoryClip pItem);

    virtual void RemoveAt(int pIndex);

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

    FBStory();

public:

    FBPropertyBool          Mute;                       
    FBPropertyBool          LockedShot;                 
    FBPropertyBool          SummaryClip;                
    FBPropertyBool          RecordToDisk;               
    FBPropertyBool          NoneBlockingPostprocess;    
    FBPropertyStoryFolder   RootFolder;                 
    FBPropertyStoryFolder   RootEditFolder;             

    static FBStory& TheOne();

};

// FBStoryFolder

class FBSDK_DLL FBStoryFolder : public FBComponent
{
    //--- Open Reality declaration.
    __FBClassDeclare(FBStoryFolder, FBComponent);
public:

    FBStoryFolder(HFBStoryFolder pParentFolder=NULL, HIObject pObject=NULL);

    virtual void FBDelete();

    void Load(bool pLoad);

    FBPropertyString            Label;              
    FBPropertyBool              Solo;               
    FBPropertyBool              Mute;               
    FBPropertyString            RecordClipPath;     
    FBPropertyStoryFolder       Parent;             
    FBPropertyListStoryFolder   Childs;             
    FBPropertyListStoryTrack    Tracks;             
};

// FBStoryTrack

class FBSDK_DLL FBStoryTrack : public FBConstraint
{
    //--- Open Reality declaration.
    __FBClassDeclare(FBStoryTrack, FBConstraint);
public:

    FBStoryTrack(FBStoryTrackType pTrackType, HFBStoryFolder pFolder=NULL, HIObject pObject=NULL);

    FBStoryTrack(FBComponent* pSource, HFBStoryFolder pFolder=NULL, HIObject pObject=NULL);

    virtual void FBDelete();

    void ChangeDetailsBegin();

    void ChangeDetailsEnd();

    //--- Animation track functions -----------------------------------------------------------------------------------------------------
    FBStoryClip* CopyTakeIntoTrack(FBTimeSpan& pTimeSpan, FBTake* pTake, FBTime pOutputOffset = 0, bool pMakeUndoable = false);

    //--- Character track functions -----------------------------------------------------------------------------------------------------
    void EnableBodyPart(FBStoryTrackBodyPart pPart, bool pEnable);

    bool IsBodyPartEnabled(FBStoryTrackBodyPart pPart);

    void AddClip(FBComponent* pClip, FBTime pTime);

    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;     
    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, HFBStoryTrack pTrack, FBTime pTime, HIObject pObject=NULL);

    FBStoryClip(const char* pFilePath, HFBStoryTrack pTrack, FBTime pTime, HIObject pObject=NULL);

    virtual void FBDelete();

    HFBStoryClip Clone();

    FBTime Move(FBTime pDelta, bool pForce=true);

    FBTime MoveTo(FBTime pTime, bool pForce=true);

    HFBStoryClip Razor(FBTime pTime);

    //--- Animation clip functions ------------------------------------------------------------------------------------------------------
    void Match();

    bool ExportToFile(FBString pOutputFile);

    void GetAffectedObjects( FBArrayTemplate<FBComponent*>* pAffectedObjects );

    void GetAffectedAnimationNodes( FBArrayTemplate<FBAnimationNode*>* pAffectedAnimationNodes, FBComponent* pClipObject );


    //--- All clip properties -----------------------------------------------------------------------------------------------------------
    FBPropertyColor     Color;          
    FBPropertyTime      Start;          
    FBPropertyTime      Stop;           
    FBPropertyTime      MarkIn;         
    FBPropertyTime      MarkOut;        
    FBPropertyTimeSpan  PreBlend;       
    FBPropertyTimeSpan  PostBlend;      
    FBPropertyTime      Offset;         
    FBPropertyDouble    Speed;          

    //--- Shot clip properties ----------------------------------------------------------------------------------------------------------
    FBPropertyCamera    ShotCamera;             
    FBPropertyVideo     ShotBackplate;          
    FBPropertyVideo     ShotFrontplate;         
    FBPropertyBool      ShowBackplate;          
    FBPropertyBool      ShowFrontplate;         
    FBPropertyTime      ShotActionStart;        
    FBPropertyTime      ShotActionStop;         

    //--- Audio clip properties ---------------------------------------------------------------------------------------------------------
    FBPropertyAudioClip AudioClip;              

    //--- Animation clip properties -----------------------------------------------------------------------------------------------------
    FBPropertyDouble                    Scale;              
    FBPropertyVector3d                  Translation;        
    FBPropertyVector3d                  Rotation;           
    FBPropertyVector3d                  LoopTranslation;    
    FBPropertyBool                      AutoLoop;           
    FBPropertyBool                      Loop;               
    FBPropertyBool                      Ghost;              
    FBPropertyBool                      GhostModel;         
    FBPropertyBool                      GhostTravelling;    
    FBPropertyBool                      GhostPivot;         
    FBPropertyStoryClipShowGhostMode    ShowGhostClipMode;  
    FBPropertyAnimationNode             PreBlendData;       
    FBPropertyAnimationNode             PostBlendData;      
    FBPropertyListPivot                 Pivots;             
    FBPropertyBool                      Loaded;             

    //--- Character clip properties -----------------------------------------------------------------------------------------------------
    FBPropertyStoryClipSolveMode        SolvingMode;        
private:
    void FBStoryClipInitProperties();
};

#ifdef FBSDKUseNamespace
    }
#endif
#endif /* this must be the last line of this file */