History

Disambiguate pick and pointer types in the returned properties

sabrina-shanman committed 7 years ago

Commit 8cde9391 parent 30482c211 files · +30 −7Browse files

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

Unified · Split

interface/src/raypick/PointerScriptingInterface.cpp+4−1
@@ -60,7 +60,7 @@ unsigned int PointerScriptingInterface::createPointer(const PickQuery::PickType& · 59 unmodified lines
6060 return PointerEvent::INVALID_POINTER_ID;
6161 }
6262
63− propertyMap["type"] = (int)type;
63+ propertyMap["pointerType"] = (int)type;
6464
6565 pointer->setScriptParameters(propertyMap);
6666
@@ -89,6 +89,7 @@ QVariantMap PointerScriptingInterface::getPointerScriptParameters(unsigned int u · 22 unmodified lines
8989 * @property {Pointers.StylusPointerModel} [model] - Override some or all of the default stylus model properties.
9090 * @property {boolean} [hover=false] - <code>true</code> if the pointer generates {@link Entities} hover events,
9191 * <code>false</code> if it doesn't.
92+ * @property {PickType} pointerType - The type of pointer when getting these properties from {@link Pointers.getPointerProperties}. A stylus pointer's type is {@link PickType.Stylus}.
9293 * @property {number} [pickID] - Returned from {@link Pointers.getPointerProperties}. The ID of the pick created alongside this pointer.
9394 * @see {@link Picks.StylusPickProperties} for additional properties from the underlying stylus pick.
9495 */
@@ -207,6 +208,7 @@ std::shared_ptr<Pointer> PointerScriptingInterface::buildStylus(const QVariant& · 112 unmodified lines
207208 * <code>false</code> if it doesn't.
208209 * @property {Pointers.Trigger[]} [triggers=[]] - A list of ways that a {@link Controller} action or function should trigger
209210 * events on the entity or overlay currently intersected.
211+ * @property {PickType} pointerType - The type of pointer when getting these properties from {@link Pointers.getPointerProperties}. A laser pointer's type is {@link PickType.Ray}.
210212 * @property {number} [pickID] - Returned from {@link Pointers.getPointerProperties}. The ID of the pick created alongside this pointer.
211213 * @see {@link Picks.RayPickProperties} for additional properties from the underlying ray pick.
212214 */
@@ -399,6 +401,7 @@ std::shared_ptr<Pointer> PointerScriptingInterface::buildLaserPointer(const QVar · 186 unmodified lines
399401 * <code>false</code> if it doesn't.
400402 * @property {Pointers.Trigger[]} [triggers=[]] - A list of ways that a {@link Controller} action or function should trigger
401403 * events on the entity or overlay currently intersected.
404+ * @property {PickType} pointerType - The type of pointer when getting these properties from {@link Pointers.getPointerProperties}. A parabola pointer's type is {@link PickType.Parabola}.
402405 * @property {number} [pickID] - Returned from {@link Pointers.getPointerProperties}. The ID of the pick created alongside this pointer.
403406 * @see {@link Picks.ParabolaPickProperties} for additional properties from the underlying parabola pick.
404407 */