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>

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,   kFBStoryTrackUnknown }
	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

Search for all occurrences

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbstory.h.

---

Enumeration Type Documentation

enum FBStoryTrackType

Search for all occurrences

Types for new story tracks.

Enumerator:

kFBStoryTrackAnimation	Animation track. Search for all occurrences
kFBStoryTrackCamera	Camera animation track. Search for all occurrences
kFBStoryTrackCharacter	Character animation track. Search for all occurrences
kFBStoryTrackConstraint	Constraint track. Search for all occurrences
kFBStoryTrackCommand	Command track. Search for all occurrences
kFBStoryTrackShot	Shot track. Search for all occurrences
kFBStoryTrackAudio	Audio track. Search for all occurrences
kFBStoryTrackVideo	Video track. Search for all occurrences
kFBStoryTrackUnknown	Search for all occurrences

Definition at line 73 of file fbstory.h.

                      {
    kFBStoryTrackAnimation,     
    kFBStoryTrackCamera,        
    kFBStoryTrackCharacter,     
    kFBStoryTrackConstraint,    
    kFBStoryTrackCommand,       
    kFBStoryTrackShot,          
    kFBStoryTrackAudio,         
    kFBStoryTrackVideo,         
    kFBStoryTrackUnknown
};

enum FBStoryTrackRefMode

Search for all occurrences

References Modes for story animation tracks.

Enumerator:

kFBStoryTrackOverride	Override track. Search for all occurrences
kFBStoryTrackAdditive	Additive track. Search for all occurrences

Definition at line 86 of file fbstory.h.

                         {
    kFBStoryTrackOverride,  
    kFBStoryTrackAdditive   
};

enum FBStoryTrackBodyPart

Search for all occurrences

Body Parts for story track character.

Enumerator:

kFBStoryTrackBodyPartNone	Search for all occurrences
kFBStoryTrackBodyPartHead	Search for all occurrences
kFBStoryTrackBodyPartLeftShoulder	Search for all occurrences
kFBStoryTrackBodyPartLeftHand	Search for all occurrences
kFBStoryTrackBodyPartLeftArm	Search for all occurrences
kFBStoryTrackBodyPartRightShoulder	Search for all occurrences
kFBStoryTrackBodyPartRightHand	Search for all occurrences
kFBStoryTrackBodyPartRightArm	Search for all occurrences
kFBStoryTrackBodyPartUpperBody	Search for all occurrences
kFBStoryTrackBodyPartLeftFoot	Search for all occurrences
kFBStoryTrackBodyPartLeftLeg	Search for all occurrences
kFBStoryTrackBodyPartRightFoot	Search for all occurrences
kFBStoryTrackBodyPartRightLeg	Search for all occurrences
kFBStoryTrackBodyPartLowerBody	Search for all occurrences
kFBStoryTrackBodyPartAll	Search for all occurrences
kFBStoryTrackBodyPartProps	Search for all occurrences
kFBStoryTrackBodyPartExtensions	Search for all occurrences

Definition at line 92 of file fbstory.h.

                          {
    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      = kFBStoryTrackBodyPartHead | 
                                          kFBStoryTrackBodyPartLeftArm | kFBStoryTrackBodyPartLeftShoulder | kFBStoryTrackBodyPartLeftHand |
                                          kFBStoryTrackBodyPartRightArm | kFBStoryTrackBodyPartRightShoulder | kFBStoryTrackBodyPartRightHand,

    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
};

enum FBStoryClipShowGhostMode

Search for all occurrences

Show Ghost Modes for story animation clips.

Enumerator:

kFBStoryClipAlways	Always show the ghost. Search for all occurrences
kFBStoryClipTimeCursor	Show the ghost only on time cursor. Search for all occurrences

Definition at line 122 of file fbstory.h.

                              {
    kFBStoryClipAlways,     
    kFBStoryClipTimeCursor  
};

enum FBStoryClipSolveMode

Search for all occurrences

Solve Modes for story character clips.

Enumerator:

kFBStoryClipRetargetSkeleton	Solve retarget skeleton. Search for all occurrences
kFBStoryClipAnimSkeleton	Solve skeleton animation. Search for all occurrences
kFBStoryClipAnimFkIk	Solve forward and inverse kinematic animation. Search for all occurrences
kFBStoryClipAnimSkeletonIk	Solve skeleton inverse kinematic animation. Search for all occurrences

Definition at line 128 of file fbstory.h.

                          {
    kFBStoryClipRetargetSkeleton,   
    kFBStoryClipAnimSkeleton,       
    kFBStoryClipAnimFkIk,           
    kFBStoryClipAnimSkeletonIk      
};

enum FBStoryClipCompMode

Search for all occurrences

Compensation Modes for story character clips.

Enumerator:

kFBStoryClipOff	No compensation. Search for all occurrences
kFBStoryClipAuto	Automatic compensation. Search for all occurrences
kFBStoryClipUser	User defined compensation. Search for all occurrences

Definition at line 136 of file fbstory.h.

                         {
    kFBStoryClipOff,    
    kFBStoryClipAuto,   
    kFBStoryClipUser    
};

---

Function Documentation

__FB_FORWARD

(

FBStory

)

Search for all occurrences

__FB_FORWARD

(

FBStoryFolder

)

Search for all occurrences

__FB_FORWARD

(

FBStoryTrack

)

Search for all occurrences

__FB_FORWARD

(

FBStoryClip

)

Search for all occurrences

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		Story
	)

Search for all occurrences

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		StoryFolder
	)

Search for all occurrences

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		StoryTrack
	)

Search for all occurrences

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		StoryClip
	)

Search for all occurrences

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		AnimationNode
	)

Search for all occurrences

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		Video
	)

Search for all occurrences

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		AudioClip
	)

Search for all occurrences

FB_DEFINE_ENUM	(	FBSDK_DLL	,
		StoryTrackType
	)

Search for all occurrences

FB_DEFINE_ENUM	(	FBSDK_DLL	,
		StoryTrackRefMode
	)

Search for all occurrences

FB_DEFINE_ENUM	(	FBSDK_DLL	,
		StoryClipShowGhostMode
	)

Search for all occurrences

FB_DEFINE_ENUM	(	FBSDK_DLL	,
		StoryClipSolveMode
	)

Search for all occurrences

FB_DEFINE_ENUM	(	FBSDK_DLL	,
		StoryClipCompMode
	)

Search for all occurrences

FB_FORWARD

(

FBPropertyListStoryFolder

)

Search for all occurrences

FB_FORWARD

(

FBPropertyListStoryTrack

)

Search for all occurrences

FB_FORWARD

(

FBPropertyListStorySubTrack

)

Search for all occurrences

FB_FORWARD

(

FBPropertyListStoryClip

)

Search for all occurrences

FB_FORWARD

(

FBPropertyListStoryDetails

)

Search for all occurrences

FB_FORWARD

(

FBPropertyListPivot

)

Search for all occurrences