REFERENCE MANUAL
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. More...
Public Member Functions | |
override void | Dispose () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
HPS.World | SetDriverConfigFile (string in_filename) |
Sets the driver configuration file (i.e., a plain text file which can force device specific behavior) for Visualize. More... | |
HPS.World | SetExchangeLibraryDirectory (string in_directory) |
Sets the directory which contains the Exchange and Publish libraries. More... | |
HPS.World | SetFontDirectories (string[] in_directories) |
Sets the directories which contain fonts for use by Visualize. More... | |
HPS.World | SetFontDirectory (string in_directory) |
Sets the directory which contains fonts for use by Visualize. More... | |
HPS.World | SetMaterialLibraryDirectory (string in_directory) |
Sets the directory which contains the material library for Visualize. More... | |
HPS.World | SetParasolidSchemaDirectory (string in_directory) |
Sets the schema directory for Parasolid. More... | |
HPS.World | SetPublishResourceDirectory (string in_directory) |
Sets the resource directory for Publish. More... | |
bool | ShowDriverConfigFile (out string out_filename) |
Shows the driver configuration file for Visualize. More... | |
bool | ShowExchangeLibraryDirectory (out string out_directory) |
Shows the Exchange and Publish library directory. More... | |
bool | ShowFontDirectories (out string[] out_directories) |
Shows the font directories for Visualize. More... | |
bool | ShowLicense (out string out_license) |
Shows the license passed to the World constructor. More... | |
bool | ShowMaterialLibraryDirectory (out string out_directory) |
Shows the material library directory for Visualize. More... | |
bool | ShowParasolidSchemaDirectory (out string out_directory) |
Shows the Parasolid schema directory. More... | |
bool | ShowPublishResourceDirectory (out string out_directory) |
Shows the Publish resource directory. More... | |
HPS.World | UnsetDriverConfigFile () |
Removes the driver configuration file for Visualize. More... | |
HPS.World | UnsetExchangeLibraryDirectory () |
Removes the Exchange and Publish library directory. More... | |
HPS.World | UnsetFontDirectories () |
Removes the font directories for Visualize. More... | |
HPS.World | UnsetMaterialLibraryDirectory () |
Removes the material library directory for Visualize. More... | |
HPS.World | UnsetParasolidSchemaDirectory () |
Removes the Parasolid schema directory. More... | |
HPS.World | UnsetPublishResourceDirectory () |
Removes the Publish resource directory. More... | |
World (string in_license) | |
This constructor creates a new World object with the given license. More... | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
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.
HPS.World.World | ( | string | 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. |
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
HPS.World HPS.World.SetDriverConfigFile | ( | string | 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. |
HPS.World HPS.World.SetExchangeLibraryDirectory | ( | string | 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. |
HPS.World HPS.World.SetFontDirectories | ( | string[] | 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_count | Size of the following array. |
in_directories | Array of UTF8-encoded directory names. |
HPS.World HPS.World.SetFontDirectory | ( | string | 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. |
HPS.World HPS.World.SetMaterialLibraryDirectory | ( | string | 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. |
HPS.World HPS.World.SetParasolidSchemaDirectory | ( | string | in_directory | ) |
HPS.World HPS.World.SetPublishResourceDirectory | ( | string | 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 HPS.World.ShowDriverConfigFile | ( | out string | out_filename | ) |
Shows the driver configuration file for Visualize.
out_filename | UTF8-encoded file names. |
bool HPS.World.ShowExchangeLibraryDirectory | ( | out string | out_directory | ) |
bool HPS.World.ShowFontDirectories | ( | out string[] | out_directories | ) |
Shows the font directories for Visualize.
out_directories | Array of UTF8-encoded directory names. |
bool HPS.World.ShowLicense | ( | out string | out_license | ) |
Shows the license passed to the World constructor.
out_license | UTF8-encoded license string. |
bool HPS.World.ShowMaterialLibraryDirectory | ( | out string | out_directory | ) |
Shows the material library directory for Visualize.
out_directory | UTF8-encoded directory name. |
bool HPS.World.ShowParasolidSchemaDirectory | ( | out string | out_directory | ) |
bool HPS.World.ShowPublishResourceDirectory | ( | out string | out_directory | ) |
HPS.World HPS.World.UnsetDriverConfigFile | ( | ) |
Removes the driver configuration file for Visualize.
HPS.World HPS.World.UnsetExchangeLibraryDirectory | ( | ) |
HPS.World HPS.World.UnsetFontDirectories | ( | ) |
Removes the font directories for Visualize.
HPS.World HPS.World.UnsetMaterialLibraryDirectory | ( | ) |
Removes the material library directory for Visualize.
HPS.World HPS.World.UnsetParasolidSchemaDirectory | ( | ) |
HPS.World HPS.World.UnsetPublishResourceDirectory | ( | ) |