REFERENCE MANUAL
#include <hps.h>
Public Member Functions | |
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 & | SetParasolidSchemaDirectory (char const *in_directory) |
World & | SetPublishResourceDirectory (char const *in_directory) |
bool | ShowDriverConfigFile (UTF8 &out_filename) const |
bool | ShowExchangeLibraryDirectory (UTF8 &out_directory) const |
bool | ShowFontDirectories (UTF8Array &out_directories) const |
bool | ShowLicense (UTF8 &out_license) const |
bool | ShowMaterialLibraryDirectory (UTF8 &out_directory) const |
bool | ShowParasolidSchemaDirectory (UTF8 &out_directory) const |
bool | ShowPublishResourceDirectory (UTF8 &out_directory) const |
World & | UnsetDriverConfigFile () |
World & | UnsetExchangeLibraryDirectory () |
World & | UnsetFontDirectories () |
World & | UnsetMaterialLibraryDirectory () |
World & | UnsetParasolidSchemaDirectory () |
World & | UnsetPublishResourceDirectory () |
World (char const *in_license) | |
~World () | |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
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.
World::World | ( | char const * | in_license | ) |
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.
in_license | UTF8-encoded license string for Visualize. |
World::~World | ( | ) |
The destructor will shutdown the database and invalidate all objects within it.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Object.
World& 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.
in_filename | UTF8-encoded file name. |
World& 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.
in_directory | UTF8-encoded directory name. |
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.
in_count | Size of the following array. |
in_directories | Array of UTF8-encoded directory names. |
World& World::SetFontDirectories | ( | UTF8Array const & | in_directories | ) |
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.
in_directories | Array of UTF8-encoded directory names. |
World& 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.
in_directory | UTF8-encoded directory name. |
World& 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.
in_directory | UTF8-encoded directory name. |
World& World::SetParasolidSchemaDirectory | ( | char const * | in_directory | ) |
World& 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.
in_directory | UTF8-encoded directory name. |
bool World::ShowDriverConfigFile | ( | UTF8 & | out_filename | ) | const |
Shows the driver configuration file for Visualize.
out_filename | UTF8-encoded file names. |
bool World::ShowExchangeLibraryDirectory | ( | UTF8 & | out_directory | ) | const |
bool World::ShowFontDirectories | ( | UTF8Array & | out_directories | ) | const |
Shows the font directories for Visualize.
out_directories | Array of UTF8-encoded directory names. |
bool World::ShowLicense | ( | UTF8 & | out_license | ) | const |
Shows the license passed to the World constructor.
out_license | UTF8-encoded license string. |
bool World::ShowMaterialLibraryDirectory | ( | UTF8 & | out_directory | ) | const |
Shows the material library directory for Visualize.
out_directory | UTF8-encoded directory name. |
bool World::ShowParasolidSchemaDirectory | ( | UTF8 & | out_directory | ) | const |
bool World::ShowPublishResourceDirectory | ( | UTF8 & | out_directory | ) | const |
World& World::UnsetDriverConfigFile | ( | ) |
Removes the driver configuration file for Visualize.
World& World::UnsetExchangeLibraryDirectory | ( | ) |
World& World::UnsetFontDirectories | ( | ) |
Removes the font directories for Visualize.
World& World::UnsetMaterialLibraryDirectory | ( | ) |
Removes the material library directory for Visualize.
World& World::UnsetParasolidSchemaDirectory | ( | ) |
World& World::UnsetPublishResourceDirectory | ( | ) |