Public Member Functions | Protected Member Functions | List of all members
HPS.World Class Reference

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

Inheritance diagram for HPS.World:
HPS.Object

Public Member Functions

override void Dispose ()
 
 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. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
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. More...
 
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. More...
 
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. 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. 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. More...
 
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. More...
 
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. More...
 
HPS.World SetParasolidSchemaDirectory (string in_directory)
 Sets the schema directory for Parasolid. This directory must be specified to make use of the Parasolid module. More...
 
HPS.World SetRealDWGDirectory (string in_directory)
 Sets the RealDWG directory. This directory must be specified to make use of the DWG module. More...
 
HPS.World SetRealDWGDirectory (string in_directory, string[] 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. More...
 
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. More...
 
HPS.World UnsetMaterialLibraryDirectory ()
 Removes the material library directory for Visualize. More...
 
HPS.World UnsetFontDirectories ()
 Removes the font directories for Visualize. More...
 
HPS.World UnsetDriverConfigFile ()
 Removes the driver configuration file for Visualize. More...
 
HPS.World UnsetExchangeLibraryDirectory ()
 Removes the Exchange and Publish library directory. Note, this will remove the previously specified directory from the PATH. More...
 
HPS.World UnsetPublishResourceDirectory ()
 Removes the Publish resource directory. More...
 
HPS.World UnsetParasolidSchemaDirectory ()
 Removes the Parasolid schema directory. More...
 
HPS.World UnsetRealDWGDirectory ()
 Removes the RealDWG directory and any Object Enabler directories. More...
 
HPS.World UnsetParasolidBodyshopDirectory ()
 Removes the Parasolid Bodyshop directory. 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 ShowFontDirectories (out string[] out_directories)
 Shows the font directories for Visualize. 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 ShowPublishResourceDirectory (out string out_directory)
 Shows the Publish resource directory. More...
 
bool ShowParasolidSchemaDirectory (out string out_directory)
 Shows the Parasolid schema directory. More...
 
bool ShowRealDWGDirectory (out string out_directory, out string[] out_object_enabler_directories)
 Shows the RealDWG directory and any related Object Enabler directories. More...
 
bool ShowParasolidBodyshopDirectory (out string out_directory)
 Shows the Parasolid Bodyshop directory. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object that)
 
HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 

Protected Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

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

Parameters
in_licenseUTF8-encoded license string for Visualize.

Member Function Documentation

override HPS.Type HPS.World.ObjectType ( )
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.

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

Parameters
in_directoryUTF8-encoded directory name.
Returns
A reference to this World object.
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.
HPS.World HPS.World.SetRealDWGDirectory ( string  in_directory)
inline

Sets the RealDWG directory. This directory must be specified to make use of the DWG module.

Parameters
in_directoryUTF8-encoded directory name.
Returns
A reference to this World object.
HPS.World HPS.World.SetRealDWGDirectory ( string  in_directory,
string[]  in_object_enabler_directories 
)
inline

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_directoryUTF8-encoded directory name.
in_object_enabler_directoriesA list of UTF8-encoded directory names.
Returns
A reference to this World object.
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.
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.
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.
bool HPS.World.ShowLicense ( out string  out_license)
inline

Shows the license passed to the World constructor.

Parameters
out_licenseUTF8-encoded license string.
Returns
true if a license was specified, false otherwise.
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.
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.
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.
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.
bool HPS.World.ShowRealDWGDirectory ( out string  out_directory,
out string[]  out_object_enabler_directories 
)
inline

Shows the RealDWG directory and any related Object Enabler directories.

Parameters
out_directoryUTF8-encoded directory name.
out_object_enabler_directoriesA list of UTF8-encoded directory names.
Returns
true if a RealDWG directory was specified, false otherwise.
HPS.World HPS.World.UnsetDriverConfigFile ( )
inline

Removes the driver configuration file for Visualize.

Returns
A reference to this World object.
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.
HPS.World HPS.World.UnsetFontDirectories ( )
inline

Removes the font directories for Visualize.

Returns
A reference to this World object.
HPS.World HPS.World.UnsetMaterialLibraryDirectory ( )
inline

Removes the material library directory for Visualize.

Returns
A reference to this World object.
HPS.World HPS.World.UnsetParasolidBodyshopDirectory ( )
inline

Removes the Parasolid Bodyshop directory.

Returns
A reference to this World object.
HPS.World HPS.World.UnsetParasolidSchemaDirectory ( )
inline

Removes the Parasolid schema directory.

Returns
A reference to this World object.
HPS.World HPS.World.UnsetPublishResourceDirectory ( )
inline

Removes the Publish resource directory.

Returns
A reference to this World object.
HPS.World HPS.World.UnsetRealDWGDirectory ( )
inline

Removes the RealDWG directory and any Object Enabler directories.

Returns
A reference to this World object.

The documentation for this class was generated from the following file: