Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-08-08 14:58:03 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

JSDoc revisions for PR16025

Browse source
This commit is contained in:
ingerjm0 2019-11-12 14:17:23 -08:00
parent 5f2f647dfb
commit a61857b6d8
4 changed files with 43 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
interface/src/raypick/PickScriptingInterface.cpp
View file

@ -99,9 +99,11 @@ PickFilter getPickFilter(unsigned int filter) {
* @property {Vec3} [dirOffset] - Synonym for <code>direction</code>. * @property {Vec3} [dirOffset] - Synonym for <code>direction</code>.
* @property {Quat} [orientation] - Alternative property for specifying <code>direction</code>. The value is applied to the * @property {Quat} [orientation] - Alternative property for specifying <code>direction</code>. The value is applied to the
* default <code>direction</code> value. * default <code>direction</code> value.
* @property {PickType} pickType - The type of pick when getting these properties from {@link Picks.getPickProperties} or {@link Picks.getPickScriptParameters}. A ray pick's type is {@link PickType.Ray}. * @property {PickType} pickType - The type of pick when getting these properties from {@link Picks.getPickProperties} or
* @property {Vec3} baseScale - Returned from {@link Picks.getPickProperties} when the pick has a parent with varying scale (usually an avatar or an entity). * {@link Picks.getPickScriptParameters}. A ray pick's type is {@link PickType.Ray}.
* Its value is the original scale of the parent at the moment the pick was created, and is used to scale the pointer which owns this pick, if any. * @property {Vec3} baseScale - Returned from {@link Picks.getPickProperties} when the pick has a parent with varying scale
* (usually an avatar or an entity). Its value is the original scale of the parent at the moment the pick was created, and
* is used to scale the pointer which owns this pick, if any.
*/ */
std::shared_ptr<PickQuery> PickScriptingInterface::buildRayPick(const QVariantMap& propMap) { std::shared_ptr<PickQuery> PickScriptingInterface::buildRayPick(const QVariantMap& propMap) {
#if defined (Q_OS_ANDROID) #if defined (Q_OS_ANDROID)
@ -170,7 +172,8 @@ std::shared_ptr<PickQuery> PickScriptingInterface::buildRayPick(const QVariantMa
* means no maximum. * means no maximum.
* @property {Vec3} [tipOffset=0,0.095,0] - The position of the stylus tip relative to the hand position at default avatar * @property {Vec3} [tipOffset=0,0.095,0] - The position of the stylus tip relative to the hand position at default avatar
* scale. * scale.
* @property {PickType} pickType - The type of pick when getting these properties from {@link Picks.getPickProperties} or {@link Picks.getPickScriptParameters}. A stylus pick's type is {@link PickType.Stylus}. * @property {PickType} pickType - The type of pick when getting these properties from {@link Picks.getPickProperties} or
* {@link Picks.getPickScriptParameters}. A stylus pick's type is {@link PickType.Stylus}.
*/ */
std::shared_ptr<PickQuery> PickScriptingInterface::buildStylusPick(const QVariantMap& propMap) { std::shared_ptr<PickQuery> PickScriptingInterface::buildStylusPick(const QVariantMap& propMap) {
bilateral::Side side = bilateral::Side::Invalid; bilateral::Side side = bilateral::Side::Invalid;
@ -204,7 +207,8 @@ std::shared_ptr<PickQuery> PickScriptingInterface::buildStylusPick(const QVarian
return std::make_shared<StylusPick>(side, filter, maxDistance, enabled, tipOffset); return std::make_shared<StylusPick>(side, filter, maxDistance, enabled, tipOffset);
} }
// NOTE: Laser pointer still uses scaleWithAvatar. Until scaleWithAvatar is also deprecated for pointers, scaleWithAvatar should not be removed from the pick API. // NOTE: Laser pointer still uses scaleWithAvatar. Until scaleWithAvatar is also deprecated for pointers, scaleWithAvatar
// should not be removed from the pick API.
/**jsdoc /**jsdoc
* The properties of a parabola pick. * The properties of a parabola pick.
* *
@ -245,9 +249,11 @@ std::shared_ptr<PickQuery> PickScriptingInterface::buildStylusPick(const QVarian
* with the avatar or other parent. * with the avatar or other parent.
* @property {boolean} [scaleWithAvatar=true] - Synonym for <code>scalewithParent</code>. * @property {boolean} [scaleWithAvatar=true] - Synonym for <code>scalewithParent</code>.
* <p class="important">Deprecated: This property is deprecated and will be removed.</p> * <p class="important">Deprecated: This property is deprecated and will be removed.</p>
* @property {PickType} pickType - The type of pick when getting these properties from {@link Picks.getPickProperties} or {@link Picks.getPickScriptParameters}. A parabola pick's type is {@link PickType.Parabola}. * @property {PickType} pickType - The type of pick when getting these properties from {@link Picks.getPickProperties} or
* @property {Vec3} baseScale - Returned from {@link Picks.getPickProperties} when the pick has a parent with varying scale (usually an avatar or an entity). * {@link Picks.getPickScriptParameters}. A parabola pick's type is {@link PickType.Parabola}.
* Its value is the original scale of the parent at the moment the pick was created, and is used to rescale the pick, and/or the pointer which owns this pick, if any. * @property {Vec3} baseScale - Returned from {@link Picks.getPickProperties} when the pick has a parent with varying scale
* (usually an avatar or an entity). Its value is the original scale of the parent at the moment the pick was created, and
* is used to rescale the pick, and/or the pointer which owns this pick, if any.
*/ */
std::shared_ptr<PickQuery> PickScriptingInterface::buildParabolaPick(const QVariantMap& propMap) { std::shared_ptr<PickQuery> PickScriptingInterface::buildParabolaPick(const QVariantMap& propMap) {
bool enabled = false; bool enabled = false;

19
interface/src/raypick/PickScriptingInterface.h
View file

@ -147,19 +147,20 @@ public:
* Gets the current properties of the pick. * Gets the current properties of the pick.
* @function Picks.getPickProperties * @function Picks.getPickProperties
* @param {number} id - The ID of the pick. * @param {number} id - The ID of the pick.
* @returns {Picks.RayPickProperties|Picks.ParabolaPickProperties|Picks.StylusPickProperties|Picks.CollisionPickProperties} Properties of the pick, per the pick <code>type</code>. * @returns {Picks.RayPickProperties|Picks.ParabolaPickProperties|Picks.StylusPickProperties|Picks.CollisionPickProperties}
* Properties of the pick, per the pick <code>type</code>.
*/ */
Q_INVOKABLE QVariantMap getPickProperties(unsigned int uid) const; Q_INVOKABLE QVariantMap getPickProperties(unsigned int uid) const;
/**jsdoc /**jsdoc
* Gets the parameters that were passed in to {@link Picks.createPick} to create the pick, * Gets the parameters that were passed in to {@link Picks.createPick} to create the pick, if the pick was created through
* if the pick was created through a script. * a script. Note that these properties do not reflect the current state of the pick.
* Note that these properties do not reflect the current state of the pick. * See {@link Picks.getPickProperties}.
* See {@link Picks.getPickProperties}. * @function Picks.getPickScriptParameters
* @function Picks.getPickScriptParameters * @param {number} id - The ID of the pick.
* @param {number} id - The ID of the pick. * @returns {Picks.RayPickProperties|Picks.ParabolaPickProperties|Picks.StylusPickProperties|Picks.CollisionPickProperties}
* @returns {Picks.RayPickProperties|Picks.ParabolaPickProperties|Picks.StylusPickProperties|Picks.CollisionPickProperties} User-provided properties, per the pick <code>type</code>. * User-provided properties, per the pick <code>type</code>.
*/ */
Q_INVOKABLE QVariantMap getPickScriptParameters(unsigned int uid) const; Q_INVOKABLE QVariantMap getPickScriptParameters(unsigned int uid) const;
/**jsdoc /**jsdoc

19
interface/src/raypick/PointerScriptingInterface.cpp
View file

@ -89,10 +89,13 @@ QVariantMap PointerScriptingInterface::getPointerScriptParameters(unsigned int u
* @property {Pointers.StylusPointerModel} [model] - Override some or all of the default stylus model properties. * @property {Pointers.StylusPointerModel} [model] - Override some or all of the default stylus model properties.
* @property {boolean} [hover=false] - <code>true</code> if the pointer generates {@link Entities} hover events, * @property {boolean} [hover=false] - <code>true</code> if the pointer generates {@link Entities} hover events,
* <code>false</code> if it doesn't. * <code>false</code> if it doesn't.
* @property {PickType} pointerType - The type of pointer when getting these properties from {@link Pointers.getPointerProperties} or {@link Pointers.getPointerScriptParameters}. A stylus pointer's type is {@link PickType.Stylus}. * @property {PickType} pointerType - The type of the stylus pointer returned from {@link Pointers.getPointerProperties}
* @property {number} [pickID] - Returned from {@link Pointers.getPointerProperties}. The ID of the pick created alongside this pointer. * or {@link Pointers.getPointerScriptParameters}. A stylus pointer's type is {@link PickType.Stylus}.
* @property {number} [pickID] - The ID of the pick created alongside this pointer, returned from
* {@link Pointers.getPointerProperties}.
* @see {@link Picks.StylusPickProperties} for additional properties from the underlying stylus pick. * @see {@link Picks.StylusPickProperties} for additional properties from the underlying stylus pick.
*/ */
/**jsdoc /**jsdoc
* The properties of a stylus pointer model. * The properties of a stylus pointer model.
* @typedef {object} Pointers.StylusPointerModel * @typedef {object} Pointers.StylusPointerModel
@ -208,8 +211,10 @@ std::shared_ptr<Pointer> PointerScriptingInterface::buildStylus(const QVariant&
* <code>false</code> if it doesn't. * <code>false</code> if it doesn't.
* @property {Pointers.Trigger[]} [triggers=[]] - A list of ways that a {@link Controller} action or function should trigger * @property {Pointers.Trigger[]} [triggers=[]] - A list of ways that a {@link Controller} action or function should trigger
* events on the entity or overlay currently intersected. * events on the entity or overlay currently intersected.
* @property {PickType} pointerType - The type of pointer when getting these properties from {@link Pointers.getPointerProperties} or {@link Pointers.getPointerScriptParameters}. A laser pointer's type is {@link PickType.Ray}. * @property {PickType} pointerType - The type of pointer returned from {@link Pointers.getPointerProperties} or
* @property {number} [pickID] - Returned from {@link Pointers.getPointerProperties}. The ID of the pick created alongside this pointer. * {@link Pointers.getPointerScriptParameters}. A laser pointer's type is {@link PickType.Ray}.
* @property {number} [pickID] - The ID of the pick created alongside this pointer, returned from
* {@link Pointers.getPointerProperties}.
* @see {@link Picks.RayPickProperties} for additional properties from the underlying ray pick. * @see {@link Picks.RayPickProperties} for additional properties from the underlying ray pick.
*/ */
std::shared_ptr<Pointer> PointerScriptingInterface::buildLaserPointer(const QVariant& properties) { std::shared_ptr<Pointer> PointerScriptingInterface::buildLaserPointer(const QVariant& properties) {
@ -401,8 +406,10 @@ std::shared_ptr<Pointer> PointerScriptingInterface::buildLaserPointer(const QVar
* <code>false</code> if it doesn't. * <code>false</code> if it doesn't.
* @property {Pointers.Trigger[]} [triggers=[]] - A list of ways that a {@link Controller} action or function should trigger * @property {Pointers.Trigger[]} [triggers=[]] - A list of ways that a {@link Controller} action or function should trigger
* events on the entity or overlay currently intersected. * events on the entity or overlay currently intersected.
* @property {PickType} pointerType - The type of pointer when getting these properties from {@link Pointers.getPointerProperties} or {@link Pointers.getPointerScriptParameters}. A parabola pointer's type is {@link PickType.Parabola}. * @property {PickType} pointerType - The type of pointer returned from {@link Pointers.getPointerProperties} or
* @property {number} [pickID] - Returned from {@link Pointers.getPointerProperties}. The ID of the pick created alongside this pointer. * {@link Pointers.getPointerScriptParameters}. A parabola pointer's type is {@link PickType.Parabola}.
* @property {number} [pickID] - The ID of the pick created alongside this pointer, returned from
* {@link Pointers.getPointerProperties}.
* @see {@link Picks.ParabolaPickProperties} for additional properties from the underlying parabola pick. * @see {@link Picks.ParabolaPickProperties} for additional properties from the underlying parabola pick.
*/ */
std::shared_ptr<Pointer> PointerScriptingInterface::buildParabolaPointer(const QVariant& properties) { std::shared_ptr<Pointer> PointerScriptingInterface::buildParabolaPointer(const QVariant& properties) {

11
interface/src/raypick/PointerScriptingInterface.h
View file

@ -161,13 +161,14 @@ public:
Q_INVOKABLE void removePointer(unsigned int uid) const { DependencyManager::get<PointerManager>()->removePointer(uid); } Q_INVOKABLE void removePointer(unsigned int uid) const { DependencyManager::get<PointerManager>()->removePointer(uid); }
/**jsdoc /**jsdoc
* Gets the parameters that were passed in to {@link Pointers.createPointer} to create the pointer, * Gets the parameters that were passed in to {@link Pointers.createPointer} to create the pointer when the pointer was
* if the pointer was created through a script. * created through a script.
* Note that these properties do not reflect the current state of the pointer. * <p><strong>Note:</strong> These properties do not reflect the current state of the pointer. To get the current state
* See {@link Pointers.getPointerProperties}. * of the pointer, see {@link Pointers.getPointerProperties}.
* @function Pointers.getPointerScriptParameters * @function Pointers.getPointerScriptParameters
* @param {number} id - The ID of the pointer. * @param {number} id - The ID of the pointer.
* @returns {Pointers.RayPointerProperties|Picks.ParabolaPointerProperties|Picks.StylusPointerProperties} User-provided properties, per the pointer <code>type</code>. * @returns {Pointers.RayPointerProperties|Picks.ParabolaPointerProperties|Picks.StylusPointerProperties}
* User-provided properties, per the pointer <code>type</code>.
*/ */
Q_INVOKABLE QVariantMap getPointerScriptParameters(unsigned int uid) const; Q_INVOKABLE QVariantMap getPointerScriptParameters(unsigned int uid) const;