History

Selection JSDoc revision

David Rowe committed 7 years ago

Commit 04573da1 parent 257ac122 files · +128 −130Browse files

Showing the changes to interface/src/scripting/SelectionScriptingInterface.cpp (1 of 2 files). Show all

Unified · Split

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