ScenePreferenceIO.ScenePreference Class Reference
Detailed Description
Holds data for a scene specific preference.
These objects are 'nameless', just value holders Initialize with a valueTuple of the form (default, (min, max), type) set the range tuple (min, max) to None for no value clamping. Only values are dynamic.
#include
<class_scene_preference_i_o_1_1_scene_preference.h>
Public Member Functions |
|
| __init__ () | |
| getDefault () | |
| getMin () | |
| getMax () | |
| getRange () | |
| getType () | |
| getValue () | |
| setDefault () | |
| setValue () | |
| If a min/max range was given on
initialization, then the value is clamped before assignment.
|
|
Member Function Documentation
| ScenePreferenceIO.ScenePreference.__init__ | ( | ) |
| ScenePreferenceIO.ScenePreference.getDefault | ( | ) |
| ScenePreferenceIO.ScenePreference.getMin | ( | ) |
| ScenePreferenceIO.ScenePreference.getMax | ( | ) |
| ScenePreferenceIO.ScenePreference.getRange | ( | ) |
| ScenePreferenceIO.ScenePreference.getType | ( | ) |
| ScenePreferenceIO.ScenePreference.getValue | ( | ) |
| ScenePreferenceIO.ScenePreference.setDefault | ( | ) |
| ScenePreferenceIO.ScenePreference.setValue | ( | ) |
If a min/max range was given on initialization, then the value is clamped before assignment.
If the given value was invalid, the value is clamped to the nearest valid value, and the method returns false.
