Open Reality Reference Guide
fbcharacterextension.h File Reference

Character extension interface for FBSDK. More...

#include <kaydaradef.h>
#include <fbsdk/fbkeyinggroup.h>
#include <fbsdk/fbmodel.h>

Go to the source code of this file.

Classes

class  FBPropertyListCharacterExtension
 Character extension property list. More...
 
class  FBCharacterExtension
 Objects Grouping class. More...
 

Macros

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

Enumerations

enum  FBPlotAllowed {
  kFBPlotAllowed_None ,
  kFBPlotAllowed_Skeleton ,
  kFBPlotAllowed_ControlRig ,
  kFBPlotAllowed_Both
}
 
enum  FBSyncActivationAndVisibilityMode {
  kFBSyncMode_None ,
  kFBSyncMode_WithContolRig ,
  kFBSyncMode_WithOthersThanControlRig
}
 
enum  FBCharacterExtensionStancePoseMode {
  kFBStancePose_Never ,
  kFBStancePose_Selected ,
  kFBStancePose_Reference_Selected ,
  kFBStancePose_Self_Or_Reference_Selected ,
  kFBStancePose_Always
}
 
enum  FBCharacterExtensionRetargetMode {
  kFBRetargetModeOff ,
  kFBRetargetModeAuto ,
  kFBRetargetModeManual
}
 

Functions

 __FB_FORWARD (FBCharacterExtension)
 
 __FB_FORWARD (FBCharacter)
 
 __FB_FORWARD (FBObjectPose)
 
 FB_DEFINE_ENUM (K_DLLIMPORT, PlotAllowed)
 
 FB_DEFINE_ENUM (K_DLLIMPORT, SyncActivationAndVisibilityMode)
 
 FB_DEFINE_ENUM (K_DLLIMPORT, CharacterExtensionStancePoseMode)
 
 FB_DEFINE_COMPONENT (K_DLLIMPORT, CharacterExtension)
 
 FB_DEFINE_LIST (K_DLLIMPORT, CharacterExtension)
 
 FB_FORWARD (FBPropertyListCharacterExtension)
 
 FB_DEFINE_ENUM (K_DLLIMPORT, CharacterExtensionRetargetMode)
 

Detailed Description

Character extension interface for FBSDK.

Definition in file fbcharacterextension.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 fbcharacterextension.h.

Enumeration Type Documentation

◆ FBCharacterExtensionRetargetMode

Character extension Retarget Mode

Enumerator
kFBRetargetModeOff 

Off.

kFBRetargetModeAuto 

Auto Mapping.

kFBRetargetModeManual 

Manually Assign.

Definition at line 97 of file fbcharacterextension.h.

◆ FBCharacterExtensionStancePoseMode

Character Extension Stance Pose mode when the stance pose is activated on a character.

Enumerator
kFBStancePose_Never 

Character extension will never go in stance pose.

kFBStancePose_Selected 

Character extension will go in stance pose if it is selected.

kFBStancePose_Reference_Selected 

Character extension will go in stance pose if its reference is selected.

kFBStancePose_Self_Or_Reference_Selected 

Character extension will go in stance pose if it is selected or if its reference is selected.

kFBStancePose_Always 

Character extension will always go in stance pose.

Definition at line 82 of file fbcharacterextension.h.

◆ FBPlotAllowed

FBPlotAllowed

Enumerator
kFBPlotAllowed_None 

kFBPlotAllowed_None.

kFBPlotAllowed_Skeleton 

kFBPlotAllowed_Skeleton

kFBPlotAllowed_ControlRig 

kFBPlotAllowed_ControlRig

kFBPlotAllowed_Both 

kFBPlotAllowed_Both

Definition at line 63 of file fbcharacterextension.h.

◆ FBSyncActivationAndVisibilityMode

Sync mode for Constraints' Activeness and Models' visibility belonging to the Character Extension.

Enumerator
kFBSyncMode_None 

No particular sync activity. Default mode.

kFBSyncMode_WithContolRig 

Enable Constraints' Activeness and Models' visibility when the attached character is driven by its control rig, otherwise disable/hide them.

kFBSyncMode_WithOthersThanControlRig 

Enable Constraints' Activeness and Models' visibility when the attached character is driven by something else than its control rig, otherwise disable/hide them.

Definition at line 73 of file fbcharacterextension.h.