SkeletonC.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_SkeletonC_h_GUID_999D5F46_F1C3_41B5_0EEC_9746ACBA9270
#define INCLUDED_SkeletonC_h_GUID_999D5F46_F1C3_41B5_0EEC_9746ACBA9270

/* Internal Includes */
#include <osvr/ClientKit/Export.h>
#include <osvr/Util/APIBaseC.h>
#include <osvr/Util/ClientReportTypesC.h>
#include <osvr/Util/ReturnCodesC.h>
#include <osvr/Util/SkeletonC.h>

/* Library/third-party includes */
/* none */

/* Standard includes */
#include <stdint.h>

OSVR_EXTERN_C_BEGIN

OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetSkeletonBoneId(
    OSVR_Skeleton skel, const char *boneName, OSVR_SkeletonBoneCount *boneId);

OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetSkeletonStringBoneNameLength(
    OSVR_Skeleton skel, OSVR_SkeletonBoneCount boneId, uint32_t *len);

OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode
osvrClientGetSkeletonBoneName(OSVR_Skeleton skel, OSVR_SkeletonBoneCount boneId,
                              char *boneName, uint32_t len);

OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetSkeletonBoneState(
    OSVR_Skeleton skel, OSVR_SkeletonBoneCount boneId,
    OSVR_SkeletonBoneState *state);

OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetSkeletonAvailableJointId(
    OSVR_Skeleton skel, OSVR_SkeletonJointCount jointIndex,
    OSVR_SkeletonJointCount *jointId);

OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetSkeletonAvailableBoneId(
    OSVR_Skeleton skel, OSVR_SkeletonBoneCount boneIndex,
    OSVR_SkeletonBoneCount *boneId);

OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode
osvrClientGetSkeletonJointId(OSVR_Skeleton skel, const char *jointName,
                             OSVR_SkeletonJointCount *jointId);

OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode
osvrClientGetSkeletonStringJointNameLength(OSVR_Skeleton skel,
                                           OSVR_SkeletonJointCount jointId,
                                           uint32_t *len);

OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetSkeletonJointName(
    OSVR_Skeleton skel, OSVR_SkeletonJointCount boneId, char *jointName,
    uint32_t len);

OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetSkeletonJointState(
    OSVR_Skeleton skel, OSVR_SkeletonJointCount jointId,
    OSVR_SkeletonJointState *state);

OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetSkeletonNumBones(
    OSVR_Skeleton skel, OSVR_SkeletonBoneCount *numBones);

OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetSkeletonNumJoints(
    OSVR_Skeleton skel, OSVR_SkeletonJointCount *numJoints);

OSVR_EXTERN_C_END

#endif // INCLUDED_SkeletonC_h_GUID_999D5F46_F1C3_41B5_0EEC_9746ACBA9270