Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HDB Class Reference

The HDB class serves as a wrapper/utility class to manage an instance of the HOOPS/3dGS scene-graph. More...

#include <HDB.h>

List of all members.

Public Member Functions

virtual void Init ()

Static Public Member Functions

static void DecrementInstanceCount ()
static void DisableErrorManager ()
static void EnableErrorManager ()
static bool GetCleanInclude ()
static const char * GetDriverType ()
static HDBGetHDB ()
static HImManagerGetHImManager ()
static HIOManagerGetHIOManager ()
static HTManagerGetHTManager ()
static const char * GetInstanceBase ()
static int GetInstanceCount ()
static bool GetIsolatedDrivers ()
static HMaterialLibraryGetMaterialLibrary ()
static unsigned long GetNextCookie ()
static bool GetOwnsSystem ()
static bool GetPublishExchangeLicenseSet ()
static int GetUniqueID ()
static HC_KEY GetUniqueIncludeKey ()
static void IncrementInstanceCount ()
static void Lock ()
static void ReportError (const char *message, int severity=1, int category=0, int specific=0)
static void SetCleanInclude (bool value)
static void SetDriverType (const char *s)
static HImManagerSetHImManager (HImManager *manager)
static HIOManagerSetHIOManager (HIOManager *manager)
static HTManagerSetHTManager (HTManager *manager)
static void SetInstanceBase (const char *s)
static void SetInstanceCount (int count)
static void SetIsolatedDrivers (bool isolated)
static void SetMaterialLibrary (HMaterialLibrary *library)
static void SetOwnsSystem (bool owns)
static void SetPublishExchangeLicenseSet (bool isSet)
static void UnLock ()

Detailed Description

The HDB class serves as a wrapper/utility class to manage an instance of the HOOPS/3dGS scene-graph.

HDB Stores the information of how many and which type of HOOPS driver instances the associated object HBaseView creates.


Member Function Documentation

static void HDB::DecrementInstanceCount ( ) [static]

This method decrements the number of instances of a driver by one.

static void HDB::DisableErrorManager ( ) [static]

This method cleans up the error manager and then disables it.

static void HDB::EnableErrorManager ( ) [static]

This method initializes the error manager and puts it in use.

static bool HDB::GetCleanInclude ( ) [inline, static]
Returns:
True if global includes should be moved to model specific includes during reading.
static const char* HDB::GetDriverType ( ) [static]
Returns:
The base driver type for the driver instances.
static HDB* HDB::GetHDB ( ) [static]
Returns:
A pointer to the HDB object.
static HImManager* HDB::GetHImManager ( ) [static]
Returns:
A pointer to the current HImManager object (the HOOPS/3dGS I.M. manager). This method creates one if none exists.
static HIOManager* HDB::GetHIOManager ( ) [static]
Returns:
A pointer to the current HIOManager object (the input/output manager). This method creates one if none exists.

Referenced by HIOUtilityPDF::Has3dSupport().

static HTManager* HDB::GetHTManager ( ) [static]
Returns:
A pointer to the current HTManager object (the timer manager). This method creates one if none exists.
static const char* HDB::GetInstanceBase ( ) [static]
Returns:
The base name for driver instances.
static int HDB::GetInstanceCount ( ) [inline, static]
Returns:
An integer denoting the number of instances of a driver.
static bool HDB::GetIsolatedDrivers ( ) [inline, static]
Returns:
True if isolated driver is set
static HMaterialLibrary* HDB::GetMaterialLibrary ( ) [static]
Returns:
A pointer to the current HMaterialLibrary object (which manages materials resources from disk). Return value is NULL if none exists.
static unsigned long HDB::GetNextCookie ( ) [inline, static]
Returns:
A globally unique identifier.
static bool HDB::GetOwnsSystem ( ) [inline, static]
static int HDB::GetUniqueID ( ) [inline, static]
Returns:
An integer that will be unique during the runtime of the application.
static HC_KEY HDB::GetUniqueIncludeKey ( ) [static]
Returns:
A key to a unique Include Library segment.
static void HDB::IncrementInstanceCount ( ) [static]

This method augments the number of instances of a driver by one.

virtual void HDB::Init ( ) [virtual]

Init() initializes the HOOPS attributes for driver type and unsets the default HOOPS alias--"?Picture"--for the root segment of the given driver. The function also sets up a default color map and registers the HOOPS I.M. callbacks that are listed in HDB::RegisterHoopsIMCallbacks().

static void HDB::ReportError ( const char *  message,
int  severity = 1,
int  category = 0,
int  specific = 0 
) [static]

This method generates a HOOPS error. Using this method, allows the error to go through HOOPS so that it will be intercepted by whatever error handlers the app might have registered, and will use the reporting mechanism appropriate to the specific platform.

Parameters:
messageThe text to be posted.
severityIf the value is 0, the message is informational. If the value is 1, the message is a warning. If the value is 2, then the message is an error. If the value is 3 or greater, the error is fatal.
categoryThe category that this error falls under as described in HC_Define_Error_Handler.
specificThe specific error under the category as described in HC_Define_Error_Handler.
static void HDB::SetCleanInclude ( bool  value) [inline, static]

This method determines whether global includes should be moved to model specific includes during reading.

Parameters:
valuePass true to have global includes move to model specific includes during reading or false to keep the includes.
static void HDB::SetDriverType ( const char *  s) [static]

This method sets the base driver type for the driver instances.

static HImManager* HDB::SetHImManager ( HImManager manager) [static]

This method replaces the HOOPS/3dGS I.M. manager.

Parameters:
managerA pointer to an HImManager object.
Returns:
A pointer to the replaced HImManager.
static HIOManager* HDB::SetHIOManager ( HIOManager manager) [static]

This method replaces the input/output manager.

Parameters:
managerA pointer to an HIOManager object.
Returns:
A pointer to the replaced HIOManager.
static HTManager* HDB::SetHTManager ( HTManager manager) [static]

This method replaces the timer manager.

Parameters:
managerA pointer to an HTManager object.
Returns:
A pointer to the replaced HTManager.
static void HDB::SetInstanceBase ( const char *  s) [static]

This method sets the base name for driver instances.

static void HDB::SetInstanceCount ( int  count) [inline, static]

This method sets the number of instances of a driver.

Parameters:
countThe number of driver instances.
static void HDB::SetIsolatedDrivers ( bool  isolated) [inline, static]

Sets the "isolated" driver option. Allows a driver to be spawned on a separate thread. Used for background printing or multiple views.

static void HDB::SetMaterialLibrary ( HMaterialLibrary library) [static]
Returns:
Sets the pointer to the material library.
static void HDB::SetOwnsSystem ( bool  owns) [inline, static]

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