###########
hp_bridge.h
###########

.. default-domain:: cpp

Macro Definitions
=================

=== ============================================================
..  :c:macro:`~HP_ERROR_key_out_of_range`                       
..  :c:macro:`~HP_ERROR_non_circle_key_out_of_range`            
..  :c:macro:`~HP_ERROR_key_does_not_exist`                     
..  :c:macro:`~HP_ERROR_unable_to_determine_entity_class`       
..  :c:macro:`~HP_ERROR_non_mappable_entity_class`              
..  :c:macro:`~HP_ERROR_unknown_entity_class`                   
..  :c:macro:`~HP_ERROR_not_implemented`                        
..  :c:macro:`~HP_ERROR_hoops_key_maps_to_invalid_entity_class` 
..  :c:macro:`~HP_ERROR_incorrect_face_tag_mapping`             
..  :c:macro:`~__wchar_t`                                       
=== ============================================================

Functions
=========

================ ==============================================================================================================================================================================================================================================================
void             :cpp:func:`HP_Init <void HP_Init(char const *pathToSchemaFiles, PK_LOGICAL_t useBulletinBoard, bool bUnicodeFilenames=true)>`                                                                                                                                 
void             :cpp:func:`HP_Update <void HP_Update(void)>`                                                                                                                                                                                                                  
void             :cpp:func:`HP_Close <void HP_Close(void)>`                                                                                                                                                                                                                    
PK_ERROR_code_t  :cpp:func:`HP_Read_Xmt_File <PK_ERROR_code_t HP_Read_Xmt_File(char const *filename, PK_PARTITION_t file_partition, int *num_parts, PK_PART_t **parts, PK_PART_receive_o_t const *options, bool tesselate=true, char const *face_tessellation_level=nullptr)>` 
PK_ERROR_code_t  :cpp:func:`HP_Write_Xmt_File <PK_ERROR_code_t HP_Write_Xmt_File(char const *filename, int num_parts, PK_PART_t const *parts, PK_PART_transmit_o_t const *options)>`                                                                                           
void             :cpp:func:`HP_Init <void HP_Init(wchar_t const *pathToSchemaFiles, PK_LOGICAL_t useBulletinBoard, bool bUnicodeFilenames=true)>`                                                                                                                              
PK_ERROR_code_t  :cpp:func:`HP_Read_Xmt_File <PK_ERROR_code_t HP_Read_Xmt_File(wchar_t const *filename, PK_PARTITION_t file_partition, int *num_parts, PK_PART_t **parts, PK_PART_receive_o_t const *options, bool tesselate=true)>`                                           
PK_ERROR_code_t  :cpp:func:`HP_Write_Xmt_File <PK_ERROR_code_t HP_Write_Xmt_File(wchar_t const *filename, int num_parts, PK_PART_t const *parts, PK_PART_transmit_o_t const *options)>`                                                                                        
void             :cpp:func:`HP_Delete_Entity_Geometry <void HP_Delete_Entity_Geometry(unsigned long count, PK_ENTITY_t *entities, bool PreserveSegments=false)>`                                                                                                               
void             :cpp:func:`HP_Render_Entities <void HP_Render_Entities(unsigned long count, PK_ENTITY_t *entities, PK_TRANSF_t view_transf=NULTAG, PK_TRANSF_t *topol_transf=0, char const *face_tessellation_level=nullptr)>`                                                
void             :cpp:func:`HP_Render_Entity <void HP_Render_Entity(PK_ENTITY_t entity, PK_TRANSF_t trans=NULTAG, PK_TRANSF_t topol_transf=NULTAG, char const *face_tessellation_level=nullptr)>`                                                                              
bool             :cpp:func:`HP_Update_Entity <bool HP_Update_Entity(PK_ENTITY_t entity, PK_TRANSF_t view_trans=NULTAG, PK_TRANSF_t topol_transf=NULTAG)>`                                                                                                                      
void             :cpp:func:`HP_Show_Tessellation_Options <void HP_Show_Tessellation_Options(PK_TOPOL_render_line_o_t *line_Options, PK_TOPOL_render_facet_go_o_t *go_options, PK_TOPOL_facet_mesh_o_t *generation_settings)>`                                                  
void             :cpp:func:`HP_Set_Tessellation_Options <void HP_Set_Tessellation_Options(PK_TOPOL_render_line_o_t *line_Options, PK_TOPOL_render_facet_go_o_t *go_options, PK_TOPOL_facet_mesh_o_t *generation_settings)>`                                                    
long             :cpp:func:`HP_Compute_Geometry_Keys <long HP_Compute_Geometry_Keys(PK_ENTITY_t tagID, long max_count, HC_KEY *keys, char const *list)>`                                                                                                                       
long             :cpp:func:`HP_Compute_Geometry_Key_Count <long HP_Compute_Geometry_Key_Count(PK_ENTITY_t tagID, char *list)>`                                                                                                                                                 
PK_ENTITY_t      :cpp:func:`HP_Compute_TagID <PK_ENTITY_t HP_Compute_TagID(HC_KEY key, PK_CLASS_t paraClass)>`                                                                                                                                                                 
void             :cpp:func:`HP_Set_Rendering_Options <void HP_Set_Rendering_Options(char const *list)>`                                                                                                                                                                        
void             :cpp:func:`HP_Show_Rendering_Options <void HP_Show_Rendering_Options(char *list)>`                                                                                                                                                                            
void             :cpp:func:`HP_Show_One_Rendering_Option <void HP_Show_One_Rendering_Option(char const *type, char *value)>`                                                                                                                                                   
int              :cpp:func:`HP_CheckConsistency <int HP_CheckConsistency(void)>`                                                                                                                                                                                               
wchar_t const *  :cpp:func:`HP_Get_Schema_Path <wchar_t const  * HP_Get_Schema_Path(void)>`                                                                                                                                                                                    
void             :cpp:func:`HP_Set_Schema_Path <void HP_Set_Schema_Path(char const *schema_path)>`                                                                                                                                                                             
unsigned char    :cpp:func:`HP_Get_Hash_Level <unsigned char HP_Get_Hash_Level(void)>`                                                                                                                                                                                         
void             :cpp:func:`HP_Set_Hash_Level <void HP_Set_Hash_Level(unsigned char level)>`                                                                                                                                                                                   
void             :cpp:func:`HP_Set_Instances_To_Bodies <void HP_Set_Instances_To_Bodies(bool flatten)>`                                                                                                                                                                        
bool             :cpp:func:`HP_Get_Instances_To_Bodies <bool HP_Get_Instances_To_Bodies(void)>`                                                                                                                                                                                
int              :cpp:func:`HP_Check_Consistency <int HP_Check_Consistency(void)>`                                                                                                                                                                                             
bool             :cpp:func:`HP_Associate_Key_To_Entity <bool HP_Associate_Key_To_Entity(PK_ENTITY_t entity, HC_KEY key)>`                                                                                                                                                      
void             :cpp:func:`HP_Compute_Selected_Entity_List <void HP_Compute_Selected_Entity_List(PK_ENTITY_t **entities, int *numentities)>`                                                                                                                                  
================ ==============================================================================================================================================================================================================================================================

Detailed Description
====================

.. doxygenfile:: hp_bridge.h
   :project: parasolid
   :sections: detaileddescription

Macro Definition
================

.. doxygendefine:: HP_ERROR_key_out_of_range
   :project: parasolid

.. doxygendefine:: HP_ERROR_non_circle_key_out_of_range
   :project: parasolid

.. doxygendefine:: HP_ERROR_key_does_not_exist
   :project: parasolid

.. doxygendefine:: HP_ERROR_unable_to_determine_entity_class
   :project: parasolid

.. doxygendefine:: HP_ERROR_non_mappable_entity_class
   :project: parasolid

.. doxygendefine:: HP_ERROR_unknown_entity_class
   :project: parasolid

.. doxygendefine:: HP_ERROR_not_implemented
   :project: parasolid

.. doxygendefine:: HP_ERROR_hoops_key_maps_to_invalid_entity_class
   :project: parasolid

.. doxygendefine:: HP_ERROR_incorrect_face_tag_mapping
   :project: parasolid

.. doxygendefine:: __wchar_t
   :project: parasolid

Function Documentation
======================

.. doxygenfunction:: HP_Init
   :project: parasolid

.. doxygenfunction:: HP_Update
   :project: parasolid

.. doxygenfunction:: HP_Close
   :project: parasolid

.. doxygenfunction:: HP_Read_Xmt_File
   :project: parasolid

.. doxygenfunction:: HP_Write_Xmt_File
   :project: parasolid

.. doxygenfunction:: HP_Init
   :project: parasolid

.. doxygenfunction:: HP_Read_Xmt_File
   :project: parasolid

.. doxygenfunction:: HP_Write_Xmt_File
   :project: parasolid

.. doxygenfunction:: HP_Delete_Entity_Geometry
   :project: parasolid

.. doxygenfunction:: HP_Render_Entities
   :project: parasolid

.. doxygenfunction:: HP_Render_Entity
   :project: parasolid

.. doxygenfunction:: HP_Update_Entity
   :project: parasolid

.. doxygenfunction:: HP_Show_Tessellation_Options
   :project: parasolid

.. doxygenfunction:: HP_Set_Tessellation_Options
   :project: parasolid

.. doxygenfunction:: HP_Compute_Geometry_Keys
   :project: parasolid

.. doxygenfunction:: HP_Compute_Geometry_Key_Count
   :project: parasolid

.. doxygenfunction:: HP_Compute_TagID
   :project: parasolid

.. doxygenfunction:: HP_Set_Rendering_Options
   :project: parasolid

.. doxygenfunction:: HP_Show_Rendering_Options
   :project: parasolid

.. doxygenfunction:: HP_Show_One_Rendering_Option
   :project: parasolid

.. doxygenfunction:: HP_CheckConsistency
   :project: parasolid

.. doxygenfunction:: HP_Get_Schema_Path
   :project: parasolid

.. doxygenfunction:: HP_Set_Schema_Path
   :project: parasolid

.. doxygenfunction:: HP_Get_Hash_Level
   :project: parasolid

.. doxygenfunction:: HP_Set_Hash_Level
   :project: parasolid

.. doxygenfunction:: HP_Set_Instances_To_Bodies
   :project: parasolid

.. doxygenfunction:: HP_Get_Instances_To_Bodies
   :project: parasolid

.. doxygenfunction:: HP_Check_Consistency
   :project: parasolid

.. doxygenfunction:: HP_Associate_Key_To_Entity
   :project: parasolid

.. doxygenfunction:: HP_Compute_Selected_Entity_List
   :project: parasolid



