Warning: include(php/utility.php): Failed to open stream: No such file or directory in /home/argos/argos3/doc/api/embedded/a02398.php on line 2

Warning: include(): Failed opening 'php/utility.php' for inclusion (include_path='.:/usr/lib64/php') in /home/argos/argos3/doc/api/embedded/a02398.php on line 2
The ARGoS Website

argos::CRay2 Class Reference

#include <ray2.h>

Public Member Functions

 CRay2 ()
 
 CRay2 (const CVector2 &c_start, const CVector2 &c_end)
 
 CRay2 (const CVector2 &c_start, const CVector2 &c_direction, Real f_length)
 
const CVector2GetStart () const
 
const CVector2GetEnd () const
 
void SetStart (const CVector2 &c_start)
 
void SetEnd (const CVector2 &c_end)
 
void Set (const CVector2 &c_start, const CVector2 &c_end)
 
void Set (const CVector2 &c_start, const CVector2 &c_direction, Real f_length)
 
void GetDirection (CVector2 &c_buffer) const
 
void GetInverseDirection (CVector2 &c_buffer) const
 
Real GetLength () const
 
void ToVector (CVector2 &c_buffer) const
 
void GetPoint (CVector2 &c_point, Real f_t) const
 
Real GetDistance (Real f_t) const
 
bool Intersects (const CRay2 &c_ray) const
 

Friends

std::ostream & operator<< (std::ostream &c_os, const CRay2 &c_ray)
 Serializes the contents of the passed ray onto a stream. More...
 

Detailed Description

Definition at line 18 of file ray2.h.

Constructor & Destructor Documentation

◆ CRay2() [1/3]

argos::CRay2::CRay2 ( )
inline

Definition at line 22 of file ray2.h.

◆ CRay2() [2/3]

argos::CRay2::CRay2 ( const CVector2 c_start,
const CVector2 c_end 
)
inline

Definition at line 25 of file ray2.h.

◆ CRay2() [3/3]

argos::CRay2::CRay2 ( const CVector2 c_start,
const CVector2 c_direction,
Real  f_length 
)
inline

Definition at line 30 of file ray2.h.

Member Function Documentation

◆ GetDirection()

void argos::CRay2::GetDirection ( CVector2 c_buffer) const
inline

Definition at line 65 of file ray2.h.

◆ GetDistance()

Real argos::CRay2::GetDistance ( Real  f_t) const
inline

Definition at line 100 of file ray2.h.

◆ GetEnd()

const CVector2& argos::CRay2::GetEnd ( ) const
inline

Definition at line 40 of file ray2.h.

◆ GetInverseDirection()

void argos::CRay2::GetInverseDirection ( CVector2 c_buffer) const
inline

Definition at line 73 of file ray2.h.

◆ GetLength()

Real argos::CRay2::GetLength ( ) const
inline

Definition at line 81 of file ray2.h.

◆ GetPoint()

void argos::CRay2::GetPoint ( CVector2 c_point,
Real  f_t 
) const
inline

Definition at line 93 of file ray2.h.

◆ GetStart()

const CVector2& argos::CRay2::GetStart ( ) const
inline

Definition at line 36 of file ray2.h.

◆ Intersects()

bool argos::CRay2::Intersects ( const CRay2 c_ray) const
inline

Definition at line 106 of file ray2.h.

◆ Set() [1/2]

void argos::CRay2::Set ( const CVector2 c_start,
const CVector2 c_end 
)
inline

Definition at line 52 of file ray2.h.

◆ Set() [2/2]

void argos::CRay2::Set ( const CVector2 c_start,
const CVector2 c_direction,
Real  f_length 
)
inline

Definition at line 57 of file ray2.h.

◆ SetEnd()

void argos::CRay2::SetEnd ( const CVector2 c_end)
inline

Definition at line 48 of file ray2.h.

◆ SetStart()

void argos::CRay2::SetStart ( const CVector2 c_start)
inline

Definition at line 44 of file ray2.h.

◆ ToVector()

void argos::CRay2::ToVector ( CVector2 c_buffer) const
inline

Definition at line 85 of file ray2.h.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  c_os,
const CRay2 c_ray 
)
friend

Serializes the contents of the passed ray onto a stream.

Parameters
c_osThe stream.
c_rayThe ray.
Returns
The new state of the stream.

Definition at line 153 of file ray2.h.