prototypeVec3d.hh 6.31 KB
 Jan Möbius committed Aug 05, 2009 1 /*===========================================================================*\  Jan Möbius committed Nov 25, 2010 2 3 * * * OpenFlipper *  Martin Schultz committed Jul 16, 2015 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  * Copyright (c) 2001-2015, RWTH-Aachen University * * Department of Computer Graphics and Multimedia * * All rights reserved. * * www.openflipper.org * * * *---------------------------------------------------------------------------* * This file is part of OpenFlipper. * *---------------------------------------------------------------------------* * * * Redistribution and use in source and binary forms, with or without * * modification, are permitted provided that the following conditions * * are met: * * * * 1. Redistributions of source code must retain the above copyright notice, * * this list of conditions and the following disclaimer. * * * * 2. Redistributions in binary form must reproduce the above copyright * * notice, this list of conditions and the following disclaimer in the * * documentation and/or other materials provided with the distribution. * * * * 3. Neither the name of the copyright holder nor the names of its * * contributors may be used to endorse or promote products derived from * * this software without specific prior written permission. * * * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED * * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A * * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER * * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, * * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, * * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR * * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF * * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING * * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *  Jan Möbius committed Nov 25, 2010 39 * *  Jan Möbius committed Aug 05, 2009 40 41 42 \*===========================================================================*/ /*===========================================================================*\  Jan Möbius committed Nov 25, 2010 43 44 45 46 47 * * * $Revision$ * * $LastChangedBy$ * * $Date$ * * *  Jan Möbius committed Aug 05, 2009 48 \*===========================================================================*/  Jan Möbius committed Aug 29, 2008 49 50 51 52 53 54 55 56 57 58  // // C++ Interface: prototypeVec3d // // Description: // //  Jan Möbius committed Jun 28, 2012 59 // Author: Jan Möbius , (C) 2007  Jan Möbius committed Aug 29, 2008 60 61 //  Jan Möbius committed Jun 28, 2012 62 63 /** \page scripting_vector_type Vector data type for scripting *  Jan Möbius committed Jun 29, 2012 64 65  * The vector data type is corresponding to the Vec3d type in C++. The implementation of the * scripting type is done in prototypeVec3d.  Jan Möbius committed Jun 28, 2012 66 67 68 69 70 71  * * You can use the following functions: * \code * var vec = Vector(1,2,3) * var vec2 = Vector(10,20,30) *  Jan Möbius committed Jun 29, 2012 72 73 74 75 76 77 78 79 80 81 82 83 84 85  * vec.multiply(0.5) // Multiply vec with 0.5 * vec.add(vec2) // Add vec2 to vec * vec.sub(vec2) // Subtract vec2 from vec * * var norm = vec.norm() // Calculate the length of the vector * var sqrnorm = vec.sqrnorm() // Calculate the squared length of the vector * * var sprod = vec.sprod(vec) //Compute scalar product with the vector and itself * * vec.normalize() // Normalize vector * * vec.zero() // Set all components of the vector to zero * * print(vec) // Output vector to the console  Jan Möbius committed Jun 28, 2012 86 87 88 89 90  * * \endcode * */  Jan Möbius committed Aug 29, 2008 91 92 93 94 95 96 97 #ifndef PROTOTYPEVEC3D_HH #define PROTOTYPEVEC3D_HH #include #include  Jan Möbius committed Jun 28, 2012 98 99 100 101 102 103 104 /** \class prototypeVec3d * * This class wraps the Vec3d to the scripting language * * \ref scripting_vector_type * */  Jan Möbius committed Aug 29, 2008 105 106 107 108 109 class prototypeVec3d : public QObject , public QScriptable { Q_OBJECT public:  Jan Möbius committed Feb 06, 2017 110  explicit prototypeVec3d(QObject *parent = 0);  Jan Möbius committed Aug 29, 2008 111   Jan Möbius committed Jun 28, 2012 112  public slots:  Jan Möbius committed Jun 28, 2012 113 114 115 116  /** \brief Multiplies the given vector with the scalar * * @param _scalar Scalar value that gets multiplied */  Jan Möbius committed Jun 28, 2012 117 118  void multiply(QScriptValue _scalar);  Jan Möbius committed Jun 28, 2012 119 120 121 122  /** \brief Adds another vector to this vector * * @param _vector Vector that should be added */  Jan Möbius committed Jun 28, 2012 123 124  void add(QScriptValue _vector);  Jan Möbius committed Jun 28, 2012 125 126 127 128  /** \brief Subtracts another vector from this vector * * @param _vector Vector that should be subtracted */  Jan Möbius committed Jun 28, 2012 129 130  void sub(QScriptValue _vector);  Jan Möbius committed Jun 29, 2012 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  /** \brief Resets all components of the vector to zero * */ void zero(); /** \brief Calculate scalar product * * @param _vector Second vector for scalar product (Can be the vector itself) * @return Scalar product value */ QScriptValue sprod(QScriptValue _vector); /** \brief Calculate the Euclidean norm of the vector * * @return Norm of the vector */ QScriptValue norm(); /** \brief Calculate the squared Euclidean norm of the vector * * @return Squared norm of the vector */ QScriptValue sqrnorm(); /** \brief Normalize the vector */ void normalize();  Jan Möbius committed Aug 29, 2008 161 162 163 164 165 166 167  public Q_SLOTS: QString toString() const; }; #endif // PROTOTYPEVEC3D_HH  Jan Möbius committed Jun 28, 2012 168