vtkSelectVisiblePoints Class Reference

#include <vtkSelectVisiblePoints.h>

Inheritance diagram for vtkSelectVisiblePoints:

[legend]

Collaboration diagram for vtkSelectVisiblePoints:

[legend]

List of all members.

Detailed Description

extract points that are visible (based on z-buffer calculation)

vtkSelectVisiblePoints is a filter that selects points based on whether they are visible or not. Visibility is determined by accessing the z-buffer of a rendering window. (The position of each input point is converted into display coordinates, and then the z-value at that point is obtained. If within the user-specified tolerance, the point is considered visible.)

Points that are visible (or if the ivar SelectInvisible is on, invisible points) are passed to the output. Associated data attributes are passed to the output as well.

This filter also allows you to specify a rectangular window in display (pixel) coordinates in which the visible points must lie. This can be used as a sort of local "brushing" operation to select just data within a window.

Warning:: You must carefully synchronize the execution of this filter. The filter refers to a renderer, which is modified every time a render occurs. Therefore, the filter is always out of date, and always executes. You may have to perform two rendering passes, or if you are using this filter in conjunction with vtkLabeledDataMapper, things work out because 2D rendering occurs after the 3D rendering.

Examples:: vtkSelectVisiblePoints (Examples)

Tests:: vtkSelectVisiblePoints (Tests)

Definition at line 57 of file vtkSelectVisiblePoints.h.


Public Types
typedef vtkPolyDataAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
unsigned long	GetMTime ()

void	SetRenderer (vtkRenderer *ren)
vtkRenderer *	GetRenderer ()

virtual void	SetSelectionWindow (int)
virtual int	GetSelectionWindow ()
virtual void	SelectionWindowOn ()
virtual void	SelectionWindowOff ()

virtual void	SetSelection (int, int, int, int)
virtual void	SetSelection (int[4])
virtual int *	GetSelection ()
virtual void	GetSelection (int data[4])

virtual void	SetSelectInvisible (int)
virtual int	GetSelectInvisible ()
virtual void	SelectInvisibleOn ()
virtual void	SelectInvisibleOff ()

virtual void	SetTolerance (double)
virtual double	GetTolerance ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkSelectVisiblePoints *	SafeDownCast (vtkObject *o)
static vtkSelectVisiblePoints *	New ()
Protected Member Functions
	vtkSelectVisiblePoints ()
	~vtkSelectVisiblePoints ()
virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
virtual int	FillInputPortInformation (int port, vtkInformation *info)
Protected Attributes
vtkRenderer *	Renderer
int	SelectionWindow
int	Selection [4]
int	SelectInvisible
double	Tolerance

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkSelectVisiblePoints::Superclass

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 60 of file vtkSelectVisiblePoints.h.

Constructor & Destructor Documentation

vtkSelectVisiblePoints::vtkSelectVisiblePoints ( ) [protected]

vtkSelectVisiblePoints::~vtkSelectVisiblePoints ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkPolyDataAlgorithm.

static int vtkSelectVisiblePoints::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

virtual int vtkSelectVisiblePoints::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

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

Reimplemented from vtkPolyDataAlgorithm.

void vtkSelectVisiblePoints::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 vtkPolyDataAlgorithm.

static vtkSelectVisiblePoints* vtkSelectVisiblePoints::New ( ) [static]

Instantiate object with no renderer; window selection turned off; tolerance set to 0.01; and select invisible off.

Reimplemented from vtkPolyDataAlgorithm.

void vtkSelectVisiblePoints::SetRenderer ( vtkRenderer * ren ) [inline]

Specify the renderer in which the visibility computation is to be performed.

Definition at line 70 of file vtkSelectVisiblePoints.h.

vtkRenderer* vtkSelectVisiblePoints::GetRenderer ( ) [inline]

Specify the renderer in which the visibility computation is to be performed.

Definition at line 78 of file vtkSelectVisiblePoints.h.

virtual void vtkSelectVisiblePoints::SetSelectionWindow ( int ) [virtual]

Set/Get the flag which enables selection in a rectangular display region.

virtual int vtkSelectVisiblePoints::GetSelectionWindow ( ) [virtual]

Set/Get the flag which enables selection in a rectangular display region.

virtual void vtkSelectVisiblePoints::SelectionWindowOn ( ) [virtual]

Set/Get the flag which enables selection in a rectangular display region.

virtual void vtkSelectVisiblePoints::SelectionWindowOff ( ) [virtual]

Set/Get the flag which enables selection in a rectangular display region.

virtual void vtkSelectVisiblePoints::SetSelection	(	int	,
		int	,
		int	,
		int
	)			`[virtual]`

Specify the selection window in display coordinates. You must specify a rectangular region using (xmin,xmax,ymin,ymax).

virtual void vtkSelectVisiblePoints::SetSelection ( int [4] ) [virtual]

Specify the selection window in display coordinates. You must specify a rectangular region using (xmin,xmax,ymin,ymax).

virtual int* vtkSelectVisiblePoints::GetSelection ( ) [virtual]

Specify the selection window in display coordinates. You must specify a rectangular region using (xmin,xmax,ymin,ymax).

virtual void vtkSelectVisiblePoints::GetSelection ( int data[4] ) [virtual]

Specify the selection window in display coordinates. You must specify a rectangular region using (xmin,xmax,ymin,ymax).

virtual void vtkSelectVisiblePoints::SetSelectInvisible ( int ) [virtual]

Set/Get the flag which enables inverse selection; i.e., invisible points are selected.

virtual int vtkSelectVisiblePoints::GetSelectInvisible ( ) [virtual]

Set/Get the flag which enables inverse selection; i.e., invisible points are selected.

virtual void vtkSelectVisiblePoints::SelectInvisibleOn ( ) [virtual]

Set/Get the flag which enables inverse selection; i.e., invisible points are selected.

virtual void vtkSelectVisiblePoints::SelectInvisibleOff ( ) [virtual]

Set/Get the flag which enables inverse selection; i.e., invisible points are selected.

virtual void vtkSelectVisiblePoints::SetTolerance ( double ) [virtual]

Set/Get a tolerance to use to determine whether a point is visible. A tolerance is usually required because the conversion from world space to display space during rendering introduces numerical round-off.

virtual double vtkSelectVisiblePoints::GetTolerance ( ) [virtual]

Set/Get a tolerance to use to determine whether a point is visible. A tolerance is usually required because the conversion from world space to display space during rendering introduces numerical round-off.

unsigned long vtkSelectVisiblePoints::GetMTime ( ) [virtual]

Return MTime also considering the renderer.

Reimplemented from vtkObject.

virtual int vtkSelectVisiblePoints::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)			`[protected, virtual]`

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

Reimplemented from vtkPolyDataAlgorithm.

virtual int vtkSelectVisiblePoints::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 vtkPolyDataAlgorithm.