scatter 0.1.0
scatter::Arrow Class Reference

[brief description] More...

#include <Arrow.hpp>

Public Member Functions

 Arrow (const Point &p1, const Point &p2)
 constructor from two Point
 
 Arrow (const Point &p1, const double &length, const double &angle)
 constructor from start Point, angle and length
 
virtual ~Arrow ()
 destructor
 
const std::array< Point, 4 > & getPoints () const
 access the Point array representing the Arrow
 

Detailed Description

[brief description]

[long description]

Constructor & Destructor Documentation

◆ Arrow() [1/2]

scatter::Arrow::Arrow ( const Point & p1,
const Point & p2 )

constructor from two Point

[long description]

Parameters
p1Point 1 (tail)
p2Point 2 (head)

◆ Arrow() [2/2]

scatter::Arrow::Arrow ( const Point & p1,
const double & length,
const double & angle )

constructor from start Point, angle and length

[long description]

Parameters
p1start Point
lengthlength of the Arrow
angleangle of Arrow to the horizontal axis (in rad)

◆ ~Arrow()

virtual scatter::Arrow::~Arrow ( )
virtual

destructor

[long description]

Member Function Documentation

◆ getPoints()

const std::array< Point, 4 > & scatter::Arrow::getPoints ( ) const

access the Point array representing the Arrow

this include the Arrow head

Returns
Point array

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