Slicer 5.9
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
vtkCapPolyData Class Reference

Filter to generate an end cap for a polydata cut with the specified function. More...

#include <Libs/MRML/Core/vtkCapPolyData.h>

Inheritance diagram for vtkCapPolyData:
Collaboration diagram for vtkCapPolyData:

Public Types

typedef vtkPolyDataAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual vtkSmartPointer< vtkImplicitFunction > GetClipFunction ()
 
virtual bool GetGenerateCellTypeScalars ()
 
virtual bool GetGenerateOutline ()
 
vtkMTimeType GetMTime () override
 Return the mtime also considering the locator and clip function.
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void SetClipFunction (vtkSmartPointer< vtkImplicitFunction >)
 
virtual void SetGenerateCellTypeScalars (bool)
 
virtual void SetGenerateOutline (bool)
 

Static Public Member Functions

static void GetPlanes (vtkImplicitFunction *function, vtkPlaneCollection *planes, vtkAbstractTransform *parentTransform=nullptr)
 Get the list of planes from the implicit function.
 
static int IsTypeOf (const char *type)
 
static vtkCapPolyDataNew ()
 
static vtkCapPolyDataSafeDownCast (vtkObject *o)
 

Protected Member Functions

void CreateEndCap (vtkPlaneCollection *planes, vtkPolyData *originalPolyData, vtkImplicitFunction *cutFunction, vtkPolyData *outputEndCap)
 Generate the end cap for the input polydata cut using planes in the cutFunction.
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 
void UpdateCellTypeArray (vtkPolyData *polyData)
 Updates the polydata cell scalar array to reflect the cell type.
 
 vtkCapPolyData ()
 
 ~vtkCapPolyData () override
 

Protected Attributes

vtkSmartPointer< vtkImplicitFunction > ClipFunction
 
bool GenerateCellTypeScalars { true }
 
bool GenerateOutline { true }
 

Detailed Description

Filter to generate an end cap for a polydata cut with the specified function.

This class is a subclass of vtkPolyDataAlgorithm that will generate an end cap for a polydata cut with the specified function. The end cap is generated only for vtkPlane defined in the vtkImplicitFunction. The planes can be stored in vtkPlanes or nested vtkImplicitBoolean functions, however it cannot extract planes in vtkImplicitSum.

The end cap is generated by generating cross sections of the input polydata with the planes defined in the vtkImplicitFunction, which are then triangulated. The triangulated contours are appended together and clipped with the implicit function to generate the end caps.

Definition at line 44 of file vtkCapPolyData.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPolyDataAlgorithm vtkCapPolyData::Superclass

Definition at line 47 of file vtkCapPolyData.h.

Constructor & Destructor Documentation

◆ vtkCapPolyData()

vtkCapPolyData::vtkCapPolyData ( )
protected

◆ ~vtkCapPolyData()

vtkCapPolyData::~vtkCapPolyData ( )
overrideprotected

Member Function Documentation

◆ CreateEndCap()

void vtkCapPolyData::CreateEndCap ( vtkPlaneCollection * planes,
vtkPolyData * originalPolyData,
vtkImplicitFunction * cutFunction,
vtkPolyData * outputEndCap )
protected

Generate the end cap for the input polydata cut using planes in the cutFunction.

◆ GetClassName()

virtual const char * vtkCapPolyData::GetClassName ( )
virtual

◆ GetClipFunction()

virtual vtkSmartPointer< vtkImplicitFunction > vtkCapPolyData::GetClipFunction ( )
virtual

◆ GetGenerateCellTypeScalars()

virtual bool vtkCapPolyData::GetGenerateCellTypeScalars ( )
virtual

◆ GetGenerateOutline()

virtual bool vtkCapPolyData::GetGenerateOutline ( )
virtual

◆ GetMTime()

vtkMTimeType vtkCapPolyData::GetMTime ( )
override

Return the mtime also considering the locator and clip function.

◆ GetPlanes()

static void vtkCapPolyData::GetPlanes ( vtkImplicitFunction * function,
vtkPlaneCollection * planes,
vtkAbstractTransform * parentTransform = nullptr )
static

Get the list of planes from the implicit function.

◆ IsA()

virtual int vtkCapPolyData::IsA ( const char * type)
virtual

◆ IsTypeOf()

static int vtkCapPolyData::IsTypeOf ( const char * type)
static

◆ New()

static vtkCapPolyData * vtkCapPolyData::New ( )
static

◆ PrintSelf()

void vtkCapPolyData::PrintSelf ( ostream & os,
vtkIndent indent )
override

◆ RequestData()

int vtkCapPolyData::RequestData ( vtkInformation * ,
vtkInformationVector ** ,
vtkInformationVector *  )
overrideprotected

◆ SafeDownCast()

static vtkCapPolyData * vtkCapPolyData::SafeDownCast ( vtkObject * o)
static

◆ SetClipFunction()

virtual void vtkCapPolyData::SetClipFunction ( vtkSmartPointer< vtkImplicitFunction > )
virtual

Specify the implicit function with which to perform the clipping. If you do not define an implicit function, then the input scalar data will be used for clipping.

◆ SetGenerateCellTypeScalars()

virtual void vtkCapPolyData::SetGenerateCellTypeScalars ( bool )
virtual

Set/Get whether to generate cell type scalars. The cell type scalars can be used to color the mesh by cell type. Ex. Different colors for polygons and lines. Default is on.

◆ SetGenerateOutline()

virtual void vtkCapPolyData::SetGenerateOutline ( bool )
virtual

Set/Get whether to generate an outline of the cap. Default is on.

◆ UpdateCellTypeArray()

void vtkCapPolyData::UpdateCellTypeArray ( vtkPolyData * polyData)
protected

Updates the polydata cell scalar array to reflect the cell type.

Member Data Documentation

◆ ClipFunction

vtkSmartPointer<vtkImplicitFunction> vtkCapPolyData::ClipFunction
protected

Definition at line 102 of file vtkCapPolyData.h.

◆ GenerateCellTypeScalars

bool vtkCapPolyData::GenerateCellTypeScalars { true }
protected

Definition at line 105 of file vtkCapPolyData.h.

◆ GenerateOutline

bool vtkCapPolyData::GenerateOutline { true }
protected

Definition at line 104 of file vtkCapPolyData.h.


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