gecko-dev/dom/gamepad/GamepadHapticActuator.cpp
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

81 lines
2.8 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/. */
#include "mozilla/dom/GamepadHapticActuator.h"
#include "mozilla/dom/GamepadManager.h"
#include "mozilla/dom/Promise.h"
namespace mozilla::dom {
NS_IMPL_CYCLE_COLLECTING_ADDREF(GamepadHapticActuator)
NS_IMPL_CYCLE_COLLECTING_RELEASE(GamepadHapticActuator)
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(GamepadHapticActuator)
NS_WRAPPERCACHE_INTERFACE_MAP_ENTRY
NS_INTERFACE_MAP_ENTRY(nsISupports)
NS_INTERFACE_MAP_END
NS_IMPL_CYCLE_COLLECTION_WRAPPERCACHE(GamepadHapticActuator, mParent)
GamepadHapticActuator::GamepadHapticActuator(nsISupports* aParent,
GamepadHandle aGamepadHandle,
uint32_t aIndex)
: mParent(aParent),
mGamepadHandle(aGamepadHandle),
mType(GamepadHapticActuatorType::Vibration),
mIndex(aIndex) {}
/* virtual */
JSObject* GamepadHapticActuator::WrapObject(JSContext* aCx,
JS::Handle<JSObject*> aGivenProto) {
return GamepadHapticActuator_Binding::Wrap(aCx, this, aGivenProto);
}
nsISupports* GamepadHapticActuator::GetParentObject() const { return mParent; }
#define CLAMP(f, min, max) (((f) < min) ? min : (((f) > max) ? max : (f)))
already_AddRefed<Promise> GamepadHapticActuator::Pulse(double aValue,
double aDuration,
ErrorResult& aRv) {
nsCOMPtr<nsIGlobalObject> global = do_QueryInterface(GetParentObject());
MOZ_ASSERT(global);
RefPtr<GamepadManager> gamepadManager(GamepadManager::GetService());
MOZ_ASSERT(gamepadManager);
// Clamp intensity aValue to be 0~1.
double value = CLAMP(aValue, 0, 1);
// aDuration should be always positive.
double duration = CLAMP(aDuration, 0, aDuration);
switch (mType) {
case GamepadHapticActuatorType::Vibration: {
RefPtr<Promise> promise = gamepadManager->VibrateHaptic(
mGamepadHandle, mIndex, value, duration, global, aRv);
if (!promise) {
return nullptr;
}
return promise.forget();
}
default: {
// We need to implement other types of haptic
MOZ_ASSERT(false);
return nullptr;
}
}
}
GamepadHapticActuatorType GamepadHapticActuator::Type() const { return mType; }
void GamepadHapticActuator::Set(const GamepadHapticActuator* aOther) {
mGamepadHandle = aOther->mGamepadHandle;
mType = aOther->mType;
mIndex = aOther->mIndex;
}
} // namespace mozilla::dom