Showing the changes to interface/src/raypick/PointerScriptingInterface.cpp (1 of 220 files). Show all
Unified · Split
| @@ -83,7 +83,7 @@ QVariantMap PointerScriptingInterface::getPointerScriptParameters(unsigned int u · 82 unmodified lines | |||
| 83 | return DependencyManager::get<PointerManager>()->getPointerScriptParameters(uid); | 83 | return DependencyManager::get<PointerManager>()->getPointerScriptParameters(uid); |
| 84 | } | 84 | } |
| 85 | 85 | ||
| 86 | /**jsdoc | 86 | /*@jsdoc |
| 87 | * The properties of a stylus pointer. These include the properties from the underlying stylus pick that the pointer uses. | 87 | * The properties of a stylus pointer. These include the properties from the underlying stylus pick that the pointer uses. |
| 88 | * @typedef {object} Pointers.StylusPointerProperties | 88 | * @typedef {object} Pointers.StylusPointerProperties |
| 89 | * @property {Pointers.StylusPointerModel} [model] - Override some or all of the default stylus model properties. | 89 | * @property {Pointers.StylusPointerModel} [model] - Override some or all of the default stylus model properties. |
| @@ -96,7 +96,7 @@ QVariantMap PointerScriptingInterface::getPointerScriptParameters(unsigned int u · 6 unmodified lines | |||
| 96 | * @see {@link Picks.StylusPickProperties} for additional properties from the underlying stylus pick. | 96 | * @see {@link Picks.StylusPickProperties} for additional properties from the underlying stylus pick. |
| 97 | */ | 97 | */ |
| 98 | 98 | ||
| 99 | /**jsdoc | 99 | /*@jsdoc |
| 100 | * The properties of a stylus pointer model. | 100 | * The properties of a stylus pointer model. |
| 101 | * @typedef {object} Pointers.StylusPointerModel | 101 | * @typedef {object} Pointers.StylusPointerModel |
| 102 | * @property {string} [url] - The url of a model to use for the stylus, to override the default stylus mode. | 102 | * @property {string} [url] - The url of a model to use for the stylus, to override the default stylus mode. |
| @@ -141,14 +141,14 @@ std::shared_ptr<Pointer> PointerScriptingInterface::buildStylus(const QVariant& · 38 unmodified lines | |||
| 141 | return std::make_shared<StylusPointer>(properties, StylusPointer::buildStylus(propertyMap), hover, enabled, modelPositionOffset, modelRotationOffset, modelDimensions); | 141 | return std::make_shared<StylusPointer>(properties, StylusPointer::buildStylus(propertyMap), hover, enabled, modelPositionOffset, modelRotationOffset, modelDimensions); |
| 142 | } | 142 | } |
| 143 | 143 | ||
| 144 | /**jsdoc | 144 | /*@jsdoc |
| 145 | * Properties that define the visual appearance of a ray pointer when the pointer is not intersecting something. These are the | 145 | * Properties that define the visual appearance of a ray pointer when the pointer is not intersecting something. These are the |
| 146 | * properties of {@link Pointers.RayPointerRenderState} but with an additional property. | 146 | * properties of {@link Pointers.RayPointerRenderState} but with an additional property. |
| 147 | * @typedef {object} Pointers.DefaultRayPointerRenderState | 147 | * @typedef {object} Pointers.DefaultRayPointerRenderState |
| 148 | * @property {number} distance - The distance at which to render the end of the ray pointer. | 148 | * @property {number} distance - The distance at which to render the end of the ray pointer. |
| 149 | * @see {@link Pointers.RayPointerRenderState} for the remainder of the properties. | 149 | * @see {@link Pointers.RayPointerRenderState} for the remainder of the properties. |
| 150 | */ | 150 | */ |
| 151 | /**jsdoc | 151 | /*@jsdoc |
| 152 | * Properties that define the visual appearance of a ray pointer when the pointer is intersecting something. | 152 | * Properties that define the visual appearance of a ray pointer when the pointer is intersecting something. |
| 153 | * @typedef {object} Pointers.RayPointerRenderState | 153 | * @typedef {object} Pointers.RayPointerRenderState |
| 154 | * @property {string} name - When creating using {@link Pointers.createPointer}, the name of the render state. | 154 | * @property {string} name - When creating using {@link Pointers.createPointer}, the name of the render state. |
| @@ -171,7 +171,7 @@ std::shared_ptr<Pointer> PointerScriptingInterface::buildStylus(const QVariant& · 16 unmodified lines | |||
| 171 | * <p>When getting using {@link Pointers.getPointerProperties}, the ID of the overlay rendered at the end of the ray; | 171 | * <p>When getting using {@link Pointers.getPointerProperties}, the ID of the overlay rendered at the end of the ray; |
| 172 | * <code>null</code> if there is no overlay. | 172 | * <code>null</code> if there is no overlay. |
| 173 | */ | 173 | */ |
| 174 | /**jsdoc | 174 | /*@jsdoc |
| 175 | * The properties of a ray pointer. These include the properties from the underlying ray pick that the pointer uses. | 175 | * The properties of a ray pointer. These include the properties from the underlying ray pick that the pointer uses. |
| 176 | * @typedef {object} Pointers.RayPointerProperties | 176 | * @typedef {object} Pointers.RayPointerProperties |
| 177 | * @property {boolean} [faceAvatar=false] - <code>true</code> if the overlay rendered at the end of the ray rotates about the | 177 | * @property {boolean} [faceAvatar=false] - <code>true</code> if the overlay rendered at the end of the ray rotates about the |
| @@ -329,7 +329,7 @@ std::shared_ptr<Pointer> PointerScriptingInterface::buildLaserPointer(const QVar · 151 unmodified lines | |||
| 329 | distanceScaleEnd, scaleWithParent, enabled); | 329 | distanceScaleEnd, scaleWithParent, enabled); |
| 330 | } | 330 | } |
| 331 | 331 | ||
| 332 | /**jsdoc | 332 | /*@jsdoc |
| 333 | * The visual appearance of the parabolic path. | 333 | * The visual appearance of the parabolic path. |
| 334 | * @typedef {object} Pointers.ParabolaPointerPath | 334 | * @typedef {object} Pointers.ParabolaPointerPath |
| 335 | * @property {Color} [color=255,255,255] - The color of the parabola. | 335 | * @property {Color} [color=255,255,255] - The color of the parabola. |
| @@ -340,14 +340,14 @@ std::shared_ptr<Pointer> PointerScriptingInterface::buildLaserPointer(const QVar · 4 unmodified lines | |||
| 340 | * @property {boolean} [drawInFront=false] - <code>true</code> if the parabola is rendered in front of objects in the world, | 340 | * @property {boolean} [drawInFront=false] - <code>true</code> if the parabola is rendered in front of objects in the world, |
| 341 | * but behind the HUD, <code>false</code> if it is occluded by objects in front of it. | 341 | * but behind the HUD, <code>false</code> if it is occluded by objects in front of it. |
| 342 | */ | 342 | */ |
| 343 | /**jsdoc | 343 | /*@jsdoc |
| 344 | * Properties that define the visual appearance of a parabola pointer when the pointer is not intersecting something. These are | 344 | * Properties that define the visual appearance of a parabola pointer when the pointer is not intersecting something. These are |
| 345 | * properties of {@link Pointers.ParabolaPointerRenderState} but with an additional property. | 345 | * properties of {@link Pointers.ParabolaPointerRenderState} but with an additional property. |
| 346 | * @typedef {object} Pointers.DefaultParabolaPointerRenderState | 346 | * @typedef {object} Pointers.DefaultParabolaPointerRenderState |
| 347 | * @property {number} distance - The distance along the parabola at which to render the end of the parabola pointer. | 347 | * @property {number} distance - The distance along the parabola at which to render the end of the parabola pointer. |
| 348 | * @see {@link Pointers.ParabolaPointerRenderState} for the remainder of the properties. | 348 | * @see {@link Pointers.ParabolaPointerRenderState} for the remainder of the properties. |
| 349 | */ | 349 | */ |
| 350 | /**jsdoc | 350 | /*@jsdoc |
| 351 | * Properties that define the visual appearance of a parabola pointer when the pointer is intersecting something. | 351 | * Properties that define the visual appearance of a parabola pointer when the pointer is intersecting something. |
| 352 | * @typedef {object} Pointers.ParabolaPointerRenderState | 352 | * @typedef {object} Pointers.ParabolaPointerRenderState |
| 353 | * @property {string} name - When creating using {@link Pointers.createPointer}, the name of the render state. | 353 | * @property {string} name - When creating using {@link Pointers.createPointer}, the name of the render state. |
| @@ -366,7 +366,7 @@ std::shared_ptr<Pointer> PointerScriptingInterface::buildLaserPointer(const QVar · 12 unmodified lines | |||
| 366 | * <p>When getting using {@link Pointers.getPointerProperties}, the ID of the overlay rendered at the end of the parabola; | 366 | * <p>When getting using {@link Pointers.getPointerProperties}, the ID of the overlay rendered at the end of the parabola; |
| 367 | * <code>null</code> if there is no overlay. | 367 | * <code>null</code> if there is no overlay. |
| 368 | */ | 368 | */ |
| 369 | /**jsdoc | 369 | /*@jsdoc |
| 370 | * The properties of a parabola pointer. These include the properties from the underlying parabola pick that the pointer uses. | 370 | * The properties of a parabola pointer. These include the properties from the underlying parabola pick that the pointer uses. |
| 371 | * @typedef {object} Pointers.ParabolaPointerProperties | 371 | * @typedef {object} Pointers.ParabolaPointerProperties |
| 372 | * @property {boolean} [faceAvatar=false] - <code>true</code> if the overlay rendered at the end of the ray rotates about the | 372 | * @property {boolean} [faceAvatar=false] - <code>true</code> if the overlay rendered at the end of the ray rotates about the |