Overte C++ Documentation
GizmoType.h
1 //
2 // Created by Sam Gondelman on 1/22/19.
3 // Copyright 2019 High Fidelity, Inc.
4 //
5 // Distributed under the Apache License, Version 2.0.
6 // See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
7 //
8 
9 #ifndef hifi_GizmoType_h
10 #define hifi_GizmoType_h
11 
12 #include "QString"
13 
14 /*@jsdoc
15  * <p>A {@link Entities.EntityProperties-Gizmo|Gizmo} entity may be one of the following types:</p>
16  * <table>
17  * <thead>
18  * <tr><th>Value</th><th>Description</th></tr>
19  * </thead>
20  * <tbody>
21  * <tr><td><code>"ring"</code></td><td>A ring gizmo.</td></tr>
22  * </tbody>
23  * </table>
24  * @typedef {string} Entities.GizmoType
25  */
26 
27 enum GizmoType {
28  RING = 0,
29  // put new gizmo-types before this line.
30  UNSET_GIZMO_TYPE
31 };
32 
33 class GizmoTypeHelpers {
34 public:
35  static QString getNameForGizmoType(GizmoType mode);
36 };
37 
38 #endif // hifi_GizmoType_h
39