This reference page is linked to from the following overview topics: MotionBuilder 2013, Your First Python Program, Object Model, FBSystem - The System Class, FBScene - The Scene Class.
Detailed Description
Provides access to the underlying system, and the MotionBuilder scene.
Use this class to access system properties such as the computer name, the system time, and the MotionBuilder application version.
It is also used to get access to the scene (FBScene) and the current take (FBTake), as in the following Python snippet:
myScene = FBSystem().Scene
for take in myScene.Takes:
print take.Name
The Python sample FBSystemEvents.py shows how to register a callback to FBSystem.
Definition at line 147 of file fbsystem.h.
#include <fbsystem.h>
Public Member Functions |
|
| FBSystem () | |
| Constructor. |
|
Static Public Member Functions |
|
| static bool | LibraryLoad (const char *pPath) |
| Load a library (DLL) into memory. |
|
| static void * | LibraryGetProcAddress (const char *pPath, const char *pFunctionName) |
| Get the the address of a function in a
specified library. |
|
| static bool | LibraryFree (const char *pPath) |
| Free a library (DLL) from memory. |
|
| static FBString | CurrentDirectory () |
| Get current work directory. |
|
| static FBString | MakeFullPath (const char *pRelativeFilePath) |
| Return the full path. |
|
| static FBSystem & | TheOne () |
| Get the global
FBSystem object. |
|
Public Attributes |
|
| FBPropertyString | ConfigPath |
| FBPropertyString | UserConfigPath |
| FBPropertyString | ApplicationPath |
| Read Only Property: Location where
the application is installed. |
|
| FBPropertyString | TempPath |
| Read Only Property: Temporary path
returned by the OS. |
|
| FBPropertyEventUIIdle | OnUIIdle |
| Event: User-interface idle. |
|
| FBPropertyEventConnectionNotify | OnConnectionNotify |
| Event: A connection event occurred
between objects in the system. |
|
| FBPropertyEventConnectionDataNotify | OnConnectionDataNotify |
| Event: A data event occurred between
objects in the system. |
|
| FBPropertyEventConnectionStateNotify | OnConnectionStateNotify |
| Event: A state change event occurred
between objects in the system. |
|
| FBPropertyEventConnectionKeyingNotify | OnConnectionKeyingNotify |
| Event: A keying event occurred when
objects are being keyed. |
|
| FBPropertyString | ComputerName |
| Read Only Property: Computer name.
|
|
| FBPropertyDouble | Version |
| Read Only Property: Application
version. |
|
| FBPropertyString | BuildId |
| Read Only Property: Unique build Id
String. |
|
| FBPropertyTime | SystemTime |
| Read Only Property: System time.
|
|
| FBPropertyTime | LocalTime |
| Read Only Property: Local time in
take. |
|
| FBPropertyTake | CurrentTake |
| Read Write Property: Current take.
|
|
| FBPropertyScene | Scene |
| Read Only Property: Scene. |
|
| FBPropertyModel | SceneRootModel |
| Read Only Property: Scene root model.
|
|
| FBPropertyModel | RootModel |
| Read Only Property: Root model.
|
|
| FBPropertyString | PathImages |
| Read Only Property: Path to images.
|
|
| FBPropertyString | PathMeshs |
| Read Only Property: Path to meshes
|
|
| FBPropertyListAudioIn | AudioInputs |
| List: Available audio inputs.
|
|
| FBPropertyListAudioOut | AudioOutputs |
| List: Available audio outputs.
|
|
| FBPropertyListVideoIn | VideoInputs |
| List: Available video inputs.
|
|
| FBPropertyListVideoOut | VideoOutputs |
| List: Available video outputs.
|
|
| FBPropertyListCommPort | CommPorts |
| List: Comm Ports available. |
|
| FBPropertyRenderer | Renderer |
| Read Only Property: Default renderer.
|
|
| FBPropertyDouble | FrameRate |
| Read Only Property: The frame rate of
the viewer. |
|
| FBPropertyDouble | ProcessMemory |
| Read Only Property: The size (MB) of
process's working set memory. |
|
| FBPropertyDouble | ProcessMemoryPeak |
| Read Only Property: The size (MB) of
process's peak memory. |
|
| FBPropertyVector2d | DesktopSize |
| Read Only Property: The width and
height of the desktop. |
|
| FBPropertyBool | FullScreenViewer |
| Read Write Property: Indicates that
the viewer is in full screen mode. |
|
| FBPropertyAssetMng | AssetManager |
| Read Only Property: Current asset
manager. |
|
| FBPropertyListManipulator | Manipulators |
| List: of manipulators. |
|
Constructor & Destructor Documentation
| FBSystem | ( | ) |
Constructor.
Member Function Documentation
| static bool LibraryLoad | ( | const char * | pPath | ) | [static] |
Load a library (DLL) into memory.
- Parameters:
-
pPath Library path.
- Returns:
- true if successful.
| static void* LibraryGetProcAddress | ( | const char * | pPath, |
| const char * | pFunctionName | ||
| ) | [static] |
Get the the address of a function in a specified library.
- Parameters:
-
pPath Library path. pFunctionName Function name.
- Returns:
- true if successful.
| static bool LibraryFree | ( | const char * | pPath | ) | [static] |
Free a library (DLL) from memory.
- Parameters:
-
pPath Library path.
- Returns:
- true if successful.
| static FBString CurrentDirectory | ( | ) | [static] |
| static FBString MakeFullPath | ( | const char * | pRelativeFilePath | ) | [static] |
Return the full path.
- Parameters:
-
pRelativeFilePath The relative file path
- Returns:
- Full file path based on combining the current directory
| static FBSystem& TheOne | ( | ) | [static] |
Member Data Documentation
Definition at line 154 of file fbsystem.h.
Definition at line 155 of file fbsystem.h.
Read Only Property: Location where the application is installed.
Definition at line 156 of file fbsystem.h.
Read Only Property: Temporary path returned by the OS.
Definition at line 157 of file fbsystem.h.
Event: A connection event occurred between objects in the system.
Definition at line 159 of file fbsystem.h.
Event: A data event occurred between objects in the system.
Definition at line 160 of file fbsystem.h.
Event: A state change event occurred between objects in the system.
Definition at line 161 of file fbsystem.h.
Event: A keying event occurred when objects are being keyed.
Definition at line 162 of file fbsystem.h.
Read Only Property: Computer name.
Definition at line 164 of file fbsystem.h.
Read Only Property: Application version.
Definition at line 165 of file fbsystem.h.
Read Only Property: Unique build Id String.
Definition at line 166 of file fbsystem.h.
Read Only Property: System time.
Definition at line 169 of file fbsystem.h.
Read Only Property: Local time in take.
Definition at line 170 of file fbsystem.h.
| FBPropertyTake CurrentTake |
Read Write Property: Current take.
Definition at line 171 of file fbsystem.h.
| FBPropertyScene Scene |
| FBPropertyModel SceneRootModel |
Read Only Property: Scene root model.
Definition at line 175 of file fbsystem.h.
| FBPropertyModel RootModel |
Read Only Property: Root model.
Definition at line 176 of file fbsystem.h.
Read Only Property: Path to images.
Definition at line 177 of file fbsystem.h.
Read Only Property: Path to meshes
Definition at line 178 of file fbsystem.h.
List: Available audio outputs.
Definition at line 182 of file fbsystem.h.
List: Available video outputs.
Definition at line 187 of file fbsystem.h.
| FBPropertyRenderer Renderer |
Read Only Property: Default renderer.
Definition at line 191 of file fbsystem.h.
Read Only Property: The frame rate of the viewer.
Definition at line 193 of file fbsystem.h.
Read Only Property: The size (MB) of process's working set memory.
Definition at line 194 of file fbsystem.h.
Read Only Property: The size (MB) of process's peak memory.
Definition at line 195 of file fbsystem.h.
Read Only Property: The width and height of the desktop.
Definition at line 196 of file fbsystem.h.
Read Write Property: Indicates that the viewer is in full screen mode.
Definition at line 197 of file fbsystem.h.
| FBPropertyAssetMng AssetManager |
Read Only Property: Current asset manager.
Definition at line 200 of file fbsystem.h.
The documentation for this class was generated from the following file:
- fbsdk/fbsystem.h
