Open Reality Reference Guide
|
|
Go to the documentation of this file. 1 #ifndef __FBPAPPLICATION_H__
2 #define __FBPAPPLICATION_H__
43 #include <kaydaradef.h>
48 #define FBSDK_DLL K_DLLIMPORT
54 #ifdef FBSDKUseNamespace
55 namespace FBSDKNamespace {;
103 kFBBatchStatusSuccess,
105 kFBBatchStatusCharacterNotSpecified,
106 kFBBatchStatusCharacterNotCharacterized,
107 kFBBatchStatusCharacterHasNoReference,
108 kFBBatchStatusInputActorNotSpecified,
109 kFBBatchStatusActorInputMarkersetNotSpecified,
110 kFBBatchStatusActorInputMarkersetHasNoReferenceModel,
111 kFBBatchStatusActorInputMarkersetNotCorrectlyAssociated,
112 kFBBatchStatusInputCharacterNotCharacterized,
113 kFBBatchStatusInputCharacterHasNoReference,
114 kFBBatchStatusInputDirectoryNotValid,
115 kFBBatchStatusAsfSkeletonFileNotSpecified,
116 kFBBatchStatusCantOpenAsfSkeletonFile,
117 kFBBatchStatusOutputDirectoryNotValid
138 #if !defined(K_NO_CHARACTER)
167 kFBRotationFilterNone,
168 kFBRotationFilterGimbleKiller,
169 kFBRotationFilterUnroll
176 kFBPlotTangentModeSmooth,
177 kFBPlotTangentModeSmoothClamp,
178 kFBPlotTangentModeSpline,
179 kFBPlotTangentModeSplineClamp,
180 kFBPlotTangentModeAuto
207 #if !defined(K_NO_AUDIO)
233 #if !defined(K_NO_CHARACTER)
236 #if !defined(K_NO_ACTOR)
239 #if !defined(K_NO_CHARACTER)
242 #if !defined(K_NO_ACTOR)
255 #if !defined(K_NO_ONECLICK)
293 virtual void Add ( HICallback pOwner, kICallbackHandler pHandler );
294 virtual void Remove ( HICallback pOwner, kICallbackHandler pHandler );
356 bool FileNew(
bool pAskUser =
false,
bool pClearSceneName =
true);
374 bool FileOpen(
void* pBuffer, kULong pBufferLength );
384 bool GetMaxFrameCount(
void* pBuffer, kULong pBufferLength, kLong* pFrameCount,
int pTimeScale);
437 void FileExit(
bool pSave =
false,
int pExitCode = 0);
454 bool FileImport(
FBString pFilename,
bool pMatchModels =
false,
bool pCreateUnmatchedModels =
true );
508 #if !defined(K_NO_CHARACTER)
534 #if !defined(K_NO_ONECLICK)
570 #if !defined(K_NO_AUDIO)
588 #if !defined(K_NO_ACTOR)
591 #if !defined(K_NO_CHARACTER)
754 #ifdef FBSDKUseNamespace
FBViewerMode
Different viewer modes for the 3D viewer.
bool ExecuteScript(FBString pFilename)
Execute a python script file.
FBPropertyString FilePath
Read Only Property: Path to the file that will be opened/merged.
bool mPlotAuxEffectors
Should we plot aux effectors?
bool FileExport(FBString pFilename)
Export a motion file.
FBBatchOnContainsBatchTakes
Different actions to perform when a scene already contains batch takes while in a batch process.
@ kFBViewerModeFourWindow
View four panes.
FBApplication is used mainly to manage files.
void FlushEventQueue()
Flush event queue.
FBAudioChannelMode ChannelMode
Property: Audio render channel number, 1 for Mono(left channel right channel render mixed to one chan...
FBPropertyActor CurrentActor
Read Write Property: Indicate the current actor, as used by the character tool. Can be NULL....
bool mWriteTranslation
Write translation animation data included with Acclaim AMC files.
@ kFBBatchOnTakeExistSkip
Skip the take.
FBBatchOptions()
Constructor.
static FBApplication & TheOne()
Get the global object for this class.
FBPropertyBool WillOverride
Read Write Property: Set to true for handling the file load, false by default. If the return value is...
@ kFBViewerModeOneWindow
View one pane.
bool GetMaxFrameCount(void *pBuffer, kULong pBufferLength, kLong *pFrameCount, int pTimeScale)
Get max frame count from a scene file in memory.
bool IsValidBatchFile(const char *pFilename)
Verify motion file readability.
K_DLLIMPORT bool FBMergeTransactionIsOn()
Call to tell if system is during Merge transaction.
bool mPlotToControlSet
To plot the animation on the control set.
FBAudioBitDepthMode
Enum FBAudioBitDepthMode.
FBString mOutputDirectory
The directory containning the output files.
#define FB_DEFINE_ENUM(DllTag, Type)
Define an enum and give it the ability to be a property.
bool FileImport(FBString pFilename, bool pMatchModels=false, bool pCreateUnmatchedModels=true)
Import a motion file.
bool LoadAnimationOnCharacter(const char *pFileName, FBCharacter *pCharacter, FBFbxOptions *pFbxOptions, FBPlotOptions *pPlotOptions)
Load a rig and its animation from a file.
FBPropertyEvent OnFileOpen
Event: A File Open has been requested, nothing has been loaded yet.
FBPlotOptions()
Constructor.
void SetSceneRevisionNumber(const char *pRevNumber)
Set the scene revision number.
@ kFBBatchFileFormatAMC
File format for Acclaim AMC.
@ kFBTranslationThreshold
Translation threshold.
K_DLLIMPORT void FBPreventUIUpdateEnd()
Call to end blocking the UI updates.
FBCharacter * mCharacter
The character to receive the animation.
bool mUseSingleTake
Use only one take to convert all files.
K_DLLIMPORT void FBMergeTransactionFileRefEditBegin()
Call to begin the transaction for merging multiple files and applying File Reference edit at the same...
void SetSceneSubject(const char *pSubject)
Set the scene subject.
@ kFBRotationThreshold
Rotation threshold.
FBPropertyEvent OnFileMerge
Event: A File Merge has been requested, nothing has been loaded yet.
bool SaveCharacterRigAndAnimation(const char *pFileName, FBCharacter *pCharacter, FBFbxOptions *pFbxOptions)
Save the rig and its animation in a file.
FBPropertyEvent OnFileSaveCompleted
Event: A File Save has been completed.
FBPropertyEvent OnFileExit
Event: A File Exit as been requested, nothing has been destroyed yet.
virtual void Add(HICallback pOwner, kICallbackHandler pHandler)
Add/Remove a callback.
@ kFBBatchFileFormatFBX
File format for FBX (animation only).
FBTime mPlotPeriod
The plot period (1/fps).
bool mUseBatchSuffix
Add a batch suffix to the name of the files.
Option parameters for plotting.
K_DLLIMPORT void FBMergeTransactionEnd()
Call to end the merge transaction.
bool mPlotOnFrame
Should we plot on frame?
const char * GetSceneComment()
Return the scene comment from the scene properties.
K_DLLIMPORT void FBSetConstantKeyReducerThresholdValue(FBConstantKeyReducerThresholdType pThresholdType, double pValue)
Set a specific threshold value used by the Constant Key Reducer filter.
void SetSceneComment(const char *pComment)
Set the scene comment.
FBBatchFileFormat mOutputFileFormat
File format of the output files.
void SetSceneTitle(const char *pTitle)
Set the scene title.
const char * GetSceneRevisionNumber()
Return the scene revision number from the scene properties.
FBPropertyEventOverrideFileOpen OnOverrideFileOpen
Event: Called when a file is about to be opened/merged. The user can override the process with his ow...
bool FileNew(bool pAskUser=false, bool pClearSceneName=true)
Command File->New in the menus.
@ kFBOneClick3dsMax
3ds Max.
bool Minimize(bool pBlocking=true)
Minimize window.
void FileExit(bool pSave=false, int pExitCode=0)
Quit application.
bool FileOpen(const char *pFilename, bool pShowUIMsg=false, FBFbxOptions *pOptions=NULL)
Open a file, replacing the current scene.
FBString OutputFileName
Property: Audio Render destination file.
FBBatchStatus
Different return values of the Batch process.
const char * GetSceneAuthor()
Return the scene author from the scene properties.
FBPropertyEvent OnFileOpenCompleted
Event: A File Open has been completed.
A take is a container for animation in a scene.
bool mPlotAllTakes
Should we plot all takes?
FBActor is used to link motion data to a character.
@ kFBScalingThreshold
Scaling threshold.
Option parameters for the batch process.
#define FBSDK_DLL
Be sure that FBSDK_DLL is defined only once...
FBBatchOnContainsBatchTakes mOnContainsBatchTakesAction
Action to perform when a scene already contains batch takes while in a batch process.
bool mPreciseTimeDiscontinuities
Should we use precise time discontinuities?
FBPropertyCharacter CurrentCharacter
Read Write Property: Indicate the current character, as used by the character tool....
FBBatchFileFormat mInputFileFormat
File format of the input files.
@ kFBBatchFileFormatBVH
File format for Biovision BVH.
void SetSceneKeywords(const char *pKeywords)
Set the scene keywords.
bool FileAppend(const char *pFilename, bool pShowUIMsg=false, FBFbxOptions *pOptions=NULL)
Append one or multiple files to the current scene.
A character is the link between a motion source and a character model.
FBPropertyEvent OnFileNew
Event: A File New has been requested, nothing has been destroyed yet.
bool mWriteRate
Write frame rate in Acclaim AMC files.
K_DLLIMPORT double FBGetConstantKeyReducerThresholdValue(FBConstantKeyReducerThresholdType pThresholdType)
Return a specific threshold value used by the Constant Key Reducer filter.
@ kFBOneClickNone
No application.
bool FileImportBatch(const char *pName, FBBatchOptions *pBatchOptions, FBModel *pReference)
Import a motion file using batch options.
#define __FBClassDeclare(Name, Parent)
For internal use only.
FBPlotTangentMode
The tangent mode for plotted curve.
@ kFBBatchFileFormatTRC
File format for Motion Analysis TRC.
#define __FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
FBOneClickApplication
Possible application for One-Click interop with MotionBuilder.
void OneClickSelectPreviouslySentObject()
Select, in MotionBuilder, the object that were sent.
FBTimeSpan TimeSpan
Property: Start and stop selection time to render.
FBAudioBitDepthMode BitDepthMode
Property: Bit depth for one sample of audio. 8, 16 and 24 bits available for audio render,...
FBPropertyEvent OnFileNewCompleted
Event: A File New has been completed.
Customize motion file loading.
@ kFBBatchProcessTypeConvert
Does the load and save.
bool mKeepDummyBones
To keep dummy bones.
Audio Render Options structure.
FBAudioRenderOptions()
Constructor.
FBBatchOnTakeExist mOnTakeExistAction
Action to perform when a take already exist while in a batch process.
FBPlotTangentMode mPlotTangentMode
The tangent mode for plotted curve.
FBBatchOnTakeExist
Different actions to perform when a take already exist while in a batch process.
const char * GetSceneSubject()
Return the scene subject from the scene properties.
bool mStartAnimationAtZero
Set the time of all loaded files to 0.
@ kFBBatchFileFormatHTR
File format for Motion Analysis HTR.
FBRotationFilter
Rotation filters.
bool mOverwriteScaling
Set the scaling to a default setting of 1.0.
K_DLLIMPORT void FBMergeTransactionBegin()
Call to begin the transaction for merging multiple files.
FBEventOverrideFileOpen(HKEventBase pEvent)
Constructor.
FBAudioRateMode RateMode
Property: Rate mode for number of samples per second. 44100 hz default,8000, 11025,...
PropertyEvent: Base event class.
class K_DLLIMPORT FBArrayTemplate< FBModel * > FBModelList
typedef class FBSDK_DLL FBArrayTemplate<FBModel*> FBModelList;
bool FileSave(const char *pFilename=NULL, FBFbxOptions *pOptions=NULL)
Save the file under another name.
const char * GetSceneKeywords()
Return the scene keywords from the scene properties.
class K_DLLIMPORT FBPropertyBase< bool, kFBPT_bool > FBPropertyBool
Property: bool
@ kFBViewerModeTwoWindow
View two panes.
void UpdateAllWidgets()
Request to refresh display of all UI widgets.
bool FileMerge(FBStringList &pPathlist, bool pShowUIMsg=false, FBFbxOptions *pOptions=NULL)
Merge multiple files with the current scene.
bool mPlotLockedProperties
Should we plot locked properties?
bool OneClickSendAsNewScene(FBOneClickApplication pApplication)
Send the current scene as a new scene in the specified application.
bool mPlotTranslationOnRootOnly
Should we plot the translation on root only?
K_DLLIMPORT bool FBPreventUIUpdateIsOn()
Call to tell if UI updates are blocked.
K_DLLIMPORT bool FBMergeTransactionFileRefEditIsOn()
Call to tell if system is during File Reference Edit Merge transaction.
FBPropertyEvent OnFileSave
Event: A File Save has been requested, nothing has been saved yet.
bool FileOpen(void *pBuffer, kULong pBufferLength)
Open a file from memory.
@ kFBBatchProcessTypeLoad
Load the files and plot the character with every take.
K_DLLIMPORT void FBPreventUIUpdateBegin()
Call to prevent UI updates when creating/deleting/renaming objects.
FBAudioRateMode
Enum FBAudioRateMode.
Customize file loading and saving.
K_DLLIMPORT void FBMergeTransactionFileRefEditEnd()
Call to end merge transaction with File Reference edit.
FBString mSkeletonFile
The Skeleton file (for Acclaim AMC files).
#define FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
@ kFBViewerModeSchematic
Schematic view.
bool mConstantKeyReducerKeepOneKey
Should the constant key reducer keep at least one key?
PropertyEvent: Event when a file is about to be opened/merged.
bool mUseConstantKeyReducer
Should we use a constant key reducer with the filter?
FBPropertyString FBXFileName
Read Write Property: Current scene filename.
FBRotationFilter mRotationFilterToApply
The rotation filter to apply.
void SetSceneAuthor(const char *pAuthor)
Set the scene author.
const char * GetSceneTitle()
Return the scene title from the scene properties.
FB_DEFINE_COMPONENT(K_DLLIMPORT, AnimationNode)
Animation node class.
FBBatchStatus FileBatch(FBBatchOptions *pBatchOptions, FBPlotOptions *pPlotOptions=NULL)
Start a batch.
FBApplication(HIObject pObject=NULL)
Constructor.
bool mFrameAnimation
Set timeline start and end time to corespond with the start and end of animation.
@ kFBViewerModeThreeWindow
View three panes.
FBConstantKeyReducerThresholdType
Different threshold types for the Constant Key Reducer filter.
FBBatchFileFormat
Different file formats for the batch.
@ kFBBatchFileFormatC3D
File format for Vicon C3D.
bool Maximize()
Maximize window (minimized).
FBAudioChannelMode
Enum FBAudioChannelMode.
FBString mInputDirectory
The directory containning the input files.
bool FileImportWithOptions(FBMotionFileOptions *pOptions)
Import a motion file with the ability to specify options.
Event that is called before a file open/merge.
bool IsSceneModified()
Is the scene modified since last save / new scene creation?
bool AudioRender(FBAudioRenderOptions *pAudioRenderOptions=NULL)
Render audio of current scene to media file, currently WAV file only.
bool OneClickAddToCurrentScene()
Send the scene and add it to the current scene in the specified application.
Property class: const char * (String).
FBBatchProcessType
Different process type for the batch.
@ kFBBatchProcessTypeSave
Save the takes in different files.
bool FileRender(FBVideoGrabOptions *pRenderOptions=NULL)
Render current scene to media file.
bool FileMerge(const char *pFilename, bool pShowUIMsg=false, FBFbxOptions *pOptions=NULL)
Merge one or multiple files with the current scene.
MotionBuilder SDK base class.
@ kFBOneClickSoftimage
Softimage.
bool mPlotToCharacter
To plot the animation on the character.
bool mKeepCharacterConstraint
To keep the character constaint when saving.
bool mEvaluateDeformation
Should we evaluate deformation while plotting? This is useful when there is a dependency with the def...
@ kFBBatchOnContainsBatchTakesSaveBatchTakesOnly
Save only the batch takes.
FBOneClickApplication OneClickIsConnectedTo()
Return the other application that MotionBuilder is connected to.
bool FileExportBatch(const char *pName, FBTake *pTake, FBBatchOptions *pBatchOptions, FBModelList &pExportModels)
Export a motion file using batch options.
bool OneClickUpdateCurrentScene()
Send the scene to update the current scene in the specified application.
@ kFBBatchOnContainsBatchTakesSaveAllTakes
Save all the takes.
@ kFBBatchOnTakeExistOverwrite
Overwrite the take.
FBBatchProcessType mProcessType
What process should be done? Load, Save or Both.
@ kFBDefaultThreshold
All other curves threshold.
Video Grabbing Options structure.