vtkKdTreeSelector Class Reference
#include <vtkKdTreeSelector.h>
Detailed Description
Selects point ids using a kd-tree.If SetKdTree is used, the filter ignores the input and selects based on that kd-tree. If SetKdTree is not used, the filter builds a kd-tree using the input point set and uses that tree for selection. The output is a vtkSelection containing the ids found in the kd-tree using the specified bounds.
Definition at line 37 of file vtkKdTreeSelector.h.
Public Types | |
| typedef vtkSelectionAlgorithm | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| unsigned long | GetMTime () |
| void | SetKdTree (vtkKdTree *tree) |
| virtual vtkKdTree * | GetKdTree () |
| virtual void | SetSelectionBounds (double, double, double, double, double, double) |
| virtual void | SetSelectionBounds (double[6]) |
| virtual double * | GetSelectionBounds () |
| virtual void | GetSelectionBounds (double &, double &, double &, double &, double &, double &) |
| virtual void | GetSelectionBounds (double[6]) |
| virtual void | SetSelectionFieldName (const char *) |
| virtual char * | GetSelectionFieldName () |
| virtual void | SetSelectionAttribute (int) |
| virtual int | GetSelectionAttribute () |
| virtual void | SetSingleSelection (bool) |
| virtual bool | GetSingleSelection () |
| virtual void | SingleSelectionOn () |
| virtual void | SingleSelectionOff () |
| virtual void | SetSingleSelectionThreshold (double) |
| virtual double | GetSingleSelectionThreshold () |
Static Public Member Functions | |
| static vtkKdTreeSelector * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkKdTreeSelector * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkKdTreeSelector () | |
| ~vtkKdTreeSelector () | |
| virtual int | FillInputPortInformation (int port, vtkInformation *info) |
| int | RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) |
Protected Attributes | |
| vtkKdTree * | KdTree |
| double | SelectionBounds [6] |
| char * | SelectionFieldName |
| bool | BuildKdTreeFromInput |
| bool | SingleSelection |
| double | SingleSelectionThreshold |
| int | SelectionAttribute |
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkKdTreeSelector::vtkKdTreeSelector | ( | ) | [protected] |
| vtkKdTreeSelector::~vtkKdTreeSelector | ( | ) | [protected] |
Member Function Documentation
| static vtkKdTreeSelector* vtkKdTreeSelector::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkSelectionAlgorithm.
| virtual const char* vtkKdTreeSelector::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkSelectionAlgorithm.
| static int vtkKdTreeSelector::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 vtkSelectionAlgorithm.
| virtual int vtkKdTreeSelector::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 vtkSelectionAlgorithm.
| static vtkKdTreeSelector* vtkKdTreeSelector::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkSelectionAlgorithm.
| void vtkKdTreeSelector::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 vtkSelectionAlgorithm.
| void vtkKdTreeSelector::SetKdTree | ( | vtkKdTree * | tree | ) |
The kd-tree to use to find selected ids. The kd-tree must be initialized with the desired set of points. When this is set, the optional input is ignored.
| virtual vtkKdTree* vtkKdTreeSelector::GetKdTree | ( | ) | [virtual] |
The kd-tree to use to find selected ids. The kd-tree must be initialized with the desired set of points. When this is set, the optional input is ignored.
| virtual void vtkKdTreeSelector::SetSelectionBounds | ( | double | , | |
| double | , | |||
| double | , | |||
| double | , | |||
| double | , | |||
| double | ||||
| ) | [virtual] |
The bounds of the form (xmin,xmax,ymin,ymax,zmin,zmax). To perform a search in 2D, use the bounds (xmin,xmax,ymin,ymax,VTK_DOUBLE_MIN,VTK_DOUBLE_MAX).
| virtual void vtkKdTreeSelector::SetSelectionBounds | ( | double | [6] | ) | [virtual] |
The bounds of the form (xmin,xmax,ymin,ymax,zmin,zmax). To perform a search in 2D, use the bounds (xmin,xmax,ymin,ymax,VTK_DOUBLE_MIN,VTK_DOUBLE_MAX).
| virtual double* vtkKdTreeSelector::GetSelectionBounds | ( | ) | [virtual] |
The bounds of the form (xmin,xmax,ymin,ymax,zmin,zmax). To perform a search in 2D, use the bounds (xmin,xmax,ymin,ymax,VTK_DOUBLE_MIN,VTK_DOUBLE_MAX).
| virtual void vtkKdTreeSelector::GetSelectionBounds | ( | double & | , | |
| double & | , | |||
| double & | , | |||
| double & | , | |||
| double & | , | |||
| double & | ||||
| ) | [virtual] |
The bounds of the form (xmin,xmax,ymin,ymax,zmin,zmax). To perform a search in 2D, use the bounds (xmin,xmax,ymin,ymax,VTK_DOUBLE_MIN,VTK_DOUBLE_MAX).
| virtual void vtkKdTreeSelector::GetSelectionBounds | ( | double | [6] | ) | [virtual] |
The bounds of the form (xmin,xmax,ymin,ymax,zmin,zmax). To perform a search in 2D, use the bounds (xmin,xmax,ymin,ymax,VTK_DOUBLE_MIN,VTK_DOUBLE_MAX).
| virtual void vtkKdTreeSelector::SetSelectionFieldName | ( | const char * | ) | [virtual] |
The field name to use when generating the selection. If set, creates a VALUES selection. If not set (or is set to NULL), creates a INDICES selection. By default this is not set.
| virtual char* vtkKdTreeSelector::GetSelectionFieldName | ( | ) | [virtual] |
The field name to use when generating the selection. If set, creates a VALUES selection. If not set (or is set to NULL), creates a INDICES selection. By default this is not set.
| virtual void vtkKdTreeSelector::SetSelectionAttribute | ( | int | ) | [virtual] |
The field attribute to use when generating the selection. If set, creates a PEDIGREEIDS or GLOBALIDS selection. If not set (or is set to -1), creates a INDICES selection. By default this is not set. NOTE: This should be set a constant in vtkDataSetAttributes, not vtkSelection.
| virtual int vtkKdTreeSelector::GetSelectionAttribute | ( | ) | [virtual] |
The field attribute to use when generating the selection. If set, creates a PEDIGREEIDS or GLOBALIDS selection. If not set (or is set to -1), creates a INDICES selection. By default this is not set. NOTE: This should be set a constant in vtkDataSetAttributes, not vtkSelection.
| virtual void vtkKdTreeSelector::SetSingleSelection | ( | bool | ) | [virtual] |
Whether to only allow up to one value in the result. The item selected is closest to the center of the bounds, if there are any points within the selection threshold. Default is off.
| virtual bool vtkKdTreeSelector::GetSingleSelection | ( | ) | [virtual] |
Whether to only allow up to one value in the result. The item selected is closest to the center of the bounds, if there are any points within the selection threshold. Default is off.
| virtual void vtkKdTreeSelector::SingleSelectionOn | ( | ) | [virtual] |
Whether to only allow up to one value in the result. The item selected is closest to the center of the bounds, if there are any points within the selection threshold. Default is off.
| virtual void vtkKdTreeSelector::SingleSelectionOff | ( | ) | [virtual] |
Whether to only allow up to one value in the result. The item selected is closest to the center of the bounds, if there are any points within the selection threshold. Default is off.
| virtual void vtkKdTreeSelector::SetSingleSelectionThreshold | ( | double | ) | [virtual] |
The threshold for the single selection. A single point is added to the selection if it is within this threshold from the bounds center. Default is 1.
| virtual double vtkKdTreeSelector::GetSingleSelectionThreshold | ( | ) | [virtual] |
The threshold for the single selection. A single point is added to the selection if it is within this threshold from the bounds center. Default is 1.
| unsigned long vtkKdTreeSelector::GetMTime | ( | ) | [virtual] |
Return this object's modified time.
Reimplemented from vtkObject.
| virtual int vtkKdTreeSelector::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 vtkSelectionAlgorithm.
| int vtkKdTreeSelector::RequestData | ( | vtkInformation * | request, | |
| vtkInformationVector ** | inputVector, | |||
| vtkInformationVector * | outputVector | |||
| ) | [protected, virtual] |
This is called by the superclass. This is the method you should override.
Reimplemented from vtkSelectionAlgorithm.
Member Data Documentation
vtkKdTree* vtkKdTreeSelector::KdTree [protected] |
Definition at line 101 of file vtkKdTreeSelector.h.
double vtkKdTreeSelector::SelectionBounds[6] [protected] |
Definition at line 102 of file vtkKdTreeSelector.h.
char* vtkKdTreeSelector::SelectionFieldName [protected] |
Definition at line 103 of file vtkKdTreeSelector.h.
bool vtkKdTreeSelector::BuildKdTreeFromInput [protected] |
Definition at line 104 of file vtkKdTreeSelector.h.
bool vtkKdTreeSelector::SingleSelection [protected] |
Definition at line 105 of file vtkKdTreeSelector.h.
double vtkKdTreeSelector::SingleSelectionThreshold [protected] |
Definition at line 106 of file vtkKdTreeSelector.h.
int vtkKdTreeSelector::SelectionAttribute [protected] |
Definition at line 107 of file vtkKdTreeSelector.h.
The documentation for this class was generated from the following file:
- dox/Graphics/vtkKdTreeSelector.h
