Volume Cartographer 2.27.0
Public Member Functions | Private Attributes | List of all members
volcart::segmentation::Particle Class Reference

A simple particle class. More...

#include <vc/segmentation/stps/Particle.hpp>

Public Member Functions

 Particle ()=default
 Default constructor.
 
 Particle (const cv::Vec3d &p)
 Constructor with position initialization. More...
 
Particleoperator+= (const cv::Vec3d &rhs)
 Add a vector offset to the particle position.
 
Particleoperator*= (const double &rhs)
 Scale all elements of the particle position.
 
cv::Vec3d & pos ()
 Get the particle position. More...
 
const cv::Vec3d & pos () const
 Get the particle position. More...
 
double & restingL ()
 Get the resting length between this and the previous particle in the chain. More...
 
const double & restingL () const
 Get the resting length between this and the previous particle in the chain. More...
 
double & restingR ()
 Get the resting length between this and the next particle in the chain. More...
 
const double & restingR () const
 Get the resting length between this and the next particle in the chain. More...
 

Private Attributes

cv::Vec3d pos_ {0, 0, 0}
 
double restingL_ {0}
 
double restingR_ {0}
 

Detailed Description

A simple particle class.

Keeps track of particle position and the resting distance between particles.

Definition at line 17 of file Particle.hpp.

Constructor & Destructor Documentation

◆ Particle()

volcart::segmentation::Particle::Particle ( const cv::Vec3d &  p)
inlineexplicit

Constructor with position initialization.

Definition at line 24 of file Particle.hpp.

Member Function Documentation

◆ pos() [1/2]

cv::Vec3d & volcart::segmentation::Particle::pos ( )
inline

Get the particle position.

Definition at line 32 of file Particle.hpp.

◆ pos() [2/2]

const cv::Vec3d & volcart::segmentation::Particle::pos ( ) const
inline

Get the particle position.

Definition at line 34 of file Particle.hpp.

◆ restingL() [1/2]

double & volcart::segmentation::Particle::restingL ( )
inline

Get the resting length between this and the previous particle in the chain.

Definition at line 40 of file Particle.hpp.

◆ restingL() [2/2]

const double & volcart::segmentation::Particle::restingL ( ) const
inline

Get the resting length between this and the previous particle in the chain.

Definition at line 42 of file Particle.hpp.

◆ restingR() [1/2]

double & volcart::segmentation::Particle::restingR ( )
inline

Get the resting length between this and the next particle in the chain.

Definition at line 48 of file Particle.hpp.

◆ restingR() [2/2]

const double & volcart::segmentation::Particle::restingR ( ) const
inline

Get the resting length between this and the next particle in the chain.

Definition at line 50 of file Particle.hpp.

Member Data Documentation

◆ pos_

cv::Vec3d volcart::segmentation::Particle::pos_ {0, 0, 0}
private

Particle position

Definition at line 54 of file Particle.hpp.

◆ restingL_

double volcart::segmentation::Particle::restingL_ {0}
private

Resting length to the "left"

Definition at line 56 of file Particle.hpp.

◆ restingR_

double volcart::segmentation::Particle::restingR_ {0}
private

Resting length to the "right"

Definition at line 58 of file Particle.hpp.


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