VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkDicer Class Reference

abstract superclass to divide dataset into pieces More...

#include <vtkDicer.h>

Inheritance diagram for vtkDicer:
[legend]

Public Types

typedef vtkDataSetAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkDicerNewInstance () const
 
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 vtkDicerSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkDicer ()
 
 ~vtkDicer ()
 
virtual void UpdatePieceMeasures (vtkDataSet *input)
 

Protected Attributes

int NumberOfPointsPerPiece
 
int NumberOfPieces
 
unsigned long MemoryLimit
 
int NumberOfActualPieces
 
int FieldData
 
int DiceMode
 

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 53 of file vtkDicer.h.

Member Typedef Documentation

typedef vtkDataSetAlgorithm vtkDicer::Superclass

Definition at line 56 of file vtkDicer.h.

Constructor & Destructor Documentation

vtkDicer::vtkDicer ( )
protected
vtkDicer::~vtkDicer ( )
inlineprotected

Definition at line 117 of file vtkDicer.h.

Member Function Documentation

static int vtkDicer::IsTypeOf ( const char *  type)
static
virtual int vtkDicer::IsA ( const char *  type)
virtual

Reimplemented in vtkOBBDicer.

static vtkDicer* vtkDicer::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkDicer::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented in vtkOBBDicer.

vtkDicer* vtkDicer::NewInstance ( ) const
void vtkDicer::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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

Specify the method to determine how many pieces the data should be broken into. By default, the number of points per piece is used.

virtual int vtkDicer::GetDiceMode ( )
virtual

Specify the method to determine how many pieces the data should be broken into. By default, the number of points per piece is used.

void vtkDicer::SetDiceModeToNumberOfPointsPerPiece ( )
inline

Specify the method to determine how many pieces the data should be broken into. By default, the number of points per piece is used.

Definition at line 75 of file vtkDicer.h.

void vtkDicer::SetDiceModeToSpecifiedNumberOfPieces ( )
inline

Specify the method to determine how many pieces the data should be broken into. By default, the number of points per piece is used.

Definition at line 77 of file vtkDicer.h.

void vtkDicer::SetDiceModeToMemoryLimitPerPiece ( )
inline

Specify the method to determine how many pieces the data should be broken into. By default, the number of points per piece is used.

Definition at line 79 of file vtkDicer.h.

virtual int vtkDicer::GetNumberOfActualPieces ( )
virtual

Use the following method after the filter has updated to determine the actual number of pieces the data was separated into.

virtual void vtkDicer::SetNumberOfPointsPerPiece ( int  )
virtual

Control piece size based on the maximum number of points per piece. (This ivar has effect only when the DiceMode is set to SetDiceModeToNumberOfPoints().)

virtual int vtkDicer::GetNumberOfPointsPerPiece ( )
virtual

Control piece size based on the maximum number of points per piece. (This ivar has effect only when the DiceMode is set to SetDiceModeToNumberOfPoints().)

virtual void vtkDicer::SetNumberOfPieces ( int  )
virtual

Set/Get the number of pieces the object is to be separated into. (This ivar has effect only when the DiceMode is set to SetDiceModeToSpecifiedNumber()). Note that the ivar NumberOfPieces is a target - depending on the particulars of the data, more or less number of pieces than the target value may be created.

virtual int vtkDicer::GetNumberOfPieces ( )
virtual

Set/Get the number of pieces the object is to be separated into. (This ivar has effect only when the DiceMode is set to SetDiceModeToSpecifiedNumber()). Note that the ivar NumberOfPieces is a target - depending on the particulars of the data, more or less number of pieces than the target value may be created.

virtual void vtkDicer::SetMemoryLimit ( unsigned  long)
virtual

Control piece size based on a memory limit. (This ivar has effect only when the DiceMode is set to SetDiceModeToMemoryLimit()). The memory limit should be set in kilobytes.

virtual unsigned long vtkDicer::GetMemoryLimit ( )
virtual

Control piece size based on a memory limit. (This ivar has effect only when the DiceMode is set to SetDiceModeToMemoryLimit()). The memory limit should be set in kilobytes.

virtual void vtkDicer::UpdatePieceMeasures ( vtkDataSet *  input)
protectedvirtual

Member Data Documentation

int vtkDicer::NumberOfPointsPerPiece
protected

Definition at line 121 of file vtkDicer.h.

int vtkDicer::NumberOfPieces
protected

Definition at line 122 of file vtkDicer.h.

unsigned long vtkDicer::MemoryLimit
protected

Definition at line 123 of file vtkDicer.h.

int vtkDicer::NumberOfActualPieces
protected

Definition at line 124 of file vtkDicer.h.

int vtkDicer::FieldData
protected

Definition at line 125 of file vtkDicer.h.

int vtkDicer::DiceMode
protected

Definition at line 126 of file vtkDicer.h.


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