vtkDicer Class Reference

#include <vtkDicer.h>

Inheritance diagram for vtkDicer:

[legend]

Collaboration diagram for vtkDicer:

[legend]

List of all members.

Detailed Description

abstract superclass to divide dataset into pieces

Subclasses of vtkDicer divides the input dataset into separate pieces. These pieces can then be operated on by other filters (e.g., vtkThreshold). One application is to break very large polygonal models into pieces and performing viewing and occlusion culling on the pieces. Multiple pieces can also be streamed through the visualization pipeline.

To use this filter, you must specify the execution mode of the filter; i.e., set the way that the piece size is controlled (do this by setting the DiceMode ivar). The filter does not change the geometry or topology of the input dataset, rather it generates integer numbers that indicate which piece a particular point belongs to (i.e., it modifies the point and cell attribute data). The integer number can be placed into the output scalar data, or the output field data.

Warning:: The number of pieces generated may not equal the specified number of pieces. Use the method GetNumberOfActualPieces() after filter execution to get the actual number of pieces generated.

See also:: vtkOBBDicer vtkConnectedDicer vtkSpatialDicer

Definition at line 52 of file vtkDicer.h.


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

virtual void	SetFieldData (int)
virtual int	GetFieldData ()
virtual void	FieldDataOn ()
virtual void	FieldDataOff ()

virtual void	SetDiceMode (int)
virtual int	GetDiceMode ()
void	SetDiceModeToNumberOfPointsPerPiece ()
void	SetDiceModeToSpecifiedNumberOfPieces ()
void	SetDiceModeToMemoryLimitPerPiece ()

virtual int	GetNumberOfActualPieces ()

virtual void	SetNumberOfPointsPerPiece (int)
virtual int	GetNumberOfPointsPerPiece ()

virtual void	SetNumberOfPieces (int)
virtual int	GetNumberOfPieces ()

virtual void	SetMemoryLimit (unsigned long)
virtual unsigned long	GetMemoryLimit ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkDicer *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkDicer ()
	~vtkDicer ()
virtual void	UpdatePieceMeasures (vtkDataSet *input)
Protected Attributes
int	NumberOfPointsPerPiece
int	NumberOfPieces
unsigned long	MemoryLimit
int	NumberOfActualPieces
int	FieldData
int	DiceMode

Member Typedef Documentation

typedef vtkDataSetAlgorithm vtkDicer::Superclass

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkOBBDicer.

Definition at line 55 of file vtkDicer.h.

Constructor & Destructor Documentation

vtkDicer::vtkDicer ( ) [protected]

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

Definition at line 116 of file vtkDicer.h.

Member Function Documentation

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

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkOBBDicer.

static int vtkDicer::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkOBBDicer.

virtual int vtkDicer::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkOBBDicer.

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

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkOBBDicer.

void vtkDicer::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 vtkDataSetAlgorithm.

Reimplemented in vtkOBBDicer.

virtual void vtkDicer::SetFieldData ( int ) [virtual]

Set/Get the flag which controls whether to generate point scalar data or point field data. If this flag is off, scalar data is generated. Otherwise, field data is generated. Note that the generated the data are integer numbers indicating which piece a particular point belongs to.

virtual int vtkDicer::GetFieldData ( ) [virtual]

Set/Get the flag which controls whether to generate point scalar data or point field data. If this flag is off, scalar data is generated. Otherwise, field data is generated. Note that the generated the data are integer numbers indicating which piece a particular point belongs to.

virtual void vtkDicer::FieldDataOn ( ) [virtual]

Set/Get the flag which controls whether to generate point scalar data or point field data. If this flag is off, scalar data is generated. Otherwise, field data is generated. Note that the generated the data are integer numbers indicating which piece a particular point belongs to.

virtual void vtkDicer::FieldDataOff ( ) [virtual]

Set/Get the flag which controls whether to generate point scalar data or point field data. If this flag is off, scalar data is generated. Otherwise, field data is generated. Note that the generated the data are integer numbers indicating which piece a particular point belongs to.

virtual void vtkDicer::SetDiceMode ( int ) [virtual]