gecko-dev/dom/gamepad/GamepadHapticActuator.h
Chris Martin 886c2c65a8 Bug 1657404 - Implement a strongly-typed, service-dependent gamepad handle r=handyman,aklotz
Currently, the gamepad code uses a uint32_t as a handle and does some trickery
with it by trying to create a unique ID and adding an offset to it for VR code.

This can (and has) led to errors where the developer forgets to perform the
arithmetic and sends the wrong number to the wrong manager.

This change created a strongly-typed handle that remembers which service it
belongs to. This should eliminate such accidents.

Differential Revision: https://phabricator.services.mozilla.com/D96273
2020-12-02 23:06:05 +00:00

54 lines
1.6 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_dom_gamepad_GamepadHapticActuator_h
#define mozilla_dom_gamepad_GamepadHapticActuator_h
#include "nsCOMPtr.h"
#include "nsWrapperCache.h"
#include "mozilla/dom/GamepadHapticActuatorBinding.h"
#include "mozilla/dom/Gamepad.h"
#include "mozilla/dom/GamepadHandle.h"
namespace mozilla {
namespace dom {
class Promise;
class GamepadHapticActuator : public nsISupports, public nsWrapperCache {
public:
GamepadHapticActuator(nsISupports* aParent, GamepadHandle aGamepadHandle,
uint32_t aIndex);
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(GamepadHapticActuator)
nsISupports* GetParentObject() const;
virtual JSObject* WrapObject(JSContext* aCx,
JS::Handle<JSObject*> aGivenProto) override;
already_AddRefed<Promise> Pulse(double aValue, double aDuration,
ErrorResult& aRv);
GamepadHapticActuatorType Type() const;
void Set(const GamepadHapticActuator* aOther);
private:
virtual ~GamepadHapticActuator() = default;
protected:
nsCOMPtr<nsISupports> mParent;
GamepadHandle mGamepadHandle;
GamepadHapticActuatorType mType;
uint32_t mIndex;
};
} // namespace dom
} // namespace mozilla
#endif // mozilla_dom_gamepad_GamepadHapticActuator_h