ImFusion C++ SDK 4.4.0
ImFusion::ASCSet Class Reference

#include <AnatomyPlugin/include/ImFusion/AnatomyPlugin/ASCSet.h>

Class storing a vector of AnatomicalStructureCollection objects. More...

Inheritance diagram for ImFusion::ASCSet:

Detailed Description

Class storing a vector of AnatomicalStructureCollection objects.

Public Member Functions

 ASCSet (bool is2D=false)
bool is2D () const
 Returns whether this ASCSet is 2D.
void add (std::unique_ptr< AnatomicalStructureCollection > asc)
 Adds and anatomical structure collection.
AnatomicalStructureCollectionget (int index=-1)
 Gets the specified (index >= 0) or focused (index == -1) anatomical structure collection.
const AnatomicalStructureCollectionget (int index=-1) const
 Const version of previous method.
virtual DataList children () const override
 CompoundData interface.
int size () const override
 Returns the number of anatomical structure collections in this set.
Public Member Functions inherited from ImFusion::Data
 Data (const std::string &name="")
 Data (const Data &other)
Data & operator= (const Data &other)
virtual ~Data ()
 Mandatory virtual destructor.
virtual Modality modality () const
 Return the modality of this data.
const std::stringname () const
 Return the name of this data.
void setName (const std::string &name)
 Sets the name of this data.
virtual bool isAnnotationType () const
 Return whether this data type is visualized through an annotation (e.g. mesh).
const DataComponentListcomponents () const
 Returns the list of DataComponents for this data.
DataComponentListcomponents ()
virtual void setMatrixFromWorld (const mat4 &m)
 Set matrix mapping from the world coordinate system to the data coordinate system.
virtual void setMatrixToWorld (const mat4 &m)
 Set matrix mapping from the data coordinate system to the world coordinate system.
virtual mat4 matrixFromWorld () const
 Get matrix mapping from the world coordinate system to the data coordinate system.
virtual mat4 matrixToWorld () const
 Get matrix mapping from the data coordinate system to the world coordinate system.
virtual mat4 matrix () const
 Return the transformation matrix.
virtual void setMatrix (const mat4 &m)
 Set the transformation matrix.
Public Member Functions inherited from ImFusion::Selectable
 Selectable (const Selectable &)
 Selectable (Selectable &&)
Selectable & operator= (const Selectable &)
Selectable & operator= (Selectable &&)
virtual Selection selection () const
virtual int focus () const
virtual void setSelection (const Selection &sel)
 Set the underlying selection.
virtual void setFocus (int index)
 Set focus of the selection.
Public Member Functions inherited from ImFusion::SignalReceiver
 SignalReceiver ()=default
 Default constructor.
 SignalReceiver (const SignalReceiver &other)
 Copy constructor, does not copy any existing signal connections from other.
SignalReceiveroperator= (SignalReceiver rhs)
 Assignment operator, disconnects all existing connections, does not copy any existing signal connections from rhs.
virtual ~SignalReceiver ()
 Virtual destructor disconnects from all connected signals.

Public Attributes

Signal signalDataChanged
 This signal is connected to all child signalDataChanged signals.
Public Attributes inherited from ImFusion::Data
Signal< const Data * > signalDeleted
 Signal emitted when this instance is deleted.
Signal< const Data * > signalMatrixChanged
 Signal emitted when the transformation of this Data has changed.
Signal< std::stringsignalNameChanged
 Signal emitted when the name changed.
Public Attributes inherited from ImFusion::CompoundData
Signal< Data * > signalChildAdded
 Signal emitted when a new Data instance has been added to children().
Signal< Data * > signalChildMoved
 Signal emitted when a Data instance has changed its position in children().
Signal< Data * > signalChildAboutToBeRemoved
 Signal emitted when a Data instance is about to be removed or taken from children().
Public Attributes inherited from ImFusion::Selectable
ProtectedSignal signalSelectionChanged
 Signals that the selection or size might have changed.
Kind kind () const override
 Data interface.
Pose::TransformationConvention matrixConvention () const override
 Defines whether the internally stored matrices in derived classes map from or to the world coordinate system.
Geometry::AlignedBox bounds () const override
 Returns the axis-aligned bounding box of this data in world space.
std::string describe () const override
 Human readable description of the data for showing in the info bar.

Additional Inherited Members

Public Types inherited from ImFusion::Data
enum  Kind {
  UNKNOWN = 0 , IMAGE = 1 , VOLUME = 2 , IMAGESET = 3 ,
  VOLUMESET = 4 , IMAGESTREAM = 5 , VOLUMESTREAM = 6 , POINTSET = 7 ,
  SURFACE = 8 , TRACKINGSTREAM = 9 , LIVETRACKINGSTREAM = TRACKINGSTREAM , TRACKINGDATA = 10 ,
  TREE = 11 , TENSOR = 12 , POLYDATASTREAM = 13 , STEREOIMAGESET = 14 ,
  STEREOIMAGESTREAM = 15 , VOLUMETRICMESH = 16
}
 Kind of data. More...
enum  Modality {
  NA = 0 , XRAY = 1 , CT = 2 , MRI = 3 ,
  ULTRASOUND = 4 , VIDEO = 5 , NM = 6 , OCT = 7 ,
  LABEL = 8 , DISTANCE = 9
}
 Image modality of the data. More...
Static Public Member Functions inherited from ImFusion::Data
static std::string modalityString (Data::Modality m)
 Return the name of an image modality.
static Data::Modality stringToModality (const std::string &s)
 Returns the modality corresponding to a modality string or NA if nothing matches.
Protected Member Functions inherited from ImFusion::Data
void swapWith (Data &other)
 Swaps the data and emits a matrix and name changed signal for both.
Protected Member Functions inherited from ImFusion::Utils::NotCopyable
 NotCopyable (NotCopyable &&) noexcept=default
NotCopyable & operator= (NotCopyable &&) noexcept=default
 NotCopyable (const NotCopyable &)=delete
NotCopyable & operator= (const NotCopyable &)=delete
Protected Member Functions inherited from ImFusion::SignalReceiver
void disconnectAll ()
 Disconnects all existing connections.
Protected Attributes inherited from ImFusion::Data
mat4 m_matrix
 Transformation matrix.
std::recursive_mutexm_matrixMutex
 Used to internally synchronize access to the matrix of data.
DataComponentList m_dataComponentList
 The list of DataComponents for this data.
Protected Attributes inherited from ImFusion::Selectable
std::mutex m_selectionMutex
 Mutex protecting the selection.
Selection m_sel

Member Function Documentation

◆ kind()

Kind ImFusion::ASCSet::kind ( ) const
inlineoverridevirtual

Data interface.

Implements ImFusion::Data.

◆ matrixConvention()

Pose::TransformationConvention ImFusion::ASCSet::matrixConvention ( ) const
inlineoverridevirtual

Defines whether the internally stored matrices in derived classes map from or to the world coordinate system.

Changes the behavior of the default implementations of matrixToWorld and matrixFromWorld.

Implements ImFusion::Data.

◆ bounds()

Geometry::AlignedBox ImFusion::ASCSet::bounds ( ) const
overridevirtual

Returns the axis-aligned bounding box of this data in world space.

Warning
Depending on the underlying data type this calling function may be computationally expensive! Do not call this method more often than needed, unless it is known that the caching behavior is implemented.

Implements ImFusion::Data.

◆ describe()

std::string ImFusion::ASCSet::describe ( ) const
overridevirtual

Human readable description of the data for showing in the info bar.

Reimplemented from ImFusion::Data.

◆ children()

virtual DataList ImFusion::ASCSet::children ( ) const
overridevirtual

CompoundData interface.

Implements ImFusion::CompoundData.

◆ size()

int ImFusion::ASCSet::size ( ) const
inlineoverridevirtual

Returns the number of anatomical structure collections in this set.

Implements ImFusion::Selectable.


The documentation for this class was generated from the following file:
  • AnatomyPlugin/include/ImFusion/AnatomyPlugin/ASCSet.h
Search Tab / S to search, Esc to close