miniassimp

annotate include/miniassimp/vector3.h @ 0:879c81d94345

find changesets by author, revision, files, or words in the commit message
initial commit
author John Tsiombikas <nuclear@member.fsf.org>
date Mon, 28 Jan 2019 18:19:26 +0200
parents
children
rev   line source
nuclear@0 1 /*
nuclear@0 2 ---------------------------------------------------------------------------
nuclear@0 3 Open Asset Import Library (assimp)
nuclear@0 4 ---------------------------------------------------------------------------
nuclear@0 5
nuclear@0 6 Copyright (c) 2006-2018, assimp team
nuclear@0 7
nuclear@0 8
nuclear@0 9
nuclear@0 10 All rights reserved.
nuclear@0 11
nuclear@0 12 Redistribution and use of this software in source and binary forms,
nuclear@0 13 with or without modification, are permitted provided that the following
nuclear@0 14 conditions are met:
nuclear@0 15
nuclear@0 16 * Redistributions of source code must retain the above
nuclear@0 17 copyright notice, this list of conditions and the
nuclear@0 18 following disclaimer.
nuclear@0 19
nuclear@0 20 * Redistributions in binary form must reproduce the above
nuclear@0 21 copyright notice, this list of conditions and the
nuclear@0 22 following disclaimer in the documentation and/or other
nuclear@0 23 materials provided with the distribution.
nuclear@0 24
nuclear@0 25 * Neither the name of the assimp team, nor the names of its
nuclear@0 26 contributors may be used to endorse or promote products
nuclear@0 27 derived from this software without specific prior
nuclear@0 28 written permission of the assimp team.
nuclear@0 29
nuclear@0 30 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
nuclear@0 31 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
nuclear@0 32 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
nuclear@0 33 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
nuclear@0 34 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
nuclear@0 35 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
nuclear@0 36 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
nuclear@0 37 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
nuclear@0 38 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
nuclear@0 39 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
nuclear@0 40 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
nuclear@0 41 ---------------------------------------------------------------------------
nuclear@0 42 */
nuclear@0 43 /** @file vector3.h
nuclear@0 44 * @brief 3D vector structure, including operators when compiling in C++
nuclear@0 45 */
nuclear@0 46 #pragma once
nuclear@0 47 #ifndef AI_VECTOR3D_H_INC
nuclear@0 48 #define AI_VECTOR3D_H_INC
nuclear@0 49
nuclear@0 50 #ifdef __cplusplus
nuclear@0 51 # include <cmath>
nuclear@0 52 #else
nuclear@0 53 # include <math.h>
nuclear@0 54 #endif
nuclear@0 55
nuclear@0 56 #include "defs.h"
nuclear@0 57
nuclear@0 58 #ifdef __cplusplus
nuclear@0 59
nuclear@0 60 template<typename TReal> class aiMatrix3x3t;
nuclear@0 61 template<typename TReal> class aiMatrix4x4t;
nuclear@0 62
nuclear@0 63 // ---------------------------------------------------------------------------
nuclear@0 64 /** Represents a three-dimensional vector. */
nuclear@0 65 template <typename TReal>
nuclear@0 66 class aiVector3t
nuclear@0 67 {
nuclear@0 68 public:
nuclear@0 69 aiVector3t() AI_NO_EXCEPT : x(), y(), z() {}
nuclear@0 70 aiVector3t(TReal _x, TReal _y, TReal _z) : x(_x), y(_y), z(_z) {}
nuclear@0 71 explicit aiVector3t (TReal _xyz ) : x(_xyz), y(_xyz), z(_xyz) {}
nuclear@0 72
nuclear@0 73 public:
nuclear@0 74
nuclear@0 75 // combined operators
nuclear@0 76 const aiVector3t& operator += (const aiVector3t& o);
nuclear@0 77 const aiVector3t& operator -= (const aiVector3t& o);
nuclear@0 78 const aiVector3t& operator *= (TReal f);
nuclear@0 79 const aiVector3t& operator /= (TReal f);
nuclear@0 80
nuclear@0 81 // transform vector by matrix
nuclear@0 82 aiVector3t& operator *= (const aiMatrix3x3t<TReal>& mat);
nuclear@0 83 aiVector3t& operator *= (const aiMatrix4x4t<TReal>& mat);
nuclear@0 84
nuclear@0 85 // access a single element
nuclear@0 86 TReal operator[](unsigned int i) const;
nuclear@0 87 TReal& operator[](unsigned int i);
nuclear@0 88
nuclear@0 89 // comparison
nuclear@0 90 bool operator== (const aiVector3t& other) const;
nuclear@0 91 bool operator!= (const aiVector3t& other) const;
nuclear@0 92 bool operator < (const aiVector3t& other) const;
nuclear@0 93
nuclear@0 94 bool Equal(const aiVector3t& other, TReal epsilon = 1e-6) const;
nuclear@0 95
nuclear@0 96 template <typename TOther>
nuclear@0 97 operator aiVector3t<TOther> () const;
nuclear@0 98
nuclear@0 99 public:
nuclear@0 100 /** @brief Set the components of a vector
nuclear@0 101 * @param pX X component
nuclear@0 102 * @param pY Y component
nuclear@0 103 * @param pZ Z component */
nuclear@0 104 void Set( TReal pX, TReal pY, TReal pZ);
nuclear@0 105
nuclear@0 106 /** @brief Get the squared length of the vector
nuclear@0 107 * @return Square length */
nuclear@0 108 TReal SquareLength() const;
nuclear@0 109
nuclear@0 110 /** @brief Get the length of the vector
nuclear@0 111 * @return length */
nuclear@0 112 TReal Length() const;
nuclear@0 113
nuclear@0 114
nuclear@0 115 /** @brief Normalize the vector */
nuclear@0 116 aiVector3t& Normalize();
nuclear@0 117
nuclear@0 118 /** @brief Normalize the vector with extra check for zero vectors */
nuclear@0 119 aiVector3t& NormalizeSafe();
nuclear@0 120
nuclear@0 121 /** @brief Componentwise multiplication of two vectors
nuclear@0 122 *
nuclear@0 123 * Note that vec*vec yields the dot product.
nuclear@0 124 * @param o Second factor */
nuclear@0 125 const aiVector3t SymMul(const aiVector3t& o);
nuclear@0 126
nuclear@0 127 TReal x, y, z;
nuclear@0 128 };
nuclear@0 129
nuclear@0 130
nuclear@0 131 typedef aiVector3t<ai_real> aiVector3D;
nuclear@0 132
nuclear@0 133 #else
nuclear@0 134
nuclear@0 135 struct aiVector3D {
nuclear@0 136 ai_real x, y, z;
nuclear@0 137 };
nuclear@0 138
nuclear@0 139 #endif // __cplusplus
nuclear@0 140
nuclear@0 141 #ifdef __cplusplus
nuclear@0 142
nuclear@0 143 #endif // __cplusplus
nuclear@0 144
nuclear@0 145 #endif // AI_VECTOR3D_H_INC