History

Add JS docs for CollisionPick API

sabrina-shanman committed 8 years ago

Commit de6d30e1 parent 8f993e42 files · +38 −2Browse files

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

Unified · Split

interface/src/raypick/PickScriptingInterface.cpp+17−0
@@ -137,6 +137,23 @@ unsigned int PickScriptingInterface::createStylusPick(const QVariant& properties · 136 unmodified lines
137137 return DependencyManager::get<PickManager>()->addPick(PickQuery::Stylus, std::make_shared<StylusPick>(side, filter, maxDistance, enabled));
138138 }
139139
140+/**jsdoc
141+* A Shape defines a physical volume.
142+*
143+* @typedef {object} Shape
144+* @property {ShapeType} shapeType The type of shape to use.
145+* @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.
146+* @property {Vec3} dimensions - The size to scale the shape to.
147+*/
148+
149+/**jsdoc
150+* A set of properties that can be passed to {@link Picks.createPick} to create a new Collision Pick.
151+
152+* @typedef {object} Picks.CollisionPickProperties
153+* @property {Shape} shape - The information about the collision region's size and shape.
154+* @property {Vec3} position - The position of the collision region.
155+* @property {Quat} orientation - The orientation of the collision region.
156+*/
140157 unsigned int PickScriptingInterface::createCollisionPick(const QVariant& properties) {
141158 QVariantMap propMap = properties.toMap();
142159