History

Reduce scope of CollisionPick shapeType to primitive shapes

sabrina-shanman committed 8 years ago

Commit 69812d01 parent 577379d1 file · +4 −2Browse files

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

Unified · Split

interface/src/raypick/PickScriptingInterface.cpp+4−2
@@ -242,11 +242,13 @@ unsigned int PickScriptingInterface::createParabolaPick(const QVariant& properti · 241 unmodified lines
242242 * A Shape defines a physical volume.
243243 *
244244 * @typedef {object} Shape
245−* @property {ShapeType} shapeType The type of shape to use.
246−* @property {string} modelURL - If shapeType is one of: "compound", "simple-hull", "simple-compound", or "static-mesh", this defines the model to load to generate the collision volume.
245+* @property {string} shapeType The type of shape to use. Can be one of the following: "box", "sphere", "capsule-x", "capsule-y", "capsule-z", "cylinder-x", "cylinder-y", "cylinder-z", "plane"
247246 * @property {Vec3} dimensions - The size to scale the shape to.
248247 */
249248
249+// TODO: Add this property to the Shape jsdoc above once model picks work properly
250+// * @property {string} modelURL - If shapeType is one of: "compound", "simple-hull", "simple-compound", or "static-mesh", this defines the model to load to generate the collision volume.
251+
250252 /**jsdoc
251253 * A set of properties that can be passed to {@link Picks.createPick} to create a new Collision Pick.
252254