Core Box3 Algorithms

List of utility functions for boxes having 3 dimensions. More...

Collaboration diagram for Core Box3 Algorithms:

Functions
template<Box3Concept BoxType>
auto	vcl::boxVertex (const BoxType &box, uint i) -> BoxType::PointType
	Returns the ith vertex of a 3D box.
template<Box3Concept BoxType>
auto	vcl::boxEdge (const BoxType &box, uint i) -> Segment< typename BoxType::PointType >
	Returns the ith edge of a 3D box.

Detailed Description

List of utility functions for boxes having 3 dimensions.

The order of the vertices, and edges is as follows:

      v2_______e2_____________v3
      /|                    /|
     / |                   / |
 e10/  |               e11/  |
   /___|______e6_________/   |
v6|    |                 |v7 |e3
  |    |                 |   |
  |    |e1               |e5 |
e7|    |                 |   |
  |    |_________________|___|
  |   / v0      e0       |   /v1          ^ y
  |  /                   |  /             |
  | /e8                  | /e9            --> x
  |/_____________________|/              /
  v4         e4          v5             z

The order of the faces is as follows:

0: v2, v3, v1, v0
1: v4, v6, v2, v0
2: v1, v5, v4, v0
3: v6, v4, v5, v7
4: v3, v2, v6, v7
5: v5, v1, v3, v7

You can access these algorithms by including #include <vclib/algorithms/core/box/box3.h>

Function Documentation

boxEdge()

template<Box3Concept BoxType>

auto vcl::boxEdge	(	const BoxType &	box,
		uint	i
	)		-> Segment<typename BoxType::PointType>

Returns the ith edge of a 3D box.

       ________e2_____________
      /|                    /|
     / |                   / |
 e10/  |               e11/  |
   /___|______e6_________/   |
  |    |                 |   |e3
  |    |                 |   |
  |    |e1               |e5 |
e7|    |                 |   |
  |    |_________________|___|
  |   /         e0       |   /            ^ y
  |  /                   |  /             |
  | /e8                  | /e9            --> x
  |/_____________________|/              /
             e4                         z

Template Parameters

BoxType

The type of the box.

Parameters

[in]	box	The box.
[in]	i	The index of the edge.

Returns

The ith edge of the box.

boxVertex()

template<Box3Concept BoxType>

auto vcl::boxVertex	(	const BoxType &	box,
		uint	i
	)		-> BoxType::PointType

Returns the ith vertex of a 3D box.

      v2______________________v3
      /|                    /|
     / |                   / |
    /  |                  /  |
   /___|_________________/   |
v6|    |                 |v7 |
  |    |                 |   |
  |    |                 |   |
  |    |                 |   |
  |    |_________________|___|
  |   / v0               |   /v1          ^ y
  |  /                   |  /             |
  | /                    | /              --> x
  |/_____________________|/              /
  v4                     v5             z

Template Parameters

BoxType

The type of the box.

Parameters

[in]	box	The box.
[in]	i	The index of the vertex.

Returns

The ith vertex of the box.