List of the Core Data Structures of VCLib. More...

Concepts
concept	vcl::ArrayConcept
	A concept representing a generic N-dimensional array.

concept	vcl::Array2Concept
	A concept representing a 2-dimensional array.

concept	vcl::Array3Concept
	A concept representing a 3-dimensional array.

concept	vcl::Array4Concept
	A concept representing a 4-dimensional array.

concept	vcl::BitSetConcept
	A concept representing a BitSet.

concept	vcl::BitProxyConcept
	A concept representing a BitProxy.

concept	vcl::BoxConcept
	A concept representing a Box.

concept	vcl::Box2Concept
	A concept representing a 2D Box.

concept	vcl::Box3Concept
	A concept representing a 3D Box.

concept	vcl::ColorConcept
	A concept representing a Color.

concept	vcl::ImageConcept
	A concept representing an Image.

concept	vcl::MatrixConcept
	Concept for 2D arrays (matrices). It is satisfied when `T` is a matrix, no matter its sizes.

concept	vcl::Matrix33Concept
	Concept for 3x3 matrices.

concept	vcl::Matrix44Concept
	Concept for 4x4 matrices.

concept	vcl::Matrix33Or44Concept
	Concept for 3x3 or 4x4 matrices.

concept	vcl::EigenMatrixConcept
	A concept representing an Eigen Matrix.

concept	vcl::PlaneConcept
	A concept representing a Plane.

concept	vcl::PointConcept
	A concept representing a Point.

concept	vcl::Point2Concept
	A concept representing a 2D Point.

concept	vcl::Point3Concept
	A concept representing a 3D Point.

concept	vcl::Point4Concept
	A concept representing a 4D Point.

concept	vcl::PointIteratorConcept
	A concept representing an iterator that iterates over Points (specifically, a class that satisfies the PointConcept).

concept	vcl::Point2IteratorConcept
	A concept representing an iterator that iterates over 2D Points (specifically, a class that satisfies the Point2Concept).

concept	vcl::Point3IteratorConcept
	A concept representing an iterator that iterates over 3D Points (specifically, a class that satisfies the Point3Concept).

concept	vcl::Point4IteratorConcept
	A concept representing an iterator that iterates over 4D Points (specifically, a class that satisfies the Point4Concept).

concept	vcl::PolygonConcept
	A concept representing a Polygon.

concept	vcl::Polygon2Concept
	A concept representing a 2D Polygon.

concept	vcl::Polygon3Concept
	A concept representing a 3D Polygon.

concept	vcl::PrincipalCurvatureConcept
	A concept representing a PrincipalCurvature.

concept	vcl::SegmentConcept
	A concept representing a Segment.

concept	vcl::Segment2Concept
	A concept representing a 2D Segment.

concept	vcl::Segment3Concept
	A concept representing a 3D Segment.

concept	vcl::SphereConcept
	A concept representing a Sphere.

concept	vcl::TexCoordConcept
	A concept representing a TexCoordIndexed.

concept	vcl::TexCoordIndexedConcept
	A concept representing a TexCoordIndexed.

concept	vcl::TextureConcept
	A concept representing a Texture.

concept	vcl::TriangleConcept
	A concept representing a Triangle.

concept	vcl::Triangle2Concept
	A concept representing a 2D Triangle.

concept	vcl::Triangle3Concept
	A concept representing a 3D Triangle.

Classes
class	vcl::Array< T, N >
	The Array class is a dynamically allocated N-dimensional array stored in RowWise mode. More...

class	vcl::BitProxy< T >
	The BitProxy class allows to access to a bool reference from a bit saved in a mask, and then allow assignment. More...

class	vcl::BitSet< T >
	The BitSet class allows to treat an integral type as an array of booleans of a guaranteed size. More...

class	vcl::Box< PointT >
	A class representing a box in N-dimensional space. More...

class	vcl::Color
	The Color class represents a 32 bit color. More...

class	vcl::Distribution< Scalar >
	The Distribution class allows to collect a set of values and then compute some statistics like average, variance, standardDeviation, and percentiles. More...

class	vcl::Histogram< ScalarType >
	The Histogram class allows to collect a set of values and then compute some statistics like average, variance, standardDeviation, and percentiles. More...

class	vcl::Image
	The Image class stores an Image in 4 bytes RGBA format. More...

class	vcl::Plane< Scalar, NORM >
	The Plane class represent a 2D plane in 3D space. More...

class	vcl::Point< Scalar, N >
	The Point class represents an N-dimensional point containing N scalar values. More...

class	vcl::PointerVector< T, N >
	The `PointerVector` class is a utility container that stores a sequence of pointers that preserve their constness when the container is constant. More...

class	vcl::Polygon< PointT >
	The Polygon class represents a polygon in a N-dimensional Euclidean space. More...

class	vcl::PolymorphicObjectVector< T, N >
	The PolymorphicObjectVector class is a container that stores a collection of polymorphic objects, having a common base class T. More...

class	vcl::PrincipalCurvature< Scalar >
	The PrincipalCurvature class stores the principal curvature directions and values at a point on a 3D surface. More...

class	vcl::Quaternion< Scalar >
	Quaternion class. More...

class	vcl::Segment< PointT >
	A class representing a line segment in n-dimensional space. The class is parameterized by a `PointConcept`, which must provide the `DIM` constant and the `[]` operator for accessing the point coordinates. More...

class	vcl::TexCoord< Scalar >
	The TexCoord class represents a 2-dimensional texture coordinate containing two scalar values. More...

class	vcl::TexCoordIndexed< Scalar >
	The TexCoordIndexed class represents a texture coordinate with an index. More...

class	vcl::TriangleWrapper< PointT >
	The TriangleWrapper class is a wrapper around a N-Dimensional triangle. More...

class	vcl::Vector< T, N >
	The Vector class is a generic container of objects of type `T`, that could have fixed or dynamic size, depending on the templated size `N`. More...

Typedefs
template<typename Scalar >
using	vcl::Array2 = Array< Scalar, 2 >
	A convenience alias for a 2-dimensional Array.

template<typename Scalar >
using	vcl::Array3 = Array< Scalar, 3 >
	A convenience alias for a 3-dimensional Array.

template<typename Scalar >
using	vcl::Array4 = Array< Scalar, 4 >
	A convenience alias for a 4-dimensional Array.

using	vcl::BitSet16 = BitSet< short >
	BitSet16 is a BitSet of 16 bits.

using	vcl::BitSet32 = BitSet< int >
	BitSet32 is a BitSet of 32 bits.

using	vcl::BitSet64 = BitSet< std::size_t >
	BitSet64 is a BitSet of 64 bits.

using	vcl::BitSet8 = BitSet< char >
	BitSet8 is a BitSet of 8 bits.

template<typename Scalar >
using	vcl::Point2 = Point< Scalar, 2 >
	A convenience alias for a 2-dimensional Point.

using	vcl::Point2d = Point2< double >
	A convenience alias for a 2-dimensional Point with double-precision floating-point components.

using	vcl::Point2f = Point2< float >
	A convenience alias for a 2-dimensional Point with floating-point components.

using	vcl::Point2i = Point2< int >
	A convenience alias for a 2-dimensional Point with integer components.

template<typename Scalar >
using	vcl::Point3 = Point< Scalar, 3 >
	A convenience alias for a 3-dimensional Point.

using	vcl::Point3d = Point3< double >
	A convenience alias for a 3-dimensional Point with double-precision floating-point components.

using	vcl::Point3f = Point3< float >
	A convenience alias for a 3-dimensional Point with floating-point components.

using	vcl::Point3i = Point3< int >
	A convenience alias for a 3-dimensional Point with integer components.

template<typename Scalar >
using	vcl::Point4 = Point< Scalar, 4 >
	A convenience alias for a 4-dimensional Point.

using	vcl::Point4d = Point4< double >
	A convenience alias for a 4-dimensional Point with double-precision floating-point components.

using	vcl::Point4f = Point4< float >
	A convenience alias for a 4-dimensional Point with floating-point components.

using	vcl::Point4i = Point4< int >
	A convenience alias for a 4-dimensional Point with integer components.

template<typename Scalar >
using	vcl::Polygon2 = Polygon< Point2< Scalar > >
	A convenience alias for a 2D polygon.

using	vcl::Polygon2d = Polygon< Point2d >
	A convenience alias for a 2D polygon with double precision floating point coordinates.

using	vcl::Polygon2f = Polygon< Point2f >
	A convenience alias for a 2D polygon with single precision floating point coordinates.

template<typename Scalar >
using	vcl::Polygon3 = Polygon< Point3< Scalar > >
	A convenience alias for a 3D polygon.

using	vcl::Polygon3d = Polygon< Point3d >
	A convenience alias for a 3D polygon with double precision floating point coordinates.

using	vcl::Polygon3f = Polygon< Point3f >
	A convenience alias for a 3D polygon with single precision floating point coordinates.

using	vcl::Quaterniond = Quaternion< double >
	A convenience alias for Quaternion with double-precision floating-point components.

using	vcl::Quaternionf = Quaternion< float >
	A convenience alias for Quaternion with floating-point components.

Functions
template<MatrixConcept MatrixType>
vcl::MatrixStorageType	vcl::matrixStorageType ()
	Get the storage type of a matrix.

Detailed Description

List of the Core Data Structures of VCLib.

In this module, you can find the core data structures of VCLib, such as simple geometric primitives, like points, vectors, and matrices, as well as more complex data structures, like images, textures, and bounding boxes.

You can access all the algorithms of VCLib by including #include <vclib/space/core.h>

Typedef Documentation

◆ Array2

template<typename Scalar >

using vcl::Array2 = typedef Array<Scalar, 2>

A convenience alias for a 2-dimensional Array.

It is an alias is a shorthand for a Array class template specialization with a scalar type of Scalar and two dimensions.

Template Parameters

Scalar The scalar type of the array components.

◆ Array3

template<typename Scalar >

using vcl::Array3 = typedef Array<Scalar, 3>

A convenience alias for a 3-dimensional Array.

It is an alias is a shorthand for a Array class template specialization with a scalar type of Scalar and three dimensions.

Template Parameters

Scalar The scalar type of the array components.

◆ Array4

template<typename Scalar >

using vcl::Array4 = typedef Array<Scalar, 4>

A convenience alias for a 4-dimensional Array.

It is an alias is a shorthand for a Array class template specialization with a scalar type of Scalar and four dimensions.

Template Parameters

Scalar The scalar type of the array components.

◆ Point2

template<typename Scalar >

using vcl::Point2 = typedef Point<Scalar, 2>

A convenience alias for a 2-dimensional Point.

The Point2 alias is a shorthand for a Point class template specialization with a scalar type of Scalar and two dimensions. It is implemented as an alias template for the Point class template.

Template Parameters

Scalar The scalar type of the point components.

◆ Point2d

using vcl::Point2d = typedef Point2<double>

A convenience alias for a 2-dimensional Point with double-precision floating-point components.

The Point2d alias is a shorthand for a Point class template specialization with double-precision floating-point components and two dimensions. It is implemented as an alias template for the Point2 alias template.

◆ Point2f

using vcl::Point2f = typedef Point2<float>

A convenience alias for a 2-dimensional Point with floating-point components.

The Point2f alias is a shorthand for a Point class template specialization with floating-point components and two dimensions. It is implemented as an alias template for the Point2 alias template.

◆ Point2i

using vcl::Point2i = typedef Point2<int>

A convenience alias for a 2-dimensional Point with integer components.

The Point2i alias is a shorthand for a Point class template specialization with integer components and two dimensions. It is implemented as an alias template for the Point2 alias template.

◆ Point3

template<typename Scalar >

using vcl::Point3 = typedef Point<Scalar, 3>

A convenience alias for a 3-dimensional Point.

The Point3 alias is a shorthand for a Point class template specialization with a scalar type of Scalar and three dimensions. It is implemented as an alias template for the Point class template.

Template Parameters

Scalar The scalar type of the point components.

◆ Point3d

using vcl::Point3d = typedef Point3<double>

A convenience alias for a 3-dimensional Point with double-precision floating-point components.

The Point3d alias is a shorthand for a Point class template specialization with double-precision floating-point components and three dimensions. It is implemented as an alias template for the Point3 alias template.

◆ Point3f

using vcl::Point3f = typedef Point3<float>

A convenience alias for a 3-dimensional Point with floating-point components.

The Point3f alias is a shorthand for a Point class template specialization with floating-point components and three dimensions. It is implemented as an alias template for the Point3 alias template.

◆ Point3i

using vcl::Point3i = typedef Point3<int>

A convenience alias for a 3-dimensional Point with integer components.

The Point3i alias is a shorthand for a Point class template specialization with integer components and three dimensions. It is implemented as an alias template for the Point3 alias template.

◆ Point4

template<typename Scalar >

using vcl::Point4 = typedef Point<Scalar, 4>

A convenience alias for a 4-dimensional Point.

The Point4 alias is a shorthand for a Point class template specialization with a scalar type of Scalar and four dimensions. It is implemented as an alias template for the Point class template.

Template Parameters

Scalar The scalar type of the point components.

◆ Point4d

using vcl::Point4d = typedef Point4<double>

A convenience alias for a 4-dimensional Point with double-precision floating-point components.

The Point4d alias is a shorthand for a Point class template specialization with double-precision floating-point components and four dimensions. It is implemented as an alias template for the Point4 alias template.

◆ Point4f

using vcl::Point4f = typedef Point4<float>

A convenience alias for a 4-dimensional Point with floating-point components.

The Point4f alias is a shorthand for a Point class template specialization with floating-point components and four dimensions. It is implemented as an alias template for the Point4 alias template.

◆ Point4i

using vcl::Point4i = typedef Point4<int>

A convenience alias for a 4-dimensional Point with integer components.

The Point4i alias is a shorthand for a Point class template specialization with integer components and four dimensions. It is implemented as an alias template for the Point4 alias template.

◆ Polygon2

template<typename Scalar >

using vcl::Polygon2 = typedef Polygon<Point2<Scalar> >

A convenience alias for a 2D polygon.

Template Parameters

Scalar the scalar type used to represent the coordinates of the points that define the polygon.

◆ Polygon3

template<typename Scalar >

using vcl::Polygon3 = typedef Polygon<Point3<Scalar> >

A convenience alias for a 3D polygon.

Template Parameters

Scalar the scalar type used to represent the coordinates of the points that define the polygon.

◆ Quaterniond

using vcl::Quaterniond = typedef Quaternion<double>

A convenience alias for Quaternion with double-precision floating-point components.

The Quaterniond alias is a shorthand for a Quaternion class template specialization with double-precision floating-point components.

◆ Quaternionf

using vcl::Quaternionf = typedef Quaternion<float>

A convenience alias for Quaternion with floating-point components.

The Quaternionf alias is a shorthand for a Quaternion class template specialization with floating-point components.

Function Documentation

◆ matrixStorageType()

template<MatrixConcept MatrixType>

vcl::MatrixStorageType vcl::matrixStorageType ( )

Get the storage type of a matrix.

Template Parameters

MatrixType The type of the matrix, it must satisfy the MatrixConcept.

Returns: The storage type of the matrix.

Concepts

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ Array2

◆ Array3

◆ Array4

◆ Point2

◆ Point2d

◆ Point2f

◆ Point2i

◆ Point3

◆ Point3d

◆ Point3f

◆ Point3i

◆ Point4

◆ Point4d

◆ Point4f

◆ Point4i

◆ Polygon2

◆ Polygon3

◆ Quaterniond

◆ Quaternionf

Function Documentation

◆ matrixStorageType()