geo::AffinePlaneBase< Vector, Point > Class Template Reference

#include "Decomposer.h"

Public Types
using	Vector_t = typename PlaneBase_t::Vector_t
	Vector in space. More...
using	Point_t = Point
	Point in space. More...

Public Member Functions
	AffinePlaneBase (Point_t const &origin, Vector_t const &main, Vector_t const &secondary)
	Constructor: assigns the origin of the system and the axes. More...
Vector_t const &	MainDir () const
	Returns the main axis direction. More...
Vector_t const &	SecondaryDir () const
	Returns the secondary axis direction. More...
Vector_t const &	NormalDir () const
	Returns the secondary axis direction. More...
Point_t	Origin () const
	Returns the origin of the coordinate system in world coordinates. More...
Vector_t	ToVector (Point_t const &point) const
	Returns the vector representing the specified point in the affine space. More...
void	SetOrigin (Point_t const &point)
	Change the 3D point of the reference frame origin. More...
void	SetMainDir (Vector_t const &dir)
	Change the main direction of the projection base. More...
void	SetSecondaryDir (Vector_t const &dir)
	Change the secondary direction of the projection base. More...

Private Types
using	PlaneBase_t = PlaneBase< Vector >

Private Attributes
Point_t	fOrigin
	Origin of the coordinate system. More...
PlaneBase_t	fBase
	Base. More...

Detailed Description

template<typename Vector, typename Point = Vector>
class geo::AffinePlaneBase< Vector, Point >

A base for a plane in space, with a coordinate system

Template Parameters

Vector	type to represent 3D vectors
Point	type to represent 3D points (same as Vector by default)

Definition at line 98 of file Decomposer.h.

Member Typedef Documentation

template<typename Vector, typename Point = Vector>

using geo::AffinePlaneBase< Vector, Point >::PlaneBase_t = PlaneBase<Vector>

private

Definition at line 99 of file Decomposer.h.

template<typename Vector, typename Point = Vector>

using geo::AffinePlaneBase< Vector, Point >::Point_t = Point

Point in space.

Definition at line 103 of file Decomposer.h.

template<typename Vector, typename Point = Vector>

using geo::AffinePlaneBase< Vector, Point >::Vector_t = typename PlaneBase_t::Vector_t

Vector in space.

Definition at line 102 of file Decomposer.h.

Constructor & Destructor Documentation

template<typename Vector, typename Point = Vector>

geo::AffinePlaneBase< Vector, Point >::AffinePlaneBase ( Point_t const &  origin, Vector_t const &  main, Vector_t const &  secondary  )

inline

Constructor: assigns the origin of the system and the axes.

Definition at line 106 of file Decomposer.h.

      : fOrigin(origin), fBase(main, secondary)
    {}

Member Function Documentation

template<typename Vector, typename Point = Vector>

Vector_t const& geo::AffinePlaneBase< Vector, Point >::MainDir ( ) const

inline

Returns the main axis direction.

Definition at line 111 of file Decomposer.h.

{ return fBase.MainDir(); }

template<typename Vector, typename Point = Vector>

Vector_t const& geo::AffinePlaneBase< Vector, Point >::NormalDir ( ) const

inline

Returns the secondary axis direction.

Definition at line 117 of file Decomposer.h.

{ return fBase.NormalDir(); }

template<typename Vector, typename Point = Vector>

Point_t geo::AffinePlaneBase< Vector, Point >::Origin ( ) const

inline

Returns the origin of the coordinate system in world coordinates.

Definition at line 120 of file Decomposer.h.

{ return fOrigin; }

template<typename Vector, typename Point = Vector>

Vector_t const& geo::AffinePlaneBase< Vector, Point >::SecondaryDir ( ) const

inline

Returns the secondary axis direction.

Definition at line 114 of file Decomposer.h.

{ return fBase.SecondaryDir(); }

template<typename Vector, typename Point = Vector>

void geo::AffinePlaneBase< Vector, Point >::SetMainDir ( Vector_t const &  dir )

inline

Change the main direction of the projection base.

Definition at line 129 of file Decomposer.h.

{ fBase.SetMainDir(dir); }

template<typename Vector, typename Point = Vector>

void geo::AffinePlaneBase< Vector, Point >::SetOrigin ( Point_t const &  point )

inline

Change the 3D point of the reference frame origin.

Definition at line 126 of file Decomposer.h.

{ fOrigin = point; }

template<typename Vector, typename Point = Vector>

void geo::AffinePlaneBase< Vector, Point >::SetSecondaryDir ( Vector_t const &  dir )

inline

Change the secondary direction of the projection base.

Definition at line 132 of file Decomposer.h.

{ fBase.SetSecondaryDir(dir); }

template<typename Vector, typename Point = Vector>

Vector_t geo::AffinePlaneBase< Vector, Point >::ToVector ( Point_t const &  point ) const

inline

Returns the vector representing the specified point in the affine space.

Definition at line 123 of file Decomposer.h.

{ return point - Origin(); }

Member Data Documentation

template<typename Vector, typename Point = Vector>

PlaneBase_t geo::AffinePlaneBase< Vector, Point >::fBase

private

Base.

Definition at line 136 of file Decomposer.h.

template<typename Vector, typename Point = Vector>

Point_t geo::AffinePlaneBase< Vector, Point >::fOrigin

private

Origin of the coordinate system.

Definition at line 135 of file Decomposer.h.

---

The documentation for this class was generated from the following file:

• larcorealg/v09_13_01/source/larcorealg/Geometry/Decomposer.h