src/Aspect/Aspect_XRHapticActionData.hxx

   1 // Copyright (c) 2020 OPEN CASCADE SAS
   2 //
   3 // This file is part of Open CASCADE Technology software library.
   4 //
   5 // This library is free software; you can redistribute it and/or modify it under
   6 // the terms of the GNU Lesser General Public License version 2.1 as published
   7 // by the Free Software Foundation, with special exception defined in the file
   8 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
   9 // distribution for complete text of the license and disclaimer of any warranty.
  10 //
  11 // Alternatively, this file may be used under the terms of Open CASCADE
  12 // commercial license or contractual agreement.
  13
  14 #ifndef _Aspect_XRHapticActionData_HeaderFile
  15 #define _Aspect_XRHapticActionData_HeaderFile
  16
  17 //! Haptic output XR action data.
  18 struct Aspect_XRHapticActionData
  19 {
  20   float Delay;     //!< delay in seconds before start
  21   float Duration;  //!< duration in seconds
  22   float Frequency; //!< vibration frequency
  23   float Amplitude; //!< vibration amplitude
  24
  25   //! Return TRUE if data is not empty.
  26   bool IsValid() const
  27   {
  28     return Duration > 0.0f
  29         && Amplitude > 0.0f
  30         && Frequency > 0.0f
  31         && Delay >= 0.0f;
  32   }
  33
  34   //! Empty constructor.
  35   Aspect_XRHapticActionData() : Delay (0.0f), Duration (0.0f), Frequency (0.0f), Amplitude (0.0f) {}
  36 };
  37
  38 #endif // _Aspect_XRHapticActionData_HeaderFile