#ifndef Magnum_Math_Swizzle_h #define Magnum_Math_Swizzle_h /* This file is part of Magnum. Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022 Vladimír Vondruš Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ /** @file * @brief Function @ref Magnum::Math::gather(), @ref Magnum::Math::scatter() */ #include "Magnum/Math/Vector.h" namespace Magnum { namespace Math { namespace Implementation { template struct GatherComponentAt { static_assert(size > position, "numeric swizzle parameter out of range of gather vector, use either xyzw/rgba/0/1 letters or small enough numbers"); template constexpr static T value(const Math::Vector& vector) { return vector._data[position]; } }; template struct GatherComponent: GatherComponentAt {}; template struct GatherComponent: public GatherComponentAt {}; template struct GatherComponent: public GatherComponentAt {}; template struct GatherComponent: public GatherComponentAt {}; template struct GatherComponent: public GatherComponentAt {}; template struct GatherComponent: public GatherComponentAt {}; template struct GatherComponent: public GatherComponentAt {}; template struct GatherComponent: public GatherComponentAt {}; template struct GatherComponent: public GatherComponentAt {}; template struct GatherComponent { template constexpr static T value(const Math::Vector&) { return T(0); } }; template struct GatherComponent { template constexpr static T value(const Math::Vector&) { return T(1); } }; template struct TypeForSize { typedef Math::Vector Type; }; template struct ScatterComponentOr { template constexpr static T value(const Math::Vector&, const T& value) { return value; } }; template struct ScatterComponentOr { template constexpr static T value(const Math::Vector& vector, const T&) { return vector._data[i]; } }; /* MSVC complains about C4389 signed/unsigned mismatch without the cast */ template struct ScatterComponent: ScatterComponentOr { static_assert(component == 'x' || component == 'r' || ((component == 'y' || component == 'g') && size > 1) || ((component == 'z' || component == 'b') && size > 2) || ((component == 'w' || component == 'a') && size > 3) || std::size_t(component) < size, "swizzle parameter out of range of scatter vector, use either xyzw/rgba letters or small enough numbers"); }; template struct ScatterComponent: ScatterComponentOr {}; template struct ScatterComponent: ScatterComponentOr {}; template struct ScatterComponent: ScatterComponentOr {}; template struct ScatterComponent: ScatterComponentOr {}; template struct ScatterComponent: ScatterComponentOr {}; template struct ScatterComponent: ScatterComponentOr {}; template struct ScatterComponent: ScatterComponentOr {}; template struct ScatterComponent: ScatterComponentOr {}; template constexpr T scatterComponentOr(const T& vector, const typename T::Type& value, Corrade::Containers::Implementation::Sequence) { return {ScatterComponent::value(vector, value)...}; } template constexpr T scatterRecursive(const T& vector, const Vector&, std::size_t) { return vector; } template constexpr T scatterRecursive(const T& vector, const Vector& values, std::size_t valueIndex) { return scatterRecursive( scatterComponentOr(vector, values._data[valueIndex], typename Corrade::Containers::Implementation::GenerateSequence::Type{}), values, valueIndex + 1); } } /** @brief Gather @ref Vector components @m_since{2019,10} Creates a new vector from given components. Example: @snippet MagnumMath.cpp gather You can use letters @cpp 'x' @ce, @cpp 'y' @ce, @cpp 'z' @ce, @cpp 'w' @ce and @cpp 'r' @ce, @cpp 'g' @ce, @cpp 'b' @ce, @cpp 'a' @ce for addressing components or letters @cpp '0' @ce and @cpp '1' @ce for zero and one. Alternatively you can also address components using their numeric index --- which is especially useful when your input has more than four components. Count of elements is unlimited, but must be at least one. If the resulting vector is two, three or four-component, corresponding @ref Vector2, @ref Vector3, @ref Vector4, @ref Color3 or @ref Color4 specialization is returned. @see @ref scatter(), @ref matrix-vector-component-access, @ref Vector4::xyz(), @ref Vector4::rgb(), @ref Vector4::xy(), @ref Vector3::xy() */ template constexpr typename Implementation::TypeForSize::Type gather(const T& vector) { return {Implementation::GatherComponent::value(vector)...}; } /** @brief Scatter @ref Vector components @param vector Vector to update @param values Values to update it with @return Updated vector @m_since{2019,10} Returns a copy of @p vector with particular components updated from @p values. Inverse to @ref gather(), supporting the same component addressing except for @cpp '0' @ce and @cpp '1' @ce. Example: @snippet MagnumMath.cpp scatter @see @ref matrix-vector-component-access, @ref Vector4::xyz(), @ref Vector4::rgb(), @ref Vector4::xy(), @ref Vector3::xy() */ #ifdef DOXYGEN_GENERATING_OUTPUT template constexpr T scatter(const T& vector, const Vector& values) #else /* Using std::common_type otherwise GCC 4.8 fails to match the arguments in SwizzleTest::scatterOneComponent() */ template constexpr T scatter(const T& vector, const typename std::common_type>::type& values) #endif { return Implementation::scatterRecursive(vector, values, 0); } #ifdef MAGNUM_BUILD_DEPRECATED /** @brief @copybrief gather() * @m_deprecated_since{2019,10} Use @ref gather() instead. */ template CORRADE_DEPRECATED("use gather() instead") constexpr typename Implementation::TypeForSize::Type swizzle(const T& vector) { return gather(vector); } #endif }} #endif