Home

kernapi.hxx File Reference

#include "acis.hxx"
#include "api.hxx"
#include "bs3surf.hxx"
#include "dcl_kern.h"
#include "logical.h"
#include "pattern_enum.hxx"
#include "ptfcenum.hxx"
#include "bullsmal.hxx"

Classes

class  minimize_options
 Supplies the specific minimization actions to api_minimize_entities. More...

Typedefs

typedef logical(* is_fun )(const ENTITY *)
 A function pointer type used in various search routines.
typedef int STATE_ID
 Identifier for a STATE.
typedef int tag_id_type
 Identifier for a ENTITY.

Functions

outcome api_abort_state (HISTORY_STREAM *hs=NULL)
 Deletes the current DELTA_STATE and rolls model to the state before the current state.
outcome api_add_state (DELTA_STATE *ds, HISTORY_STREAM *hs)
 Merges a DELTA_STATE instance into a HISTORY_STREAM.
outcome api_add_to_collection (ENTITY_LIST &ent_list, SPACOLLECTION *col, AcisOptions *ao=NULL)
 Adds a list of entities to a collection.
outcome api_apply_transf (ENTITY *entity, SPAtransf const &trans, AcisOptions *ao=NULL)
 Changes the transform entity attached to a body.
outcome api_calculate_edge_tolerance (EDGE *edge, double &tol, AcisOptions *ao=NULL)
 Calculates the tolerance of an edge.
outcome api_calculate_vertex_tolerance (VERTEX *vertex, double &tol, AcisOptions *ao=NULL)
 Calculates the tolerance of a vertex.
outcome api_change_body_trans (BODY *body, TRANSFORM *new_transform, logical negate=FALSE, AcisOptions *ao=NULL)
 Substitutes the given transform for the existing transform of the BODY.
outcome api_change_state (DELTA_STATE *ds)
 Modifies the modeler state by applying a delta state.
outcome api_change_to_state (HISTORY_STREAM *hs, DELTA_STATE *ds, int &n_actual)
 Modifies the modeler state by applying zero or more DELTA_STATEs.
outcome api_check_face_loops (FACE *in_face, int ai_info[5]=NULL, AcisOptions *ao=NULL)
 Checks a face to see that it contains valid loops.
outcome api_check_histories (HISTORY_STREAM_LIST *insane_list=NULL, FILE *fptr=stdout)
 Checks all HISTORY_STREAMs for problems.
outcome api_checking (logical on_off)
 Sets the pointer argument checking for an API call to on or off.
outcome api_clear_annotations (AcisOptions *ao=NULL)
 Clears annotation entities from the currently active bulletin board.
outcome api_copy_body (BODY *body, BODY *&new_body, AcisOptions *ao=NULL)
 Creates a copy of a BODY.
outcome api_copy_entity (ENTITY *entity, ENTITY *&new_entity, AcisOptions *ao=NULL)
 Creates a copy of an ENTITY and all its associated entities.
outcome api_copy_entity_contents (ENTITY *in_ent, ENTITY *&copy, const SPAtransf &tr=*(const SPAtransf *) NULL_REF, AcisOptions *ao=NULL)
 Creates a copy of an ENTITY all its associated subentities.
outcome api_copy_entity_list (ENTITY_LIST &entity_list, ENTITY_LIST &copied_entity_list, AcisOptions *ao=NULL)
 Creates a copy of all entities in an ENTITY_LIST and all their associated entities.
outcome api_create_history (HISTORY_STREAM *&hs)
 Returns a newly created HISTORY_STREAM on the heap.
outcome api_deep_copy_entity (ENTITY *entity, ENTITY *&new_entity, logical dpcpy_skip=FALSE, AcisOptions *ao=NULL)
 Creates a deep copy of an ENTITY and all its associated entities.
outcome api_deep_copy_entity_list (ENTITY_LIST &entity_list, ENTITY_LIST &new_entity_list, logical dpcpy_skip=FALSE, AcisOptions *ao=NULL)
 Creates a deep copy of all entities in an ENTITY_LIST and all their associated entities.
outcome api_deep_down_copy_entity (ENTITY *entity, ENTITY *&new_entity, logical dpcpy_skip=FALSE, AcisOptions *ao=NULL)
 Creates a deep (complete) copy of an ENTITY and all entities below it in the topology hierarchy.
outcome api_del_entity (ENTITY *given_entity, AcisOptions *ao=NULL)
 Deletes the given ENTITY and all its associated entities.
outcome api_del_entity_list (ENTITY_LIST &given_list, AcisOptions *ao=NULL)
 Deletes the entities contained in the given ENTITY_LIST.
outcome api_delent (ENTITY *given_entity, AcisOptions *ao=NULL)
 Deletes an ENTITY and its subentities.
outcome api_delete_collection_entities (SPACOLLECTION *col, AcisOptions *ao=NULL)
 Deletes the member entities within the collection and then delete the collection itself.
outcome api_delete_ds (DELTA_STATE *ds)
 Deletes a delta state and dependent data.
outcome api_delete_history (HISTORY_STREAM *hs=NULL)
 Deletes the HISTORY_STREAM and all ENTITYs in the stream.
outcome api_distribute_state_to_streams (DELTA_STATE *pState, StreamFinder *pStreamFinder, logical clearDelta, logical hideStates)
 Distributes BULLETINs in a DELTA_STATE to one or more HISTORY_STREAM as directed by a StreamFinder.
outcome api_down_copy_entity (ENTITY *in_ent, ENTITY *&copy, AcisOptions *ao=NULL)
 Creates a copy of an ENTITY and all the entities below it in the topology hierarchy.
outcome api_ensure_empty_root_state (HISTORY_STREAM *history, DELTA_STATE *&root_state)
 If necessary, adds an empty DELTA_STATE to the beginning of the HISTORY_STREAM so that users can roll to a state with no entities.
outcome api_extract_coed_info (COEDGE *coedge, logical forward, logical outward, int num_pts, SPAposition *pts, SPAunit_vector *tans)
 Computes the given number of equidistant points in the parametric space of the underlying curve for the COEDGE.
outcome api_find_annotations (ENTITY_LIST &list_annotation, is_fun anno=is_ANNOTATION, BULLETIN_BOARD *bb=NULL, AcisOptions *ao=NULL)
 Finds all annotation entities of a given type.
outcome api_find_named_state (const char *name, HISTORY_STREAM *hs, DELTA_STATE_LIST &dslist)
 Rolls to the start of a named state.
outcome api_get_active_entities (HISTORY_STREAM const *hs, ENTITY_LIST &ents, logical unowned_only=FALSE, AcisOptions *ao=NULL)
 Finds all active ENTITY associated with a HISTORY_STREAM.
outcome api_get_active_state (DELTA_STATE *&active_ds, HISTORY_STREAM *hs=NULL)
 Returns the active DELTA_STATE in the given HISTORY_STREAM.
outcome api_get_all_user_attributes (HISTORY_STREAM const *hs, int derivation_level, int attrib_type_code, ENTITY_LIST &attribs, logical active_only=TRUE, AcisOptions *ao=NULL)
 Finds all attributes of a specified user type in a history stream.
outcome api_get_coedges (ENTITY *ent, ENTITY_LIST &coedge_list, PAT_NEXT_TYPE include_pat=PAT_CAN_CREATE, AcisOptions *ao=NULL)
 Gets all the coedges related to an entity.
outcome api_get_curve_ends (EDGE *crv, SPAposition &pt1, SPAposition &pt2, AcisOptions *ao=NULL)
 Gets the end points of an edge.
outcome api_get_default_history (HISTORY_STREAM *&default_hs)
 Returns the default HISTORY_STREAM.
outcome api_get_edges (ENTITY *ent, ENTITY_LIST &edge_list, PAT_NEXT_TYPE include_pat=PAT_CAN_CREATE, AcisOptions *ao=NULL)
 Gets all the edges related to an entity.
outcome api_get_ellipse_parameters (EDGE *ell, SPAposition &center, SPAunit_vector &normal, SPAvector &major_axis, double &radius_ratio, double &start_angle, double &end_angle, AcisOptions *ao=NULL)
 Gets the geometry data that defines a circle or an ellipse underlying an edge.
outcome api_get_entities (ENTITY *ent, ENTITY_LIST &ent_list, ENTITY_ID topology_ids, ENTITY_ID geometry_ids, PAT_NEXT_TYPE include_pat=PAT_CAN_CREATE, AcisOptions *ao=NULL)
 Gets all specified entities related to an entity.
outcome api_get_entity_from_id (tag_id_type id, ENTITY *&returned_ent, HISTORY_STREAM *hs=NULL)
 Returns the pointer to the ENTITY identified by the given id.
outcome api_get_entity_id (ENTITY *ent, tag_id_type &id)
 Returns a unique integer identifier (ID number) for a given ENTITY.
outcome api_get_faces (ENTITY *ent, ENTITY_LIST &face_list, PAT_NEXT_TYPE include_pat=PAT_CAN_CREATE, AcisOptions *ao=NULL)
 Gets all faces related to an entity.
outcome api_get_file_info (FileInfo &info)
 Gets header info from the last restored file.
outcome api_get_history_from_entity (ENTITY *ent, HISTORY_STREAM *&hs)
 Returns the HISTORY_STREAM in which the ENTITY lives.
outcome api_get_history_size (HISTORY_STREAM *hs, int &size, DELTA_STATE *start_ds=NULL)
 Gets the size of the DELTA_STATE in the HISTORY_STREAM.
outcome api_get_loops (ENTITY *ent, ENTITY_LIST &loop_list, PAT_NEXT_TYPE include_pat=PAT_CAN_CREATE, AcisOptions *ao=NULL)
 Gets all loops related to an entity.
outcome api_get_lumps (ENTITY *ent, ENTITY_LIST &lump_list, PAT_NEXT_TYPE include_pat=PAT_CAN_CREATE, AcisOptions *ao=NULL)
 Gets all lumps related to an entity.
outcome api_get_modified_faces (DELTA_STATE *ds, ENTITY_LIST &deleted_faces, ENTITY_LIST &created_faces, ENTITY_LIST &modified_faces, AcisOptions *ao=NULL)
 Finds faces that have been deleted, created, or modified since a particular DELTA_STATE.
outcome api_get_owner (ENTITY *ent, ENTITY *&owner, AcisOptions *ao=NULL)
 Gets the top level owner of an ENTITY.
outcome api_get_save_version (int &major_version, int &minor_version)
 Gets the current save file format version.
outcome api_get_shells (ENTITY *ent, ENTITY_LIST &shell_list, PAT_NEXT_TYPE include_pat=PAT_CAN_CREATE, AcisOptions *ao=NULL)
 Gets all shells related to an entity.
outcome api_get_state_from_id (STATE_ID id, DELTA_STATE *&returned_ds, HISTORY_STREAM *hs=NULL)
 Returns a DELTA_STATE identified by the given id.
outcome api_get_state_id (DELTA_STATE *ds, STATE_ID &id)
 Returns a unique integer identifier, in a particular HISTORY_STREAM, for a given DELTA_STATE.
outcome api_get_stream_logging (stream_logging &sl, HISTORY_STREAM *hs=NULL)
 Returns the HISTORY_STREAM specific API logging setting.
outcome api_get_tcoedges (ENTITY *ent, ENTITY_LIST &tcoedge_list, PAT_NEXT_TYPE include_pat=PAT_CAN_CREATE, AcisOptions *ao=NULL)
 Gets all the tcoedges related to an entity.
outcome api_get_tedges (ENTITY *ent, ENTITY_LIST &tedge_list, PAT_NEXT_TYPE include_pat=PAT_CAN_CREATE, AcisOptions *ao=NULL)
 Gets all the tedges related to an entity.
outcome api_get_tvertices (ENTITY *ent, ENTITY_LIST &tvertex_list, PAT_NEXT_TYPE include_pat=PAT_CAN_CREATE, AcisOptions *ao=NULL)
 Gets all TVERTEXes related to an entity.
outcome api_get_version_tag (int &tag)
 Gets the version tag from the current AcisVersion.
outcome api_get_version_tag (int major, int minor, int point, int &tag)
 Gets the version tag from the individual point information.
outcome api_get_version_tag (AcisVersion *av, int &tag)
 Gets the version tag from an AcisVersion.
outcome api_get_vertices (ENTITY *ent, ENTITY_LIST &vertex_list, PAT_NEXT_TYPE include_pat=PAT_CAN_CREATE, AcisOptions *ao=NULL)
 Gets all vertices related to an entity.
outcome api_get_wires (ENTITY *ent, ENTITY_LIST &out_list, PAT_NEXT_TYPE include_pat=PAT_CAN_CREATE, AcisOptions *ao=NULL)
 Gets all the wires related to an entity.
outcome api_hook_annotations (is_fun anno=is_ANNOTATION, BULLETIN_BOARD *bb=NULL, AcisOptions *ao=NULL)
 Traverses the active list of annotations and adds ATTRIB_ANNOTATIONs to hook them to the annotated entities.
outcome api_initialize_kernel ()
 Initializes the kernel library.
outcome api_integrate_law (law *input_law, double start, double end, double &answer, double tolerance=1E-12, int min_level=2, int *used_level=NULL)
 Integrates a law over a given domain to a given tolerance.
outcome api_integrate_law_wrt (law *input_law, double start, double end, int wrt, double *along, double &answer, double tolerance=1E-12, int min_level=2, int *used_level=NULL)
 Integrates a law over a given domain to a given tolerance, with respect to a given variable.
outcome api_integrate_law_wrt_and_splits (law *input_law, double start, double end, int wrt, double *along, double &answer, int number_of_splits=0, double *splits=NULL, double tolerance=1E-12, int min_level=2, int *used_level=NULL)
 Integrates a law over a given domain to a given tolerance, with respect to a given variable and an array of points used to split the domain.
outcome api_law_to_entity (law *input_law, ENTITY *&out_ent, AcisOptions *ao=NULL)
 Converts a law mathematic function into an entity for the purposes of saving to and restoring from a SAT file.
outcome api_load_state (FILE *file_ptr, AcisOptions *ao=NULL)
 Loads the state of global variables from a given text file.
outcome api_logging (logical on_off)
 Sets logging of entity modifications on or off for roll back purposes.
outcome api_loop_type (LOOP *in_loop, loop_type &type, int info[2]=NULL)
 Determines the loop_type of a given loop.
outcome api_make_cubic (double aval, double bval, double faval, double fbval, double ffaval, double ffbval, law *&answer)
 Creates a cubic law given {a,b,f(a),f(b),f'(a),f'(b)}.
outcome api_make_face_from_surface (surface *from_surface, FACE *&face_from_surface, AcisOptions *ao=NULL)
 Create a FACE that spans an entire surface.
outcome api_make_linear (double aval, double bval, double faval, double fbval, law *&answer)
 Creates a linear law given {a,b,f(a),f(b)}.
outcome api_make_polynomial_law (double *coeff, int degree, law *&answer)
 Creates a polynomial law.
outcome api_make_quintic (double aval, double bval, double faval, double fbval, double ffaval, double ffbval, double fffaval, double fffbval, law *&answer)
 Creates a quintic law given {a,b,f(a),f(b),f'(a),f'(b) f''(a) f''(b)}.
outcome api_make_rails (ENTITY *path, law **&rails, int &number_of_rails, law **axis=NULL, FACE **faces=NULL, law **user_rails=NULL, law *twist_law=NULL, AcisOptions *ao=NULL, SPAunit_vector const &in_rigid_tangent=*(const class SPAunit_vector *) NULL_REF)
 Creates the default rail laws for sweeping along a wire.
outcome api_make_root_state (DELTA_STATE *ds)
 Sets the root DELTA_STATE.
outcome api_make_VBL_output_surfaces (const surface *vbl_sf, double &interior_fit, double &boundary_fit, bs3_surface *&bs3_array, int &n, logical approx_error=TRUE)
 Splits the approximating surface for a VBL_SURF into n four-sided bs3_surface patches.
outcome api_make_version_object (AcisVersion *&av)
 Makes an current AcisVersion object.
outcome api_make_version_object (AcisVersion *&av, int major, int minor, int point)
 Makes an AcisVersion object from individual point integers.
outcome api_make_version_object (AcisVersion *&av, int tag)
 Makes an AcisVersion object from a version tag integer.
outcome api_merge_states (DELTA_STATE *ds1=NULL, DELTA_STATE *ds2=NULL, HISTORY_STREAM *hs=NULL, logical prune_partners=FALSE, logical keep_both=FALSE)
 Modifies a history stream by merging a range of delta states.
outcome api_minimize_entities (ENTITY_LIST *list, minimize_options *mo=NULL, AcisOptions *ao=NULL)
 Attempts to minimize the working memory footprint of the input entities.
outcome api_name_state (const char *name, DELTA_STATE *ds)
 Gives a string name to a DELTA_STATE.
outcome api_ndifferentiate_law (law *input_law, double *where, int which_dim, double *answer, int type=0, int times=1)
 Numerically differentiates a law at a given point with respect to a given variable a given number of times.
outcome api_nmax_of_law (law *input_law, double start, double end, double *answer)
 Gets the maximum value of a given law over the given domain.
outcome api_nmin_of_law (law *input_law, double start, double end, double *answer)
 Gets the minimum value of a given law over the given domain.
outcome api_note_state (DELTA_STATE *&ds, HISTORY_STREAM *hs=NULL, logical delete_if_empty=FALSE)
 Sets a check point for roll back and returns model differences since previous call to api_note_state.
outcome api_nroots_of_law (law *input_law, double start, double end, int *size, double **answer)
 Returns all the roots of the given law over the given domain.
outcome api_nsolve_laws (law *input_law1, law *input_law2, double start, double end, int *size, double **answer)
 Determines where two given laws are equal within a given domain.
outcome api_project_curve_to_surface (const curve &in_curve, const SPAinterval &in_range, const surface &in_surface, curve **&curves_on_surface, int &num_curves, AcisOptions *ao=NULL)
 Projects a curve onto a surface.
outcome api_prune_following (HISTORY_STREAM *hs)
 Removes forward DELTA_STATE objects from a HISTORY_STREAM.
outcome api_prune_history (HISTORY_STREAM *hs, DELTA_STATE *ds=NULL)
 Removes a DELTA_STATE from a HISTORY_STREAM.
outcome api_query_state_validity (DELTA_STATE *ds, logical &change_state_possible, HISTORY_STREAM *hs=NULL)
 Returns TRUE if the given DELTA_STATE is in the HISTORY_STREAM.
outcome api_remove_from_collection (ENTITY_LIST &ent_list, SPACOLLECTION *col, AcisOptions *ao=NULL)
 Removes a list of entities from a collection.
outcome api_remove_state (DELTA_STATE *ds)
 Merges a DELTA_STATE instance into a HISTORY_STREAM.
outcome api_remove_transf (ENTITY *entity, AcisOptions *ao=NULL)
 Removes (discards) the transformation of a body.
outcome api_reset_boxes (ENTITY *ent, AcisOptions *ao=NULL)
 Removes any cached bounding boxes from the selected BODY and its subparts (or just the selected entity if it is not a BODY).
outcome api_restore_entity_list (FILE *file_ptr, logical text_mode, ENTITY_LIST &entities, AcisOptions *ao=NULL)
 Restores entities from file.
outcome api_restore_entity_list_file (FileInterface *file_ptr, ENTITY_LIST &entities, AcisOptions *ao=NULL)
 Restores entities from a custom input target.
outcome api_restore_entity_list_with_history (FILE *file_ptr, logical text_mode, ENTITY_LIST &entities, HISTORY_STREAM_LIST &hslist, DELTA_STATE_LIST &dslist, AcisOptions *ao=NULL)
 Restores an ENTITY_LIST from a file with history.
outcome api_restore_entity_list_with_history_file (FileInterface *file_ptr, ENTITY_LIST &entities, HISTORY_STREAM_LIST &hslist, DELTA_STATE_LIST &dslist, AcisOptions *ao=NULL)
 Restores an ENTITY_LIST from a file.
outcome api_restore_history (FILE *file_ptr, logical text_mode, HISTORY_STREAM_LIST &hlist, logical create_new_hs=FALSE, AcisOptions *ao=NULL)
 Restores a HISTORY_STREAM and associated entities and ENTITY ID information from a file.
outcome api_restore_history_file (FileInterface *file_ptr, HISTORY_STREAM_LIST &hlist, logical create_new_hs=FALSE, AcisOptions *ao=NULL)
 Restores a HISTORY_STREAM and associated entities and entity id information from a file.
outcome api_return_collection_ents (SPACOLLECTION *col, ENTITY_LIST &list, AcisOptions *ao=NULL)
 Gets a list of all entities in a collection.
outcome api_return_collections (ENTITY *ent, ENTITY_LIST &list, AcisOptions *ao=NULL)
 Gets a list of all collections in which an entity participates.
outcome api_roll_n_states (HISTORY_STREAM *hs, int nRequest, int &nActual)
 Modifies modeler state by applying zero or more DELTA_STATE.
outcome api_save_entity_list (FILE *file_ptr, logical text_mode, ENTITY_LIST const &entity_list_save, AcisOptions *ao=NULL)
 Writes entities to a file in text or binary format.
outcome api_save_entity_list_file (FileInterface *file_ptr, ENTITY_LIST const &entity_list_save, AcisOptions *ao=NULL)
 Writes entities to a custom output target.
outcome api_save_entity_list_with_history (FILE *file_ptr, logical text_mode, ENTITY_LIST const &entity_list, HISTORY_STREAM_LIST &hslist, DELTA_STATE_LIST &dslist, AcisOptions *ao=NULL)
 Writes an ENTITY_LIST to a file as text or in binary mode.
outcome api_save_entity_list_with_history_file (FileInterface *file_ptr, ENTITY_LIST const &entity_list, HISTORY_STREAM_LIST &hslist, DELTA_STATE_LIST &dslist, logical mainline_only=FALSE, AcisOptions *ao=NULL)
 Writes an ENTITY_LIST to file as text or in binary mode.
outcome api_save_history (FILE *file_ptr, logical text_mode, HISTORY_STREAM *hs=NULL, logical active_ents_only=FALSE, logical mainline_only=FALSE, AcisOptions *ao=NULL)
 Writes a HISTORY_STREAM and associated entities and entity ID information to a file.
outcome api_save_history_file (FileInterface *file_ptr, HISTORY_STREAM *hs=NULL, logical active_ents_only=FALSE, logical mainline_only=FALSE, AcisOptions *ao=NULL)
 Writes a HISTORY_STREAM and associated entities and entity id information to a file.
outcome api_save_state (FILE *file_ptr, AcisOptions *ao=NULL)
 Saves the current state of global variables into a text file.
outcome api_save_version (int major_version, int minor_version)
 Sets the save file format.
outcome api_set_dbl_option (char const *name, double value)
 Sets the value of the specified option to the given double.
outcome api_set_default_history (HISTORY_STREAM *hs)
 Sets the input HISTORY_STREAM to be the default the history stream.
outcome api_set_default_minimize_options (minimize_options *mo)
 Set the default minimization actions.
outcome api_set_file_info (unsigned long mask, const FileInfo &info)
 Sets required header info to be written to ACIS save files.
outcome api_set_int_option (char const *name, int value)
 Sets the value of the specified option to the given integer.
outcome api_set_str_option (char const *name, char const *value)
 Sets the value of the specified option to the given string.
outcome api_set_stream_logging (stream_logging sl, HISTORY_STREAM *hs=NULL)
 Sets the HISTORY_STREAM specific API logging behavior.
outcome api_stackmon_limit (size_t limit)
 Sets the limit in bytes of how much stack ACIS may use.
outcome api_start_modeller (int n)
 Starts the modeler.
outcome api_stop_modeller ()
 Stops the modeler.
outcome api_str_to_law (const char *str, law **answer, law_data **data=NULL, int size=0, AcisOptions *ao=NULL)
 Creates a law from a string and an optional array of law data.
outcome api_terminate_kernel ()
 Terminates the kernel library.
outcome api_test_deep_copy (ENTITY_LIST const &entity_list, double numerical_tolerance=SPAresnor, logical report_all_errors=FALSE, char *file1=NULL, char *file2=NULL, AcisOptions *ao=NULL)
 Tests the deep copy functionality for improper sharing.
outcome api_test_deep_down_copy (ENTITY_LIST const &entity_list, ENTITY_LIST &return_list, double numerical_tolerance=SPAresnor, logical report_all_errors=FALSE, char *file1=NULL, char *file2=NULL, AcisOptions *ao=NULL)
 Tests the deep down copy functionality for improper sharing.
outcome api_transform_entity (ENTITY *ent, const SPAtransf &tform, AcisOptions *ao=NULL)
 Applies a transformation to an entity.
outcome api_unhook_annotations (is_fun anno=is_ANNOTATION, BULLETIN_BOARD *bb=NULL, AcisOptions *ao=NULL)
 Traverses the active list of annotations and removes associated ATTRIB_ANNOTATIONs.
outcome api_update_tolerance (ENTITY *this_entity, logical &updated, AcisOptions *ao=NULL)
 Updates the tolerance on an ENTITY.
outcome api_wcs_create (const SPAposition &origin, const SPAposition &xpt, const SPAposition &ypt, WCS *&new_wcs, AcisOptions *ao=NULL)
 Creates a new working coordinate system.
outcome api_wcs_get_active (WCS *&active_wcs, AcisOptions *ao=NULL)
 Gets the active working coordinate system.
outcome api_wcs_set_active (WCS *new_active, AcisOptions *ao=NULL)
 Sets a specified working coordinate system to be active.
logical is_ANNOTATION (const ENTITY *ent)
 Determines if an ENTITY is an ANNOTATION.
logical is_modeler_started ()
 Returns TRUE if the modeler is already started, otherwise FALSE.
FACEmake_face_spline (surface const &this_surface, curve const &lv=*(curve const *) NULL_REF, curve const &hv=*(curve const *) NULL_REF, curve const &lu=*(curve const *) NULL_REF, curve const &hu=*(curve const *) NULL_REF, SPApar_box const &pb=*(SPApar_box const *) NULL_REF)
 Constructs a new FACE from a spline surface.

Detailed Description


Function Documentation

outcome api_calculate_edge_tolerance ( EDGE edge,
double &  tol,
AcisOptions ao = NULL 
)

Calculates the tolerance of an edge.



Role: This function calculates the tolerance of an EDGE or a TEDGE and returns a tolerance value. It does not use the tolerance value on the TEDGE.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
edge edge to test.
tol resulting tolerance.
ao ACIS options.

include <kernapi.hxx>

outcome api_calculate_vertex_tolerance ( VERTEX vertex,
double &  tol,
AcisOptions ao = NULL 
)

Calculates the tolerance of a vertex.



Role: This function calculates the tolerance of a VERTEX or a TVERTEX and returns a tolerance value. It does not use the tolerance value on the TVERTEX.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
vertex input vertex / tvertex.
tol resulting tolerance.
ao ACIS options.

include <kernapi.hxx>

outcome api_update_tolerance ( ENTITY this_entity,
logical &  updated,
AcisOptions ao = NULL 
)

Updates the tolerance on an ENTITY.



Role: This function calculates and updates the tolerant topology of the given entity and its children.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
this_entity entity with tolerance.
updated result TRUE is a tolerant entity updated.
ao ACIS options.

include <kernapi.hxx>