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
vtkSpatialRepresentationFilter Class Reference

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

#include <vtkSpatialRepresentationFilter.h>

Inherits vtkMultiBlockDataSetAlgorithm.

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 vtkLocator * GetSpatialRepresentation ()
 
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 vtkObjectBase * NewInstanceInternal () const
 
 vtkSpatialRepresentationFilter ()
 
 ~vtkSpatialRepresentationFilter ()
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual int FillInputPortInformation (int, vtkInformation *)
 

Protected Attributes

int MaximumLevel
 
bool GenerateLeaves
 
vtkLocator * SpatialRepresentation
 

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

typedef vtkMultiBlockDataSetAlgorithm vtkSpatialRepresentationFilter::Superclass

Definition at line 63 of file vtkSpatialRepresentationFilter.h.

Constructor & Destructor Documentation

vtkSpatialRepresentationFilter::vtkSpatialRepresentationFilter ( )
protected
vtkSpatialRepresentationFilter::~vtkSpatialRepresentationFilter ( )
protected

Member Function Documentation

static vtkSpatialRepresentationFilter* vtkSpatialRepresentationFilter::New ( )
static
static int vtkSpatialRepresentationFilter::IsTypeOf ( const char *  type)
static
virtual int vtkSpatialRepresentationFilter::IsA ( const char *  type)
virtual
static vtkSpatialRepresentationFilter* vtkSpatialRepresentationFilter::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkSpatialRepresentationFilter::NewInstanceInternal ( ) const
protectedvirtual
vtkSpatialRepresentationFilter* vtkSpatialRepresentationFilter::NewInstance ( ) const
void vtkSpatialRepresentationFilter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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::GetMaximumLevel ( )
virtual

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

void vtkSpatialRepresentationFilter::AddLevel ( int  level)

Add a level to be computed.

void vtkSpatialRepresentationFilter::ResetLevels ( )

Remove all levels.

virtual void vtkSpatialRepresentationFilter::SetGenerateLeaves ( bool  )
virtual

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

virtual bool vtkSpatialRepresentationFilter::GetGenerateLeaves ( )
virtual

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

virtual void vtkSpatialRepresentationFilter::GenerateLeavesOn ( )
virtual

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

virtual void vtkSpatialRepresentationFilter::GenerateLeavesOff ( )
virtual

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

virtual int vtkSpatialRepresentationFilter::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual
virtual void vtkSpatialRepresentationFilter::ReportReferences ( vtkGarbageCollector *  )
protectedvirtual
virtual int vtkSpatialRepresentationFilter::FillInputPortInformation ( int  ,
vtkInformation *   
)
protectedvirtual

Member Data Documentation

int vtkSpatialRepresentationFilter::MaximumLevel
protected

Definition at line 99 of file vtkSpatialRepresentationFilter.h.

bool vtkSpatialRepresentationFilter::GenerateLeaves
protected

Definition at line 100 of file vtkSpatialRepresentationFilter.h.

vtkLocator* vtkSpatialRepresentationFilter::SpatialRepresentation
protected

Definition at line 102 of file vtkSpatialRepresentationFilter.h.


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