VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkSpatialRepresentationFilter Class Reference

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

#include <vtkSpatialRepresentationFilter.h>

Inheritance diagram for vtkSpatialRepresentationFilter:
Inheritance graph
[legend]
Collaboration diagram for vtkSpatialRepresentationFilter:
Collaboration graph
[legend]

List of all members.

Public Types

typedef
vtkMultiBlockDataSetAlgorithm 
Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkSpatialRepresentationFilterNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
void AddLevel (int level)
void ResetLevels ()
virtual void SetSpatialRepresentation (vtkLocator *)
virtual vtkLocatorGetSpatialRepresentation ()
virtual int GetMaximumLevel ()
virtual void SetGenerateLeaves (bool)
virtual bool GetGenerateLeaves ()
virtual void GenerateLeavesOn ()
virtual void GenerateLeavesOff ()

Static Public Member Functions

static
vtkSpatialRepresentationFilter
New ()
static int IsTypeOf (const char *type)
static
vtkSpatialRepresentationFilter
SafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkSpatialRepresentationFilter ()
 ~vtkSpatialRepresentationFilter ()
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void ReportReferences (vtkGarbageCollector *)
virtual int FillInputPortInformation (int, vtkInformation *)

Protected Attributes

int MaximumLevel
bool GenerateLeaves
vtkLocatorSpatialRepresentation

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. This 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 vtkPolyData blocks corresponding to different levels in the spatial search tree. The block ids range from 0 (root level) to MaximumLevel. Note that the block for level "id" is not computed unless a AddLevel(id) method is issued. Thus, if you desire three levels of output (say 2,4,7), you would have to invoke AddLevel(2), AddLevel(4), and AddLevel(7). If GenerateLeaves is set to true (off by default), all leaf nodes of the locator (which may be at different levels) are computed and stored in block with id MaximumLevel + 1.

See also:
vtkLocator vtkPointLocator vtkCellLocator vtkOBBTree
Tests:
vtkSpatialRepresentationFilter (Tests)

Definition at line 59 of file vtkSpatialRepresentationFilter.h.


Member Typedef Documentation

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Definition at line 63 of file vtkSpatialRepresentationFilter.h.


Constructor & Destructor Documentation


Member Function Documentation

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

Reimplemented from vtkMultiBlockDataSetAlgorithm.

static int vtkSpatialRepresentationFilter::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 vtkMultiBlockDataSetAlgorithm.

virtual int vtkSpatialRepresentationFilter::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 vtkMultiBlockDataSetAlgorithm.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

virtual vtkObjectBase* vtkSpatialRepresentationFilter::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

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 vtkMultiBlockDataSetAlgorithm.

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

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

Get the maximum level that is available. Populated during RequestData().

Add a level to be computed.

Remove all levels.

virtual void vtkSpatialRepresentationFilter::SetGenerateLeaves ( bool  ) [virtual]

Turn on/off the generation of leaf nodes. Off by default.

Turn on/off the generation of leaf nodes. Off by default.

Turn on/off the generation of leaf nodes. Off by default.

Turn on/off the generation of leaf nodes. Off by default.

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

Reimplemented from vtkMultiBlockDataSetAlgorithm.

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

Reimplemented from vtkAlgorithm.

virtual int vtkSpatialRepresentationFilter::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 vtkMultiBlockDataSetAlgorithm.


Member Data Documentation

Definition at line 99 of file vtkSpatialRepresentationFilter.h.

Definition at line 100 of file vtkSpatialRepresentationFilter.h.

Definition at line 102 of file vtkSpatialRepresentationFilter.h.


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