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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
/**************************************************************************\
*
* This file is part of the Coin 3D visualization library.
* Copyright (C) by Kongsberg Oil & Gas Technologies.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* ("GPL") version 2 as published by the Free Software Foundation.
* See the file LICENSE.GPL at the root directory of this source
* distribution for additional information about the GNU GPL.
*
* For using Coin with software that can not be combined with the GNU
* GPL, and for taking advantage of the additional benefits of our
* support services, please contact Kongsberg Oil & Gas Technologies
* about acquiring a Coin Professional Edition License.
*
* See http://www.coin3d.org/ for more information.
*
* Kongsberg Oil & Gas Technologies, Bygdoy Alle 5, 0257 Oslo, NORWAY.
* http://www.sim.no/ sales@sim.no coin-support@coin3d.org
*
\**************************************************************************/
/*!
\class SoSFRotation SoSFRotation.h Inventor/fields/SoSFRotation.h
\brief The SoSFRotation class is a container for an SbRotation.
\ingroup fields
This field is used where nodes, engines or other field containers
needs to store a single rotation definition.
Fields of this type stores their value to file as a rotation axis
vector plus a rotation angle: "axis0 axis1 axis2 angle".
Note that there is one \e very common mistake that is easy to make
when setting the value of an SoSFRotation field, and that is to
inadvertently use the wrong SbRotation constructor. This example
should clarify the problem:
\code
mytransformnode->rotation.setValue(0, 0, 1, 1.5707963f);
\endcode
The programmer clearly tries to set a PI/2 rotation around the Z
axis, but this will fail, as the SbRotation constructor invoked
above is the one that takes as arguments the 4 floats of a \e
quaternion. What the programmer almost certainly wanted to do was to
use the SbRotation constructor that takes a rotation vector and a
rotation angle, which is invoked like this:
\code
mytransformnode->rotation.setValue(SbVec3f(0, 0, 1), 1.5707963f);
\endcode
\sa SoMFRotation
*/
// *************************************************************************
#include <Inventor/fields/SoSFRotation.h>
#include <Inventor/SbVec3f.h>
#include <Inventor/errors/SoDebugError.h>
#include "fields/SoSubFieldP.h"
#include "fields/shared.h"
// *************************************************************************
SO_SFIELD_SOURCE(SoSFRotation, SbRotation, const SbRotation &);
// *************************************************************************
// Override from parent.
void
SoSFRotation::initClass(void)
{
SO_SFIELD_INTERNAL_INIT_CLASS(SoSFRotation);
}
// *************************************************************************
// No need to document readValue() and writeValue() here, as the
// necessary information is provided by the documentation of the
// parent classes.
#ifndef DOXYGEN_SKIP_THIS
SbBool
SoSFRotation::readValue(SoInput * in)
{
SbRotation r;
if (!sosfrotation_read_value(in, r)) return FALSE;
this->setValue(r);
return TRUE;
}
void
SoSFRotation::writeValue(SoOutput * out) const
{
sosfrotation_write_value(out, this->getValue());
}
#endif // DOXYGEN_SKIP_THIS
// *************************************************************************
/*!
Return value of rotation as an \a axis and an \a angle around this
\a axis.
*/
void
SoSFRotation::getValue(SbVec3f & axis, float & angle) const
{
this->getValue().getValue(axis, angle);
}
/*!
Set the rotation from a set of quaternion values.
*/
void
SoSFRotation::setValue(const float q0, const float q1,
const float q2, const float q3)
{
this->setValue(SbRotation(q0, q1, q2, q3));
}
/*!
Set the rotation from a set of quaternion values.
*/
void
SoSFRotation::setValue(const float q[4])
{
this->setValue(SbRotation(q));
}
/*!
Set the rotation from an \a axis and an \a angle around
this \a axis.
*/
void
SoSFRotation::setValue(const SbVec3f & axis, const float angle)
{
this->setValue(SbRotation(axis, angle));
}
// *************************************************************************
#ifdef COIN_TEST_SUITE
BOOST_AUTO_TEST_CASE(initialized)
{
SoSFRotation field;
BOOST_CHECK_MESSAGE(SoSFRotation::getClassTypeId() != SoType::badType(),
"SoSFRotation class not initialized");
BOOST_CHECK_MESSAGE(field.getTypeId() != SoType::badType(),
"missing class initialization");
}
#endif // COIN_TEST_SUITE
|