Showing the changes to interface/src/ui/overlays/RectangleOverlay.cpp (1 of 44 files). Show all
Unified · Split
| @@ -11,29 +11,6 @@ · 10 unmodified lines | |||
| 11 | QString const RectangleOverlay::TYPE = "rectangle"; | 11 | QString const RectangleOverlay::TYPE = "rectangle"; |
| 12 | QUrl const RectangleOverlay::URL(QString("hifi/overlays/RectangleOverlay.qml")); | 12 | QUrl const RectangleOverlay::URL(QString("hifi/overlays/RectangleOverlay.qml")); |
| 13 | 13 | ||
| 14 | // RectangleOverlay's properties are defined in the QML file specified above. | ||
| 15 | /**jsdoc | ||
| 16 | * These are the properties of a <code>rectangle</code> {@link Overlays.OverlayType|OverlayType}. | ||
| 17 | * @typedef {object} Overlays.RectangleProperties | ||
| 18 | * | ||
| 19 | * @property {Rect} bounds - The position and size of the rectangle, in pixels. <em>Write-only.</em> | ||
| 20 | * @property {number} x - Integer left, x-coordinate value = <code>bounds.x</code>. <em>Write-only.</em> | ||
| 21 | * @property {number} y - Integer top, y-coordinate value = <code>bounds.y</code>. <em>Write-only.</em> | ||
| 22 | * @property {number} width - Integer width of the rectangle = <code>bounds.width</code>. <em>Write-only.</em> | ||
| 23 | * @property {number} height - Integer height of the rectangle = <code>bounds.height</code>. <em>Write-only.</em> | ||
| 24 | * | ||
| 25 | * @property {Color} color=0,0,0 - The color of the overlay. <em>Write-only.</em> | ||
| 26 | * @property {number} alpha=1.0 - The opacity of the overlay, <code>0.0</code> - <code>1.0</code>. <em>Write-only.</em> | ||
| 27 | * @property {number} borderWidth=1 - Integer width of the border, in pixels. The border is drawn within the rectangle's bounds. | ||
| 28 | * It is not drawn unless either <code>borderColor</code> or <code>borderAlpha</code> are specified. <em>Write-only.</em> | ||
| 29 | * @property {number} radius=0 - Integer corner radius, in pixels. <em>Write-only.</em> | ||
| 30 | * @property {Color} borderColor=0,0,0 - The color of the border. <em>Write-only.</em> | ||
| 31 | * @property {number} borderAlpha=1.0 - The opacity of the border, <code>0.0</code> - <code>1.0</code>. | ||
| 32 | * <em>Write-only.</em> | ||
| 33 | * @property {boolean} visible=true - If <code>true</code>, the overlay is rendered, otherwise it is not rendered. | ||
| 34 | * <em>Write-only.</em> | ||
| 35 | */ | ||
| 36 | |||
| 37 | RectangleOverlay::RectangleOverlay() : QmlOverlay(URL) {} | 14 | RectangleOverlay::RectangleOverlay() : QmlOverlay(URL) {} |
| 38 | 15 | ||
| 39 | RectangleOverlay::RectangleOverlay(const RectangleOverlay* rectangleOverlay) | 16 | RectangleOverlay::RectangleOverlay(const RectangleOverlay* rectangleOverlay) |