Inheritance diagram for HPS.World:
HPS.Object

Public Member Functions

override void Dispose ()
 
override HPS.Type ObjectType ()
 
HPS.World SetDriverConfigFile (string in_filename)
 
HPS.World SetExchangeLibraryDirectory (string in_directory)
 
HPS.World SetFontDirectories (string[] in_directories)
 
HPS.World SetFontDirectory (string in_directory)
 
HPS.World SetMaterialLibraryDirectory (string in_directory)
 
HPS.World SetParasolidBodyshopDirectory (string in_directory)
 
HPS.World SetParasolidSchemaDirectory (string in_directory)
 
HPS.World SetPublishResourceDirectory (string in_directory)
 
bool ShowDriverConfigFile (out string out_filename)
 
bool ShowExchangeLibraryDirectory (out string out_directory)
 
bool ShowFontDirectories (out string[] out_directories)
 
bool ShowMaterialLibraryDirectory (out string out_directory)
 
bool ShowParasolidBodyshopDirectory (out string out_directory)
 
bool ShowParasolidSchemaDirectory (out string out_directory)
 
bool ShowPublishResourceDirectory (out string out_directory)
 
HPS.World UnsetDriverConfigFile ()
 
HPS.World UnsetExchangeLibraryDirectory ()
 
HPS.World UnsetFontDirectories ()
 
HPS.World UnsetMaterialLibraryDirectory ()
 
HPS.World UnsetParasolidBodyshopDirectory ()
 
HPS.World UnsetParasolidSchemaDirectory ()
 
HPS.World UnsetPublishResourceDirectory ()
 
 World (string in_license, string in_code_generation_directory)
 
 World (string in_license)
 
 World (HPS.World in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static void AddCodeGenerationComment (string in_comment)
 
static void StopCodeGeneration ()
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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

◆ World() [1/2]

HPS.World.World ( string  in_license,
string  in_code_generation_directory 
)
inline

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_licenseUTF8-encoded license string for Visualize.
in_code_generation_directoryUTF8-encoded directory where the output of Code Generation will be stored. The directory must already exist.

◆ World() [2/2]

HPS.World.World ( string  in_license)
inline

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_licenseUTF8-encoded license string for Visualize.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.World.ObjectType ( )
inlinevirtual

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).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

◆ SetDriverConfigFile()

HPS.World HPS.World.SetDriverConfigFile ( string  in_filename)
inline

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_filenameUTF8-encoded file name.
Returns
A reference to this World object.

◆ SetExchangeLibraryDirectory()

HPS.World HPS.World.SetExchangeLibraryDirectory ( string  in_directory)
inline

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_directoryUTF8-encoded directory name.
Returns
A reference to this World object.

◆ SetFontDirectories()

HPS.World HPS.World.SetFontDirectories ( string []  in_directories)
inline

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_directoriesArray of UTF8-encoded directory names.
Returns
A reference to this World object.

◆ SetFontDirectory()

HPS.World HPS.World.SetFontDirectory ( string  in_directory)
inline

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_directoryUTF8-encoded directory name.
Returns
A reference to this World object.

◆ SetMaterialLibraryDirectory()

HPS.World HPS.World.SetMaterialLibraryDirectory ( string  in_directory)
inline

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_directoryUTF8-encoded directory name.
Returns
A reference to this World object.

◆ SetParasolidBodyshopDirectory()

HPS.World HPS.World.SetParasolidBodyshopDirectory ( string  in_directory)
inline

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

Parameters
in_directoryUTF8-encoded directory name.
Returns
A reference to this World object.

◆ SetParasolidSchemaDirectory()

HPS.World HPS.World.SetParasolidSchemaDirectory ( string  in_directory)
inline

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_directoryUTF8-encoded directory name.
Returns
A reference to this World object.

◆ SetPublishResourceDirectory()

HPS.World HPS.World.SetPublishResourceDirectory ( string  in_directory)
inline

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_directoryUTF8-encoded directory name.
Returns
A reference to this World object.

◆ ShowDriverConfigFile()

bool HPS.World.ShowDriverConfigFile ( out string  out_filename)
inline

Shows the driver configuration file for Visualize.

Parameters
out_filenameUTF8-encoded file names.
Returns
true if font directories were specified, false otherwise.

◆ ShowExchangeLibraryDirectory()

bool HPS.World.ShowExchangeLibraryDirectory ( out string  out_directory)
inline

Shows the Exchange and Publish library directory.

Parameters
out_directoryUTF8-encoded directory name.
Returns
true if an Exchange and Publish directory was specified, false otherwise.

◆ ShowFontDirectories()

bool HPS.World.ShowFontDirectories ( out string []  out_directories)
inline

Shows the font directories for Visualize.

Parameters
out_directoriesArray of UTF8-encoded directory names.
Returns
true if font directories were specified, false otherwise.

◆ ShowMaterialLibraryDirectory()

bool HPS.World.ShowMaterialLibraryDirectory ( out string  out_directory)
inline

Shows the material library directory for Visualize.

Parameters
out_directoryUTF8-encoded directory name.
Returns
true if a material library directory was specified, false otherwise.

◆ ShowParasolidBodyshopDirectory()

bool HPS.World.ShowParasolidBodyshopDirectory ( out string  out_directory)
inline

Shows the Parasolid Bodyshop directory.

Parameters
out_directoryUTF8-encoded directory name.
Returns
true if a Parasolid Bodyshop directory was specified, false otherwise.

◆ ShowParasolidSchemaDirectory()

bool HPS.World.ShowParasolidSchemaDirectory ( out string  out_directory)
inline

Shows the Parasolid schema directory.

Parameters
out_directoryUTF8-encoded directory name.
Returns
true if a Parasolid schema directory was specified, false otherwise.

◆ ShowPublishResourceDirectory()

bool HPS.World.ShowPublishResourceDirectory ( out string  out_directory)
inline

Shows the Publish resource directory.

Parameters
out_directoryUTF8-encoded directory name.
Returns
true if a Publish resource directory was specified, false otherwise.

◆ StopCodeGeneration()

static void HPS.World.StopCodeGeneration ( )
inlinestatic

Stops Code Generation.

◆ UnsetDriverConfigFile()

HPS.World HPS.World.UnsetDriverConfigFile ( )
inline

Removes the driver configuration file for Visualize.

Returns
A reference to this World object.

◆ UnsetExchangeLibraryDirectory()

HPS.World HPS.World.UnsetExchangeLibraryDirectory ( )
inline

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

Returns
A reference to this World object.

◆ UnsetFontDirectories()

HPS.World HPS.World.UnsetFontDirectories ( )
inline

Removes the font directories for Visualize.

Returns
A reference to this World object.

◆ UnsetMaterialLibraryDirectory()

HPS.World HPS.World.UnsetMaterialLibraryDirectory ( )
inline

Removes the material library directory for Visualize.

Returns
A reference to this World object.

◆ UnsetParasolidBodyshopDirectory()

HPS.World HPS.World.UnsetParasolidBodyshopDirectory ( )
inline

Removes the Parasolid Bodyshop directory.

Returns
A reference to this World object.

◆ UnsetParasolidSchemaDirectory()

HPS.World HPS.World.UnsetParasolidSchemaDirectory ( )
inline

Removes the Parasolid schema directory.

Returns
A reference to this World object.

◆ UnsetPublishResourceDirectory()

HPS.World HPS.World.UnsetPublishResourceDirectory ( )
inline

Removes the Publish resource directory.

Returns
A reference to this World object.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.World.cs