fbstory.h File Reference

Story interface for FBSDK. More...

#include <kaydaradef.h>
#include <fbsdk/fbcomponent.h>
#include <fbsdk/fbcore.h>
#include <fbsdk/fbvideo.h>
#include <fbsdk/fbmodel.h>
#include <fbsdk/fbcamera.h>

Go to the source code of this file.

Classes
class	FBEventClipChange
class	FBPropertyListStoryFolder
	List: StoryFolder More...
class	FBPropertyListStoryTrack
	List: StoryTrack More...
class	FBPropertyListStorySubTrack
	List: StorySubTrack More...
class	FBPropertyListStoryClip
	List: StoryClip More...
class	FBPropertyListStoryDetails
	List: Story track Details More...
class	FBPropertyListPivot
	List: Story Clip pivot models More...
class	FBStory
	Story Management class. More...
class	FBStoryFolder
	Story Folder class. More...
class	FBStoryTrack
	Story Track class. More...
class	FBStoryClip
	Story Clip class. More...
class	FBStoryGroupClip
	Story Group Clip class. More...

Macros
#define	FBSDK_DLL   K_DLLIMPORT
	Be sure that FBSDK_DLL is defined only once...
#define	FBXSDK_NAMESPACE   fbxsdk

Enumerations
enum	FBStoryTrackType {   kFBStoryTrackAnimation ,   kFBStoryTrackCamera ,   kFBStoryTrackCharacter ,   kFBStoryTrackConstraint ,   kFBStoryTrackCommand ,   kFBStoryTrackShot ,   kFBStoryTrackAudio ,   kFBStoryTrackVideo }
	Types for new story tracks. More...
enum	FBStoryTrackRefMode {   kFBStoryTrackOverride ,   kFBStoryTrackAdditive }
	References Modes for story animation tracks. More...
enum	FBStoryTrackBodyPart {   kFBStoryTrackBodyPartNone = 0 ,   kFBStoryTrackBodyPartHead = 1 << 0 ,   kFBStoryTrackBodyPartLeftShoulder = 1 << 1 ,   kFBStoryTrackBodyPartLeftHand = 1 << 2 ,   kFBStoryTrackBodyPartLeftArm = 1 << 3 | kFBStoryTrackBodyPartLeftShoulder | kFBStoryTrackBodyPartLeftHand ,   kFBStoryTrackBodyPartRightShoulder = 1 << 4 ,   kFBStoryTrackBodyPartRightHand = 1 << 5 ,   kFBStoryTrackBodyPartRightArm = 1 << 6 | kFBStoryTrackBodyPartRightShoulder | kFBStoryTrackBodyPartRightHand ,   kFBStoryTrackBodyPartLeftFoot = 1 << 7 ,   kFBStoryTrackBodyPartLeftLeg = 1 << 8 | kFBStoryTrackBodyPartLeftFoot ,   kFBStoryTrackBodyPartRightFoot = 1 << 9 ,   kFBStoryTrackBodyPartRightLeg = 1 << 10| kFBStoryTrackBodyPartRightFoot ,   kFBStoryTrackBodyPartProps = 1 << 11 ,   kFBStoryTrackBodyPartExtensions = 1 << 12 ,   kFBStoryTrackBodyPartSpine = 1 << 13 ,   kFBStoryTrackBodyPartUpperBody ,   kFBStoryTrackBodyPartLowerBody = kFBStoryTrackBodyPartLeftLeg | kFBStoryTrackBodyPartLeftFoot | kFBStoryTrackBodyPartRightLeg | kFBStoryTrackBodyPartRightFoot ,   kFBStoryTrackBodyPartAll = kFBStoryTrackBodyPartUpperBody | kFBStoryTrackBodyPartLowerBody }
	Body Parts for story track character. More...
enum	FBStoryTrackGhostShowMode {   kFBStoryTrackShowAllClips ,   kFBStoryTrackShowCurrentTimeAdjacentClips }
	Ghost Show Modes for story animation tracks. More...
enum	FBStoryClipShowGhostMode {   kFBStoryClipAlways ,   kFBStoryClipTimeCursor ,   kFBStoryClipTimeCustom }
	Show Ghost Modes for story animation clips. More...
enum	FBStoryClipGhostTimeMode {   kFBStoryClipGhostCurrent ,   kFBStoryClipGhostStart ,   kFBStoryClipGhostStop ,   kFBStoryClipGhostCustom }
	Time mode to display ghost. More...
enum	FBStoryClipNodeFunction {   kFBStoryClipNodeAverage ,   kFBStoryClipNodeFloorProjection ,   kFBStoryClipNodeNone }
	Node function. More...
enum	FBStoryClipSolveMode {   kFBStoryClipRetargetSkeleton ,   kFBStoryClipAnimSkeleton ,   kFBStoryClipAnimFkIk ,   kFBStoryClipAnimSkeletonIk }
	Solve Modes for story character clips. More...
enum	FBStoryClipMirrorPlane {   kFBStoryClipMirrorPlaneXY ,   kFBStoryClipMirrorPlaneZY ,   kFBStoryClipMirrorPlaneXZ }
	Several mirror planes to mirror animation. More...
enum	FBStoryClipCompMode {   kFBStoryClipOff ,   kFBStoryClipAuto ,   kFBStoryClipUser }
	Compensation Modes for story character clips. More...
enum	FBStoryClipMatchingTimeType {   kFBStoryClipMatchingTimeCurrentTime ,   kFBStoryClipMatchingTimeStartOfSelectedClip ,   kFBStoryClipMatchingTimeBetweenPreviousAndSelectedClip ,   kFBStoryClipMatchingTimeEndOfPreviousClip ,   kFBStoryClipMatchingTimeStartOfNextClip ,   kFBStoryClipMatchingTimeBetweenSelectedAndNextClip ,   kFBStoryClipMatchingTimeEndOfSelectedClip ,   kFBStoryClipMatchingTimeDefault }
	Matching Time Types, when matching clips to each other. More...
enum	FBStoryClipMatchingTranslationType {   kFBStoryClipMatchingTranslationNone ,   kFBStoryClipMatchingTranslationXYZ ,   kFBStoryClipMatchingTranslationGravityXZ ,   kFBStoryClipMatchingTranslationDefault }
	Matching Translation, Types when matching clips to each other. More...
enum	FBStoryClipMatchingRotationType {   kFBStoryClipMatchingRotationNone ,   kFBStoryClipMatchingRotationXYZ ,   kFBStoryClipMatchingRotationGravityXZ ,   kFBStoryClipMatchingRotationDefault }
	Matching Rotation Types, when matching clips to each other. More...
enum	FBStoryClipAlignmentType {   kFBStoryClipAlignmentCurrentTimeline ,   kFBStoryClipAlignmentEndPrevious ,   kFBStoryClipAlignmentEndPreviousAllAligned ,   kFBStoryClipAlignmentBeginningNext ,   kFBStoryClipAlignmentBeginningNextAllAligned ,   kFBStoryClipAlignmentCurrentTimelineWithOffset ,   kFBStoryClipAlignmentEndPreviousWithOffset ,   kFBStoryClipAlignmentBeginningNextWithOffset }
	Alignment Types when aligning clips. More...
enum	FBStoryGroupClipAlignmentType {   kFBStoryGroupClipAlignmentCurrentTimeline ,   kFBStoryGroupClipAlignmentEndPreviousWithOffset ,   kFBStoryGroupClipAlignmentBeginningNextWithOffset }
	Alignment Types when aligning groups. More...
enum	FBStoryClipChangeType {   kFBStoryClipNotSet ,   kFBStoryClipMoveClip ,   kFBStoryClipMoveData ,   kFBStoryClipMoveBlend ,   kFBStoryClipUpdateUI ,   kFBStoryClipRemoved }
	Types of clip change events, matching KEventClip.eType Expose only kFBStoryClipMoveClip and kFBStoryClipRemoved for now. More...
enum	FBStoryClipTimeWarpInterpolatorType {   kFBStoryClipTimeWarpInterpolatorCustom ,   kFBStoryClipTimeWarpInterpolatorLinear ,   kFBStoryClipTimeWarpInterpolatorSmoothedEnds ,   kFBStoryClipTimeWarpInterpolatorGoingFaster ,   kFBStoryClipTimeWarpInterpolatorSlowingDown ,   kFBStoryClipTimeWarpInterpolatorLinearReversed ,   kFBStoryClipTimeWarpInterpolatorSmoothedEndsReversed ,   kFBStoryClipTimeWarpInterpolatorGoingFasterReversed ,   kFBStoryClipTimeWarpInterpolatorSlowingDownReversed }
	Types of TimeWrap Interpolator for Story Clips. More...

Functions
	__FB_FORWARD (FBStory)
	__FB_FORWARD (FBStoryFolder)
	__FB_FORWARD (FBStoryTrack)
	__FB_FORWARD (FBStoryClip)
	__FB_FORWARD (FBStoryGroupClip)
	FB_DEFINE_COMPONENT (K_DLLIMPORT, Story)
	FB_DEFINE_COMPONENT (K_DLLIMPORT, StoryFolder)
	FB_DEFINE_COMPONENT (K_DLLIMPORT, StoryTrack)
	FB_DEFINE_COMPONENT (K_DLLIMPORT, StoryClip)
	FB_DEFINE_COMPONENT (K_DLLIMPORT, StoryGroupClip)
	FB_DEFINE_COMPONENT (K_DLLIMPORT, AnimationNode)
	FB_DEFINE_COMPONENT (K_DLLIMPORT, Video)
	FB_DEFINE_COMPONENT (K_DLLIMPORT, AudioClip)
	FB_DEFINE_ENUM (K_DLLIMPORT, StoryClipChangeType)
	FB_DEFINE_ENUM (K_DLLIMPORT, StoryTrackType)
	FB_DEFINE_ENUM (K_DLLIMPORT, StoryTrackRefMode)
	FB_DEFINE_ENUM (K_DLLIMPORT, StoryTrackGhostShowMode)
	FB_DEFINE_ENUM (K_DLLIMPORT, StoryClipShowGhostMode)
	FB_DEFINE_ENUM (K_DLLIMPORT, StoryClipGhostTimeMode)
	FB_DEFINE_ENUM (K_DLLIMPORT, StoryClipNodeFunction)
	FB_DEFINE_ENUM (K_DLLIMPORT, StoryClipSolveMode)
	FB_DEFINE_ENUM (K_DLLIMPORT, StoryClipMirrorPlane)
	FB_DEFINE_ENUM (K_DLLIMPORT, StoryClipCompMode)
	FB_DEFINE_ENUM (K_DLLIMPORT, StoryClipAlignmentType)
	FB_DEFINE_ENUM (K_DLLIMPORT, StoryClipTimeWarpInterpolatorType)
	__FB_FORWARD (FBEventClipChange)
	FB_FORWARD (FBPropertyListStoryFolder)
	FB_FORWARD (FBPropertyListStoryTrack)
	FB_FORWARD (FBPropertyListStorySubTrack)
	FB_FORWARD (FBPropertyListStoryClip)
	FB_FORWARD (FBPropertyListStoryDetails)
	FB_FORWARD (FBPropertyListPivot)

Detailed Description

Story interface for FBSDK.

Definition in file fbstory.h.

Macro Definition Documentation

FBSDK_DLL

#define FBSDK_DLL   K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbstory.h.

FBXSDK_NAMESPACE

#define FBXSDK_NAMESPACE   fbxsdk

Definition at line 58 of file fbstory.h.

Enumeration Type Documentation

FBStoryClipAlignmentType

enum FBStoryClipAlignmentType

Alignment Types when aligning clips.

Enumerator
kFBStoryClipAlignmentCurrentTimeline	Align all selected clips with the current time.
kFBStoryClipAlignmentEndPrevious	Align selected clips to the end of the previous clip.
kFBStoryClipAlignmentEndPreviousAllAligned	Align selected clips to the end of the previous clip, all clips will be align to the selected clip position.
kFBStoryClipAlignmentBeginningNext	Align selected clips to the beginning of the next clip.
kFBStoryClipAlignmentBeginningNextAllAligned	Align selected clips to the beginning of the next clip, all clips will be align to the selected clip position.
kFBStoryClipAlignmentCurrentTimelineWithOffset	Align all selected clips with the current time, while keeping the relative offset.
kFBStoryClipAlignmentEndPreviousWithOffset	Align selected clips to the end of the previous clip, while keeping the relative offset.
kFBStoryClipAlignmentBeginningNextWithOffset	Align selected clips to the beginning of the next clip, while keeping the relative offset.

Definition at line 216 of file fbstory.h.

FBStoryClipChangeType

enum FBStoryClipChangeType

Types of clip change events, matching KEventClip.eType Expose only kFBStoryClipMoveClip and kFBStoryClipRemoved for now.

Enumerator
kFBStoryClipNotSet	Clip none.
kFBStoryClipMoveClip	Clip moved.
kFBStoryClipMoveData	Clip data moved.
kFBStoryClipMoveBlend	Clip move blend.
kFBStoryClipUpdateUI	Clip UI update.
kFBStoryClipRemoved	Clip removed.

Definition at line 236 of file fbstory.h.

FBStoryClipCompMode

enum FBStoryClipCompMode

Compensation Modes for story character clips.

Enumerator
kFBStoryClipOff	No compensation.
kFBStoryClipAuto	Automatic compensation.
kFBStoryClipUser	User defined compensation.

Definition at line 177 of file fbstory.h.

FBStoryClipGhostTimeMode

enum FBStoryClipGhostTimeMode

Time mode to display ghost.

Enumerator
kFBStoryClipGhostCurrent	Show the ghost at current time of the clip.
kFBStoryClipGhostStart	Show the ghost at start time of the clip.
kFBStoryClipGhostStop	Show the ghost at stop time of the clip.
kFBStoryClipGhostCustom	Show the ghost at custom time of the clip. See GhostManipulatorCustomTime property.

Definition at line 147 of file fbstory.h.

FBStoryClipMatchingRotationType

enum FBStoryClipMatchingRotationType

Matching Rotation Types, when matching clips to each other.

Enumerator
kFBStoryClipMatchingRotationNone	The clip's match object is not rotated to match another clip's animation.
kFBStoryClipMatchingRotationXYZ	Rotates a selected clip's match object to the same orientation as the previous clip's match object.
kFBStoryClipMatchingRotationGravityXZ	Rotates a selected clip's match object around the global Y axis.
kFBStoryClipMatchingRotationDefault	Uses the matching translation type stored in the Application configuration file: [Story] > MatchRotation. This value, in the configuration file, is update each time a matching is done, with the selected value.

Definition at line 206 of file fbstory.h.

FBStoryClipMatchingTimeType

enum FBStoryClipMatchingTimeType

Matching Time Types, when matching clips to each other.

Enumerator
kFBStoryClipMatchingTimeCurrentTime	Matches the start of the selected clip to the previous/next clip at the current time.
kFBStoryClipMatchingTimeStartOfSelectedClip	Matches the start of the selected clip to the start of the blend with the previous clip.
kFBStoryClipMatchingTimeBetweenPreviousAndSelectedClip	Matches the selected clip and the previous clip at the middle of the blend.
kFBStoryClipMatchingTimeEndOfPreviousClip	Matches the end of the blend with the selected clip to the end of the previous clip.
kFBStoryClipMatchingTimeStartOfNextClip	Matches the start of the blend with the selected clip to the start of the next clip.
kFBStoryClipMatchingTimeBetweenSelectedAndNextClip	Matches the selected clip and the next clip at the middle of the blend.
kFBStoryClipMatchingTimeEndOfSelectedClip	Matches the end of the selected clip to the end of the blend with the previous clip.
kFBStoryClipMatchingTimeDefault	Uses the matching time type stored in the Application configuration file: [Story] > MatchWhen. This value, in the configuration file, is update each time a matching is done, with the selected value.

Definition at line 184 of file fbstory.h.

FBStoryClipMatchingTranslationType

enum FBStoryClipMatchingTranslationType

Matching Translation, Types when matching clips to each other.

Enumerator
kFBStoryClipMatchingTranslationNone	The clip's match object is not translated to match another clip's animation.
kFBStoryClipMatchingTranslationXYZ	Translates a selected clip's match object to the same location as the previous clip's match object.
kFBStoryClipMatchingTranslationGravityXZ	Translates a selected clip's match object along the global X and Z axes.
kFBStoryClipMatchingTranslationDefault	Uses the matching translation type stored in the Application configuration file: [Story] > MatchTranslation. This value, in the configuration file, is update each time a matching is done, with the selected value.

Definition at line 197 of file fbstory.h.

FBStoryClipMirrorPlane

enum FBStoryClipMirrorPlane

Several mirror planes to mirror animation.

Enumerator
kFBStoryClipMirrorPlaneXY	X-Y plane.
kFBStoryClipMirrorPlaneZY	Z-Y plane.
kFBStoryClipMirrorPlaneXZ	X-Z plane.

Definition at line 170 of file fbstory.h.

FBStoryClipNodeFunction

enum FBStoryClipNodeFunction

Node function.

Enumerator
kFBStoryClipNodeAverage	Average.
kFBStoryClipNodeFloorProjection	Project on XZ plane.
kFBStoryClipNodeNone	None.

Definition at line 155 of file fbstory.h.

FBStoryClipShowGhostMode

enum FBStoryClipShowGhostMode

Show Ghost Modes for story animation clips.

Enumerator
kFBStoryClipAlways	Always show the ghost.
kFBStoryClipTimeCursor	Show the ghost only on time cursor.
kFBStoryClipTimeCustom	Show the ghost for custom time frame.

Definition at line 140 of file fbstory.h.

FBStoryClipSolveMode

enum FBStoryClipSolveMode

Solve Modes for story character clips.

Enumerator
kFBStoryClipRetargetSkeleton	Solve retarget skeleton.
kFBStoryClipAnimSkeleton	Solve skeleton animation.
kFBStoryClipAnimFkIk	Solve forward and inverse kinematic animation.
kFBStoryClipAnimSkeletonIk	Solve skeleton inverse kinematic animation.

Definition at line 162 of file fbstory.h.

FBStoryClipTimeWarpInterpolatorType

enum FBStoryClipTimeWarpInterpolatorType

Types of TimeWrap Interpolator for Story Clips.

Enumerator
kFBStoryClipTimeWarpInterpolatorCustom	'Custom' TimeWarp Interpolation
kFBStoryClipTimeWarpInterpolatorLinear	'Normal' TimeWarp Interpolation
kFBStoryClipTimeWarpInterpolatorSmoothedEnds	'Smoothed Ends' TimeWarp Interpolation
kFBStoryClipTimeWarpInterpolatorGoingFaster	'Going Faster' TimeWarp Interpolation
kFBStoryClipTimeWarpInterpolatorSlowingDown	'Slowing Down' TimeWarp Interpolation
kFBStoryClipTimeWarpInterpolatorLinearReversed	'Reversed' TimeWarp Interpolation
kFBStoryClipTimeWarpInterpolatorSmoothedEndsReversed	'Reversed, Smoothed Ends' TimeWarp Interpolation
kFBStoryClipTimeWarpInterpolatorGoingFasterReversed	'Reversed, Going Faster' TimeWarp Interpolation
kFBStoryClipTimeWarpInterpolatorSlowingDownReversed	'Reversed, Slowing Down' TimeWarp Interpolation

Definition at line 246 of file fbstory.h.

FBStoryGroupClipAlignmentType

enum FBStoryGroupClipAlignmentType

Alignment Types when aligning groups.

Enumerator
kFBStoryGroupClipAlignmentCurrentTimeline	Align the clips contained in the group clip with the current time.
kFBStoryGroupClipAlignmentEndPreviousWithOffset	Align the clips contained in the group clip to the end of the previous clip, while keeping the relative offset.
kFBStoryGroupClipAlignmentBeginningNextWithOffset	Align the clips contained in the group clip to the beginning of the next clip, while keeping the relative offset.

Definition at line 228 of file fbstory.h.

FBStoryTrackBodyPart

enum FBStoryTrackBodyPart

Body Parts for story track character.

Definition at line 102 of file fbstory.h.

FBStoryTrackGhostShowMode

enum FBStoryTrackGhostShowMode

Ghost Show Modes for story animation tracks.

Enumerator
kFBStoryTrackShowAllClips	Show the ghosts for all the clips on the track.
kFBStoryTrackShowCurrentTimeAdjacentClips	Show the ghosts only for the previous clip, current clip, and next clip relative to current time.

Definition at line 134 of file fbstory.h.

FBStoryTrackRefMode

enum FBStoryTrackRefMode

References Modes for story animation tracks.

Enumerator
kFBStoryTrackOverride	Override track.
kFBStoryTrackAdditive	Additive track.

Definition at line 96 of file fbstory.h.

FBStoryTrackType

enum FBStoryTrackType

Types for new story tracks.

Enumerator
kFBStoryTrackAnimation	Animation track.
kFBStoryTrackCamera	Camera animation track.
kFBStoryTrackCharacter	Character animation track.
kFBStoryTrackConstraint	Constraint track.
kFBStoryTrackCommand	Command track.
kFBStoryTrackShot	Shot track.
kFBStoryTrackAudio	Audio track.
kFBStoryTrackVideo	Video track.

Definition at line 84 of file fbstory.h.