Home

HOOPS/ACIS Bridge
[Model Visualization and Display]

Collaboration diagram for HOOPS/ACIS Bridge:
Declared at <ha_bridge.h>. More...

Classes

class  acis_ha_part_entity_mgr
 Concrete entity manager class for ACIS Assembly Modeling with the Scheme example application. More...
class  acis_ha_part_entity_mgr_factory
 Concrete entity manager factory class for creating acis_scm_entity_mgr objects. More...
class  ha_rendering_context
 Rendering context. More...
class  ha_rendering_options
 Rendering Options. More...
class  IEntityConverter
 Interface to be implemented by custom ENTITY conversion classes. More...

Defines

#define HA_CREATE_BODY_SEGMENTS   8
 Create Body Elements.
#define HA_CREATE_COLOR_SEGMENTS   16
 Create Color Segments.
#define HA_GEOMETRY_TYPE_bodies   8
 Body Geometry Type.
#define HA_GEOMETRY_TYPE_edges   2
 Edge Geometry Type.
#define HA_GEOMETRY_TYPE_faces   4
 Face Geometry Type.
#define HA_MERGE_BODIES   4
 Merge Bodies Type.
#define HA_MERGE_FACES   2
 Merge Faces Type.
#define HA_RENDER_EDGES   64
 Render edges.
#define HA_RENDER_FACES   128
 Render faces.
#define HA_TESSELLATE_ELLIPSES   32
 Tessellate ellipses.

Enumerations

enum  CurveFacetLevel
 Curve Facetting Level. More...

Functions

outcome api_initialize_hoops_acis_bridge ()
 ACIS style initialization.
outcome api_terminate_hoops_acis_bridge ()
 ACIS style termination.
logical HA_Associate_Key_To_Component (component_handle *comp, long key)
 Associates the component with key in the component map.
logical HA_Associate_Key_To_Entity (ENTITY *entity, long key)
 Associates the entity with key in the map.
logical HA_Associate_Key_To_Model (asm_model *model, long key)
 Associates the model with key in the model map.
char * HA_Build_Segment_String (ENTITY *entity, char *inbuffer, const char *pattern=0)
 Converts the pattern input to an expanded string and places into a buffer.
void HA_Close (void)
logical HA_Compute_Component_Entity_Keys (component_entity_handle *comp_ent, long &comp_key, long &ent_key)
 Returns the HOOPS keys associated with the given component-entity.
component_entity_handle * HA_Compute_Component_Entity_Pointer (long comp_key, long ent_key)
 Returns the handle pointer for the ACIS assembly component-entity associated with the specified HOOPS segments.
component_entity_handle * HA_Compute_Component_Entity_Pointer (unsigned long count, long *keys)
 Returns the handle pointer for the ACIS assembly component-entity associated with the specified HOOPS segment-key path.
unsigned long HA_Compute_Component_Key_Count (component_handle *comp)
 Returns the number of HOOPS segments in the HOOPS database that represent the given ACIS assembly component.
unsigned long HA_Compute_Component_Keys (component_handle *comp, unsigned long count, long *keys)
 Returns an array of HOOPS keys associated with the given assembly component, with the count.
component_handle * HA_Compute_Component_Pointer (long key)
 Returns the handle pointer for the ACIS assembly component associated with the specified HOOPS segment key.
ENTITY * HA_Compute_Entity_Pointer (long key)
 Returns the pointer for the ACIS entity that contains the specified HOOPS geometric entity.
ENTITY * HA_Compute_Entity_Pointer (long key, int acisClass)
 Returns the pointer for the ACIS entity that contains the specified HOOPS geometric entity.
unsigned long HA_Compute_Geometry_Key_Count (ENTITY *entity)
 Returns the number of HOOPS geometric primitives in the HOOPS database that graphically represent the ACIS entity.
unsigned long HA_Compute_Geometry_Key_Count (ENTITY *entity, const char *geomTypes)
 Returns the number of HOOPS geometric primitives in the HOOPS database that graphically represent the ACIS entity.
unsigned long HA_Compute_Geometry_Keys (ENTITY *entity, unsigned long count, long *keys)
 Returns the array of HOOPS keys for the geometry in the HOOPS database generated by the HOOPS/ACIS Bridge.
unsigned long HA_Compute_Geometry_Keys (ENTITY *entity, unsigned long count, long *keys, const char *geomTypes)
 Returns the array of HOOPS keys for the geometry in the HOOPS database generated by the HOOPS/ACIS Bridge.
unsigned long HA_Compute_Model_Key_Count (asm_model *model)
 Returns the number of HOOPS segments in the HOOPS database that represent the given ACIS assembly model.
unsigned long HA_Compute_Model_Keys (asm_model *model, unsigned long count, long *keys)
 Returns an array of HOOPS keys associated with the given assembly model, with the count.
asm_model * HA_Compute_Model_Pointer (long key)
 Returns the pointer for the ACIS assembly model associated with the specified HOOPS segment key.
void HA_Delete_Entity_Geometry (ENTITY *entity)
 Delete the geometric primitives associated with the given ACIS entity.
void HA_Delete_Entity_Geometry (ENTITY_LIST const &entitylist)
 Delete the geometric primitives associated with the given ACIS entities.
void HA_Delete_Model (asm_model *model)
 Delete the HOOPS segments associated with the given ACIS assembly model.
void HA_Delete_Model_Geometry (asm_model *model)
 Delete the HOOPS segments containing the geometry data associated with the given ACIS assembly model.
void HA_Delete_Model_Ref (ASM_MODEL_REF *mref)
 Delete the HOOPS segments associated with the given ACIS assembly model reference.
logical HA_Disassociate_Key_From_Component (component_handle *comp, long key)
 Disassociates a key in the component map from an assembly component.
logical HA_Disassociate_Key_From_Entity (ENTITY *entity, long key)
 Disassociates a key in the map from an entity.
logical HA_Disassociate_Key_From_Model (asm_model *model, long key)
 Disassociates a key in the model map from an assembly model.
bool HA_Erase_PointCloud (SPApoint_cloud *inputCloud)
 SPApoint_cloud is deprecated.
long HA_Get_Current_View_Segment ()
 Returns the current view segment.
IEntityConverter * HA_Get_Entity_Converter ()
 Returns the current IEntityConverter.
facet_options * HA_Get_Facet_Options ()
 Returns the current facet_options.
bool HA_Get_PointCloud_Color (SPApoint_cloud *inputCloud, rgb_color &outputColor)
 SPApoint_cloud is deprecated.
ha_rendering_options & HA_Get_Rendering_Options ()
 Returns the current ha_rendering_options.
void HA_Highlight_Component_Entity (component_entity_handle *ce, logical on, const rgb_color &color)
 Highlights or un-highlights a component entity with the given color.
void HA_Highlight_Entity (ENTITY *e, logical on, const rgb_color &color)
 Highlights or un-highlights an ENTITY with an rgb_color.
long HA_Highlight_PointCloud (SPApoint_cloud *inputCloud, const rgb_color &inColor, logical turnOn)
 SPApoint_cloud is deprecated.
void HA_Init (const char *options)
long HA_KCreate_Segment (ENTITY *entity, const char *pattern=0)
 Returns the value from HC_KOpen_Segment(HA_Build_Segment_String(entity,pattern)).
long HA_KINDEXED_MESH_to_HOOPS (INDEXED_MESH *mesh, FACE *face=0)
 Converts an INDEXED_MESH into a HOOPS shell.
long HA_KOpen_Segment (ENTITY *entity, const char *pattern=0)
 Returns the value from HC_KOpen_Segment(HA_Build_Segment_String(entity,pattern)).
logical HA_Read_Sab_File (const char *fname, ENTITY_LIST &entitylist)
 Parses the input ACIS file, populates the ACIS kernel with its contents, and creates the corresponding geometry in the HOOPS database using the ACIS renderer and HOOPS/ACIS Bridge.
logical HA_Read_Sat_File (const char *fname, ENTITY_LIST &entitylist)
 Parses the input ACIS file, populates the ACIS kernel with its contents, and creates the corresponding geometry in the HOOPS database using the ACIS renderer and HOOPS/ACIS Bridge.
long HA_Render_Curve (CURVE *this_curve, SPAparameter start_param, SPAparameter end_param, const SPAtransf *sketch_transform)
 Generates the tessellation of an ACIS CURVE.
void HA_Render_Entities (const ENTITY_LIST &entitylist, const char *pattern=0)
 Generate the tessellation of a set of ACIS entities.
long HA_Render_Entity (ENTITY *entity, const char *pattern=0)
 Generate the tessellation of an ACIS entity.
long HA_Render_Model (asm_model *model, const char *pattern=0)
 Generate the tessellation of an ACIS assembly model.
long HA_Render_PointCloud (SPApoint_cloud *inputCloud, const rgb_color &color)
 SPApoint_cloud is deprecated.
long HA_Render_PositionCloud (SPAposition_cloud const &cloud)
 Renders a SPAposition_cloud into its own hoops segment.
logical HA_ReRender_Body_Transforms (ENTITY_LIST &bodies)
 Updates the transforms attached to the segments associated with the specified bodies.
long HA_ReRender_Component (component_handle *comp)
 HA_ReRender_Component regenerates the component-related rendering data associated with the given component and its subcomponents.
void HA_ReRender_Entities (const ENTITY_LIST &entitylist, const char *pattern=0)
 HA_ReRender_Entities regenerates the rendering data for the given ENTITYs.
long HA_ReRender_Entity (ENTITY *entity, const char *pattern=0)
 HA_ReRender_Entity regenerates the rendering data for the given ENTITY.
long HA_ReRender_Model_Components (asm_model *model)
 HA_ReRender_Model_Components regenerates the component-related rendering data for the given assembly model.
long HA_ReRender_Model_Entity (entity_handle *ent_handle)
 HA_ReRender_Model_Entity regenerates the B-Rep rendering data for specified entity within its assembly model.
long HA_ReRender_Model_Geometry (asm_model *model)
 HA_ReRender_Model_Geometry regenerates the B-Rep rendering data for the given assembly model.
void HA_ReRender_Visibility_ASM ()
 Update the visibility of faces, edges, etc., based upon the current rendering options.
SPApoint_cloud * HA_Select_Point_Cloud (long scene_key, HA_Point pick_point)
 SPApoint_cloud is deprecated.
SPApoint_cloud * HA_Select_Point_Cloud_Marker (long scene_key, HA_Point pick_point)
 SPApoint_cloud is deprecated.
SPApoint_cloud * HA_Select_Point_Cloud_Markers (long scene_key, HA_Point pick_point1, HA_Point pick_point2)
 SPApoint_cloud is deprecated.
void HA_Set_Current_View_Segment (long)
 Set the current view segment.
void HA_Set_Entity_Converter (IEntityConverter *ent_conv)
 Sets the IEntityConverter used by HA_Render_Entity/HA_Render_Entities.
void HA_Set_Facet_Options (facet_options *facet_opts)
 Shows the list of rendering options.
bool HA_Set_PointCloud_Color (SPApoint_cloud *inputCloud, rgb_color inColor)
 SPApoint_cloud is deprecated.
void HA_Set_Rendering_Options (const ha_rendering_options &rendering_options)
 Provides control over how ACIS objects are rendered to HOOPS objects via the HOOPS/ACIS Mesh Manager.
void HA_Set_Rendering_Options (const char *rendering_options)
 Provides control over how ACIS objects are rendered to HOOPS objects via the HOOPS/ACIS Mesh Manager.
logical HA_Show_Entity_Highlight (ENTITY *e)
 Determines whether an ENTITY is highlighted.
void HA_Show_One_Rendering_Option (const char *type, char *value)
 Shows a rendering option and the value set to it.
void HA_Show_Rendering_Options (char *list)
 Shows the list of rendering options.
logical HA_Update_Entity (ENTITY *entity)
 Updates the given entity by re-tessellating it.
double HA_World_Coords_Per_Pixel ()
 Returns world coordinates per pixel.
logical HA_Write_Sab_File (const char *fname, ENTITY_LIST const &entitylist)
 Saves all entities in the given entity list with the entities loaded from to the given file.
logical HA_Write_Sat_File (const char *fname, ENTITY_LIST const &entitylist)
 Saves all entities in the given entity list with the entities loaded from to the given file.
logical HA_Write_Sat_File_2 (const char *fname, ENTITY_LIST const &entitylist, float version)
 Saves all entities in the given entity list with the entities loaded from to the given file.

Detailed Description

Declared at <ha_bridge.h>.

Declared at <ientityconverter.h>.

Declared at <ha_rend_options.h>.

Declared at <ha_rend_context.h>.

Declared at <ha_bridge_asm.h>.

Declared at <acis_ha_part_entity_mgr_factory.hxx>.

Declared at <acis_ha_part_entity_mgr.hxx>.

Define Documentation

#define HA_CREATE_BODY_SEGMENTS   8

Create Body Elements.

#define HA_CREATE_COLOR_SEGMENTS   16

Create Color Segments.

#define HA_GEOMETRY_TYPE_bodies   8

Body Geometry Type.

#define HA_GEOMETRY_TYPE_edges   2

Edge Geometry Type.

#define HA_GEOMETRY_TYPE_faces   4

Face Geometry Type.

#define HA_MERGE_BODIES   4

Merge Bodies Type.

#define HA_MERGE_FACES   2

Merge Faces Type.

#define HA_RENDER_EDGES   64

Render edges.

#define HA_RENDER_FACES   128

Render faces.

#define HA_TESSELLATE_ELLIPSES   32

Tessellate ellipses.

Enumeration Type Documentation

enum CurveFacetLevel

Curve Facetting Level.

Parameters:
cfl_world Facet curves to world units tolerance.
cfl_screen Facet curves to screen (pixel) tolerance.
cfl_bounding_box Facet curves to BB diagonal as unit size tolerance.
cfl_face_facets Facet curves using nodes from faceted faces.
cfl_hoops_primitives Display curves as HOOPS primitives when possible.

include <ha_rend_options.h>

Function Documentation

outcome api_initialize_hoops_acis_bridge (  ) 

ACIS style initialization.



Role: The following calls are made inside this routine: 

 api_initialize_faceter();
 api_initialize_rendering();
 api_initialize_generic_attributes();
 g_History_Callbacks = ACIS_NEW HA_History_Callbacks;
 get_history_callbacks_list().add(g_History_Callbacks);
 // Set the ENTITY converter.
 HA_Set_Entity_Converter(ACIS_NEW hoops_acis_entity_converter);
Returns:
Indicates success or failure.

include <ha_bridge.h>

outcome api_terminate_hoops_acis_bridge (  ) 

ACIS style termination.



Role: The following calls are made inside this routine: 

 IEntityConverter *icvrt=HA_Get_Entity_Converter();
 HA_Set_Entity_Converter(0);
 ACIS_DELETE icvrt;
 api_terminate_generic_attributes();
 api_terminate_rendering();
 api_terminate_faceter();
Returns:
Indicates success or failure.

include <ha_bridge.h>

logical HA_Associate_Key_To_Component ( component_handle *  comp,
long  key 
)

Associates the component with key in the component map.



Role: This is required if an ACIS assembly compoment is rendered in a HOOPS scene by a non-bridge routine and still needs to be considered by the Bridge.

Parameters:
comp Given component handle.
key Key for HOOPS segment.

Returns:
Returns TRUE if the given key is associated with the assembly component.

include <ha_bridge_asm.h>

logical HA_Associate_Key_To_Entity ( ENTITY *  entity,
long  key 
)

Associates the entity with key in the map.



Role: This is required if an ACIS ENTITY is rendered in HOOPS scene by a non-bridge routine and still needs to be considered by the Bridge.

Parameters:
entity Given ENTITY.
key Key for HOOPS segment.

Returns:
Returns TRUE if the given key is associated with the entity.

include <ha_bridge.h>

logical HA_Associate_Key_To_Model ( asm_model *  model,
long  key 
)

Associates the model with key in the model map.



Role: This is required if an ACIS model is rendered in a HOOPS scene by a non-bridge routine and still needs to be considered by the Bridge.

Parameters:
model Given asm_model.
key Key for HOOPS segment.

Returns:
Returns true if the given key is associated with the assembly model.

include <ha_bridge_asm.h>

char* HA_Build_Segment_String ( ENTITY *  entity,
char *  inbuffer,
const char *  pattern = 0 
)

Converts the pattern input to an expanded string and places into a buffer.



Role: The pattern should be a string with '/' separating keywords and static strings.

Keywords:

  • history (this is replaced with entity->history())
  • entity (this is replaced with the ENTITY's pointer value)
  • type (this is replaced with entity->type_name())


For example: "?Include Library/entity" will become "?Include Library/0x12345678" if entity=0x12345678

Parameters:
entity Given ENTITY.
inbuffer Expanded string, should be large enough to hold the expanded string.
pattern Segment pattern string.

Returns:
Value of inbuffer.

include <ha_bridge.h>

void HA_Close ( void   ) 

</td>

include <ha_bridge.h>

logical HA_Compute_Component_Entity_Keys ( component_entity_handle *  comp_ent,
long &  comp_key,
long &  ent_key 
)

Returns the HOOPS keys associated with the given component-entity.



Parameters:
comp_ent Pointer to an ACIS component-entity.
comp_key The HOOPS key associated with the component. Returned to user.
ent_key The HOOPS key associated with the entity. Returned to user.

Returns:
Returns TRUE if both keys were found.

include <ha_bridge_asm.h>

component_entity_handle* HA_Compute_Component_Entity_Pointer ( long  comp_key,
long  ent_key 
)

Returns the handle pointer for the ACIS assembly component-entity associated with the specified HOOPS segments.



Parameters:
comp_key The HOOPS key associated with the component.
ent_key The HOOPS key associated with the entity.

Returns:
The requested ACIS pointer.

include <ha_bridge_asm.h>

component_entity_handle* HA_Compute_Component_Entity_Pointer ( unsigned long  count,
long *  keys 
)

Returns the handle pointer for the ACIS assembly component-entity associated with the specified HOOPS segment-key path.



Role: The first component key and entity key found in the key array are used to determine the component-entity.

Parameters:
count the number of keys in the path.
keys HOOPS keys provided for computing associated component-entity handle pointer.

Returns:
The requested ACIS pointer.

include <ha_bridge_asm.h>

unsigned long HA_Compute_Component_Key_Count ( component_handle *  comp  ) 

Returns the number of HOOPS segments in the HOOPS database that represent the given ACIS assembly component.



Role: This allows allocating an appropriate sized keys array for a subsequent HA_Compute_Component_Keys call.

Parameters:
comp Pointer to an ACIS assembly component handle.

Returns:
Number of HOOPS keys associated with the given ACIS assembly component.

include <ha_bridge_asm.h>

unsigned long HA_Compute_Component_Keys ( component_handle *  comp,
unsigned long  count,
long *  keys 
)

Returns an array of HOOPS keys associated with the given assembly component, with the count.



Parameters:
comp Pointer to an ACIS assembly component handle.
count Maximum number of keys that should be returned, see HA_Compute_Component_Key_Count.
keys Array of associated HOOPS keys. Returned to user.

Returns:
Actual number of keys returned to user in keys array. Always less than or equal to count.

include <ha_bridge_asm.h>

component_handle* HA_Compute_Component_Pointer ( long  key  ) 

Returns the handle pointer for the ACIS assembly component associated with the specified HOOPS segment key.



Parameters:
key HOOPS keys provided for computing associated component-handle pointer.

Returns:
The requested ACIS pointer.

include <ha_bridge_asm.h>

ENTITY* HA_Compute_Entity_Pointer ( long  key  ) 

Returns the pointer for the ACIS entity that contains the specified HOOPS geometric entity.



Parameters:
key HOOPS key provided for computing associated ACIS entity pointer.

Returns:
The requested ACIS pointer.

include <ha_bridge.h>

ENTITY* HA_Compute_Entity_Pointer ( long  key,
int  acisClass 
)

Returns the pointer for the ACIS entity that contains the specified HOOPS geometric entity.



Parameters:
key HOOPS key provided for computing associated ACIS entity pointer.
acisClass ACIS Class for desired entity associated with the input HOOPS key.

Returns:
The requested ACIS pointer.

include <ha_bridge.h>

unsigned long HA_Compute_Geometry_Key_Count ( ENTITY *  entity  ) 

Returns the number of HOOPS geometric primitives in the HOOPS database that graphically represent the ACIS entity.



Role: This allows allocating an appropriate sized keys array for a subsequent HA_Compute_Geometry_Keys call.

Parameters:
entity Pointer to an ACIS entity.

Returns:
Number of HOOPS keys associated with the given ACIS entity.

include <ha_bridge.h>

unsigned long HA_Compute_Geometry_Key_Count ( ENTITY *  entity,
const char *  geomTypes 
)

Returns the number of HOOPS geometric primitives in the HOOPS database that graphically represent the ACIS entity.



Role: This allows allocating an appropriate sized keys array for a subsequent HA_Compute_Geometry_Keys call.

Parameters:
entity Pointer to an ACIS entity.
geomTypes A quoted string or string variable specifying the particular types of ACIS geometry that should be converted.

Returns:
Number of HOOPS keys associated with the given ACIS entity.

include <ha_bridge.h>

unsigned long HA_Compute_Geometry_Keys ( ENTITY *  entity,
unsigned long  count,
long *  keys 
)

Returns the array of HOOPS keys for the geometry in the HOOPS database generated by the HOOPS/ACIS Bridge.



Role: HA_Render_Entity must have tessellated the ENTITY.

Parameters:
entity Pointer to an ACIS entity.
count Maximum number of keys that should be returned, see HA_Compute_Geometry_Key_Count.
keys Array of associated HOOPS keys. Returned to user.
geomTypes A quoted string or string variable specifying the particular types of ACIS geometry that should be converted.

Returns:
Actual number of keys returned to user in keys array. Always less than or equal to count.

include <ha_bridge.h>

unsigned long HA_Compute_Geometry_Keys ( ENTITY *  entity,
unsigned long  count,
long *  keys,
const char *  geomTypes 
)

Returns the array of HOOPS keys for the geometry in the HOOPS database generated by the HOOPS/ACIS Bridge.



Role: HA_Render_Entity must have tessellated the ENTITY.

Parameters:
entity Pointer to an ACIS entity.
count Maximum number of keys that should be returned, see HA_Compute_Geometry_Key_Count.
keys Array of associated HOOPS keys. Returned to user.

Returns:
Actual number of keys returned to user in keys array. Always less than or equal to count.

include <ha_bridge.h>

unsigned long HA_Compute_Model_Key_Count ( asm_model *  model  ) 

Returns the number of HOOPS segments in the HOOPS database that represent the given ACIS assembly model.



Role: This allows allocating an appropriate sized keys array for a subsequent HA_Compute_Model_Keys call.

Parameters:
model Pointer to an ACIS assembly model.

Returns:
Number of HOOPS keys associated with the given ACIS assembly model.

include <ha_bridge_asm.h>

unsigned long HA_Compute_Model_Keys ( asm_model *  model,
unsigned long  count,
long *  keys 
)

Returns an array of HOOPS keys associated with the given assembly model, with the count.



Parameters:
model Pointer to an ACIS assembly model.
count Maximum number of keys that should be returned, see HA_Compute_Model_Key_Count.
keys Array of associated HOOPS keys. Returned to user.

Returns:
Actual number of keys returned to user in keys array. Always less than or equal to count.

include <ha_bridge_asm.h>

asm_model* HA_Compute_Model_Pointer ( long  key  ) 

Returns the pointer for the ACIS assembly model associated with the specified HOOPS segment key.



Parameters:
key HOOPS key provided for computing associated ACIS assembly-model pointer.

Returns:
The requested ACIS pointer.

include <ha_bridge_asm.h>

void HA_Delete_Entity_Geometry ( ENTITY *  entity  ) 

Delete the geometric primitives associated with the given ACIS entity.



Role: Deletes the geometric primitives associated with the given ACIS entity from the HOOPS database and update the mapping between the ACIS pointer and the HOOPS keys.

Parameters:
entity Entity to be deleted from the HOOPS database.

include <ha_bridge.h>

void HA_Delete_Entity_Geometry ( ENTITY_LIST const &  entitylist  ) 

Delete the geometric primitives associated with the given ACIS entities.



Role: Deletes the geometric primitives associated with the given ACIS entities from the HOOPS database and update the mapping between the ACIS pointers and the HOOPS keys.

Parameters:
entitylist List of entities to be deleted from the HOOPS database.

include <ha_bridge.h>

void HA_Delete_Model ( asm_model *  model  ) 

Delete the HOOPS segments associated with the given ACIS assembly model.



Role: Deletes the segments associated with the given ACIS assembly model from the HOOPS database and updates the mapping between the ACIS pointers and the HOOPS keys.

Parameters:
model Model whose segments are to be deleted from the HOOPS database.

include <ha_bridge_asm.h>

void HA_Delete_Model_Geometry ( asm_model *  model  ) 

Delete the HOOPS segments containing the geometry data associated with the given ACIS assembly model.



Role: Deletes the geometry segments associated with the given ACIS assembly model from the HOOPS database and updates the mapping between the ACIS pointers and the HOOPS keys. Segments bearing component information (e.g., model-reference transforms or component color overrides) are left alone.

Parameters:
model Model whose geometry segments are to be deleted from the HOOPS database.

include <ha_bridge_asm.h>

void HA_Delete_Model_Ref ( ASM_MODEL_REF *  mref  ) 

Delete the HOOPS segments associated with the given ACIS assembly model reference.



Role: Deletes the segments associated with the given ACIS assembly model reference from the HOOPS database and updates the mapping between the ACIS pointers and the HOOPS keys.

Parameters:
mref Model-ref whose segments are to be deleted from the HOOPS database.

include <ha_bridge_asm.h>

logical HA_Disassociate_Key_From_Component ( component_handle *  comp,
long  key 
)

Disassociates a key in the component map from an assembly component.



Parameters:
comp (can be NULL) Given component handle.
key Key for HOOPS segment.

Returns:
Returns true if the given key is disassociated from the component.

include <ha_bridge_asm.h>

logical HA_Disassociate_Key_From_Entity ( ENTITY *  entity,
long  key 
)

Disassociates a key in the map from an entity.



Role: This allows the removal of HOOPS geometry without removing the complete entity and the rest of its geometry from the Bridge.

Parameters:
entity (can be NULL) Given ENTITY.
key Key for HOOPS segment.

Returns:
Returns TRUE if the given key is disassociated from the entity.

include <ha_bridge.h>

logical HA_Disassociate_Key_From_Model ( asm_model *  model,
long  key 
)

Disassociates a key in the model map from an assembly model.



Parameters:
model (can be NULL) Given asm_model.
key Key for HOOPS segment.

Returns:
Returns true if the given key is disassociated from the model.

include <ha_bridge_asm.h>

bool HA_Erase_PointCloud ( SPApoint_cloud *  inputCloud  ) 

SPApoint_cloud is deprecated.

Please consider using SPAposition_cloud.

Erases a point cloud from the display.

Role: Finds and deletes the segment displaying the given point cloud, if one exists.

Parameters:
inputCloud SPApoint_cloud object to be erased

Returns:
Boolean indicating success or failure.

include <ha_bridge.h>

long HA_Get_Current_View_Segment (  ) 

Returns the current view segment.



Role: Used for HA_Get_Facet_Tolerance().

Returns:
Key for HOOPS segment.

include <ha_bridge.h>

IEntityConverter* HA_Get_Entity_Converter (  ) 

Returns the current IEntityConverter.



Returns:
The current IEntityConverter.

include <ha_bridge.h>

facet_options* HA_Get_Facet_Options (  ) 

Returns the current facet_options.



Returns:
The current facet_options.

include <ha_bridge.h>

bool HA_Get_PointCloud_Color ( SPApoint_cloud *  inputCloud,
rgb_color &  outputColor 
)

SPApoint_cloud is deprecated.

Please consider using SPAposition_cloud.

Get the rendering color for a SPApoint_cloud object

Role: Returns the stored value for the color of a point cloud.

Parameters:
inputCloud Pointer to a SPApoint_cloud to be queried.
outColor RGB color specifying the current color of the point cloud.

Returns:
TRUE if successful.

include <ha_bridge.h>

ha_rendering_options& HA_Get_Rendering_Options (  ) 

Returns the current ha_rendering_options.



Returns:
The current ha_rendering_options.

include <ha_bridge.h>

void HA_Highlight_Component_Entity ( component_entity_handle *  ce,
logical  on,
const rgb_color &  color 
)

Highlights or un-highlights a component entity with the given color.



Parameters:
ce The given component entity.
on Indicates if the component entity should be highlighted or not.
color Highlighting color to be used.

include <ha_bridge_asm.h>

void HA_Highlight_Entity ( ENTITY *  e,
logical  on,
const rgb_color &  color 
)

Highlights or un-highlights an ENTITY with an rgb_color.



Parameters:
e Given ENTITY.
on Indicates if the ENTITY should be highlighted or not.
color Highlighting color to be used.

include <ha_bridge.h>

long HA_Highlight_PointCloud ( SPApoint_cloud *  inputCloud,
const rgb_color &  inColor,
logical  turnOn 
)

SPApoint_cloud is deprecated.

Please consider using SPAposition_cloud.

Turn highlighting for a point cloud on or off.

Role: Generates a temporary segment and renders highlighted points in it, or deletes the temporary segment if highlighting is being disabled.

Parameters:
inputCloud SPApoint_cloud object to be highlighted
inColor Highlighting color.
turnOn Logical specifying TRUE if highlighting is being turned on, FALSE if not.

Returns:
Key for HOOPS segment.

include <ha_bridge.h>

void HA_Init ( const char *  options  ) 

Deprecated:
R10

This API has been deprecated in R10.

Role: Please implement the initialisation functions in the sequence described below:

initialize_base
The first initialization function is to initialize the base component. This initializes the ACIS memory manager.

api_start_modeller
After calling initialize_base, start the modeler by explicitly calling api_start_modeller.

ACIS component initialization
Each ACIS component used in a user application must be initialized before use. For example, if a user application performs booleans, then a call to api_initialize_boolean should be made explicitly. These component initialization functions should be called after api_start_modeller.

api_initialize_hoops_acis_bridge
The api_initialize_hoops_acis_bridge function has been added to initialize the bridge. This function should be called after api_start_modeller and component initialization.

Parameters:
options options.

include <ha_bridge.h>

long HA_KCreate_Segment ( ENTITY *  entity,
const char *  pattern = 0 
)

Returns the value from HC_KOpen_Segment(HA_Build_Segment_String(entity,pattern)).



Role: Calls HA_Build_Segment_String and then HC_KOpen_Segment/HC_KClose_Segment.

Parameters:
entity Given ENTITY.
pattern Segment pattern string.

Returns:
Returns HC_KOpen_Segment.

include <ha_bridge.h>

long HA_KINDEXED_MESH_to_HOOPS ( INDEXED_MESH *  mesh,
FACE *  face = 0 
)

Converts an INDEXED_MESH into a HOOPS shell.



Role: A segment should already be open, where the shell should be placed.

Parameters:
mesh Given INDEXED MESH.

Returns:
Key for HOOPS segment.

include <ha_bridge.h>

long HA_KOpen_Segment ( ENTITY *  entity,
const char *  pattern = 0 
)

Returns the value from HC_KOpen_Segment(HA_Build_Segment_String(entity,pattern)).



Role: Calls HA_Build_Segment_String.

Parameters:
entity Given ENTITY.
pattern Segment pattern string.

Returns:
Returns HC_KOpen_Segment.

include <ha_bridge.h>

logical HA_Read_Sab_File ( const char *  fname,
ENTITY_LIST &  entitylist 
)

Parses the input ACIS file, populates the ACIS kernel with its contents, and creates the corresponding geometry in the HOOPS database using the ACIS renderer and HOOPS/ACIS Bridge.



Role: This function also fills the given entity list with the entities loaded from the file. Calling this function is equivalent to calling HA_Read_Sat_File, except that information in the file is expected to be in binary format.

Parameters:
fname Name of the ACIS File to be parsed.
entitylist List of entities read in.

Returns:
Returns TRUE when successful.

include <ha_bridge.h>

logical HA_Read_Sat_File ( const char *  fname,
ENTITY_LIST &  entitylist 
)

Parses the input ACIS file, populates the ACIS kernel with its contents, and creates the corresponding geometry in the HOOPS database using the ACIS renderer and HOOPS/ACIS Bridge.



Role: This function also fills the given entity list with the entities loaded from the file. Calling this function is equivalent to calling api_restore_entity_list and HA_Render_Entities, except that a file name is used instead of a file pointer.

Parameters:
fname Name of the ACIS File to be parsed.
entitylist List of entities read in.

Returns:
Returns TRUE when successful.

include <ha_bridge.h>

long HA_Render_Curve ( CURVE *  this_curve,
SPAparameter  start_param,
SPAparameter  end_param,
const SPAtransf *  sketch_transform 
)

Generates the tessellation of an ACIS CURVE.



Role: Stores the tessellation in the HOOPS database using the HOOPS/ACIS Bridge. The ACIS CURVE is bounded by the given parameters and transformed by the given transform.

Precondition: A segment is already open.

Parameters:
this_curve Given ACIS CURVE.
start_param Starting parameter on the CURVE.
end_param Ending parameter on the CURVE.
sketch_transform Transformation.

Returns:
Key for HOOPS segment.

include <ha_bridge.h>

void HA_Render_Entities ( const ENTITY_LIST &  entitylist,
const char *  pattern = 0 
)

Generate the tessellation of a set of ACIS entities.



Role: Generates the tessellation of a set of ACIS entities and stores it in the HOOPS database using the HOOPS/ACIS Bridge.

Note: HA_Render_Entities will use default pattern set by "segment pattern" option sent to HA_Set_Rendering_Options.

For example: 

 char buffer[1024];
 char pbuffer[POINTER_BUFFER_SIZE];
 sprintf(buffer,"segment pattern = ?Include Library/%s",ptoax(m_pPart.GetPart(), pbuffer));
 HA_Set_Rendering_Options(buffer);
Parameters:
entitylist List of entities to be rendered.
pattern Pattern.

include <ha_bridge.h>

long HA_Render_Entity ( ENTITY *  entity,
const char *  pattern = 0 
)

Generate the tessellation of an ACIS entity.



Role: Generates the tessellation of an ACIS entity and stores it in the HOOPS database using the HOOPS/ACIS Bridge.

Note: HA_Render_Entity will use default pattern set by "segment pattern" option sent to HA_Set_Rendering_Options.

For example: 

 char buffer[1024];
 char pbuffer[POINTER_BUFFER_SIZE];
 sprintf(buffer,"segment pattern = ?Include Library/%s",ptoax(m_pPart.GetPart(), pbuffer));
 HA_Set_Rendering_Options(buffer);
Parameters:
entity ACIS entity.
pattern Pattern.

Returns:
Key for HOOPS segment.

include <ha_bridge.h>

long HA_Render_Model ( asm_model *  model,
const char *  pattern = 0 
)

Generate the tessellation of an ACIS assembly model.



Role: Generates the tessellation of an ACIS assembly model and stores it in the HOOPS database using the HOOPS/ACIS Bridge.

Note: HA_Render_Model will use default pattern set by "segment pattern" option sent to HA_Set_Rendering_Options.

For example: 

 char buffer[1024];
 char pbuffer[POINTER_BUFFER_SIZE];
 sprintf(buffer,"segment pattern = ?Include Library/%s",ptoax(m_pPart.GetPart(), pbuffer));
 HA_Set_Rendering_Options(buffer);
Parameters:
asm_model pointer to an ACIS assembly model.
pattern Pattern.

Returns:
Key for HOOPS segment.

include <ha_bridge_asm.h>

long HA_Render_PointCloud ( SPApoint_cloud *  inputCloud,
const rgb_color &  color 
)

SPApoint_cloud is deprecated.

Please consider using SPAposition_cloud.

Render a point cloud to the active display.

Role: Constructs appropriate HOOPS segment then stores the points of the cloud in a shell inside the segment.

Parameters:
inputCloud SPApoint_cloud object to be rendered
color Rendering color.

Returns:
Key for HOOPS segment the point cloud was placed in.

include <ha_bridge.h>

long HA_Render_PositionCloud ( SPAposition_cloud const &  cloud  ) 

Renders a SPAposition_cloud into its own hoops segment.

The returned value is the hoops key for the cloud's segment.

include <ha_bridge.h>

logical HA_ReRender_Body_Transforms ( ENTITY_LIST &  bodies  ) 

Updates the transforms attached to the segments associated with the specified bodies.



Role: The existing transforms attached to the body segments are replaced by the ones currently attached to each BODY. Entities contained in bodies are ignored if they are not actually bodies.

Parameters:
bodies List of bodies for which an update is requested.

Returns:
TRUE if any updates are performed, FALSE otherwise.

include <ha_bridge.h>

long HA_ReRender_Component ( component_handle *  comp  ) 

HA_ReRender_Component regenerates the component-related rendering data associated with the given component and its subcomponents.



Role: The rendering data associated with an ACIS assembly model is organized in two segment trees. One contains geometric data (e.g., meshes) as well as entity-specific properties, such as colors. The other contains component-related data (e.g., the transforms associated with model references and component property overrides), and references the geometry tree as a include segment. This function updates the second of these two trees, and only affects the second if it is missing.

The rendering data in the HOOPS database is first deleted and then regenerated.

Parameters:
comp component handle associated with the component to be rerendered.

Returns:
Key for HOOPS segment. This is probably different than the component originally used.

include <ha_bridge_asm.h>

void HA_ReRender_Entities ( const ENTITY_LIST &  entitylist,
const char *  pattern = 0 
)

HA_ReRender_Entities regenerates the rendering data for the given ENTITYs.



Role: The rendering data in the HOOPS database is first deleted and then regenerated..

Note: HA_ReRender_Entities will use default pattern set by "segment pattern" option sent to HA_Set_Rendering_Options.

For example: 

 char buffer[1024];
 char pbuffer[POINTER_BUFFER_SIZE];
 sprintf(buffer,"segment pattern = ?Include Library/%s",ptoax(m_pPart.GetPart(), pbuffer));
 HA_Set_Rendering_Options(buffer);
Parameters:
entitylist List of entities to be rendered.
pattern Pattern.

include <ha_bridge.h>

long HA_ReRender_Entity ( ENTITY *  entity,
const char *  pattern = 0 
)

HA_ReRender_Entity regenerates the rendering data for the given ENTITY.



Role: The rendering data in the HOOPS database is first deleted and then regenerated.

Note: HA_ReRender_Entity will use default pattern set by "segment pattern" option sent to HA_Set_Rendering_Options.

For example: 

 char buffer[1024];
 char pbuffer[POINTER_BUFFER_SIZE];
 sprintf(buffer,"segment pattern = ?Include Library/%s",ptoax(m_pPart.GetPart(), pbuffer));
 HA_Set_Rendering_Options(buffer);
Parameters:
entity ACIS entity.
pattern Pattern.

Returns:
Key for HOOPS segment. This is probably different than the ENTITY originally used.

include <ha_bridge.h>

long HA_ReRender_Model_Components ( asm_model *  model  ) 

HA_ReRender_Model_Components regenerates the component-related rendering data for the given assembly model.



Role: The rendering data associated with an ACIS assembly model is organized in two segment trees. One contains geometric data (e.g., meshes) as well as entity-specific properties, such as colors. The other contains component-related data (e.g., the transforms associated with model references and component property overrides), and references the geometry tree as a include segment. This function updates the second of these two trees, and only affects the second if it is missing.

The rendering data in the HOOPS database is first deleted and then regenerated.

Parameters:
model ACIS assembly model.

Returns:
Key for HOOPS segment. This is probably different than the component originally used.

include <ha_bridge_asm.h>

long HA_ReRender_Model_Entity ( entity_handle *  ent_handle  ) 

HA_ReRender_Model_Entity regenerates the B-Rep rendering data for specified entity within its assembly model.



Role: The rendering data associated with an ACIS assembly model is organized in two segment trees. One contains geometric data (e.g., meshes) as well as body-specific properties, such as colors. The other contains component-related data (e.g., the transforms associated with model references and component property overrides), and references the geometry tree as a include segment. This function updates only the first of these two trees.

The rendering data in the HOOPS database is first deleted and then regenerated.

Parameters:
ent_handle entity handle associated with the entity to be rerendered.

Returns:
Key for HOOPS segment. This is probably different than the entity originally used.

include <ha_bridge_asm.h>

long HA_ReRender_Model_Geometry ( asm_model *  model  ) 

HA_ReRender_Model_Geometry regenerates the B-Rep rendering data for the given assembly model.



Role: The rendering data associated with an ACIS assembly model is organized in two segment trees. One contains geometric data (e.g., meshes) as well as body-specific properties, such as colors. The other contains component-related data (e.g., the transforms associated with model references and component property overrides), and references the geometry tree as a include segment. This function updates only the first of these two trees.

The rendering data in the HOOPS database is first deleted and then regenerated.

Parameters:
model ACIS assembly model.

Returns:
Key for HOOPS segment. This is probably different than the model originally used.

include <ha_bridge_asm.h>

void HA_ReRender_Visibility_ASM (  ) 

Update the visibility of faces, edges, etc., based upon the current rendering options.



Role: Implemented only for assembly modeling.

include <ha_bridge_asm.h>

SPApoint_cloud* HA_Select_Point_Cloud ( long  scene_key,
HA_Point  pick_point 
)

SPApoint_cloud is deprecated.

Please consider using SPAposition_cloud.

Select an entire point cloud.

Role: Determines what point cloud is closest to the selection location and returns it.

Parameters:
scene_key Key to HOOPS scene to pick in.
pick_point HA_Point giving the pick location in screen coordinates.

Returns:
Point cloud picked by the user.

include <ha_bridge.h>

SPApoint_cloud* HA_Select_Point_Cloud_Marker ( long  scene_key,
HA_Point  pick_point 
)

SPApoint_cloud is deprecated.

Please consider using SPAposition_cloud.

Select a single point within a cloud.

Role: Picks the closest point within the point cloud closest to the selection location.

Parameters:
scene_key Key to HOOPS scene to pick in.
pick_point HA_Point giving the pick location in screen coordinates.

Returns:
Point cloud containing a single point.

include <ha_bridge.h>

SPApoint_cloud* HA_Select_Point_Cloud_Markers ( long  scene_key,
HA_Point  pick_point1,
HA_Point  pick_point2 
)

SPApoint_cloud is deprecated.

Please consider using SPAposition_cloud.

Select zero or more points within a point cloud.

Role: Selects all points contained within a rectangular area, using the closest point cloud to the center of the selection area as the "parent" point cloud for the subset.

Parameters:
scene_key Key to HOOPS scene to pick in.
pick_point1 HA_Point giving the first corner of the rectangular pick area.
pick_point2 HA_Point giving the second corner of the rectanglar pick area.

Returns:
Point cloud subset specified by the rectangular area.

include <ha_bridge.h>

void HA_Set_Current_View_Segment ( long   ) 

Set the current view segment.



Role: Used for HA_Get_Facet_Tolerance().

Parameters:
key Key for HOOPS segment.

include <ha_bridge.h>

void HA_Set_Entity_Converter ( IEntityConverter *  ent_conv  ) 

Sets the IEntityConverter used by HA_Render_Entity/HA_Render_Entities.



Parameters:
ent_conv IEntityConverter used by HA_Render_Entity/HA_Render_Entities.

include <ha_bridge.h>

void HA_Set_Facet_Options ( facet_options *  facet_opts  ) 

Shows the list of rendering options.



Parameters:
list List of rendering options. Provides control over how ACIS objects are faceted during rendering.

facet_opts facet_options class containing desired settings.

include <ha_bridge.h>

bool HA_Set_PointCloud_Color ( SPApoint_cloud *  inputCloud,
rgb_color  inColor 
)

SPApoint_cloud is deprecated.

Please consider using SPAposition_cloud.

Set the rendering color for a SPApoint_cloud object

Role: Changes the stored value for the color of a point cloud.

Note: HA_Set_PointCloud_Color will only take effect after the point cloud is redrawn.

Parameters:
inputCloud Pointer to a SPApoint_cloud to be modified.
inColor RGB color specifying the new color of the point cloud.

Returns:
TRUE if successful.

include <ha_bridge.h>

void HA_Set_Rendering_Options ( const ha_rendering_options &  rendering_options  ) 

Provides control over how ACIS objects are rendered to HOOPS objects via the HOOPS/ACIS Mesh Manager.



Parameters:
rendering_options ha_rendering_options class containing desired settings.

include <ha_bridge.h>

void HA_Set_Rendering_Options ( const char *  rendering_options  ) 

Provides control over how ACIS objects are rendered to HOOPS objects via the HOOPS/ACIS Mesh Manager.



Parameters:
rendering_options A quoted string or a string variable containing a list of the desired settings.

include <ha_bridge.h>

logical HA_Show_Entity_Highlight ( ENTITY *  e  ) 

Determines whether an ENTITY is highlighted.



Parameters:
e Given ENTITY.

Returns:
Indicates if the ENTITY is highlighted or not.

include <ha_bridge.h>

void HA_Show_One_Rendering_Option ( const char *  type,
char *  value 
)

Shows a rendering option and the value set to it.



Parameters:
type Rendering option.
value Value set to the rendering option.

include <ha_bridge.h>

void HA_Show_Rendering_Options ( char *  list  ) 

Shows the list of rendering options.



Parameters:
list List of rendering options.

include <ha_bridge.h>

logical HA_Update_Entity ( ENTITY *  entity  ) 

Updates the given entity by re-tessellating it.

The HOOPS segment hierarchy will be retained to the extent possible. The top level HC_KEY returned from HA_Render_Entity will be maintained.

Role: Regenerates the tessellation of an ACIS entity and updates the previously created HOOPS segment where the entity exists.

Note: HA_Render_Entity Should have already been used to create this Entity in the HOOPS database. Topology changes in the ENTITY between HA_Render_Entity and HA_Update_Entity can force HA_Update_Entity to make changes in the underlying HOOPS subsegments that may be generated.

Parameters:
entity ACIS entity.

Returns:
TRUE if successful, FALSE otherwise.

include <ha_bridge.h>

double HA_World_Coords_Per_Pixel (  ) 

Returns world coordinates per pixel.



Role: Uses the current view key set by HA_Set_Current_View_Segment.

Returns:
World co-ordinates per pixel.

include <ha_bridge.h>

logical HA_Write_Sab_File ( const char *  fname,
ENTITY_LIST const &  entitylist 
)

Saves all entities in the given entity list with the entities loaded from to the given file.



Role: Calling this function is equivalent to calling HA_Write_Sat_File, except that information is written in binary format.

Parameters:
fname Name of the ACIS File to be written.
entitylist List of entities to be written.

Returns:
Returns TRUE when successful.

include <ha_bridge.h>

logical HA_Write_Sat_File ( const char *  fname,
ENTITY_LIST const &  entitylist 
)

Saves all entities in the given entity list with the entities loaded from to the given file.



Role: Calling this function is equivalent to calling api_save_entity_list, except that a file name is used instead of a file pointer.

Parameters:
fname Name of the ACIS File to be written.
entitylist List of entities to be written.

Returns:
Returns TRUE when successful.

include <ha_bridge.h>

logical HA_Write_Sat_File_2 ( const char *  fname,
ENTITY_LIST const &  entitylist,
float  version 
)

Saves all entities in the given entity list with the entities loaded from to the given file.



Role: Calling this function is equivalent to calling api_save_entity_list, except that a file name is used instead of a file pointer.

Parameters:
fname Name of the ACIS File to be written.
entitylist List of entities to be written.
version ACIS version number. Use float values (e.g. 6.0, 6.3)for indicating the ACIS version number to use for archiving the file.

Returns:
Returns TRUE when successful.

include <ha_bridge.h>