chapter 24. functions ca thru lz - university of arizona

58
Kernel R10 Chapter 24. Functions Ca thru Lz Topic: Ignore check_outcome Function: Debugging Action: Check an outcome from an API and signal an exception if it is not OK. Prototype: void check_outcome ( const outcome& result // the outcome to check ); Includes: #include ”kernel/acis.hxx” #include ”kernel/geomhusk/ckoutcom.hxx” #include ”kernel/kernapi/api/api.hxx” Description: Checks the outcome and calls sys_error if it is not OK. This routine should be called after all routines that return an outcome and after each API_END. If the outcome is not checked, exception conditions will not propagate up the stack and get reported to the user. Errors: None Limitations: None Library: kernel Filename: kern/kernel/geomhusk/ckoutcom.hxx Effect: System routine clear_debug_lists Function: Debugging Action: Clears the DEBUG_LISTs.

Upload: others

Post on 19-Mar-2022

1 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Chapter 24.Functions Ca thru Lz

Topic: Ignore

check_outcomeFunction: Debugging

Action: Check an outcome from an API and signal an exception if it is not OK.

Prototype: void check_outcome (const outcome& result // the outcome to check);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/ckoutcom.hxx”#include ”kernel/kernapi/api/api.hxx”

Description: Checks the outcome and calls sys_error if it is not OK. This routineshould be called after all routines that return an outcome and after eachAPI_END. If the outcome is not checked, exception conditions will notpropagate up the stack and get reported to the user.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/ckoutcom.hxx

Effect: System routine

clear_debug_listsFunction: Debugging

Action: Clears the DEBUG_LISTs.

Page 2: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Prototype: void clear_debug_lists ();

Includes: #include ”kernel/acis.hxx”#include ”kernel/kerndata/data/debug.hxx”

Description: Refer to action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/data/debug.hxx

Effect: System routine

closest_pointsFunction: Model Geometry

Action: Determines where two lines, defined by positions and directions, areclosest.

Prototype: logical closest_points (const SPAposition& p1, // root position on first

// lineconst SPAunit_vector& v1,// direction of first

// lineconst SPAposition& p2, // root position on

// second lineconst SPAunit_vector& v2,// direction on second

// linedouble& t1, // closest first line

// parameter returnedSPAposition& pt1, // position on first line

// returneddouble& t2, // closest second line

// parameter returnedSPAposition& pt2 // position on second

// line returned);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/geom_utl.hxx”#include ”baseutil/logical.h”#include ”baseutil/vector/position.hxx”#include ”baseutil/vector/unitvec.hxx”

Page 3: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Description: This function returns TRUE if the lines intersect, and it finds theintersection. For parallel lines, this function returns the root position onthe first line and its projection on the second line.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/geom_utl.hxx

Effect: Read–only

compute_axes_from_zFunction: Work Coordinate Systems

Action: Determines two orthogonal vectors to define a coordinate system, given aSPAunit_vector.

Prototype: void compute_axes_from_z (const SPAunit_vector& z_axis,// given vectorSPAunit_vector& x_axis, // first orthogonal

// vector returnedSPAunit_vector& y_axis // second orthogonal

// vector returned);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/geom_utl.hxx”#include ”baseutil/vector/unitvec.hxx”

Description: This function uses the active WCS to find the valid x-axis and y-axis of acoordinate system if the z-axis is the only supplied information.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/geom_utl.hxx

Effect: Read–only

current_bbFunction: History and Roll

Action: Gets access to the current bulletin-board for update functions.

Page 4: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Prototype: BULLETIN_BOARD* current_bb ();

Includes: #include ”kernel/acis.hxx”#include ”kernel/kerndata/bulletin/bulletin.hxx”

Description: Refer to action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/bulletin/bulletin.hxx

Effect: System routine

debug_intFunction: Debugging

Action: Prints an integer with the given title to the output file.

Prototype: void debug_int (char const* title, // titleint val, // integer valueFILE* fp // file pointer);

Includes: #include ”kernel/acis.hxx”#include ”kernel/kerndata/data/debug.hxx”

Description: Refer to action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/data/debug.hxx

Effect: System routine

debug_leaderFunction: Debugging

Action: Prints to the output file a pointer to a static string containing a suitableblank title string for the second and subsequent lines of an item.

Page 5: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Prototype: char const* debug_leader ();

Includes: #include ”kernel/acis.hxx”#include ”kernel/kerndata/data/debug.hxx”

Description: Refer to action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/data/debug.hxx

Effect: System routine

debug_new_pointerFunction: Debugging

Action: Prints to the output file an ENTITY pointer.

Prototype: void debug_new_pointer (ENTITY const* ptr, // entity pointerFILE* fp // file pointer);

void debug_new_pointer (char const* title, // titleENTITY const* ptr, // entityFILE* fp // file pointer);

Includes: #include ”kernel/acis.hxx”#include ”kernel/kerndata/data/debug.hxx”#include ”kernel/kerndata/data/entity.hxx”

Description: Outputs an ENTITY pointer and enters it into the list. This pointer can bepreceded by a title and followed by a new line.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/data/debug.hxx

Page 6: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Effect: System routine

debug_realFunction: Debugging

Action: Prints out a real number with title and newline.

Prototype: void debug_real (char const* title, // titledouble val, // real valueFILE* fp // file pointer);

Includes: #include ”kernel/acis.hxx”#include ”kernel/kerndata/data/debug.hxx”

Description: Outputs a real number. The value can be preceded by a title and followedby a new line.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/data/debug.hxx

Effect: System routine

debug_stringFunction: Debugging

Action: Prints to the output file a string value with the given title.

Prototype: void debug_string (char const* title, // titlechar const* str, // string valueFILE* fp // file pointer);

Includes: #include ”kernel/acis.hxx”#include ”kernel/kerndata/data/debug.hxx”

Description: Refer to action.

Page 7: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/data/debug.hxx

Effect: System routine

delete_all_delta_statesFunction: History and Roll

Action: Deletes all recorded DELTA_STATEs.

Prototype: logical delete_all_delta_states (HISTORY_STREAM*& del_stream,// history streamlogical keep_stream // default stream

= FALSE // flag);

Includes: #include ”kernel/acis.hxx”#include ”kernel/kerndata/bulletin/bulletin.hxx”#include ”baseutil/logical.h”

Description: Deletes all recorded DELTA_STATEs. This method is used by theapi_stop_modeller to safely release as much memory as possible beforereleasing all free-list blocks. If keep_default is set TRUE, it will keep thedefault stream, but empty it, and also return TRUE only if everything isdeleted.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/bulletin/bulletin.hxx

Effect: System routine

dist_pt_to_lineFunction: Analyzing Models, Object Relationships

Action: Gets the distance from a point to a line, and the parameter along the lineof the closest approach.

Page 8: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Prototype: logical dist_pt_to_line (SPAposition const& pt, // position to projectSPAposition const& line_pt,// position on lineSPAvector const& line_vec,// direction of linedouble& dist, // distance returneddouble& line_prm // line parameter

// returned);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/geom_utl.hxx”#include ”baseutil/logical.h”#include ”baseutil/vector/position.hxx”#include ”baseutil/vector/vector.hxx”

Description: This function drops a perpendicular to a line that’s given by a point and avector. The vector need not be normalized. The function returns thedistance from the point to the line, and the parameter along the line.

Errors: input line_vec is zero

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/geom_utl.hxx

Effect: Read–only

extend_splineFunction: Construction Geometry

Action: Creates an extension to a given spline using the supplied distance.

Prototype: spline* extend_spline (spline const& spl, // input surfacedouble dist // distance to extend);

spline* extend_spline (spline const& spl, // input surfacedouble dist[][] // distance to extend);

spline* extend_spline (spline const& spl, // input surfaceSPApar_box const& range // change in range);

Page 9: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Includes: #include ”kernel/acis.hxx”#include ”kernel/kerngeom/surface/spldef.hxx”#include ”kernel/sg_husk/splsur/sub_spl.hxx”#include ”baseutil/vector/param.hxx”

Description: Functions to extend splines, which use this spl_sur definition.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/sg_husk/splsur/sub_spl.hxx

Effect: Changes model

find_attribFunction: Attributes

Action: Locates an ENTITY’s attribute list for an ATTRIB of a given type, subtype,etc., starting at the beginning of the list.

Prototype: ATTRIB* find_attrib (ENTITY const* owner, // owning entityint subtype // subtype

= –1,int subsubtype // subsubtype

= –1,int subsubsubtype // subsubsubtype

= –1,int subsubsubsubtype // subsubsubsubtype

= –1);

Includes: #include ”kernel/acis.hxx”#include ”kernel/kerndata/attrib/attrib.hxx”#include ”kernel/kerndata/data/entity.hxx”

Description: Searches an ENTITY’s attribute list for an ATTRIB of a given type,subtype, etc., starting at the beginning of the list. The int arguments aresuccessive subtypes of ATTRIB to be matched. Genuine identifiers arealways strictly positive. Zero means “don’t care at this level.” Negativemeans “don’t care at this or any deeper level.” All attribute type codes areguaranteed unique for any run of ACIS. If no matching ATTRIB is found,NULL is returned.

Page 10: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/attrib/attrib.hxx

Effect: Read–only

find_leaf_attribFunction: Attributes

Action: Locates an ENTITY’s attribute list for a leaf ATTRIB of a given type,starting at the beginning of the list.

Prototype: ATTRIB* find_leaf_attrib (ENTITY const* owner, // owning entityint attrib_type // type code);

Includes: #include ”kernel/acis.hxx”#include ”kernel/kerndata/attrib/attrib.hxx”#include ”kernel/kerndata/data/entity.hxx”

Description: Searches an ENTITY’s attribute list for a leaf ATTRIB of a given type,starting at the beginning of the list. All attribute type codes are guaranteedunique for any run of ACIS. If no matching ATTRIB is found, NULL isreturned.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/attrib/attrib.hxx

Effect: Read–only

get_ATTRIB_SYS_TYPEFunction: Attributes

Action: Gets the type of system attribute.

Page 11: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Prototype: int get_ATTRIB_SYS_TYPE ();

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/acistype.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

get_attrib_tag_callbacks_listFunction: Callbacks

Action: Gets the global list of WCS callbacks.

Prototype: attrib_tag_callbacks_list&get_attrib_tag_callbacks_list ();

Includes: #include ”kernel/acis.hxx”#include ”kernel/kerndata/data/att_tag.hxx”

Description: Refer to action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/data/att_tag.hxx

Effect: Read–only

get_ATTRIB_TSL_TYPEFunction: Attributes

Action: Gets the type of TSL attribute.

Prototype: int get_ATTRIB_TSL_TYPE ();

Page 12: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/acistype.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

get_bounded_curveFunction: Model Geometry

Action: Gets a bounded_curve from an EDGE.

Prototype: bounded_curve* get_bounded_curve (EDGE* edge, // edgelogical apply_transf // transformation

= TRUE);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/bnd_crv.hxx”#include ”kernel/kerndata/top/edge.hxx”#include ”baseutil/logical.h”

Description: Gets a bounded_curve from an EDGE. The bounded_curve contains acopy of the curve pointed to by the EDGE. If the EDGE belongs to aBODY, then the BODY transformation is applied, so the bounded curve isalways defined in the model coordinate system rather than in thecoordinate system of the body.

This method differs from the constructor for bounded curve because itchecks the type of the curve of the EDGE, and creates the appropriate typeof bounded curve. For example, if the EDGE points to a straight, thismethod creates a bounded line and returns it.

Errors: None

Limitations: None

Page 13: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Library: kernel

Filename: kern/kernel/geomhusk/bnd_crv.hxx

Effect: Read–only

get_curve_centerFunction: Model Geometry

Action: Gets the center of a circular or elliptical EDGE.

Prototype: logical get_curve_center (EDGE* crv, // curveSPAposition& center // returns center);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/curveq.hxx”#include ”kernel/kerndata/top/edge.hxx”#include ”baseutil/logical.h”#include ”baseutil/vector/position.hxx”

Description: Gets the center of a circular or elliptical EDGE. Returns FALSE if theedge was not circular or elliptical.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/curveq.hxx

Effect: Read–only

get_default_streamFunction: History and Roll

Action: Retrieves a default history stream, which may be necessary when initiallycreating a history of actions.

Prototype: HISTORY_STREAM* get_default_stream (logical make_if_null // make new one

= TRUE);

Page 14: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Includes: #include ”kernel/acis.hxx”#include ”kernel/kerndata/bulletin/bulletin.hxx”#include ”baseutil/logical.h”

Description: If make_if_null is set TRUE, this function will create a new history streamif one is not found.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/bulletin/bulletin.hxx

Effect: Read–only

get_edge_boxFunction: Construction Geometry

Action: Returns the bounding box used for the edge.

Prototype: SPAbox get_edge_box (EDGE* this_edge, // edge to examineSPAtransf const* t // transform to

= NULL, // apply to boxlogical tight_box // Flag to calculate

= FALSE, // tight boxSPAbox* untransformed_box// standard box

= NULL);

Includes: #include ”kernel/acis.hxx”#include ”kernel/kerndata/geometry/getbox.hxx”#include ”kernel/kerndata/top/edge.hxx”#include ”baseutil/vector/box.hxx”#include ”baseutil/vector/transf.hxx”#include ”baseutil/logical.h”

Description: If a bounding box already exists, it is returned. If there is no bounding box,it is calculated and returned. After a box is computed it is saved for laterreuse. If tight_box flag is TRUE then a tighter box is calculated. If thestandard box has not been set, it is accumulated too.

Errors: None

Page 15: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/geometry/getbox.hxx

Effect: Read–only

get_face_boxFunction: Construction Geometry

Action: Returns the bounding box used for the face.

Prototype: SPAbox get_face_box (FACE* this_face, // face to examineSPAtransf const* t // transform to apply

= NULL, // to boxlogical tight_box // Flag to calculate

= FALSE, // tight boxSPAbox* untransformed_box// standard box

= NULL);

Includes: #include ”kernel/acis.hxx”#include ”kernel/kerndata/geometry/getbox.hxx”#include ”kernel/kerndata/top/face.hxx”#include ”baseutil/vector/box.hxx”#include ”baseutil/vector/transf.hxx”#include ”baseutil/logical.h”

Description: If a bounding box already exists, it is returned. If there is no bounding box,it is calculated and returned. After a box is computed it is saved for laterreuse. If tight_box flag is TRUE then a tighter box is calculated. If thestandard box has not been set, it is accumulated too.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/geometry/getbox.hxx

Effect: Read–only

get_savres_fileFunction: SAT Save and Restore

Action: Gets the file interface object corresponding to the current SAT file.

Page 16: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Prototype: FileInterface* get_savres_file ();

Includes: #include ”kernel/acis.hxx”#include ”kernel/kernutil/fileio/fileif.hxx”#include ”kernel/kernutil/fileio/fileio.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kernutil/fileio/fileio.hxx

Effect: Read–only

get_Scm_EntityFunction: Scheme Interface, Entity

Action: Creates a C++ ENTITY from a Scheme entity.

Prototype: ENTITY* get_Scm_Entity (ScmObject e // Scheme object);

ENTITY* get_Scm_Entity (ScmObject o, // Scheme objectconst entity_filter& filt, // filter testconst char* type // type);

ENTITY* get_Scm_Entity (ScmObject o, // Scheme objectentity_test_proc test, // entity testconst char* type // type);

Includes: #include ”kernel/acis.hxx”#include ”kern_scm/ent_typ.hxx”#include ”kernel/geomhusk/efilter.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”scheme/elk/object.h”

Description: type is a character string describing type of ENTITY filter is looking for,such as “BODY”, and is used for printing error messages.

Page 17: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

This function is overloaded:

Creates an ENTITY from a Scheme entity.

Creates an ENTITY from a Scheme object given an addition constraint inthe form of an entity_filter.

Creates an ENTITY from a Scheme object given an addition constraint inthe form of an entity test procedure.

Errors: None

Limitations: None

Library: kern_scm

Filename: kern/kern_scm/ent_typ.hxx

Effect: Read–only

get_Scm_GvectorFunction: Scheme Interface, Mathematics

Action: Creates a C++ SPAvector from a Scheme gvector object.

Prototype: SPAvector get_Scm_Gvector (ScmObject sp // Scheme object);

Includes: #include ”kernel/acis.hxx”#include ”kern_scm/gvec_typ.hxx”#include ”baseutil/vector/vector.hxx”#include ”scheme/elk/object.h”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kern_scm

Filename: kern/kern_scm/gvec_typ.hxx

Effect: Read–only

get_Scm_LawFunction: Scheme Interface, Laws

Action: Creates a C++ law from a Scheme law object.

Page 18: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Prototype: law* get_Scm_Law (ScmObject r // Scheme object);

Includes: #include ”kernel/acis.hxx”#include ”kern_scm/law_typ.hxx”#include ”lawutil/law_base.hxx”#include ”scheme/elk/object.h”

Description: Refer to Action.

Errors: None

Limitations: The law created with this function should be removed when no longerneeded, to free the memory space.

Library: kern_scm

Filename: kern/kern_scm/law_typ.hxx

Effect: Read–only

get_Scm_PositionFunction: Scheme Interface, Mathematics

Action: Creates a C++ SPAposition from a Scheme position object.

Prototype: SPAposition get_Scm_Position (ScmObject sp // Scheme object);

Includes: #include ”kernel/acis.hxx”#include ”kern_scm/pos_typ.hxx”#include ”baseutil/vector/position.hxx”#include ”scheme/elk/object.h”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kern_scm

Filename: kern/kern_scm/pos_typ.hxx

Effect: Read–only

Page 19: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

get_Scm_TransformFunction: Scheme Interface, Model Geometry

Action: Creates a C++ SPAtransf from a Scheme transform object.

Prototype: SPAtransf get_Scm_Transform (ScmObject t // Scheme object);

Includes: #include ”kernel/acis.hxx”#include ”kern_scm/tran_typ.hxx”#include ”baseutil/vector/transf.hxx”#include ”scheme/elk/object.h”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kern_scm

Filename: kern/kern_scm/tran_typ.hxx

Effect: Read–only

get_wire_planeFunction: Model Geometry

Action: Gets the plane of a 3D WIRE.

Prototype: logical get_wire_plane (WIRE* this_wire, // input WIRESPAposition& centroid, // centroidSPAunit_vector& normal, // normallogical apply_transf // TRUE to apply

= TRUE // transform);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/wire_qry.hxx”#include ”kernel/kerndata/top/wire.hxx”#include ”baseutil/logical.h”#include ”baseutil/vector/position.hxx”#include ”baseutil/vector/unitvec.hxx”

Description: Refer to Action.

Page 20: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/wire_qry.hxx

Effect: Read–only

intersect_line_circleFunction: Mathematics, Construction Geometry, Analyzing Models

Action: Gets the intersections of a line with a circle.

Prototype: int intersect_line_circle (const SPAposition& line_pt, // position on lineconst SPAunit_vector& line_dir,// direction of

// lineconst SPAposition& center, // center of circleconst SPAunit_vector& normal,// circle normaldouble radius, // circle radiusSPAposition* intpts // returns

// intersections);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/geom_utl.hxx”#include ”baseutil/vector/position.hxx”#include ”baseutil/vector/unitvec.hxx”

Description: This function returns the number of intersections (0, 1, or 2).

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/geom_utl.hxx

Effect: Read–only

intersect_line_planeFunction: Mathematics, Construction Geometry, Analyzing Models

Action: Gets the intersection of a line with a plane.

Page 21: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Prototype: int intersect_line_plane (const SPAposition& line_point,// position on lineconst SPAvector& line_vector,// direction of lineconst SPAposition& plane_point,// position on

// planeconst SPAunit_vector& // plane

plane_normal, // normaldouble& line_param, // returns line

// parameterSPAposition& // returns

intersection_position // intersection);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/geom_utl.hxx”#include ”baseutil/vector/position.hxx”#include ”baseutil/vector/unitvec.hxx”#include ”baseutil/vector/vector.hxx”

Description: This function returns 1 (if there is a normal intersection), –1 (if the line isparallel to the plane but is on the plane), or 0 (the line does not intersectthe plane.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/geom_utl.hxx

Effect: Read–only

intersect_plane_planeFunction: Mathematics, Construction Geometry, Analyzing Models

Action: Gets the intersection of two planes.

Prototype: int intersect_plane_plane (const SPAposition& p1, // position on plane 1const SPAunit_vector& n1,// normal to plane 1const SPAposition& p2, // position on plane 2const SPAunit_vector& n2,// normal to plane 2SPAposition& line_pt, // returns position on

// lineSPAunit_vector& line_dir // returns line direction);

Page 22: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/geom_utl.hxx”#include ”baseutil/vector/position.hxx”#include ”baseutil/vector/unitvec.hxx”

Description: This function returns 1 (if the planes intersect) or 0 (if the planes areparallel).

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/geom_utl.hxx

Effect: Read–only

is_ANNOTATIONFunction: Feature Naming

Action: Determines if an ENTITY is an ANNOTATION.

Prototype: logical is_ANNOTATION (const ENTITY* e // entity to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/data/annotation.hxx”#include ”kernel/kerndata/data/entity.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/data/annotation.hxx

Effect: Read–only

is_APOINTFunction: Entity, Model Topology

Action: Determines if an ENTITY is an APOINT.

Prototype: logical is_APOINT (const ENTITY* ent // entity to test);

Page 23: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/data/entity.hxx”#include ”kernel/kerndata/geom/point.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/geom/point.hxx

Effect: Read–only

is_ATTRIBFunction: Attributes

Action: Determines if an ENTITY is an ATTRIBUTE.

Prototype: logical is_ATTRIB (const ENTITY* ent // entity to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/attrib/attrib.hxx”#include ”kernel/kerndata/data/entity.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_ATTRIB_ANNOTATIONFunction: Feature Naming

Action: Determines if an ENTITY is an ATTRIB_ANNOTATION.

Prototype: logical is_ATTRIB_ANNOTATION (const ENTITY* e // entity to test);

Page 24: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/data/annotation.hxx”#include ”kernel/kerndata/data/entity.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/data/annotation.hxx

Effect: Read–only

is_ATTRIB_STFunction: Attributes

Action: Determines if an ENTITY is an ATTRIB_ST.

Prototype: logical is_ATTRIB_ST (const ENTITY* ent // entity to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/geomhusk/attr_sti.hxx”#include ”kernel/kerndata/data/entity.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_ATTRIB_SYSFunction: Attributes

Action: Determines if an ENTITY is an ATTRIB_SYS.

Prototype: logical is_ATTRIB_SYS (const ENTITY* e // entity to test);

Page 25: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/attrib/at_sys.hxx”#include ”kernel/kerndata/data/entity.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/attrib/at_sys.hxx

Effect: Read–only

is_ATTRIB_TAGFunction: Feature Naming

Action: Determines if an ENTITY is an ATTRIB_TAG.

Prototype: logical is_ATTRIB_TAG (const ENTITY* e // entity to test);

Includes: #include ”kernel/acis.hxx”#include ”kernel/kerndata/data/att_tag.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”baseutil/logical.h”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/data/att_tag.hxx

Effect: Read–only

is_ATTRIB_TSLFunction: Attributes

Action: Determines if an ENTITY is an ATTRIB_TSL.

Prototype: logical is_ATTRIB_TSL (const ENTITY* e // entity to test);

Page 26: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/attrib/at_tsl.hxx”#include ”kernel/kerndata/data/entity.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/attrib/at_tsl.hxx

Effect: Read–only

is_BODYFunction: Entity, Model Topology

Action: Determines if an ENTITY is a BODY.

Prototype: logical is_BODY (const ENTITY* ent // entity);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”baseutil/logical.h”

Description: This procedure takes an ENTITY as an argument and returns TRUE if theentity is a BODY, FALSE if it is not. This procedure also checks for aNULL pointer.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_circular_edgeFunction: Entity, Model Topology

Action: Determines if an ENTITY is a circular edge.

Page 27: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Prototype: logical is_circular_edge (const ENTITY* ent // entity);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”baseutil/logical.h”

Description: An edge with no geometry pointer returns FALSE.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_closed_curveFunction: Model Topology

Action: Determines if a curve is closed.

Prototype: logical is_closed_curve (EDGE* crv // curve);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/curveq.hxx”#include ”kernel/kerndata/top/edge.hxx”#include ”baseutil/logical.h”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/curveq.hxx

Effect: Read–only

Page 28: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

is_COEDGEFunction: Entity, Model Topology

Action: Determines if an ENTITY is a COEDGE.

Prototype: logical is_COEDGE (const ENTITY* ent // entity);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”baseutil/logical.h”

Description: This procedure takes an ENTITY as an argument and returns TRUE if theentity is a COEDGE, FALSE if it is not. This procedure also checks for aNULL pointer.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_CONEFunction: Entity, Model Topology

Action: Determines if an ENTITY is a CONE.

Prototype: logical is_CONE (const ENTITY* ent // entity to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/data/entity.hxx”#include ”kernel/kerndata/geom/cone.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Page 29: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Library: kernel

Filename: kern/kernel/kerndata/geom/cone.hxx

Effect: Read–only

is_coneFunction: Entity, Model Topology

Action: Determines if a surface is a conical surface.

Prototype: logical is_cone (const surface* surf // surface to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerngeom/surface/surdef.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_conical_faceFunction: Entity, Model Topology

Action: Determines if an ENTITY is a conical face.

Prototype: logical is_conical_face (const ENTITY* ent // entity);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”baseutil/logical.h”

Page 30: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_CURVEFunction: Entity, Model Topology

Action: Determines if an ENTITY is a CURVE.

Prototype: logical is_CURVE (const ENTITY* ent // entity to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/data/entity.hxx”#include ”kernel/kerndata/geom/curve.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/geom/curve.hxx

Effect: Read–only

is_curve_edgeFunction: Entity, Model Topology

Action: Determines if an ENTITY is a curve edge.

Prototype: logical is_curve_edge (const ENTITY* ent // entity);

Page 31: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”baseutil/logical.h”

Description: An edge with no geometry pointer returns FALSE.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_cylindrical_faceFunction: Entity, Model Topology

Action: Determines if an ENTITY is a cylindrical face.

Prototype: logical is_cylindrical_face (const ENTITY* ent // entity);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”baseutil/logical.h”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_EDGEFunction: Entity, Model Topology

Action: Determines if an ENTITY is an EDGE.

Page 32: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Prototype: logical is_EDGE (const ENTITY* ent // entity to test);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”baseutil/logical.h”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_EE_LISTFunction: Entity

Action: Determines if an ENTITY is an EE_LIST.

Prototype: logical is_EE_LIST (const ENTITY* e // entity to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/data/entity.hxx”#include ”kernel/kerndata/lists/eelists.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/lists/eelists.hxx

Effect: Read–only

Page 33: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

is_ELLIPSEFunction: Entity, Model Geometry

Action: Determines if an ENTITY is an ELLIPSE.

Prototype: logical is_ELLIPSE (const ENTITY* ent // entity);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”baseutil/logical.h”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_ellipseFunction: Entity, Model Geometry

Action: Determines if a curve is an ellipse.

Prototype: logical is_ellipse (const curve* crv // curve to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerngeom/curve/curdef.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Page 34: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_elliptical_edgeFunction: Entity, Model Topology

Action: Determines if an ENTITY is an elliptical edge.

Prototype: logical is_elliptical_edge (const ENTITY* ent // entity);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”baseutil/logical.h”

Description: An EDGE with no geometry pointer returns FALSE.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_ENTITYFunction: Entity

Action: Validates the input ENTITY.

Prototype: int is_ENTITY (const ENTITY* // entity to test);

Includes: #include ”kernel/acis.hxx”#include ”kernel/kerndata/data/entity.hxx”

Description: Refer to Action.

Errors: None

Page 35: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/data/entity.hxx

Effect: Read–only

is_FACEFunction: Entity, Model Topology, Object Relationships

Action: Determines if an ENTITY is a FACE.

Prototype: logical is_FACE (const ENTITY* ent // entity);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”baseutil/logical.h”

Description: This procedure takes an ENTITY as an argument and returns TRUE if theentity is a FACE, FALSE if it is not. This procedure also checks for aNULL pointer.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_INTCURVEFunction: Entity, Model Topology

Action: Determines if an ENTITY is an INTCURVE.

Prototype: logical is_INTCURVE (const ENTITY* ent // entity to test);

Page 36: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/data/entity.hxx”#include ”kernel/kerndata/geom/intcurve.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/geom/intcurve.hxx

Effect: Read–only

is_intcurveFunction: Entity, Model Geometry

Action: Determines if a curve is an intcurve.

Prototype: logical is_intcurve (const curve* crv // curve to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerngeom/curve/curdef.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_intcurve_edgeFunction: Entity, Model Topology

Action: Determines if an ENTITY is an intcurve edge.

Page 37: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Prototype: logical is_intcurve_edge (const ENTITY* ent // entity);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”baseutil/logical.h”

Description: An edge with no geometry pointer returns FALSE.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_LAWFunction: Entity, Model Topology

Action: Determines if an ENTITY is a LAW.

Prototype: logical is_LAW (const ENTITY* ent // entity to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/geomhusk/lawent.hxx”#include ”kernel/kerndata/data/entity.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/lawent.hxx

Effect: Read–only

Page 38: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

is_linear_edgeFunction: Entity, Model Topology

Action: Determines if an ENTITY is a linear edge.

Prototype: logical is_linear_edge (const ENTITY* ent // entity);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”baseutil/logical.h”

Description: An EDGE with no geometry pointer returns FALSE.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_LOOPFunction: Entity, Model Topology

Action: Determines if an ENTITY is a LOOP.

Prototype: logical is_LOOP (const ENTITY* ent // entity);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”baseutil/logical.h”

Description: This procedure takes an ENTITY as an argument and returns TRUE if theentity is a LOOP, FALSE if it is not. This procedure also checks for aNULL pointer.

Errors: None

Limitations: None

Page 39: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_LUMPFunction: Entity, Model Topology

Action: Determines if an ENTITY is a LUMP.

Prototype: logical is_LUMP (const ENTITY* ent // entity to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/data/entity.hxx”#include ”kernel/kerndata/top/lump.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/top/lump.hxx

Effect: Read–only

is_PCURVEFunction: Entity, Model Topology

Action: Determines if an ENTITY is a PCURVE.

Prototype: logical is_PCURVE (const ENTITY* ent // entity to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/data/entity.hxx”#include ”kernel/kerndata/geom/pcurve.hxx”

Page 40: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/geom/pcurve.hxx

Effect: Read–only

is_planar_faceFunction: Entity, Model Topology

Action: Determines if an ENTITY is a planar face.

Prototype: logical is_planar_face (const ENTITY* ent // entity);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”baseutil/logical.h”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_planar_wireFunction: Model Topology

Action: Determines if a WIRE is planar.

Prototype: logical is_planar_wire (COEDGE* this_coedge, // wireSPAposition& centroid, // returns centroidSPAunit_vector& normal, // returns normallogical apply_transf // transformation to

= TRUE // apply);

Page 41: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

logical is_planar_wire (WIRE* this_wire, // wireSPAposition& centroid, // returns centroidSPAunit_vector& normal, // returns normallogical apply_transf // transformation to

= TRUE // apply);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/wire_qry.hxx”#include ”kernel/kerndata/top/wire.hxx”#include ”kernel/kerndata/top/coedge.hxx”#include ”baseutil/logical.h”#include ”baseutil/vector/position.hxx”#include ”baseutil/vector/unitvec.hxx”

Description: This API is overloaded to also accept wire as chain of coedges.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/wire_qry.hxx

Effect: Read–only

is_PLANEFunction: Entity, Model Topology

Action: Determines if an ENTITY is a PLANE.

Prototype: logical is_PLANE (const ENTITY* ent // entity to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/data/entity.hxx”#include ”kernel/kerndata/geom/plane.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Page 42: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Library: kernel

Filename: kern/kernel/kerndata/geom/plane.hxx

Effect: Read–only

is_planeFunction: Construction Geometry

Action: Determines if a surface is a planar surface.

Prototype: logical is_plane (const surface* surf // surface to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerngeom/surface/surdef.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_Scm_EntityFunction: Scheme Interface, Entity

Action: Determines if a Scheme object is an ENTITY.

Prototype: logical is_Scm_Entity (ScmObject e // Scheme object);

logical is_Scm_Entity (ScmObject o, // Scheme objectconst entity_filter& filt // filter);

Page 43: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

logical is_Scm_Entity (ScmObject o, // Scheme objectentity_test_proc test // test procedure);

Includes: #include ”kernel/acis.hxx”#include ”kern_scm/ent_typ.hxx”#include ”kernel/geomhusk/efilter.hxx”#include ”baseutil/logical.h”#include ”scheme/elk/object.h”

Description: This function is overloaded and can be used in three ways.

Determines if a Scheme object is an ENTITY.

Determine if a Scheme object is an ENTITY of a type which passes a filtertest.

Determine if a Scheme object is an ENTITY which also passes anadditional test.

Errors: None

Limitations: None

Library: kern_scm

Filename: kern/kern_scm/ent_typ.hxx

Effect: Read–only

is_Scm_EntrayFunction: Scheme Interface, Picking

Action: Determines if a Scheme object is an entray.

Prototype: logical is_Scm_Entray (ScmObject r // Scheme object);

Includes: #include ”kernel/acis.hxx”#include ”kern_scm/eray_typ.hxx”#include ”baseutil/logical.h”#include ”scheme/elk/object.h”

Description: Refer to Action.

Page 44: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Errors: None

Limitations: None

Library: kern_scm

Filename: kern/kern_scm/eray_typ.hxx

Effect: Read–only

is_SHELLFunction: Entity, Model Topology

Action: Determines if an ENTITY is a SHELL.

Prototype: logical is_SHELL (const ENTITY* ent // entity to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/data/entity.hxx”#include ”kernel/kerndata/top/shell.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/top/shell.hxx

Effect: Read–only

is_solid_bodyFunction: Entity, Model Topology

Action: Determines if an ENTITY is a solid BODY.

Prototype: logical is_solid_body (const ENTITY* ent // entity);

Page 45: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”baseutil/logical.h”

Description: A solid BODY has at least one LUMP and no WIREs. If the ENTITY is nota solid BODY or is NULL, then this function returns FALSE.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_SPHEREFunction: Entity, Model Topology

Action: Determines if an ENTITY is a SPHERE.

Prototype: logical is_SPHERE (const ENTITY* ent // entity to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/data/entity.hxx”#include ”kernel/kerndata/geom/sphere.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/geom/sphere.hxx

Effect: Read–only

is_sphereFunction: Entity, Model Topology

Action: Determines if a surface is a spherical surface.

Prototype: logical is_sphere (const surface* surf // surface to test);

Page 46: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerngeom/surface/surdef.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_spherical_faceFunction: Entity, Model Topology

Action: Determines if an ENTITY is a spherical face.

Prototype: logical is_spherical_face (const ENTITY* ent // entity);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”baseutil/logical.h”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_SPLINEFunction: Entity, Model Topology

Action: Determines if an ENTITY is a SPLINE.

Prototype: logical is_SPLINE (const ENTITY* ent // entity to test);

Page 47: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/data/entity.hxx”#include ”kernel/kerndata/geom/spline.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/geom/spline.hxx

Effect: Read–only

is_splineFunction: Entity, Model Topology

Action: Determines if a surface is a spline surface.

Prototype: logical is_spline (const surface* surf // surface to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerngeom/surface/surdef.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_spline_faceFunction: Entity, Model Topology

Action: Determines if the ENTITY is a spline face.

Page 48: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Prototype: logical is_spline_face (const ENTITY* ent // entity);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”baseutil/logical.h”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_STRAIGHTFunction: Entity, Model Geometry

Action: Determines if an ENTITY is a STRAIGHT.

Prototype: logical is_STRAIGHT (const ENTITY* ent // entity);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”baseutil/logical.h”

Description: This procedure takes an ENTITY as an argument and returns TRUE if theENTITY is a STRAIGHT, FALSE if it is not. This procedure also checksfor a NULL pointer.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Page 49: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Effect: Read–only

is_straightFunction: Entity, Model Topology

Action: Determines if a curve is a straight curve.

Prototype: logical is_straight (const curve* crv // curve to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerngeom/curve/curdef.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_SUBSHELLFunction: Entity, Model Topology

Action: Determines if an ENTITY is a SUBSHELL.

Prototype: logical is_SUBSHELL (const ENTITY* ent // entity to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/data/entity.hxx”#include ”kernel/kerndata/top/subshell.hxx”

Description: Refer to Action.

Errors: None

Page 50: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/top/subshell.hxx

Effect: Read–only

is_SURFACEFunction: Entity, Model Topology

Action: Determines if an ENTITY is a SURFACE.

Prototype: logical is_SURFACE (const ENTITY* ent // entity to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/data/entity.hxx”#include ”kernel/kerndata/geom/surface.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_TCOEDGEFunction: Entity, Model Topology

Action: Determines if an ENTITY is a TCOEDGE.

Prototype: logical is_TCOEDGE (const ENTITY* e // entity to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/data/entity.hxx”#include ”kernel/kerndata/top/tcoedge.hxx”

Page 51: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/top/tcoedge.hxx

Effect: Read–only

is_TEDGEFunction: Entity, Model Topology

Action: Determines if an ENTITY is a TEDGE.

Prototype: logical is_TEDGE (const ENTITY* e // entity to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/data/entity.hxx”#include ”kernel/kerndata/top/tedge.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/top/tedge.hxx

Effect: Read–only

is_TEXT_ANNOTATIONFunction: Feature Naming

Action: Determines if an ENTITY is a TEXT_ANNOTATION.

Prototype: logical is_TEXT_ANNOTATION (const ENTITY* e // entity to test);

Page 52: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/data/entity.hxx”#include ”kernel/kerndata/data/textannotation.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/data/textannotation.hxx

Effect: Read–only

is_TEXT_ENTFunction: Feature Naming

Action: Determines if an ENTITY is a TEXT_ENT.

Prototype: logical is_TEXT_ENT (const ENTITY* ent // entity to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/geomhusk/text.hxx”#include ”kernel/kerndata/data/entity.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/text.hxx

Effect: Read–only

is_toplevelFunction: Entity

Action: Determines if an ENTITY is top level.

Page 53: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Prototype: logical is_toplevel (const ENTITY* ent // entity);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/getowner.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”baseutil/logical.h”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/getowner.hxx

Effect: Read–only

is_toroidal_faceFunction: Entity, Model Topology

Action: Determines if the ENTITY is a toroidal face.

Prototype: logical is_toroidal_face (const ENTITY* ent // entity);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”baseutil/logical.h”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

Page 54: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

is_TORUSFunction: Entity, Model Topology

Action: Determines if an ENTITY is a TORUS.

Prototype: logical is_TORUS (const ENTITY* ent // entity to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/data/entity.hxx”#include ”kernel/kerndata/geom/torus.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/geom/torus.hxx

Effect: Read–only

is_torusFunction: Entity, Model Topology

Action: Determines if a surface is a toroidal surface.

Prototype: logical is_torus (const surface* surf // surface to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerngeom/surface/surdef.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Page 55: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_TRANSFORMFunction: Transforms

Action: Determines if an ENTITY is a TRANSFORM.

Prototype: logical is_TRANSFORM (const ENTITY* e // entity);

Includes: #include ”kernel/acis.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”kernel/kerndata/geom/transfrm.hxx”#include ”baseutil/logical.h”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/geom/transfrm.hxx

Effect: Read–only

is_TVERTEXFunction: Entity, Model Topology

Action: Determines if an ENTITY is a TVERTEX.

Prototype: logical is_TVERTEX (const ENTITY* e // entity to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/data/entity.hxx”#include ”kernel/kerndata/top/tvertex.hxx”

Description: Refer to Action.

Page 56: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/top/tvertex.hxx

Effect: Read–only

is_UNDEFCFunction: Entity, Model Topology

Action: Determines if an ENTITY is an UNDEFC.

Prototype: logical is_UNDEFC (const ENTITY* e // entity to test);

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/data/entity.hxx”#include ”kernel/kerndata/geom/undefc.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/geom/undefc.hxx

Effect: Read–only

is_VERTEXFunction: Entity, Model Topology

Action: Determines if the ENTITY is a VERTEX.

Prototype: logical is_VERTEX (const ENTITY* ent // entity);

Page 57: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”baseutil/logical.h”

Description: This procedure takes an ENTITY as an argument and returns TRUE if theENTITY is a VERTEX, FALSE if it is not. This procedure also checks fora NULL pointer.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only

is_WCSFunction: Entity, Work Coordinate Systems

Action: Determines if an ENTITY is a WCS.

Prototype: logical is_WCS (const ENTITY* ent // entity);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/wcs.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”baseutil/logical.h”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/wcs.hxx

Effect: Read–only

is_WIREFunction: Entity, Model Topology

Action: Determines if an ENTITY is a WIRE.

Prototype: logical is_WIRE (const ENTITY* ent // entity to test);

Page 58: Chapter 24. Functions Ca thru Lz - University of Arizona

Kernel R10

Includes: #include ”kernel/acis.hxx”#include ”baseutil/logical.h”#include ”kernel/kerndata/data/entity.hxx”#include ”kernel/kerndata/top/wire.hxx”

Description: Refer to Action.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/kerndata/top/wire.hxx

Effect: Read–only

is_wire_bodyFunction: Entity, Model Topology

Action: Determines if an ENTITY is a wire BODY.

Prototype: logical is_wire_body (const ENTITY* ent // entity);

Includes: #include ”kernel/acis.hxx”#include ”kernel/geomhusk/acistype.hxx”#include ”kernel/kerndata/data/entity.hxx”#include ”baseutil/logical.h”

Description: A wire BODY has no LUMPs and at least one WIRE. If the ENTITY is nota wire BODY or is NULL, then this function returns FALSE.

Errors: None

Limitations: None

Library: kernel

Filename: kern/kernel/geomhusk/acistype.hxx

Effect: Read–only