include/opencascade/Aspect_XRHapticActionData.hxx

0001 // Copyright (c) 2020 OPEN CASCADE SAS
0002 //
0003 // This file is part of Open CASCADE Technology software library.
0004 //
0005 // This library is free software; you can redistribute it and/or modify it under
0006 // the terms of the GNU Lesser General Public License version 2.1 as published
0007 // by the Free Software Foundation, with special exception defined in the file
0008 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0009 // distribution for complete text of the license and disclaimer of any warranty.
0010 //
0011 // Alternatively, this file may be used under the terms of Open CASCADE
0012 // commercial license or contractual agreement.
0013
0014 #ifndef _Aspect_XRHapticActionData_HeaderFile
0015 #define _Aspect_XRHapticActionData_HeaderFile
0016
0017 //! Haptic output XR action data.
0018 struct Aspect_XRHapticActionData
0019 {
0020   float Delay;     //!< delay in seconds before start
0021   float Duration;  //!< duration in seconds
0022   float Frequency; //!< vibration frequency
0023   float Amplitude; //!< vibration amplitude
0024
0025   //! Return TRUE if data is not empty.
0026   bool IsValid() const
0027   {
0028     return Duration > 0.0f && Amplitude > 0.0f && Frequency > 0.0f && Delay >= 0.0f;
0029   }
0030
0031   //! Empty constructor.
0032   Aspect_XRHapticActionData()
0033       : Delay(0.0f),
0034         Duration(0.0f),
0035         Frequency(0.0f),
0036         Amplitude(0.0f)
0037   {
0038   }
0039 };
0040
0041 #endif // _Aspect_XRHapticActionData_HeaderFile