Helios++
Helios software for LiDAR simulations
Pulse Class Reference

Class representing a laser pulse. More...

#include <Pulse.h>

Inheritance diagram for Pulse:
Collaboration diagram for Pulse:

Public Member Functions

 Pulse (glm::dvec3 const &origin, Rotation const &attitude)
 Laser pulse constructor. More...
 
glm::dvec3 getOrigin () const
 Obtain the origin of the pulse. More...
 
glm::dvec3 & getOriginRef ()
 Obtain the origin of the pulse by reference. More...
 
void setOrigin (glm::dvec3 const &origin)
 Set the origin of the pulse. More...
 
Rotation getAttitude () const
 Obtain the attitude of the ray. More...
 
RotationgetAttitudeRef ()
 Obtain the attitude of the ray by reference. More...
 
void setAttitude (Rotation const &attitude)
 Set the attitude of the ray. More...
 
glm::dvec3 computeDirection ()
 Compute the director vector of the ray/beam. More...
 

Protected Attributes

glm::dvec3 origin
 The origin of the pulse, typically named as the point \(o\).
 
Rotation attitude
 The attitude of the ray.
 

Detailed Description

Class representing a laser pulse.

Author
Alberto M. Esmoris Pena
Version
1.0

Constructor & Destructor Documentation

◆ Pulse()

Pulse::Pulse ( glm::dvec3 const &  origin,
Rotation const &  attitude 
)
inline

Laser pulse constructor.

See also
Pulse::origin
Pulse:attitude

Member Function Documentation

◆ computeDirection()

glm::dvec3 Pulse::computeDirection ( )
inline

Compute the director vector of the ray/beam.

Returns
The director vector of the ray/beam

◆ getAttitude()

Rotation Pulse::getAttitude ( ) const
inline

Obtain the attitude of the ray.

Returns
Copy of the attitude of the ray
See also
Pulse::attitude

◆ getAttitudeRef()

Rotation& Pulse::getAttitudeRef ( )
inline

Obtain the attitude of the ray by reference.

Returns
Reference to the attitude of the ray

◆ getOrigin()

glm::dvec3 Pulse::getOrigin ( ) const
inline

Obtain the origin of the pulse.

Returns
Copy of the origin of the pulse
See also
Pulse::origin

◆ getOriginRef()

glm::dvec3& Pulse::getOriginRef ( )
inline

Obtain the origin of the pulse by reference.

Returns
Reference to the origin of the pulse
See also
Pulse::origin

◆ setAttitude()

void Pulse::setAttitude ( Rotation const &  attitude)
inline

Set the attitude of the ray.

Parameters
attitudeThe new attitude for the ray

◆ setOrigin()

void Pulse::setOrigin ( glm::dvec3 const &  origin)
inline

Set the origin of the pulse.

Parameters
originThe new origin for the pulse
See also
Pulse::origin

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