DGtal  1.0.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Static Private Attributes
DGtal::Knot_5_2< TSpace > Class Template Reference

Aim: Implement a parametrized knot 5, 2. More...

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

Public Types

typedef TSpace Space
 
typedef TSpace::RealPoint RealPoint
 
typedef TSpace::Point Point
 

Public Member Functions

 ~Knot_5_2 ()
 
 Knot_5_2 (long double scale_1, long double scale_2, long double scale_3)
 
RealPoint x (long double t) const
 
RealPoint xp (long double t) const
 
void selfDisplay (std::ostream &out) const
 
bool isValid () const
 

Static Public Member Functions

static double getPeriod ()
 

Protected Member Functions

 Knot_5_2 ()
 

Private Member Functions

 Knot_5_2 (const Knot_5_2 &other)
 
Knot_5_2operator= (const Knot_5_2 &other)
 

Private Attributes

long double scale [3]
 

Static Private Attributes

static constexpr double PERIOD = M_PI * 2.0
 

Detailed Description

template<typename TSpace>
class DGtal::Knot_5_2< TSpace >

Aim: Implement a parametrized knot 5, 2.

Description of class 'Knot_5_2'

Template Parameters
TSpacemodel of CSpace

Definition at line 59 of file Knot_5_2.h.

Member Typedef Documentation

◆ Point

template<typename TSpace>
typedef TSpace::Point DGtal::Knot_5_2< TSpace >::Point

Definition at line 65 of file Knot_5_2.h.

◆ RealPoint

template<typename TSpace>
typedef TSpace::RealPoint DGtal::Knot_5_2< TSpace >::RealPoint

Definition at line 64 of file Knot_5_2.h.

◆ Space

template<typename TSpace>
typedef TSpace DGtal::Knot_5_2< TSpace >::Space

Definition at line 63 of file Knot_5_2.h.

Constructor & Destructor Documentation

◆ ~Knot_5_2()

template<typename TSpace>
DGtal::Knot_5_2< TSpace >::~Knot_5_2 ( )
inline

Destructor.

Definition at line 70 of file Knot_5_2.h.

70 {}

◆ Knot_5_2() [1/3]

template<typename TSpace>
DGtal::Knot_5_2< TSpace >::Knot_5_2 ( long double  scale_1,
long double  scale_2,
long double  scale_3 
)

Constructor.

Parameters
scale_1x-axis scaling factor
scale_2y-axis scaling factor
scale_3z-axis scaling factor

◆ Knot_5_2() [2/3]

template<typename TSpace>
DGtal::Knot_5_2< TSpace >::Knot_5_2 ( )
protected

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

◆ Knot_5_2() [3/3]

template<typename TSpace>
DGtal::Knot_5_2< TSpace >::Knot_5_2 ( const Knot_5_2< TSpace > &  other)
private

Copy constructor.

Parameters
otherthe object to clone. Forbidden by default.

Member Function Documentation

◆ getPeriod()

template<typename TSpace>
static double DGtal::Knot_5_2< TSpace >::getPeriod ( )
static

◆ isValid()

template<typename TSpace>
bool DGtal::Knot_5_2< TSpace >::isValid ( ) const

Checks the validity/consistency of the object.

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

◆ operator=()

template<typename TSpace>
Knot_5_2& DGtal::Knot_5_2< TSpace >::operator= ( const Knot_5_2< TSpace > &  other)
private

Assignment.

Parameters
otherthe object to copy.
Returns
a reference on 'this'. Forbidden by default.

◆ selfDisplay()

template<typename TSpace>
void DGtal::Knot_5_2< TSpace >::selfDisplay ( std::ostream &  out) const

Writes/Displays the object on an output stream.

Parameters
outthe output stream where the object is written.

◆ x()

template<typename TSpace>
RealPoint DGtal::Knot_5_2< TSpace >::x ( long double  t) const
Parameters
tany value.
Returns
the vector (x(t), y(t), z(t))

◆ xp()

template<typename TSpace>
RealPoint DGtal::Knot_5_2< TSpace >::xp ( long double  t) const
Parameters
tany value.
Returns
the vector (x(t)', y(t)', z(t)')

Field Documentation

◆ PERIOD

template<typename TSpace>
constexpr double DGtal::Knot_5_2< TSpace >::PERIOD = M_PI * 2.0
staticprivate

Definition at line 148 of file Knot_5_2.h.

◆ scale

template<typename TSpace>
long double DGtal::Knot_5_2< TSpace >::scale[3]
private

Definition at line 118 of file Knot_5_2.h.


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