fbsdk/fbstory.h Source File

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 
69 __FB_FORWARD( FBStory );
70 __FB_FORWARD( FBStoryFolder );
71 __FB_FORWARD( FBStoryTrack );
72 __FB_FORWARD( FBStoryClip );
73 __FB_FORWARD( FBStoryGroupClip );
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 
104 
106 
113 
118 
121 
123 
127 
129 
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 
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:
542  FBStory();
552 
556  int CleanEmptyTracksAndFolders();
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();
587 
591  void Load(bool pLoad);
592 
601 
606  void AlignSelectedClips(FBStoryClipAlignmentType pType, FBComponent* pReferenceClip);
607 
611  void AlignSelectedClipsGroup(FBStoryGroupClipAlignmentType pType);
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();
665 
669  void ChangeDetailsBegin();
670 
674  void ChangeDetailsEnd();
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 
698  bool IsBodyPartEnabled(FBStoryTrackBodyPart pPart);
699 
703  void AddClip(FBComponent* pClip, FBTime pTime);
704 
710  FBStoryTrack* CreateSubTrack(FBStoryTrackType pTrackType, FBStoryTrackRefMode pRefMode);
711 
715  void Load(bool pLoad);
716 
717  //--- All track properties ----------------------------------------------------------------------------------------------------------
730 
731  //--- Animation and Constraint track properties -------------------------------------------------------------------------------------
733 
734  //--- Animation track properties ----------------------------------------------------------------------------------------------------
744 
745  //--- Character track properties ----------------------------------------------------------------------------------------------------
748 
749  //--- Shot track properties ---------------------------------------------------------------------------------------------------------
752 
753  //--- Audio track properties --------------------------------------------------------------------------------------------------------
755 
756  //--- Video track properties --------------------------------------------------------------------------------------------------------
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();
811 
814  FBStoryClip* Clone();
815 
822  FBTime Move(FBTime pDelta, bool pForce=true);
823 
830  FBTime MoveTo(FBTime pTime, bool pForce=true);
831 
837  FBStoryClip* Razor(FBTime pTime);
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 
894  void GetAffectedObjects( FBArrayTemplate<FBComponent*>* pAffectedObjects );
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 
941  bool CanAssignSourcesToDestinations();
942 
952  void GetAssignSourcesToDestinationsInfo( FBStringList& pSrcList, FBStringList& pAvailableDstList, FBStringList& pDefaultDstList, FBStringList& pEffectiveDstList );
953 
962  bool SetAssignSourcesToDestinationsInfo( FBStringList& pEffectiveDstList );
963 
967  FBXSDK_NAMESPACE::FbxScene* GetFbxScene();
968 
972  bool UpdateFromCurrentTake();
973 
974  //--- All clip properties -----------------------------------------------------------------------------------------------------------
984 
985  //--- Shot clip properties ----------------------------------------------------------------------------------------------------------
993 
994  //--- Audio clip properties ---------------------------------------------------------------------------------------------------------
999 
1000  //--- Video clip properties ---------------------------------------------------------------------------------------------------------
1006 
1007  //--- Animation clip properties -----------------------------------------------------------------------------------------------------
1031 
1032  //--- Character clip properties -----------------------------------------------------------------------------------------------------
1036 
1038 
1039  //--- Character and shot clip properties -----------------------------------------------------------------------------------------------------
1044 
1045 private:
1046  void FBStoryClipInitProperties();
1047 };
1048 
1050 // FBStoryGroupClip
1052 
1056 {
1057  //--- Open Reality declaration.
1059 public:
1060 
1065  FBStoryGroupClip(FBArrayTemplate<FBStoryClip*>* pAffectedClipObject, HIObject pObject=NULL);
1066 
1069  virtual void FBDelete();
1070 
1077  FBTime Move(FBTime pDelta, bool pForce=true);
1078 
1085  FBTime MoveTo(FBTime pTime, bool pForce=true);
1086 
1091  void Razor(FBTime pTime);
1092 
1096 
1097 private:
1098  void FBStoryClipInitProperties();
1099 };
1100 
1101 #ifdef FBSDKUseNamespace
1102  }
1103 #endif
1104 #endif /* this must be the last line of this file */
FBPropertyBool GhostPivot
Read Write Property: Show ghost of match object
Definition: fbstory.h:1018
PropertyEvent: Base event class.
Definition: fbproperties.h:507
Solve skeleton animation.
Definition: fbstory.h:164
Story Management class.
Definition: fbstory.h:534
FBPropertyBool NoneBlockingPostprocess
Read Write Property: If true, record to disk will post process recorded data in low priority thread w...
Definition: fbstory.h:548
FBStoryClipSolveMode
Solve Modes for story character clips.
Definition: fbstory.h:162
Align the clips contained in the group clip with the current time.
Definition: fbstory.h:229
#define __FBClassDeclare(Name, Parent)
For internal use only.
Definition: fbcomponent.h:132
FBPropertyBool GhostTravelling
Read Write Property: Show ghost of clip vector or traveling node
Definition: fbstory.h:737
FBPropertyBool LockedShot
Read Write Property: If true, shots will be locked (no time discontinuity).
Definition: fbstory.h:544
'Normal' TimeWarp Interpolation
Definition: fbstory.h:248
Model class.
Definition: fbmodel.h:273
FBPropertyString Label
Read Write Property: Label to display for this story track.
Definition: fbstory.h:719
Matches the start of the selected clip to the start of the blend with the previous clip...
Definition: fbstory.h:187
FBPropertyStoryFolder Parent
Read Only Property: Object pointing to the folder's parent.
Definition: fbstory.h:598
FBPropertyString ClipNameConvention
Read Write Property: Naming convention for each new recording clip that is created.
Definition: fbstory.h:723
FBPropertyTime Start
Read Write Property: Start time of the clip local to its track.
Definition: fbstory.h:976
FBPropertyColor Color
Read Write Property: Color of the clip.
Definition: fbstory.h:975
Solve skeleton inverse kinematic animation.
Definition: fbstory.h:166
Solve forward and inverse kinematic animation.
Definition: fbstory.h:165
Story Folder class.
Definition: fbstory.h:571
Translates a selected clip's match object to the same location as the previous clip's match object...
Definition: fbstory.h:200
FBPropertyBool Collapsed
Read Write Property: Toggle to collapse or expand the story folder.
Definition: fbstory.h:594
class FBPropertyBaseEnum< enum FBStoryClipGhostTimeMode > FBPropertyStoryClipGhostTimeMode
Definition: fbstory.h:263
FBPropertyAnimationNode PostBlendData
Read Only Property: To get the animation of the Post blend curve
Definition: fbstory.h:1022
FBStoryClipGhostTimeMode
Time mode to display ghost.
Definition: fbstory.h:147
FBPropertyEvent OnChange
Event: Something in the clip has changed.
Definition: fbstory.h:1037
#define FB_DEFINE_COMPONENT(DllTag, Type)
Define a component and give it the ability to be a property.
Definition: fbproperties.h:139
class FBPropertyBaseComponent< FBVideo * > FBPropertyVideo
Definition: fbstory.h:80
FBPropertyStoryClipShowGhostMode ShowGhostClipMode
Read Write Property: Show the ghost depending on the time.
Definition: fbstory.h:1019
Property class: const char * (String).
FBPropertyListStoryTrack Tracks
List: Tracks of this folder.
Definition: fbstory.h:600
Time data structure.
Definition: fbtime.h:86
FBPropertyTimeSpan PostBlend
Read Write Property: Start/Stop time of the post-blend phase.
Definition: fbstory.h:981
'Smoothed Ends' TimeWarp Interpolation
Definition: fbstory.h:249
FBPropertyStoryClipSolveMode SolvingMode
Read Write Property: Solve Modes for story character clips.
Definition: fbstory.h:1033
Basic string class.
Definition: fbstring.h:66
FBPropertyString Label
Read Write Property: Label to display for this story folder.
Definition: fbstory.h:593
FBPropertyAudioClip AudioClip
Read Only Property: The audio clip used by this StoryClip.
Definition: fbstory.h:995
FBPropertyTime GhostManipulatorCustomTime
Read Write Property: Custom time to display ghost manipulator, only applicable if GhostManipulatorMod...
Definition: fbstory.h:1029
FBPropertyBool GhostModel
Read Write Property: Show ghost of models
Definition: fbstory.h:1016
FBPropertyVector3d GhostManipulatorOffset
Read Write Property: Animation clip's ghost manipulator offset.
Definition: fbstory.h:1025
Story Track class.
Definition: fbstory.h:642
FBPropertyBool ConnectedToTake
Read Write Property: When connected to current take, user can do updating from current take...
Definition: fbstory.h:1030
FBPropertyStoryClipMirrorPlane MirrorPlane
Read Write Property: Several mirror planes to mirror animation.
Definition: fbstory.h:1035
class FBPropertyBaseComponent< FBAudioClip * > FBPropertyAudioClip
Definition: fbaudio.h:63
FBPropertyBool ShowBackplate
Read Write Property: If true, the backplate will be shown.
Definition: fbstory.h:750
User defined compensation.
Definition: fbstory.h:180
class FBPropertyBaseEnum< enum FBStoryClipChangeType > FBPropertyStoryClipChangeType
Definition: fbstory.h:258
Always show the ghost.
Definition: fbstory.h:141
FBPropertyString ClipAnimationPath
Read Write Property: Animation clip's file path
Definition: fbstory.h:1008
FBPropertyBool OffsetEnable
Read Write Property: When enabled, allow clip to be offset
Definition: fbstory.h:742
FBStoryTrackType
Types for new story tracks.
Definition: fbstory.h:84
FBPropertyBool Mute
Read Write Property: If true, the Story mode will be globally disabled.
Definition: fbstory.h:543
List: StoryClip
Definition: fbstory.h:415
A take is a container for animation in a scene.
Definition: fbdata.h:1692
Align selected clips to the beginning of the next clip.
Definition: fbstory.h:220
FBStoryClipMatchingRotationType
Matching Rotation Types, when matching clips to each other.
Definition: fbstory.h:206
Show the ghost at stop time of the clip.
Definition: fbstory.h:150
FBPropertyString RecordClipPath
Read Write Property: Path for story recording.
Definition: fbstory.h:722
FBPropertyStoryClipChangeType Type
Read Only Property: Type of event.
Definition: fbstory.h:286
List: StoryTrack
Definition: fbstory.h:333
FBPropertyBool Loop
Read Write Property: If true, loop clip's animation
Definition: fbstory.h:1014
List: Story Clip pivot models
Definition: fbstory.h:491
FBPropertyStoryFolder ParentFolder
Read Only Property: Parent folder.
Definition: fbstory.h:725
#define NULL
Definition: kaydara.h:179
FBVideo and derivative classes.
class FBPropertyBaseEnum< enum FBStoryClipNodeFunction > FBPropertyStoryClipNodeFunction
Definition: fbstory.h:264
Template class to contain an array of items.
Definition: fbarray.h:77
FBStoryTrackBodyPart
Body Parts for story track character.
Definition: fbstory.h:102
FBPropertyBool GhostPivot
Read Write Property: Show ghost of match object
Definition: fbstory.h:738
Show the ghost only on time cursor.
Definition: fbstory.h:142
FBPropertyStoryTrackGhostShowMode GhostShowTrackMode
Read Write Property: Show the ghosts for all the clips or only the adjacent clips.
Definition: fbstory.h:739
FBPropertyAnimationNode PreBlendData
Read Only Property: To get the animation of the Pre blend curve
Definition: fbstory.h:1021
class FBPropertyBaseComponent< FBCharacter * > FBPropertyCharacter
Solve retarget skeleton.
Definition: fbstory.h:163
Align selected clips to the end of the previous clip, while keeping the relative offset.
Definition: fbstory.h:223
FBStoryClipShowGhostMode
Show Ghost Modes for story animation clips.
Definition: fbstory.h:140
class FBPropertyBaseEnum< enum FBStoryTrackType > FBPropertyStoryTrackType
Definition: fbstory.h:259
FBPropertyTime MarkIn
Read Write Property: Start time inside the clip.
Definition: fbstory.h:978
FBPropertyBool ShowBackplate
Read Write Property: Enable/Disable the shot backplate.
Definition: fbstory.h:989
class FBPropertyBase< int, kFBPT_int > FBPropertyInt
Property: int
'Slowing Down' TimeWarp Interpolation
Definition: fbstory.h:251
FBPropertyVideo ShotFrontplate
Read Write Property: The frontplate used for that specific shot.
Definition: fbstory.h:988
Translates a selected clip's match object along the global X and Z axes.
Definition: fbstory.h:201
FBPropertyDouble Speed
Read Write Property: Speed of the clip.
Definition: fbstory.h:983
FBPropertyTime ShotActionStart
Read Write Property: If not in locked shot mode (time discontinuity enabled), this time can be differ...
Definition: fbstory.h:991
class FBPropertyBase< FBColor, kFBPT_ColorRGB > FBPropertyColor
FBPropertyColor type definition.
Contains definitions for devices, boxes and models.
FBStoryGroupClipAlignmentType
Alignment Types when aligning groups.
Definition: fbstory.h:228
FBPropertyDouble ClipPitch
Read Write Property: The clip pitch value.
Definition: fbstory.h:997
FBPropertyVideo TrackVideo
Read Only Property: This FBVideo can be used as a texture.
Definition: fbstory.h:757
Base Event class.
Definition: fbcomponent.h:955
FBPropertyCamera ShotCamera
Read Write Property: The camera used for that specific shot.
Definition: fbstory.h:986
Base class for Cameras.
FBPropertyDouble FrameRate
Read Write Property: Frame rate value.
Definition: fbstory.h:1004
Show the ghost at start time of the clip.
Definition: fbstory.h:149
List: StoryFolder
Definition: fbstory.h:291
Show the ghosts for all the clips on the track.
Definition: fbstory.h:135
List: StorySubTrack
Definition: fbstory.h:374
FBPropertyBool RecordTrack
Read Write Property: Path for story recording.
Definition: fbstory.h:724
#define FB_DEFINE_ENUM(DllTag, Type)
Define an enum and give it the ability to be a property.
Definition: fbproperties.h:148
Camera animation track.
Definition: fbstory.h:86
class FBPropertyBaseEnum< enum FBStoryTrackRefMode > FBPropertyStoryTrackRefMode
Definition: fbstory.h:260
Align the clips contained in the group clip to the beginning of the next clip, while keeping the rela...
Definition: fbstory.h:231
FBPropertyBool PassThrough
Read Write Property: Enable passthrough of animation if there is no clip on track animation is taken ...
Definition: fbstory.h:743
FBPropertyBool AcceptKey
Read Write Property: Allow track to accept keys
Definition: fbstory.h:740
class FBPropertyBaseEnum< enum FBStoryClipShowGhostMode > FBPropertyStoryClipShowGhostMode
Definition: fbstory.h:262
FBPropertyBool GhostTravelling
Read Write Property: Show ghost of clip vector or traveling node
Definition: fbstory.h:1017
FBPropertyBool TimeWarpReverse
Read Write Property: If true, reverse the Animation or Shot clip's TimeWarp FCurve.
Definition: fbstory.h:1042
FBPropertyTime GhostCustomTime
Read Write Property: Custom time to display ghost, only applicable if ShowGhostClipMode is kFBStoryCl...
Definition: fbstory.h:1020
Uses the matching translation type stored in the Application configuration file: [Story] > MatchTrans...
Definition: fbstory.h:202
FBPropertyStoryFolder RootFolder
Read Only Property: Story's root folder
Definition: fbstory.h:550
#define FBXSDK_NAMESPACE
Definition: fbstory.h:58
FBPropertyStoryClipTimeWarpInterpolatorType TimeWarpInterpolatorType
Read Write Property: Animation and Shot clip's TimeWarp interpolation type.
Definition: fbstory.h:1041
FBPropertyVideo ShotBackplate
Read Write Property: The backplate used for that specific shot.
Definition: fbstory.h:987
Align the clips contained in the group clip to the end of the previous clip, while keeping the relati...
Definition: fbstory.h:230
FBPropertyString ClipAudioPath
Read Write Property: Audio clip's file path
Definition: fbstory.h:996
Matches the start of the selected clip to the previous/next clip at the current time.
Definition: fbstory.h:186
FBPropertyBool UseSystemFrameRate
Read Write Property: Whether always use system frame rate.
Definition: fbstory.h:1003
FBPropertyString RecordClipPath
Read Write Property: Path for story recording.
Definition: fbstory.h:597
'Custom' TimeWarp Interpolation
Definition: fbstory.h:247
FBPropertyVector3d LoopTranslation
Read Write Property: Animation clip's loop translation.
Definition: fbstory.h:1012
FBPropertyInt AudioOutIndex
Read Write Property: Audio Output's index to use.
Definition: fbstory.h:754
FBPropertyListStorySubTrack SubTracks
List: Only Character and Animation tracks can have sub-tracks.
Definition: fbstory.h:727
Align all selected clips with the current time, while keeping the relative offset.
Definition: fbstory.h:222
FBPropertyTimeSpan PreBlend
Read Write Property: Start/Stop time of the pre-blend phase.
Definition: fbstory.h:980
FBPropertyBool SummaryClip
Read Write Property: If true, summary clips for story folders will be created to help manipulating fo...
Definition: fbstory.h:546
Rotates a selected clip's match object to the same orientation as the previous clip's match object...
Definition: fbstory.h:209
FBPropertyBool AutoLoop
Read Write Property: If true, clip will automatically loop
Definition: fbstory.h:1013
'Reversed, Smoothed Ends' TimeWarp Interpolation
Definition: fbstory.h:253
class FBPropertyBaseComponent< FBAnimationNode * > FBPropertyAnimationNode
Definition: fbdata.h:1044
FBPropertyStoryClipGhostTimeMode GhostManipulatorMode
Read Write Property: Time mode to display ghost manipulator.
Definition: fbstory.h:1028
Story Clip class.
Definition: fbstory.h:777
FBPropertyBool RecordToDisk
Read Write Property: If true, record to story will record directly to disk.
Definition: fbstory.h:547
Definition: Python-ast.h:18
Align selected clips to the end of the previous clip.
Definition: fbstory.h:218
FBPropertyBool Ghost
Read Write Property: Show ghosts
Definition: fbstory.h:1015
Matches the selected clip and the next clip at the middle of the blend.
Definition: fbstory.h:191
FBStoryClipMatchingTimeType
Matching Time Types, when matching clips to each other.
Definition: fbstory.h:184
FBPropertyCharacter Character
Read Write Property: Character to use.
Definition: fbstory.h:746
FBPropertyTime MarkOut
Read Write Property: Stop time inside the clip.
Definition: fbstory.h:979
FBPropertyBool Solo
Read Write Property: If true, this story folder will be the only one to play.
Definition: fbstory.h:595
FBPropertyTime ShotActionStop
Read Write Property: If not in locked shot mode (time discontinuity enabled), this time can be differ...
Definition: fbstory.h:992
class FBPropertyBaseComponent< FBStoryTrack * > FBPropertyStoryTrack
Definition: fbstory.h:76
class FBPropertyBaseEnum< enum FBStoryClipMirrorPlane > FBPropertyStoryClipMirrorPlane
Definition: fbstory.h:266
#define __FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
Definition: fbtypes.h:68
Uses the matching translation type stored in the Application configuration file: [Story] > MatchRotat...
Definition: fbstory.h:211
FBPropertyStoryTrack ParentTrack
Read Only Property: Parent track, if the track is of Character or Animation type. ...
Definition: fbstory.h:726
FBPropertyDouble Scale
Read Write Property: Animation clip's scaling (some don't support this property)
Definition: fbstory.h:1009
Show the ghost at custom time of the clip.
Definition: fbstory.h:151
FBStoryClipMirrorPlane
Several mirror planes to mirror animation.
Definition: fbstory.h:170
FBPropertyBool Ghost
Read Write Property: Show ghosts
Definition: fbstory.h:735
FBPropertyListStoryClip Clips
List: Clips contained in this track.
Definition: fbstory.h:728
class FBPropertyBaseComponent< FBStoryFolder * > FBPropertyStoryFolder
Definition: fbstory.h:75
No compensation.
Definition: fbstory.h:178
TimeSpan class.
Definition: fbtime.h:381
List: Story track Details
Definition: fbstory.h:454
FBStoryTrackGhostShowMode
Ghost Show Modes for story animation tracks.
Definition: fbstory.h:134
#define FBSDKNamespace
FBSDKNamespace define.
Definition: fbversion.h:64
Align selected clips to the beginning of the next clip, all clips will be align to the selected clip ...
Definition: fbstory.h:221
FBPropertyListStoryDetails Details
List: All objects associated to this track for processing.
Definition: fbstory.h:729
FBPropertyBool Solo
Read Write Property: If true, this track will be the only one to play.
Definition: fbstory.h:721
FBPropertyListObject DependentClips
Read Write Property: Clips that are included in the group clip.
Definition: fbstory.h:1095
PropertyList: Component.
Definition: fbcomponent.h:490
FBPropertyBool ImageSequence
Read Write Property: Whether is a image sequence.
Definition: fbstory.h:1002
FBPropertyBool MaintainShotAndClipShotLengthsSynced
Read Write Property: When working in time discontinuity, if true, shots and their corresponding shot ...
Definition: fbstory.h:545
Basic class definitions.
FBPropertyListStoryFolder Childs
List: Children folders of this folder.
Definition: fbstory.h:599
List of scene objects.
Definition: fbcomponent.h:569
FBPropertyBool Loaded
Read Write Property: If true, clip file is loaded into memory and can be evaluated (will affect track...
Definition: fbstory.h:1024
class FBPropertyBase< FBVector3d, kFBPT_Vector3D > FBPropertyVector3d
FBPropertyVector3d type definition.
class FBPropertyBase< FBTimeSpan, kFBPT_TimeSpan > FBPropertyTimeSpan
Property: FBTimeSpan
FBStoryClipCompMode
Compensation Modes for story character clips.
Definition: fbstory.h:177
KEventBase * HKEventBase
Definition: fbcomponent.h:75
Story Group Clip class.
Definition: fbstory.h:1055
Base class for constraints.
Definition: fbconstraint.h:134
FBPropertyTime Stop
Read Write Property: Stop time of the clip.
Definition: fbstory.h:1094
#define FBSDK_DLL
Be sure that FBSDK_DLL is defined only once...
Definition: fbstory.h:48
FBPropertyBool ShowFrontplate
Read Write Property: If true, the frontplate will be shown.
Definition: fbstory.h:751
The clip's match object is not translated to match another clip's animation.
Definition: fbstory.h:199
class FBPropertyBaseComponent< FBCamera * > FBPropertyCamera
Definition: fbcamera.h:58
'Going Faster' TimeWarp Interpolation
Definition: fbstory.h:250
Show the ghosts only for the previous clip, current clip, and next clip relative to current time...
Definition: fbstory.h:136
class FBPropertyBaseEnum< enum FBStoryClipSolveMode > FBPropertyStoryClipSolveMode
Definition: fbstory.h:265
FBStoryClipTimeWarpInterpolatorType
Types of TimeWrap Interpolator for Story Clips.
Definition: fbstory.h:246
MotionBuilder SDK base class.
Definition: fbcomponent.h:664
'Reversed, Going Faster' TimeWarp Interpolation
Definition: fbstory.h:254
class FBPropertyBase< double, kFBPT_double > FBPropertyDouble
Property: double
Character animation track.
Definition: fbstory.h:87
#define FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
Definition: fbtypes.h:62
Automatic compensation.
Definition: fbstory.h:179
String list.
Definition: fbstring.h:201
FBStoryClipAlignmentType
Alignment Types when aligning clips.
Definition: fbstory.h:216
'Reversed, Slowing Down' TimeWarp Interpolation
Definition: fbstory.h:255
FBPropertyAnimatableDouble Weight
Read Write Property: Control the blend amount.
Definition: fbstory.h:732
Align selected clips to the beginning of the next clip, while keeping the relative offset...
Definition: fbstory.h:224
Align selected clips to the end of the previous clip, all clips will be align to the selected clip po...
Definition: fbstory.h:219
The clip's match object is not rotated to match another clip's animation.
Definition: fbstory.h:208
class FBPropertyBaseAnimatable< double, kFBPT_double > FBPropertyAnimatableDouble
FBPropertyBaseAnimatableDouble type definition.
class FBPropertyBase< FBTime, kFBPT_Time > FBPropertyTime
Property: FBTime
FBPropertyAnimationNode CustomTimeWarp
Read Only Property: Animation and Shot clip's custom TimeWarp FCurve.
Definition: fbstory.h:1043
Matches the selected clip and the previous clip at the middle of the blend.
Definition: fbstory.h:188
FBPropertyBool LockPitchToSpeed
Read Write Property: Time-stretching enabled or not.
Definition: fbstory.h:998
FBPropertyTime Offset
Read Write Property: First loop time offset.
Definition: fbstory.h:982
FBPropertyBool GhostModel
Read Write Property: Show ghost of models
Definition: fbstory.h:736
Align all selected clips with the current time.
Definition: fbstory.h:217
FBStoryClipMatchingTranslationType
Matching Translation, Types when matching clips to each other.
Definition: fbstory.h:197
FBPropertyTime Stop
Read Write Property: Stop time of the clip local to its track.
Definition: fbstory.h:977
FBPropertyTime Start
Read Write Property: Start time of the clip.
Definition: fbstory.h:1093
FBPropertyBool ShowFrontplate
Read Write Property: Enable/Disable the shot frontplate.
Definition: fbstory.h:990
Matches the start of the blend with the selected clip to the start of the next clip.
Definition: fbstory.h:190
FBPropertyListPivot Pivots
List: Pivots models (Generally, only one model is necessary)
Definition: fbstory.h:1023
FBPropertyStoryTrackType Type
Read Only Property: Type of the track
Definition: fbstory.h:718
Matches the end of the blend with the selected clip to the end of the previous clip.
Definition: fbstory.h:189
FBStoryClipChangeType
Types of clip change events, matching KEventClip.eType Expose only kFBStoryClipMoveClip and kFBStoryC...
Definition: fbstory.h:236
FBPropertyBool MirrorAnimation
Read Write Property: If true, clip animation will be mirrored
Definition: fbstory.h:1034
FBPropertyBool Mute
Read Write Property: If true, this track wont' play.
Definition: fbstory.h:720
FBPropertyBool ShowEmbeddedTimecode
Read Write Property: Whether to show embedded timecode of the clip, if available. ...
Definition: fbstory.h:1005
FBStoryClipNodeFunction
Node function.
Definition: fbstory.h:155
class FBPropertyBaseEnum< enum FBStoryTrackGhostShowMode > FBPropertyStoryTrackGhostShowMode
Definition: fbstory.h:261
FBPropertyInt CharacterIndex
Read Write Property: Character's index to use.
Definition: fbstory.h:747
Show the ghost at current time of the clip.
Definition: fbstory.h:148
Rotates a selected clip's match object around the global Y axis.
Definition: fbstory.h:210
FBPropertyVector3d Rotation
Read Write Property: Animation clip's rotation offset.
Definition: fbstory.h:1011
FBPropertyVector3d Translation
Read Write Property: Animation clip's translation offset.
Definition: fbstory.h:1010
Matches the end of the selected clip to the end of the blend with the previous clip.
Definition: fbstory.h:192
FBPropertyString ClipVideoPath
Read Write Property: Video clip's file path
Definition: fbstory.h:1001
FBPropertyListObject TravellingNode
List: Travelling node(s).
Definition: fbstory.h:1026
FBPropertyBool TimeWarpEnabled
Read Write Property: Animation and Shot clip's TimeWarp activeness.
Definition: fbstory.h:1040
FBPropertyStoryClipNodeFunction TravellingNodeFunction
Read Write Property: Travelling node function.
Definition: fbstory.h:1027
Show the ghost for custom time frame.
Definition: fbstory.h:143
FBPropertyStoryTrackRefMode ReferenceMode
Read Write Property: Track composition mode, kFBStoryTrackOverride or kFBStoryTrackAdditive ...
Definition: fbstory.h:741
class FBPropertyBaseEnum< enum FBStoryClipTimeWarpInterpolatorType > FBPropertyStoryClipTimeWarpInterpolatorType
Definition: fbstory.h:269
FBPropertyStoryFolder RootEditFolder
Read Only Property: Story's root edit folder
Definition: fbstory.h:551
FBStoryTrackRefMode
References Modes for story animation tracks.
Definition: fbstory.h:96
FBPropertyBool Mute
Read Write Property: If true, this story folder will be muted.
Definition: fbstory.h:596
class FBPropertyBase< bool, kFBPT_bool > FBPropertyBool
Property: bool
Uses the matching time type stored in the Application configuration file: [Story] > MatchWhen...
Definition: fbstory.h:193
FBPropertyBool ClipsTextsVisible
Read Write Property: If true, clips' texts are visible.
Definition: fbstory.h:549