Python Reference Guide
 
Loading...
Searching...
No Matches
FBBatchOptions Class Reference

Option parameters for the batch process. More...

#include <pyfbsdk.h>

Inheritance diagram for FBBatchOptions:

Public Member Functions

 FBBatchOptions ()
 Constructor.
 

Public Attributes

FBBatchFileFormat InputFileFormat
 Read Write Property: File format of the input files.
 
FBBatchFileFormat OutputFileFormat
 Read Write Property: File format of the output files.
 
FBBatchProcessType ProcessType
 Read Write Property: What process should be done? Load, Save or Both.
 
str InputDirectory
 Read Write Property: The directory containning the input files.
 
str OutputDirectory
 Read Write Property: The directory containning the output files.
 
str SkeletonFile
 Read Write Property: The Skeleton file (for Acclaim AMC files).
 
FBCharacter Character
 Read Write Property: The character to receive the animation.
 
bool StartAnimationAtZero
 Read Write Property: Set the time of all loaded files to 0.
 
bool FrameAnimation
 Read Write Property: Set timeline start and end time to corespond with the start and end of animation.
 
bool OverwriteScaling
 Read Write Property: Set the scaling to a default setting of 1.0.
 
bool KeepDummyBones
 Read Write Property: To keep dummy bones.
 
bool WriteRate
 Read Write Property: Write frame rate in Acclaim AMC files.
 
bool WriteTranslation
 Read Write Property: Write translation animation data included with Acclaim AMC files.
 
bool PlotToCharacter
 Read Write Property: To plot the animation on the character.
 
bool PlotToControlSet
 Read Write Property: To plot the animation on the control set.
 
bool UseSingleTake
 Read Write Property: Use only one take to convert all files.
 
bool UseBatchSuffix
 Read Write Property: Add a batch suffix to the name of the files.
 
bool KeepCharacterConstraint
 Read Write Property: To keep the character constaint when saving.
 
FBBatchOnTakeExist OnTakeExistAction
 Read Write Property: Action to perform when a take already exist while in a batch process.
 
FBBatchOnContainsBatchTakes OnContainsBatchTakesAction
 Read Write Property: Action to perform when a scene already contains batch takes while in a batch process.
 

Detailed Description

Option parameters for the batch process.


Constructor & Destructor Documentation

◆ FBBatchOptions()

Constructor.

Member Data Documentation

◆ Character

FBCharacter Character

Read Write Property: The character to receive the animation.

◆ FrameAnimation

bool FrameAnimation

Read Write Property: Set timeline start and end time to corespond with the start and end of animation.

◆ InputDirectory

str InputDirectory

Read Write Property: The directory containning the input files.

◆ InputFileFormat

FBBatchFileFormat InputFileFormat

Read Write Property: File format of the input files.

◆ KeepCharacterConstraint

bool KeepCharacterConstraint

Read Write Property: To keep the character constaint when saving.

◆ KeepDummyBones

bool KeepDummyBones

Read Write Property: To keep dummy bones.

◆ OnContainsBatchTakesAction

FBBatchOnContainsBatchTakes OnContainsBatchTakesAction

Read Write Property: Action to perform when a scene already contains batch takes while in a batch process.

◆ OnTakeExistAction

FBBatchOnTakeExist OnTakeExistAction

Read Write Property: Action to perform when a take already exist while in a batch process.

◆ OutputDirectory

str OutputDirectory

Read Write Property: The directory containning the output files.

◆ OutputFileFormat

FBBatchFileFormat OutputFileFormat

Read Write Property: File format of the output files.

◆ OverwriteScaling

bool OverwriteScaling

Read Write Property: Set the scaling to a default setting of 1.0.

◆ PlotToCharacter

bool PlotToCharacter

Read Write Property: To plot the animation on the character.

◆ PlotToControlSet

bool PlotToControlSet

Read Write Property: To plot the animation on the control set.

◆ ProcessType

FBBatchProcessType ProcessType

Read Write Property: What process should be done? Load, Save or Both.

◆ SkeletonFile

str SkeletonFile

Read Write Property: The Skeleton file (for Acclaim AMC files).

◆ StartAnimationAtZero

bool StartAnimationAtZero

Read Write Property: Set the time of all loaded files to 0.

◆ UseBatchSuffix

bool UseBatchSuffix

Read Write Property: Add a batch suffix to the name of the files.

◆ UseSingleTake

bool UseSingleTake

Read Write Property: Use only one take to convert all files.

◆ WriteRate

bool WriteRate

Read Write Property: Write frame rate in Acclaim AMC files.

◆ WriteTranslation

bool WriteTranslation

Read Write Property: Write translation animation data included with Acclaim AMC files.