vtkMaskPoints Class Reference

#include <vtkMaskPoints.h>

Inheritance diagram for vtkMaskPoints:

[legend]

Collaboration diagram for vtkMaskPoints:

[legend]

List of all members.

Detailed Description

selectively filter points

vtkMaskPoints is a filter that passes through points and point attributes from input dataset. (Other geometry is not passed through.) It is possible to mask every nth point, and to specify an initial offset to begin masking from. A special random mode feature enables random selection of points. The filter can also generate vertices (topological primitives) as well as points. This is useful because vertices are rendered while points are not.

Tests:: vtkMaskPoints (Tests)

Definition at line 35 of file vtkMaskPoints.h.


Public Types
typedef vtkPolyDataAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	SetOnRatio (int)
virtual int	GetOnRatio ()

virtual void	SetMaximumNumberOfPoints (vtkIdType)
virtual vtkIdType	GetMaximumNumberOfPoints ()

virtual void	SetOffset (vtkIdType)
virtual vtkIdType	GetOffset ()

virtual void	SetRandomMode (int)
virtual int	GetRandomMode ()
virtual void	RandomModeOn ()
virtual void	RandomModeOff ()

virtual void	SetGenerateVertices (int)
virtual int	GetGenerateVertices ()
virtual void	GenerateVerticesOn ()
virtual void	GenerateVerticesOff ()

virtual void	SetSingleVertexPerCell (int)
virtual int	GetSingleVertexPerCell ()
virtual void	SingleVertexPerCellOn ()
virtual void	SingleVertexPerCellOff ()
Static Public Member Functions
static vtkMaskPoints *	New ()
static int	IsTypeOf (const char *type)
static vtkMaskPoints *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkMaskPoints ()
	~vtkMaskPoints ()
virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
virtual int	FillInputPortInformation (int port, vtkInformation *info)
Protected Attributes
int	OnRatio
vtkIdType	Offset
int	RandomMode
vtkIdType	MaximumNumberOfPoints
int	GenerateVertices
int	SingleVertexPerCell

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkMaskPoints::Superclass

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 39 of file vtkMaskPoints.h.

Constructor & Destructor Documentation

vtkMaskPoints::vtkMaskPoints ( ) [protected]

vtkMaskPoints::~vtkMaskPoints ( ) [inline, protected]

Definition at line 89 of file vtkMaskPoints.h.

Member Function Documentation

static vtkMaskPoints* vtkMaskPoints::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkPolyDataAlgorithm.

virtual const char* vtkMaskPoints::GetClassName ( ) [virtual]

Reimplemented from vtkPolyDataAlgorithm.

static int vtkMaskPoints::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

virtual int vtkMaskPoints::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

static vtkMaskPoints* vtkMaskPoints::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkPolyDataAlgorithm.

void vtkMaskPoints::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkPolyDataAlgorithm.

virtual void vtkMaskPoints::SetOnRatio ( int ) [virtual]

Turn on every nth point.

virtual int vtkMaskPoints::GetOnRatio ( ) [virtual]

Turn on every nth point.

virtual void vtkMaskPoints::SetMaximumNumberOfPoints ( vtkIdType ) [virtual]

Limit the number of points that can be passed through.

virtual vtkIdType vtkMaskPoints::GetMaximumNumberOfPoints ( ) [virtual]

Limit the number of points that can be passed through.

virtual void vtkMaskPoints::SetOffset ( vtkIdType ) [virtual]

Start with this point.

virtual vtkIdType vtkMaskPoints::GetOffset ( ) [virtual]

Start with this point.

virtual void vtkMaskPoints::SetRandomMode ( int ) [virtual]

Special flag causes randomization of point selection. If this mode is on, statistically every nth point (i.e., OnRatio) will be displayed.

virtual int vtkMaskPoints::GetRandomMode ( ) [virtual]

Special flag causes randomization of point selection. If this mode is on, statistically every nth point (i.e., OnRatio) will be displayed.

virtual void vtkMaskPoints::RandomModeOn ( ) [virtual]

Special flag causes randomization of point selection. If this mode is on, statistically every nth point (i.e., OnRatio) will be displayed.

virtual void vtkMaskPoints::RandomModeOff ( ) [virtual]

Special flag causes randomization of point selection. If this mode is on, statistically every nth point (i.e., OnRatio) will be displayed.

virtual void vtkMaskPoints::SetGenerateVertices ( int ) [virtual]

Generate output polydata vertices as well as points. A useful convenience method because vertices are drawn (they are topology) while points are not (they are geometry). By default this method is off.

virtual int vtkMaskPoints::GetGenerateVertices ( ) [virtual]

Generate output polydata vertices as well as points. A useful convenience method because vertices are drawn (they are topology) while points are not (they are geometry). By default this method is off.

virtual void vtkMaskPoints::GenerateVerticesOn ( ) [virtual]

Generate output polydata vertices as well as points. A useful convenience method because vertices are drawn (they are topology) while points are not (they are geometry). By default this method is off.

virtual void vtkMaskPoints::GenerateVerticesOff ( ) [virtual]

Generate output polydata vertices as well as points. A useful convenience method because vertices are drawn (they are topology) while points are not (they are geometry). By default this method is off.

virtual void vtkMaskPoints::SetSingleVertexPerCell ( int ) [virtual]

When vertex generation is enabled, by default vertices are produced as multi-vertex cells (more than one per cell), if you wish to have a single vertex per cell, enable this flag.

virtual int vtkMaskPoints::GetSingleVertexPerCell ( ) [virtual]

When vertex generation is enabled, by default vertices are produced as multi-vertex cells (more than one per cell), if you wish to have a single vertex per cell, enable this flag.

virtual void vtkMaskPoints::SingleVertexPerCellOn ( ) [virtual]

When vertex generation is enabled, by default vertices are produced as multi-vertex cells (more than one per cell), if you wish to have a single vertex per cell, enable this flag.

virtual void vtkMaskPoints::SingleVertexPerCellOff ( ) [virtual]

When vertex generation is enabled, by default vertices are produced as multi-vertex cells (more than one per cell), if you wish to have a single vertex per cell, enable this flag.

virtual int vtkMaskPoints::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)			`[protected, virtual]`

This is called by the superclass. This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

virtual int vtkMaskPoints::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)			`[protected, virtual]`

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkPolyDataAlgorithm.