Go to the source code of this file.
Retrieves options providers associated with the options manager.
- Parameters
-
[in] | options_provider | The options provider object. |
[in] | len | The number of keys to retrieve. |
[out] | keys | The keys retrieved. |
[out] | count | The number of keys retrieved. |
- Returns
-
Gets the number of available option keys.
- Parameters
-
[in] | options_provider | The options provider object. |
[out] | count | The number of keys available. |
- Returns
-
Gets the value of the given option.
- Parameters
-
[in] | options_provider | The options provider object. |
[in] | key | The key that indicates which option to get. |
[out] | value | The value to get the current option setting. |
- Returns
-
The breakdown of options and value types for each options provider is shown in the table below.
Options Provider | Option | Value Type | Meaning |
NamedOptions | | | Provides ability to save arbitrary named option values. There are no default options for this provider. |
PageOptions | | | Options for the Scene |
| ShowTransition | SUTypedValueType_Bool | Show scene transitions |
| TransitionTime | SUTypedValueType_Double | Number of seconds between each scene transition |
SlideshowOptions | | | Options for the slideshow |
| LoopSlideshow | SUTypedValueType_Bool | Causes the slideshow to loop |
| SlideTime | SUTypedValueType_Double | Number of seconds that each slide is shown |
UnitsOptions | | | Options for units display in the model |
| LengthPrecision | SUTypedValueType_Int32 | Number of decimal places of precision shown for length |
| LengthFormat | SUTypedValueType_Int32 | Default units format for the model |
| LengthUnit | SUTypedValueType_Int32 | Units format for the model |
| LengthSnapEnabled | SUTypedValueType_Bool | Indicates whether length snapping is enabled |
| LengthSnapLength | SUTypedValueType_Double | Controls the snapping length size increment |
| AnglePrecision | SUTypedValueType_Int32 | Number of decimal places of precision shown for angles |
| AngleSnapEnabled | SUTypedValueType_Bool | Indicates whether angle snapping is enabled |
| SnapAngle | SUTypedValueType_Double | Controls the angle snapping size increment |
| SuppressUnitsDisplay | SUTypedValueType_Bool | Display the units format if LengthFormat is Decimal or Fractional |
| ForceInchDisplay | SUTypedValueType_Bool | Force displaying 0" if LengthFormat is Architectural |
Some of the options map to enumerated values, as shown in the table below.
Option | Value | Meaning |
LengthFormat | 0: | Decimal |
| 1: | Architectural |
| 2: | Engineering |
| 3: | Fractional |
LengthUnit | 0: | Inches |
| 1: | Feet |
| 2: | Millimeter |
| 3: | Centimeter |
| 4: | Meter |
Note that LengthUnit will be overridden by LengthFormat if LengthFormat is not set to Decimal. Architectural defaults to inches, Engineering defaults to feet, and Fractional defaults to inches.
Sets the value of the given option.
- Parameters
-
[in] | options_provider | The options provider object. |
[in] | key | The key that indicates which option to set. |
[in] | value | The value to set the option to. |
- Returns
-