Open Reality Reference Guide
fbapplication.h File Reference

this file contain FBApplication class interface More...

#include <kaydaradef.h>
#include <fbsdk/fbcomponent.h>

Go to the source code of this file.

Classes

class  FBBatchOptions
 Option parameters for the batch process. More...
 
class  FBPlotOptions
 Option parameters for plotting. More...
 
class  FBAudioRenderOptions
 Audio Render Options structure. More...
 
class  FBEventOverrideFileOpen
 Event that is called before a file open/merge. More...
 
class  FBPropertyEventOverrideFileOpen
 PropertyEvent: Event when a file is about to be opened/merged. More...
 
class  FBApplication
 FBApplication is used mainly to manage files. More...
 

Macros

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

Enumerations

enum  FBBatchProcessType {
  kFBBatchProcessTypeLoad ,
  kFBBatchProcessTypeSave ,
  kFBBatchProcessTypeConvert
}
 Different process type for the batch. More...
 
enum  FBBatchFileFormat {
  kFBBatchFileFormatTRC ,
  kFBBatchFileFormatC3D ,
  kFBBatchFileFormatAMC ,
  kFBBatchFileFormatBVH ,
  kFBBatchFileFormatHTR ,
  kFBBatchFileFormatFBX
}
 Different file formats for the batch. More...
 
enum  FBBatchOnTakeExist {
  kFBBatchOnTakeExistOverwrite ,
  kFBBatchOnTakeExistSkip
}
 Different actions to perform when a take already exist while in a batch process. More...
 
enum  FBBatchOnContainsBatchTakes {
  kFBBatchOnContainsBatchTakesSaveBatchTakesOnly ,
  kFBBatchOnContainsBatchTakesSaveAllTakes
}
 Different actions to perform when a scene already contains batch takes while in a batch process. More...
 
enum  FBBatchStatus {
  kFBBatchStatusSuccess ,
  kFBBatchStatusError ,
  kFBBatchStatusCharacterNotSpecified ,
  kFBBatchStatusCharacterNotCharacterized ,
  kFBBatchStatusCharacterHasNoReference ,
  kFBBatchStatusInputActorNotSpecified ,
  kFBBatchStatusActorInputMarkersetNotSpecified ,
  kFBBatchStatusActorInputMarkersetHasNoReferenceModel ,
  kFBBatchStatusActorInputMarkersetNotCorrectlyAssociated ,
  kFBBatchStatusInputCharacterNotCharacterized ,
  kFBBatchStatusInputCharacterHasNoReference ,
  kFBBatchStatusInputDirectoryNotValid ,
  kFBBatchStatusAsfSkeletonFileNotSpecified ,
  kFBBatchStatusCantOpenAsfSkeletonFile ,
  kFBBatchStatusOutputDirectoryNotValid
}
 Different return values of the Batch process. More...
 
enum  FBRotationFilter {
  kFBRotationFilterNone ,
  kFBRotationFilterGimbleKiller ,
  kFBRotationFilterUnroll
}
 Rotation filters. More...
 
enum  FBPlotTangentMode {
  kFBPlotTangentModeSmooth ,
  kFBPlotTangentModeSmoothClamp ,
  kFBPlotTangentModeSpline ,
  kFBPlotTangentModeSplineClamp ,
  kFBPlotTangentModeAuto
}
 The tangent mode for plotted curve. More...
 
enum  FBViewerMode {
  kFBViewerModeOneWindow ,
  kFBViewerModeTwoWindow ,
  kFBViewerModeThreeWindow ,
  kFBViewerModeFourWindow ,
  kFBViewerModeSchematic
}
 Different viewer modes for the 3D viewer. More...
 
enum  FBOneClickApplication {
  kFBOneClickNone ,
  kFBOneClickMaya ,
  kFBOneClick3dsMax ,
  kFBOneClickSoftimage
}
 Possible application for One-Click interop with MotionBuilder. More...
 
enum  FBApplicationState {
  kFBInteractive ,
  kFBBatch ,
  kFBMobuPy
}
 Application state the MotionBuilder application has been started in. More...
 
enum  FBConstantKeyReducerThresholdType {
  kFBTranslationThreshold ,
  kFBRotationThreshold ,
  kFBScalingThreshold ,
  kFBDefaultThreshold
}
 Different threshold types for the Constant Key Reducer filter. More...
 

Functions

 FB_FORWARD (FBBatchOptions)
 
 FB_DEFINE_ENUM (K_DLLIMPORT, BatchProcessType)
 
 FB_DEFINE_ENUM (K_DLLIMPORT, BatchFileFormat)
 
 FB_DEFINE_ENUM (K_DLLIMPORT, BatchOnTakeExist)
 
 FB_DEFINE_ENUM (K_DLLIMPORT, BatchOnContainsBatchTakes)
 
 FB_FORWARD (FBPlotOptions)
 
 FB_DEFINE_ENUM (K_DLLIMPORT, RotationFilter)
 
 FB_FORWARD (FBAudioRenderOptions)
 
 __FB_FORWARD (FBApplication)
 
 __FB_FORWARD (FBCharacter)
 
 __FB_FORWARD (FBActor)
 
 FB_DEFINE_COMPONENT (K_DLLIMPORT, Character)
 
 FB_DEFINE_COMPONENT (K_DLLIMPORT, Actor)
 
 FB_DEFINE_ENUM (K_DLLIMPORT, ApplicationState)
 
 FB_FORWARD (FBMotionFileOptions)
 
K_DLLIMPORT void FBPreventUIUpdateBegin ()
 Call to prevent UI updates when creating/deleting/renaming objects. More...
 
K_DLLIMPORT void FBPreventUIUpdateEnd ()
 Call to end blocking the UI updates. More...
 
K_DLLIMPORT bool FBPreventUIUpdateIsOn ()
 Call to tell if UI updates are blocked. More...
 
K_DLLIMPORT void FBMergeTransactionBegin ()
 Call to begin the transaction for merging multiple files. More...
 
K_DLLIMPORT void FBMergeTransactionEnd ()
 Call to end the merge transaction. More...
 
K_DLLIMPORT bool FBMergeTransactionIsOn ()
 Call to tell if system is during Merge transaction. More...
 
K_DLLIMPORT void FBMergeTransactionFileRefEditBegin ()
 Call to begin the transaction for merging multiple files and applying File Reference edit at the same time. More...
 
K_DLLIMPORT void FBMergeTransactionFileRefEditEnd ()
 Call to end merge transaction with File Reference edit. More...
 
K_DLLIMPORT bool FBMergeTransactionFileRefEditIsOn ()
 Call to tell if system is during File Reference Edit Merge transaction. More...
 
K_DLLIMPORT double FBGetConstantKeyReducerThresholdValue (FBConstantKeyReducerThresholdType pThresholdType)
 Return a specific threshold value used by the Constant Key Reducer filter. More...
 
K_DLLIMPORT void FBSetConstantKeyReducerThresholdValue (FBConstantKeyReducerThresholdType pThresholdType, double pValue)
 Set a specific threshold value used by the Constant Key Reducer filter. More...
 

Detailed Description

this file contain FBApplication class interface

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

Enumeration Type Documentation

◆ FBApplicationState

Application state the MotionBuilder application has been started in.

Enumerator
kFBInteractive 

Running in an interactive mode with the UI. Default mode.

kFBBatch 

Running in a batch mode, without the UI, i.e.: when starting MotionBuilder from the command line with the -batch command flag.

kFBMobuPy 

Running via the mobupy executable.

Definition at line 269 of file fbapplication.h.

◆ FBBatchFileFormat

Different file formats for the batch.

Enumerator
kFBBatchFileFormatTRC 

File format for Motion Analysis TRC.

kFBBatchFileFormatC3D 

File format for Vicon C3D.

kFBBatchFileFormatAMC 

File format for Acclaim AMC.

kFBBatchFileFormatBVH 

File format for Biovision BVH.

kFBBatchFileFormatHTR 

File format for Motion Analysis HTR.

kFBBatchFileFormatFBX 

File format for FBX (animation only).

Definition at line 73 of file fbapplication.h.

◆ FBBatchOnContainsBatchTakes

Different actions to perform when a scene already contains batch takes while in a batch process.

Enumerator
kFBBatchOnContainsBatchTakesSaveBatchTakesOnly 

Save only the batch takes.

kFBBatchOnContainsBatchTakesSaveAllTakes 

Save all the takes.

Definition at line 93 of file fbapplication.h.

◆ FBBatchOnTakeExist

Different actions to perform when a take already exist while in a batch process.

Enumerator
kFBBatchOnTakeExistOverwrite 

Overwrite the take.

kFBBatchOnTakeExistSkip 

Skip the take.

Definition at line 85 of file fbapplication.h.

◆ FBBatchProcessType

Different process type for the batch.

Enumerator
kFBBatchProcessTypeLoad 

Load the files and plot the character with every take.

kFBBatchProcessTypeSave 

Save the takes in different files.

kFBBatchProcessTypeConvert 

Does the load and save.

Definition at line 64 of file fbapplication.h.

◆ FBBatchStatus

Different return values of the Batch process.

Definition at line 101 of file fbapplication.h.

◆ FBOneClickApplication

Possible application for One-Click interop with MotionBuilder.

Enumerator
kFBOneClickNone 

No application.

kFBOneClickMaya 

Maya.

kFBOneClick3dsMax 

3ds Max.

kFBOneClickSoftimage 

Softimage.

Definition at line 257 of file fbapplication.h.

◆ FBPlotTangentMode

The tangent mode for plotted curve.

Definition at line 174 of file fbapplication.h.

◆ FBRotationFilter

Rotation filters.

Definition at line 165 of file fbapplication.h.

◆ FBViewerMode

Different viewer modes for the 3D viewer.

Enumerator
kFBViewerModeOneWindow 

View one pane.

kFBViewerModeTwoWindow 

View two panes.

kFBViewerModeThreeWindow 

View three panes.

kFBViewerModeFourWindow 

View four panes.

kFBViewerModeSchematic 

Schematic view.

Definition at line 247 of file fbapplication.h.