SchemeExt:Spring-back-options:set-check-result-mode

From DocR23

Contents 1 Action 2 Filename 3 APIs 4 Syntax 5 Argument Types 6 Returns 7 Description 8 Arguments 9 Example

Action

Changes the "check-result-mode" setting of the specified spring back options object and returns its former setting.

Filename

scm/scmext/sb/spring_back_scm.cpp

APIs

None

Syntax

(spring-back-options:set-check-result-mode sbo mode)

Argument Types

Argument	Scheme Data Type
sbo	spring-back-options
mode	string

Returns

string

Description

The "check-result-mode" setting affects how entity:spring-back deals with illegal geometry:

• "fail" (default setting) - abort the operation and roll back
• "warn" - complete the operation and provide a list of bad faces via the spring-back-options:get-problem-faces extension
• "none" - ignore errors and complete the operation (not recommended); no problem-face list is to be provided

Arguments

• sbo is the object configuring optional spring back settings.
• mode is the string that specifies the desired check-result mode.

Example

; spring-back-options:set-check-result-mode
; Create the default options object
(define sbo (spring-back:options))
;; sbo
; Change the "check-result-mode" option to "warn" and return the old value
(spring-back-options:set-check-result-mode sbo "warn")
;; "fail"