Open Reality Reference Guide
|
|
Go to the documentation of this file.
44 #include <kaydaradef.h>
49 #define FBSDK_DLL K_DLLIMPORT
60 #include <fbsdk/fbcamera.h>
61 #include <fbsdk/fblight.h>
66 #include <fbsdk/fbnamespace.h>
69 #if !defined(K_NO_CHARACTER)
72 #include <fbsdk/fbcharacterpose.h>
76 #if !defined(K_NO_DECK)
80 #if !defined(K_NO_AUDIO)
84 #if !defined(K_NO_MANIPULATOR)
88 #if !defined(K_NO_NOTE)
92 #if !defined(K_NO_POSE)
96 #if !defined(K_NO_STORY)
100 #if !defined(K_NO_PROJECTSETTINGS)
101 #include <fbsdk/fbprojectsettings.h>
104 #ifndef FBSDK_LEAN_AND_MEAN
105 #include <fbsdk/fbuserobject.h>
109 #if !defined(K_NO_OPTICAL)
114 #ifdef FBSDKUseNamespace
115 namespace FBSDKNamespace {;
183 FBPropertySceneChangeType
Type;
195 kFBTakeChangeRemoved,
198 kFBTakeChangeRenamed,
199 kFBTakeChangeUpdated,
437 bool NamespaceImport(
const char* pNamespace,
const char* pFilePath,
bool pAsFileReference =
false );
454 bool NamespaceExport(
const char* pNamespace,
const char* pFilePath,
bool pASCIIFormat =
false);
506 #if !defined(K_NO_NAMESPACE_UPGRADE)
534 #if !defined(K_NO_AUDIO)
537 #if !defined(K_NO_VIDEO)
543 #if !defined(K_NO_FOLDER)
547 #if !defined(K_NO_NOTE)
551 #if !defined(K_NO_POSE)
556 #if !defined(K_NO_ACTOR)
561 #if !defined(K_NO_CHARACTER)
575 #if !defined(K_NO_PROJECTSETTINGS)
607 #ifndef __FB_COMPONENT_SCENE
608 #define __FB_COMPONENT_SCENE
613 #ifdef FBSDKUseNamespace
FBPropertyListHUD HUDs
Read Only Property: Heads Up Displays in the scene.
@ kFBSceneChangeDeactivate
Deactivate.
FBPropertyListCharacterPose CharacterPoses
List: Character poses in scene.
@ kFBSceneChangeSoftUnselect
Soft deselection.
FBPropertyListControlSet ControlSets
List: Control set rigs in scene.
FBPropertyListDevice Devices
List: Devices for scene.
FBPropertyListCharacterFace CharacterFaces
List: Character faces in scene.
@ kFBSceneChangeRenameUniquePrefix
Before object rename unique prefix.
virtual void FBDelete() override
Virtual FBDelete function.
@ kFBSceneChangeRemoveChild
Child removed.
int CleanEmptyGroups()
Remove all empty groups present in the scene.
class K_DLLIMPORT FBPropertyBaseComponent< FBComponent * > FBPropertyComponent
Property: FBPropertyBaseComponent(FBComponent*)
#define FB_DEFINE_ENUM(DllTag, Type)
Define an enum and give it the ability to be a property.
@ kFBSceneChangeTransactionBegin
Begin transaction.
FBPropertyListActorFace ActorFaces
List: ActorFaces in scene.
@ kFBSceneChangeReSelect
Re-selection.
@ kFBSceneChangeRenamed
After object rename.
int CleanInactiveConstraints()
Remove all inactive constraints present in the scene.
FBPropertyListDeformer Deformers
List: Deformers for scene.
FBPropertyListCamera Cameras
List: Cameras in scene.
virtual FBScene * operator[](int pIndex)
Get the Scene at pIndex.
void GetScriptsPaths(FBStringList &pPathList)
Get paths of all the python scripts object in the scene.
FBScene(HIObject pObject)
Constructor.
bool NamespaceExist(const char *pNamespace)
Query if namespace exists.
Character extension property list.
FBPropertyListMaterial Materials
List: Materials for scene.
Select model event class.
Objects Containing class.
Character extension interface for FBSDK.
@ kFBSceneChangeActivate
Activate.
FBPropertyProjectSettings ProjectSettings
Read Only Property: Local project settings
@ kFBSceneChangeChangedParent
Object changed parent.
FBPropertyListPhysicalProperties PhysicalProperties
List: PhysicalProperties present in the scene.
bool NamespaceImportToMultiple(const FBStringList &pDstNamespaceList, const char *pFilePath, bool pAsFileReference=false)
Import file into multiple Namespaces (or as file references)
@ kFBSceneChangeAddChild
Child added.
@ kFBSceneChangeTransactionEnd
End transaction.
static int TypeInfo
TypeInfo.
FBPropertyListCharacterMarkerSet CharacterMarkerSets
List: Character marker sets in scene.
PropertyList: Character face.
FBPropertyListHandle Handles
List: Handles present in the scene.
@ kFBSceneChangeLoadBegin
Begin loading file.
Contains definitions for object poses.
FBEventSceneChange(HKEventBase pEvent)
Constructor.
FBPropertyListGroup Groups
List: Groups available in the scene.
@ kFBSceneChangeReordered
Object reordered.
FileReference interface for FBSDK.
FBPropertyEvent OnTakeChange
Event: Something related to a take has happened.(FBEventTakeChange)
Audio interface for FBSDK.
virtual int Add(FBScene *pItem)
Add a scene to the list.
@ kFBSceneChangePreParent
Before object parenting.
Objects Containing class.
@ kFBSceneChangeRenamedUniquePrefix
After object rename unique prefix.
int CleanUnusedAudioClips()
Remove all unused audio clips present in the scene.
FBVideo and derivative classes.
FBPropertyListTexture Textures
List: Textures for scene.
@ kFBSceneChangeClearEnd
End clearing file (file new)
FBPropertyListModelSkeleton ModelSkeletons
Read Write Property: Bones (Skeletons) in the scene.
Groups interface for FBSDK.
FBPropertyListConstraint Constraints
List: Constraints in scene.
bool CandidateEvaluationAndResolve()
Resolving the Candidate.
@ kFBSceneChangeRename
Before object rename.
FBPropertyListNamespace Namespaces
List: Namespace (include FileReference) available in the scene
FBPropertyListKeyingGroup KeyingGroups
Read Write Property: Keying Groups in the scene.
@ kFBSceneChangeFocus
Object have focus.
int CleanUnusedShaders()
Remove all unused shaders present in the scene.
Create new manipulators using the FBManipulator class.
int NamespaceGetChildrenList(FBStringList &pNamespaceList, const char *pNamespace=NULL, bool pRecursive=true)
Get list of children namespaces in the given namespace.
FBPropertyListFileReference FileReferences
List: FileReference available in the scene.
#define FBSDK_DLL
Be sure that FBSDK_DLL is defined only once...
bool NamespaceEmpty(const char *pNamespace)
Query if namespace is empty.
@ kFBSceneChangePreUnparent
Before object unparenting.
FBPropertySceneChangeType Type
Read Only Property: Type of selection event.
PropertyList: CharacterPose.
void NamespaceGetContentList(FBComponentList &pContentList, const char *pNamespace, FBPlugModificationFlag pModificationFlags=kFBPlugAllContent, bool pRecursive=true, int pTypeInfo=FBPlug::TypeInfo, bool pExactTypeMatch=false)
Get List of the namespace content.
FBPropertyTakeChangeType Type
Read Only Property: Type of take change event.
@ kFBSceneChangeRenameUnique
Before object rename unique.
@ kFBSceneChangeHardSelect
Hard selection.
FBPropertyString FilePath
Read Write Property: File path of the scene.
@ kFBSceneChangeClearBegin
Begin clearing file (file new)
FBPropertyListPose Poses
List: Poses in scene.
#define __FBClassDeclare(Name, Parent)
For internal use only.
bool NamespaceUpgradeToFileReference(const char *pNamespace, const char *pFilePath, bool pASCIIFormat=false)
Upgrade Namespace to FileReference and save the referenced file to disk.
FBPropertyTake Take
Read Only Property: The take modified.
void Clear()
Clears the elements part of the scene.
FBPropertyListComponent Components
List: Generic List of components.
#define __FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
int CleanUnusedMaterials()
Remove all unused materials present in the scene.
FBEventTakeChange(HKEventBase pEvent)
Constructor.
FBPropertyRenderer Renderer
Read Only Property: Local renderer.
@ kFBSceneChangeDestroy
Object destroyed.
FBPropertyListConstraintSolver ConstraintSolvers
List: Constraint Solvers present in the scene.
bool NamespaceImport(const char *pNamespace, const char *pFilePath, bool pAsFileReference=false)
Import file into Namespace (or as file reference)
FBFileReference * NamespaceGetOwnerFileReference(const char *pNamespace)
Get Owner FileReference object if the namespace is originated from File Reference.
@ kFBSceneChangeLoadEnd
End loading file.
FBPropertyListUserObject UserObjects
List: User objects
FBPropertyComponent ChildComponent
Read Only Property: Child component of the event.
FBPropertyListMarkerSet MarkerSets
List: Marker sets in scene.
FBPropertyListFolder Folders
List: Folders in scene.
@ kFBSceneChangeRenamePrefix
Before object rename prefix.
PropertyList: ObjectPose.
bool NamespaceRename(const char *pNameSpace, const char *pNewNamespace, bool pRecursive=true, int pTypeInfo=FBPlug::TypeInfo, bool pExactTypeMatch=false)
Rename the namespace.
FBPropertyListObjectPose ObjectPoses
List: ObjectPoses in scene.
int CleanEmptySets()
Remove all empty sets present in the scene.
Motion interface for FBSDK.
@ kFBSceneChangeReorder
Object reorder.
Folders interface for FBSDK.
PropertyEvent: Base event class.
bool NamespaceCleanup()
Remove all empty namespaces.
FBPropertyEvent OnChange
Event: Something in the scene has happened.(FBEventSceneChange)
bool EvaluateDeformations()
Evaluate the deformations of the scene.
PropertyList: KeyingGroup.
@ kFBSceneChangeUnselect
Object deselection.
@ kFBSceneChangeAttach
Object attached.
@ kFBSceneChangeMergeTransactionEnd
End merge transaction.
@ kFBSceneChangeNone
Unknown event.
#define FB_DEFINE_LIST(DllTag, Type)
Define a component list.
PropertyList: Physical properties
FBPropertyListCharacter Characters
List: Characters in scene.
bool NamespaceDeleteContent(const char *pNamespace, FBPlugModificationFlag pModificationFlags=kFBPlugAllContent, bool pRecursive=true, int pTypeInfo=FBPlug::TypeInfo, bool pExactTypeMatch=false)
Delete the namespace content.
@ kFBSceneChangeRenamedPrefix
After object rename prefix.
virtual void RemoveAt(int pIndex)
Remove the scene at pIndex from list.
FBPropertyListModelOptical ModelOpticals
Read Write Property: Optical Data in the scene.
PropertyList: ModelOptical.
Contains abstract deck class to interface with a deck.
FBPropertyComponent Component
Read Only Property: Modified component
FBPropertyListActor Actors
List: Actors in scene.
void NamespaceSelectContent(const char *pNamespace, bool pSelect, FBPlugModificationFlag pModificationFlags=kFBPlugAllContent, bool pRecursive=true, int pTypeInfo=FBPlug::TypeInfo, bool pExactTypeMatch=false)
Select (or de-select) the namespace content.
PropertyList: Concrete class for PropertyList of component
Contains definitions for actor faces and character faces In Development.
Contains definitions for devices, boxes and models.
Template class to contain an array of items.
@ kFBSceneChangeChangeName
Object change name.
#define FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
Declaration for the FBCommand class.
FBPropertyListLight Lights
List: Lights in scene.
PropertyList: ModelSkeleton.
FBPropertyListAudioClip AudioClips
List: Audio clips in scene.
PropertyList: Constraint solver
PropertyList: UserObject.
@ kFBPlugAllContent
None Modified.
FBPropertyListMotionClip MotionClips
List: Motion clips in scene.
@ kFBSceneChangeSoftSelect
Soft selection.
FB_DEFINE_COMPONENT(K_DLLIMPORT, AnimationNode)
Animation node class.
int CleanUnusedVideoClips()
Remove all unused video clips present in the scene.
int CleanUnusedTextures()
Remove all unused textures present in the scene.
int CleanEmptyRelationConstraints()
Remove all empty relation constraints present in the scene.
FBPropertyListNote Notes
List: Notes in scene.
FBPropertyListSet Sets
List: Sets available in the scene.
@ kFBSceneChangeRenamedUnique
After object rename unique.
FBPropertyListTake Takes
List: Takes for scene.
Generic optical motion capture device interface.
Declaration for the classes FBShaderManager, FBShader, FBPropertyListShader and other subclasses.
Access to the MotionBuilder scene.
FBNamespace * NamespaceGet(const char *pNamespace)
Get Namespace object.
bool NamespaceExport(const char *pNamespace, const char *pFilePath, bool pASCIIFormat=false)
Export scene content within namespace to file.
Property class: const char * (String).
PropertyList: CharacterMarkerSet.
MotionBuilder SDK base class.
@ kFBSceneChangeChangedName
Object changed name.
int CleanRelationConstraintsUnusedBoxes()
Remove all unused boxes in relations constraints present in the scene.
bool Evaluate()
Evaluate the scene.
@ kFBSceneChangeSelect
Object selection.
FBPropertyListVideoClip VideoClips
List: Video clips in scene.
Contains definitions for actors, characters, and marker sets In Development.
FBPropertyListShader Shaders
List: Shaders for scene.
FBSceneChangeType
Types of model selection events.
FBPropertyListCharacterExtension CharacterExtensions
List: Character extensions available in the scene.
bool NamespaceDowngradeFromFileReference(const char *pNamespace)
Downgrade FileReference to namespace (won't touch the original referenced file)
bool NamespaceDelete(const char *pNamespace)
Delete the namespace & all its content.
virtual int GetCount()
Get the Scene count.
FBPropertyModel RootModel
Read Only Property: Scene Root model for that scene
FBTakeChangeType
Types of take change events.
@ kFBSceneChangeMergeTransactionBegin
Begin merge transaction.
@ kFBSceneChangeDetach
Object detached.
PropertyList: Actor face.