Overte C++ Documentation
PulseMode.h
1 //
2 // Created by Sam Gondelman on 1/15/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_PulseMode_h
10 #define hifi_PulseMode_h
11 
12 #include "QString"
13 
14 /*@jsdoc
15  * <p>Pulse modes for color and alpha pulsing.</p>
16  * <table>
17  * <thead>
18  * <tr><th>Value</th><th>Description</th></tr>
19  * </thead>
20  * <tbody>
21  * <tr><td><code>"none"</code></td><td>No pulsing.</td></tr>
22  * <tr><td><code>"in"</code></td><td>Pulse in phase with the pulse period.</td></tr>
23  * <tr><td><code>"out"</code></td><td>Pulse out of phase with the pulse period.</td></tr>
24  * </tbody>
25  * </table>
26  * @typedef {string} Entities.PulseMode
27  */
28 
29 enum class PulseMode {
30  NONE = 0,
31  IN_PHASE,
32  OUT_PHASE
33 };
34 
35 class PulseModeHelpers {
36 public:
37  static QString getNameForPulseMode(PulseMode mode);
38 };
39 
40 #endif // hifi_PulseMode_h
41