#include <hps.h>

Public Member Functions | |
HPS::Type | ObjectType () const |
World & | SetDriverConfigFile (char const *in_filename) |
World & | SetExchangeLibraryDirectory (char const *in_directory) |
World & | SetFontDirectories (size_t in_count, UTF8 const in_directories[]) |
World & | SetFontDirectories (UTF8Array const &in_directories) |
World & | SetFontDirectory (char const *in_directory) |
World & | SetMaterialLibraryDirectory (char const *in_directory) |
World & | SetParasolidBodyshopDirectory (char const *in_directory) |
World & | SetParasolidSchemaDirectory (char const *in_directory) |
World & | SetPublishResourceDirectory (char const *in_directory) |
World & | SetRealDWGDirectory (char const *in_directory) |
World & | SetRealDWGDirectory (char const *in_directory, UTF8Array const &in_object_enabler_directories) |
bool | ShowDriverConfigFile (UTF8 &out_filename) const |
bool | ShowExchangeLibraryDirectory (UTF8 &out_directory) const |
bool | ShowFontDirectories (UTF8Array &out_directories) const |
bool | ShowMaterialLibraryDirectory (UTF8 &out_directory) const |
bool | ShowParasolidBodyshopDirectory (UTF8 &out_directory) const |
bool | ShowParasolidSchemaDirectory (UTF8 &out_directory) const |
bool | ShowPublishResourceDirectory (UTF8 &out_directory) const |
bool | ShowRealDWGDirectory (UTF8 &out_directory, UTF8Array &out_object_enabler_directories) const |
World & | UnsetDriverConfigFile () |
World & | UnsetExchangeLibraryDirectory () |
World & | UnsetFontDirectories () |
World & | UnsetMaterialLibraryDirectory () |
World & | UnsetParasolidBodyshopDirectory () |
World & | UnsetParasolidSchemaDirectory () |
World & | UnsetPublishResourceDirectory () |
World & | UnsetRealDWGDirectory () |
World (char const *in_license, char const *in_code_generation_directory=nullptr) | |
~World () | |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual HPS::Type | Type () const |
Static Public Member Functions | |
static void | AddCodeGenerationComment (UTF8 const &in_comment) |
static void | StopCodeGeneration () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
The World class is a special object that must be constructed prior to making any database calls and must exist for the life of the application.
Constructor & Destructor Documentation
HPS::World::World | ( | char const * | in_license, |
char const * | in_code_generation_directory = nullptr |
||
) |
This constructor creates a new World object with the given license. The license string determines what functionality is available in Visualize. There should only be one World object that is constructed during the life of the application. Optionally it is possible to start Code Generation, which logs every call to the HPS API for debugging purposes. While Code Generation is active, HPS performance will be slower than usual.
- Parameters
-
in_license UTF8-encoded license string for Visualize. in_code_generation_directory UTF8-encoded directory where the output of Code Generation will be stored. The directory must already exist.
HPS::World::~World | ( | ) |
The destructor will shutdown the database and invalidate all objects within it.
Member Function Documentation
|
static |
Adds a comment to the generated code. Useful to guide a developer towards the source of a problem. Code Generation must be started before this function can be called.
- Parameters
-
in_comment A comment to be embedded in the code generation.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Object.
World& HPS::World::SetDriverConfigFile | ( | char const * | in_filename | ) |
Sets the driver configuration file (i.e., a plain text file which can force device specific behavior) for Visualize. To ensure the settings within the configuration file take effect, this file must be specified prior to creating a driver which will be affected by the settings.
- Parameters
-
in_filename UTF8-encoded file name.
- Returns
- A reference to this World object.
World& HPS::World::SetExchangeLibraryDirectory | ( | char const * | in_directory | ) |
Sets the directory which contains the Exchange and Publish libraries. If this is set, the Exchange and Publish Visualize modules will try to load the libraries from this directory. If this is not set, those modules will try to load the libraries from the directories in the application's PATH. Note that this function will append the given directory to the PATH.
- Parameters
-
in_directory UTF8-encoded directory name.
- Returns
- A reference to this World object.
Sets the directories which contain fonts for use by Visualize. This must be specified for Visualize to make use of any fonts beyond those Visualize defines itself.
- Parameters
-
in_count Size of the following array. in_directories Array of UTF8-encoded directory names.
- Returns
- A reference to this World object.
Sets the directories which contain fonts for use by Visualize. This must be specified for Visualize to make use of any fonts beyond those Visualize defines itself.
- Parameters
-
in_directories Array of UTF8-encoded directory names.
- Returns
- A reference to this World object.
World& HPS::World::SetFontDirectory | ( | char const * | in_directory | ) |
Sets the directory which contains fonts for use by Visualize. This must be specified for Visualize to make use of any fonts beyond those Visualize defines itself.
- Parameters
-
in_directory UTF8-encoded directory name.
- Returns
- A reference to this World object.
World& HPS::World::SetMaterialLibraryDirectory | ( | char const * | in_directory | ) |
Sets the directory which contains the material library for Visualize. This must be specified to ensure any files which use the material library display correctly.
- Parameters
-
in_directory UTF8-encoded directory name.
- Returns
- A reference to this World object.
World& HPS::World::SetParasolidBodyshopDirectory | ( | char const * | in_directory | ) |
World& HPS::World::SetParasolidSchemaDirectory | ( | char const * | in_directory | ) |
Sets the schema directory for Parasolid. This directory must be specified to make use of the Parasolid module.
- Note
- Using this function will set the P_SCHEMA environment variable to the given directory as well.
- Parameters
-
in_directory UTF8-encoded directory name.
- Returns
- A reference to this World object.
World& HPS::World::SetPublishResourceDirectory | ( | char const * | in_directory | ) |
Sets the resource directory for Publish. This is not the directory which contains the libraries (see World::SetExchangeLibraryDirectory), but rather the directory which contains fonts and associated mappings and files used during PDF generation. This directory must be specified to make use of the Publish module.
- Parameters
-
in_directory UTF8-encoded directory name.
- Returns
- A reference to this World object.
World& HPS::World::SetRealDWGDirectory | ( | char const * | in_directory | ) |
Sets the RealDWG directory. This directory must be specified to make use of the DWG module.
- Parameters
-
in_directory UTF8-encoded directory name.
- Returns
- A reference to this World object.
- Deprecated:
- This function exists for compatibility. In order to use DWG please make sure that the RealDWG directory is part of your PATH. Users who use RealDWG Object Enablers should additionally make sure that the DBX files for the Object Enablers are located in your PATH, prior to initializing HPS.
World& HPS::World::SetRealDWGDirectory | ( | char const * | in_directory, |
UTF8Array const & | in_object_enabler_directories | ||
) |
Sets the RealDWG directory and its related Object Enabler directories. This RealDWG directory must be specified to make use of the DWG module.
- Parameters
-
in_directory UTF8-encoded directory name. in_object_enabler_directories A list of UTF8-encoded directory names.
- Returns
- A reference to this World object.
- Deprecated:
- This function exists for compatibility. In order to use DWG please make sure that the RealDWG directory is part of your PATH. Users who use RealDWG Object Enablers should additionally make sure that the DBX files for the Object Enablers are located in your PATH, prior to initializing HPS.
bool HPS::World::ShowDriverConfigFile | ( | UTF8 & | out_filename | ) | const |
Shows the driver configuration file for Visualize.
- Parameters
-
out_filename UTF8-encoded file names.
- Returns
- true if font directories were specified, false otherwise.
bool HPS::World::ShowExchangeLibraryDirectory | ( | UTF8 & | out_directory | ) | const |
bool HPS::World::ShowFontDirectories | ( | UTF8Array & | out_directories | ) | const |
Shows the font directories for Visualize.
- Parameters
-
out_directories Array of UTF8-encoded directory names.
- Returns
- true if font directories were specified, false otherwise.
bool HPS::World::ShowMaterialLibraryDirectory | ( | UTF8 & | out_directory | ) | const |
Shows the material library directory for Visualize.
- Parameters
-
out_directory UTF8-encoded directory name.
- Returns
- true if a material library directory was specified, false otherwise.
bool HPS::World::ShowParasolidBodyshopDirectory | ( | UTF8 & | out_directory | ) | const |
bool HPS::World::ShowParasolidSchemaDirectory | ( | UTF8 & | out_directory | ) | const |
bool HPS::World::ShowPublishResourceDirectory | ( | UTF8 & | out_directory | ) | const |
bool HPS::World::ShowRealDWGDirectory | ( | UTF8 & | out_directory, |
UTF8Array & | out_object_enabler_directories | ||
) | const |
Shows the RealDWG directory and any related Object Enabler directories.
- Parameters
-
out_directory UTF8-encoded directory name. out_object_enabler_directories A list of UTF8-encoded directory names.
- Returns
- true if a RealDWG directory was specified, false otherwise.
- Deprecated:
- This function exists for compatibility.
|
static |
Stops Code Generation.
World& HPS::World::UnsetDriverConfigFile | ( | ) |
Removes the driver configuration file for Visualize.
- Returns
- A reference to this World object.
World& HPS::World::UnsetExchangeLibraryDirectory | ( | ) |
World& HPS::World::UnsetFontDirectories | ( | ) |
Removes the font directories for Visualize.
- Returns
- A reference to this World object.
World& HPS::World::UnsetMaterialLibraryDirectory | ( | ) |
Removes the material library directory for Visualize.
- Returns
- A reference to this World object.
World& HPS::World::UnsetParasolidBodyshopDirectory | ( | ) |
World& HPS::World::UnsetParasolidSchemaDirectory | ( | ) |
World& HPS::World::UnsetPublishResourceDirectory | ( | ) |
World& HPS::World::UnsetRealDWGDirectory | ( | ) |
Removes the RealDWG directory and any Object Enabler directories.
- Returns
- A reference to this World object.
- Deprecated:
- This function exists for compatibility.
The documentation for this class was generated from the following file:
- include/hps.h