9ea18345b487743d08d7f7021653da3612645697
[WebKit-https.git] / Source / WebCore / dom / DeviceMotionEvent.h
1 /*
2  * Copyright (C) 2010 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #pragma once
27
28 #include "DeviceOrientationOrMotionEvent.h"
29 #include "Event.h"
30
31 namespace WebCore {
32
33 class DeviceMotionData;
34
35 class DeviceMotionEvent final : public Event, public DeviceOrientationOrMotionEvent {
36 public:
37     virtual ~DeviceMotionEvent();
38
39     // FIXME: Merge this with DeviceMotionData::Acceleration
40     struct Acceleration {
41         Optional<double> x;
42         Optional<double> y;
43         Optional<double> z;
44     };
45
46     // FIXME: Merge this with DeviceMotionData::RotationRate
47     struct RotationRate {
48         Optional<double> alpha;
49         Optional<double> beta;
50         Optional<double> gamma;
51     };
52
53     static Ref<DeviceMotionEvent> create(const AtomString& eventType, DeviceMotionData* deviceMotionData)
54     {
55         return adoptRef(*new DeviceMotionEvent(eventType, deviceMotionData));
56     }
57
58     static Ref<DeviceMotionEvent> createForBindings()
59     {
60         return adoptRef(*new DeviceMotionEvent);
61     }
62
63     Optional<Acceleration> acceleration() const;
64     Optional<Acceleration> accelerationIncludingGravity() const;
65     Optional<RotationRate> rotationRate() const;
66     Optional<double> interval() const;
67
68     void initDeviceMotionEvent(const AtomString& type, bool bubbles, bool cancelable, Optional<Acceleration>&&, Optional<Acceleration>&&, Optional<RotationRate>&&, Optional<double>);
69
70 private:
71     DeviceMotionEvent();
72     DeviceMotionEvent(const AtomString& eventType, DeviceMotionData*);
73
74     EventInterface eventInterface() const override;
75
76     RefPtr<DeviceMotionData> m_deviceMotionData;
77 };
78
79 } // namespace WebCore