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>
#include <fbxsdk/fbxsdk_nsbegin.h>
#include <fbxsdk/fbxsdk_nsend.h>

Go to the source code of this file.

Classes

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...

Defines

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

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,
  kFBStoryTrackBodyPartUpperBody, kFBStoryTrackBodyPartLeftFoot = 1 << 7, kFBStoryTrackBodyPartLeftLeg = 1 << 8 | kFBStoryTrackBodyPartLeftFoot, kFBStoryTrackBodyPartRightFoot = 1 << 9,
  kFBStoryTrackBodyPartRightLeg = 1 << 10| kFBStoryTrackBodyPartRightFoot, kFBStoryTrackBodyPartLowerBody = kFBStoryTrackBodyPartLeftLeg | kFBStoryTrackBodyPartLeftFoot | kFBStoryTrackBodyPartRightLeg | kFBStoryTrackBodyPartRightFoot, kFBStoryTrackBodyPartAll = kFBStoryTrackBodyPartUpperBody | kFBStoryTrackBodyPartLowerBody, kFBStoryTrackBodyPartProps = 1 << 11,
  kFBStoryTrackBodyPartExtensions = 1 << 12
}
 

Body Parts for story track character.

More...
enum  FBStoryClipShowGhostMode { kFBStoryClipAlways, kFBStoryClipTimeCursor }
 

Show Ghost Modes for story animation clips.

More...
enum  FBStoryClipSolveMode { kFBStoryClipRetargetSkeleton, kFBStoryClipAnimSkeleton, kFBStoryClipAnimFkIk, kFBStoryClipAnimSkeletonIk }
 

Solve Modes for story character clips.

More...
enum  FBStoryClipCompMode { kFBStoryClipOff, kFBStoryClipAuto, kFBStoryClipUser }
 

Compensation Modes for story character clips.

More...

Functions

 __FB_FORWARD (FBStory)
 __FB_FORWARD (FBStoryFolder)
 __FB_FORWARD (FBStoryTrack)
 __FB_FORWARD (FBStoryClip)
 FB_DEFINE_COMPONENT (FBSDK_DLL, Story)
 FB_DEFINE_COMPONENT (FBSDK_DLL, StoryFolder)
 FB_DEFINE_COMPONENT (FBSDK_DLL, StoryTrack)
 FB_DEFINE_COMPONENT (FBSDK_DLL, StoryClip)
 FB_DEFINE_COMPONENT (FBSDK_DLL, AnimationNode)
 FB_DEFINE_COMPONENT (FBSDK_DLL, Video)
 FB_DEFINE_COMPONENT (FBSDK_DLL, AudioClip)
 FB_DEFINE_ENUM (FBSDK_DLL, StoryTrackType)
 FB_DEFINE_ENUM (FBSDK_DLL, StoryTrackRefMode)
 FB_DEFINE_ENUM (FBSDK_DLL, StoryClipShowGhostMode)
 FB_DEFINE_ENUM (FBSDK_DLL, StoryClipSolveMode)
 FB_DEFINE_ENUM (FBSDK_DLL, StoryClipCompMode)
 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.


Define Documentation

#define FBSDK_DLL   K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbstory.h.


Enumeration Type Documentation

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 78 of file fbstory.h.

References Modes for story animation tracks.

Enumerator:
kFBStoryTrackOverride 

Override track.

kFBStoryTrackAdditive 

Additive track.

Definition at line 90 of file fbstory.h.

Body Parts for story track character.

Enumerator:
kFBStoryTrackBodyPartNone 
kFBStoryTrackBodyPartHead 
kFBStoryTrackBodyPartLeftShoulder 
kFBStoryTrackBodyPartLeftHand 
kFBStoryTrackBodyPartLeftArm 
kFBStoryTrackBodyPartRightShoulder 
kFBStoryTrackBodyPartRightHand 
kFBStoryTrackBodyPartRightArm 
kFBStoryTrackBodyPartUpperBody 
kFBStoryTrackBodyPartLeftFoot 
kFBStoryTrackBodyPartLeftLeg 
kFBStoryTrackBodyPartRightFoot 
kFBStoryTrackBodyPartRightLeg 
kFBStoryTrackBodyPartLowerBody 
kFBStoryTrackBodyPartAll 
kFBStoryTrackBodyPartProps 
kFBStoryTrackBodyPartExtensions 

Definition at line 96 of file fbstory.h.

Show Ghost Modes for story animation clips.

Enumerator:
kFBStoryClipAlways 

Always show the ghost.

kFBStoryClipTimeCursor 

Show the ghost only on time cursor.

Definition at line 126 of file fbstory.h.

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 132 of file fbstory.h.

Compensation Modes for story character clips.

Enumerator:
kFBStoryClipOff 

No compensation.

kFBStoryClipAuto 

Automatic compensation.

kFBStoryClipUser 

User defined compensation.

Definition at line 140 of file fbstory.h.


Function Documentation

__FB_FORWARD ( FBStory  )
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
Story   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
StoryFolder   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
StoryTrack   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
StoryClip   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
AnimationNode   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
Video   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
AudioClip   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
StoryTrackType   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
StoryTrackRefMode   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
StoryClipShowGhostMode   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
StoryClipSolveMode   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
StoryClipCompMode   
)