DGtal::DecoratorParametricCurveTransformation< TCurve, TTransfromation > Class Template Reference

Aim: Implements a decorator for applying transformations to parametric curves. More...

#include <DGtal/geometry/curves/parametric/DecoratorParametricCurveTransformation.h>

Public Types
typedef TCurve	TypeCurve
typedef TCurve::Space	Space
typedef Space::RealPoint	RealPoint
typedef Space::Point	Point

Public Member Functions
	DecoratorParametricCurveTransformation (const TCurve &, const TTransfromation &)
	~DecoratorParametricCurveTransformation ()=default
RealPoint	x (double t) const
RealPoint	xp (double t) const
void	selfDisplay (std::ostream &out) const
bool	isValid () const

Data Fields
const TCurve &	curve

Protected Member Functions
	DecoratorParametricCurveTransformation ()

Private Member Functions
	BOOST_CONCEPT_ASSERT ((concepts::C3DParametricCurve< TCurve >))
	DecoratorParametricCurveTransformation (const DecoratorParametricCurveTransformation &other)
DecoratorParametricCurveTransformation &	operator= (const DecoratorParametricCurveTransformation &other)

Private Attributes
const TTransfromation &	trans

Detailed Description

template<typename TCurve, typename TTransfromation>
class DGtal::DecoratorParametricCurveTransformation< TCurve, TTransfromation >

Aim: Implements a decorator for applying transformations to parametric curves.

Description of class 'DecoratorParametricCurveTransformation'

Template Parameters

TCurve	a model of C3DParametricCurve
TTransfromation	a functor taking an instance of TCurve::Space::RealPoint and returning an instance of TCurve::Space::RealPoint

Definition at line 63 of file DecoratorParametricCurveTransformation.h.

Member Typedef Documentation

Point

template<typename TCurve , typename TTransfromation >

typedef Space::Point DGtal::DecoratorParametricCurveTransformation< TCurve, TTransfromation >::Point

Definition at line 72 of file DecoratorParametricCurveTransformation.h.

RealPoint

template<typename TCurve , typename TTransfromation >

typedef Space::RealPoint DGtal::DecoratorParametricCurveTransformation< TCurve, TTransfromation >::RealPoint

Definition at line 71 of file DecoratorParametricCurveTransformation.h.

Space

template<typename TCurve , typename TTransfromation >

typedef TCurve::Space DGtal::DecoratorParametricCurveTransformation< TCurve, TTransfromation >::Space

Definition at line 70 of file DecoratorParametricCurveTransformation.h.

TypeCurve

template<typename TCurve , typename TTransfromation >

typedef TCurve DGtal::DecoratorParametricCurveTransformation< TCurve, TTransfromation >::TypeCurve

Definition at line 69 of file DecoratorParametricCurveTransformation.h.

Constructor & Destructor Documentation

DecoratorParametricCurveTransformation() [1/3]

template<typename TCurve , typename TTransfromation >

DGtal::DecoratorParametricCurveTransformation< TCurve, TTransfromation >::DecoratorParametricCurveTransformation	(	const TCurve &	,
		const TTransfromation &	)

~DecoratorParametricCurveTransformation()

template<typename TCurve , typename TTransfromation >

DGtal::DecoratorParametricCurveTransformation< TCurve, TTransfromation >::~DecoratorParametricCurveTransformation ( )

default

Destructor.

DecoratorParametricCurveTransformation() [2/3]

template<typename TCurve , typename TTransfromation >

DGtal::DecoratorParametricCurveTransformation< TCurve, TTransfromation >::DecoratorParametricCurveTransformation ( )

protected

Constructor. Forbidden by default (protected to avoid g++ warnings).

DecoratorParametricCurveTransformation() [3/3]

template<typename TCurve , typename TTransfromation >

DGtal::DecoratorParametricCurveTransformation< TCurve, TTransfromation >::DecoratorParametricCurveTransformation ( const DecoratorParametricCurveTransformation< TCurve, TTransfromation > & other )

private

Copy constructor.

Parameters

other

the object to clone. Forbidden by default.

Member Function Documentation

BOOST_CONCEPT_ASSERT()

template<typename TCurve , typename TTransfromation >

DGtal::DecoratorParametricCurveTransformation< TCurve, TTransfromation >::BOOST_CONCEPT_ASSERT ( (concepts::C3DParametricCurve< TCurve >) )

private

isValid()

template<typename TCurve , typename TTransfromation >

bool DGtal::DecoratorParametricCurveTransformation< TCurve, TTransfromation >::isValid

(

)

const

Checks the validity/consistency of the object.

Returns

'true' if the object is valid, 'false' otherwise.

operator=()

template<typename TCurve , typename TTransfromation >

DecoratorParametricCurveTransformation & DGtal::DecoratorParametricCurveTransformation< TCurve, TTransfromation >::operator= ( const DecoratorParametricCurveTransformation< TCurve, TTransfromation > & other )

private

Assignment.

Parameters

other

the object to copy.

Returns

a reference on 'this'. Forbidden by default.

selfDisplay()

template<typename TCurve , typename TTransfromation >

void DGtal::DecoratorParametricCurveTransformation< TCurve, TTransfromation >::selfDisplay

(

std::ostream &

out

)

const

Writes/Displays the object on an output stream.

Parameters

out	the output stream where the object is written.

x()

template<typename TCurve , typename TTransfromation >

RealPoint DGtal::DecoratorParametricCurveTransformation< TCurve, TTransfromation >::x

(

double

t

)

const

Parameters

t	any angle between 0 and k*Pi.

Returns

the vector (x(t),y(t), z(t))

xp()

template<typename TCurve , typename TTransfromation >

RealPoint DGtal::DecoratorParametricCurveTransformation< TCurve, TTransfromation >::xp

(

double

t

)

const

Parameters

t	any angle between 0 and k*Pi.

Returns

the vector (x(t)',y(t)', z(t)')

Field Documentation

curve

template<typename TCurve , typename TTransfromation >

const TCurve& DGtal::DecoratorParametricCurveTransformation< TCurve, TTransfromation >::curve

Definition at line 83 of file DecoratorParametricCurveTransformation.h.

trans

template<typename TCurve , typename TTransfromation >

const TTransfromation& DGtal::DecoratorParametricCurveTransformation< TCurve, TTransfromation >::trans

private

Definition at line 145 of file DecoratorParametricCurveTransformation.h.

---

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

• DecoratorParametricCurveTransformation.h