OSegment3D Class Reference

Class to define a segment. More...

#include <3d.h>

Inheritance diagram for OSegment3D:

Collaboration diagram for OSegment3D:

Public Member Functions
	OSegment3D ()
	Default constructor. More...
	OSegment3D (const OSegment3D &other)
	Copy constructor. More...
	OSegment3D (const OPoint3D &ptA, const OPoint3D &ptB)
virtual	~OSegment3D ()
	Destructor. More...
virtual OSegment3D &	operator= (const OSegment3D &other)
	operator= More...
virtual bool	operator== (const OSegment3D &other) const
	operator== More...
virtual bool	operator!= (const OSegment3D &other) const
	operator!= More...
virtual OSegment3D	operator* (const OMatrix &matrix) const
	Multiplication with a matrix. More...
virtual double	longueur () const
	Return the segment length. More...
virtual int	symetrieOf (const OPoint3D &pt, OPoint3D &ptSym) const
	Return the symmetrical of a point. More...
virtual int	projection (const OPoint3D &pt, OPoint3D &ptProj, double seuilConfondus) const
	Return the projection of a point. More...
virtual int	intersects (const OSegment3D &seg, OPoint3D &pt, double seuilConfondus) const
	Return the intersection point with another segment. More...
virtual OPoint3D	centreOf () const
	Return the position of the segment middle. More...
virtual OPoint3D	centerOfCurvedPath (const double &R) const
	Return the position of the arc circle center of radius R passing by the segment extremities. More...
virtual double	lengthOfCurvedPath (const double &R)
	Calculate the path length of radius R passing by the segment extremities. More...
virtual OVector3D	toVector3D () const
	Build a OVector3D from a segment used for the direction of the sources. More...
virtual OSegment3D	swap () const
	Return the segment. More...
	OSegment3D ()
	Default constructor. More...
	OSegment3D (const OSegment3D &other)
	Copy constructor. More...
	OSegment3D (const OPoint3D &ptA, const OPoint3D &ptB)
virtual	~OSegment3D ()
	Destructor. More...
virtual OSegment3D &	operator= (const OSegment3D &other)
	operator= More...
virtual bool	operator== (const OSegment3D &other) const
	operator== More...
virtual bool	operator!= (const OSegment3D &other) const
	operator!= More...
virtual OSegment3D	operator* (const OMatrix &matrix) const
virtual double	longueur () const
virtual int	symetrieOf (const OPoint3D &pt, OPoint3D &ptSym) const
virtual int	projection (const OPoint3D &pt, OPoint3D &ptProj, double seuilConfondus) const
virtual int	intersects (const OSegment3D &seg, OPoint3D &pt, double seuilConfondus) const
virtual OPoint3D	centreOf () const
virtual OPoint3D	centerOfCurvedPath (const double &R) const
virtual double	lengthOfCurvedPath (const double &R)
virtual OVector3D	toVector3D () const
virtual OSegment3D	swap () const

Public Attributes
OPoint3D	_ptA
	Point A of the segment. More...
OPoint3D	_ptB
	Point B of the segment. More...

Detailed Description

Class to define a segment.

Definition at line 1087 of file 3d.h.

Constructor & Destructor Documentation

OSegment3D() [1/6]

OSegment3D::OSegment3D

(

)

Default constructor.

Definition at line 1156 of file 3d.cpp.

Here is the caller graph for this function:

OSegment3D() [2/6]

OSegment3D::OSegment3D

(

const OSegment3D &

other

)

Copy constructor.

Definition at line 1162 of file 3d.cpp.

OSegment3D() [3/6]

OSegment3D::OSegment3D	(	const OPoint3D &	ptA,
		const OPoint3D &	ptB
	)

Definition at line 1167 of file 3d.cpp.

~OSegment3D() [1/2]

OSegment3D::~OSegment3D ( )

virtual

Destructor.

Definition at line 1173 of file 3d.cpp.

Here is the caller graph for this function:

OSegment3D() [4/6]

OSegment3D::OSegment3D

(

)

Default constructor.

OSegment3D() [5/6]

OSegment3D::OSegment3D

(

const OSegment3D &

other

)

Copy constructor.

OSegment3D() [6/6]

OSegment3D::OSegment3D	(	const OPoint3D &	ptA,
		const OPoint3D &	ptB
	)

~OSegment3D() [2/2]

virtual OSegment3D::~OSegment3D ( )

virtual

Destructor.

Member Function Documentation

centerOfCurvedPath() [1/2]

virtual OPoint3D OSegment3D::centerOfCurvedPath ( const double &  R ) const

virtual

centerOfCurvedPath() [2/2]

OPoint3D OSegment3D::centerOfCurvedPath ( const double &  R ) const

virtual

Return the position of the arc circle center of radius R passing by the segment extremities.

Returns

OPoint3D Position of the arc circle center.

Definition at line 1271 of file 3d.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

centreOf() [1/2]

virtual OPoint3D OSegment3D::centreOf ( ) const

virtual

centreOf() [2/2]

OPoint3D OSegment3D::centreOf ( ) const

virtual

Return the position of the segment middle.

Returns

OPoint3D

Definition at line 1262 of file 3d.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

intersects() [1/2]

virtual int OSegment3D::intersects ( const OSegment3D &  seg, OPoint3D &  pt, double  seuilConfondus  ) const

virtual

intersects() [2/2]

int OSegment3D::intersects ( const OSegment3D &  seg, OPoint3D &  pt, double  seuilConfondus  ) const

virtual

Return the intersection point with another segment.

Parameters

seg	Another segment.
pt	The intersection point.
seuilConfondus	Minimal distance between a point and a segment for which they are considered as overlaid

Returns

INTERS_OUI (1) if the intersection exists, INTERS_CONFONDU (2) if the elements are overlaid, INTERS_NULLE (0) if there is no intersection.

Definition at line 1236 of file 3d.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

lengthOfCurvedPath() [1/2]

virtual double OSegment3D::lengthOfCurvedPath ( const double &  R )

virtual

lengthOfCurvedPath() [2/2]

double OSegment3D::lengthOfCurvedPath ( const double &  R )

virtual

Calculate the path length of radius R passing by the segment extremities.

Parameters

R	radius R of the circle

Returns

length of curved path

Definition at line 1293 of file 3d.cpp.

Here is the caller graph for this function:

longueur() [1/2]

virtual double OSegment3D::longueur ( ) const

virtual

longueur() [2/2]

double OSegment3D::longueur ( ) const

virtual

Return the segment length.

Definition at line 1207 of file 3d.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

operator!=() [1/2]

virtual bool OSegment3D::operator!= ( const OSegment3D &  other ) const

virtual

operator!=

operator!=() [2/2]

bool OSegment3D::operator!= ( const OSegment3D &  other ) const

virtual

operator!=

Definition at line 1197 of file 3d.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

operator*() [1/2]

virtual OSegment3D OSegment3D::operator* ( const OMatrix &  matrix ) const

virtual

operator*() [2/2]

OSegment3D OSegment3D::operator* ( const OMatrix &  matrix ) const

virtual

Multiplication with a matrix.

Parameters

matrix

The matrix to apply to the segment points.

Returns

A copy of this transformed segment.

Definition at line 1202 of file 3d.cpp.

Here is the caller graph for this function:

operator=() [1/2]

virtual OSegment3D& OSegment3D::operator= ( const OSegment3D &  other )

virtual

operator=

operator=() [2/2]

OSegment3D & OSegment3D::operator= ( const OSegment3D &  other )

virtual

operator=

Definition at line 1177 of file 3d.cpp.

Here is the caller graph for this function:

operator==() [1/2]

virtual bool OSegment3D::operator== ( const OSegment3D &  other ) const

virtual

operator==

operator==() [2/2]

bool OSegment3D::operator== ( const OSegment3D &  other ) const

virtual

operator==

Definition at line 1187 of file 3d.cpp.

Here is the caller graph for this function:

projection() [1/2]

virtual int OSegment3D::projection ( const OPoint3D &  pt, OPoint3D &  ptProj, double  seuilConfondus  ) const

virtual

projection() [2/2]

int OSegment3D::projection ( const OPoint3D &  pt, OPoint3D &  ptProj, double  seuilConfondus  ) const

virtual

Return the projection of a point.

Parameters

pt	The point we want the projection.
ptProj	The projected point.
seuilConfondus	Minimal distance between the point and the segment for which they are considered as overlaid

Returns

1 if the calculation succeeds, 0 if not.

Definition at line 1227 of file 3d.cpp.

Here is the caller graph for this function:

swap() [1/2]

virtual OSegment3D OSegment3D::swap ( ) const

virtual

swap() [2/2]

OSegment3D OSegment3D::swap ( ) const

virtual

Return the segment.

Definition at line 1302 of file 3d.cpp.

Here is the caller graph for this function:

symetrieOf() [1/2]

virtual int OSegment3D::symetrieOf ( const OPoint3D &  pt, OPoint3D &  ptSym  ) const

virtual

symetrieOf() [2/2]

int OSegment3D::symetrieOf ( const OPoint3D &  pt, OPoint3D &  ptSym  ) const

virtual

Return the symmetrical of a point.

Parameters

pt	The point we want the symmetrical.
ptSym	The symmetrical point.

Returns

1 if the calculation succeeds, 0 if not.

Definition at line 1212 of file 3d.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

toVector3D() [1/2]

virtual OVector3D OSegment3D::toVector3D ( ) const

inlinevirtual

Definition at line 1185 of file 3d.h.

Here is the call graph for this function:

toVector3D() [2/2]

OVector3D OSegment3D::toVector3D ( ) const

inlinevirtual

Build a OVector3D from a segment used for the direction of the sources.

Returns

A reference to a OVector3D

Definition at line 1187 of file 3d.h.

Here is the caller graph for this function:

Member Data Documentation

_ptA

OPoint3D OSegment3D::_ptA

Point A of the segment.

Definition at line 1197 of file 3d.h.

_ptB

OPoint3D OSegment3D::_ptB

Point B of the segment.

Definition at line 1199 of file 3d.h.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/codetympan/checkouts/latest/Tympan/geometric_methods/AcousticRaytracer/Geometry/3d.h
• /home/docs/checkouts/readthedocs.org/user_builds/codetympan/checkouts/latest/Tympan/geometric_methods/AcousticRaytracer/Geometry/3d.cpp