Open Reality Reference Guide
|
|
Go to the documentation of this file.
43 #include <kaydaradef.h>
48 #define FBSDK_DLL K_DLLIMPORT
55 #include <fbsdk/fbcamera.h>
57 #ifndef FBXSDK_NAMESPACE
58 #define FBXSDK_NAMESPACE fbxsdk
61 namespace FBXSDK_NAMESPACE {
65 #ifdef FBSDKUseNamespace
66 namespace FBSDKNamespace {
103 kFBStoryTrackBodyPartNone = 0,
105 kFBStoryTrackBodyPartHead = 1 << 0,
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,
114 kFBStoryTrackBodyPartLeftFoot = 1 << 7,
115 kFBStoryTrackBodyPartLeftLeg = 1 << 8 | kFBStoryTrackBodyPartLeftFoot,
116 kFBStoryTrackBodyPartRightFoot = 1 << 9,
117 kFBStoryTrackBodyPartRightLeg = 1 << 10| kFBStoryTrackBodyPartRightFoot,
119 kFBStoryTrackBodyPartProps = 1 << 11,
120 kFBStoryTrackBodyPartExtensions = 1 << 12,
122 kFBStoryTrackBodyPartSpine = 1 << 13,
124 kFBStoryTrackBodyPartUpperBody = kFBStoryTrackBodyPartHead | kFBStoryTrackBodyPartSpine |
125 kFBStoryTrackBodyPartLeftArm | kFBStoryTrackBodyPartLeftShoulder | kFBStoryTrackBodyPartLeftHand |
126 kFBStoryTrackBodyPartRightArm | kFBStoryTrackBodyPartRightShoulder | kFBStoryTrackBodyPartRightHand,
128 kFBStoryTrackBodyPartLowerBody = kFBStoryTrackBodyPartLeftLeg | kFBStoryTrackBodyPartLeftFoot | kFBStoryTrackBodyPartRightLeg | kFBStoryTrackBodyPartRightFoot,
130 kFBStoryTrackBodyPartAll = kFBStoryTrackBodyPartUpperBody | kFBStoryTrackBodyPartLowerBody,
286 FBPropertyStoryClipChangeType
Type;
324 #ifndef DOXYGEN_SHOULD_SKIP_THIS
365 #ifndef DOXYGEN_SHOULD_SKIP_THIS
406 #ifndef DOXYGEN_SHOULD_SKIP_THIS
445 #ifndef DOXYGEN_SHOULD_SKIP_THIS
484 #ifndef DOXYGEN_SHOULD_SKIP_THIS
521 #ifndef DOXYGEN_SHOULD_SKIP_THIS
759 void FBStoryTrackInitProperties();
935 void SetTime(
FBTime *pSourceIn = NULL,
FBTime *pSourceOut = NULL,
FBTime *pDestinationIn = NULL,
FBTime *pDestinationOut = NULL,
bool pUseAlternateSrcInProp =
false );
1048 void FBStoryClipInitProperties();
1101 void FBStoryClipInitProperties();
1104 #ifdef FBSDKUseNamespace
@ kFBStoryClipMatchingTimeEndOfSelectedClip
Matches the end of the selected clip to the end of the blend with the previous clip.
FBPropertyBool LockedShot
Read Write Property: If true, shots will be locked (no time discontinuity).
FBTime Move(FBTime pDelta, bool pForce=true)
Move.
@ kFBStoryClipAuto
Automatic compensation.
@ kFBStoryClipMatchingTranslationXYZ
Translates a selected clip's match object to the same location as the previous clip's match object.
@ kFBStoryClipRemoved
Clip removed.
FBStoryTrack(FBComponent *pSource, FBStoryFolder *pFolder=NULL, HIObject pObject=NULL)
Constructor.
@ kFBStoryClipMatchingTranslationNone
The clip's match object is not translated to match another clip's animation.
@ kFBStoryClipTimeWarpInterpolatorLinearReversed
'Reversed' TimeWarp Interpolation
@ kFBStoryClipMatchingTimeBetweenPreviousAndSelectedClip
Matches the selected clip and the previous clip at the middle of the blend.
FBPropertyString ClipNameConvention
Read Write Property: Naming convention for each new recording clip that is created....
@ kFBStoryClipMatchingTimeDefault
Uses the matching time type stored in the Application configuration file: [Story] > MatchWhen....
FBPropertyString ClipAnimationPath
Read Write Property: Animation clip's file path
FBPropertyStoryFolder Parent
Read Only Property: Object pointing to the folder's parent.
FBPropertyTime Start
Read Write Property: Start time of the clip local to its track.
FBPropertyBool Solo
Read Write Property: If true, this track will be the only one to play.
@ kFBStoryClipMirrorPlaneXY
X-Y plane.
FBPropertyListPivot Pivots
List: Pivots models (Generally, only one model is necessary)
virtual FBStoryTrack * operator[](int pIndex)
Get the sub-track at pIndex.
void GetAffectedObjects(FBArrayTemplate< FBComponent * > *pAffectedObjects)
GetAffectedObjects.
void ExpandSelectedClipsGroup(bool pPreserveOverlap)
ExpandSelectedClipsGroup Used to expand group clip dependent clips.
FBPropertyBool TimeWarpReverse
Read Write Property: If true, reverse the Animation or Shot clip's TimeWarp FCurve.
FBPropertyAudioClip AudioClip
Read Only Property: The audio clip used by this StoryClip.
void GetAssignSourcesToDestinationsInfo(FBStringList &pSrcList, FBStringList &pAvailableDstList, FBStringList &pDefaultDstList, FBStringList &pEffectiveDstList)
GetAssignSourcesToDestinationsInfo.
#define FB_DEFINE_ENUM(DllTag, Type)
Define an enum and give it the ability to be a property.
@ kFBStoryClipMatchingRotationGravityXZ
Rotates a selected clip's match object around the global Y axis.
@ kFBStoryClipNotSet
Clip none.
@ kFBStoryClipTimeWarpInterpolatorLinear
'Normal' TimeWarp Interpolation
FBPropertyDouble ClipPitch
Read Write Property: The clip pitch value.
FBStoryTrackRefMode
References Modes for story animation tracks.
@ kFBStoryClipMatchingTimeEndOfPreviousClip
Matches the end of the blend with the selected clip to the end of the previous clip.
@ kFBStoryClipGhostStop
Show the ghost at stop time of the clip.
@ kFBStoryClipAlignmentBeginningNextWithOffset
Align selected clips to the beginning of the next clip, while keeping the relative offset.
FBPropertyTime Start
Read Write Property: Start time of the clip.
virtual FBStoryClip * operator[](int pIndex)
Get the clip at pIndex.
FBTime Move(FBTime pDelta, bool pForce=true)
Move.
FBStoryTrack(FBStoryTrackType pTrackType, FBStoryFolder *pFolder=NULL, HIObject pObject=NULL)
Constructor.
class K_DLLIMPORT FBPropertyBase< int, kFBPT_int > FBPropertyInt
Property: int
FBPropertyBool RecordTrack
Read Write Property: Path for story recording. Can be relative or full path.
@ kFBStoryClipAlignmentEndPreviousWithOffset
Align selected clips to the end of the previous clip, while keeping the relative offset.
FBPropertyBool PassThrough
Read Write Property: Enable passthrough of animation if there is no clip on track animation is taken ...
FBPropertyBool RecordToDisk
Read Write Property: If true, record to story will record directly to disk.
FBPropertyAnimationNode PreBlendData
Read Only Property: To get the animation of the Pre blend curve
FBPropertyListStoryClip Clips
List: Clips contained in this track.
@ kFBStoryTrackAnimation
Animation track.
FBPropertyBool Solo
Read Write Property: If true, this story folder will be the only one to play.
FBPropertyTime MarkOut
Read Write Property: Stop time inside the clip.
FBPropertyTime ShotActionStart
Read Write Property: If not in locked shot mode (time discontinuity enabled), this time can be differ...
@ kFBStoryClipMoveClip
Clip moved.
FBTime MoveTo(FBTime pTime, bool pForce=true)
MoveTo.
@ kFBStoryTrackCharacter
Character animation track.
FBStoryTrack * CreateSubTrack(FBStoryTrackType pTrackType, FBStoryTrackRefMode pRefMode)
Create a sub track, Only Character and Animation tracks can have sub-tracks.
FBStoryClipSolveMode
Solve Modes for story character clips.
@ kFBStoryClipTimeWarpInterpolatorGoingFasterReversed
'Reversed, Going Faster' TimeWarp Interpolation
FBStoryClipMatchingRotationType
Matching Rotation Types, when matching clips to each other.
FBPropertyVideo ShotFrontplate
Read Write Property: The frontplate used for that specific shot.
FBPropertyBool GhostTravelling
Read Write Property: Show ghost of clip vector or traveling node
FBPropertyTimeSpan PreBlend
Read Write Property: Start/Stop time of the pre-blend phase.
FBPropertyTime Stop
Read Write Property: Stop time of the clip.
FBPropertyStoryClipTimeWarpInterpolatorType TimeWarpInterpolatorType
Read Write Property: Animation and Shot clip's TimeWarp interpolation type. See FBStoryClipTimeWarpIn...
void ChangeDetailsBegin()
ChangeDetailsBegin.
FBPropertyBool ConnectedToTake
Read Write Property: When connected to current take, user can do updating from current take,...
@ kFBStoryClipTimeWarpInterpolatorGoingFaster
'Going Faster' TimeWarp Interpolation
virtual FBStoryTrack * operator[](int pIndex)
Get the track at pIndex.
@ kFBStoryClipGhostCurrent
Show the ghost at current time of the clip.
@ kFBStoryTrackVideo
Video track.
class K_DLLIMPORT FBPropertyBase< double, kFBPT_double > FBPropertyDouble
Property: double
virtual FBComponent * operator[](int pIndex)
Get the object at pIndex.
FBPropertyBool TimeWarpEnabled
Read Write Property: Animation and Shot clip's TimeWarp activeness.
FBPropertyStoryClipMirrorPlane MirrorPlane
Read Write Property: Several mirror planes to mirror animation. See FBStoryClipMirrorPlane
virtual int GetCount()
Get the number of track.
FBPropertyListStorySubTrack SubTracks
List: Only Character and Animation tracks can have sub-tracks.
FBPropertyListStoryFolder Childs
List: Children folders of this folder.
FBPropertyBool Mute
Read Write Property: If true, this track wont' play.
@ kFBStoryClipOff
No compensation.
void ExpandSelectedClips(bool pPreserveOverlap)
Used to expand selected clips .
virtual int GetCount()
Get the number of clip.
@ kFBStoryGroupClipAlignmentCurrentTimeline
Align the clips contained in the group clip with the current time.
FBPropertyVector3d LoopTranslation
Read Write Property: Animation clip's loop translation.
virtual int GetCount()
Get the number of object.
virtual void FBDelete() override
Virtual FBDelete function.
FBVideo and derivative classes.
FBPropertyVector3d GhostManipulatorOffset
Read Write Property: Animation clip's ghost manipulator offset.
FBPropertyCharacter Character
Read Write Property: Character to use.
List: Story Clip pivot models
@ kFBStoryClipMatchingTimeCurrentTime
Matches the start of the selected clip to the previous/next clip at the current time.
@ kFBStoryClipAlignmentBeginningNextAllAligned
Align selected clips to the beginning of the next clip, all clips will be align to the selected clip ...
@ kFBStoryClipMatchingTimeStartOfNextClip
Matches the start of the blend with the selected clip to the start of the next clip.
@ kFBStoryClipTimeCustom
Show the ghost for custom time frame.
class K_DLLIMPORT FBPropertyBase< FBColor, kFBPT_ColorRGB > FBPropertyColor
FBPropertyColor type definition.
@ kFBStoryClipMoveData
Clip data moved.
bool UpdateFromCurrentTake()
Update clip animation from current take animation for clip track's scope, works only for clip created...
FBPropertyString RecordClipPath
Read Write Property: Path for story recording. Can be relative or full path.
void EnableBodyPart(FBStoryTrackBodyPart pPart, bool pEnable)
EnableBodyPart.
A take is a container for animation in a scene.
FBPropertyAnimatableDouble Weight
Read Write Property: Control the blend amount.
virtual int GetCount()
Get the number of object.
FBPropertyString ClipVideoPath
Read Write Property: Video clip's file path
virtual void RemoveAt(int pIndex)
Remove the folder at pIndex.
FBPropertyAnimationNode CustomTimeWarp
Read Only Property: Animation and Shot clip's custom TimeWarp FCurve.
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.
FBPropertyEvent OnChange
Event: Something in the clip has changed. (FBEventClip)
FBPropertyStoryFolder RootEditFolder
Read Only Property: Story's root edit folder
FBPropertyDouble Speed
Read Write Property: Speed of the clip.
virtual void RemoveAt(int pIndex)
Remove the clip at pIndex.
FBPropertyBool StartStopLocked
Read Write Property: Clip's 'In/Out Locked' property value. True if the clip's In/Out properties (sta...
virtual int Remove(FBModel *pItem)
Remove object pItem from property list.
FBStoryFolder(FBStoryFolder *pParentFolder=NULL, HIObject pObject=NULL)
Constructor.
@ kFBStoryClipNodeAverage
Average.
FBPropertyString RecordClipPath
Read Write Property: Path for story recording. Can be relative or full path.
FBPropertyBool GhostPivot
Read Write Property: Show ghost of match object
FBStoryClip(FBComponent *pClipObject, FBStoryTrack *pTrack, FBTime pTime, HIObject pObject=NULL)
Constructor.
FBPropertyTime GhostManipulatorCustomTime
Read Write Property: Custom time to display ghost manipulator, only applicable if GhostManipulatorMod...
FBPropertyBool Ghost
Read Write Property: Show ghosts
FBPropertyTime MarkIn
Read Write Property: Start time inside the clip.
virtual int Remove(FBStoryTrack *pItem)
Remove sub-track pItem from property list.
@ kFBStoryClipAlignmentBeginningNext
Align selected clips to the beginning of the next clip.
@ kFBStoryClipMirrorPlaneXZ
X-Z plane.
FBStoryClipChangeType
Types of clip change events, matching KEventClip.eType Expose only kFBStoryClipMoveClip and kFBStoryC...
virtual void FBDelete() override
Virtual FBDelete function.
FBPropertyDouble Scale
Read Write Property: Animation clip's scaling (some don't support this property)
FBPropertyBool GhostTravelling
Read Write Property: Show ghost of clip vector or traveling node
FBPropertyStoryClipChangeType Type
Read Only Property: Type of event.
virtual int Remove(FBStoryFolder *pItem)
Remove folder pItem from property list.
@ kFBStoryTrackCommand
Command track.
FBPropertyBool GhostModel
Read Write Property: Show ghost of models
FBPropertyTimeSpan PostBlend
Read Write Property: Start/Stop time of the post-blend phase.
@ kFBStoryClipTimeCursor
Show the ghost only on time cursor.
FBStoryGroupClipAlignmentType
Alignment Types when aligning groups.
class K_DLLIMPORT FBPropertyBase< FBTime, kFBPT_Time > FBPropertyTime
Property: FBTime
FBStoryClipNodeFunction
Node function.
FBPropertyBool Loaded
Read Write Property: If true, clip file is loaded into memory and can be evaluated (will affect track...
void Load(bool pLoad)
Allow to load/unload all story clips under this track.
FBPropertyAnimationNode PostBlendData
Read Only Property: To get the animation of the Post blend curve
bool SetAssignSourcesToDestinationsInfo(FBStringList &pEffectiveDstList)
SetAssignSourcesToDestinationsInfo.
virtual int GetCount()
Get the number of sub-track.
#define __FBClassDeclare(Name, Parent)
For internal use only.
class K_DLLIMPORT FBPropertyBaseAnimatable< double, kFBPT_double > FBPropertyAnimatableDouble
FBPropertyBaseAnimatableDouble type definition.
@ kFBStoryClipTimeWarpInterpolatorSlowingDownReversed
'Reversed, Slowing Down' TimeWarp Interpolation
void Load(bool pLoad)
Allow to load/unload all story clips under this folder.
FBPropertyBool ClipsTextsVisible
Read Write Property: If true, clips' texts are visible.
@ kFBStoryGroupClipAlignmentBeginningNextWithOffset
Align the clips contained in the group clip to the beginning of the next clip, while keeping the rela...
FBPropertyBool ShowFrontplate
Read Write Property: If true, the frontplate will be shown.
FBStoryClipTimeWarpInterpolatorType
Types of TimeWrap Interpolator for Story Clips.
virtual void RemoveAt(int pIndex)
Remove the track at pIndex.
@ kFBStoryClipAlignmentEndPreviousAllAligned
Align selected clips to the end of the previous clip, all clips will be align to the selected clip po...
FBStoryGroupClip(FBArrayTemplate< FBStoryClip * > *pAffectedClipObject, HIObject pObject=NULL)
Constructor.
@ kFBStoryTrackConstraint
Constraint track.
FBPropertyBool ShowFrontplate
Read Write Property: Enable/Disable the shot frontplate.
FBPropertyBool Collapsed
Read Write Property: Toggle to collapse or expand the story folder.
#define __FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
FBEventClipChange(HKEventBase pEvent)
Constructor.
FBPropertyInt CharacterIndex
Read Write Property: Character's index to use.
void ConvertClipsToReadOnly(bool pSelected, char *pFilePath)
Convert all clips to read-only clips.
FBPropertyCamera ShotCamera
Read Write Property: The camera used for that specific shot.
void ChangeDetailsEnd()
ChangeDetailsEnd.
FBStoryTrackBodyPart
Body Parts for story track character.
@ kFBStoryTrackShowCurrentTimeAdjacentClips
Show the ghosts only for the previous clip, current clip, and next clip relative to current time.
#define FBSDK_DLL
Be sure that FBSDK_DLL is defined only once...
class K_DLLIMPORT FBPropertyBase< FBVector3d, kFBPT_Vector3D > FBPropertyVector3d
FBPropertyVector3d type definition.
FBTime MoveTo(FBTime pTime, bool pForce=true)
MoveTo.
void GetAffectedAnimationNodes(FBArrayTemplate< FBAnimationNode * > *pAffectedAnimationNodes, FBComponent *pClipObject)
GetAffectedAnimationNodes.
bool MakeWritable()
MakeWritable.
virtual void RemoveAt(int pIndex)
Remove the sub-track at pIndex.
FBPropertyStoryFolder ParentFolder
Read Only Property: Parent folder.
FBPropertyBool ShowBackplate
Read Write Property: Enable/Disable the shot backplate.
virtual int Add(FBComponent *pItem)
Add a object to the property list.
@ kFBStoryClipMatchingTranslationDefault
Uses the matching translation type stored in the Application configuration file: [Story] > MatchTrans...
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.
FBPropertyTime GhostCustomTime
Read Write Property: Custom time to display ghost, only applicable if ShowGhostClipMode is kFBStoryCl...
FBPropertyBool ShowEmbeddedTimecode
Read Write Property: Whether to show embedded timecode of the clip, if available.
virtual int Add(FBModel *pItem)
Add a object to the property list.
FBPropertyTime ShotActionStop
Read Write Property: If not in locked shot mode (time discontinuity enabled), this time can be differ...
@ kFBStoryClipAnimSkeletonIk
Solve skeleton inverse kinematic animation.
FBPropertyColor Color
Read Write Property: Color of the clip.
FBPropertyVideo TrackVideo
Read Only Property: This FBVideo can be used as a texture.
FBPropertyDouble FrameRate
Read Write Property: Frame rate value. Only effective when UseSystemFrameRate is false.
FBStoryClip * Razor(FBTime pTime)
Razor.
FBPropertyBool GhostModel
Read Write Property: Show ghost of models
FBPropertyString ClipAudioPath
Read Write Property: Audio clip's file path
FBPropertyStoryClipNodeFunction TravellingNodeFunction
Read Write Property: Travelling node function. If set, this property will overwrite the Track's Trave...
virtual void RemoveAt(int pIndex)
Remove the object at pIndex.
@ kFBStoryClipMatchingTimeBetweenSelectedAndNextClip
Matches the selected clip and the next clip at the middle of the blend.
fbxsdk ::FbxScene * GetFbxScene()
Get KFbxScene.
FBPropertyString Label
Read Write Property: Label to display for this story folder.
FBPropertyBool UseSystemFrameRate
Read Write Property: Whether always use system frame rate.
void AlignSelectedClipsGroup(FBStoryGroupClipAlignmentType pType)
Used to align clips inside a group.
@ kFBStoryGroupClipAlignmentEndPreviousWithOffset
Align the clips contained in the group clip to the end of the previous clip, while keeping the relati...
virtual void RemoveAt(int pIndex)
Remove the object at pIndex.
FBPropertyTime Offset
Read Write Property: First loop time offset.
FBPropertyBool MaintainShotAndClipShotLengthsSynced
Read Write Property: When working in time discontinuity, if true, shots and their corresponding shot ...
@ kFBStoryTrackAudio
Audio track.
void Razor(FBTime pTime)
Razor.
void AddClip(FBComponent *pClip, FBTime pTime)
AddClip Add the clip to the track.
FBPropertyVector3d Rotation
Read Write Property: Animation clip's rotation offset. Refer to class notes to learn more about how t...
PropertyEvent: Base event class.
FBStoryClipMatchingTimeType
Matching Time Types, when matching clips to each other.
virtual void FBDelete() override
Virtual FBDelete function.
FBPropertyBool LockPitchToSpeed
Read Write Property: Time-stretching enabled or not.
@ kFBStoryClipAlignmentCurrentTimelineWithOffset
Align all selected clips with the current time, while keeping the relative offset.
@ kFBStoryClipMirrorPlaneZY
Z-Y plane.
@ kFBStoryClipUpdateUI
Clip UI update.
class K_DLLIMPORT FBPropertyBase< bool, kFBPT_bool > FBPropertyBool
Property: bool
@ kFBStoryClipMatchingRotationXYZ
Rotates a selected clip's match object to the same orientation as the previous clip's match object.
FBPropertyVector3d Translation
Read Write Property: Animation clip's translation offset. Refer to class notes to learn more about ho...
virtual FBStoryFolder * operator[](int pIndex)
Get the folder at pIndex.
@ kFBStoryClipNodeNone
None.
@ kFBStoryClipMatchingTranslationGravityXZ
Translates a selected clip's match object along the global X and Z axes.
FBPropertyStoryClipSolveMode SolvingMode
Read Write Property: Solve Modes for story character clips. See FBStoryClipSolveMode
FBStoryTrackGhostShowMode
Ghost Show Modes for story animation tracks.
FBPropertyBool StartStopLocked
Read Write Property: Clip's 'In/Out Locked' property value. True if the clip's In/Out properties (sta...
FBStoryClip(const char *pFilePath, FBStoryTrack *pTrack, FBTime pTime, HIObject pObject=NULL)
Constructor.
@ kFBStoryClipTimeWarpInterpolatorCustom
'Custom' TimeWarp Interpolation
bool CanAssignSourcesToDestinations()
CanAssignSourcesToDestinations.
FBStoryClipMatchingTranslationType
Matching Translation, Types when matching clips to each other.
FBStoryClipShowGhostMode
Show Ghost Modes for story animation clips.
@ kFBStoryTrackShowAllClips
Show the ghosts for all the clips on the track.
bool SetReadOnly(bool pMakeClipReadOnly, FBString pOutputFile=FBString())
SetReadOnly Assigns the clip read-only status.
virtual int Add(FBStoryTrack *pItem)
Add a track to the property list.
FBPropertyStoryClipGhostTimeMode GhostManipulatorMode
Read Write Property: Time mode to display ghost manipulator. See FBStoryClipGhostTimeMode.
FBPropertyBool ShowBackplate
Read Write Property: If true, the backplate will be shown.
FBPropertyBool OffsetEnable
Read Write Property: When enabled, allow clip to be offset
@ kFBStoryClipMoveBlend
Clip move blend.
FBPropertyBool Mute
Read Write Property: If true, the Story mode will be globally disabled.
@ kFBStoryClipUser
User defined compensation.
@ kFBStoryClipAnimSkeleton
Solve skeleton animation.
@ kFBStoryClipGhostCustom
Show the ghost at custom time of the clip. See GhostManipulatorCustomTime property.
@ kFBStoryClipMatchingRotationDefault
Uses the matching translation type stored in the Application configuration file: [Story] > MatchRotat...
FBPropertyStoryTrackRefMode ReferenceMode
Read Write Property: Track composition mode, kFBStoryTrackOverride or kFBStoryTrackAdditive
@ kFBStoryTrackShot
Shot track.
@ kFBStoryClipTimeWarpInterpolatorSmoothedEndsReversed
'Reversed, Smoothed Ends' TimeWarp Interpolation
FBPropertyVideo ShotBackplate
Read Write Property: The backplate used for that specific shot.
Base class for constraints.
Contains definitions for devices, boxes and models.
Template class to contain an array of items.
@ kFBStoryClipTimeWarpInterpolatorSmoothedEnds
'Smoothed Ends' TimeWarp Interpolation
FBStoryTrackType
Types for new story tracks.
FBPropertyString Label
Read Write Property: Label to display for this story track.
#define FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
FBPropertyBool SummaryClip
Read Write Property: If true, summary clips for story folders will be created to help manipulating fo...
FBPropertyBool AutoLoop
Read Write Property: If true, clip will automatically loop
virtual int Remove(FBComponent *pItem)
Remove object pItem from property list.
virtual int Add(FBStoryClip *pItem)
Add a clip to the property list.
FBPropertyStoryClipShowGhostMode ShowGhostClipMode
Read Write Property: Show the ghost depending on the time. See FBStoryClipShowGhostMode
FBPropertyBool Ghost
Read Write Property: Show ghosts
FBPropertyListStoryTrack Tracks
List: Tracks of this folder.
virtual int Add(FBStoryFolder *pItem)
Add a folder to the property list.
virtual int GetCount()
Get the number of folder.
@ kFBStoryClipRetargetSkeleton
Solve retarget skeleton.
@ kFBStoryTrackCamera
Camera animation track.
FBPropertyBool ImageSequence
Read Write Property: Whether is a image sequence.
FBPropertyListStoryDetails Details
List: All objects associated to this track for processing.
@ kFBStoryClipAlignmentCurrentTimeline
Align all selected clips with the current time.
FBPropertyStoryTrackType Type
Read Only Property: Type of the track
FB_DEFINE_COMPONENT(K_DLLIMPORT, AnimationNode)
Animation node class.
@ kFBStoryClipTimeWarpInterpolatorSlowingDown
'Slowing Down' TimeWarp Interpolation
int CleanEmptyTracksAndFolders()
Remove all empty tracks and folders present in the Story Tool.
FBPropertyStoryTrackGhostShowMode GhostShowTrackMode
Read Write Property: Show the ghosts for all the clips or only the adjacent clips....
@ kFBStoryClipMatchingRotationNone
The clip's match object is not rotated to match another clip's animation.
FBPropertyBool Mute
Read Write Property: If true, this story folder will be muted.
virtual int Remove(FBStoryTrack *pItem)
Remove track pItem from property list.
FBPropertyTime Stop
Read Write Property: Stop time of the clip local to its track.
FBPropertyBool Loop
Read Write Property: If true, loop clip's animation
class K_DLLIMPORT FBPropertyBase< FBTimeSpan, kFBPT_TimeSpan > FBPropertyTimeSpan
Property: FBTimeSpan
@ kFBStoryClipNodeFloorProjection
Project on XZ plane.
FBPropertyBool MirrorAnimation
Read Write Property: If true, clip animation will be mirrored
FBPropertyBool ShotStartStopLocked
Read Write Property: Shot clip's 'In/Out Locked' property value. True if the shot clip's In/Out prope...
FBPropertyStoryFolder RootFolder
Read Only Property: Story's root folder
bool ExportToFile(FBString pOutputFile)
ExportToFile.
virtual int Remove(FBStoryClip *pItem)
Remove clip pItem from property list.
@ kFBStoryTrackOverride
Override track.
FBPropertyBool GhostPivot
Read Write Property: Show ghost of match object
FBPropertyListObject DependentClips
Read Write Property: Clips that are included in the group clip.
@ kFBStoryClipAlways
Always show the ghost.
FBStoryClipCompMode
Compensation Modes for story character clips.
FBStoryClip * Clone()
Clone the clip.
@ kFBStoryClipAnimFkIk
Solve forward and inverse kinematic animation.
static FBStory & TheOne()
Get the global story object.
FBPropertyListObject TravellingNode
List: Travelling node(s). If set, this property will overwrite the Track's Travelling node(s).
FBPropertyInt AudioOutIndex
Read Write Property: Audio Output's index to use.
Property class: const char * (String).
void Match(FBString pObjectName, FBStoryClipMatchingTimeType pTimeType, FBStoryClipMatchingTranslationType pTranslationType, FBStoryClipMatchingRotationType pRotationType)
Match.
MotionBuilder SDK base class.
FBPropertyBool NoneBlockingPostprocess
Read Write Property: If true, record to disk will post process recorded data in low priority thread w...
List: Story track Details
FBStoryClipGhostTimeMode
Time mode to display ghost.
virtual FBModel * operator[](int pIndex)
Get the object at pIndex.
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
Matches the start of the selected clip to the start of the blend with the previous clip.
FBStoryClip(const char *pFilePath, FBStoryTrack *pTrack, FBTime pTime, FBTime pTimeOffset, HIObject pObject=NULL)
Constructor.
FBStoryClipAlignmentType
Alignment Types when aligning clips.
FBPropertyStoryTrack ParentTrack
Read Only Property: Parent track, if the track is of Character or Animation type.
@ kFBStoryClipGhostStart
Show the ghost at start time of the clip.
FBPropertyBool AcceptKey
Read Write Property: Allow track to accept keys
virtual int Add(FBStoryTrack *pItem)
Add a sub-track to the property list.
bool GetReadOnly()
GetReadOnly Retrieves the clip read-only status.
FBStoryClipMirrorPlane
Several mirror planes to mirror animation.
@ kFBStoryTrackAdditive
Additive track.
@ kFBStoryClipAlignmentEndPrevious
Align selected clips to the end of the previous clip.
void AlignSelectedClips(FBStoryClipAlignmentType pType, FBComponent *pReferenceClip)
Used to align selected clips .
virtual void FBDelete() override
Virtual FBDelete function.
bool IsBodyPartEnabled(FBStoryTrackBodyPart pPart)
IsBodyPartEnabled.