#include <tolerize_ent_opts.hxx>
Public Member Functions | |
| void | get_affected_entities (ENTITY_LIST &list) |
| Returns a list of affected entities. | |
| logical | get_do_tedge_repair () const |
| returns a logical indicating whether API will do TEDGE repair. | |
| logical | get_ignore_tentities () |
| returns logical which indicates whether the API ignores already tolerant edges and vertices. | |
| double | get_max_gap () |
| returns double indicating size of maximum gap fixed by tolerization. | |
| double | get_original_gap (ENTITY *ent) |
| returns the gap which was present on ent before tolerization. | |
| logical | get_report_gaps () |
| returns logical indicating whether API will record gaps so they can be reported using get_original_gap | |
| ENTITY * | remap_ptr (ENTITY *possibly_stale_ptr) |
| returns a pointer to the tolerant ENTITY in the model replacing possibly_stale_ptr; if the input pointer was not replaced by a tolerant entity, the input pointer is returned. | |
| void | set_do_tedge_repair (logical do_repair) |
| set option so that API will do TEDGE repair. | |
| void | set_ignore_tentities (logical ignore) |
| set whether API should examine edges and vertices which are already tolerant. | |
| void | set_max_gap (double mg) |
| limits the maximum gap which will be repaired by tolerizing. | |
| void | set_report_gaps (logical report_gaps) |
| set option for API to report orginal gaps | |
When an edge or vertex is replaced by a tedge or tvertex, the old pointer to the edge or vertex no longer points to anything in the model. The remap_ptr method allows the user to get the pointer to the tolerant object corresponding to the old edge or vertex.
There is an option to automatically repair tedge errors.
There is an option for the API to record gaps as it tolerizes, so that the user can look up the gaps using get_original_gap.
The output data stored in the options object is cleared each time the API is called.
| void tolerize_entity_opts::get_affected_entities | ( | ENTITY_LIST & | list | ) |
Returns a list of affected entities.
An entity is considered affected if it has been tolerized or has had its tolerance change. This method will remove any existing contents of the list. Warning: the pointers on the affected entities list are likely to be stale. Do not dereference them without using remap_ptr first.
| logical tolerize_entity_opts::get_do_tedge_repair | ( | ) | const |
returns a logical indicating whether API will do TEDGE repair.
The default value is FALSE
| logical tolerize_entity_opts::get_ignore_tentities | ( | ) |
returns logical which indicates whether the API ignores already tolerant edges and vertices.
| double tolerize_entity_opts::get_max_gap | ( | ) |
returns double indicating size of maximum gap fixed by tolerization.
-1 indicates default, which is to fix arbitrary gaps by tolerizing.
| double tolerize_entity_opts::get_original_gap | ( | ENTITY * | ent | ) |
returns the gap which was present on ent before tolerization.
If ent was not present before tolerization, or if the user has not used set_report_gap_data(TRUE) returns -1.
| logical tolerize_entity_opts::get_report_gaps | ( | ) |
returns logical indicating whether API will record gaps so they can be reported using get_original_gap
returns a pointer to the tolerant ENTITY in the model replacing possibly_stale_ptr; if the input pointer was not replaced by a tolerant entity, the input pointer is returned.
| possibly_stale_ptr | pointer to an edge or vertex present in the model before calling API_tolerize_entity. |
| void tolerize_entity_opts::set_do_tedge_repair | ( | logical | do_repair | ) |
set option so that API will do TEDGE repair.
| do_repair | logical indicating whether API does tedge repair |
| void tolerize_entity_opts::set_ignore_tentities | ( | logical | ignore | ) |
set whether API should examine edges and vertices which are already tolerant.
| ignore | if ignore==TRUE, API will not check gaps for entities which are already tolerant. Defaults to TRUE. if ignore==FALSE, API will make sure tolerance is larger than the gap of each edge or vertex. |
| void tolerize_entity_opts::set_max_gap | ( | double | mg | ) |
limits the maximum gap which will be repaired by tolerizing.
The default behavior is to tolerize arbitrarily large gaps.
| max_gap |
| void tolerize_entity_opts::set_report_gaps | ( | logical | report_gaps | ) |
set option for API to report orginal gaps
| report_gaps | report_gaps indicates whether the API will record entity gaps during tolerization for reporting. Default is FALSE because gap reporting may have a performance impact. |