mirror of https://github.com/mosra/magnum.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
100 lines
3.4 KiB
100 lines
3.4 KiB
#ifndef Magnum_Primitives_Cone_h |
|
#define Magnum_Primitives_Cone_h |
|
/* |
|
This file is part of Magnum. |
|
|
|
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018 |
|
Vladimír Vondruš <mosra@centrum.cz> |
|
|
|
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::Primitives::coneSolid(), @ref Magnum::Primitives::coneWireframe() |
|
*/ |
|
|
|
#include <Corrade/Containers/EnumSet.h> |
|
|
|
#include "Magnum/Magnum.h" |
|
#include "Magnum/Primitives/visibility.h" |
|
#include "Magnum/Trade/Trade.h" |
|
|
|
namespace Magnum { namespace Primitives { |
|
|
|
/** |
|
@brief Cone flag |
|
|
|
@see @ref ConeFlags, @ref coneSolid() |
|
*/ |
|
enum class ConeFlag { |
|
GenerateTextureCoords = 1 << 0, /**< Generate texture coordinates */ |
|
CapEnd = 1 << 1 /**< Cap end */ |
|
}; |
|
|
|
/** |
|
@brief Cone flags |
|
|
|
@see @ref coneSolid() |
|
*/ |
|
typedef Containers::EnumSet<ConeFlag> ConeFlags; |
|
|
|
CORRADE_ENUMSET_OPERATORS(ConeFlags) |
|
|
|
/** |
|
@brief Solid 3D cone |
|
@param rings Number of (face) rings. Must be larger or equal to |
|
@cpp 1 @ce. |
|
@param segments Number of (face) segments. Must be larger or equal to |
|
@cpp 3 @ce. |
|
@param halfLength Half the cone length |
|
@param flags Flags |
|
|
|
Cone along Y axis of radius @cpp 1.0f @ce. Indexed |
|
@ref MeshPrimitive::Triangles. Note that in order to have properly smooth |
|
normals over the whole area, the tip consists of @cpp segments*2 @ce vertices |
|
instead of just one. |
|
|
|
@image html primitives-conesolid.png width=256px |
|
|
|
The cone is by default created with radius set to @f$ 1.0 @f$. In order to get |
|
radius @f$ r @f$, length @f$ l @f$ and preserve correct normals, set |
|
@p halfLength to @f$ 0.5 \frac{l}{r} @f$ and then scale all |
|
@ref Trade::MeshData3D::positions() by @f$ r @f$, for example using |
|
@ref MeshTools::transformPointsInPlace(). |
|
@see @ref coneWireframe(), @ref cylinderSolid() |
|
*/ |
|
MAGNUM_PRIMITIVES_EXPORT Trade::MeshData3D coneSolid(UnsignedInt rings, UnsignedInt segments, Float halfLength, ConeFlags flags = {}); |
|
|
|
/** |
|
@brief Wireframe 3D cone |
|
@param segments Number of (line) segments. Must be larger or equal to |
|
@cpp 4 @ce and multiple of @cpp 4 @ce. |
|
@param halfLength Half the cone length |
|
|
|
Cone along Y axis of radius @cpp 1.0f @ce. Indexed @ref MeshPrimitive::Lines. |
|
|
|
@image html primitives-conewireframe.png width=256px |
|
|
|
@see @ref coneSolid(), @ref cylinderWireframe() |
|
*/ |
|
MAGNUM_PRIMITIVES_EXPORT Trade::MeshData3D coneWireframe(UnsignedInt segments, Float halfLength); |
|
|
|
}} |
|
|
|
#endif
|
|
|