|
<NAME>
|
The
Name title identifies the option. Options may be set to modify the behavior of
ACIS.
|
|
|
Action:
|
The
Action field summarizes what the option does.
|
|
|
Name String:
|
The
Name String field indicates the string used to refer to the option in Scheme extensions or APIs. The minimum required portion of the string is shown in bold. The string may be abbreviated down to this minimum required portion when used in Scheme extensions or APIs.
|
|
|
Options may be set in a Scheme application (such as
Scheme AIDE) using the Scheme extension
option:set; or in a
C++ application using an API function.
|
|
|
Scheme:
|
The
Scheme field contains three columns for the type, valid values, and initial value of the option when used in a Scheme extension. The type is a Scheme data type, either
boolean,
integer,
string, or
real. Many options are simply flags indicating an
on or
off state. These options are
booleans, with a value of
#t indicating
on and a value of
#f indicating
off. If the option does not apply to the Scheme environment, this field contains the words "Not applicable."
|
|
|
C++:
|
The
C++ field contains three columns for the type, valid values, and initial value of the option when used in
C++. The type is
int,
double,
char*, or
logical (which is defined in
ACIS and is equivalent to an
int). Many options are simply flags indicating an
on or
off state. These options are
logicals, with a value of
TRUE indicating
on and a value of
FALSE indicating
off. If the option does not apply to the
C++ environment, this field contains the words "Not applicable."
|
|
|
There are 3 APIs for setting options. The appropriate API to use depends on the type of the value:
api_set_int_option when the value is an
int (or, equivalently, a
logical);
api_set_dbl_option when the value is a
double; and
api_set_str_option when the value is a
char* (character string).
|
|
|
Description:
|
The
Description field describes the option and its use.
|
|
|
Example:
|
The
Example field contains a Scheme example that sets the option (possibly including surrounding calls that provide context). Comment lines are indicated by a leading single semicolon
(;). Text lines returned as output by the extension are indicated by leading double semicolons (;;). Refer to the
Scheme Extension Template description in the
3D ACIS Online Help User's Guide for more information on Scheme examples.
|
|
|
If the option does not apply to the Scheme environment, this field contains the words "Not applicable."
|
|
|
When appropriate, an illustration follows the example.
|