Home

Kernel Functionality

Collaboration diagram for Kernel Functionality:


Components

 API Behavior
 Topology and Geometry Queries
 Annotations
 Attributes
 Debug
 Topology
 Entity Operations
 Save and Restore
 Graph Theory
 Evaluators
 History
 Tolerant Geometry
 Laws
 Lists
 Patterns
 Visualization
 Geometry
 Declared at <curextnd.hxx>, SPAintr.
 Transformations
 Model geometric transformations.
 Working Coordinate Systems

Classes

class  APATTERN
  More...
class  ASM_ASSEMBLY
 Assembly Entity. More...
class  asm_model_kern
 Use-counted base class for asm_model. More...
class  ASM_MODEL_REF
 Assembly model reference. More...
class  blend_contact
 Information about the contact point of the blend for a blend cross section. More...
class  curve_interp
 Contains arrays to be interpolated and the information necessary for the interpolation. More...
class  entity_with_ray
 Combines an ENTITY and a pick_ray. More...
class  METHOD_ARGS
 Defines the virtual method ID that must return a unique character string to allow runtime identification of overloaded methods. More...
class  METHOD_ID
 Identifies runtime methods. More...
class  METHOD_TABLE
 Holds the table of runtime method implementation functions for a class. More...
class  pointer_map
 This class tracks reference counting of sub-objects used in making a deep copy. More...
class  rat_poly_vec
 A SPAvector of rational polynomials (or more accurately a rational polynomial of vectors, as the denominator is the same for all coordinates). More...
class  subtrans_object
 Defines a shared-subtype class that is subject to transformations. More...
class  subtype_object
 Defines the master object from which all subtype objects must be derived. More...
class  var_cross_section
 Evaluates the cross section of a blend surface. More...

Typedefs

typedef logical(* is_fun )(const ENTITY *)
 A function pointer type used in various search routines.
typedef logical(* MethodFunction )(void *pv, METHOD_ARGS const &args)
 Method function.
typedef int STATE_ID
 Identifier for a STATE.
typedef int tag_id_type
 Identifier for a ENTITY.

Enumerations

enum  bl_continuity
 Specifies the continuity with which a blend face is to meet adjacent body faces. More...
enum  bl_ed_convexity
 Specifies blending convexity of an entity. More...
enum  blend_how
 Specifies blend behavior when the rolling ball meets a smooth or non-smooth edge at the start, middle or end of the blend sequence. More...
enum  cross_section_forms
 Number specifies the type of cross section. More...
enum  sweep_bool_type
 Sweep to body boolean operation type. More...

Functions

outcome api_initialize_kernel ()
 Initializes the kernel library.
outcome api_initialize_spline ()
 Initializes the spline library.
outcome api_start_modeller (int n)
 Starts the modeler.
outcome api_stop_modeller ()
 Stops the modeler.
outcome api_terminate_kernel ()
 Terminates the kernel library.
outcome api_terminate_spline ()
 Terminates the spline library.
logical is_modeler_started ()
 Returns TRUE if the modeler is already started, otherwise FALSE.
logical is_PATTERN (const ENTITY *ent)
 

Typedef Documentation

typedef logical(* is_fun)(const ENTITY *)

A function pointer type used in various search routines.

typedef logical(* MethodFunction)(void *pv, METHOD_ARGS const &args)

Method function.

Parameters:
pv pointer.
args method args.

include <method.hxx>

typedef int STATE_ID

Identifier for a STATE.


Role: Unique identifier for a given STATE.

include <kernapi.hxx>

typedef int tag_id_type

Identifier for a ENTITY.


Role: Unique identifier for a given ENTITY.

include <kernapi.hxx>


Enumeration Type Documentation

Specifies the continuity with which a blend face is to meet adjacent body faces.



Parameters:
unset_continuity the continuity has not been specified.
position_continuous G0 continuity.
slope_continuous G1 continuity.
curvature_continuous G2 continuity.

include <bl_enum.hxx>

Specifies blending convexity of an entity.

Parameters:
bl_ed_undefined_cvxty undefined convexity.
bl_ed_convex convex blend.
bl_ed_concave concave.
bl_ed_convex_smooth smooth convex.
bl_ed_concave_smooth smooth concave.
bl_ed_smooth smooth.
bl_ed_convex_cusp convex cusp.
bl_ed_concave_cusp concave cusp.
bl_ed_cusp cusp.
bl_ed_convexity_unset unset.

include <bl_enum.hxx>

enum blend_how

Specifies blend behavior when the rolling ball meets a smooth or non-smooth edge at the start, middle or end of the blend sequence.

Parameters:
bl_how_default follow default behavior.
bl_how_cap cap or mitre regardless of edge convexity.
bl_how_roll_on roll-on regardless of edge convexity.
bl_error could be used to prevent a blend spreading too far.

include <bl_enum.hxx>

Number specifies the type of cross section.

Parameters:
XSECT_UNKNOWN cross section is unknown.
CIRCULAR cross section is circular.
THUMBWEIGHTS thumbweights.
ROT_ELLIPSE cross section is rotational ellipse.
RND_CHAMFER cross section is round chamfer.
G2_CONTINUOUS cross section is G2 continuous.
CHAMFER cross section is chamfer.

include <blnd_sec.hxx>

Sweep to body boolean operation type.

Parameters:
UNITE Creates a body which is the result of the sweep up to the location of the intersection between the sweep and the fixed body. This is the default setting.
INTERSECT Creates one body out of the fixed body and the result of the sweep up to the location of the intersection between the sweep and the fixed body.
SUBTRACT Creates one or more pieces resulting from the intersection of the fixed body with the swept body.
LIMIT Modifies the fixed body by removing material equivalent to the swept body.
KEEP_BOTH Creates a body equivalent to the limit type without deleting the original body.

include <swp_enum.hxx>


Function Documentation

outcome api_initialize_kernel (  ) 

Initializes the kernel library.



Effect: System routine

Journal: Not Available

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

include <kernapi.hxx>

outcome api_initialize_spline (  ) 

Initializes the spline library.


Effect: System routine
Journal: Not Available
Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

include <spl_api.hxx>

outcome api_start_modeller ( int  n  ) 

Starts the modeler.



Role: This API starts the modeler. This API must be called before calling any other ACIS API, function, or method, with one exception: initialize_base. If you need to configure the ACIS base component to meet your specific application needs, you must call initialize_base prior to calling api_start_modeller. (Calling initialize_base is optional.)

Care should be taken to call this API only once; this API is not use-counted and implicit calls to internal initialization routines could adversely affect applications if called more than once.

ACIS does not currently support stopping and restarting the modeler. However, it is possible for applications to dynamically unload and reload the ACIS dll's, which would subsequently require the app to call this API again.

The integer argument to this API is not used.

Effect: System routine

Journal: Not Available

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

Parameters:
n not used.

See also:
api_stop_modeller, is_modeler_started, initialize_base, terminate_base

include <kernapi.hxx>

outcome api_stop_modeller (  ) 

Stops the modeler.



Role: This API stops the modeler. After calling this API you should not call any other ACIS API, function, or method, with one exception: terminate_base. You would only need to call terminate_base after api_stop_modeller if you had previously called initialize_base prior to calling api_start_modeller.

ACIS does not currently support stopping and restarting the modeler, except when done in a DLL.

Effect: Read-only

Journal: Not Available

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

See also:
api_start_modeller, is_modeler_started, initialize_base, terminate_base

include <kernapi.hxx>

outcome api_terminate_kernel (  ) 

Terminates the kernel library.



Effect: System routine

Journal: Not Available

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

include <kernapi.hxx>

outcome api_terminate_spline (  ) 

Terminates the spline library.


Effect: System routine
Journal: Not Available
Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

include <spl_api.hxx>

logical is_modeler_started (  ) 

Returns TRUE if the modeler is already started, otherwise FALSE.



See also:
api_start_modeller, api_stop_modeller

include <kernapi.hxx>

logical is_PATTERN ( const ENTITY ent  )