History

Picks and RayPick API JSdoc updates per Pointers API JSDoc

David Rowe committed 7 years ago

Commit e109c8f1 parent f2cf3bd3 files · +31 −25Browse files

Showing the changes to interface/src/raypick/PickScriptingInterface.cpp (1 of 3 files). Show all

Unified · Split

interface/src/raypick/PickScriptingInterface.cpp+4−4
@@ -55,7 +55,7 @@ PickFilter getPickFilter(unsigned int filter) { · 54 unmodified lines
55}55}
56 56
57/**jsdoc57/**jsdoc
58 * A set of properties that can be passed to {@link Picks.createPick} when creating a new ray pick.58 * The properties of a ray pick.
59 *59 *
60 * @typedef {object} Picks.RayPickProperties60 * @typedef {object} Picks.RayPickProperties
61 * @property {boolean} [enabled=false] - <code>true</code> if this pick should start enabled, <code>false</code> if it should 61 * @property {boolean} [enabled=false] - <code>true</code> if this pick should start enabled, <code>false</code> if it should
@@ -138,7 +138,7 @@ unsigned int PickScriptingInterface::createRayPick(const QVariant& properties) { · 76 unmodified lines
138}138}
139 139
140/**jsdoc140/**jsdoc
141 * A set of properties that can be passed to {@link Picks.createPick} when creating a new stylus pick.141 * The properties of a stylus pick.
142 *142 *
143 * @typedef {object} Picks.StylusPickProperties143 * @typedef {object} Picks.StylusPickProperties
144 * @property {number} [hand=-1] <code>0</code> for the left hand, <code>1</code> for the right hand, invalid (<code>-1</code>) 144 * @property {number} [hand=-1] <code>0</code> for the left hand, <code>1</code> for the right hand, invalid (<code>-1</code>)
@@ -189,7 +189,7 @@ unsigned int PickScriptingInterface::createStylusPick(const QVariant& properties · 44 unmodified lines
189 189
190// NOTE: Laser pointer still uses scaleWithAvatar. Until scaleWithAvatar is also deprecated for pointers, scaleWithAvatar should not be removed from the pick API.190// NOTE: Laser pointer still uses scaleWithAvatar. Until scaleWithAvatar is also deprecated for pointers, scaleWithAvatar should not be removed from the pick API.
191/**jsdoc191/**jsdoc
192 * A set of properties that can be passed to {@link Picks.createPick} when creating a new parabola pick.192 * The properties of a parabola pick.
193 *193 *
194 * @typedef {object} Picks.ParabolaPickProperties194 * @typedef {object} Picks.ParabolaPickProperties
195 * @property {boolean} [enabled=false] - <code>true</code> if this pick should start enabled, <code>false</code> if it should 195 * @property {boolean} [enabled=false] - <code>true</code> if this pick should start enabled, <code>false</code> if it should
@@ -297,7 +297,7 @@ unsigned int PickScriptingInterface::createParabolaPick(const QVariant& properti · 101 unmodified lines
297 297
298 298
299/**jsdoc299/**jsdoc
300 * A set of properties that can be passed to {@link Picks.createPick} when creating a new collision pick.300 * The properties or a collision pick.
301 *301 *
302 * @typedef {object} Picks.CollisionPickProperties302 * @typedef {object} Picks.CollisionPickProperties
303 * @property {boolean} [enabled=false] - <code>true</code> if this pick should start enabled, <code>false</code> if it should303 * @property {boolean} [enabled=false] - <code>true</code> if this pick should start enabled, <code>false</code> if it should