Developer Documentation

prototypeVec3d.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4 * Copyright (c) 2001-2015, RWTH-Aachen University *
5 * Department of Computer Graphics and Multimedia *
6 * All rights reserved. *
7 * www.openflipper.org *
8 * *
9 *---------------------------------------------------------------------------*
10 * This file is part of OpenFlipper. *
11 *---------------------------------------------------------------------------*
12 * *
13 * Redistribution and use in source and binary forms, with or without *
14 * modification, are permitted provided that the following conditions *
15 * are met: *
16 * *
17 * 1. Redistributions of source code must retain the above copyright notice, *
18 * this list of conditions and the following disclaimer. *
19 * *
20 * 2. Redistributions in binary form must reproduce the above copyright *
21 * notice, this list of conditions and the following disclaimer in the *
22 * documentation and/or other materials provided with the distribution. *
23 * *
24 * 3. Neither the name of the copyright holder nor the names of its *
25 * contributors may be used to endorse or promote products derived from *
26 * this software without specific prior written permission. *
27 * *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41
42
72 #ifndef PROTOTYPEVEC3D_HH
73 #define PROTOTYPEVEC3D_HH
74
75
76 #include <QtCore/QObject>
77 #include <QtScript/QtScript>
78
86 class prototypeVec3d : public QObject , public QScriptable
87 {
88 Q_OBJECT
89
90 public:
91 explicit prototypeVec3d(QObject *parent = 0);
92
93 public slots:
98 void multiply(QScriptValue _scalar);
99
104 void add(QScriptValue _vector);
105
110 void sub(QScriptValue _vector);
111
115 void zero();
116
117
123 QScriptValue sprod(QScriptValue _vector);
124
129 QScriptValue norm();
130
135 QScriptValue sqrnorm();
136
137
140 void normalize();
141
142 public Q_SLOTS:
143 QString toString() const;
144
145 };
146
147
148 #endif // PROTOTYPEVEC3D_HH
149
prototypeVec3d::sqrnorm
QScriptValue sqrnorm()
Calculate the squared Euclidean norm of the vector.
Definition: prototypeVec3d.cc:98
prototypeVec3d::zero
void zero()
Resets all components of the vector to zero.
Definition: prototypeVec3d.cc:79
prototypeVec3d::sub
void sub(QScriptValue _vector)
Subtracts another vector from this vector.
Definition: prototypeVec3d.cc:73
prototypeVec3d::norm
QScriptValue norm()
Calculate the Euclidean norm of the vector.
Definition: prototypeVec3d.cc:92
prototypeVec3d::normalize
void normalize()
Normalize the vector.
Definition: prototypeVec3d.cc:104
prototypeVec3d::add
void add(QScriptValue _vector)
Adds another vector to this vector.
Definition: prototypeVec3d.cc:66
prototypeVec3d::multiply
void multiply(QScriptValue _scalar)
Multiplies the given vector with the scalar.
Definition: prototypeVec3d.cc:60
prototypeVec3d
Definition: prototypeVec3d.hh:86
prototypeVec3d::sprod
QScriptValue sprod(QScriptValue _vector)
Calculate scalar product.
Definition: prototypeVec3d.cc:85