Options

 

 

Technical Article
Options may be set to modify the behavior of ACIS. An option's value may be a flag (indicating an on/off state), a number (integer or real number), or a string. Options may be set in a Scheme application (such as Scheme AIDE) using the Scheme extension option:set; or in a C++ application using one of several API functions.

address_debug

Action
Sets the form of output addresses.

Name String
address_debug

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE

Description
Selects whether or not to output actual entity addresses as well as list indices. Makes output position-independent, thus comparisons are easier.

; address_debug
; Turn off entity addresses
(option:set "address_debug" #f)
;; #t

[Top]

annotations

Action
Controls whether annotation entities are created.

Name String
annotations

Scheme
Type Values Default
boolean #f,#t #f

C++
Type Values Default
logical FALSE,TRUE FALSE

Description
If this option is on (true), annotation entities are created during ACIS operations. If it is off, they are not. The annotations option has different default values for the release and the debug mode. It is on (true) by default in the debug mode. When the unhooking option is on (true), the annotation entities are not saved in the SAT file. However, unhooking does not occur until the outer most set of API_BEGIN and API_END macros. Hence the annotation entities would be saved in the SAT file, if the save is being performed within the same set of API_BEGIN and API_END macros as the annotated operations. This behavior could be overriden by explicitly turning off (false) the annotations option in debug mode.

; annotations
; Turn on annotation creation
(option:set "annotations" #t)
;; #f

[Top]

api_checking

Action
Controls whether or not arguments to APIs are checked.

Name String
api_checking

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE

Description
If this option is on, arguments to APIs are checked for validity. If it is off, they are not. This is a global option.

; api_checking
; Turn off API argument checking
(option:set "api_checking" #f)
;; #t

[Top]

auto_merge_periodic_vertices

Action
Controls whether periodic seam vertices are merged away.

Name String
auto_merge_periodic_vertices

Scheme
Type Values Default
integer -1, 0, 1 -1

C++
Type Values Default
int -1, 0, 1 -1

Description
This option controls whether seam vertices are recorded when periodic edges are split and whether these candidate vertices are merged away at the end of the operation.

Candidate vertices are those that are placed on the seam of a periodic edge to satisfy an ACIS topological requirement and have become superfluous because the edge was split at a location other than the seam.

The merges are attempted with the standard Boolean merge algorithm and are logged on the currently active bulletin board. Vertices with an attached NO_MERGE_ATTRIB are not merged. The merges occur when the current bulletin board is being closed.

The possible values are:
-1    Use the default setting of the version of ACIS.
 0    Disable automatic merging of periodic seam vertices.
 1    Enable automatic merging of periodic seam vertices.

; auto_merge_periodic_vertices
; enable merging of periodic vertices
(option:set "auto_merge_periodic_vertices" 1)
;; -1

[Top]

backup_boxes

Action
Sets backup of mesh boxes.

Name String
backup_boxes

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE

Description
Turning this off saves a lot of memory, but boxes must be recomputed as needed. Used in the tri3_msh_sur::copy_pointers function.

; backup_boxes
; Turn off mesh backup boxes
(option:set "backup_boxes" #f)
;; #t

[Top]

backup_lazy_data

Action
Determines whether ENTITY lazy data is backed-up for rollback purposes.

Name String
backup_lazy_data

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE

Description
Entity lazy data (bounding boxes, loop type classifications, tolerant modeling tolerances) is backed-up by the normal entity backup mechanism when this option is enabled. This allows for quick reinstatement of the data during roll operations, which can provide a significant performance improvement in certain circumstances. Disabling this option turns off the backup, which results in the data being cleared during roll operations and requires a recalculation of the data when needed. For more details, refer to the section "Preserving Bounding Boxes and Other Lazy Data".

; backup_lazy_data
; Turn off lazy data backup
(option:set "backup_lazy_data" #f)
;; #t

[Top]

bb_immediate_close

Action
Controls whether or not a bulletin board is closed off immediately when the call is made to the close_bulletin_board function.

Name String
bb_immediate_close

Scheme
Type Values Default
boolean #f,#t #f

C++
Type Values Default
logical FALSE,TRUE FALSE

Description
Controls whether bulletin boards are closed in close_bulletin_board or in open_bulletin_board. Historically it has been done in the open, so that is the default. Switching the option on could result in finding errors related to missing API_BEGIN/API_ENDs a bit quicker, because this causes the bulletin board to be closed immediately in the outermost API_END instead of waiting for the next API_BEGIN.

; bb_immediate_close
; Close bulletin boards immediately
(option:set "bb_immediate_close" #t)
;; #f

[Top]

binary_format

Action
Controls the format to use when writing ACIS part save files as binary.

Name String
binary_format

Scheme
Type Values Default
integer 0, 1, 2, 3, 4, 5, 6 0

C++
Type Values Default
int 0, 1, 2, 3, 4, 5, 6 0

Description
This option determines the format used when writing ACIS part save files in binary form (to .sab files). It controls whether the file is written in a 32 bit or 64 bit (word size) format and whether the file is written with big-endian or little-endian byte ordering. The word size only affects longs. Pointers are converted to (long) indices before writing. All other types are the same size on 32 and 64 bit platforms. This option does not affect the reading of binary files.

The possible values are:

      0   Use the native format for the platform
      1   Use big-endian byte ordering with native word sizes for the platform
      2   Use little-endian byte ordering with native word sizes for the platform
      3   Use big-endian byte ordering with 32-bit word sizes
      4   Use little-endian byte ordering with 32-bit word sizes
      5   Use big-endian byte ordering with 64-bit word sizes
      6   Use little-endian byte ordering with 64-bit word sizes

; binary_format
; Using little-endian order and native word size
(option:set "binary_format" 2)
;; 0

[Top]

binary_read_format

Action
Controls the format to use when reading ACIS part save files as binary.

Name String
binary_read_format

Scheme
Type Values Default
integer -1, 0, 1, 2, 3, 4, 5, 6 -1

C++
Type Values Default
int -1, 0, 1, 2, 3, 4, 5, 6 -1

Description
This option determines the format used when reading ACIS part save files in binary form (from .sab files). It controls whether the file is read in a 32 bit or 64 bit (word size) format and whether the file is read with big-endian or little-endian byte ordering. The word size only affects longs. Pointers are converted to (long) indices before being written to the .sab file. All other types are the same size on 32 and 64 bit platforms.

The possible values are:

     -1   Determine the format automatically
      0   Use the native format for the platform
      1   Use big-endian byte ordering with native word sizes for the platform
      2   Use little-endian byte ordering with native word sizes for the platform
      3   Use big-endian byte ordering with 32-bit word sizes
      4   Use little-endian byte ordering with 32-bit word sizes
      5   Use big-endian byte ordering with 64-bit word sizes
      6   Use little-endian byte ordering with 64-bit word sizes

; binary_read_format
; Using little-endian order and native word size
(option:set "binary_read_format" 2)
;; -1

[Top]

bl_envelope_surf

Action
Controls the type of blend surface used when a variable-radius blend is created.

Name String
bl_envelope_surf

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE

Description
If this option is on (true), a rolling ball envelope blend surface is created for the variable-radius blend. If it is off (false), a rolling ball snapshot blend surface is created.

; bl_envelope_surf
; Unite two blocks, then create two blends, one
; with bl_envelope_surf off, and one with it on
(define block1 (solid:block (position 0 5 0)
    (position 5 10 10)))
;; block1
(define block2 (solid:block (position 0 0 0)
    (position 10 10 5)))
;; block2
(solid:unite block1 block2)
;; #[entity 2 1]
(iso)
;; #[view 1077019000]
(zoom-all)
;; #[view 1077019000]
(ray:queue 35.8763 -51.7115 28.5678
    -0.408248 0.816497 -0.408248 1)
;; #[ray (35.8763 -51.7115 28.5678)
;; (-0.408248 0.816497 -0.408248)]
(define edge1 (pick-edge))
;; edge1
(solid:blend-edges edge1 2)
;; (#[entity 2 1])
(ray:queue 32.557 -50.0111 35.2878
    -0.408248 0.816497 -0.408248 1)
;; #[ray (32.557 -50.0111 35.2878)
;; (-0.408248 0.816497 -0.408248)]
(define edge2 (pick-edge))
;; edge2
(solid:blend-edges edge2 2)
;; (#[entity 2 1])
(define radii (abl:two-ends-rad 1 2))
;; radii ;

;;Turn option off and create a blend
(option:set "bl_envelope_surf" #f)
;; #t
(ray:queue 29.4386 -53.3763 31.6758
    -0.408248 0.816497 -0.408248 1)
;; #[ray (29.4386 -53.3763 31.6758)
;; (-0.408248 0.816497 -0.408248)]
(define edge3 (pick-edge))
;; edge3
(define edges (blend:get-smooth-edges edge3))
;; edges
(blend:var-rad-on-edge edges 0 2)
;; (#[entity 6 1] #[entity 7 1] #[entity 8 1])
(blend:network edges)
;; #[entity 2 1]
; Turn option on and create another blend
(option:set "bl_envelope_surf" #t)
;; #f
(ray:queue 29.639 -52.2681 33.6918
    -0.408248 0.816497 -0.408248 1)
;; #[ray (29.639 -52.2681 33.6918)
;; (-0.408248 0.816497 -0.408248)]
(define edge4 (pick-edge))
;; edge4
(define edges (blend:get-smooth-edges edge4))
;; edges
(blend:var-rad-on-edge edges 0 2)
;; (#[entity 9 1] #[entity 10 1] #[entity 11 1])
(blend:network edges)
;; #[entity 2 1]
; Check convexity of edges
(ray:queue 34.0659 -49.9426 33.9158
    -0.408248 0.816497 -0.408248 1)
;; #[ray (34.0659 -49.9426 33.9158)
;; (-0.408248 0.816497 -0.408248)]
(define edge5 (pick-edge))
;; edge5
(edge:convexity edge5)
;; "convex"
(ray:queue 35.9327 -50.5213 30.8918
    -0.408248 0.816497 -0.408248 1)
;; #[ray (35.9327 -50.5213 30.8918)
;; (-0.408248 0.816497 -0.408248)]
(define edge6 (pick-edge))
;; edge6
(edge:convexity edge6)
;; "convex_smooth"

[Top]

brief_comp_debug

Action
Sets how much information about a compcurv is printed.

Name String
brief_comp_debug

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE

Description
If on, a brief version of the information is printed by com_cur::debug.

; brief_comp_debug
; Turn off the brief debug option
(option:set "brief_comp_debug" #f)
;; #t

[Top]

brief_curve_debug

Action
Sets how much information about a curve is printed.

Name String
brief_curve_debug

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE

Description
If on, only a brief version of the curve information is printed by intcurve::debug.

; brief_curve_debug
; Turn off the brief debug option
(option:set "brief_curve_debug" #f)
;; #t

[Top]

brief_mesh_debug

Action
Sets how much information about a mesh is printed.

Name String
brief_mesh_debug

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE

Description
If on, only a brief version of the mesh information is printed by msh_sur::debug_data.

; brief_mesh_debug
; Turn off the brief debug option
(option:set "brief_mesh_debug" #f)
;; #t

[Top]

brief_pcurve_debug

Action
Sets how much information about a pcurve is printed.

Name String
brief_pcurve_debug

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE

Description
If on, only a brief version of the pcurve information is printed by pcurve::debug.

; brief_pcurve_debug
; Turn off the brief debug option
(option:set "brief_pcurve_debug" #f)
;; #t

[Top]

brief_surface_debug

Action
Sets how much information about a spline surface is printed.

Name String
brief_surface_debug

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE


Description
If on, only a brief version of the spline surface information is printed by spline::debug.

; brief_surface_debug
; Turn off the brief debug option
(option:set "brief_surface_debug" #f)
;; #t

[Top]

careful

Action
Controls whether extra geometry/topology checking is done.

Name String
careful

Scheme
Type Values Default
boolean #f,#t #f

C++
Type Values Default
logical FALSE,TRUE FALSE

Description
When this option is enabled (TRUE), self-intersection checking occurs during sweeping, and face-face intersection checking occurs at the end of the operation. Note that extra geometry/topology checking is done at the expense of performance.

; careful
; Turn on checking
(option:set "careful" #t)
;; #f

[Top]

check_attribute_ownership

Action
Checks whether attribute ownership is correct during restore.

Name String
check_attribute_ownership

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE

Description
If this option is on (TRUE), all attributes are checked during the restore process to assure that their owner pointers point to the entity to which they are attached. An attribute's owner pointer will be changed if it is incorrect. Incorrect owner relationships can cause delete errors when affected entities are lost.

; check_attribute_ownership
; Make sure ATTRIBUTEs actually belong to their owners
(option:set "check_attribute_ownership" #f)
;; #t

[Top]

check_ee_list_ownership

Action
Checks whether EE_LIST ownership is set correctly during restore.

Name String
check_ee_list_ownership

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE

Description
If this option is on (TRUE), the owner of each entity in an EE_LIST with its owns_entries logical set to true is checked during the restore process. The logical is set to false if an entity is found that is not owned by the EE_LIST. Incorrect ownership can cause delete errors when EE_LISTs are lost.

; check_ee_list_ownership
; Make sure EE_LISTs actually own their entries if they claim to
(option:set "check_ee_list_ownership" #f)
;; #t

[Top]

check_output

Action
Determines the level of output generated by the body checker.

Name String
check_output

Scheme
Type Values Default
boolean #f,#t #f

C++
Type Values Default
logical FALSE,TRUE FALSE

Description
Selects the level of output generated by the body checker. If this option is on, a more detailed output on the errors is generated and sent to stdout.

; check_output
; Turn on detailed output
(option:set "check_output" #t)
;; #f

[Top]

compress_bb

Action
Controls bulletin board compression.

Name String
compress_bb

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE

Description
If on, bulletin boards are to be automatically compressed. This means that each bulletin board is automatically merged with any previous bulletin boards in the same delta state. This generally results in smaller memory usage. To maintain separate bulletin boards for each API, set this option to off during initialization.

Each set of operations within an outermost API_BEGIN/API_END block produces a bulletin board containing a bulletin for each entity created, changed, or deleted within that block. All operations on any given entity within the block go into a single bulletin. Thus, the bulletin indicates only the state of the entity before and after the entire block.

A call to API api_note_state creates a delta state containing all of the bulletin boards created since the previous call to api_note_state. If an entity has been modified in several different blocks, there will be several bulletins for that entity, each on a different bulletin board.

If the compress_bb option is on, at the end of each successful block the bulletins in the bulletin board created for that block are merged with those from the previous bulletin board, so they appear as though the operations occurred in the same block. This should save memory used by extra bulletins and backup copies of modified entities. It should also save time during roll back.

; compress_bb
; Turn off bulletin board compression
(option:set "compress_bb" #f)
;; #t

[Top]

cone_param_range_v

Action
Controls whether to use a more accurate algorithm for computing cone surface parameter range.

Name String
cone_param_range_v

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE

Description
If this option is on, a more accurate, but slower algorithm is used for computing the parameter range of a cone surface.

; cone_param_range_v
; Turn off cone_param_range_v
(option:set "cone_param_range_v" #f)
;; #t

[Top]

convert_on_restore

Action
Controls whether to convert wires from the old to the new format during a restore operation.

Name String
convert_on_restore

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE
; convert_on_restore
; Do not convert
(option:set "convert_on_restore" #f)
;; #t

[Top]

delete_forward_states

Action
Controls whether to delete all forward delta states.

Name String
delete_forward_states

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE

Description
If this option is on, all forward delta states are deleted when adding a new delta state to a history stream.

; delete_forward_states
; Turn off forward state deletion
(option:set "delete_forward_states" #f)
;; #t

[Top]

duplicate_shared_transforms

Action
Controls whether shared transforms are duplicated during restore.

Name String
duplicate_shared_transforms

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE

Description
If this option is on (#t), it simply assures a one-to-one relationship between bodies and transforms during the restore process by duplicating transforms when necessary. If it is off (#f), they are not duplicated. Transforms are not meant to be shared between multiple bodies and consequently must only be owned by one body. ACIS releases prior to R12 allowed one to attach a transform to multiple bodies, which made it possible to create SAT files with this illegal, multiple transform-body ownership. This option allows these files to be restored correctly.

; duplicate_shared_transforms
; Turn off transform duplication during restore
(option:set "duplicate_shared_transforms" #f)
;; #t

[Top]

error_no_input_tag

Action
Controls whether or not an error occurs if inputs are not tagged (when annotations are activated).

Name String
error_no_input_tag

Scheme
Type Values Default
boolean #f,#t #f

C++
Type Values Default
logical FALSE,TRUE FALSE

Description
This option affects the behavior when annotations are activated (for example, using option annotations); it has no affect when annotations are not turned on (because annotations are not created). If this option is on (true), inputs must by tagged (by adding an ATTRIB_TAG or an entity derived from it) by the caller before calling the ACIS operation. If not tagged, a sys_error occurs when creating an annotation that references the input. This can be a useful debugging tool. If this option is off (false), tags are generated as needed.

; error_no_input_tag
; Turn on error if not tagged
(option:set "error_no_input_tag" #t)
;; #f

[Top]

fitol_curve_interp

Action
Sets the fit tolerance for spline curve interpolation.

Name String
fitol_curve_interp

Scheme
Type Values Default
real See Description -1.0

C++
Type Values Default
double See Description -1.0

Description
The fit tolerance is set based on the value of this option, as follows:

Option Value Fit Tolerance Used
Greater than 0.0 Option value
Equal to 0.0 SPAresfit * arc length; where arc length is the length of the path created by connecting the initial fit points with line segments
Less than 0.0 SPAresfit

If the resulting fit tolerance is less than 10*SPAresabs, then 10*SPAresabs is used.

; fitol_curve_interp
; Set fit tolerance to use arc length * SPAresfit
(option:set "fitol_curve_interp" 0.0)
;; -1

[Top]

fix_pcurves

Action
Controls whether or not pcurves are corrected when validity checks are performed.

Name String
fix_pcurves

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE

Description
This option is used whenever validity checks are performed on a pcurve. This happens whenever a CCS (curve-curve intersection on a surface) is done. The pcurve checking code checks various properties of the pcurve. If this option is on (true), the checking code will attempt to correct any properties that are not satisfied. If this option is off (false), there is no attempt to correct the pcurve.

; fix_pcurves
; Turn off pcurve fixing
(option:set "fix_pcurves" #f)
;; #t

[Top]

history_checks

Action
Controls which history checks are performed and how they are reported.

Name String
history_checks

Scheme
Type Values Default
integer See Description 0

C++
Type Values Default
int See Description hs_checks_off
Description
This option controls the thoroughness level at which history operations are checked for correctness and the way eventual errors are reported. Checks for the most common errors are performed at levels 2 and 3, whereas time-consuming checks that help discover obscure errors are performed at level 3. These checks are intended to help an application validate their use of the ACIS history functionality. They should be viewed as a debugging tool and not generally be enabled in released products. The coverage and thoroughness of the checks will continue to improve. We advise that you validate an application at level 2 before attempting level 3.

A few of the most common history errors that are found at level 2 and 3 are:


A few of the more time-consuming history errors that that are found at level 3 are:

The valid level values are defined in the enumerated type hs_checks_level:
; history_checks
; Change history check reporting
(option:set "history_checks" 2)
;; 0

[Top]

intcurve_save_approx_level

Action
Controls the level of information stored in the SAT file for intcurves.

Name String
intcurve_save_approx_level

Scheme
Type Values Default
string See Description optimal

C++
Type Values Default
char* See Description optimal

Description
This option controls the amount of data stored in the SAT file for intcurves. In particular, it controls whether the approximating geometry for a spline curve is stored in full, in summary form, or not at all. If the approximating geometry is stored in full, then the SAT file will be large, but regenerating the part from the SAT file will be relatively fast. If the approximating geometry is not stored at all, then the SAT file will be at its minimum size, but parts may take a long time to regenerate because the approximating geometry must be completely recalculated. The summary form is a compromise. The SAT files will be only slightly larger than when no approximating geometry is stored, and regeneration is nearly as fast as when the full geometry is stored.

In this discussion, regenerate means to restore the data and prepare it for use. In release 5.0, approximating geometry may not be recalculated during the restore, but it will be recalculated when it is first required. Therefore, if approximating geometry is stored in full, the actual restore will be fast, but the part may not be "ready for use" until the approximating geometry has been recalculated.

The argument to this option is a string. Possible values are:

"full" Save the complete approximating geometry.
"summary" Save a summary form of the approximating geometry.
"none" Do not save the approximating geometry.
"historical" Preserve the historical behavior; that is, save the approximating geometry if and only if this was done in pre-5.0 versions.
"optimal" Allow ACIS to decide the level at which approximating geometry is saved.

ACIS may override the setting of this option for a particular geometry type. Typically, this will be because the geometry type requires the approximating geometry as a fundamental part of its definition and cannot exist without it. For example, if this option is set to "none," exact intcurves (exact_int_cur) will still be saved in full, because they would otherwise be undefined.

The possible values for this option are defined in the enumeration save_approx_level and in the corresponding enum_entry structure save_approx_entries (and its enum_table save_approx_map), which defines the strings and maps them to the enumeration.

save_approx_full "full"
save_approx_summary "summary"
save_approx_none "none"
save_approx_historical "historical"
save_approx_optimal "optimal"
; intcurve_save_approx_level
; Set to full save
(option:set "intcurve_save_approx_level" "full")
;; "optimal"

[Top]

logging

Action
Sets whether bulletin boards and delta states are to be visible at the application level.

Name String
logging

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE

Description
If off, each bulletin board is deleted as soon as the next is opened, and application functions to get bulletin boards or delta states always return NULL.

; logging
; Turn off logging
(option:set "logging" #f)
;; #t

[Top]

new_dangling_wires

Action
Converts dangling wires to either new or old style.

Name String
new_dangling_wires

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE

Description
Used when restoring old-style save files. If off, converts backwards; if on, converts forwards.

; new_dangling_wires
; Convert backwards
(option:set "new_dangling_wires" #f)
;; #t

[Top]

new_transform_method

Action
Sets the method used for transformations.

Name String
new_transform_method

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE

Description
If on, uses the new streamlined method for performing transformations. If off, uses the old method.

; new_transform_method
; Use old method
(option:set "new_transform_method" #f)
;; #t

[Top]

print_entity_type

Action
Controls how an entity is printed in Scheme output.

Name String
print_entity_type

Scheme
Type Values Default
boolean #f,#t #f

Description
If this option is on (true), the type name of the entity (for example, face, body, etc.) gets printed in Scheme output instead of just the string "entity". If it is off, Scheme simply prints "entity".

; print_entity_type
; Create a body and print some entity information
(define b (solid:block (position 0 0 0)
    (position 1 1 1)))
;; b
b
;; #[entity 2 1]
(entity:faces b)
;; (#[entity 3 1] #[entity 4 1] #[entity 5 1]
;; #[entity 6 1] #[entity 7 1] #[entity 8 1])
;
; Turn the option on and repeat
(option:set "print_entity_type" #t)
;; #f
(define b (solid:block (position 0 0 0)
    (position 1 1 1)))
;; b
b
;; #[body 9 1]
(entity:faces b)
;; (#[face 10 1] #[face 11 1] #[face 12 1]
;; #[face 13 1] #[face 14 1] #[face 15 1])

[Top]

regen_skin_approx

Action
Controls whether to regenerate the approximating surface during retrieval of a skin surface.

Name String
regen_skin_approx

Scheme
Type Values Default
boolean #f,#t #f

C++
Type Values Default
logical FALSE,TRUE FALSE

Description
If this option is on, the approximating surface of a skin_spl_sur is regenerated. Surfaces created with older versions of ACIS may have bad approximating surfaces.

; regen_skin_approx
; Regenerate the surface
(option:set "regen_skin_approx" #t)
;; #f

[Top]

remesh

Action
Sets automatic remeshing during a Boolean.

Name String
remesh

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE

Description
Any compcurv intersections are used to break up the mesh faces on which they lie. Breaks up the triangles along a boundary curve to be compatible with the segments of that curve. Limited to straight segments. When on, this will happen automatically during a Boolean. When off, the user must remesh the body.

; remesh
; Turn off automatic remeshing
(option:set "remesh" #f)
;; #t

[Top]

restore_file

Action
Sets the name of the file to which to write entity record information generated by restore logging functionality.

Name String
restore_file

Scheme
Type Values Default
string validpathname "restore.log"

C++
Type Values Default
char* validpathname "restore.log"

Description
Setting the restore_log option to TRUE enables the logging functionality which generates log files that identify corrupt fields in entity records during restore. The name and location of these log files can be changed from the default "restore.log" by setting the restore_log option to the desired path.

; restore_file
; Change the restore log file name.
(option:set "restore_file" "C:/temp/my_restore.log")

[Top]

restore_locale

Action
Sets the localization properties (language locale) to use when restoring save files (.sat).

Name String
restore_locale

Scheme
Type Values Default
string See Description C

C++
Type Values Default
char* See Description C

Description
This provides the ability to restore .sat files that were saved using a locale other than the "C" locale. It results in a call to the C standard library function setlocale, if a restore operation is performed. The locale is reset to its original value following the restore.

The argument to this option is a string. Possible values are:

"C" Uses the standard environment for C.
"" (empty string) Uses the system's native environment.
"<other valid locale name>" Is a string specifying some other locale. Valid values are system dependent locale names.

For example, in HP-UX version 10.01, a locale name conforms to ISO standards and identifies the language (with a 2-character code), country or territory (with a 2-character code), and the codeset of that locale. Examples of valid locale names for an HP-UX (10.01) system include "ar_DZ.arabic8" (for the Arabic language in Algeria, using the arabic8 codeset) "iw_IL.hebrew8" (Hebrew, Israel, hebrew8), and "de_DE.iso88591" (German, Germany, ISO 8859/1).

; restore_locale
; On HP-UX 10.01, set locale to German, ISO codeset
(option:set "restore_locale" "de_DE.iso88591")
;; "C"

[Top]

restore_log

Action
Controls whether to generate a log file that identifies corrupt fields in entity records so that successful restores can be possible.

Name String
restore_log

Scheme
Type Values Default
logical FALSE,TRUE FALSE

Description
This provides the ability to generate a log file that identifies corrupt fields in entity records so that successful restores can be possible. Setting the restore_log option to TRUE enables the logging functionality; FALSE disables it. The output log file named "restore.log" (by default) is created in the current working directory, in overwrite mode.

[Top]

res_near_tangent

Action
Sets the tolerant modeling resolution (tolerance) for determining if an edge is considered tangent.

Name String
res_near_tangent

Scheme
Type Values Default
real 01234567890. 0.0175

C++
Type Values Default
double 01234567890. 0.0175

Description
This option is used for tolerant modeling, and is a system-wide setting for the tolerance to use in testing whether or not an edge is considered tangent (based on the angle between normals). Tolerant modeling algorithms throughout the system may use this value. This option may be used in conjunction with other options that control specific tolerant modeling functionality. For example, this option may have no effect on certain operations if tolerant modeling is not specifically enabled for that functionality (for example, blending, skinning, local operations, etc.).

The value given is specified in radians, with a logical range of 0.0 to 2pi. In practice, this will be a small number close to zero. The default setting of 0.0175 is approximately 1 degree.

; res_near_tangent
; Increase the tolerance to 2 degrees
(option:set "res_near_tangent" .035)
;; 0.0175

[Top]

ret_directory

Action
Sets the default directory for retrieving files in Scheme AIDE.

Name String
ret_directory

Description
This option only applies to Scheme AIDE. This is the default directory name for files retrieved using the retrieve command.

[Top]

save_box

Action
Sets writing the bounding boxes to the save file.

Name String
save_box

Scheme
Type Values Default
boolean #f,#t #t

Description
When on, saves the bounding boxes in the SAT file. To improve performance when performing operations on restored models, bounding boxes ( includes uv bounding boxes) are saved in the SAT file by default. However this can be avoided by setting this option to off.

; save_box
; Do not write the bounding boxes to the file
(option:set "save_box" #f)
;; #t

[Top]

save_directory

Action
Sets the default directory for saving files in Scheme AIDE.

Name String
save_directory

Description
This option only applies to the ACIS Scheme AIDE. This is the default directory name for files created using the save command.

[Top]

save_entity_count

Action
Sets writing the entity count to the save file.

Name String
save_entity_count

Scheme
Type Values Default
boolean #f,#t #f

C++
Type Values Default
logical FALSE,TRUE FALSE

Description
When on, forces the number of entities saved to be written to the file header. Thus, when on, the save procedure must reposition the file, so you may not be able to save to some targets.

; save_entity_count
; Write the entity count to the file
(option:set "save_entity_count" #t)
;; #f

[Top]

save_old_sab

Action
Sets format for binary save files.

Name String
save_old_sab

Scheme
Type Values Default
boolean #f,#t #f

C++
Type Values Default
logical FALSE,TRUE FALSE

Description
When on, saves binary files in the old format which does not support unknown entity types. Only truly useful in testing.

; save_old_sab
; Use old binary format
(option:set "save_old_sab" #t)
;; #f

[Top]

save_unknown_subtype_as_approx

Action
Sets how unknown subtypes are saved in old save file formats.

Name String
save_unknown_subtype_as_approx

Scheme
Type Values Default
boolean #f,#t #f

C++
Type Values Default
logical FALSE,TRUE FALSE

Description
When on, saves unknown spl_sur or int_cur to old versions as an exact, based on the approximate information.

; save_unknown_subtype_as_approx
; Save unknowns as approximates
(option:set "save_unknown_subtype_as_approx" #t)
;; #f

[Top]

sequence_save_files

Action
Sets sequence numbers in save files.

Name String
sequence_save_files

Scheme
Type Values Default
boolean #f,#t #f

C++
Type Values Default
logical FALSE,TRUE FALSE

Description
When on, enables the writing of sequence numbers in .sat files

; sequence_save_files
; Write sequence numbers to save file
(option:set "sequence_save_files" #t)
;; #f

[Top]

spline_save_approx_level

Action
Controls the level of information stored in the SAT file for spline surfaces.

Name String
spline_save_approx_level

Scheme
Type Values Default
string See Description "optimal"

C++
Type Values Default
char* See Description "optimal"

Description
This option controls the amount of data stored in the SAT file for spline surfaces. In particular, it controls whether the approximating geometry for a spline surface is stored in full, in summary form, or not at all. If the approximating geometry is stored in full, then the SAT file will be large, but regenerating the part from the SAT file will be relatively fast. If the approximating geometry is not stored at all, then the SAT file will be at its minimum size, but parts may take a long time to regenerate because the approximating geometry must be completely recalculated. The summary form is a compromise. The SAT files will be only slightly larger than when no approximating geometry is stored, and regeneration is nearly as fast as when the full geometry is stored.

In this discussion, regenerate means to restore the data and prepare it for use. In release 5.0, approximating geometry may not be recalculated during the restore, but it will be recalculated when it is first required. Therefore, if approximating geometry is stored in full, the actual restore will be fast, but the part may not be "ready for use" until the approximating geometry has been recalculated.

The argument to this option is a string. Possible values are:

"full" Save the complete approximating geometry.
"summary" Save a summary form of the approximating geometry.
"none" Do not save the approximating geometry.
"historical" Preserve the historical behavior; that is, save the approximating geometry if and only if this was done in pre-5.0 versions.
"optimal" Allow ACIS to decide the level at which approximating geometry is saved.

ACIS may override the setting of this option for a particular geometry type. Typically, this will be because the geometry type requires the approximating geometry as a fundamental part of its definition and cannot exist without it.

The possible values for this option are defined in the enumeration save_approx_level and in the corresponding enum_entry structure save_approx_entries (and its enum_table save_approx_map), which defines the strings and maps them to the enumeration.

save_approx_full "full"
save_approx_summary "summary"
save_approx_none "none"
save_approx_historical "historical"
save_approx_optimal "optimal"
; spline_save_approx_level
; Set to full save
(option:set "spline_save_approx_level" "full")
;; "optimal"

[Top]

split_curves

Action
Sets curve splitting in the curve::split function.

Name String
split_curves

Scheme
Type Values Default
boolean #f,#t #f

C++
Type Values Default
logical FALSE,TRUE FALSE

Description
When on, enables curve splitting in the curve::split function. If off, curve::split does nothing and returns NULL.

; split_curves
; Turn on curve splitting
(option:set "split_curves" #t)
;; #f

[Top]

string_check

Action
Sets how NULL strings are handled.

Name String
string_check

C++
Type Values Default
logical FALSE,TRUE FALSE

Description
Selects "fixup" or "collapse" option. The general fixup treats NULL strings as empty ones, making a check/fix function useful.

[Top]

sweep_selfint

Action
Sets self intersection checks while evaluating the sweep surface.

Name String
sweep_selfint

Scheme
Type Values Default
boolean #f,#t #f

C++
Type Values Default
logical FALSE,TRUE FALSE

Description
When on, enables some limited self intersection checks while evaluating the sweep surface. This is normally turned off and is turned on only during the surface construction.

; sweep_selfint
; Turn on self intersection checks
(option:set "sweep_selfint" #t)
;; #f

[Top]

test_share

Action
Sets detecting and sharing of identical objects when restoring save files.

Name String
test_share

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE

Description
When on, int_cur and spl_sur types are compared with those that have already been restored to determine if they are identical to a previously restored int_cur or spl_sur when restoring save files. This option significantly reduces the size of retrieved bodies and aids subsequent operations, but it can be expensive and can become noticeable when restoring large parts. Turning it off will speed up the restore process. However, the amount of memory required to restore a model will be larger, since sharing of geometry is not taking place. Also, evaluations of geometry during modeling operations may take longer because the test for coincidence will take place each time the objects are evaluated. This may cause the test to happen many times instead of once when the model is loaded. On is the default.

; test_share
; Turn off share testing
(option:set "test_share" #f)
;; #t

[Top]

tight_sphere_box

Action
Sets calculation of a tight bounding box for a spherical face.

Name String
tight_sphere_box

Scheme
Type Values Default
boolean #f,#t #f

C++
Type Values Default
logical FALSE,TRUE FALSE

Description
When on, enables calculation of a tight bounding box for a spherical face. See get_face_box for further details. It is recommended that users do not change the default value of this option, as ACIS has been configured to perform optimally with the default option. This option will eventually be withdrawn. It should not be changed mid-application. It should be set once at the beginning of the session.

; tight_sphere_box
; Turn on sphere bounding box
(option:set "tight_sphere_box" #t)
;; #f

[Top]

tight_torus_box

Action
Sets calculation of a tight bounding box for a toroidal face.

Name String
tight_torus_box

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE

Description
When on, enables calculation of a tight bounding box for a toroidal face. See get_face_box for further details. It is recommended that users do not change the default value of this option, as ACIS has been configured to perform optimally with the default option. This option will eventually be withdrawn. It should not be changed mid-application. It should be set once at the beginning of the session.

; tight_torus_box
; Turn off torus bounding box
(option:set "tight_torus_box" #f)
;; #t

[Top]

torus_param_range

Action
Sets whether or not a box is used to find the torus parameter range.

Name String
torus_param_range

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE

Description
When on, the box supplied to torus::param_range is used to find a reasonably small parameter range for the torus (otherwise, the entire torus range is returned).

; torus_param_range
; Turn option off
(option:set "torus_param_range" #f)
;; #t

[Top]

unhook_annotations

Action
Controls whether annotations are automatically unhooked from their entities.

Name String
unhook_annotations

Scheme
Type Values Default
boolean #f,#t #t

C++
Type Values Default
logical FALSE,TRUE TRUE

Description
If this option is on (true), annotations are automatically unhooked from their entities at the outermost API_END enclosing an operation. This is done by losing all ANNOTATION_ATTRIBs, as in API function api_unhook_annotations.

; unhook_annotations
; Turn off automatic unhook
(option:set "unhook_annotations" #f)
;; #t

[Top]

© 1989-2007 Spatial Corp., a Dassault Systèmes company. All rights reserved.