Public Member Functions | Public Attributes

FBConsole Class Reference

Search for all occurrences

Detailed Description

Console base class.

Definition at line 152 of file fbconsole.h.

#include <fbconsole.h>

Inheritance diagram for FBConsole:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBConsole (const char *pName=NULL, HIObject pObject=NULL)
 Constructor.
virtual bool FBCreate ()
 Open Reality Creation function.
virtual void FBDestroy ()
 Open Reality destruction function.
virtual bool Open ()=0
 Open console.
virtual bool Close ()=0
 Close console.
virtual bool Initialize ()=0
 Initialize console.
virtual bool FetchData ()=0
 Fetch data from console.
virtual bool FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)
 Store/Retrieve data to/from FBX files.
virtual bool FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)

Public Attributes

FBPropertyListConsoleChannel Channels
 List: Data Channels.
FBPropertyBool IsTransportControl
 Property: Is the console able to interface transport controls (true/false)?

Constructor & Destructor Documentation

FBConsole ( const char *  pName = NULL,
HIObject  pObject = NULL 
)

Constructor.

Parameters:
pNameName of console.
pObjectOwner of FBComponent (default is NULL).

Member Function Documentation

virtual bool FbxStore ( FBFbxObject pFbxObject,
kFbxObjectStore  pStoreWhat 
) [virtual]

Store/Retrieve data to/from FBX files.

Parameters:
pFbxObjectInterface to FBX format.
pStoreWhatAttributes to store in file.
Returns:
true if successful.
virtual bool FbxRetrieve ( FBFbxObject pFbxObject,
kFbxObjectStore  pStoreWhat 
) [virtual]
virtual bool FBCreate ( ) [virtual]

Open Reality Creation function.

Returns:
Outcome of creation (true/false).

Reimplemented from FBComponent.

virtual void FBDestroy ( ) [virtual]

Open Reality destruction function.

Reimplemented from FBComponent.

virtual bool Open ( ) [pure virtual]

Open console.

Returns:
true if successful.
virtual bool Close ( ) [pure virtual]

Close console.

Returns:
true if successful.
virtual bool Initialize ( ) [pure virtual]

Initialize console.

Returns:
true if successful.
virtual bool FetchData ( ) [pure virtual]

Fetch data from console.

Returns:
true if successful.

Member Data Documentation

List: Data Channels.

Definition at line 163 of file fbconsole.h.

Property: Is the console able to interface transport controls (true/false)?

Definition at line 164 of file fbconsole.h.


The documentation for this class was generated from the following file:

FBConsole FBConsole FBConsole FBConsole FBConsole FBConsole FBConsole FBConsole FBConsole FBConsole
FBConsole FBConsole FBConsole FBConsole FBConsole FBConsole FBConsole FBConsole FBConsole FBConsole