summaryrefslogtreecommitdiff
path: root/gfx/vr/osvr/Util/Pose3C.h
blob: 173428cfcb2746315cf646b748d8970190cdfda3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
/** @file
    @brief Header

    Must be c-safe!

    @date 2014

    @author
    Sensics, Inc.
    <http://sensics.com/osvr>
*/

/*
// Copyright 2014 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_Pose3C_h_GUID_066CFCE2_229C_4194_5D2B_2602CCD5C439
#define INCLUDED_Pose3C_h_GUID_066CFCE2_229C_4194_5D2B_2602CCD5C439

/* Internal Includes */

/* Internal Includes */
#include <osvr/Util/APIBaseC.h>
#include <osvr/Util/Vec3C.h>
#include <osvr/Util/QuaternionC.h>

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

/* Standard includes */
/* none */

OSVR_EXTERN_C_BEGIN

/** @addtogroup UtilMath
    @{
*/

/** @brief A structure defining a 3D (6DOF) rigid body pose: translation and
    rotation.
*/
typedef struct OSVR_Pose3 {
    /** @brief Position vector */
    OSVR_Vec3 translation;
    /** @brief Orientation as a unit quaternion */
    OSVR_Quaternion rotation;
} OSVR_Pose3;

/** @brief Set a pose to identity */
OSVR_INLINE void osvrPose3SetIdentity(OSVR_Pose3 *pose) {
    osvrQuatSetIdentity(&(pose->rotation));
    osvrVec3Zero(&(pose->translation));
}
/** @} */

OSVR_EXTERN_C_END

#endif