v2.0.0
Loading...
Searching...
No Matches
UTILSLIB::AcquiredPoints Class Reference

In-memory store of all points captured during a session. More...

#include <acquired_points.h>

Signals

void pointsChanged ()

Public Member Functions

 AcquiredPoints (QObject *parent=nullptr)
const QVector< DigitizedPoint > & points () const
void append (const DigitizedPoint &p)
void undoLast (PointKind kind)
void clear ()
QVector3D fiducial (FiducialId id) const
bool hasFiducial (FiducialId id) const
void removeFiducial (FiducialId id)
bool hasAllFiducials () const
int countOf (PointKind kind) const
void setPosition (int index, const QVector3D &pos)
void emitChanged ()
void setTwinFiducial (FiducialId id, const QVector3D &pos)
void clearTwinFiducial (FiducialId id)
bool hasTwinFiducial (FiducialId id) const
QVector3D twinFiducial (FiducialId id) const
bool hasAllTwinFiducials () const

Detailed Description

In-memory store of all points captured during a session.

The wizard hands one of these to the 3-D view (for visualisation) and later to the export step (for FIFF write). Single-threaded, no locking.

Definition at line 89 of file acquired_points.h.

Inheritance diagram for UTILSLIB::AcquiredPoints:
Inheritance graph

Constructor & Destructor Documentation

◆ AcquiredPoints()

UTILSLIB::AcquiredPoints::AcquiredPoints ( QObject * parent = nullptr)
inlineexplicit

Definition at line 93 of file acquired_points.h.

Member Function Documentation

◆ append()

void UTILSLIB::AcquiredPoints::append ( const DigitizedPoint & p)
inline

Append a new point and emit pointsChanged.

Definition at line 98 of file acquired_points.h.

◆ clear()

void UTILSLIB::AcquiredPoints::clear ( )
inline

Drop every captured point.

Definition at line 115 of file acquired_points.h.

◆ clearTwinFiducial()

void UTILSLIB::AcquiredPoints::clearTwinFiducial ( FiducialId id)
inline

Definition at line 180 of file acquired_points.h.

◆ countOf()

int UTILSLIB::AcquiredPoints::countOf ( PointKind kind) const
inline

Definition at line 160 of file acquired_points.h.

◆ emitChanged()

void UTILSLIB::AcquiredPoints::emitChanged ( )
inline

Definition at line 171 of file acquired_points.h.

◆ fiducial()

QVector3D UTILSLIB::AcquiredPoints::fiducial ( FiducialId id) const
inline

Convenience accessor: returns the captured fiducial position for id, or a default-constructed QVector3D if not yet captured.

Definition at line 123 of file acquired_points.h.

◆ hasAllFiducials()

bool UTILSLIB::AcquiredPoints::hasAllFiducials ( ) const
inline

True iff all three cardinal fiducials have been captured.

Definition at line 154 of file acquired_points.h.

◆ hasAllTwinFiducials()

bool UTILSLIB::AcquiredPoints::hasAllTwinFiducials ( ) const
inline

Definition at line 193 of file acquired_points.h.

◆ hasFiducial()

bool UTILSLIB::AcquiredPoints::hasFiducial ( FiducialId id) const
inline

True iff a fiducial of the given id has been captured.

Definition at line 133 of file acquired_points.h.

◆ hasTwinFiducial()

bool UTILSLIB::AcquiredPoints::hasTwinFiducial ( FiducialId id) const
inline

Definition at line 185 of file acquired_points.h.

◆ points()

const QVector< DigitizedPoint > & UTILSLIB::AcquiredPoints::points ( ) const
inline

Definition at line 95 of file acquired_points.h.

◆ pointsChanged

void UTILSLIB::AcquiredPoints::pointsChanged ( )
signal

◆ removeFiducial()

void UTILSLIB::AcquiredPoints::removeFiducial ( FiducialId id)
inline

Remove a previously captured fiducial so it can be re-recorded.

Definition at line 143 of file acquired_points.h.

◆ setPosition()

void UTILSLIB::AcquiredPoints::setPosition ( int index,
const QVector3D & pos )
inline

Definition at line 166 of file acquired_points.h.

◆ setTwinFiducial()

void UTILSLIB::AcquiredPoints::setTwinFiducial ( FiducialId id,
const QVector3D & pos )
inline

Definition at line 175 of file acquired_points.h.

◆ twinFiducial()

QVector3D UTILSLIB::AcquiredPoints::twinFiducial ( FiducialId id) const
inline

Definition at line 189 of file acquired_points.h.

◆ undoLast()

void UTILSLIB::AcquiredPoints::undoLast ( PointKind kind)
inline

Remove the most recently captured point matching kind, if any.

Definition at line 104 of file acquired_points.h.


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