ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
itk::PolyLineCell< TCellInterface > Class Template Reference

#include <itkPolyLineCell.h>

Detailed Description

template<typename TCellInterface>
class itk::PolyLineCell< TCellInterface >

Represents a series of connected line segments for a Mesh.

PolyLineCell represents a series of connected line segments for a Mesh.

Template parameters for PolyLineCell:

Template Parameters
TPixelTypeThe type associated with a point, cell, or boundary for use in storing its data.
TCellTraitsType information of mesh containing cell.

Definition at line 41 of file itkPolyLineCell.h.

+ Inheritance diagram for itk::PolyLineCell< TCellInterface >:
+ Collaboration diagram for itk::PolyLineCell< TCellInterface >:

Public Types

using VertexAutoPointer = typename VertexType::SelfAutoPointer
 
using VertexType = VertexCell< TCellInterface >
 

Public Member Functions

void ClearPoints ()
 
bool GetBoundaryFeature (int dimension, CellFeatureIdentifier, CellAutoPointer &) override
 
unsigned int GetDimension () const override
 
const char * GetNameOfClass () const override
 
CellFeatureCount GetNumberOfBoundaryFeatures (int dimension) const override
 
unsigned int GetNumberOfPoints () const override
 
virtual CellFeatureCount GetNumberOfVertices () const
 
virtual bool GetVertex (CellFeatureIdentifier, VertexAutoPointer &)
 
void InitializePoints ()
 
void InitializePoints (PointIdentifier numberOfPoints)
 
 itkCellVisitMacro (CellGeometryEnum::POLYLINE_CELL)
 
PointIdConstIterator PointIdsBegin () const override
 
PointIdIterator PointIdsBegin () override
 
PointIdConstIterator PointIdsEnd () const override
 
PointIdIterator PointIdsEnd () override
 
 PolyLineCell ()
 
 PolyLineCell (PointIdentifier numberOfPoints)
 
void SetPointId (int localId, PointIdentifier) override
 
void SetPointIds (int dummy, int num, PointIdConstIterator first)
 
void SetPointIds (PointIdConstIterator first) override
 
void SetPointIds (PointIdConstIterator first, PointIdConstIterator last) override
 
 ~PolyLineCell () override=default
 
 itkCellCommonTypedefs (PolyLineCell)
 
 itkCellInheritedTypedefs (TCellInterface)
 
CellGeometryEnum GetType () const override
 
void MakeCopy (CellAutoPointer &) const override
 

Static Public Attributes

static constexpr unsigned int CellDimension = 1
 

Protected Attributes

std::vector< PointIdentifier > m_PointIds {}
 

Member Typedef Documentation

◆ VertexAutoPointer

template<typename TCellInterface >
using itk::PolyLineCell< TCellInterface >::VertexAutoPointer = typename VertexType::SelfAutoPointer

Definition at line 56 of file itkPolyLineCell.h.

◆ VertexType

template<typename TCellInterface >
using itk::PolyLineCell< TCellInterface >::VertexType = VertexCell<TCellInterface>

The type of boundary for this lines's vertices.

Definition at line 55 of file itkPolyLineCell.h.

Constructor & Destructor Documentation

◆ PolyLineCell() [1/2]

template<typename TCellInterface >
itk::PolyLineCell< TCellInterface >::PolyLineCell ( )
inline

Constructor and destructor

Definition at line 133 of file itkPolyLineCell.h.

◆ PolyLineCell() [2/2]

template<typename TCellInterface >
itk::PolyLineCell< TCellInterface >::PolyLineCell ( PointIdentifier  numberOfPoints)
inline

Definition at line 135 of file itkPolyLineCell.h.

◆ ~PolyLineCell()

template<typename TCellInterface >
itk::PolyLineCell< TCellInterface >::~PolyLineCell ( )
overridedefault

Member Function Documentation

◆ ClearPoints()

template<typename TCellInterface >
void itk::PolyLineCell< TCellInterface >::ClearPoints ( )

◆ GetBoundaryFeature()

template<typename TCellInterface >
bool itk::PolyLineCell< TCellInterface >::GetBoundaryFeature ( int  dimension,
CellFeatureIdentifier  ,
CellAutoPointer &   
)
override

◆ GetDimension()

template<typename TCellInterface >
unsigned int itk::PolyLineCell< TCellInterface >::GetDimension ( ) const
override

◆ GetNameOfClass()

template<typename TCellInterface >
const char* itk::PolyLineCell< TCellInterface >::GetNameOfClass ( ) const
override

◆ GetNumberOfBoundaryFeatures()

template<typename TCellInterface >
CellFeatureCount itk::PolyLineCell< TCellInterface >::GetNumberOfBoundaryFeatures ( int  dimension) const
override

◆ GetNumberOfPoints()

template<typename TCellInterface >
unsigned int itk::PolyLineCell< TCellInterface >::GetNumberOfPoints ( ) const
override

◆ GetNumberOfVertices()

template<typename TCellInterface >
virtual CellFeatureCount itk::PolyLineCell< TCellInterface >::GetNumberOfVertices ( ) const
virtual

Line-specific interface.

◆ GetType()

template<typename TCellInterface >
CellGeometryEnum itk::PolyLineCell< TCellInterface >::GetType ( ) const
inlineoverride

Implement the standard CellInterface.

Definition at line 63 of file itkPolyLineCell.h.

References itk::CommonEnums::POLYLINE_CELL.

◆ GetVertex()

template<typename TCellInterface >
virtual bool itk::PolyLineCell< TCellInterface >::GetVertex ( CellFeatureIdentifier  ,
VertexAutoPointer  
)
virtual

◆ InitializePoints() [1/2]

template<typename TCellInterface >
void itk::PolyLineCell< TCellInterface >::InitializePoints ( )

◆ InitializePoints() [2/2]

template<typename TCellInterface >
void itk::PolyLineCell< TCellInterface >::InitializePoints ( PointIdentifier  numberOfPoints)
inline

Definition at line 123 of file itkPolyLineCell.h.

◆ itkCellCommonTypedefs()

template<typename TCellInterface >
itk::PolyLineCell< TCellInterface >::itkCellCommonTypedefs ( PolyLineCell< TCellInterface >  )

Standard class type aliases.

◆ itkCellInheritedTypedefs()

template<typename TCellInterface >
itk::PolyLineCell< TCellInterface >::itkCellInheritedTypedefs ( TCellInterface  )

Standard class type aliases.

◆ itkCellVisitMacro()

template<typename TCellInterface >
itk::PolyLineCell< TCellInterface >::itkCellVisitMacro ( CellGeometryEnum::POLYLINE_CELL  )

Visitor interface

◆ MakeCopy()

template<typename TCellInterface >
void itk::PolyLineCell< TCellInterface >::MakeCopy ( CellAutoPointer &  ) const
override

Implement the standard CellInterface.

◆ PointIdsBegin() [1/2]

template<typename TCellInterface >
PointIdConstIterator itk::PolyLineCell< TCellInterface >::PointIdsBegin ( ) const
override

◆ PointIdsBegin() [2/2]

template<typename TCellInterface >
PointIdIterator itk::PolyLineCell< TCellInterface >::PointIdsBegin ( )
override

◆ PointIdsEnd() [1/2]

template<typename TCellInterface >
PointIdConstIterator itk::PolyLineCell< TCellInterface >::PointIdsEnd ( ) const
override

◆ PointIdsEnd() [2/2]

template<typename TCellInterface >
PointIdIterator itk::PolyLineCell< TCellInterface >::PointIdsEnd ( )
override

◆ SetPointId()

template<typename TCellInterface >
void itk::PolyLineCell< TCellInterface >::SetPointId ( int  localId,
PointIdentifier   
)
override

◆ SetPointIds() [1/3]

template<typename TCellInterface >
void itk::PolyLineCell< TCellInterface >::SetPointIds ( int  dummy,
int  num,
PointIdConstIterator  first 
)

◆ SetPointIds() [2/3]

template<typename TCellInterface >
void itk::PolyLineCell< TCellInterface >::SetPointIds ( PointIdConstIterator  first)
override

◆ SetPointIds() [3/3]

template<typename TCellInterface >
void itk::PolyLineCell< TCellInterface >::SetPointIds ( PointIdConstIterator  first,
PointIdConstIterator  last 
)
override

Member Data Documentation

◆ CellDimension

template<typename TCellInterface >
constexpr unsigned int itk::PolyLineCell< TCellInterface >::CellDimension = 1
staticconstexpr

Line-specific topology numbers.

Definition at line 59 of file itkPolyLineCell.h.

◆ m_PointIds

template<typename TCellInterface >
std::vector<PointIdentifier> itk::PolyLineCell< TCellInterface >::m_PointIds {}
protected

For storing the points needed for a line segment.

Definition at line 141 of file itkPolyLineCell.h.


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