vtkHardwareSelector Class Reference

#include <vtkHardwareSelector.h>

Inheritance diagram for vtkHardwareSelector:

[legend]

Collaboration diagram for vtkHardwareSelector:

[legend]

List of all members.

Detailed Description

manager for OpenGL-based selection.

vtkHardwareSelector is a helper that orchestrates color buffer based selection. This relies on OpenGL. vtkHardwareSelector can be used to select visible cells or points within a given rectangle of the RenderWindow. To use it, call in order:

SetRenderer() - to select the renderer in which we want to select the cells/points.
SetArea() - to set the rectangular region in the render window to select in.
SetFieldAssociation() - to select the attribute to select i.e. cells/points etc.
Finally, call Select(). Select will cause the attached vtkRenderer to render in a special color mode, where each cell/point is given it own color so that later inspection of the Rendered Pixels can determine what cells are visible. Select() returns a new vtkSelection instance with the cells/points selected.

Limitations: Antialiasing will break this class. If your graphics card settings force their use this class will return invalid results.

Currently only cells from PolyDataMappers can be selected from. When vtkRenderer::Selector is non-null vtkPainterPolyDataMapper uses the vtkHardwareSelectionPolyDataPainter which make appropriate calls to BeginRenderProp(), EndRenderProp(), RenderAttributeId() to render colors correctly. Until alternatives to vtkHardwareSelectionPolyDataPainter exist that can do a similar coloration of other vtkDataSet types, only polygonal data can be selected. If you need to select other data types, consider using vtkDataSetMapper and turning on it's PassThroughCellIds feature, or using vtkFrustumExtractor.

Only Opaque geometry in Actors is selected from. Assemblies and LODMappers are not currently supported.

During selection, visible datasets that can not be selected from are temporarily hidden so as not to produce invalid indices from their colors.

See also:: vtkIdentColoredPainter

Tests:: vtkHardwareSelector (Tests)

Definition at line 72 of file vtkHardwareSelector.h.


vtkRenderer *	Renderer
unsigned int	Area [4]
int	FieldAssociation
vtkIdType	MaxAttributeId
void	ReleasePixBuffers ()
Public Types
enum	PassTypes { PROCESS_PASS, ACTOR_PASS, COMPOSITE_INDEX_PASS, ID_LOW24, ID_MID24, ID_HIGH16, MAX_KNOWN_PASS = ID_HIGH16, MIN_KNOWN_PASS = PROCESS_PASS }
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
vtkSelection *	Select ()
void	RenderCompositeIndex (unsigned int index)
void	RenderAttributeId (vtkIdType attribid)
int	Render (vtkRenderer renderer, vtkProp *propArray, int propArrayCount)
vtkProp *	GetPropFromID (int id)

void	SetRenderer (vtkRenderer *)
virtual vtkRenderer *	GetRenderer ()

virtual void	SetArea (unsigned int, unsigned int, unsigned int, unsigned int)
virtual void	SetArea (unsigned int[4])
virtual unsigned int *	GetArea ()
virtual void	GetArea (unsigned int &, unsigned int &, unsigned int &, unsigned int &)
virtual void	GetArea (unsigned int[4])

virtual void	SetFieldAssociation (int)
virtual int	GetFieldAssociation ()

virtual bool	CaptureBuffers ()
PixelInformation	GetPixelInformation (unsigned int display_position[2])
PixelInformation	GetPixelInformation (unsigned int display_position[2], int maxDist)
void	ClearBuffers ()

bool	GetPixelInformation (unsigned int display_position[2], int &processId, vtkIdType &attrId, vtkProp *&prop)

bool	GetPixelInformation (unsigned int display_position[2], int &processId, vtkIdType &attrId, vtkProp *&prop, int maxDist)

void	BeginRenderProp ()
void	EndRenderProp ()

virtual void	SetProcessID (int)
virtual int	GetProcessID ()

virtual int	GetCurrentPass ()

virtual vtkSelection *	GenerateSelection ()
virtual vtkSelection *	GenerateSelection (unsigned int r[4])
virtual vtkSelection *	GenerateSelection (unsigned int x1, unsigned int y1, unsigned int x2, unsigned int y2)
Static Public Member Functions
static vtkHardwareSelector *	New ()
static int	IsTypeOf (const char *type)
static vtkHardwareSelector *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkHardwareSelector ()
	~vtkHardwareSelector ()
int	Convert (unsigned long offset, unsigned char *pb)
vtkIdType	GetID (int low24, int mid24, int high16)
virtual bool	PassRequired (int pass)
bool	IsPropHit (int propid)
virtual void	BeginSelection ()
virtual void	EndSelection ()
void	SavePixelBuffer (int passNo)
void	BuildPropHitList (unsigned char *rgbData)

int	Convert (unsigned int pos[2], unsigned char *pb)
int	Convert (int xx, int yy, unsigned char *pb)

virtual int	GetPropID (int idx, vtkProp *vtkNotUsed(prop))
Static Protected Member Functions
static void	Convert (int id, float tcoord[3])
Protected Attributes
unsigned char *	PixBuffer [10]
int	ProcessID
int	CurrentPass
int	InPropRender
Classes
struct	PixelInformation

Member Typedef Documentation

typedef vtkObject vtkHardwareSelector::Superclass

Reimplemented from vtkObject.

Reimplemented in vtkPHardwareSelector.

Definition at line 96 of file vtkHardwareSelector.h.

Member Enumeration Documentation

enum vtkHardwareSelector::PassTypes

Enumerator:

PROCESS_PASS
ACTOR_PASS
COMPOSITE_INDEX_PASS
ID_LOW24
ID_MID24
ID_HIGH16
MAX_KNOWN_PASS
MIN_KNOWN_PASS

Definition at line 209 of file vtkHardwareSelector.h.

Constructor & Destructor Documentation

vtkHardwareSelector::vtkHardwareSelector ( ) [protected]

vtkHardwareSelector::~vtkHardwareSelector ( ) [protected]

Member Function Documentation

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

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

Reimplemented from vtkObject.

Reimplemented in vtkPHardwareSelector.

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

Reimplemented from vtkObject.

Reimplemented in vtkPHardwareSelector.

static int vtkHardwareSelector::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 vtkObject.

Reimplemented in vtkPHardwareSelector.

virtual int vtkHardwareSelector::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 vtkObject.

Reimplemented in vtkPHardwareSelector.

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

Reimplemented from vtkObject.

Reimplemented in vtkPHardwareSelector.

void vtkHardwareSelector::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 vtkObject.

Reimplemented in vtkPHardwareSelector.

void vtkHardwareSelector::SetRenderer ( vtkRenderer * )

Get/Set the renderer to perform the selection on.

virtual vtkRenderer* vtkHardwareSelector::GetRenderer ( ) [virtual]

Get/Set the renderer to perform the selection on.

virtual void vtkHardwareSelector::SetArea	(	unsigned	int,
		unsigned	int,
		unsigned	int,
		unsigned	int
	)			`[virtual]`