Showing the changes to interface/src/scripting/SelectionScriptingInterface.cpp (1 of 2 files). Show all
Unified · Split
| @@ -44,13 +44,14 @@ SelectionScriptingInterface::SelectionScriptingInterface() { · 43 unmodified lines | ||
| 44 | 44 | } |
| 45 | 45 | |
| 46 | 46 | /**jsdoc |
| 47 | + * The type of an item in a selection list. | |
| 47 | 48 | * <table> |
| 48 | 49 | * <thead> |
| 49 | 50 | * <tr><th>Value</th><th>Description</th></tr> |
| 50 | 51 | * </thead> |
| 51 | 52 | * <tbody> |
| 52 | − * <tr><td><code>"avatar"</code></td><td></td></tr> | |
| 53 | − * <tr><td><code>"entity"</code></td><td></td></tr> | |
| 53 | + * <tr><td><code>"avatar"</code></td><td>The item is an avatar.</td></tr> | |
| 54 | + * <tr><td><code>"entity"</code></td><td>The item is an entity.</td></tr> | |
| 54 | 55 | * </tbody> |
| 55 | 56 | * </table> |
| 56 | 57 | * @typedef {string} Selection.ItemType |
| @@ -245,9 +246,10 @@ void SelectionScriptingInterface::printList(const QString& listName) { · 188 unmodified lines | ||
| 245 | 246 | } |
| 246 | 247 | |
| 247 | 248 | /**jsdoc |
| 249 | + * A selection list. | |
| 248 | 250 | * @typedef {object} Selection.SelectedItemsList |
| 249 | − * @property {Uuid[]} avatars - The IDs of the avatars in the selection. | |
| 250 | − * @property {Uuid[]} entities - The IDs of the entities in the selection. | |
| 251 | + * @property {Uuid[]} avatars - The IDs of the avatars in the selection list. | |
| 252 | + * @property {Uuid[]} entities - The IDs of the entities in the selection list. | |
| 251 | 253 | */ |
| 252 | 254 | QVariantMap SelectionScriptingInterface::getSelectedItemsList(const QString& listName) const { |
| 253 | 255 | QReadLocker lock(&_selectionListsLock); |
| @@ -438,18 +440,19 @@ bool SelectionHighlightStyle::fromVariantMap(const QVariantMap& properties) { · 184 unmodified lines | ||
| 438 | 440 | } |
| 439 | 441 | |
| 440 | 442 | /**jsdoc |
| 443 | + * The highlighting style of a selection list. | |
| 441 | 444 | * @typedef {object} Selection.HighlightStyle |
| 442 | − * @property {Color} outlineUnoccludedColor - Color of the specified highlight region. | |
| 443 | − * @property {Color} outlineOccludedColor - "" | |
| 444 | − * @property {Color} fillUnoccludedColor- "" | |
| 445 | − * @property {Color} fillOccludedColor- "" | |
| 446 | − * @property {number} outlineUnoccludedAlpha - Alpha value ranging from <code>0.0</code> (not visible) to <code>1.0</code> | |
| 447 | − * (fully opaque) for the specified highlight region. | |
| 448 | − * @property {number} outlineOccludedAlpha - "" | |
| 449 | − * @property {number} fillUnoccludedAlpha - "" | |
| 450 | − * @property {number} fillOccludedAlpha - "" | |
| 451 | − * @property {number} outlineWidth - Width of the outline, in pixels. | |
| 452 | − * @property {boolean} isOutlineSmooth - <code>true</code> to enable outline smooth fall-off. | |
| 445 | + * @property {Color} outlineUnoccludedColor=255,178,51 - Unoccluded outline color. | |
| 446 | + * @property {Color} outlineOccludedColor=255,178,51 - Occluded outline color. | |
| 447 | + * @property {Color} fillUnoccludedColor=51,178,255 - Unoccluded fill color. | |
| 448 | + * @property {Color} fillOccludedColor=51,178,255 - Occluded fill color. | |
| 449 | + * @property {number} outlineUnoccludedAlpha=0.9 - Unoccluded outline alpha, range <code>0.0</code> – <code>1.0</code>. | |
| 450 | + * @property {number} outlineOccludedAlpha=0.9 - Occluded outline alpha, range <code>0.0</code> – <code>1.0</code>. | |
| 451 | + * @property {number} fillUnoccludedAlpha=0.0 - Unoccluded fill alpha, range <code>0.0</code> – <code>1.0</code>. | |
| 452 | + * @property {number} fillOccludedAlpha=0.0 - Occluded fill alpha, range <code>0.0</code> – <code>1.0</code>. | |
| 453 | + * @property {number} outlineWidth=2 - Width of the outline, in pixels. | |
| 454 | + * @property {boolean} isOutlineSmooth=false - <code>true</code> to fade the outside edge of the outline, <code>false</code> | |
| 455 | + * to have a sharp edge. | |
| 453 | 456 | */ |
| 454 | 457 | QVariantMap SelectionHighlightStyle::toVariantMap() const { |
| 455 | 458 | QVariantMap properties; |