Public Member Functions | List of all members
mirtk::SurfaceBoundary Class Reference

#include <SurfaceBoundary.h>

Inheritance diagram for mirtk::SurfaceBoundary:
Inheritance graph
Collaboration diagram for mirtk::SurfaceBoundary:
Collaboration graph

Public Member Functions

bool Contains (int ptId) const
 
void DeselectPoint (int i)
 
int Find (int ptId) const
 
int FindLargestSegment () const
 Get index of boundary segment which contains the most boundary points.
 
int FindLongestSegment () const
 Get index of longest boundary segment.
 
int FindSegment (int ptId, int *i=nullptr) const
 
void GetPoint (int i, double p[3]) const
 
void InitializeIndex ()
 Pre-compute maps of surface point ID to boundary (segment) point index.
 
void InitializeLengths ()
 Pre-compute boundary edge lengths and length of each segment.
 
const BoundarySegmentLargestSegment () const
 Get boundary segment which contains the most boundary points.
 
const BoundarySegmentLongestSegment () const
 Get longest boundary segment.
 
int NumberOfPoints () const
 Number of surface boundary points.
 
int NumberOfPoints (int n) const
 Number of boundary segment points.
 
int NumberOfSegments () const
 Number of boundary segments.
 
SurfaceBoundaryoperator= (const SurfaceBoundary &)
 Assignment operator.
 
class Point Point (int i) const
 
int PointId (int i) const
 
int PointId (int n, int i) const
 
const Array< int > & PointIds (int n) const
 
int PointIndex (int n, int i) const
 
void PointIndices (int n, Array< int > &i) const
 
Array< int > PointIndices (int n) const
 
BoundarySegmentSegment (int n)
 
const BoundarySegmentSegment (int n) const
 
void SelectPoint (int i)
 
 SurfaceBoundary (vtkPolyData *, EdgeTablePointer=nullptr)
 Constructor.
 
 SurfaceBoundary (const SurfaceBoundary &)
 Copy constructor.
 
bool Write (const char *) const
 Write boundary lines to polygonal data set file.
 
virtual ~SurfaceBoundary ()
 Destructor.
 
- Public Member Functions inherited from mirtk::Object
virtual const char * NameOfClass () const =0
 Get name of class, which this object is an instance of.
 
virtual ParameterList Parameter () const
 Get parameter name/value pairs.
 
bool Parameter (const ParameterList &)
 Set parameters from name/value pairs.
 
virtual bool Set (const char *name, const char *value)
 
virtual ~Object ()
 Destructor.
 

Additional Inherited Members

- Static Public Member Functions inherited from mirtk::Object
static const char * NameOfType ()
 Get name of this class type.
 
- Protected Member Functions inherited from mirtk::Object
template<typename... Args>
void Throw (ErrorType err, const char *func, Args... args) const
 
- Static Protected Member Functions inherited from mirtk::Object
template<typename... Args>
static void ThrowStatic (ErrorType err, const char *cls, const char *func, Args... args)
 

Detailed Description

Boundary points and boundary segments of surface mesh

Definition at line 43 of file SurfaceBoundary.h.

Member Function Documentation

§ Contains()

bool mirtk::SurfaceBoundary::Contains ( int  ptId) const
inline

Check if surface point is on the boundary

Parameters
[in]ptIdSurface point ID.
Returns
Whether a given surface point is on the boundary.

Definition at line 279 of file SurfaceBoundary.h.

§ DeselectPoint()

void mirtk::SurfaceBoundary::DeselectPoint ( int  i)

Deselect i-th boundary point

Parameters
[in]iBoundary point index.

§ Find()

int mirtk::SurfaceBoundary::Find ( int  ptId) const

Find surface point ID in list of boundary points

Parameters
[in]ptIdSurface point ID.
Returns
Index of surface boundary point or -1 if point is not on the boundary.

§ FindSegment()

int mirtk::SurfaceBoundary::FindSegment ( int  ptId,
int *  i = nullptr 
) const

Get index of boundary segment that a surface point belongs to

Parameters
[in]ptIdIndex of surface point.
[out]iCorresponding boundary segment point index.
Returns
Index of first encountered boundary segment.
Return values
-1if point is not a boundary point.

§ GetPoint()

void mirtk::SurfaceBoundary::GetPoint ( int  i,
double  p[3] 
) const
inline

Get coordinates of boundary point

Parameters
[in]iIndex of boundary point.
[out]pBoundary point coordinates.

Definition at line 264 of file SurfaceBoundary.h.

§ Point()

Point mirtk::SurfaceBoundary::Point ( int  i) const
inline

Get coordinates of boundary point

Parameters
[in]iIndex of boundary point.
Returns
Boundary point coordinates.

Definition at line 271 of file SurfaceBoundary.h.

§ PointId() [1/2]

int mirtk::SurfaceBoundary::PointId ( int  i) const
inline

Surface point index of boundary point

Parameters
[in]iSurfaceBoundary point index.
Returns
Surface point index of i-th boundary point.

Definition at line 258 of file SurfaceBoundary.h.

§ PointId() [2/2]

int mirtk::SurfaceBoundary::PointId ( int  n,
int  i 
) const
inline

Surface point ID of boundary segment point

Parameters
[in]nIndex of boundary segment.
[in]iIndex of boundary segment point.
Returns
Surface point ID of i-th point of n-th boundary segment.

Definition at line 331 of file SurfaceBoundary.h.

§ PointIds()

const Array< int > & mirtk::SurfaceBoundary::PointIds ( int  n) const
inline

Surface point IDs of points making up a boundary point segment

Parameters
[in]nIndex of boundary segment.
Returns
Indices of surface points making up the n-th boundary segment.

Definition at line 325 of file SurfaceBoundary.h.

§ PointIndex()

int mirtk::SurfaceBoundary::PointIndex ( int  n,
int  i 
) const
inline

Boundary point index of boundary segment point

Parameters
[in]nIndex of boundary segment.
[in]iIndex of boundary segment point.
Returns
Boundary point index of i-th point of n-th boundary segment.

Definition at line 354 of file SurfaceBoundary.h.

§ PointIndices() [1/2]

void mirtk::SurfaceBoundary::PointIndices ( int  n,
Array< int > &  i 
) const
inline

Get indices of boundary points making up a boundary segment

Parameters
[in]nIndex of boundary segment.
[out]iIndices of boundary points making up the n-th boundary segment.

Definition at line 337 of file SurfaceBoundary.h.

§ PointIndices() [2/2]

Array< int > mirtk::SurfaceBoundary::PointIndices ( int  n) const
inline

Get indices of boundary points making up a boundary segment

Parameters
[in]nIndex of boundary segment.
Returns
Indices of boundary points making up the n-th boundary segment.

Definition at line 346 of file SurfaceBoundary.h.

§ Segment() [1/2]

BoundarySegment & mirtk::SurfaceBoundary::Segment ( int  n)
inline

Get n-th boundary segment

Parameters
[in]nIndex of boundary segment.
Returns
Reference to n-th boundary segment.

Definition at line 295 of file SurfaceBoundary.h.

§ Segment() [2/2]

const BoundarySegment & mirtk::SurfaceBoundary::Segment ( int  n) const
inline

Get n-th boundary segment

Parameters
[in]nIndex of boundary segment.
Returns
Reference to n-th boundary segment.

Definition at line 301 of file SurfaceBoundary.h.

§ SelectPoint()

void mirtk::SurfaceBoundary::SelectPoint ( int  i)

Select i-th boundary point

Parameters
[in]iBoundary point index.

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