SkeletonComponent.h

Go to the documentation of this file.

// Copyright 2015 Sensics, 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 INCLUDED_SkeletonComponent_h_GUID_53FA481D_05BD_4CA5_3A50_FE01B600476E
#define INCLUDED_SkeletonComponent_h_GUID_53FA481D_05BD_4CA5_3A50_FE01B600476E

// Internal Includes
#include <osvr/Common/CommonComponent_fwd.h>
#include <osvr/Common/DeviceComponent.h>
#include <osvr/Common/Export.h>
#include <osvr/Common/PathTree.h>
#include <osvr/Common/SerializationTags.h>
#include <osvr/Util/ChannelCountC.h>
#include <osvr/Util/ClientReportTypesC.h>
#include <osvr/Util/ReturnCodesC.h>

// Library/third-party includes
#include <json/value.h>
#include <vrpn_BaseClass.h>

// Standard includes
#include <string>

namespace osvr {
namespace common {

    struct SkeletonNotification {
        OSVR_ChannelCount sensor;
    };

    struct SkeletonSpec {
        Json::Value spec;
    };

    namespace messages {
        class SkeletonRecord : public MessageRegistration<SkeletonRecord> {
          public:
            class MessageSerialization;

            static const char *identifier();
        };
        class SkeletonSpecRecord
            : public MessageRegistration<SkeletonSpecRecord> {
          public:
            class MessageSerialization;

            static const char *identifier();
        };

    } // namespace messages

    class SkeletonComponent : public DeviceComponent {
      public:
        static OSVR_COMMON_EXPORT shared_ptr<SkeletonComponent>
        create(std::string const &jsonSpec);

        messages::SkeletonRecord skeletonRecord;

        messages::SkeletonSpecRecord skeletonSpecRecord;

        OSVR_COMMON_EXPORT void
        sendNotification(OSVR_ChannelCount sensor,
                         OSVR_TimeValue const &timestamp);

        OSVR_COMMON_EXPORT void sendArticulationSpec(std::string const &spec);

        OSVR_COMMON_EXPORT OSVR_ReturnCode
        setArticulationSpec(std::string const &jsonDescriptor);

        typedef std::function<void(SkeletonNotification const &,
                                   util::time::TimeValue const &)>
            SkeletonHandler;
        typedef std::function<void(SkeletonSpec const &,
                                   util::time::TimeValue const &)>
            SkeletonSpecHandler;
        OSVR_COMMON_EXPORT void registerSkeletonHandler(SkeletonHandler cb);
        OSVR_COMMON_EXPORT void
        registerSkeletonSpecHandler(SkeletonSpecHandler cb);

      private:
        SkeletonComponent(std::string const &jsonSpec);
        virtual void m_parentSet();

        static int VRPN_CALLBACK m_handleSkeletonRecord(void *userdata,
                                                        vrpn_HANDLERPARAM p);
        static int VRPN_CALLBACK
        m_handleSkeletonSpecRecord(void *userdata, vrpn_HANDLERPARAM p);
        std::string m_spec;
        std::vector<SkeletonHandler> m_cb;
        std::vector<SkeletonSpecHandler> m_cb_spec;
        common::CommonComponent *m_commonComponent;
    };

} // namespace common
} // namespace osvr

#endif // INCLUDED_SkeletonComponent_h_GUID_53FA481D_05BD_4CA5_3A50_FE01B600476E