Warning: include(php/utility.php): Failed to open stream: No such file or directory in /home/argos/argos3/doc/api/embedded/a02402.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/a02402.php on line 2
The ARGoS Website

argos::CRay3 Class Reference

#include <ray3.h>

Public Member Functions

 CRay3 ()
 
 CRay3 (const CVector3 &c_start, const CVector3 &c_end)
 
 CRay3 (const CVector3 &c_start, const CVector3 &c_direction, Real f_length)
 
CVector3GetStart ()
 
const CVector3GetStart () const
 
CVector3GetEnd ()
 
const CVector3GetEnd () const
 
void SetStart (const CVector3 &c_start)
 
void SetEnd (const CVector3 &c_end)
 
void SetLength (Real f_length)
 
void Set (const CVector3 &c_start, const CVector3 &c_end)
 
void Set (const CVector3 &c_start, const CVector3 &c_direction, Real f_length)
 
void GetDirection (CVector3 &c_buffer) const
 
void GetInverseDirection (CVector3 &c_buffer) const
 
Real GetLength () const
 
CVector3ToVector (CVector3 &c_buffer) const
 
void GetPoint (CVector3 &c_point, Real f_t) const
 
Real GetDistance (Real f_t) const
 
bool Intersects (const CPlane &c_plane, CVector3 &c_point) const
 

Friends

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

Detailed Description

Definition at line 19 of file ray3.h.

Constructor & Destructor Documentation

◆ CRay3() [1/3]

argos::CRay3::CRay3 ( )
inline

Definition at line 23 of file ray3.h.

◆ CRay3() [2/3]

argos::CRay3::CRay3 ( const CVector3 c_start,
const CVector3 c_end 
)
inline

Definition at line 26 of file ray3.h.

◆ CRay3() [3/3]

argos::CRay3::CRay3 ( const CVector3 c_start,
const CVector3 c_direction,
Real  f_length 
)
inline

Definition at line 31 of file ray3.h.

Member Function Documentation

◆ GetDirection()

void argos::CRay3::GetDirection ( CVector3 c_buffer) const
inline

Definition at line 80 of file ray3.h.

◆ GetDistance()

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

Definition at line 117 of file ray3.h.

◆ GetEnd() [1/2]

CVector3& argos::CRay3::GetEnd ( )
inline

Definition at line 45 of file ray3.h.

◆ GetEnd() [2/2]

const CVector3& argos::CRay3::GetEnd ( ) const
inline

Definition at line 49 of file ray3.h.

◆ GetInverseDirection()

void argos::CRay3::GetInverseDirection ( CVector3 c_buffer) const
inline

Definition at line 88 of file ray3.h.

◆ GetLength()

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

Definition at line 96 of file ray3.h.

◆ GetPoint()

void argos::CRay3::GetPoint ( CVector3 c_point,
Real  f_t 
) const
inline

Definition at line 109 of file ray3.h.

◆ GetStart() [1/2]

CVector3& argos::CRay3::GetStart ( )
inline

Definition at line 37 of file ray3.h.

◆ GetStart() [2/2]

const CVector3& argos::CRay3::GetStart ( ) const
inline

Definition at line 41 of file ray3.h.

◆ Intersects()

bool argos::CRay3::Intersects ( const CPlane c_plane,
CVector3 c_point 
) const

Definition at line 15 of file ray3.cpp.

◆ Set() [1/2]

void argos::CRay3::Set ( const CVector3 c_start,
const CVector3 c_end 
)
inline

Definition at line 67 of file ray3.h.

◆ Set() [2/2]

void argos::CRay3::Set ( const CVector3 c_start,
const CVector3 c_direction,
Real  f_length 
)
inline

Definition at line 72 of file ray3.h.

◆ SetEnd()

void argos::CRay3::SetEnd ( const CVector3 c_end)
inline

Definition at line 57 of file ray3.h.

◆ SetLength()

void argos::CRay3::SetLength ( Real  f_length)
inline

Definition at line 61 of file ray3.h.

◆ SetStart()

void argos::CRay3::SetStart ( const CVector3 c_start)
inline

Definition at line 53 of file ray3.h.

◆ ToVector()

CVector3& argos::CRay3::ToVector ( CVector3 c_buffer) const
inline

Definition at line 100 of file ray3.h.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  c_os,
const CRay3 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 138 of file ray3.h.