SkeletonC.cpp File Reference

Implementation. More...

#include <osvr/Client/Skeleton.h>
#include <osvr/ClientKit/SkeletonC.h>
#include <osvr/Util/Verbosity.h>
#include <boost/assert.hpp>
#include <exception>

Macros
#define	OSVR_VALIDATE_OUTPUT_PTR(X, DESC)
#define	OSVR_VALIDATE_SKELETON_CONFIG

Functions
OSVR_ReturnCode	osvrClientGetSkeletonBoneId (OSVR_Skeleton skel, const char *boneName, OSVR_SkeletonBoneCount *boneId)
	OSVR_Skeleton provides an API to iterate over articulation tree and get skeleton related information such as joint, bone states, get number of joints, etc. More...
OSVR_ReturnCode	osvrClientGetSkeletonStringBoneNameLength (OSVR_Skeleton skel, OSVR_SkeletonBoneCount boneId, uint32_t *len)
	Get the length of a string parameter associated with the given boneId. More...
OSVR_ReturnCode	osvrClientGetSkeletonBoneName (OSVR_Skeleton skel, OSVR_SkeletonBoneCount boneId, char *boneName, uint32_t len)
	Convert the boneId to the bone name. More...
OSVR_ReturnCode	osvrClientGetSkeletonBoneState (OSVR_Skeleton skel, OSVR_SkeletonBoneCount boneId, OSVR_SkeletonBoneState *state)
	Get skeleton bone state for given boneId. More...
OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode	osvrClientGetSkeletonAvailableJointId (OSVR_Skeleton skel, OSVR_SkeletonJointCount jointIndex, OSVR_SkeletonJointCount *jointId)
	Get the jointId for a given available joint. More...
OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode	osvrClientGetSkeletonAvailableBoneId (OSVR_Skeleton skel, OSVR_SkeletonBoneCount boneIndex, OSVR_SkeletonBoneCount *boneId)
	Get the boneId for a given available bone. More...
OSVR_ReturnCode	osvrClientGetSkeletonJointId (OSVR_Skeleton skel, const char *jointName, OSVR_SkeletonJointCount *jointId)
	Convert a given jointName to the jointId. More...
OSVR_ReturnCode	osvrClientGetSkeletonStringJointNameLength (OSVR_Skeleton skel, OSVR_SkeletonJointCount jointId, uint32_t *len)
	Get the length of a string parameter associated with the given jointId. More...
OSVR_ReturnCode	osvrClientGetSkeletonJointName (OSVR_Skeleton skel, OSVR_SkeletonJointCount jointId, char *jointName, uint32_t len)
	Convert the jointId to the joint name. More...
OSVR_ReturnCode	osvrClientGetSkeletonJointState (OSVR_Skeleton skel, OSVR_SkeletonJointCount jointId, OSVR_SkeletonJointState *state)
	Get skeleton joint state for given joint Id. More...
OSVR_ReturnCode	osvrClientGetSkeletonNumBones (OSVR_Skeleton skel, OSVR_SkeletonBoneCount *numBones)
	Get the number of bones available for a given skeleton. More...
OSVR_ReturnCode	osvrClientGetSkeletonNumJoints (OSVR_Skeleton skel, OSVR_SkeletonJointCount *numJoints)
	Get the number of joints available for a given skeleton. More...

Detailed Description

Implementation.

Date

2015

Author

Sensics, Inc. http://sensics.com/osvr

Macro Definition Documentation

OSVR_VALIDATE_OUTPUT_PTR

#define OSVR_VALIDATE_OUTPUT_PTR	(		X,
			DESC
	)

Value:

OSVR_UTIL_MULTILINE_BEGIN                                                  \
    if (nullptr == X) {                                                        \
        OSVR_DEV_VERBOSE("Passed a null pointer for output parameter " #X      \
                         ", " DESC "!");                                       \
        return OSVR_RETURN_FAILURE;                                            \
    }                                                                          \
    OSVR_UTIL_MULTILINE_END

OSVR_VALIDATE_SKELETON_CONFIG

#define OSVR_VALIDATE_SKELETON_CONFIG

Value:

OSVR_UTIL_MULTILINE_BEGIN                                                  \
    if (nullptr == skel) {                                                     \
        OSVR_DEV_VERBOSE("Passed a null skeleton object!");                    \
        return OSVR_RETURN_FAILURE;                                            \
    }                                                                          \
    OSVR_UTIL_MULTILINE_END