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 #include <fbxsdk/fbxsdk_nsbegin.h>
58  class FbxScene;
59 #include <fbxsdk/fbxsdk_nsend.h>
60 
61 #ifdef FBSDKUseNamespace
62  namespace FBSDKNamespace {
63 #endif
64 
65 __FB_FORWARD( FBStory );
66 __FB_FORWARD( FBStoryFolder );
67 __FB_FORWARD( FBStoryTrack );
68 __FB_FORWARD( FBStoryClip );
69 __FB_FORWARD( FBStoryGroupClip );
74 FB_DEFINE_COMPONENT( FBSDK_DLL, StoryGroupClip );
75 FB_DEFINE_COMPONENT( FBSDK_DLL, AnimationNode );
77 FB_DEFINE_COMPONENT( FBSDK_DLL, AudioClip );
78 
89 };
90 
95 };
96 
100 
102 
109 
114 
117 
119 
123 
125 
127 };
128 
133 };
134 
140 };
141 
148 };
149 
155 };
156 
163 };
164 
170 };
171 
177 };
178 
181 {
190 };
191 
194 {
199 };
200 
203 {
208 };
209 
210 
221 };
222 
228 };
229 
239 };
240 
252 };
253 
254 FB_DEFINE_ENUM(FBSDK_DLL, StoryClipChangeType );
255 FB_DEFINE_ENUM(FBSDK_DLL, StoryTrackType);
256 FB_DEFINE_ENUM(FBSDK_DLL, StoryTrackRefMode);
257 FB_DEFINE_ENUM(FBSDK_DLL, StoryTrackGhostShowMode);
258 FB_DEFINE_ENUM(FBSDK_DLL, StoryClipShowGhostMode);
259 FB_DEFINE_ENUM(FBSDK_DLL, StoryClipGhostTimeMode);
260 FB_DEFINE_ENUM(FBSDK_DLL, StoryClipNodeFunction);
261 FB_DEFINE_ENUM(FBSDK_DLL, StoryClipSolveMode);
262 FB_DEFINE_ENUM(FBSDK_DLL, StoryClipMirrorPlane);
263 FB_DEFINE_ENUM(FBSDK_DLL, StoryClipCompMode);
264 FB_DEFINE_ENUM(FBSDK_DLL, StoryClipAlignmentType);
265 FB_DEFINE_ENUM(FBSDK_DLL, StoryClipTimeWarpInterpolatorType);
266 
267 
269 // FBClipEvent
271 
273 
275 {
276  public:
280  FBEventClipChange( HKEventBase pEvent );
281 
283 };
284 
288 {
289 public:
295  virtual int Add(FBStoryFolder* pItem);
296 
302  virtual int Remove(FBStoryFolder* pItem);
303 
307  virtual void RemoveAt(int pIndex);
308 
313  virtual FBStoryFolder* operator[](int pIndex);
314 
318  virtual int GetCount();
319 
320 #ifndef DOXYGEN_SHOULD_SKIP_THIS
321  inline virtual FBComponent* GetAt(int pIndex) { return (FBComponent*)operator[](pIndex); }
322 private:
323  inline virtual int Add ( FBComponent* pItem ) { return Add((FBStoryFolder*)pItem); }
324 #endif
325 };
326 
330 {
331 public:
337  virtual int Add(FBStoryTrack* pItem);
338 
344  virtual int Remove(FBStoryTrack* pItem);
345 
349  virtual void RemoveAt(int pIndex);
350 
355  virtual FBStoryTrack* operator[](int pIndex);
356 
360  virtual int GetCount();
361 #ifndef DOXYGEN_SHOULD_SKIP_THIS
362  inline virtual FBComponent* GetAt(int pIndex) { return (FBComponent*)operator[](pIndex); }
363 private:
364  inline virtual int Add ( FBComponent* pItem ) { return Add((FBStoryTrack*)pItem); }
365 #endif
366 };
367 
371 {
372 public:
378  virtual int Add(FBStoryTrack* pItem);
379 
385  virtual int Remove(FBStoryTrack* pItem);
386 
390  virtual void RemoveAt(int pIndex);
391 
396  virtual FBStoryTrack* operator[](int pIndex);
397 
401  virtual int GetCount();
402 #ifndef DOXYGEN_SHOULD_SKIP_THIS
403  inline virtual FBComponent* GetAt(int pIndex) { return (FBComponent*)operator[](pIndex); }
404 private:
405  inline virtual int Add ( FBComponent* pItem ) { return Add((FBStoryTrack*)pItem); }
406 #endif
407 };
408 
412 {
413 public:
418  virtual int Add(FBStoryClip* pItem);
419 
424  virtual int Remove(FBStoryClip* pItem);
425 
429  virtual void RemoveAt(int pIndex);
430 
435  virtual FBStoryClip* operator[](int pIndex);
436 
440  virtual int GetCount();
441 #ifndef DOXYGEN_SHOULD_SKIP_THIS
442  inline virtual FBComponent* GetAt(int pIndex) { return (FBComponent*)operator[](pIndex); }
443 private:
444  inline virtual int Add ( FBComponent* pItem ) { return Add((FBStoryClip*)pItem); }
445 #endif
446 };
447 
451 {
452 public:
457  virtual int Add(FBComponent* pItem);
458 
463  virtual int Remove(FBComponent* pItem);
464 
468  virtual void RemoveAt(int pIndex);
469 
474  virtual FBComponent* operator[](int pIndex);
475 
479  virtual int GetCount();
480 #ifndef DOXYGEN_SHOULD_SKIP_THIS
481  inline virtual FBComponent* GetAt(int pIndex) { return (FBComponent*)operator[](pIndex); }
482 #endif
483 };
484 
488 {
489 public:
494  virtual int Add(FBModel* pItem);
495 
500  virtual int Remove(FBModel* pItem);
501 
505  virtual void RemoveAt(int pIndex);
506 
511  virtual FBModel* operator[](int pIndex);
512 
516  virtual int GetCount();
517 #ifndef DOXYGEN_SHOULD_SKIP_THIS
518  inline virtual FBComponent* GetAt(int pIndex) { return (FBComponent*)operator[](pIndex); }
519 private:
520  inline virtual int Add ( FBComponent* pItem ) { return Add((FBModel*)pItem); }
521 #endif
522 };
523 
525 // FBStory
527 
531 {
532  //--- Open Reality declaration.
534 
535 public:
538  FBStory();
546 
550  static FBStory& TheOne();
551 
552 };
553 
555 // FBStoryFolder
557 
561 {
562  //--- Open Reality declaration.
564 public:
565 
571  FBStoryFolder(FBStoryFolder* pParentFolder=NULL, HIObject pObject=NULL);
572 
575  virtual void FBDelete();
576 
580  void Load(bool pLoad);
581 
590 
595  void AlignSelectedClips(FBStoryClipAlignmentType pType, FBComponent* pReferenceClip);
596 
600  void AlignSelectedClipsGroup(FBStoryGroupClipAlignmentType pType);
601 
605  void ExpandSelectedClips(bool pPreserveOverlap);
606 
612  void ConvertClipsToReadOnly(bool pSelected, char* pFilePath);
613 
618  void ExpandSelectedClipsGroup(bool pPreserveOverlap);
619 };
620 
622 // FBStoryTrack
624 
632 {
633  //--- Open Reality declaration.
635 public:
636 
642  FBStoryTrack(FBStoryTrackType pTrackType, FBStoryFolder* pFolder=NULL, HIObject pObject=NULL);
643 
649  FBStoryTrack(FBComponent* pSource, FBStoryFolder* pFolder=NULL, HIObject pObject=NULL);
650 
653  virtual void FBDelete();
654 
658  void ChangeDetailsBegin();
659 
663  void ChangeDetailsEnd();
664 
665  //--- Animation track functions -----------------------------------------------------------------------------------------------------
674  FBStoryClip* CopyTakeIntoTrack(FBTimeSpan& pTimeSpan, FBTake* pTake, FBTime pOutputOffset = 0, bool pMakeUndoable = false);
675 
676  //--- Character track functions -----------------------------------------------------------------------------------------------------
682  void EnableBodyPart(FBStoryTrackBodyPart pPart, bool pEnable);
683 
687  bool IsBodyPartEnabled(FBStoryTrackBodyPart pPart);
688 
692  void AddClip(FBComponent* pClip, FBTime pTime);
693 
699  FBStoryTrack* CreateSubTrack(FBStoryTrackType pTrackType, FBStoryTrackRefMode pRefMode);
700 
704  void Load(bool pLoad);
705 
706  //--- All track properties ----------------------------------------------------------------------------------------------------------
719 
720  //--- Animation and Constraint track properties -------------------------------------------------------------------------------------
722 
723  //--- Animation track properties ----------------------------------------------------------------------------------------------------
733 
734  //--- Character track properties ----------------------------------------------------------------------------------------------------
737 
738  //--- Shot track properties ---------------------------------------------------------------------------------------------------------
741 
742  //--- Audio track properties --------------------------------------------------------------------------------------------------------
744 
745  //--- Video track properties --------------------------------------------------------------------------------------------------------
747 private:
748  void FBStoryTrackInitProperties();
749 };
750 
752 // FBStoryClip
754 
767 {
768  //--- Open Reality declaration.
770 public:
771 
778  FBStoryClip(FBComponent* pClipObject, FBStoryTrack* pTrack, FBTime pTime, HIObject pObject=NULL);
779 
786  FBStoryClip(const char* pFilePath, FBStoryTrack* pTrack, FBTime pTime, HIObject pObject=NULL);
787 
795  FBStoryClip(const char* pFilePath, FBStoryTrack* pTrack, FBTime pTime, FBTime pTimeOffset, HIObject pObject=NULL);
796 
799  virtual void FBDelete();
800 
803  FBStoryClip* Clone();
804 
811  FBTime Move(FBTime pDelta, bool pForce=true);
812 
819  FBTime MoveTo(FBTime pTime, bool pForce=true);
820 
826  FBStoryClip* Razor(FBTime pTime);
827 
828  //--- Animation clip functions ------------------------------------------------------------------------------------------------------
832  void Match();
833 
841  void Match
842  (
843  FBString pObjectName,
844  FBStoryClipMatchingTimeType pTimeType,
845  FBStoryClipMatchingTranslationType pTranslationType,
846  FBStoryClipMatchingRotationType pRotationType
847  );
848 
854  bool ExportToFile(FBString pOutputFile);
855 
860  bool GetReadOnly();
861 
868  bool SetReadOnly(bool pMakeClipReadOnly, FBString pOutputFile = FBString());
869 
874  bool MakeWritable();
875 
883  void GetAffectedObjects( FBArrayTemplate<FBComponent*>* pAffectedObjects );
884 
893  void GetAffectedAnimationNodes( FBArrayTemplate<FBAnimationNode*>* pAffectedAnimationNodes, FBComponent* pClipObject );
894 
901  bool DestinationSetObject( const char* pSrcName, FBComponent* pObject );
902 
924  void SetTime( FBTime *pSourceIn = NULL, FBTime *pSourceOut = NULL, FBTime *pDestinationIn = NULL, FBTime *pDestinationOut = NULL, bool pUseAlternateSrcInProp = false );
925 
930  bool CanAssignSourcesToDestinations();
931 
941  void GetAssignSourcesToDestinationsInfo( FBStringList& pSrcList, FBStringList& pAvailableDstList, FBStringList& pDefaultDstList, FBStringList& pEffectiveDstList );
942 
951  bool SetAssignSourcesToDestinationsInfo( FBStringList& pEffectiveDstList );
952 
956  FBXSDK_NAMESPACE::FbxScene* GetFbxScene();
957 
961  bool UpdateFromCurrentTake();
962 
963  //--- All clip properties -----------------------------------------------------------------------------------------------------------
973 
974  //--- Shot clip properties ----------------------------------------------------------------------------------------------------------
982 
983  //--- Audio clip properties ---------------------------------------------------------------------------------------------------------
988 
989  //--- Video clip properties ---------------------------------------------------------------------------------------------------------
994 
995  //--- Animation clip properties -----------------------------------------------------------------------------------------------------
1019 
1020  //--- Character clip properties -----------------------------------------------------------------------------------------------------
1024 
1026 
1031 
1032 private:
1033  void FBStoryClipInitProperties();
1034 };
1035 
1037 // FBStoryGroupClip
1039 
1043 {
1044  //--- Open Reality declaration.
1046 public:
1047 
1052  FBStoryGroupClip(FBArrayTemplate<FBStoryClip*>* pAffectedClipObject, HIObject pObject=NULL);
1053 
1056  virtual void FBDelete();
1057 
1064  FBTime Move(FBTime pDelta, bool pForce=true);
1065 
1072  FBTime MoveTo(FBTime pTime, bool pForce=true);
1073 
1078  void Razor(FBTime pTime);
1079 
1083 
1084 private:
1085  void FBStoryClipInitProperties();
1086 };
1087 
1088 #ifdef FBSDKUseNamespace
1089  }
1090 #endif
1091 #endif /* this must be the last line of this file */
'Custom' TimeWarp Interpolation
Definition: fbstory.h:243
Story Management class.
Definition: fbstory.h:530
FBPropertyBool PassThrough
Read Write Property: Enable passthrough of animation if there is no clip on track animation is taken ...
Definition: fbstory.h:732
FBStoryTrackGhostShowMode
Ghost Show Modes for story animation tracks.
Definition: fbstory.h:130
FBPropertyTimeSpan PreBlend
Read Write Property: Start/Stop time of the pre-blend phase.
Definition: fbstory.h:969
Model class.
Definition: fbmodel.h:273
#define __FBClassDeclare(Name, Parent)
For internal use only.
Definition: fbcomponent.h:132
FBPropertyTime Stop
Read Write Property: Stop time of the clip.
Definition: fbstory.h:1081
Rotates a selected clip's match object to the same orientation as the previous clip's match object...
Definition: fbstory.h:205
'Reversed, Smoothed Ends' TimeWarp Interpolation
Definition: fbstory.h:249
Align selected clips to the end of the previous clip.
Definition: fbstory.h:214
class FBPropertyBase< FBTimeSpan, kFBPT_TimeSpan > FBPropertyTimeSpan
Property: FBTimeSpan
FBPropertyBool ShowBackplate
Read Write Property: If true, the backplate will be shown.
Definition: fbstory.h:739
FBPropertyBool Ghost
Read Write Property: Show ghosts
Definition: fbstory.h:1003
Matches the selected clip and the next clip at the middle of the blend.
Definition: fbstory.h:187
#define FB_DEFINE_COMPONENT(DllTag, Type)
Define a component and give it the ability to be a property.
Definition: fbproperties.h:139
FBPropertyTime MarkOut
Read Write Property: Stop time inside the clip.
Definition: fbstory.h:968
class FBPropertyBaseComponent< FBAnimationNode * > FBPropertyAnimationNode
Definition: fbdata.h:554
class FBPropertyBaseComponent< FBCamera * > FBPropertyCamera
Definition: fbcamera.h:58
Uses the matching translation type stored in the Application configuration file: [Story] > MatchRotat...
Definition: fbstory.h:207
FBPropertyBool Loaded
Read Write Property: If true, clip file is loaded into memory and can be evaluated (will affect track...
Definition: fbstory.h:1012
FBPropertyDouble Scale
Read Write Property: Animation clip's scaling (some don't support this property)
Definition: fbstory.h:997
Show the ghost at custom time of the clip.
Definition: fbstory.h:147
FBPropertyString RecordClipPath
Read Write Property: Path for story recording.
Definition: fbstory.h:711
Story Group Clip class.
Definition: fbstory.h:1042
FBPropertyListStorySubTrack SubTracks
List: Only Character and Animation tracks can have sub-tracks.
Definition: fbstory.h:716
FBPropertyString ClipNameConvention
Read Write Property: Naming convention for each new recording clip that is created.
Definition: fbstory.h:712
Base class for constraints.
Definition: fbconstraint.h:134
Story Folder class.
Definition: fbstory.h:560
Story Track class.
Definition: fbstory.h:631
class FBPropertyBaseEnum< enum FBStoryClipMirrorPlane > FBPropertyStoryClipMirrorPlane
Definition: fbstory.h:262
No compensation.
Definition: fbstory.h:174
'Going Faster' TimeWarp Interpolation
Definition: fbstory.h:246
Show the ghosts only for the previous clip, current clip, and next clip relative to current time...
Definition: fbstory.h:132
Story Clip class.
Definition: fbstory.h:766
class FBPropertyBase< double, kFBPT_double > FBPropertyDouble
Property: double
FBPropertyStoryTrackGhostShowMode GhostShowTrackMode
Read Write Property: Show the ghosts for all the clips or only the adjacent clips.
Definition: fbstory.h:728
Align selected clips to the beginning of the next clip, all clips will be align to the selected clip ...
Definition: fbstory.h:217
FBPropertyStoryFolder Parent
Read Only Property: Object pointing to the folder's parent.
Definition: fbstory.h:587
FBPropertyTime Start
Read Write Property: Start time of the clip.
Definition: fbstory.h:1080
class FBPropertyBaseAnimatable< double, kFBPT_double > FBPropertyAnimatableDouble
FBPropertyBaseAnimatableDouble type definition.
class FBPropertyBase< FBTime, kFBPT_Time > FBPropertyTime
Property: FBTime
FBPropertyStoryFolder RootFolder
Read Only Property: Story's root folder
Definition: fbstory.h:544
FBPropertyBool Solo
Read Write Property: If true, this story folder will be the only one to play.
Definition: fbstory.h:584
FBPropertyBool ImageSequence
Read Write Property: Whether is a image sequence.
Definition: fbstory.h:991
'Reversed, Going Faster' TimeWarp Interpolation
Definition: fbstory.h:250
Basic string class.
Definition: fbstring.h:66
List of scene objects.
Definition: fbcomponent.h:573
FBStoryClipMatchingTranslationType
Matching Translation, Types when matching clips to each other.
Definition: fbstory.h:193
Align selected clips to the beginning of the next clip, while keeping the relative offset...
Definition: fbstory.h:220
The clip's match object is not rotated to match another clip's animation.
Definition: fbstory.h:204
#define NULL
Definition: kaydara.h:169
FBVideo and derivative classes.
FBPropertyAnimationNode CustomTimeWarp
Read Only Property: Animation clip's custom TimeWarp FCurve.
Definition: fbstory.h:1030
FBPropertyListStoryTrack Tracks
List: Tracks of this folder.
Definition: fbstory.h:589
The clip's match object is not translated to match another clip's animation.
Definition: fbstory.h:195
FBPropertyBool NoneBlockingPostprocess
Read Write Property: If true, record to disk will post process recorded data in low priority thread w...
Definition: fbstory.h:543
FBPropertyVideo TrackVideo
Read Only Property: This FBVideo can be used as a texture.
Definition: fbstory.h:746
Align all selected clips with the current time.
Definition: fbstory.h:213
class FBPropertyBase< FBVector3d, kFBPT_Vector3D > FBPropertyVector3d
FBPropertyVector3d type definition.
FBPropertyBool OffsetEnable
Read Write Property: When enabled, allow clip to be offset
Definition: fbstory.h:731
List: StoryClip
Definition: fbstory.h:411
FBStoryClipCompMode
Compensation Modes for story character clips.
Definition: fbstory.h:173
FBPropertyBool RecordTrack
Read Write Property: Path for story recording.
Definition: fbstory.h:713
FBStoryClipChangeType
Types of clip change events, matching KEventClip.eType Expose only kFBStoryClipMoveClip and kFBStoryC...
Definition: fbstory.h:232
FBPropertyBool LockedShot
Read Write Property: If true, shots will be locked (no time discontinuity).
Definition: fbstory.h:540
FBPropertyListObject DependentClips
Read Write Property: Clips that are included in the group clip.
Definition: fbstory.h:1082
FBStoryClipNodeFunction
Node function.
Definition: fbstory.h:151
FBPropertyBool ShowFrontplate
Read Write Property: Enable/Disable the shot frontplate.
Definition: fbstory.h:979
Matches the start of the blend with the selected clip to the start of the next clip.
Definition: fbstory.h:186
Character animation track.
Definition: fbstory.h:83
Automatic compensation.
Definition: fbstory.h:175
'Reversed, Slowing Down' TimeWarp Interpolation
Definition: fbstory.h:251
class FBPropertyBaseEnum< enum FBStoryClipSolveMode > FBPropertyStoryClipSolveMode
Definition: fbstory.h:261
FBStoryClipTimeWarpInterpolatorType
Types of TimeWrap Interpolator for Story Clips.
Definition: fbstory.h:242
Contains definitions for devices, boxes and models.
Align selected clips to the end of the previous clip, all clips will be align to the selected clip po...
Definition: fbstory.h:215
Property class: const char * (String).
Matches the selected clip and the previous clip at the middle of the blend.
Definition: fbstory.h:184
Base Event class.
Definition: fbcomponent.h:959
Base class for Cameras.
FBStoryClipAlignmentType
Alignment Types when aligning clips.
Definition: fbstory.h:212
FBPropertyBool LockPitchToSpeed
Read Write Property: Time-stretching enabled or not.
Definition: fbstory.h:987
FBPropertyTime Offset
Read Write Property: First loop time offset.
Definition: fbstory.h:971
FBPropertyBool Mute
Read Write Property: If true, this story folder will be muted.
Definition: fbstory.h:585
List: StorySubTrack
Definition: fbstory.h:370
#define FB_DEFINE_ENUM(DllTag, Type)
Define an enum and give it the ability to be a property.
Definition: fbproperties.h:148
FBPropertyTime Stop
Read Write Property: Stop time of the clip local to its track.
Definition: fbstory.h:966
MotionBuilder SDK base class.
Definition: fbcomponent.h:668
Show the ghost at current time of the clip.
Definition: fbstory.h:144
FBPropertyVector3d Translation
Read Write Property: Animation clip's translation offset.
Definition: fbstory.h:998
FBPropertyString Label
Read Write Property: Label to display for this story folder.
Definition: fbstory.h:582
FBPropertyListObject TravellingNode
List: Travelling node(s).
Definition: fbstory.h:1014
FBPropertyBool TimeWarpEnabled
Read Write Property: Animation clip's TimeWarp activeness.
Definition: fbstory.h:1027
FBPropertyInt AudioOutIndex
Read Write Property: Audio Output's index to use.
Definition: fbstory.h:743
List: Story track Details
Definition: fbstory.h:450
FBPropertyListPivot Pivots
List: Pivots models (Generally, only one model is necessary)
Definition: fbstory.h:1011
class FBPropertyBase< bool, kFBPT_bool > FBPropertyBool
Property: bool
Matches the end of the blend with the selected clip to the end of the previous clip.
Definition: fbstory.h:185
FBPropertyStoryClipNodeFunction TravellingNodeFunction
Read Write Property: Travelling node function.
Definition: fbstory.h:1015
FBPropertyBool MirrorAnimation
Read Write Property: If true, clip animation will be mirrored
Definition: fbstory.h:1022
Show the ghost for custom time frame.
Definition: fbstory.h:139
FBStoryClipSolveMode
Solve Modes for story character clips.
Definition: fbstory.h:158
FBPropertyBool GhostPivot
Read Write Property: Show ghost of match object
Definition: fbstory.h:1006
Rotates a selected clip's match object around the global Y axis.
Definition: fbstory.h:206
Solve skeleton animation.
Definition: fbstory.h:160
PropertyList: Component.
Definition: fbcomponent.h:494
FBPropertyVector3d Rotation
Read Write Property: Animation clip's rotation offset.
Definition: fbstory.h:999
Matches the end of the selected clip to the end of the blend with the previous clip.
Definition: fbstory.h:188
Align the clips contained in the group clip with the current time.
Definition: fbstory.h:225
FBPropertyString ClipVideoPath
Read Write Property: Video clip's file path
Definition: fbstory.h:990
class FBPropertyBaseEnum< enum FBStoryTrackGhostShowMode > FBPropertyStoryTrackGhostShowMode
Definition: fbstory.h:257
FBPropertyStoryTrackType Type
Read Only Property: Type of the track
Definition: fbstory.h:707
FBPropertyColor Color
Read Write Property: Color of the clip.
Definition: fbstory.h:964
class FBPropertyBaseComponent< FBVideo * > FBPropertyVideo
Definition: fbstory.h:76
Translates a selected clip's match object to the same location as the previous clip's match object...
Definition: fbstory.h:196
Definition: Python-ast.h:18
FBPropertyAnimationNode PostBlendData
Read Only Property: To get the animation of the Post blend curve
Definition: fbstory.h:1010
A take is a container for animation in a scene.
Definition: fbdata.h:935
FBPropertyListStoryDetails Details
List: All objects associated to this track for processing.
Definition: fbstory.h:718
FBPropertyBool Solo
Read Write Property: If true, this track will be the only one to play.
Definition: fbstory.h:710
FBPropertyBool SummaryClip
Read Write Property: If true, summary clips for story folders will be created to help manipulating fo...
Definition: fbstory.h:541
Uses the matching time type stored in the Application configuration file: [Story] > MatchWhen...
Definition: fbstory.h:189
FBPropertyInt CharacterIndex
Read Write Property: Character's index to use.
Definition: fbstory.h:736
class FBPropertyBaseEnum< enum FBStoryClipTimeWarpInterpolatorType > FBPropertyStoryClipTimeWarpInterpolatorType
Definition: fbstory.h:265
#define __FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
Definition: fbtypes.h:68
FBStoryTrackRefMode
References Modes for story animation tracks.
Definition: fbstory.h:92
class FBPropertyBaseComponent< FBAudioClip * > FBPropertyAudioClip
Definition: fbaudio.h:63
Template class to contain an array of items.
Definition: fbarray.h:77
class FBPropertyBaseEnum< enum FBStoryClipChangeType > FBPropertyStoryClipChangeType
Definition: fbstory.h:254
FBPropertyString RecordClipPath
Read Write Property: Path for story recording.
Definition: fbstory.h:586
FBPropertyBool GhostPivot
Read Write Property: Show ghost of match object
Definition: fbstory.h:727
FBPropertyTime GhostManipulatorCustomTime
Read Write Property: Custom time to display ghost manipulator, only applicable if GhostManipulatorMod...
Definition: fbstory.h:1017
'Normal' TimeWarp Interpolation
Definition: fbstory.h:244
FBStoryTrackType
Types for new story tracks.
Definition: fbstory.h:80
Matches the start of the selected clip to the start of the blend with the previous clip...
Definition: fbstory.h:183
FBPropertyBool ConnectedToTake
Read Write Property: When connected to current take, user can do updating from current take...
Definition: fbstory.h:1018
FBPropertyTime Start
Read Write Property: Start time of the clip local to its track.
Definition: fbstory.h:965
Solve skeleton inverse kinematic animation.
Definition: fbstory.h:162
Solve forward and inverse kinematic animation.
Definition: fbstory.h:161
FBStoryClipMatchingRotationType
Matching Rotation Types, when matching clips to each other.
Definition: fbstory.h:202
List: StoryTrack
Definition: fbstory.h:329
FBPropertyStoryTrackRefMode ReferenceMode
Read Write Property: Track composition mode, kFBStoryTrackOverride or kFBStoryTrackAdditive ...
Definition: fbstory.h:730
#define FBSDKNamespace
FBSDKNamespace define.
Definition: fbversion.h:64
Always show the ghost.
Definition: fbstory.h:137
FBPropertyCharacter Character
Read Write Property: Character to use.
Definition: fbstory.h:735
FBPropertyEvent OnChange
Event: Something in the clip has changed.
Definition: fbstory.h:1025
FBStoryTrackBodyPart
Body Parts for story track character.
Definition: fbstory.h:98
FBPropertyStoryClipShowGhostMode ShowGhostClipMode
Read Write Property: Show the ghost depending on the time.
Definition: fbstory.h:1007
Show the ghost at stop time of the clip.
Definition: fbstory.h:146
Basic class definitions.
Time data structure.
Definition: fbtime.h:86
FBPropertyTimeSpan PostBlend
Read Write Property: Start/Stop time of the post-blend phase.
Definition: fbstory.h:970
FBPropertyBool Loop
Read Write Property: If true, loop clip's animation
Definition: fbstory.h:1002
PropertyEvent: Base event class.
Definition: fbproperties.h:507
'Smoothed Ends' TimeWarp Interpolation
Definition: fbstory.h:245
class FBPropertyBaseEnum< enum FBStoryClipGhostTimeMode > FBPropertyStoryClipGhostTimeMode
Definition: fbstory.h:259
FBPropertyBool Ghost
Read Write Property: Show ghosts
Definition: fbstory.h:724
FBPropertyListStoryClip Clips
List: Clips contained in this track.
Definition: fbstory.h:717
KEventBase * HKEventBase
Definition: fbcomponent.h:75
FBPropertyStoryClipSolveMode SolvingMode
Read Write Property: Solve Modes for story character clips.
Definition: fbstory.h:1021
FBStoryClipGhostTimeMode
Time mode to display ghost.
Definition: fbstory.h:143
FBPropertyListStoryFolder Childs
List: Children folders of this folder.
Definition: fbstory.h:588
FBPropertyAnimatableDouble Weight
Read Write Property: Control the blend amount.
Definition: fbstory.h:721
FBPropertyAudioClip AudioClip
Read Only Property: The audio clip used by this StoryClip.
Definition: fbstory.h:984
FBPropertyBool GhostModel
Read Write Property: Show ghost of models
Definition: fbstory.h:1004
FBPropertyVector3d GhostManipulatorOffset
Read Write Property: Animation clip's ghost manipulator offset.
Definition: fbstory.h:1013
Show the ghost only on time cursor.
Definition: fbstory.h:138
#define FBSDK_DLL
Be sure that FBSDK_DLL is defined only once...
Definition: fbstory.h:48
FBPropertyStoryClipMirrorPlane MirrorPlane
Read Write Property: Several mirror planes to mirror animation.
Definition: fbstory.h:1023
Solve retarget skeleton.
Definition: fbstory.h:159
FBPropertyBool RecordToDisk
Read Write Property: If true, record to story will record directly to disk.
Definition: fbstory.h:542
FBPropertyBool ShowBackplate
Read Write Property: Enable/Disable the shot backplate.
Definition: fbstory.h:978
User defined compensation.
Definition: fbstory.h:176
FBPropertyBool GhostModel
Read Write Property: Show ghost of models
Definition: fbstory.h:725
FBStoryGroupClipAlignmentType
Alignment Types when aligning groups.
Definition: fbstory.h:224
FBPropertyBool Collapsed
Read Write Property: Toggle to collapse or expand the story folder.
Definition: fbstory.h:583
FBPropertyString ClipAnimationPath
Read Write Property: Animation clip's file path
Definition: fbstory.h:996
FBPropertyDouble Speed
Read Write Property: Speed of the clip.
Definition: fbstory.h:972
FBPropertyBool AcceptKey
Read Write Property: Allow track to accept keys
Definition: fbstory.h:729
FBPropertyTime ShotActionStart
Read Write Property: If not in locked shot mode (time discontinuity enabled), this time can be differ...
Definition: fbstory.h:980
Align selected clips to the beginning of the next clip.
Definition: fbstory.h:216
#define FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
Definition: fbtypes.h:62
String list.
Definition: fbstring.h:201
FBPropertyStoryFolder RootEditFolder
Read Only Property: Story's root edit folder
Definition: fbstory.h:545
FBPropertyBool ShowFrontplate
Read Write Property: If true, the frontplate will be shown.
Definition: fbstory.h:740
FBPropertyDouble ClipPitch
Read Write Property: The clip pitch value.
Definition: fbstory.h:986
FBPropertyDouble FrameRate
Read Write Property: Frame rate value.
Definition: fbstory.h:993
FBPropertyAnimationNode PreBlendData
Read Only Property: To get the animation of the Pre blend curve
Definition: fbstory.h:1009
Align selected clips to the end of the previous clip, while keeping the relative offset.
Definition: fbstory.h:219
Show the ghosts for all the clips on the track.
Definition: fbstory.h:131
FBPropertyBool Mute
Read Write Property: If true, this track wont' play.
Definition: fbstory.h:709
List: Story Clip pivot models
Definition: fbstory.h:487
FBPropertyTime MarkIn
Read Write Property: Start time inside the clip.
Definition: fbstory.h:967
class FBPropertyBaseEnum< enum FBStoryClipNodeFunction > FBPropertyStoryClipNodeFunction
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:227
'Slowing Down' TimeWarp Interpolation
Definition: fbstory.h:247
TimeSpan class.
Definition: fbtime.h:381
FBPropertyVideo ShotFrontplate
Read Write Property: The frontplate used for that specific shot.
Definition: fbstory.h:977
Translates a selected clip's match object along the global X and Z axes.
Definition: fbstory.h:197
class FBPropertyBaseComponent< FBCharacter * > FBPropertyCharacter
FBPropertyBool TimeWarpReverse
Read Write Property: If true, reverse the Animation clip's TimeWarp FCurve.
Definition: fbstory.h:1029
FBStoryClipShowGhostMode
Show Ghost Modes for story animation clips.
Definition: fbstory.h:136
FBPropertyTime GhostCustomTime
Read Write Property: Custom time to display ghost, only applicable if ShowGhostClipMode is kFBStoryCl...
Definition: fbstory.h:1008
class FBPropertyBaseEnum< enum FBStoryTrackType > FBPropertyStoryTrackType
Definition: fbstory.h:255
FBPropertyStoryClipChangeType Type
Read Only Property: Type of event.
Definition: fbstory.h:282
Uses the matching translation type stored in the Application configuration file: [Story] > MatchTrans...
Definition: fbstory.h:198
class FBPropertyBase< int, kFBPT_int > FBPropertyInt
Property: int
FBPropertyStoryFolder ParentFolder
Read Only Property: Parent folder.
Definition: fbstory.h:714
FBPropertyStoryClipTimeWarpInterpolatorType TimeWarpInterpolatorType
Read Write Property: Animation clip's TimeWarp interpolation type.
Definition: fbstory.h:1028
FBPropertyVideo ShotBackplate
Read Write Property: The backplate used for that specific shot.
Definition: fbstory.h:976
FBPropertyCamera ShotCamera
Read Write Property: The camera used for that specific shot.
Definition: fbstory.h:975
class FBPropertyBase< FBColor, kFBPT_ColorRGB > FBPropertyColor
FBPropertyColor type definition.
Show the ghost at start time of the clip.
Definition: fbstory.h:145
Camera animation track.
Definition: fbstory.h:82
FBPropertyStoryTrack ParentTrack
Read Only Property: Parent track, if the track is of Character or Animation type. ...
Definition: fbstory.h:715
FBPropertyVector3d LoopTranslation
Read Write Property: Animation clip's loop translation.
Definition: fbstory.h:1000
Align all selected clips with the current time, while keeping the relative offset.
Definition: fbstory.h:218
FBPropertyBool GhostTravelling
Read Write Property: Show ghost of clip vector or traveling node
Definition: fbstory.h:1005
FBPropertyBool Mute
Read Write Property: If true, the Story mode will be globally disabled.
Definition: fbstory.h:539
FBStoryClipMatchingTimeType
Matching Time Types, when matching clips to each other.
Definition: fbstory.h:180
FBPropertyBool AutoLoop
Read Write Property: If true, clip will automatically loop
Definition: fbstory.h:1001
class FBPropertyBaseEnum< enum FBStoryTrackRefMode > FBPropertyStoryTrackRefMode
Definition: fbstory.h:256
FBPropertyStoryClipGhostTimeMode GhostManipulatorMode
Read Write Property: Time mode to display ghost manipulator.
Definition: fbstory.h:1016
FBPropertyBool GhostTravelling
Read Write Property: Show ghost of clip vector or traveling node
Definition: fbstory.h:726
FBPropertyString Label
Read Write Property: Label to display for this story track.
Definition: fbstory.h:708
class FBPropertyBaseComponent< FBStoryTrack * > FBPropertyStoryTrack
Definition: fbstory.h:72
Align the clips contained in the group clip to the end of the previous clip, while keeping the relati...
Definition: fbstory.h:226
FBPropertyString ClipAudioPath
Read Write Property: Audio clip's file path
Definition: fbstory.h:985
class FBPropertyBaseEnum< enum FBStoryClipShowGhostMode > FBPropertyStoryClipShowGhostMode
Definition: fbstory.h:258
Matches the start of the selected clip to the previous/next clip at the current time.
Definition: fbstory.h:182
FBStoryClipMirrorPlane
Several mirror planes to mirror animation.
Definition: fbstory.h:166
FBPropertyBool UseSystemFrameRate
Read Write Property: Whether always use system frame rate.
Definition: fbstory.h:992
List: StoryFolder
Definition: fbstory.h:287
FBPropertyTime ShotActionStop
Read Write Property: If not in locked shot mode (time discontinuity enabled), this time can be differ...
Definition: fbstory.h:981
class FBPropertyBaseComponent< FBStoryFolder * > FBPropertyStoryFolder
Definition: fbstory.h:71