World

class HPS.World : HPS.Object

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.

Public Functions

override void Dispose ()
override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return:The declared type of the object in question, which may differ from the true, underlying type.
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.

Param in_filename:
 UTF8-encoded file name.
Return:A reference to this World object.
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.

Param in_directory:
 UTF8-encoded directory name.
Return:A reference to this World object.
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.

Param in_directories:
 Array of UTF8-encoded directory names.
Return:A reference to this World object.
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.

Param in_directory:
 UTF8-encoded directory name.
Return:A reference to this World object.
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.

Param in_directory:
 UTF8-encoded directory name.
Return:A reference to this World object.
HPS.World SetParasolidBodyshopDirectory (string in_directory)

Sets the Parasolid Bodyshop directory. If this directory is specified, Exchange will use the Parasolid Bodyshop to translate files to Parasolid parts.

Param in_directory:
 UTF8-encoded directory name.
Return:A reference to this World object.
HPS.World SetParasolidSchemaDirectory (string 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.

Param in_directory:
 UTF8-encoded directory name.
Return:A reference to this World object.
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.

Param in_directory:
 UTF8-encoded directory name.
Return:A reference to this World object.
bool ShowDriverConfigFile (out string out_filename)

Shows the driver configuration file for Visualize.

Param out_filename:
 UTF8-encoded file names.
Return:true if font directories were specified, false otherwise.
bool ShowExchangeLibraryDirectory (out string out_directory)

Shows the Exchange and Publish library directory.

Param out_directory:
 UTF8-encoded directory name.
Return:true if an Exchange and Publish directory was specified, false otherwise.
bool ShowFontDirectories (out string[] out_directories)
bool ShowMaterialLibraryDirectory (out string out_directory)

Shows the material library directory for Visualize.

Param out_directory:
 UTF8-encoded directory name.
Return:true if a material library directory was specified, false otherwise.
bool ShowParasolidBodyshopDirectory (out string out_directory)

Shows the Parasolid Bodyshop directory.

Param out_directory:
 UTF8-encoded directory name.
Return:true if a Parasolid Bodyshop directory was specified, false otherwise.
bool ShowParasolidSchemaDirectory (out string out_directory)

Shows the Parasolid schema directory.

Param out_directory:
 UTF8-encoded directory name.
Return:true if a Parasolid schema directory was specified, false otherwise.
bool ShowPublishResourceDirectory (out string out_directory)

Shows the Publish resource directory.

Param out_directory:
 UTF8-encoded directory name.
Return:true if a Publish resource directory was specified, false otherwise.
HPS.World UnsetDriverConfigFile ()

Removes the driver configuration file for Visualize.

Return:A reference to this World object.
HPS.World UnsetExchangeLibraryDirectory ()

Removes the Exchange and Publish library directory. Note, this will remove the previously specified directory from the PATH.

Return:A reference to this World object.
HPS.World UnsetFontDirectories ()

Removes the font directories for Visualize.

Return:A reference to this World object.
HPS.World UnsetMaterialLibraryDirectory ()

Removes the material library directory for Visualize.

Return:A reference to this World object.
HPS.World UnsetParasolidBodyshopDirectory ()

Removes the Parasolid Bodyshop directory.

Return:A reference to this World object.
HPS.World UnsetParasolidSchemaDirectory ()

Removes the Parasolid schema directory.

Return:A reference to this World object.
HPS.World UnsetPublishResourceDirectory ()

Removes the Publish resource directory.

Return:A reference to this World object.
World (HPS.World in_that)
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. 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.

Param in_license:
 UTF8-encoded license string for Visualize.
World (string in_license, string in_code_generation_directory)

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.

Param in_license:
 UTF8-encoded license string for Visualize.
Param in_code_generation_directory:
 UTF8-encoded directory where the output of Code Generation will be stored. The directory must already exist.

Public Static Functions

void AddCodeGenerationComment (string in_comment)
bool IsInitialized ()

Returns the state of the World

Return:true if the World has been initialized; otherwise false if the World is not initialized or has been deconstructed.
void StopCodeGeneration ()

Stops Code Generation.