settings_base
SettingItem
A wrapper of an individual setting item.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
owner |
class: |
required | |
setting_type |
class: |
required | |
name |
str
|
Description of this setting. |
required |
path |
str
|
Path of this setting. |
required |
range_from |
float
|
The lower bound of the values for this setting. Defaults to -inf. |
-float('inf')
|
range_to |
float
|
The upper bound of the values for this settin. Defaults to inf. |
float('inf')
|
range_list |
list
|
Possible values for this setting. Defaults to None. |
None
|
range_dict |
dict
|
Possible values for this setting. Defaults to None. |
None
|
Source code in omnigibson/renderer_settings/settings_base.py
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 |
|
value
property
Get the current setting value.
Returns:
Type | Description |
---|---|
any
|
The current setting value. |
get()
reset()
set(value)
Set the current setting to @value.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value |
any
|
Value to set for the current setting value. |
required |
Source code in omnigibson/renderer_settings/settings_base.py
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 |
|
SettingsBase
Base class for all renderer settings classes.
Settings classes include Common, Real-Time (Ray-Tracing), Path-Tracing and Post Processing.
SubSettingsBase
Base class for all renderer sub-settings classes.
Source code in omnigibson/renderer_settings/settings_base.py
enabled_setting_path
property
The path of "enabled" setting for this sub-settings class.
Subclass with "enabled" mode needs to overwrite this method.
Returns:
Type | Description |
---|---|
str or None
|
The path of "enabled" mode for this sub-setting class. Defaults to None, which means this sub-setting group cannot be enabled/disabled. |
disable()
Disable this sub-setting class.
Source code in omnigibson/renderer_settings/settings_base.py
enable()
Enable this sub-setting class.
Source code in omnigibson/renderer_settings/settings_base.py
is_enabled()
Get the enabled status for this sub-setting class.
Returns:
Type | Description |
---|---|
bool
|
Whether this sub-setting group is enabled. Returns true if this sub-setting group has no "enabled" mode. |