vtkSpatialRepresentationFilter Class Reference

#include <vtkSpatialRepresentationFilter.h>

Inheritance diagram for vtkSpatialRepresentationFilter:

[legend]Collaboration diagram for vtkSpatialRepresentationFilter:

[legend]List of all members.

Detailed Description

generate polygonal model of spatial search object (i.e., a vtkLocator)

vtkSpatialRepresentationFilter generates an polygonal representation of a spatial search (vtkLocator) object. The representation varies depending upon the nature of the spatial search object. For example, the representation for vtkOBBTree is a collection of oriented bounding boxes. Ths input to this filter is a dataset of any type, and the output is polygonal data. You must also specify the spatial search object to use.

Generally spatial search objects are used for collision detection and other geometric operations, but in this filter one or more levels of spatial searchers can be generated to form a geometric approximation to the input data. This is a form of data simplification, generally used to accelerate the rendering process. Or, this filter can be used as a debugging/ visualization aid for spatial search objects.

This filter can generate one or more output vtkPolyData corresponding to different levels in the spatial search tree. The output data is retrieved using the GetOutput(id) method, where id ranges from 0 (root level) to Level. Note that the output for level "id" is not computed unless a GetOutput(id) method is issued. Thus, if you desire three levels of output (say 2,4,7), you would have to invoke GetOutput(2), GetOutput(4), and GetOutput(7). (Also note that the Level ivar is computed automatically depending on the size and nature of the input data.) There is also another GetOutput() method that takes no parameters. This method returns the leafs of the spatial search tree, which may be at different levels.

Warning:: You can specify the number of levels of to generate with the MaxLevels ivar. However, when the spatial search tree is built, this number of levels may not actually be generated. The actual number available can be found in the Levels ivar. Note that the value of Levels may change after filter execution.

See also:: vtkLocator vtkPointLocator vtkCellLocator vtkOBBTree

Created by:

Schroeder, Will

CVS contributions (if > 5%):

Schroeder, Will (47%)
Martin, Ken (13%)
King, Brad (8%)
Lorensen, Bill (8%)
Blue, Rusty (7%)
Cedilnik, Andy (5%)

CVS logs (CVSweb):

.h (/Graphics/vtkSpatialRepresentationFilter.h)
.cxx (/Graphics/vtkSpatialRepresentationFilter.cxx)

Tests:: vtkSpatialRepresentationFilter (Tests)

Definition at line 83 of file vtkSpatialRepresentationFilter.h.

Public Types

typedef vtkPolyDataSource Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

vtkPolyData * GetOutput (int level)

vtkPolyData * GetOutput ()

void ResetOutput ()

virtual void SetSpatialRepresentation (vtkLocator *)

virtual vtkLocator * GetSpatialRepresentation ()

virtual int GetLevel ()

virtual void SetInput (vtkDataSet *input)

vtkDataSet * GetInput ()

Static Public Member Functions

vtkSpatialRepresentationFilter * New ()

int IsTypeOf (const char *type)

vtkSpatialRepresentationFilter * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkSpatialRepresentationFilter ()

~vtkSpatialRepresentationFilter ()

void Execute ()

void GenerateOutput ()

virtual void ReportReferences (vtkGarbageCollector *)

virtual void RemoveReferences ()

virtual int FillInputPortInformation (int, vtkInformation *)

Protected Attributes

int Level

int TerminalNodesRequested

vtkLocator * SpatialRepresentation

Member Typedef Documentation

typedef vtkPolyDataSource vtkSpatialRepresentationFilter::Superclass

Reimplemented from vtkPolyDataSource.
Definition at line 87 of file vtkSpatialRepresentationFilter.h.

Constructor & Destructor Documentation

vtkSpatialRepresentationFilter::vtkSpatialRepresentationFilter ( ) [protected]

vtkSpatialRepresentationFilter::~vtkSpatialRepresentationFilter ( ) [protected]

Member Function Documentation

vtkSpatialRepresentationFilter* vtkSpatialRepresentationFilter::New ( ) [static]

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

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

Reimplemented from vtkPolyDataSource.

int vtkSpatialRepresentationFilter::IsTypeOf ( const char * type ) [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 vtkPolyDataSource.

virtual int vtkSpatialRepresentationFilter::IsA ( const char * type ) [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 vtkPolyDataSource.

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

Reimplemented from vtkPolyDataSource.

void vtkSpatialRepresentationFilter::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 vtkPolyDataSource.

virtual void vtkSpatialRepresentationFilter::SetSpatialRepresentation ( vtkLocator * ) [virtual]

Set/Get the locator that will be used to generate the representation.

virtual vtkLocator* vtkSpatialRepresentationFilter::GetSpatialRepresentation ( ) [virtual]

Set/Get the locator that will be used to generate the representation.

virtual int vtkSpatialRepresentationFilter::GetLevel ( ) [virtual]

Get the maximum number of outputs actually available.

vtkPolyData* vtkSpatialRepresentationFilter::GetOutput ( int level )

A special form of the GetOutput() method that returns multiple outputs.
Reimplemented from vtkPolyDataSource.

vtkPolyData* vtkSpatialRepresentationFilter::GetOutput ( )

Output of terminal nodes/leaves.
Reimplemented from vtkPolyDataSource.

void vtkSpatialRepresentationFilter::ResetOutput ( )

Reset requested output levels

virtual void vtkSpatialRepresentationFilter::SetInput ( vtkDataSet * input ) [virtual]

Set / get the input data or filter.

vtkDataSet* vtkSpatialRepresentationFilter::GetInput ( )

Set / get the input data or filter.

void vtkSpatialRepresentationFilter::Execute ( ) [protected, virtual]

This method is the old style execute method
Reimplemented from vtkSource.

void vtkSpatialRepresentationFilter::GenerateOutput ( ) [protected]

virtual void vtkSpatialRepresentationFilter::ReportReferences ( vtkGarbageCollector * ) [protected, virtual]

Reimplemented from vtkSource.

virtual void vtkSpatialRepresentationFilter::RemoveReferences ( ) [protected, virtual]

Reimplemented from vtkSource.

virtual int vtkSpatialRepresentationFilter::FillInputPortInformation ( int ,

vtkInformation *

) [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 vtkProcessObject.

Member Data Documentation

int vtkSpatialRepresentationFilter::Level [protected]

Definition at line 124 of file vtkSpatialRepresentationFilter.h.

int vtkSpatialRepresentationFilter::TerminalNodesRequested [protected]

Definition at line 125 of file vtkSpatialRepresentationFilter.h.

vtkLocator* vtkSpatialRepresentationFilter::SpatialRepresentation [protected]

Definition at line 127 of file vtkSpatialRepresentationFilter.h.

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

dox/Graphics/vtkSpatialRepresentationFilter.h


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

virtual void	SetSpatialRepresentation (vtkLocator *)
virtual vtkLocator *	GetSpatialRepresentation ()

virtual int	GetLevel ()

virtual void	SetInput (vtkDataSet *input)
vtkDataSet *	GetInput ()
Static Public Member Functions
vtkSpatialRepresentationFilter *	New ()
int	IsTypeOf (const char *type)
vtkSpatialRepresentationFilter *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkSpatialRepresentationFilter ()
	~vtkSpatialRepresentationFilter ()
void	Execute ()
void	GenerateOutput ()
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	RemoveReferences ()
virtual int	FillInputPortInformation (int, vtkInformation *)
Protected Attributes
int	Level
int	TerminalNodesRequested
vtkLocator *	SpatialRepresentation