/******************************************************************************** * ReactPhysics3D physics library, http://www.reactphysics3d.com * * Copyright (c) 2010-2022 Daniel Chappuis * ********************************************************************************* * * * This software is provided 'as-is', without any express or implied warranty. * * In no event will the authors be held liable for any damages arising from the * * use of this software. * * * * Permission is granted to anyone to use this software for any purpose, * * including commercial applications, and to alter it and redistribute it * * freely, subject to the following restrictions: * * * * 1. The origin of this software must not be misrepresented; you must not claim * * that you wrote the original software. If you use this software in a * * product, an acknowledgment in the product documentation would be * * appreciated but is not required. * * * * 2. Altered source versions must be plainly marked as such, and must not be * * misrepresented as being the original software. * * * * 3. This notice may not be removed or altered from any source distribution. * * * ********************************************************************************/ #ifndef REACTPHYSICS3D_MATHEMATICS_FUNCTIONS_H #define REACTPHYSICS3D_MATHEMATICS_FUNCTIONS_H // Libraries #include #include #include #include #include #include #include /// ReactPhysics3D namespace namespace reactphysics3d { struct Vector3; struct Vector2; // ---------- Mathematics functions ---------- // /// Function that returns the result of the "value" clamped by /// two others values "lowerLimit" and "upperLimit" RP3D_FORCE_INLINE int clamp(int value, int lowerLimit, int upperLimit) { assert(lowerLimit <= upperLimit); return std::min(std::max(value, lowerLimit), upperLimit); } /// Function that returns the result of the "value" clamped by /// two others values "lowerLimit" and "upperLimit" RP3D_FORCE_INLINE decimal clamp(decimal value, decimal lowerLimit, decimal upperLimit) { assert(lowerLimit <= upperLimit); return std::min(std::max(value, lowerLimit), upperLimit); } /// Return the minimum value among three values RP3D_FORCE_INLINE decimal min3(decimal a, decimal b, decimal c) { return std::min(std::min(a, b), c); } /// Return the maximum value among three values RP3D_FORCE_INLINE decimal max3(decimal a, decimal b, decimal c) { return std::max(std::max(a, b), c); } /// Return true if two values have the same sign RP3D_FORCE_INLINE bool sameSign(decimal a, decimal b) { return a * b >= decimal(0.0); } // Return true if two vectors are parallel RP3D_FORCE_INLINE bool areParallelVectors(const Vector3& vector1, const Vector3& vector2) { return vector1.cross(vector2).lengthSquare() < decimal(0.00001); } // Return true if two vectors are orthogonal RP3D_FORCE_INLINE bool areOrthogonalVectors(const Vector3& vector1, const Vector3& vector2) { return std::abs(vector1.dot(vector2)) < decimal(0.001); } // Clamp a vector such that it is no longer than a given maximum length RP3D_FORCE_INLINE Vector3 clamp(const Vector3& vector, decimal maxLength) { if (vector.lengthSquare() > maxLength * maxLength) { return vector.getUnit() * maxLength; } return vector; } // Compute and return a point on segment from "segPointA" and "segPointB" that is closest to point "pointC" RP3D_FORCE_INLINE Vector3 computeClosestPointOnSegment(const Vector3& segPointA, const Vector3& segPointB, const Vector3& pointC) { const Vector3 ab = segPointB - segPointA; decimal abLengthSquare = ab.lengthSquare(); // If the segment has almost zero length if (abLengthSquare < MACHINE_EPSILON) { // Return one end-point of the segment as the closest point return segPointA; } // Project point C onto "AB" line decimal t = (pointC - segPointA).dot(ab) / abLengthSquare; // If projected point onto the line is outside the segment, clamp it to the segment if (t < decimal(0.0)) t = decimal(0.0); if (t > decimal(1.0)) t = decimal(1.0); // Return the closest point on the segment return segPointA + t * ab; } // Compute the closest points between two segments // This method uses the technique described in the book Real-Time // collision detection by Christer Ericson. RP3D_FORCE_INLINE void computeClosestPointBetweenTwoSegments(const Vector3& seg1PointA, const Vector3& seg1PointB, const Vector3& seg2PointA, const Vector3& seg2PointB, Vector3& closestPointSeg1, Vector3& closestPointSeg2) { const Vector3 d1 = seg1PointB - seg1PointA; const Vector3 d2 = seg2PointB - seg2PointA; const Vector3 r = seg1PointA - seg2PointA; decimal a = d1.lengthSquare(); decimal e = d2.lengthSquare(); decimal f = d2.dot(r); decimal s, t; // If both segments degenerate into points if (a <= MACHINE_EPSILON && e <= MACHINE_EPSILON) { closestPointSeg1 = seg1PointA; closestPointSeg2 = seg2PointA; return; } if (a <= MACHINE_EPSILON) { // If first segment degenerates into a point s = decimal(0.0); // Compute the closest point on second segment t = clamp(f / e, decimal(0.0), decimal(1.0)); } else { decimal c = d1.dot(r); // If the second segment degenerates into a point if (e <= MACHINE_EPSILON) { t = decimal(0.0); s = clamp(-c / a, decimal(0.0), decimal(1.0)); } else { decimal b = d1.dot(d2); decimal denom = a * e - b * b; // If the segments are not parallel if (denom != decimal(0.0)) { // Compute the closest point on line 1 to line 2 and // clamp to first segment. s = clamp((b * f - c * e) / denom, decimal(0.0), decimal(1.0)); } else { // Pick an arbitrary point on first segment s = decimal(0.0); } // Compute the point on line 2 closest to the closest point // we have just found t = (b * s + f) / e; // If this closest point is inside second segment (t in [0, 1]), we are done. // Otherwise, we clamp the point to the second segment and compute again the // closest point on segment 1 if (t < decimal(0.0)) { t = decimal(0.0); s = clamp(-c / a, decimal(0.0), decimal(1.0)); } else if (t > decimal(1.0)) { t = decimal(1.0); s = clamp((b - c) / a, decimal(0.0), decimal(1.0)); } } } // Compute the closest points on both segments closestPointSeg1 = seg1PointA + d1 * s; closestPointSeg2 = seg2PointA + d2 * t; } // Compute the barycentric coordinates u, v, w of a point p inside the triangle (a, b, c) // This method uses the technique described in the book Real-Time collision detection by // Christer Ericson. RP3D_FORCE_INLINE void computeBarycentricCoordinatesInTriangle(const Vector3& a, const Vector3& b, const Vector3& c, const Vector3& p, decimal& u, decimal& v, decimal& w) { const Vector3 v0 = b - a; const Vector3 v1 = c - a; const Vector3 v2 = p - a; const decimal d00 = v0.dot(v0); const decimal d01 = v0.dot(v1); const decimal d11 = v1.dot(v1); const decimal d20 = v2.dot(v0); const decimal d21 = v2.dot(v1); const decimal denom = d00 * d11 - d01 * d01; v = (d11 * d20 - d01 * d21) / denom; w = (d00 * d21 - d01 * d20) / denom; u = decimal(1.0) - v - w; } // Compute the intersection between a plane and a segment // Let the plane define by the equation planeNormal.dot(X) = planeD with X a point on the plane and "planeNormal" the plane normal. This method // computes the intersection P between the plane and the segment (segA, segB). The method returns the value "t" such // that P = segA + t * (segB - segA). Note that it only returns a value in [0, 1] if there is an intersection. Otherwise, // there is no intersection between the plane and the segment. RP3D_FORCE_INLINE decimal computePlaneSegmentIntersection(const Vector3& segA, const Vector3& segB, const decimal planeD, const Vector3& planeNormal) { const decimal parallelEpsilon = decimal(0.0001); decimal t = decimal(-1); const decimal nDotAB = planeNormal.dot(segB - segA); // If the segment is not parallel to the plane if (std::abs(nDotAB) > parallelEpsilon) { t = (planeD - planeNormal.dot(segA)) / nDotAB; } return t; } // Compute the distance between a point "point" and a line given by the points "linePointA" and "linePointB" RP3D_FORCE_INLINE decimal computePointToLineDistance(const Vector3& linePointA, const Vector3& linePointB, const Vector3& point) { decimal distAB = (linePointB - linePointA).length(); if (distAB < MACHINE_EPSILON) { return (point - linePointA).length(); } return ((point - linePointA).cross(point - linePointB)).length() / distAB; } // Clip a segment against multiple planes and return the clipped segment vertices // This method implements the Sutherland–Hodgman clipping algorithm RP3D_FORCE_INLINE Array clipSegmentWithPlanes(const Vector3& segA, const Vector3& segB, const Array& planesPoints, const Array& planesNormals, MemoryAllocator& allocator) { assert(planesPoints.size() == planesNormals.size()); Array inputVertices(allocator, 2); Array outputVertices(allocator, 2); inputVertices.add(segA); inputVertices.add(segB); // For each clipping plane const uint32 nbPlanesPoints = static_cast(planesPoints.size()); for (uint32 p=0; p < nbPlanesPoints; p++) { // If there is no more vertices, stop if (inputVertices.size() == 0) return inputVertices; assert(inputVertices.size() == 2); outputVertices.clear(); Vector3& v1 = inputVertices[0]; Vector3& v2 = inputVertices[1]; decimal v1DotN = (v1 - planesPoints[p]).dot(planesNormals[p]); decimal v2DotN = (v2 - planesPoints[p]).dot(planesNormals[p]); // If the second vertex is in front of the clippling plane if (v2DotN >= decimal(0.0)) { // If the first vertex is not in front of the clippling plane if (v1DotN < decimal(0.0)) { // The second point we keep is the intersection between the segment v1, v2 and the clipping plane decimal t = computePlaneSegmentIntersection(v1, v2, planesNormals[p].dot(planesPoints[p]), planesNormals[p]); if (t >= decimal(0) && t <= decimal(1.0)) { outputVertices.add(v1 + t * (v2 - v1)); } else { outputVertices.add(v2); } } else { outputVertices.add(v1); } // Add the second vertex outputVertices.add(v2); } else { // If the second vertex is behind the clipping plane // If the first vertex is in front of the clippling plane if (v1DotN >= decimal(0.0)) { outputVertices.add(v1); // The first point we keep is the intersection between the segment v1, v2 and the clipping plane decimal t = computePlaneSegmentIntersection(v1, v2, -planesNormals[p].dot(planesPoints[p]), -planesNormals[p]); if (t >= decimal(0.0) && t <= decimal(1.0)) { outputVertices.add(v1 + t * (v2 - v1)); } } } inputVertices = outputVertices; } return outputVertices; } // Clip a polygon against a single plane and return the clipped polygon vertices // This method implements the Sutherland–Hodgman polygon clipping algorithm RP3D_FORCE_INLINE void clipPolygonWithPlane(const Array& polygonVertices, const Vector3& planePoint, const Vector3& planeNormal, Array& outClippedPolygonVertices) { uint32 nbInputVertices = static_cast(polygonVertices.size()); assert(outClippedPolygonVertices.size() == 0); uint32 vStartIndex = nbInputVertices - 1; const decimal planeNormalDotPlanePoint = planeNormal.dot(planePoint); decimal vStartDotN = (polygonVertices[vStartIndex] - planePoint).dot(planeNormal); // For each edge of the polygon for (uint vEndIndex = 0; vEndIndex < nbInputVertices; vEndIndex++) { const Vector3& vStart = polygonVertices[vStartIndex]; const Vector3& vEnd = polygonVertices[vEndIndex]; const decimal vEndDotN = (vEnd - planePoint).dot(planeNormal); // If the second vertex is in front of the clippling plane if (vEndDotN >= decimal(0.0)) { // If the first vertex is not in front of the clippling plane if (vStartDotN < decimal(0.0)) { // The second point we keep is the intersection between the segment v1, v2 and the clipping plane const decimal t = computePlaneSegmentIntersection(vStart, vEnd, planeNormalDotPlanePoint, planeNormal); if (t >= decimal(0) && t <= decimal(1.0)) { outClippedPolygonVertices.add(vStart + t * (vEnd - vStart)); } else { outClippedPolygonVertices.add(vEnd); } } // Add the second vertex outClippedPolygonVertices.add(vEnd); } else { // If the second vertex is behind the clipping plane // If the first vertex is in front of the clippling plane if (vStartDotN >= decimal(0.0)) { // The first point we keep is the intersection between the segment v1, v2 and the clipping plane const decimal t = computePlaneSegmentIntersection(vStart, vEnd, -planeNormalDotPlanePoint, -planeNormal); if (t >= decimal(0.0) && t <= decimal(1.0)) { outClippedPolygonVertices.add(vStart + t * (vEnd - vStart)); } else { outClippedPolygonVertices.add(vStart); } } } vStartIndex = vEndIndex; vStartDotN = vEndDotN; } } // Project a point onto a plane that is given by a point and its unit length normal RP3D_FORCE_INLINE Vector3 projectPointOntoPlane(const Vector3& point, const Vector3& unitPlaneNormal, const Vector3& planePoint) { return point - unitPlaneNormal.dot(point - planePoint) * unitPlaneNormal; } // Return the distance between a point and a plane (the plane normal must be normalized) RP3D_FORCE_INLINE decimal computePointToPlaneDistance(const Vector3& point, const Vector3& planeNormal, const Vector3& planePoint) { return planeNormal.dot(point - planePoint); } /// Return true if a number is a power of two RP3D_FORCE_INLINE bool isPowerOfTwo(uint64 number) { return number != 0 && !(number & (number -1)); } /// Return the next power of two larger than the number in parameter RP3D_FORCE_INLINE uint64 nextPowerOfTwo64Bits(uint64 number) { number--; number |= number >> 1; number |= number >> 2; number |= number >> 4; number |= number >> 8; number |= number >> 16; number |= number >> 32; number++; number += (number == 0); return number; } /// Return an unique integer from two integer numbers (pairing function) /// Here we assume that the two parameter numbers are sorted such that /// number1 = max(number1, number2) /// http://szudzik.com/ElegantPairing.pdf RP3D_FORCE_INLINE uint64 pairNumbers(uint32 number1, uint32 number2) { assert(number1 == std::max(number1, number2)); uint64 nb1 = number1; uint64 nb2 = number2; return nb1 * nb1 + nb1 + nb2; } } #endif