IVT
Public Member Functions | Public Attributes | List of all members
StraightLine2d Struct Reference

Data structure for the representation of a 2D straight line. More...

#include <Structs.h>

Public Member Functions

 StraightLine2d ()
 
 StraightLine2d (const Vec2d &point1, const Vec2d &point2)
 
 StraightLine2d (float angle, float c)
 
 StraightLine2d (const PointPair2d &pointPair)
 

Public Attributes

Vec2d point
 An aribtrary point belonging to the straight line. More...
 
Vec2d directionVector
 The normalized direction vector of the straight line. More...
 
Vec2d normalVector
 The normalized normal vector of the straight line. More...
 
float c
 The negative scalar product of normalVector and point. More...
 

Detailed Description

Data structure for the representation of a 2D straight line.

The function PrimitivesDrawer::DrawLine draws a straight line, given its specification in this struct. Other functions (e.g. detectors) can use this struct as well.

The two independent straight line equations are:

  1. $\vec{n} \cdot (\vec{x} - \vec{a}) = \vec{n} \cdot \vec{x} - \vec{n} \cdot \vec{a} = \vec{n} \cdot \vec{x} + c$.
  2. $\vec{x} = \vec{a} + r \cdot \vec{u},\ \ r \in R$

where any $\vec{x}$ satisfying one of these equations belongs to the straight line, $\vec{a}$ = point, $\vec{u}$ = directionVector, and $\vec{n}$ = normalVector.

Definition at line 179 of file Structs.h.

Constructor & Destructor Documentation

StraightLine2d::StraightLine2d ( )
inline

Definition at line 181 of file Structs.h.

StraightLine2d::StraightLine2d ( const Vec2d &  point1,
const Vec2d &  point2 
)
inline

Definition at line 189 of file Structs.h.

StraightLine2d::StraightLine2d ( float  angle,
float  c 
)
inline

Definition at line 207 of file Structs.h.

StraightLine2d::StraightLine2d ( const PointPair2d &  pointPair)
inline

Definition at line 229 of file Structs.h.

Member Data Documentation

float StraightLine2d::c

The negative scalar product of normalVector and point.

Definition at line 252 of file Structs.h.

Vec2d StraightLine2d::directionVector

The normalized direction vector of the straight line.

Definition at line 242 of file Structs.h.

Vec2d StraightLine2d::normalVector

The normalized normal vector of the straight line.

Definition at line 247 of file Structs.h.

Vec2d StraightLine2d::point

An aribtrary point belonging to the straight line.

Definition at line 237 of file Structs.h.

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