LeapDevice.h

// This file is a part of the OpenSurgSim project.
// Copyright 2013-2015, SimQuest Solutions Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef SURGSIM_DEVICES_LEAP_LEAPDEVICE_H
#define SURGSIM_DEVICES_LEAP_LEAPDEVICE_H

#include <memory>

#include "SurgSim/DataStructures/OptionalValue.h"
#include "SurgSim/Input/CommonDevice.h"


namespace SurgSim
{
namespace Devices
{

class LeapScaffold;

SURGSIM_STATIC_REGISTRATION(LeapDevice);

enum HandType : SURGSIM_ENUM_TYPE;

class LeapDevice : public SurgSim::Input::CommonDevice
{
public:
    explicit LeapDevice(const std::string& name);

    SURGSIM_CLASSNAME(SurgSim::Devices::LeapDevice);

    virtual ~LeapDevice();

    void setHandType(HandType type);

    HandType getHandType() const;

    void setUseHmdTrackingMode(bool useHmdTrackingMode);

    bool isUsingHmdTrackingMode() const;

    void setProvideImages(bool provideImages);

    bool isProvidingImages() const;

    bool initialize() override;

    bool isInitialized() const override;

private:
    friend class LeapScaffold;

    bool finalize() override;

    std::shared_ptr<LeapScaffold> m_scaffold;

    HandType m_handType;

    DataStructures::OptionalValue<bool> m_requestedHmdTrackingMode;

    bool m_isProvidingImages;
};

};
};

SURGSIM_SERIALIZABLE_ENUM(SurgSim::Devices::HandType, (HANDTYPE_LEFT)(HANDTYPE_RIGHT));

#endif //SURGSIM_DEVICES_LEAP_LEAPDEVICE_H