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
45 
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 -----------------------------------------------------------------------------------------------------
685  FBStoryClip* CopyTakeIntoTrack(FBTimeSpan& pTimeSpan, FBTake* pTake, FBTime pOutputOffset = 0, bool pMakeUndoable = false);
686 
687  //--- Character track functions -----------------------------------------------------------------------------------------------------
693  void EnableBodyPart(FBStoryTrackBodyPart pPart, bool pEnable);
694 
699 
703  void AddClip(FBComponent* pClip, FBTime pTime);
704 
711 
715  void Load(bool pLoad);
716 
717  //--- All track properties ----------------------------------------------------------------------------------------------------------
718  FBPropertyStoryTrackType Type;
725  FBPropertyStoryFolder ParentFolder;
726  FBPropertyStoryTrack ParentTrack;
730 
731  //--- Animation and Constraint track properties -------------------------------------------------------------------------------------
733 
734  //--- Animation track properties ----------------------------------------------------------------------------------------------------
739  FBPropertyStoryTrackGhostShowMode GhostShowTrackMode;
741  FBPropertyStoryTrackRefMode ReferenceMode;
744 
745  //--- Character track properties ----------------------------------------------------------------------------------------------------
746  FBPropertyCharacter Character;
748 
749  //--- Shot track properties ---------------------------------------------------------------------------------------------------------
752 
753  //--- Audio track properties --------------------------------------------------------------------------------------------------------
755 
756  //--- Video track properties --------------------------------------------------------------------------------------------------------
757  FBPropertyVideo TrackVideo;
758 private:
759  void FBStoryTrackInitProperties();
760 };
761 
763 // FBStoryClip
765 
778 {
779  //--- Open Reality declaration.
781 public:
782 
789  FBStoryClip(FBComponent* pClipObject, FBStoryTrack* pTrack, FBTime pTime, HIObject pObject=NULL);
790 
797  FBStoryClip(const char* pFilePath, FBStoryTrack* pTrack, FBTime pTime, HIObject pObject=NULL);
798 
806  FBStoryClip(const char* pFilePath, FBStoryTrack* pTrack, FBTime pTime, FBTime pTimeOffset, HIObject pObject=NULL);
807 
810  virtual void FBDelete() override;
811 
815 
822  FBTime Move(FBTime pDelta, bool pForce=true);
823 
830  FBTime MoveTo(FBTime pTime, bool pForce=true);
831 
838 
839  //--- Animation clip functions ------------------------------------------------------------------------------------------------------
843  void Match();
844 
852  void Match
853  (
854  FBString pObjectName,
855  FBStoryClipMatchingTimeType pTimeType,
856  FBStoryClipMatchingTranslationType pTranslationType,
857  FBStoryClipMatchingRotationType pRotationType
858  );
859 
865  bool ExportToFile(FBString pOutputFile);
866 
871  bool GetReadOnly();
872 
879  bool SetReadOnly(bool pMakeClipReadOnly, FBString pOutputFile = FBString());
880 
885  bool MakeWritable();
886 
895 
904  void GetAffectedAnimationNodes( FBArrayTemplate<FBAnimationNode*>* pAffectedAnimationNodes, FBComponent* pClipObject );
905 
912  bool DestinationSetObject( const char* pSrcName, FBComponent* pObject );
913 
935  void SetTime( FBTime *pSourceIn = NULL, FBTime *pSourceOut = NULL, FBTime *pDestinationIn = NULL, FBTime *pDestinationOut = NULL, bool pUseAlternateSrcInProp = false );
936 
942 
952  void GetAssignSourcesToDestinationsInfo( FBStringList& pSrcList, FBStringList& pAvailableDstList, FBStringList& pDefaultDstList, FBStringList& pEffectiveDstList );
953 
963 
967  FBXSDK_NAMESPACE::FbxScene* GetFbxScene();
968 
973 
974  //--- All clip properties -----------------------------------------------------------------------------------------------------------
985 
986  //--- Shot clip properties ----------------------------------------------------------------------------------------------------------
987  FBPropertyCamera ShotCamera;
988  FBPropertyVideo ShotBackplate;
989  FBPropertyVideo ShotFrontplate;
995 
996  //--- Audio clip properties ---------------------------------------------------------------------------------------------------------
997  FBPropertyAudioClip AudioClip;
1001 
1002  //--- Video clip properties ---------------------------------------------------------------------------------------------------------
1008 
1009  //--- Animation clip properties -----------------------------------------------------------------------------------------------------
1021  FBPropertyStoryClipShowGhostMode ShowGhostClipMode;
1023  FBPropertyAnimationNode PreBlendData;
1024  FBPropertyAnimationNode PostBlendData;
1029  FBPropertyStoryClipNodeFunction TravellingNodeFunction;
1030  FBPropertyStoryClipGhostTimeMode GhostManipulatorMode;
1033 
1034  //--- Character clip properties -----------------------------------------------------------------------------------------------------
1035  FBPropertyStoryClipSolveMode SolvingMode;
1037  FBPropertyStoryClipMirrorPlane MirrorPlane;
1038 
1040 
1041  //--- Character and shot clip properties -----------------------------------------------------------------------------------------------------
1043  FBPropertyStoryClipTimeWarpInterpolatorType TimeWarpInterpolatorType;
1045  FBPropertyAnimationNode CustomTimeWarp;
1046 
1047 private:
1048  void FBStoryClipInitProperties();
1049 };
1050 
1052 // FBStoryGroupClip
1054 
1058 {
1059  //--- Open Reality declaration.
1061 public:
1062 
1067  FBStoryGroupClip(FBArrayTemplate<FBStoryClip*>* pAffectedClipObject, HIObject pObject=NULL);
1068 
1071  virtual void FBDelete() override;
1072 
1079  FBTime Move(FBTime pDelta, bool pForce=true);
1080 
1087  FBTime MoveTo(FBTime pTime, bool pForce=true);
1088 
1093  void Razor(FBTime pTime);
1094 
1099 
1100 private:
1101  void FBStoryClipInitProperties();
1102 };
1103 
1104 #ifdef FBSDKUseNamespace
1105  }
1106 #endif
1107 #endif /* this must be the last line of this file */
kFBStoryClipMatchingTimeEndOfSelectedClip
@ kFBStoryClipMatchingTimeEndOfSelectedClip
Matches the end of the selected clip to the end of the blend with the previous clip.
Definition: fbstory.h:192
FBStory::LockedShot
FBPropertyBool LockedShot
Read Write Property: If true, shots will be locked (no time discontinuity).
Definition: fbstory.h:544
FBStoryGroupClip::Move
FBTime Move(FBTime pDelta, bool pForce=true)
Move.
kFBStoryClipAuto
@ kFBStoryClipAuto
Automatic compensation.
Definition: fbstory.h:179
kFBStoryClipMatchingTranslationXYZ
@ kFBStoryClipMatchingTranslationXYZ
Translates a selected clip's match object to the same location as the previous clip's match object.
Definition: fbstory.h:200
kFBStoryClipRemoved
@ kFBStoryClipRemoved
Clip removed.
Definition: fbstory.h:242
FBStoryTrack::FBStoryTrack
FBStoryTrack(FBComponent *pSource, FBStoryFolder *pFolder=NULL, HIObject pObject=NULL)
Constructor.
kFBStoryClipMatchingTranslationNone
@ kFBStoryClipMatchingTranslationNone
The clip's match object is not translated to match another clip's animation.
Definition: fbstory.h:199
kFBStoryClipTimeWarpInterpolatorLinearReversed
@ kFBStoryClipTimeWarpInterpolatorLinearReversed
'Reversed' TimeWarp Interpolation
Definition: fbstory.h:252
kFBStoryClipMatchingTimeBetweenPreviousAndSelectedClip
@ kFBStoryClipMatchingTimeBetweenPreviousAndSelectedClip
Matches the selected clip and the previous clip at the middle of the blend.
Definition: fbstory.h:188
FBStoryTrack::ClipNameConvention
FBPropertyString ClipNameConvention
Read Write Property: Naming convention for each new recording clip that is created....
Definition: fbstory.h:723
kFBStoryClipMatchingTimeDefault
@ kFBStoryClipMatchingTimeDefault
Uses the matching time type stored in the Application configuration file: [Story] > MatchWhen....
Definition: fbstory.h:193
FBStoryClip::ClipAnimationPath
FBPropertyString ClipAnimationPath
Read Write Property: Animation clip's file path
Definition: fbstory.h:1010
FBStoryFolder::Parent
FBPropertyStoryFolder Parent
Read Only Property: Object pointing to the folder's parent.
Definition: fbstory.h:598
FBStoryClip::Start
FBPropertyTime Start
Read Write Property: Start time of the clip local to its track.
Definition: fbstory.h:976
FBStoryTrack::Solo
FBPropertyBool Solo
Read Write Property: If true, this track will be the only one to play.
Definition: fbstory.h:721
kFBStoryClipMirrorPlaneXY
@ kFBStoryClipMirrorPlaneXY
X-Y plane.
Definition: fbstory.h:171
FBStoryClip::Pivots
FBPropertyListPivot Pivots
List: Pivots models (Generally, only one model is necessary)
Definition: fbstory.h:1025
FBPropertyListStorySubTrack::operator[]
virtual FBStoryTrack * operator[](int pIndex)
Get the sub-track at pIndex.
FBStoryClip::GetAffectedObjects
void GetAffectedObjects(FBArrayTemplate< FBComponent * > *pAffectedObjects)
GetAffectedObjects.
FBStoryFolder::ExpandSelectedClipsGroup
void ExpandSelectedClipsGroup(bool pPreserveOverlap)
ExpandSelectedClipsGroup Used to expand group clip dependent clips.
FBStoryClip::TimeWarpReverse
FBPropertyBool TimeWarpReverse
Read Write Property: If true, reverse the Animation or Shot clip's TimeWarp FCurve.
Definition: fbstory.h:1044
FBStoryClip::AudioClip
FBPropertyAudioClip AudioClip
Read Only Property: The audio clip used by this StoryClip.
Definition: fbstory.h:997
FBStoryClip::GetAssignSourcesToDestinationsInfo
void GetAssignSourcesToDestinationsInfo(FBStringList &pSrcList, FBStringList &pAvailableDstList, FBStringList &pDefaultDstList, FBStringList &pEffectiveDstList)
GetAssignSourcesToDestinationsInfo.
FB_DEFINE_ENUM
#define FB_DEFINE_ENUM(DllTag, Type)
Define an enum and give it the ability to be a property.
Definition: fbproperties.h:150
kFBStoryClipMatchingRotationGravityXZ
@ kFBStoryClipMatchingRotationGravityXZ
Rotates a selected clip's match object around the global Y axis.
Definition: fbstory.h:210
kFBStoryClipNotSet
@ kFBStoryClipNotSet
Clip none.
Definition: fbstory.h:237
kFBStoryClipTimeWarpInterpolatorLinear
@ kFBStoryClipTimeWarpInterpolatorLinear
'Normal' TimeWarp Interpolation
Definition: fbstory.h:248
FBStoryClip::ClipPitch
FBPropertyDouble ClipPitch
Read Write Property: The clip pitch value.
Definition: fbstory.h:999
FBStoryTrackRefMode
FBStoryTrackRefMode
References Modes for story animation tracks.
Definition: fbstory.h:96
kFBStoryClipMatchingTimeEndOfPreviousClip
@ kFBStoryClipMatchingTimeEndOfPreviousClip
Matches the end of the blend with the selected clip to the end of the previous clip.
Definition: fbstory.h:189
kFBStoryClipGhostStop
@ kFBStoryClipGhostStop
Show the ghost at stop time of the clip.
Definition: fbstory.h:150
kFBStoryClipAlignmentBeginningNextWithOffset
@ kFBStoryClipAlignmentBeginningNextWithOffset
Align selected clips to the beginning of the next clip, while keeping the relative offset.
Definition: fbstory.h:224
FBStoryGroupClip::Start
FBPropertyTime Start
Read Write Property: Start time of the clip.
Definition: fbstory.h:1095
FBPropertyListStoryClip::operator[]
virtual FBStoryClip * operator[](int pIndex)
Get the clip at pIndex.
FBStoryClip::Move
FBTime Move(FBTime pDelta, bool pForce=true)
Move.
FBStoryTrack::FBStoryTrack
FBStoryTrack(FBStoryTrackType pTrackType, FBStoryFolder *pFolder=NULL, HIObject pObject=NULL)
Constructor.
FBPropertyInt
class K_DLLIMPORT FBPropertyBase< int, kFBPT_int > FBPropertyInt
Property: int
Definition: fbproperties.h:1331
FBTimeSpan
TimeSpan class.
Definition: fbtime.h:384
FBStoryTrack::RecordTrack
FBPropertyBool RecordTrack
Read Write Property: Path for story recording. Can be relative or full path.
Definition: fbstory.h:724
kFBStoryClipAlignmentEndPreviousWithOffset
@ kFBStoryClipAlignmentEndPreviousWithOffset
Align selected clips to the end of the previous clip, while keeping the relative offset.
Definition: fbstory.h:223
FBStoryTrack::PassThrough
FBPropertyBool PassThrough
Read Write Property: Enable passthrough of animation if there is no clip on track animation is taken ...
Definition: fbstory.h:743
FBStory::RecordToDisk
FBPropertyBool RecordToDisk
Read Write Property: If true, record to story will record directly to disk.
Definition: fbstory.h:547
FBStoryClip::PreBlendData
FBPropertyAnimationNode PreBlendData
Read Only Property: To get the animation of the Pre blend curve
Definition: fbstory.h:1023
FBStoryTrack::Clips
FBPropertyListStoryClip Clips
List: Clips contained in this track.
Definition: fbstory.h:728
kFBStoryTrackAnimation
@ kFBStoryTrackAnimation
Animation track.
Definition: fbstory.h:85
FBStoryFolder::Solo
FBPropertyBool Solo
Read Write Property: If true, this story folder will be the only one to play.
Definition: fbstory.h:595
FBStoryClip::MarkOut
FBPropertyTime MarkOut
Read Write Property: Stop time inside the clip.
Definition: fbstory.h:979
FBStoryClip::ShotActionStart
FBPropertyTime ShotActionStart
Read Write Property: If not in locked shot mode (time discontinuity enabled), this time can be differ...
Definition: fbstory.h:992
kFBStoryClipMoveClip
@ kFBStoryClipMoveClip
Clip moved.
Definition: fbstory.h:238
FBStringList
String list.
Definition: fbstring.h:208
FBStoryClip::MoveTo
FBTime MoveTo(FBTime pTime, bool pForce=true)
MoveTo.
kFBStoryTrackCharacter
@ kFBStoryTrackCharacter
Character animation track.
Definition: fbstory.h:87
FBStoryTrack::CreateSubTrack
FBStoryTrack * CreateSubTrack(FBStoryTrackType pTrackType, FBStoryTrackRefMode pRefMode)
Create a sub track, Only Character and Animation tracks can have sub-tracks.
FBStoryClipSolveMode
FBStoryClipSolveMode
Solve Modes for story character clips.
Definition: fbstory.h:162
kFBStoryClipTimeWarpInterpolatorGoingFasterReversed
@ kFBStoryClipTimeWarpInterpolatorGoingFasterReversed
'Reversed, Going Faster' TimeWarp Interpolation
Definition: fbstory.h:254
FBStoryClipMatchingRotationType
FBStoryClipMatchingRotationType
Matching Rotation Types, when matching clips to each other.
Definition: fbstory.h:207
FBStoryClip::ShotFrontplate
FBPropertyVideo ShotFrontplate
Read Write Property: The frontplate used for that specific shot.
Definition: fbstory.h:989
FBStoryTrack::GhostTravelling
FBPropertyBool GhostTravelling
Read Write Property: Show ghost of clip vector or traveling node
Definition: fbstory.h:737
FBStoryClip::PreBlend
FBPropertyTimeSpan PreBlend
Read Write Property: Start/Stop time of the pre-blend phase.
Definition: fbstory.h:980
FBStoryGroupClip::Stop
FBPropertyTime Stop
Read Write Property: Stop time of the clip.
Definition: fbstory.h:1096
FBStoryClip::TimeWarpInterpolatorType
FBPropertyStoryClipTimeWarpInterpolatorType TimeWarpInterpolatorType
Read Write Property: Animation and Shot clip's TimeWarp interpolation type. See FBStoryClipTimeWarpIn...
Definition: fbstory.h:1043
FBStoryTrack::ChangeDetailsBegin
void ChangeDetailsBegin()
ChangeDetailsBegin.
FBStoryClip::ConnectedToTake
FBPropertyBool ConnectedToTake
Read Write Property: When connected to current take, user can do updating from current take,...
Definition: fbstory.h:1032
kFBStoryClipTimeWarpInterpolatorGoingFaster
@ kFBStoryClipTimeWarpInterpolatorGoingFaster
'Going Faster' TimeWarp Interpolation
Definition: fbstory.h:250
FBPropertyListStoryTrack::operator[]
virtual FBStoryTrack * operator[](int pIndex)
Get the track at pIndex.
FBPropertyListComponentBase
PropertyList: Component.
Definition: fbcomponent.h:477
kFBStoryClipGhostCurrent
@ kFBStoryClipGhostCurrent
Show the ghost at current time of the clip.
Definition: fbstory.h:148
kFBStoryTrackVideo
@ kFBStoryTrackVideo
Video track.
Definition: fbstory.h:92
FBPropertyDouble
class K_DLLIMPORT FBPropertyBase< double, kFBPT_double > FBPropertyDouble
Property: double
Definition: fbproperties.h:1340
FBPropertyListStoryDetails::operator[]
virtual FBComponent * operator[](int pIndex)
Get the object at pIndex.
FBStoryClip::TimeWarpEnabled
FBPropertyBool TimeWarpEnabled
Read Write Property: Animation and Shot clip's TimeWarp activeness.
Definition: fbstory.h:1042
FBStoryClip::MirrorPlane
FBPropertyStoryClipMirrorPlane MirrorPlane
Read Write Property: Several mirror planes to mirror animation. See FBStoryClipMirrorPlane
Definition: fbstory.h:1037
FBPropertyListStoryTrack::GetCount
virtual int GetCount()
Get the number of track.
FBStoryTrack::SubTracks
FBPropertyListStorySubTrack SubTracks
List: Only Character and Animation tracks can have sub-tracks.
Definition: fbstory.h:727
FBStoryClip
Story Clip class.
Definition: fbstory.h:778
FBStoryFolder::Childs
FBPropertyListStoryFolder Childs
List: Children folders of this folder.
Definition: fbstory.h:599
FBStoryTrack::Mute
FBPropertyBool Mute
Read Write Property: If true, this track wont' play.
Definition: fbstory.h:720
kFBStoryClipOff
@ kFBStoryClipOff
No compensation.
Definition: fbstory.h:178
FBStoryFolder::ExpandSelectedClips
void ExpandSelectedClips(bool pPreserveOverlap)
Used to expand selected clips .
FBTime
Time data structure.
Definition: fbtime.h:88
FBPropertyListStoryClip::GetCount
virtual int GetCount()
Get the number of clip.
kFBStoryGroupClipAlignmentCurrentTimeline
@ kFBStoryGroupClipAlignmentCurrentTimeline
Align the clips contained in the group clip with the current time.
Definition: fbstory.h:229
FBStoryClip::LoopTranslation
FBPropertyVector3d LoopTranslation
Read Write Property: Animation clip's loop translation.
Definition: fbstory.h:1014
FBPropertyListStoryDetails::GetCount
virtual int GetCount()
Get the number of object.
FBStoryClip::FBDelete
virtual void FBDelete() override
Virtual FBDelete function.
fbvideo.h
FBVideo and derivative classes.
FBStoryClip::GhostManipulatorOffset
FBPropertyVector3d GhostManipulatorOffset
Read Write Property: Animation clip's ghost manipulator offset.
Definition: fbstory.h:1027
FBStoryGroupClip
Story Group Clip class.
Definition: fbstory.h:1058
FBStoryTrack::Character
FBPropertyCharacter Character
Read Write Property: Character to use.
Definition: fbstory.h:746
FBPropertyListPivot
List: Story Clip pivot models
Definition: fbstory.h:492
kFBStoryClipMatchingTimeCurrentTime
@ kFBStoryClipMatchingTimeCurrentTime
Matches the start of the selected clip to the previous/next clip at the current time.
Definition: fbstory.h:186
kFBStoryClipAlignmentBeginningNextAllAligned
@ kFBStoryClipAlignmentBeginningNextAllAligned
Align selected clips to the beginning of the next clip, all clips will be align to the selected clip ...
Definition: fbstory.h:221
kFBStoryClipMatchingTimeStartOfNextClip
@ kFBStoryClipMatchingTimeStartOfNextClip
Matches the start of the blend with the selected clip to the start of the next clip.
Definition: fbstory.h:190
kFBStoryClipTimeCustom
@ kFBStoryClipTimeCustom
Show the ghost for custom time frame.
Definition: fbstory.h:143
FBPropertyListStoryFolder
List: StoryFolder
Definition: fbstory.h:292
FBPropertyColor
class K_DLLIMPORT FBPropertyBase< FBColor, kFBPT_ColorRGB > FBPropertyColor
FBPropertyColor type definition.
Definition: fbproperties.h:1454
FBPropertyListStoryTrack
List: StoryTrack
Definition: fbstory.h:334
FBEventClipChange
Definition: fbstory.h:279
kFBStoryClipMoveData
@ kFBStoryClipMoveData
Clip data moved.
Definition: fbstory.h:239
FBStoryClip::UpdateFromCurrentTake
bool UpdateFromCurrentTake()
Update clip animation from current take animation for clip track's scope, works only for clip created...
FBStoryFolder::RecordClipPath
FBPropertyString RecordClipPath
Read Write Property: Path for story recording. Can be relative or full path.
Definition: fbstory.h:597
FBStoryTrack::EnableBodyPart
void EnableBodyPart(FBStoryTrackBodyPart pPart, bool pEnable)
EnableBodyPart.
FBTake
A take is a container for animation in a scene.
Definition: fbdata.h:1692
FBStoryTrack::Weight
FBPropertyAnimatableDouble Weight
Read Write Property: Control the blend amount.
Definition: fbstory.h:732
FBPropertyListPivot::GetCount
virtual int GetCount()
Get the number of object.
FBStoryClip::ClipVideoPath
FBPropertyString ClipVideoPath
Read Write Property: Video clip's file path
Definition: fbstory.h:1003
FBPropertyListStoryFolder::RemoveAt
virtual void RemoveAt(int pIndex)
Remove the folder at pIndex.
FBStoryClip::CustomTimeWarp
FBPropertyAnimationNode CustomTimeWarp
Read Only Property: Animation and Shot clip's custom TimeWarp FCurve.
Definition: fbstory.h:1045
FBStoryTrack::CopyTakeIntoTrack
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.
FBStoryClip::OnChange
FBPropertyEvent OnChange
Event: Something in the clip has changed. (FBEventClip)
Definition: fbstory.h:1039
FBStory::RootEditFolder
FBPropertyStoryFolder RootEditFolder
Read Only Property: Story's root edit folder
Definition: fbstory.h:551
FBStoryClip::Speed
FBPropertyDouble Speed
Read Write Property: Speed of the clip.
Definition: fbstory.h:983
FBPropertyListStoryClip::RemoveAt
virtual void RemoveAt(int pIndex)
Remove the clip at pIndex.
FBStoryClip::StartStopLocked
FBPropertyBool StartStopLocked
Read Write Property: Clip's 'In/Out Locked' property value. True if the clip's In/Out properties (sta...
Definition: fbstory.h:984
FBPropertyListPivot::Remove
virtual int Remove(FBModel *pItem)
Remove object pItem from property list.
FBStoryFolder::FBStoryFolder
FBStoryFolder(FBStoryFolder *pParentFolder=NULL, HIObject pObject=NULL)
Constructor.
kFBStoryClipNodeAverage
@ kFBStoryClipNodeAverage
Average.
Definition: fbstory.h:156
FBStoryTrack::RecordClipPath
FBPropertyString RecordClipPath
Read Write Property: Path for story recording. Can be relative or full path.
Definition: fbstory.h:722
FBStoryTrack::GhostPivot
FBPropertyBool GhostPivot
Read Write Property: Show ghost of match object
Definition: fbstory.h:738
FBStoryClip::FBStoryClip
FBStoryClip(FBComponent *pClipObject, FBStoryTrack *pTrack, FBTime pTime, HIObject pObject=NULL)
Constructor.
FBStoryClip::GhostManipulatorCustomTime
FBPropertyTime GhostManipulatorCustomTime
Read Write Property: Custom time to display ghost manipulator, only applicable if GhostManipulatorMod...
Definition: fbstory.h:1031
FBStoryTrack::Ghost
FBPropertyBool Ghost
Read Write Property: Show ghosts
Definition: fbstory.h:735
FBStoryClip::MarkIn
FBPropertyTime MarkIn
Read Write Property: Start time inside the clip.
Definition: fbstory.h:978
FBStoryTrack
Story Track class.
Definition: fbstory.h:643
FBPropertyListStorySubTrack::Remove
virtual int Remove(FBStoryTrack *pItem)
Remove sub-track pItem from property list.
kFBStoryClipAlignmentBeginningNext
@ kFBStoryClipAlignmentBeginningNext
Align selected clips to the beginning of the next clip.
Definition: fbstory.h:220
fbmodel.h
Base class for Cameras.
kFBStoryClipMirrorPlaneXZ
@ kFBStoryClipMirrorPlaneXZ
X-Z plane.
Definition: fbstory.h:173
FBStoryClipChangeType
FBStoryClipChangeType
Types of clip change events, matching KEventClip.eType Expose only kFBStoryClipMoveClip and kFBStoryC...
Definition: fbstory.h:236
FBStoryTrack::FBDelete
virtual void FBDelete() override
Virtual FBDelete function.
FBStoryClip::Scale
FBPropertyDouble Scale
Read Write Property: Animation clip's scaling (some don't support this property)
Definition: fbstory.h:1011
FBStoryClip::GhostTravelling
FBPropertyBool GhostTravelling
Read Write Property: Show ghost of clip vector or traveling node
Definition: fbstory.h:1019
FBEventClipChange::Type
FBPropertyStoryClipChangeType Type
Read Only Property: Type of event.
Definition: fbstory.h:286
FBPropertyListStoryFolder::Remove
virtual int Remove(FBStoryFolder *pItem)
Remove folder pItem from property list.
kFBStoryTrackCommand
@ kFBStoryTrackCommand
Command track.
Definition: fbstory.h:89
FBStoryClip::GhostModel
FBPropertyBool GhostModel
Read Write Property: Show ghost of models
Definition: fbstory.h:1018
FBStoryClip::PostBlend
FBPropertyTimeSpan PostBlend
Read Write Property: Start/Stop time of the post-blend phase.
Definition: fbstory.h:981
kFBStoryClipTimeCursor
@ kFBStoryClipTimeCursor
Show the ghost only on time cursor.
Definition: fbstory.h:142
FBStory
Story Management class.
Definition: fbstory.h:535
FBStoryGroupClipAlignmentType
FBStoryGroupClipAlignmentType
Alignment Types when aligning groups.
Definition: fbstory.h:228
FBPropertyTime
class K_DLLIMPORT FBPropertyBase< FBTime, kFBPT_Time > FBPropertyTime
Property: FBTime
Definition: fbproperties.h:1346
FBStoryClipNodeFunction
FBStoryClipNodeFunction
Node function.
Definition: fbstory.h:155
FBStoryClip::Loaded
FBPropertyBool Loaded
Read Write Property: If true, clip file is loaded into memory and can be evaluated (will affect track...
Definition: fbstory.h:1026
FBStoryTrack::Load
void Load(bool pLoad)
Allow to load/unload all story clips under this track.
FBStoryClip::PostBlendData
FBPropertyAnimationNode PostBlendData
Read Only Property: To get the animation of the Post blend curve
Definition: fbstory.h:1024
FBStoryClip::SetAssignSourcesToDestinationsInfo
bool SetAssignSourcesToDestinationsInfo(FBStringList &pEffectiveDstList)
SetAssignSourcesToDestinationsInfo.
FBString
Basic string class.
Definition: fbstring.h:67
FBPropertyListStorySubTrack::GetCount
virtual int GetCount()
Get the number of sub-track.
__FBClassDeclare
#define __FBClassDeclare(Name, Parent)
For internal use only.
Definition: fbcomponent.h:131
FBPropertyAnimatableDouble
class K_DLLIMPORT FBPropertyBaseAnimatable< double, kFBPT_double > FBPropertyAnimatableDouble
FBPropertyBaseAnimatableDouble type definition.
Definition: fbproperties.h:1752
kFBStoryClipTimeWarpInterpolatorSlowingDownReversed
@ kFBStoryClipTimeWarpInterpolatorSlowingDownReversed
'Reversed, Slowing Down' TimeWarp Interpolation
Definition: fbstory.h:255
FBStoryFolder::Load
void Load(bool pLoad)
Allow to load/unload all story clips under this folder.
FBStory::ClipsTextsVisible
FBPropertyBool ClipsTextsVisible
Read Write Property: If true, clips' texts are visible.
Definition: fbstory.h:549
kFBStoryGroupClipAlignmentBeginningNextWithOffset
@ kFBStoryGroupClipAlignmentBeginningNextWithOffset
Align the clips contained in the group clip to the beginning of the next clip, while keeping the rela...
Definition: fbstory.h:231
FBStoryTrack::ShowFrontplate
FBPropertyBool ShowFrontplate
Read Write Property: If true, the frontplate will be shown.
Definition: fbstory.h:751
FBStoryClipTimeWarpInterpolatorType
FBStoryClipTimeWarpInterpolatorType
Types of TimeWrap Interpolator for Story Clips.
Definition: fbstory.h:246
FBPropertyListStoryTrack::RemoveAt
virtual void RemoveAt(int pIndex)
Remove the track at pIndex.
kFBStoryClipAlignmentEndPreviousAllAligned
@ 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
FBStoryGroupClip::FBStoryGroupClip
FBStoryGroupClip(FBArrayTemplate< FBStoryClip * > *pAffectedClipObject, HIObject pObject=NULL)
Constructor.
FBPropertyListStorySubTrack
List: StorySubTrack
Definition: fbstory.h:375
FBPropertyListObject
List of scene objects.
Definition: fbcomponent.h:556
kFBStoryTrackConstraint
@ kFBStoryTrackConstraint
Constraint track.
Definition: fbstory.h:88
FBStoryClip::ShowFrontplate
FBPropertyBool ShowFrontplate
Read Write Property: Enable/Disable the shot frontplate.
Definition: fbstory.h:991
FBStoryFolder::Collapsed
FBPropertyBool Collapsed
Read Write Property: Toggle to collapse or expand the story folder.
Definition: fbstory.h:594
__FB_FORWARD
#define __FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
Definition: fbtypes.h:68
FBEventClipChange::FBEventClipChange
FBEventClipChange(HKEventBase pEvent)
Constructor.
FBStoryTrack::CharacterIndex
FBPropertyInt CharacterIndex
Read Write Property: Character's index to use.
Definition: fbstory.h:747
FBStoryFolder::ConvertClipsToReadOnly
void ConvertClipsToReadOnly(bool pSelected, char *pFilePath)
Convert all clips to read-only clips.
FBEvent
Base Event class.
Definition: fbcomponent.h:940
FBStoryClip::ShotCamera
FBPropertyCamera ShotCamera
Read Write Property: The camera used for that specific shot.
Definition: fbstory.h:987
FBStoryTrack::ChangeDetailsEnd
void ChangeDetailsEnd()
ChangeDetailsEnd.
FBStoryTrackBodyPart
FBStoryTrackBodyPart
Body Parts for story track character.
Definition: fbstory.h:102
kFBStoryTrackShowCurrentTimeAdjacentClips
@ kFBStoryTrackShowCurrentTimeAdjacentClips
Show the ghosts only for the previous clip, current clip, and next clip relative to current time.
Definition: fbstory.h:136
FBSDK_DLL
#define FBSDK_DLL
Be sure that FBSDK_DLL is defined only once...
Definition: fbstory.h:48
FBPropertyVector3d
class K_DLLIMPORT FBPropertyBase< FBVector3d, kFBPT_Vector3D > FBPropertyVector3d
FBPropertyVector3d type definition.
Definition: fbproperties.h:1469
FBStoryGroupClip::MoveTo
FBTime MoveTo(FBTime pTime, bool pForce=true)
MoveTo.
FBStoryClip::GetAffectedAnimationNodes
void GetAffectedAnimationNodes(FBArrayTemplate< FBAnimationNode * > *pAffectedAnimationNodes, FBComponent *pClipObject)
GetAffectedAnimationNodes.
FBStoryClip::MakeWritable
bool MakeWritable()
MakeWritable.
FBPropertyListStorySubTrack::RemoveAt
virtual void RemoveAt(int pIndex)
Remove the sub-track at pIndex.
FBStoryTrack::ParentFolder
FBPropertyStoryFolder ParentFolder
Read Only Property: Parent folder.
Definition: fbstory.h:725
FBStoryClip::ShowBackplate
FBPropertyBool ShowBackplate
Read Write Property: Enable/Disable the shot backplate.
Definition: fbstory.h:990
FBPropertyListStoryDetails::Add
virtual int Add(FBComponent *pItem)
Add a object to the property list.
kFBStoryClipMatchingTranslationDefault
@ kFBStoryClipMatchingTranslationDefault
Uses the matching translation type stored in the Application configuration file: [Story] > MatchTrans...
Definition: fbstory.h:202
FBStoryClip::SetTime
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.
FBStoryClip::GhostCustomTime
FBPropertyTime GhostCustomTime
Read Write Property: Custom time to display ghost, only applicable if ShowGhostClipMode is kFBStoryCl...
Definition: fbstory.h:1022
FBStoryClip::ShowEmbeddedTimecode
FBPropertyBool ShowEmbeddedTimecode
Read Write Property: Whether to show embedded timecode of the clip, if available.
Definition: fbstory.h:1007
FBPropertyListPivot::Add
virtual int Add(FBModel *pItem)
Add a object to the property list.
FBStoryClip::ShotActionStop
FBPropertyTime ShotActionStop
Read Write Property: If not in locked shot mode (time discontinuity enabled), this time can be differ...
Definition: fbstory.h:993
kFBStoryClipAnimSkeletonIk
@ kFBStoryClipAnimSkeletonIk
Solve skeleton inverse kinematic animation.
Definition: fbstory.h:166
FBStoryClip::Color
FBPropertyColor Color
Read Write Property: Color of the clip.
Definition: fbstory.h:975
FBStoryTrack::TrackVideo
FBPropertyVideo TrackVideo
Read Only Property: This FBVideo can be used as a texture.
Definition: fbstory.h:757
FBStoryClip::FrameRate
FBPropertyDouble FrameRate
Read Write Property: Frame rate value. Only effective when UseSystemFrameRate is false.
Definition: fbstory.h:1006
FBStoryClip::Razor
FBStoryClip * Razor(FBTime pTime)
Razor.
FBStoryTrack::GhostModel
FBPropertyBool GhostModel
Read Write Property: Show ghost of models
Definition: fbstory.h:736
FBStoryClip::ClipAudioPath
FBPropertyString ClipAudioPath
Read Write Property: Audio clip's file path
Definition: fbstory.h:998
FBStoryClip::TravellingNodeFunction
FBPropertyStoryClipNodeFunction TravellingNodeFunction
Read Write Property: Travelling node function. If set, this property will overwrite the Track's Trave...
Definition: fbstory.h:1029
FBPropertyListPivot::RemoveAt
virtual void RemoveAt(int pIndex)
Remove the object at pIndex.
kFBStoryClipMatchingTimeBetweenSelectedAndNextClip
@ kFBStoryClipMatchingTimeBetweenSelectedAndNextClip
Matches the selected clip and the next clip at the middle of the blend.
Definition: fbstory.h:191
FBStoryClip::GetFbxScene
fbxsdk ::FbxScene * GetFbxScene()
Get KFbxScene.
FBPropertyListStoryClip
List: StoryClip
Definition: fbstory.h:416
FBStoryFolder::Label
FBPropertyString Label
Read Write Property: Label to display for this story folder.
Definition: fbstory.h:593
FBStoryClip::UseSystemFrameRate
FBPropertyBool UseSystemFrameRate
Read Write Property: Whether always use system frame rate.
Definition: fbstory.h:1005
FBStoryFolder::AlignSelectedClipsGroup
void AlignSelectedClipsGroup(FBStoryGroupClipAlignmentType pType)
Used to align clips inside a group.
kFBStoryGroupClipAlignmentEndPreviousWithOffset
@ kFBStoryGroupClipAlignmentEndPreviousWithOffset
Align the clips contained in the group clip to the end of the previous clip, while keeping the relati...
Definition: fbstory.h:230
FBPropertyListStoryDetails::RemoveAt
virtual void RemoveAt(int pIndex)
Remove the object at pIndex.
FBStoryClip::Offset
FBPropertyTime Offset
Read Write Property: First loop time offset.
Definition: fbstory.h:982
FBStory::MaintainShotAndClipShotLengthsSynced
FBPropertyBool MaintainShotAndClipShotLengthsSynced
Read Write Property: When working in time discontinuity, if true, shots and their corresponding shot ...
Definition: fbstory.h:545
kFBStoryTrackAudio
@ kFBStoryTrackAudio
Audio track.
Definition: fbstory.h:91
FBStoryGroupClip::Razor
void Razor(FBTime pTime)
Razor.
FBStoryTrack::AddClip
void AddClip(FBComponent *pClip, FBTime pTime)
AddClip Add the clip to the track.
FBStoryClip::Rotation
FBPropertyVector3d Rotation
Read Write Property: Animation clip's rotation offset. Refer to class notes to learn more about how t...
Definition: fbstory.h:1013
FBPropertyEvent
PropertyEvent: Base event class.
Definition: fbproperties.h:515
FBStoryClipMatchingTimeType
FBStoryClipMatchingTimeType
Matching Time Types, when matching clips to each other.
Definition: fbstory.h:185
FBStoryFolder::FBDelete
virtual void FBDelete() override
Virtual FBDelete function.
FBStoryClip::LockPitchToSpeed
FBPropertyBool LockPitchToSpeed
Read Write Property: Time-stretching enabled or not.
Definition: fbstory.h:1000
kFBStoryClipAlignmentCurrentTimelineWithOffset
@ kFBStoryClipAlignmentCurrentTimelineWithOffset
Align all selected clips with the current time, while keeping the relative offset.
Definition: fbstory.h:222
kFBStoryClipMirrorPlaneZY
@ kFBStoryClipMirrorPlaneZY
Z-Y plane.
Definition: fbstory.h:172
FBStory::FBStory
FBStory()
Constructor.
kFBStoryClipUpdateUI
@ kFBStoryClipUpdateUI
Clip UI update.
Definition: fbstory.h:241
FBPropertyBool
class K_DLLIMPORT FBPropertyBase< bool, kFBPT_bool > FBPropertyBool
Property: bool
Definition: fbproperties.h:1308
kFBStoryClipMatchingRotationXYZ
@ kFBStoryClipMatchingRotationXYZ
Rotates a selected clip's match object to the same orientation as the previous clip's match object.
Definition: fbstory.h:209
FBStoryClip::Translation
FBPropertyVector3d Translation
Read Write Property: Animation clip's translation offset. Refer to class notes to learn more about ho...
Definition: fbstory.h:1012
FBPropertyListStoryFolder::operator[]
virtual FBStoryFolder * operator[](int pIndex)
Get the folder at pIndex.
kFBStoryClipNodeNone
@ kFBStoryClipNodeNone
None.
Definition: fbstory.h:158
kFBStoryClipMatchingTranslationGravityXZ
@ kFBStoryClipMatchingTranslationGravityXZ
Translates a selected clip's match object along the global X and Z axes.
Definition: fbstory.h:201
FBStoryClip::SolvingMode
FBPropertyStoryClipSolveMode SolvingMode
Read Write Property: Solve Modes for story character clips. See FBStoryClipSolveMode
Definition: fbstory.h:1035
FBStoryTrackGhostShowMode
FBStoryTrackGhostShowMode
Ghost Show Modes for story animation tracks.
Definition: fbstory.h:134
fbcomponent.h
Basic class definitions.
FBStoryGroupClip::StartStopLocked
FBPropertyBool StartStopLocked
Read Write Property: Clip's 'In/Out Locked' property value. True if the clip's In/Out properties (sta...
Definition: fbstory.h:1097
FBStoryClip::Match
void Match()
Match.
FBStoryClip::FBStoryClip
FBStoryClip(const char *pFilePath, FBStoryTrack *pTrack, FBTime pTime, HIObject pObject=NULL)
Constructor.
kFBStoryClipTimeWarpInterpolatorCustom
@ kFBStoryClipTimeWarpInterpolatorCustom
'Custom' TimeWarp Interpolation
Definition: fbstory.h:247
FBStoryClip::CanAssignSourcesToDestinations
bool CanAssignSourcesToDestinations()
CanAssignSourcesToDestinations.
FBStoryClipMatchingTranslationType
FBStoryClipMatchingTranslationType
Matching Translation, Types when matching clips to each other.
Definition: fbstory.h:198
FBStoryClipShowGhostMode
FBStoryClipShowGhostMode
Show Ghost Modes for story animation clips.
Definition: fbstory.h:140
kFBStoryTrackShowAllClips
@ kFBStoryTrackShowAllClips
Show the ghosts for all the clips on the track.
Definition: fbstory.h:135
FBStoryClip::SetReadOnly
bool SetReadOnly(bool pMakeClipReadOnly, FBString pOutputFile=FBString())
SetReadOnly Assigns the clip read-only status.
FBPropertyListStoryTrack::Add
virtual int Add(FBStoryTrack *pItem)
Add a track to the property list.
FBStoryClip::GhostManipulatorMode
FBPropertyStoryClipGhostTimeMode GhostManipulatorMode
Read Write Property: Time mode to display ghost manipulator. See FBStoryClipGhostTimeMode.
Definition: fbstory.h:1030
FBStoryTrack::ShowBackplate
FBPropertyBool ShowBackplate
Read Write Property: If true, the backplate will be shown.
Definition: fbstory.h:750
FBStoryTrack::OffsetEnable
FBPropertyBool OffsetEnable
Read Write Property: When enabled, allow clip to be offset
Definition: fbstory.h:742
kFBStoryClipMoveBlend
@ kFBStoryClipMoveBlend
Clip move blend.
Definition: fbstory.h:240
FBStory::Mute
FBPropertyBool Mute
Read Write Property: If true, the Story mode will be globally disabled.
Definition: fbstory.h:543
kFBStoryClipUser
@ kFBStoryClipUser
User defined compensation.
Definition: fbstory.h:180
kFBStoryClipAnimSkeleton
@ kFBStoryClipAnimSkeleton
Solve skeleton animation.
Definition: fbstory.h:164
kFBStoryClipGhostCustom
@ kFBStoryClipGhostCustom
Show the ghost at custom time of the clip. See GhostManipulatorCustomTime property.
Definition: fbstory.h:151
kFBStoryClipMatchingRotationDefault
@ kFBStoryClipMatchingRotationDefault
Uses the matching translation type stored in the Application configuration file: [Story] > MatchRotat...
Definition: fbstory.h:211
FBStoryTrack::ReferenceMode
FBPropertyStoryTrackRefMode ReferenceMode
Read Write Property: Track composition mode, kFBStoryTrackOverride or kFBStoryTrackAdditive
Definition: fbstory.h:741
kFBStoryTrackShot
@ kFBStoryTrackShot
Shot track.
Definition: fbstory.h:90
kFBStoryClipTimeWarpInterpolatorSmoothedEndsReversed
@ kFBStoryClipTimeWarpInterpolatorSmoothedEndsReversed
'Reversed, Smoothed Ends' TimeWarp Interpolation
Definition: fbstory.h:253
FBStoryClip::ShotBackplate
FBPropertyVideo ShotBackplate
Read Write Property: The backplate used for that specific shot.
Definition: fbstory.h:988
FBConstraint
Base class for constraints.
Definition: fbconstraint.h:134
fbcore.h
Contains definitions for devices, boxes and models.
FBArrayTemplate
Template class to contain an array of items.
Definition: fbarray.h:78
kFBStoryClipTimeWarpInterpolatorSmoothedEnds
@ kFBStoryClipTimeWarpInterpolatorSmoothedEnds
'Smoothed Ends' TimeWarp Interpolation
Definition: fbstory.h:249
FBStoryTrackType
FBStoryTrackType
Types for new story tracks.
Definition: fbstory.h:84
FBStoryTrack::Label
FBPropertyString Label
Read Write Property: Label to display for this story track.
Definition: fbstory.h:719
FB_FORWARD
#define FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
Definition: fbtypes.h:62
FBStory::SummaryClip
FBPropertyBool SummaryClip
Read Write Property: If true, summary clips for story folders will be created to help manipulating fo...
Definition: fbstory.h:546
FBStoryClip::AutoLoop
FBPropertyBool AutoLoop
Read Write Property: If true, clip will automatically loop
Definition: fbstory.h:1015
FBPropertyListStoryDetails::Remove
virtual int Remove(FBComponent *pItem)
Remove object pItem from property list.
FBPropertyListStoryClip::Add
virtual int Add(FBStoryClip *pItem)
Add a clip to the property list.
FBStoryClip::ShowGhostClipMode
FBPropertyStoryClipShowGhostMode ShowGhostClipMode
Read Write Property: Show the ghost depending on the time. See FBStoryClipShowGhostMode
Definition: fbstory.h:1021
FBStoryClip::Ghost
FBPropertyBool Ghost
Read Write Property: Show ghosts
Definition: fbstory.h:1017
FBStoryFolder
Story Folder class.
Definition: fbstory.h:572
FBStoryFolder::Tracks
FBPropertyListStoryTrack Tracks
List: Tracks of this folder.
Definition: fbstory.h:600
FBPropertyListStoryFolder::Add
virtual int Add(FBStoryFolder *pItem)
Add a folder to the property list.
FBPropertyListStoryFolder::GetCount
virtual int GetCount()
Get the number of folder.
kFBStoryClipRetargetSkeleton
@ kFBStoryClipRetargetSkeleton
Solve retarget skeleton.
Definition: fbstory.h:163
kFBStoryTrackCamera
@ kFBStoryTrackCamera
Camera animation track.
Definition: fbstory.h:86
FBStoryClip::ImageSequence
FBPropertyBool ImageSequence
Read Write Property: Whether is a image sequence.
Definition: fbstory.h:1004
FBStoryTrack::Details
FBPropertyListStoryDetails Details
List: All objects associated to this track for processing.
Definition: fbstory.h:729
kFBStoryClipAlignmentCurrentTimeline
@ kFBStoryClipAlignmentCurrentTimeline
Align all selected clips with the current time.
Definition: fbstory.h:217
FBStoryTrack::Type
FBPropertyStoryTrackType Type
Read Only Property: Type of the track
Definition: fbstory.h:718
FB_DEFINE_COMPONENT
FB_DEFINE_COMPONENT(K_DLLIMPORT, AnimationNode)
Animation node class.
kFBStoryClipTimeWarpInterpolatorSlowingDown
@ kFBStoryClipTimeWarpInterpolatorSlowingDown
'Slowing Down' TimeWarp Interpolation
Definition: fbstory.h:251
FBStory::CleanEmptyTracksAndFolders
int CleanEmptyTracksAndFolders()
Remove all empty tracks and folders present in the Story Tool.
FBStoryTrack::GhostShowTrackMode
FBPropertyStoryTrackGhostShowMode GhostShowTrackMode
Read Write Property: Show the ghosts for all the clips or only the adjacent clips....
Definition: fbstory.h:739
kFBStoryClipMatchingRotationNone
@ kFBStoryClipMatchingRotationNone
The clip's match object is not rotated to match another clip's animation.
Definition: fbstory.h:208
FBStoryFolder::Mute
FBPropertyBool Mute
Read Write Property: If true, this story folder will be muted.
Definition: fbstory.h:596
FBPropertyListStoryTrack::Remove
virtual int Remove(FBStoryTrack *pItem)
Remove track pItem from property list.
FBStoryClip::Stop
FBPropertyTime Stop
Read Write Property: Stop time of the clip local to its track.
Definition: fbstory.h:977
FBStoryClip::Loop
FBPropertyBool Loop
Read Write Property: If true, loop clip's animation
Definition: fbstory.h:1016
FBPropertyTimeSpan
class K_DLLIMPORT FBPropertyBase< FBTimeSpan, kFBPT_TimeSpan > FBPropertyTimeSpan
Property: FBTimeSpan
Definition: fbproperties.h:1352
kFBStoryClipNodeFloorProjection
@ kFBStoryClipNodeFloorProjection
Project on XZ plane.
Definition: fbstory.h:157
FBStoryClip::MirrorAnimation
FBPropertyBool MirrorAnimation
Read Write Property: If true, clip animation will be mirrored
Definition: fbstory.h:1036
FBStoryClip::ShotStartStopLocked
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:994
FBStory::RootFolder
FBPropertyStoryFolder RootFolder
Read Only Property: Story's root folder
Definition: fbstory.h:550
FBStoryClip::ExportToFile
bool ExportToFile(FBString pOutputFile)
ExportToFile.
FBPropertyListStoryClip::Remove
virtual int Remove(FBStoryClip *pItem)
Remove clip pItem from property list.
kFBStoryTrackOverride
@ kFBStoryTrackOverride
Override track.
Definition: fbstory.h:97
FBStoryClip::GhostPivot
FBPropertyBool GhostPivot
Read Write Property: Show ghost of match object
Definition: fbstory.h:1020
FBStoryGroupClip::DependentClips
FBPropertyListObject DependentClips
Read Write Property: Clips that are included in the group clip.
Definition: fbstory.h:1098
kFBStoryClipAlways
@ kFBStoryClipAlways
Always show the ghost.
Definition: fbstory.h:141
FBStoryClipCompMode
FBStoryClipCompMode
Compensation Modes for story character clips.
Definition: fbstory.h:177
FBStoryClip::Clone
FBStoryClip * Clone()
Clone the clip.
kFBStoryClipAnimFkIk
@ kFBStoryClipAnimFkIk
Solve forward and inverse kinematic animation.
Definition: fbstory.h:165
FBStory::TheOne
static FBStory & TheOne()
Get the global story object.
FBStoryClip::TravellingNode
FBPropertyListObject TravellingNode
List: Travelling node(s). If set, this property will overwrite the Track's Travelling node(s).
Definition: fbstory.h:1028
FBStoryTrack::AudioOutIndex
FBPropertyInt AudioOutIndex
Read Write Property: Audio Output's index to use.
Definition: fbstory.h:754
FBPropertyString
Property class: const char * (String).
Definition: fbproperties.h:1281
FBStoryClip::Match
void Match(FBString pObjectName, FBStoryClipMatchingTimeType pTimeType, FBStoryClipMatchingTranslationType pTranslationType, FBStoryClipMatchingRotationType pRotationType)
Match.
FBModel
Model class.
Definition: fbmodel.h:274
FBComponent
MotionBuilder SDK base class.
Definition: fbcomponent.h:651
FBStory::NoneBlockingPostprocess
FBPropertyBool NoneBlockingPostprocess
Read Write Property: If true, record to disk will post process recorded data in low priority thread w...
Definition: fbstory.h:548
FBPropertyListStoryDetails
List: Story track Details
Definition: fbstory.h:455
FBStoryClipGhostTimeMode
FBStoryClipGhostTimeMode
Time mode to display ghost.
Definition: fbstory.h:147
FBPropertyListPivot::operator[]
virtual FBModel * operator[](int pIndex)
Get the object at pIndex.
FBStoryClip::DestinationSetObject
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...
kFBStoryClipMatchingTimeStartOfSelectedClip
@ kFBStoryClipMatchingTimeStartOfSelectedClip
Matches the start of the selected clip to the start of the blend with the previous clip.
Definition: fbstory.h:187
FBStoryClip::FBStoryClip
FBStoryClip(const char *pFilePath, FBStoryTrack *pTrack, FBTime pTime, FBTime pTimeOffset, HIObject pObject=NULL)
Constructor.
FBStoryClipAlignmentType
FBStoryClipAlignmentType
Alignment Types when aligning clips.
Definition: fbstory.h:216
FBStoryTrack::ParentTrack
FBPropertyStoryTrack ParentTrack
Read Only Property: Parent track, if the track is of Character or Animation type.
Definition: fbstory.h:726
kFBStoryClipGhostStart
@ kFBStoryClipGhostStart
Show the ghost at start time of the clip.
Definition: fbstory.h:149
FBStoryTrack::AcceptKey
FBPropertyBool AcceptKey
Read Write Property: Allow track to accept keys
Definition: fbstory.h:740
FBPropertyListStorySubTrack::Add
virtual int Add(FBStoryTrack *pItem)
Add a sub-track to the property list.
FBStoryClip::GetReadOnly
bool GetReadOnly()
GetReadOnly Retrieves the clip read-only status.
FBStoryClipMirrorPlane
FBStoryClipMirrorPlane
Several mirror planes to mirror animation.
Definition: fbstory.h:170
kFBStoryTrackAdditive
@ kFBStoryTrackAdditive
Additive track.
Definition: fbstory.h:98
kFBStoryClipAlignmentEndPrevious
@ kFBStoryClipAlignmentEndPrevious
Align selected clips to the end of the previous clip.
Definition: fbstory.h:218
FBStoryFolder::AlignSelectedClips
void AlignSelectedClips(FBStoryClipAlignmentType pType, FBComponent *pReferenceClip)
Used to align selected clips .
FBStoryGroupClip::FBDelete
virtual void FBDelete() override
Virtual FBDelete function.
FBStoryTrack::IsBodyPartEnabled
bool IsBodyPartEnabled(FBStoryTrackBodyPart pPart)
IsBodyPartEnabled.