Open Reality Reference Guide
fbstory.h
Go to the documentation of this file.
1 #ifndef __FBSTORY_H__
2 #define __FBSTORY_H__
3 /**************************************************************************
4  Copyright (c) 1994 - 2009 Autodesk, Inc. and/or its licensors.
5  All Rights Reserved.
6 
7  The coded instructions, statements, computer programs, and/or related
8  material (collectively the "Data") in these files contain unpublished
9  information proprietary to Autodesk, Inc. and/or its licensors, which is
10  protected by Canada and United States of America federal copyright law
11  and by international treaties.
12 
13  The Data may not be disclosed or distributed to third parties, in whole
14  or in part, without the prior written consent of Autodesk, Inc.
15  ("Autodesk").
16 
17  THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
18  ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
19  WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR
20  ARISING BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES
21  OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
22  PURPOSE OR USE. WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT
23  WARRANT THAT THE OPERATION OF THE DATA WILL BE UNINTERRUPTED OR ERROR
24  FREE.
25 
26  IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
27  OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR
28  EXPENSES OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE
29  DAMAGES OR OTHER SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS
30  OF PROFITS, REVENUE OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR
31  DAMAGES OF ANY KIND), HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF
32  LIABILITY, WHETHER DERIVED FROM CONTRACT, TORT (INCLUDING, BUT NOT
33  LIMITED TO, NEGLIGENCE), OR OTHERWISE, ARISING OUT OF OR RELATING TO THE
34  DATA OR ITS USE OR ANY OTHER PERFORMANCE, WHETHER OR NOT AUTODESK HAS
35  BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.
36 
37 **************************************************************************/
38 
43 #include <kaydaradef.h>
44 #ifndef FBSDK_DLL
48  #define FBSDK_DLL K_DLLIMPORT
49 #endif
50 
51 #include <fbsdk/fbcomponent.h>
52 #include <fbsdk/fbcore.h>
53 #include <fbsdk/fbvideo.h>
54 #include <fbsdk/fbmodel.h>
55 #include <fbsdk/fbcamera.h>
56 
57 #ifndef FBXSDK_NAMESPACE
58  #define FBXSDK_NAMESPACE fbxsdk
59 #endif
60 
61 namespace FBXSDK_NAMESPACE {
62  class FbxScene;
63 }
64 
65 #ifdef FBSDKUseNamespace
66  namespace FBSDKNamespace {
67 #endif
68 
75 FB_DEFINE_COMPONENT( FBSDK_DLL, StoryFolder );
76 FB_DEFINE_COMPONENT( FBSDK_DLL, StoryTrack );
77 FB_DEFINE_COMPONENT( FBSDK_DLL, StoryClip );
78 FB_DEFINE_COMPONENT( FBSDK_DLL, StoryGroupClip );
79 FB_DEFINE_COMPONENT( FBSDK_DLL, AnimationNode );
81 FB_DEFINE_COMPONENT( FBSDK_DLL, AudioClip );
82 
93 };
94 
99 };
100 
103  kFBStoryTrackBodyPartNone = 0,
104 
105  kFBStoryTrackBodyPartHead = 1 << 0,
106 
107  kFBStoryTrackBodyPartLeftShoulder = 1 << 1,
108  kFBStoryTrackBodyPartLeftHand = 1 << 2,
109  kFBStoryTrackBodyPartLeftArm = 1 << 3 | kFBStoryTrackBodyPartLeftShoulder | kFBStoryTrackBodyPartLeftHand,
110  kFBStoryTrackBodyPartRightShoulder = 1 << 4,
111  kFBStoryTrackBodyPartRightHand = 1 << 5,
112  kFBStoryTrackBodyPartRightArm = 1 << 6 | kFBStoryTrackBodyPartRightShoulder | kFBStoryTrackBodyPartRightHand,
113 
114  kFBStoryTrackBodyPartLeftFoot = 1 << 7,
115  kFBStoryTrackBodyPartLeftLeg = 1 << 8 | kFBStoryTrackBodyPartLeftFoot,
116  kFBStoryTrackBodyPartRightFoot = 1 << 9,
117  kFBStoryTrackBodyPartRightLeg = 1 << 10| kFBStoryTrackBodyPartRightFoot,
118 
119  kFBStoryTrackBodyPartProps = 1 << 11,
120  kFBStoryTrackBodyPartExtensions = 1 << 12,
121 
122  kFBStoryTrackBodyPartSpine = 1 << 13,
123 
124  kFBStoryTrackBodyPartUpperBody = kFBStoryTrackBodyPartHead | kFBStoryTrackBodyPartSpine |
125  kFBStoryTrackBodyPartLeftArm | kFBStoryTrackBodyPartLeftShoulder | kFBStoryTrackBodyPartLeftHand |
126  kFBStoryTrackBodyPartRightArm | kFBStoryTrackBodyPartRightShoulder | kFBStoryTrackBodyPartRightHand,
127 
128  kFBStoryTrackBodyPartLowerBody = kFBStoryTrackBodyPartLeftLeg | kFBStoryTrackBodyPartLeftFoot | kFBStoryTrackBodyPartRightLeg | kFBStoryTrackBodyPartRightFoot,
129 
130  kFBStoryTrackBodyPartAll = kFBStoryTrackBodyPartUpperBody | kFBStoryTrackBodyPartLowerBody,
131 };
132 
137 };
138 
144 };
145 
152 };
153 
159 };
160 
167 };
168 
174 };
175 
181 };
182 
185 {
194 };
195 
198 {
203 };
204 
207 {
212 };
213 
214 
225 };
226 
232 };
233 
243 };
244 
256 };
257 
258 FB_DEFINE_ENUM(FBSDK_DLL, StoryClipChangeType );
259 FB_DEFINE_ENUM(FBSDK_DLL, StoryTrackType);
260 FB_DEFINE_ENUM(FBSDK_DLL, StoryTrackRefMode);
261 FB_DEFINE_ENUM(FBSDK_DLL, StoryTrackGhostShowMode);
262 FB_DEFINE_ENUM(FBSDK_DLL, StoryClipShowGhostMode);
263 FB_DEFINE_ENUM(FBSDK_DLL, StoryClipGhostTimeMode);
264 FB_DEFINE_ENUM(FBSDK_DLL, StoryClipNodeFunction);
265 FB_DEFINE_ENUM(FBSDK_DLL, StoryClipSolveMode);
266 FB_DEFINE_ENUM(FBSDK_DLL, StoryClipMirrorPlane);
267 FB_DEFINE_ENUM(FBSDK_DLL, StoryClipCompMode);
268 FB_DEFINE_ENUM(FBSDK_DLL, StoryClipAlignmentType);
269 FB_DEFINE_ENUM(FBSDK_DLL, StoryClipTimeWarpInterpolatorType);
270 
271 
273 // FBClipEvent
275 
277 
279 {
280  public:
284  FBEventClipChange( HKEventBase pEvent );
285 
286  FBPropertyStoryClipChangeType Type;
287 };
288 
292 {
293 public:
299  virtual int Add(FBStoryFolder* pItem);
300 
306  virtual int Remove(FBStoryFolder* pItem);
307 
311  virtual void RemoveAt(int pIndex);
312 
317  virtual FBStoryFolder* operator[](int pIndex);
318 
322  virtual int GetCount();
323 
324 #ifndef DOXYGEN_SHOULD_SKIP_THIS
325  inline virtual FBComponent* GetAt(int pIndex) { return (FBComponent*)operator[](pIndex); }
326 private:
327  inline virtual int Add ( FBComponent* pItem ) { return Add((FBStoryFolder*)pItem); }
328 #endif
329 };
330 
334 {
335 public:
341  virtual int Add(FBStoryTrack* pItem);
342 
348  virtual int Remove(FBStoryTrack* pItem);
349 
353  virtual void RemoveAt(int pIndex);
354 
359  virtual FBStoryTrack* operator[](int pIndex);
360 
364  virtual int GetCount();
365 #ifndef DOXYGEN_SHOULD_SKIP_THIS
366  inline virtual FBComponent* GetAt(int pIndex) { return (FBComponent*)operator[](pIndex); }
367 private:
368  inline virtual int Add ( FBComponent* pItem ) { return Add((FBStoryTrack*)pItem); }
369 #endif
370 };
371 
375 {
376 public:
382  virtual int Add(FBStoryTrack* pItem);
383 
389  virtual int Remove(FBStoryTrack* pItem);
390 
394  virtual void RemoveAt(int pIndex);
395 
400  virtual FBStoryTrack* operator[](int pIndex);
401 
405  virtual int GetCount();
406 #ifndef DOXYGEN_SHOULD_SKIP_THIS
407  inline virtual FBComponent* GetAt(int pIndex) { return (FBComponent*)operator[](pIndex); }
408 private:
409  inline virtual int Add ( FBComponent* pItem ) { return Add((FBStoryTrack*)pItem); }
410 #endif
411 };
412 
416 {
417 public:
422  virtual int Add(FBStoryClip* pItem);
423 
428  virtual int Remove(FBStoryClip* pItem);
429 
433  virtual void RemoveAt(int pIndex);
434 
439  virtual FBStoryClip* operator[](int pIndex);
440 
444  virtual int GetCount();
445 #ifndef DOXYGEN_SHOULD_SKIP_THIS
446  inline virtual FBComponent* GetAt(int pIndex) { return (FBComponent*)operator[](pIndex); }
447 private:
448  inline virtual int Add ( FBComponent* pItem ) { return Add((FBStoryClip*)pItem); }
449 #endif
450 };
451 
455 {
456 public:
461  virtual int Add(FBComponent* pItem);
462 
467  virtual int Remove(FBComponent* pItem);
468 
472  virtual void RemoveAt(int pIndex);
473 
478  virtual FBComponent* operator[](int pIndex);
479 
483  virtual int GetCount();
484 #ifndef DOXYGEN_SHOULD_SKIP_THIS
485  inline virtual FBComponent* GetAt(int pIndex) { return (FBComponent*)operator[](pIndex); }
486 #endif
487 };
488 
492 {
493 public:
498  virtual int Add(FBModel* pItem);
499 
504  virtual int Remove(FBModel* pItem);
505 
509  virtual void RemoveAt(int pIndex);
510 
515  virtual FBModel* operator[](int pIndex);
516 
520  virtual int GetCount();
521 #ifndef DOXYGEN_SHOULD_SKIP_THIS
522  inline virtual FBComponent* GetAt(int pIndex) { return (FBComponent*)operator[](pIndex); }
523 private:
524  inline virtual int Add ( FBComponent* pItem ) { return Add((FBModel*)pItem); }
525 #endif
526 };
527 
529 // FBStory
531 
535 {
536  //--- Open Reality declaration.
538 
539 public:
550  FBPropertyStoryFolder RootFolder;
551  FBPropertyStoryFolder RootEditFolder;
552 
557 
561  static FBStory& TheOne();
562 
563 };
564 
566 // FBStoryFolder
568 
572 {
573  //--- Open Reality declaration.
575 public:
576 
582  FBStoryFolder(FBStoryFolder* pParentFolder=NULL, HIObject pObject=NULL);
583 
586  virtual void FBDelete() override;
587 
591  void Load(bool pLoad);
592 
598  FBPropertyStoryFolder Parent;
601 
607 
612 
616  void ExpandSelectedClips(bool pPreserveOverlap);
617 
623  void ConvertClipsToReadOnly(bool pSelected, char* pFilePath);
624 
629  void ExpandSelectedClipsGroup(bool pPreserveOverlap);
630 };
631 
633 // FBStoryTrack
635 
643 {
644  //--- Open Reality declaration.
646 public:
647 
653  FBStoryTrack(FBStoryTrackType pTrackType, FBStoryFolder* pFolder=NULL, HIObject pObject=NULL);
654 
660  FBStoryTrack(FBComponent* pSource, FBStoryFolder* pFolder=NULL, HIObject pObject=NULL);
661 
664  virtual void FBDelete() override;
665 
670 
675 
676  //--- Animation track functions -----------------------------------------------------------------------------------------------------
686  FBStoryClip* CopyTakeIntoTrack(FBTimeSpan& pTimeSpan, FBTake* pTake, FBTime pOutputOffset = 0, bool pMakeUndoable = false);
687 
697  FBStoryClip* CopyTakeIntoTrack(FBTimeSpan& pTimeSpan, FBTake* pTake, bool pConnectToCurrentTake, FBTime pOutputOffset = FBTime( 0 ), bool pMakeUndoable = false);
698 
699  //--- Character track functions -----------------------------------------------------------------------------------------------------
705  void EnableBodyPart(FBStoryTrackBodyPart pPart, bool pEnable);
706 
711 
715  void AddClip(FBComponent* pClip, FBTime pTime);
716 
723 
727  void Load(bool pLoad);
728 
729  //--- All track properties ----------------------------------------------------------------------------------------------------------
730  FBPropertyStoryTrackType Type;
737  FBPropertyStoryFolder ParentFolder;
738  FBPropertyStoryTrack ParentTrack;
742 
743  //--- Animation and Constraint track properties -------------------------------------------------------------------------------------
745 
746  //--- Animation track properties ----------------------------------------------------------------------------------------------------
751  FBPropertyStoryTrackGhostShowMode GhostShowTrackMode;
753  FBPropertyStoryTrackRefMode ReferenceMode;
756 
757  //--- Character track properties ----------------------------------------------------------------------------------------------------
758  FBPropertyCharacter Character;
760 
761  //--- Shot track properties ---------------------------------------------------------------------------------------------------------
764 
765  //--- Audio track properties --------------------------------------------------------------------------------------------------------
767 
768  //--- Video track properties --------------------------------------------------------------------------------------------------------
769  FBPropertyVideo TrackVideo;
770 private:
771  void FBStoryTrackInitProperties();
772 };
773 
775 // FBStoryClip
777 
790 {
791  //--- Open Reality declaration.
793 public:
794 
801  FBStoryClip(FBComponent* pClipObject, FBStoryTrack* pTrack, FBTime pTime, HIObject pObject=NULL);
802 
809  FBStoryClip(const char* pFilePath, FBStoryTrack* pTrack, FBTime pTime, HIObject pObject=NULL);
810 
818  FBStoryClip(const char* pFilePath, FBStoryTrack* pTrack, FBTime pTime, FBTime pTimeOffset, HIObject pObject=NULL);
819 
822  virtual void FBDelete() override;
823 
827 
834  FBTime Move(FBTime pDelta, bool pForce=true);
835 
842  FBTime MoveTo(FBTime pTime, bool pForce=true);
843 
850 
851  //--- Animation clip functions ------------------------------------------------------------------------------------------------------
855  void Match();
856 
864  void Match
865  (
866  FBString pObjectName,
867  FBStoryClipMatchingTimeType pTimeType,
868  FBStoryClipMatchingTranslationType pTranslationType,
869  FBStoryClipMatchingRotationType pRotationType
870  );
871 
877  bool ExportToFile(FBString pOutputFile);
878 
883  bool GetReadOnly();
884 
891  bool SetReadOnly(bool pMakeClipReadOnly, FBString pOutputFile = FBString());
892 
897  bool MakeWritable();
898 
907 
916  void GetAffectedAnimationNodes( FBArrayTemplate<FBAnimationNode*>* pAffectedAnimationNodes, FBComponent* pClipObject );
917 
924  bool DestinationSetObject( const char* pSrcName, FBComponent* pObject );
925 
947  void SetTime( FBTime *pSourceIn = NULL, FBTime *pSourceOut = NULL, FBTime *pDestinationIn = NULL, FBTime *pDestinationOut = NULL, bool pUseAlternateSrcInProp = false );
948 
954 
965  K_DEPRECATED_2023 void GetAssignSourcesToDestinationsInfo( FBStringList& pSrcList, FBStringList& pAvailableDstList, FBStringList& pDefaultDstList, FBStringList& pEffectiveDstList );
966 
979  void GetAssignSourcesToDestinationsInfo( FBStringList& pSrcList, FBArrayBool& pValidAnimatedSrc, FBStringList& pAvailableDstList, FBArrayBool& pValidAnimatedDst, FBStringList& pDefaultDstList, FBStringList& pEffectiveDstList );
980 
990 
994  FBXSDK_NAMESPACE::FbxScene* GetFbxScene();
995 
1000 
1009  FBTime GetSourceTimeFromDestinationTime( FBTime pDestinationTime, int* pLoopNumber = nullptr );
1010 
1011  //--- All clip properties -----------------------------------------------------------------------------------------------------------
1022 
1023  //--- Shot clip properties ----------------------------------------------------------------------------------------------------------
1024  FBPropertyCamera ShotCamera;
1025  FBPropertyVideo ShotBackplate;
1026  FBPropertyVideo ShotFrontplate;
1032 
1033  //--- Audio clip properties ---------------------------------------------------------------------------------------------------------
1034  FBPropertyAudioClip AudioClip;
1038 
1039  //--- Video clip properties ---------------------------------------------------------------------------------------------------------
1045 
1046  //--- Animation clip properties -----------------------------------------------------------------------------------------------------
1058  FBPropertyStoryClipShowGhostMode ShowGhostClipMode;
1060  FBPropertyAnimationNode PreBlendData;
1061  FBPropertyAnimationNode PostBlendData;
1066  FBPropertyStoryClipNodeFunction TravellingNodeFunction;
1067  FBPropertyStoryClipGhostTimeMode GhostManipulatorMode;
1070 
1071  //--- Character clip properties -----------------------------------------------------------------------------------------------------
1072  FBPropertyStoryClipSolveMode SolvingMode;
1074  FBPropertyStoryClipMirrorPlane MirrorPlane;
1075 
1077 
1078  //--- Character and shot clip properties -----------------------------------------------------------------------------------------------------
1080  FBPropertyStoryClipTimeWarpInterpolatorType TimeWarpInterpolatorType;
1082  FBPropertyAnimationNode CustomTimeWarp;
1083 
1084 private:
1085  void FBStoryClipInitProperties();
1086 };
1087 
1089 // FBStoryGroupClip
1091 
1095 {
1096  //--- Open Reality declaration.
1098 public:
1099 
1104  FBStoryGroupClip(FBArrayTemplate<FBStoryClip*>* pAffectedClipObject, HIObject pObject=NULL);
1105 
1108  virtual void FBDelete() override;
1109 
1116  FBTime Move(FBTime pDelta, bool pForce=true);
1117 
1124  FBTime MoveTo(FBTime pTime, bool pForce=true);
1125 
1130  void Razor(FBTime pTime);
1131 
1136 
1137 private:
1138  void FBStoryClipInitProperties();
1139 };
1140 
1141 #ifdef FBSDKUseNamespace
1142  }
1143 #endif
1144 #endif /* this must be the last line of this file */
Template class to contain an array of items.
Definition: fbarray.h:78
MotionBuilder SDK base class.
Definition: fbcomponent.h:651
Base class for constraints.
Definition: fbconstraint.h:134
FBEventClipChange(HKEventBase pEvent)
Constructor.
FBPropertyStoryClipChangeType Type
Read Only Property: Type of event.
Definition: fbstory.h:286
Base Event class.
Definition: fbcomponent.h:940
Model class.
Definition: fbmodel.h:274
PropertyEvent: Base event class.
Definition: fbproperties.h:515
PropertyList: Component.
Definition: fbcomponent.h:477
List of scene objects.
Definition: fbcomponent.h:556
List: Story Clip pivot models
Definition: fbstory.h:492
virtual void RemoveAt(int pIndex)
Remove the object at pIndex.
virtual int Remove(FBModel *pItem)
Remove object pItem from property list.
virtual int Add(FBModel *pItem)
Add a object to the property list.
virtual FBModel * operator[](int pIndex)
Get the object at pIndex.
virtual int GetCount()
Get the number of object.
List: StoryClip
Definition: fbstory.h:416
virtual FBStoryClip * operator[](int pIndex)
Get the clip at pIndex.
virtual void RemoveAt(int pIndex)
Remove the clip at pIndex.
virtual int Remove(FBStoryClip *pItem)
Remove clip pItem from property list.
virtual int Add(FBStoryClip *pItem)
Add a clip to the property list.
virtual int GetCount()
Get the number of clip.
List: Story track Details
Definition: fbstory.h:455
virtual void RemoveAt(int pIndex)
Remove the object at pIndex.
virtual int Add(FBComponent *pItem)
Add a object to the property list.
virtual int Remove(FBComponent *pItem)
Remove object pItem from property list.
virtual int GetCount()
Get the number of object.
virtual FBComponent * operator[](int pIndex)
Get the object at pIndex.
List: StoryFolder
Definition: fbstory.h:292
virtual FBStoryFolder * operator[](int pIndex)
Get the folder at pIndex.
virtual int Remove(FBStoryFolder *pItem)
Remove folder pItem from property list.
virtual void RemoveAt(int pIndex)
Remove the folder at pIndex.
virtual int Add(FBStoryFolder *pItem)
Add a folder to the property list.
virtual int GetCount()
Get the number of folder.
List: StorySubTrack
Definition: fbstory.h:375
virtual void RemoveAt(int pIndex)
Remove the sub-track at pIndex.
virtual int Add(FBStoryTrack *pItem)
Add a sub-track to the property list.
virtual int GetCount()
Get the number of sub-track.
virtual FBStoryTrack * operator[](int pIndex)
Get the sub-track at pIndex.
virtual int Remove(FBStoryTrack *pItem)
Remove sub-track pItem from property list.
List: StoryTrack
Definition: fbstory.h:334
virtual void RemoveAt(int pIndex)
Remove the track at pIndex.
virtual int Add(FBStoryTrack *pItem)
Add a track to the property list.
virtual int GetCount()
Get the number of track.
virtual FBStoryTrack * operator[](int pIndex)
Get the track at pIndex.
virtual int Remove(FBStoryTrack *pItem)
Remove track pItem from property list.
Property class: const char * (String).
Story Clip class.
Definition: fbstory.h:790
FBPropertyStoryClipShowGhostMode ShowGhostClipMode
Read Write Property: Show the ghost depending on the time. See FBStoryClipShowGhostMode
Definition: fbstory.h:1058
FBPropertyListObject TravellingNode
List: Travelling node(s). If set, this property will overwrite the Track's Travelling node(s).
Definition: fbstory.h:1065
FBPropertyBool GhostPivot
Read Write Property: Show ghost of match object
Definition: fbstory.h:1057
FBPropertyVector3d LoopTranslation
Read Write Property: Animation clip's loop translation.
Definition: fbstory.h:1051
fbxsdk ::FbxScene * GetFbxScene()
Get KFbxScene.
FBPropertyBool ShowFrontplate
Read Write Property: Enable/Disable the shot frontplate.
Definition: fbstory.h:1028
bool MakeWritable()
MakeWritable.
FBPropertyString ClipAnimationPath
Read Write Property: Animation clip's file path
Definition: fbstory.h:1047
void Match(FBString pObjectName, FBStoryClipMatchingTimeType pTimeType, FBStoryClipMatchingTranslationType pTranslationType, FBStoryClipMatchingRotationType pRotationType)
Match.
FBStoryClip(const char *pFilePath, FBStoryTrack *pTrack, FBTime pTime, HIObject pObject=NULL)
Constructor.
FBPropertyBool GhostModel
Read Write Property: Show ghost of models
Definition: fbstory.h:1055
FBPropertyTime MarkIn
Read Write Property: Start time inside the clip.
Definition: fbstory.h:1015
FBPropertyBool Loaded
Read Write Property: If true, clip file is loaded into memory and can be evaluated (will affect track...
Definition: fbstory.h:1063
FBPropertyTime Start
Read Write Property: Start time of the clip local to its track.
Definition: fbstory.h:1013
virtual void FBDelete() override
Virtual FBDelete function.
bool SetAssignSourcesToDestinationsInfo(FBStringList &pEffectiveDstList)
SetAssignSourcesToDestinationsInfo.
FBPropertyBool Loop
Read Write Property: If true, loop clip's animation
Definition: fbstory.h:1053
bool UpdateFromCurrentTake()
Update clip animation from current take animation for clip track's scope, works only for clip created...
FBPropertyAnimationNode PostBlendData
Read Only Property: To get the animation of the Post blend curve
Definition: fbstory.h:1061
FBStoryClip * Clone()
Clone the clip.
FBPropertyDouble ClipPitch
Read Write Property: The clip pitch value.
Definition: fbstory.h:1036
FBPropertyTime Stop
Read Write Property: Stop time of the clip local to its track.
Definition: fbstory.h:1014
FBPropertyBool MirrorAnimation
Read Write Property: If true, clip animation will be mirrored
Definition: fbstory.h:1073
FBPropertyStoryClipSolveMode SolvingMode
Read Write Property: Solve Modes for story character clips. See FBStoryClipSolveMode
Definition: fbstory.h:1072
FBPropertyTime GhostCustomTime
Read Write Property: Custom time to display ghost, only applicable if ShowGhostClipMode is kFBStoryCl...
Definition: fbstory.h:1059
FBPropertyVector3d Rotation
Read Write Property: Animation clip's rotation offset. Refer to class notes to learn more about how t...
Definition: fbstory.h:1050
FBPropertyTimeSpan PostBlend
Read Write Property: Start/Stop time of the post-blend phase.
Definition: fbstory.h:1018
FBPropertyStoryClipTimeWarpInterpolatorType TimeWarpInterpolatorType
Read Write Property: Animation and Shot clip's TimeWarp interpolation type. See FBStoryClipTimeWarpIn...
Definition: fbstory.h:1080
FBPropertyTime ShotActionStart
Read Write Property: If not in locked shot mode (time discontinuity enabled), this time can be differ...
Definition: fbstory.h:1029
FBPropertyBool LockPitchToSpeed
Read Write Property: Time-stretching enabled or not.
Definition: fbstory.h:1037
void GetAffectedObjects(FBArrayTemplate< FBComponent * > *pAffectedObjects)
GetAffectedObjects.
void GetAffectedAnimationNodes(FBArrayTemplate< FBAnimationNode * > *pAffectedAnimationNodes, FBComponent *pClipObject)
GetAffectedAnimationNodes.
FBPropertyVector3d GhostManipulatorOffset
Read Write Property: Animation clip's ghost manipulator offset.
Definition: fbstory.h:1064
FBPropertyBool ConnectedToTake
Read Write Property: When connected to current take, user can do updating from current take,...
Definition: fbstory.h:1069
FBPropertyVideo ShotFrontplate
Read Write Property: The frontplate used for that specific shot.
Definition: fbstory.h:1026
FBPropertyAnimationNode CustomTimeWarp
Read Only Property: Animation and Shot clip's custom TimeWarp FCurve.
Definition: fbstory.h:1082
FBPropertyBool ShotStartStopLocked
Read Write Property: Shot clip's 'In/Out Locked' property value. True if the shot clip's In/Out prope...
Definition: fbstory.h:1031
void SetTime(FBTime *pSourceIn=NULL, FBTime *pSourceOut=NULL, FBTime *pDestinationIn=NULL, FBTime *pDestinationOut=NULL, bool pUseAlternateSrcInProp=false)
SetTime Sets any in/out values for the source/destination times.
K_DEPRECATED_2023 void GetAssignSourcesToDestinationsInfo(FBStringList &pSrcList, FBStringList &pAvailableDstList, FBStringList &pDefaultDstList, FBStringList &pEffectiveDstList)
GetAssignSourcesToDestinationsInfo.
FBStoryClip(FBComponent *pClipObject, FBStoryTrack *pTrack, FBTime pTime, HIObject pObject=NULL)
Constructor.
FBPropertyTime Offset
Read Write Property: First loop time offset.
Definition: fbstory.h:1019
FBPropertyDouble Scale
Read Write Property: Animation clip's scaling (some don't support this property)
Definition: fbstory.h:1048
FBPropertyVector3d Translation
Read Write Property: Animation clip's translation offset. Refer to class notes to learn more about ho...
Definition: fbstory.h:1049
void GetAssignSourcesToDestinationsInfo(FBStringList &pSrcList, FBArrayBool &pValidAnimatedSrc, FBStringList &pAvailableDstList, FBArrayBool &pValidAnimatedDst, FBStringList &pDefaultDstList, FBStringList &pEffectiveDstList)
GetAssignSourcesToDestinationsInfo.
FBPropertyDouble Speed
Read Write Property: Speed of the clip.
Definition: fbstory.h:1020
FBPropertyBool ShowEmbeddedTimecode
Read Write Property: Whether to show embedded timecode of the clip, if available.
Definition: fbstory.h:1044
FBTime GetSourceTimeFromDestinationTime(FBTime pDestinationTime, int *pLoopNumber=nullptr)
Get the clip source time (internal time) from a destination time (local time).
FBPropertyAnimationNode PreBlendData
Read Only Property: To get the animation of the Pre blend curve
Definition: fbstory.h:1060
bool ExportToFile(FBString pOutputFile)
ExportToFile.
FBTime Move(FBTime pDelta, bool pForce=true)
Move.
FBPropertyTime MarkOut
Read Write Property: Stop time inside the clip.
Definition: fbstory.h:1016
FBPropertyTime GhostManipulatorCustomTime
Read Write Property: Custom time to display ghost manipulator, only applicable if GhostManipulatorMod...
Definition: fbstory.h:1068
FBPropertyBool AutoLoop
Read Write Property: If true, clip will automatically loop
Definition: fbstory.h:1052
FBPropertyCamera ShotCamera
Read Write Property: The camera used for that specific shot.
Definition: fbstory.h:1024
FBPropertyBool TimeWarpEnabled
Read Write Property: Animation and Shot clip's TimeWarp activeness.
Definition: fbstory.h:1079
FBPropertyAudioClip AudioClip
Read Only Property: The audio clip used by this StoryClip.
Definition: fbstory.h:1034
FBPropertyBool ShowBackplate
Read Write Property: Enable/Disable the shot backplate.
Definition: fbstory.h:1027
FBPropertyStoryClipNodeFunction TravellingNodeFunction
Read Write Property: Travelling node function. If set, this property will overwrite the Track's Trave...
Definition: fbstory.h:1066
FBPropertyBool Ghost
Read Write Property: Show ghosts
Definition: fbstory.h:1054
FBStoryClip(const char *pFilePath, FBStoryTrack *pTrack, FBTime pTime, FBTime pTimeOffset, HIObject pObject=NULL)
Constructor.
FBPropertyDouble FrameRate
Read Write Property: Frame rate value. Only effective when UseSystemFrameRate is false.
Definition: fbstory.h:1043
bool SetReadOnly(bool pMakeClipReadOnly, FBString pOutputFile=FBString())
SetReadOnly Assigns the clip read-only status.
FBPropertyString ClipVideoPath
Read Write Property: Video clip's file path
Definition: fbstory.h:1040
FBStoryClip * Razor(FBTime pTime)
Razor.
bool DestinationSetObject(const char *pSrcName, FBComponent *pObject)
Assign source to destination if the pSrcName is found in source list and pObject is in the Details li...
FBPropertyStoryClipMirrorPlane MirrorPlane
Read Write Property: Several mirror planes to mirror animation. See FBStoryClipMirrorPlane
Definition: fbstory.h:1074
FBPropertyColor Color
Read Write Property: Color of the clip.
Definition: fbstory.h:1012
FBTime MoveTo(FBTime pTime, bool pForce=true)
MoveTo.
bool CanAssignSourcesToDestinations()
CanAssignSourcesToDestinations.
FBPropertyBool StartStopLocked
Read Write Property: Clip's 'In/Out Locked' property value. True if the clip's In/Out properties (sta...
Definition: fbstory.h:1021
bool GetReadOnly()
GetReadOnly Retrieves the clip read-only status.
FBPropertyBool TimeWarpReverse
Read Write Property: If true, reverse the Animation or Shot clip's TimeWarp FCurve.
Definition: fbstory.h:1081
FBPropertyEvent OnChange
Event: Something in the clip has changed. (FBEventClip)
Definition: fbstory.h:1076
FBPropertyString ClipAudioPath
Read Write Property: Audio clip's file path
Definition: fbstory.h:1035
FBPropertyStoryClipGhostTimeMode GhostManipulatorMode
Read Write Property: Time mode to display ghost manipulator. See FBStoryClipGhostTimeMode.
Definition: fbstory.h:1067
FBPropertyBool GhostTravelling
Read Write Property: Show ghost of clip vector or traveling node
Definition: fbstory.h:1056
FBPropertyTimeSpan PreBlend
Read Write Property: Start/Stop time of the pre-blend phase.
Definition: fbstory.h:1017
FBPropertyListPivot Pivots
List: Pivots models (Generally, only one model is necessary)
Definition: fbstory.h:1062
FBPropertyBool ImageSequence
Read Write Property: Whether is a image sequence.
Definition: fbstory.h:1041
FBPropertyTime ShotActionStop
Read Write Property: If not in locked shot mode (time discontinuity enabled), this time can be differ...
Definition: fbstory.h:1030
FBPropertyVideo ShotBackplate
Read Write Property: The backplate used for that specific shot.
Definition: fbstory.h:1025
FBPropertyBool UseSystemFrameRate
Read Write Property: Whether always use system frame rate.
Definition: fbstory.h:1042
void Match()
Match.
Story Folder class.
Definition: fbstory.h:572
void ConvertClipsToReadOnly(bool pSelected, char *pFilePath)
Convert all clips to read-only clips.
FBPropertyListStoryFolder Childs
List: Children folders of this folder.
Definition: fbstory.h:599
FBPropertyString RecordClipPath
Read Write Property: Path for story recording. Can be relative or full path.
Definition: fbstory.h:597
virtual void FBDelete() override
Virtual FBDelete function.
void ExpandSelectedClips(bool pPreserveOverlap)
Used to expand selected clips .
void ExpandSelectedClipsGroup(bool pPreserveOverlap)
ExpandSelectedClipsGroup Used to expand group clip dependent clips.
FBPropertyStoryFolder Parent
Read Only Property: Object pointing to the folder's parent.
Definition: fbstory.h:598
FBPropertyListStoryTrack Tracks
List: Tracks of this folder.
Definition: fbstory.h:600
void AlignSelectedClips(FBStoryClipAlignmentType pType, FBComponent *pReferenceClip)
Used to align selected clips .
FBPropertyString Label
Read Write Property: Label to display for this story folder.
Definition: fbstory.h:593
FBPropertyBool Solo
Read Write Property: If true, this story folder will be the only one to play.
Definition: fbstory.h:595
void Load(bool pLoad)
Allow to load/unload all story clips under this folder.
FBPropertyBool Collapsed
Read Write Property: Toggle to collapse or expand the story folder.
Definition: fbstory.h:594
FBPropertyBool Mute
Read Write Property: If true, this story folder will be muted.
Definition: fbstory.h:596
void AlignSelectedClipsGroup(FBStoryGroupClipAlignmentType pType)
Used to align clips inside a group.
FBStoryFolder(FBStoryFolder *pParentFolder=NULL, HIObject pObject=NULL)
Constructor.
Story Group Clip class.
Definition: fbstory.h:1095
void Razor(FBTime pTime)
Razor.
FBPropertyTime Start
Read Write Property: Start time of the clip.
Definition: fbstory.h:1132
virtual void FBDelete() override
Virtual FBDelete function.
FBPropertyTime Stop
Read Write Property: Stop time of the clip.
Definition: fbstory.h:1133
FBPropertyListObject DependentClips
Read Write Property: Clips that are included in the group clip.
Definition: fbstory.h:1135
FBTime Move(FBTime pDelta, bool pForce=true)
Move.
FBTime MoveTo(FBTime pTime, bool pForce=true)
MoveTo.
FBPropertyBool StartStopLocked
Read Write Property: Clip's 'In/Out Locked' property value. True if the clip's In/Out properties (sta...
Definition: fbstory.h:1134
FBStoryGroupClip(FBArrayTemplate< FBStoryClip * > *pAffectedClipObject, HIObject pObject=NULL)
Constructor.
Story Management class.
Definition: fbstory.h:535
FBPropertyBool SummaryClip
Read Write Property: If true, summary clips for story folders will be created to help manipulating fo...
Definition: fbstory.h:546
static FBStory & TheOne()
Get the global story object.
FBPropertyBool ClipsTextsVisible
Read Write Property: If true, clips' texts are visible.
Definition: fbstory.h:549
FBPropertyStoryFolder RootFolder
Read Only Property: Story's root folder
Definition: fbstory.h:550
FBPropertyBool RecordToDisk
Read Write Property: If true, record to story will record directly to disk.
Definition: fbstory.h:547
FBPropertyStoryFolder RootEditFolder
Read Only Property: Story's root edit folder
Definition: fbstory.h:551
FBPropertyBool LockedShot
Read Write Property: If true, shots will be locked (no time discontinuity).
Definition: fbstory.h:544
FBPropertyBool MaintainShotAndClipShotLengthsSynced
Read Write Property: When working in time discontinuity, if true, shots and their corresponding shot ...
Definition: fbstory.h:545
FBPropertyBool Mute
Read Write Property: If true, the Story mode will be globally disabled.
Definition: fbstory.h:543
FBStory()
Constructor.
FBPropertyBool NoneBlockingPostprocess
Read Write Property: If true, record to disk will post process recorded data in low priority thread w...
Definition: fbstory.h:548
int CleanEmptyTracksAndFolders()
Remove all empty tracks and folders present in the Story Tool.
Story Track class.
Definition: fbstory.h:643
FBPropertyBool GhostPivot
Read Write Property: Show ghost of match object
Definition: fbstory.h:750
FBPropertyString ClipNameConvention
Read Write Property: Naming convention for each new recording clip that is created....
Definition: fbstory.h:735
FBPropertyVideo TrackVideo
Read Only Property: This FBVideo can be used as a texture.
Definition: fbstory.h:769
FBPropertyInt CharacterIndex
Read Write Property: Character's index to use.
Definition: fbstory.h:759
FBPropertyBool ShowFrontplate
Read Write Property: If true, the frontplate will be shown.
Definition: fbstory.h:763
FBPropertyInt AudioOutIndex
Read Write Property: Audio Output's index to use.
Definition: fbstory.h:766
FBPropertyBool GhostModel
Read Write Property: Show ghost of models
Definition: fbstory.h:748
FBPropertyStoryTrackRefMode ReferenceMode
Read Write Property: Track composition mode, kFBStoryTrackOverride or kFBStoryTrackAdditive
Definition: fbstory.h:753
FBPropertyString RecordClipPath
Read Write Property: Path for story recording. Can be relative or full path.
Definition: fbstory.h:734
virtual void FBDelete() override
Virtual FBDelete function.
FBPropertyBool OffsetEnable
Read Write Property: When enabled, allow clip to be offset
Definition: fbstory.h:754
FBPropertyCharacter Character
Read Write Property: Character to use.
Definition: fbstory.h:758
FBPropertyBool PassThrough
Read Write Property: Enable passthrough of animation if there is no clip on track animation is taken ...
Definition: fbstory.h:755
FBStoryTrack(FBStoryTrackType pTrackType, FBStoryFolder *pFolder=NULL, HIObject pObject=NULL)
Constructor.
FBPropertyListStorySubTrack SubTracks
List: Only Character and Animation tracks can have sub-tracks.
Definition: fbstory.h:739
void ChangeDetailsBegin()
ChangeDetailsBegin.
void EnableBodyPart(FBStoryTrackBodyPart pPart, bool pEnable)
EnableBodyPart.
FBStoryClip * CopyTakeIntoTrack(FBTimeSpan &pTimeSpan, FBTake *pTake, FBTime pOutputOffset=0, bool pMakeUndoable=false)
CopyTakeIntoTrack Copy animation from the specified take for affected objects of the track.
void ChangeDetailsEnd()
ChangeDetailsEnd.
FBPropertyStoryFolder ParentFolder
Read Only Property: Parent folder.
Definition: fbstory.h:737
FBPropertyString Label
Read Write Property: Label to display for this story track.
Definition: fbstory.h:731
FBPropertyBool Solo
Read Write Property: If true, this track will be the only one to play.
Definition: fbstory.h:733
void Load(bool pLoad)
Allow to load/unload all story clips under this track.
FBPropertyStoryTrackType Type
Read Only Property: Type of the track
Definition: fbstory.h:730
FBStoryClip * CopyTakeIntoTrack(FBTimeSpan &pTimeSpan, FBTake *pTake, bool pConnectToCurrentTake, FBTime pOutputOffset=FBTime(0), bool pMakeUndoable=false)
CopyTakeIntoTrack Copy animation from the specified take for affected objects of the track.
FBPropertyListStoryDetails Details
List: All objects associated to this track for processing.
Definition: fbstory.h:741
FBPropertyBool ShowBackplate
Read Write Property: If true, the backplate will be shown.
Definition: fbstory.h:762
FBPropertyBool Mute
Read Write Property: If true, this track wont' play.
Definition: fbstory.h:732
FBPropertyListStoryClip Clips
List: Clips contained in this track.
Definition: fbstory.h:740
FBPropertyBool Ghost
Read Write Property: Show ghosts
Definition: fbstory.h:747
FBPropertyBool RecordTrack
Read Write Property: Path for story recording. Can be relative or full path.
Definition: fbstory.h:736
FBStoryTrack * CreateSubTrack(FBStoryTrackType pTrackType, FBStoryTrackRefMode pRefMode)
Create a sub track, Only Character and Animation tracks can have sub-tracks.
void AddClip(FBComponent *pClip, FBTime pTime)
AddClip Add the clip to the track.
bool IsBodyPartEnabled(FBStoryTrackBodyPart pPart)
IsBodyPartEnabled.
FBPropertyStoryTrack ParentTrack
Read Only Property: Parent track, if the track is of Character or Animation type.
Definition: fbstory.h:738
FBPropertyBool AcceptKey
Read Write Property: Allow track to accept keys
Definition: fbstory.h:752
FBPropertyAnimatableDouble Weight
Read Write Property: Control the blend amount.
Definition: fbstory.h:744
FBPropertyBool GhostTravelling
Read Write Property: Show ghost of clip vector or traveling node
Definition: fbstory.h:749
FBStoryTrack(FBComponent *pSource, FBStoryFolder *pFolder=NULL, HIObject pObject=NULL)
Constructor.
FBPropertyStoryTrackGhostShowMode GhostShowTrackMode
Read Write Property: Show the ghosts for all the clips or only the adjacent clips....
Definition: fbstory.h:751
Basic string class.
Definition: fbstring.h:67
String list.
Definition: fbstring.h:208
A take is a container for animation in a scene.
Definition: fbdata.h:1727
Time data structure.
Definition: fbtime.h:88
TimeSpan class.
Definition: fbtime.h:384
Basic class definitions.
#define __FBClassDeclare(Name, Parent)
For internal use only.
Definition: fbcomponent.h:131
Contains definitions for devices, boxes and models.
FB_DEFINE_COMPONENT(K_DLLIMPORT, AnimationNode)
Animation node class.
Base class for Cameras.
class K_DLLIMPORT FBPropertyBase< int, kFBPT_int > FBPropertyInt
Property: int
class K_DLLIMPORT FBPropertyBaseAnimatable< double, kFBPT_double > FBPropertyAnimatableDouble
FBPropertyBaseAnimatableDouble type definition.
class K_DLLIMPORT FBPropertyBase< FBVector3d, kFBPT_Vector3D > FBPropertyVector3d
FBPropertyVector3d type definition.
class K_DLLIMPORT FBPropertyBase< bool, kFBPT_bool > FBPropertyBool
Property: bool
class K_DLLIMPORT FBPropertyBase< FBTime, kFBPT_Time > FBPropertyTime
Property: FBTime
class K_DLLIMPORT FBPropertyBase< FBTimeSpan, kFBPT_TimeSpan > FBPropertyTimeSpan
Property: FBTimeSpan
#define FB_DEFINE_ENUM(DllTag, Type)
Define an enum and give it the ability to be a property.
Definition: fbproperties.h:150
class K_DLLIMPORT FBPropertyBase< FBColor, kFBPT_ColorRGB > FBPropertyColor
FBPropertyColor type definition.
class K_DLLIMPORT FBPropertyBase< double, kFBPT_double > FBPropertyDouble
Property: double
#define FBSDK_DLL
Be sure that FBSDK_DLL is defined only once...
Definition: fbstory.h:48
FBStoryClipSolveMode
Solve Modes for story character clips.
Definition: fbstory.h:162
@ kFBStoryClipAnimFkIk
Solve forward and inverse kinematic animation.
Definition: fbstory.h:165
@ kFBStoryClipRetargetSkeleton
Solve retarget skeleton.
Definition: fbstory.h:163
@ kFBStoryClipAnimSkeleton
Solve skeleton animation.
Definition: fbstory.h:164
@ kFBStoryClipAnimSkeletonIk
Solve skeleton inverse kinematic animation.
Definition: fbstory.h:166
FBStoryTrackGhostShowMode
Ghost Show Modes for story animation tracks.
Definition: fbstory.h:134
@ kFBStoryTrackShowCurrentTimeAdjacentClips
Show the ghosts only for the previous clip, current clip, and next clip relative to current time.
Definition: fbstory.h:136
@ kFBStoryTrackShowAllClips
Show the ghosts for all the clips on the track.
Definition: fbstory.h:135
FBStoryClipTimeWarpInterpolatorType
Types of TimeWrap Interpolator for Story Clips.
Definition: fbstory.h:246
@ kFBStoryClipTimeWarpInterpolatorSmoothedEnds
'Smoothed Ends' TimeWarp Interpolation
Definition: fbstory.h:249
@ kFBStoryClipTimeWarpInterpolatorGoingFaster
'Going Faster' TimeWarp Interpolation
Definition: fbstory.h:250
@ kFBStoryClipTimeWarpInterpolatorSlowingDown
'Slowing Down' TimeWarp Interpolation
Definition: fbstory.h:251
@ kFBStoryClipTimeWarpInterpolatorLinear
'Normal' TimeWarp Interpolation
Definition: fbstory.h:248
@ kFBStoryClipTimeWarpInterpolatorCustom
'Custom' TimeWarp Interpolation
Definition: fbstory.h:247
@ kFBStoryClipTimeWarpInterpolatorSlowingDownReversed
'Reversed, Slowing Down' TimeWarp Interpolation
Definition: fbstory.h:255
@ kFBStoryClipTimeWarpInterpolatorSmoothedEndsReversed
'Reversed, Smoothed Ends' TimeWarp Interpolation
Definition: fbstory.h:253
@ kFBStoryClipTimeWarpInterpolatorGoingFasterReversed
'Reversed, Going Faster' TimeWarp Interpolation
Definition: fbstory.h:254
@ kFBStoryClipTimeWarpInterpolatorLinearReversed
'Reversed' TimeWarp Interpolation
Definition: fbstory.h:252
FBStoryGroupClipAlignmentType
Alignment Types when aligning groups.
Definition: fbstory.h:228
@ kFBStoryGroupClipAlignmentCurrentTimeline
Align the clips contained in the group clip with the current time.
Definition: fbstory.h:229
@ kFBStoryGroupClipAlignmentBeginningNextWithOffset
Align the clips contained in the group clip to the beginning of the next clip, while keeping the rela...
Definition: fbstory.h:231
@ kFBStoryGroupClipAlignmentEndPreviousWithOffset
Align the clips contained in the group clip to the end of the previous clip, while keeping the relati...
Definition: fbstory.h:230
FBStoryTrackType
Types for new story tracks.
Definition: fbstory.h:84
@ kFBStoryTrackConstraint
Constraint track.
Definition: fbstory.h:88
@ kFBStoryTrackCommand
Command track.
Definition: fbstory.h:89
@ kFBStoryTrackAnimation
Animation track.
Definition: fbstory.h:85
@ kFBStoryTrackVideo
Video track.
Definition: fbstory.h:92
@ kFBStoryTrackAudio
Audio track.
Definition: fbstory.h:91
@ kFBStoryTrackCamera
Camera animation track.
Definition: fbstory.h:86
@ kFBStoryTrackShot
Shot track.
Definition: fbstory.h:90
@ kFBStoryTrackCharacter
Character animation track.
Definition: fbstory.h:87
FBStoryClipChangeType
Types of clip change events, matching KEventClip.eType Expose only kFBStoryClipMoveClip and kFBStoryC...
Definition: fbstory.h:236
@ kFBStoryClipNotSet
Clip none.
Definition: fbstory.h:237
@ kFBStoryClipUpdateUI
Clip UI update.
Definition: fbstory.h:241
@ kFBStoryClipMoveBlend
Clip move blend.
Definition: fbstory.h:240
@ kFBStoryClipRemoved
Clip removed.
Definition: fbstory.h:242
@ kFBStoryClipMoveData
Clip data moved.
Definition: fbstory.h:239
@ kFBStoryClipMoveClip
Clip moved.
Definition: fbstory.h:238
FBStoryTrackBodyPart
Body Parts for story track character.
Definition: fbstory.h:102
FBStoryClipMatchingRotationType
Matching Rotation Types, when matching clips to each other.
Definition: fbstory.h:207
@ kFBStoryClipMatchingRotationGravityXZ
Rotates a selected clip's match object around the global Y axis.
Definition: fbstory.h:210
@ kFBStoryClipMatchingRotationNone
The clip's match object is not rotated to match another clip's animation.
Definition: fbstory.h:208
@ kFBStoryClipMatchingRotationXYZ
Rotates a selected clip's match object to the same orientation as the previous clip's match object.
Definition: fbstory.h:209
@ kFBStoryClipMatchingRotationDefault
Uses the matching translation type stored in the Application configuration file: [Story] > MatchRotat...
Definition: fbstory.h:211
FBStoryClipMatchingTimeType
Matching Time Types, when matching clips to each other.
Definition: fbstory.h:185
@ kFBStoryClipMatchingTimeBetweenSelectedAndNextClip
Matches the selected clip and the next clip at the middle of the blend.
Definition: fbstory.h:191
@ kFBStoryClipMatchingTimeEndOfSelectedClip
Matches the end of the selected clip to the end of the blend with the previous clip.
Definition: fbstory.h:192
@ kFBStoryClipMatchingTimeStartOfNextClip
Matches the start of the blend with the selected clip to the start of the next clip.
Definition: fbstory.h:190
@ kFBStoryClipMatchingTimeCurrentTime
Matches the start of the selected clip to the previous/next clip at the current time.
Definition: fbstory.h:186
@ kFBStoryClipMatchingTimeBetweenPreviousAndSelectedClip
Matches the selected clip and the previous clip at the middle of the blend.
Definition: fbstory.h:188
@ kFBStoryClipMatchingTimeStartOfSelectedClip
Matches the start of the selected clip to the start of the blend with the previous clip.
Definition: fbstory.h:187
@ kFBStoryClipMatchingTimeEndOfPreviousClip
Matches the end of the blend with the selected clip to the end of the previous clip.
Definition: fbstory.h:189
@ kFBStoryClipMatchingTimeDefault
Uses the matching time type stored in the Application configuration file: [Story] > MatchWhen....
Definition: fbstory.h:193
FBStoryClipAlignmentType
Alignment Types when aligning clips.
Definition: fbstory.h:216
@ kFBStoryClipAlignmentBeginningNextAllAligned
Align selected clips to the beginning of the next clip, all clips will be align to the selected clip ...
Definition: fbstory.h:221
@ kFBStoryClipAlignmentCurrentTimelineWithOffset
Align all selected clips with the current time, while keeping the relative offset.
Definition: fbstory.h:222
@ kFBStoryClipAlignmentBeginningNextWithOffset
Align selected clips to the beginning of the next clip, while keeping the relative offset.
Definition: fbstory.h:224
@ kFBStoryClipAlignmentEndPreviousWithOffset
Align selected clips to the end of the previous clip, while keeping the relative offset.
Definition: fbstory.h:223
@ kFBStoryClipAlignmentCurrentTimeline
Align all selected clips with the current time.
Definition: fbstory.h:217
@ kFBStoryClipAlignmentEndPrevious
Align selected clips to the end of the previous clip.
Definition: fbstory.h:218
@ kFBStoryClipAlignmentBeginningNext
Align selected clips to the beginning of the next clip.
Definition: fbstory.h:220
@ kFBStoryClipAlignmentEndPreviousAllAligned
Align selected clips to the end of the previous clip, all clips will be align to the selected clip po...
Definition: fbstory.h:219
FBStoryClipGhostTimeMode
Time mode to display ghost.
Definition: fbstory.h:147
@ kFBStoryClipGhostCurrent
Show the ghost at current time of the clip.
Definition: fbstory.h:148
@ kFBStoryClipGhostCustom
Show the ghost at custom time of the clip. See GhostManipulatorCustomTime property.
Definition: fbstory.h:151
@ kFBStoryClipGhostStop
Show the ghost at stop time of the clip.
Definition: fbstory.h:150
@ kFBStoryClipGhostStart
Show the ghost at start time of the clip.
Definition: fbstory.h:149
FBStoryTrackRefMode
References Modes for story animation tracks.
Definition: fbstory.h:96
@ kFBStoryTrackAdditive
Additive track.
Definition: fbstory.h:98
@ kFBStoryTrackOverride
Override track.
Definition: fbstory.h:97
FBStoryClipShowGhostMode
Show Ghost Modes for story animation clips.
Definition: fbstory.h:140
@ kFBStoryClipTimeCursor
Show the ghost only on time cursor.
Definition: fbstory.h:142
@ kFBStoryClipTimeCustom
Show the ghost for custom time frame.
Definition: fbstory.h:143
@ kFBStoryClipAlways
Always show the ghost.
Definition: fbstory.h:141
FBStoryClipMirrorPlane
Several mirror planes to mirror animation.
Definition: fbstory.h:170
@ kFBStoryClipMirrorPlaneXZ
X-Z plane.
Definition: fbstory.h:173
@ kFBStoryClipMirrorPlaneZY
Z-Y plane.
Definition: fbstory.h:172
@ kFBStoryClipMirrorPlaneXY
X-Y plane.
Definition: fbstory.h:171
FBStoryClipCompMode
Compensation Modes for story character clips.
Definition: fbstory.h:177
@ kFBStoryClipOff
No compensation.
Definition: fbstory.h:178
@ kFBStoryClipUser
User defined compensation.
Definition: fbstory.h:180
@ kFBStoryClipAuto
Automatic compensation.
Definition: fbstory.h:179
FBStoryClipNodeFunction
Node function.
Definition: fbstory.h:155
@ kFBStoryClipNodeFloorProjection
Project on XZ plane.
Definition: fbstory.h:157
@ kFBStoryClipNodeAverage
Average.
Definition: fbstory.h:156
@ kFBStoryClipNodeNone
None.
Definition: fbstory.h:158
FBStoryClipMatchingTranslationType
Matching Translation, Types when matching clips to each other.
Definition: fbstory.h:198
@ kFBStoryClipMatchingTranslationGravityXZ
Translates a selected clip's match object along the global X and Z axes.
Definition: fbstory.h:201
@ kFBStoryClipMatchingTranslationXYZ
Translates a selected clip's match object to the same location as the previous clip's match object.
Definition: fbstory.h:200
@ kFBStoryClipMatchingTranslationNone
The clip's match object is not translated to match another clip's animation.
Definition: fbstory.h:199
@ kFBStoryClipMatchingTranslationDefault
Uses the matching translation type stored in the Application configuration file: [Story] > MatchTrans...
Definition: fbstory.h:202
#define FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
Definition: fbtypes.h:62
#define __FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
Definition: fbtypes.h:68
FBVideo and derivative classes.