manager for OpenGL-based selection. More...

#include <vtkHardwareSelector.h>

Inheritance diagram for vtkHardwareSelector:

Collaboration diagram for vtkHardwareSelector:

Classes
struct	PixelInformation
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 int	IsA (const char *type)
vtkHardwareSelector *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
vtkSelection *	Select ()
virtual void	RenderCompositeIndex (unsigned int index)
virtual void	RenderAttributeId (vtkIdType attribid)
virtual void	RenderProcessId (unsigned int processid)
int	Render (vtkRenderer renderer, vtkProp *propArray, int propArrayCount)
vtkProp *	GetPropFromID (int id)

virtual 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 void	SetUseProcessIdFromData (bool)
virtual bool	GetUseProcessIdFromData ()

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)

virtual void	BeginRenderProp ()
virtual void	EndRenderProp ()

virtual void	SetProcessID (int)
virtual int	GetProcessID ()

virtual float *	GetPropColorValue ()
virtual void	GetPropColorValue (float &, float &, float &)
virtual void	GetPropColorValue (float[3])
virtual void	SetPropColorValue (float, float, float)
virtual void	SetPropColorValue (float[3])

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)

virtual vtkSelection *	GeneratePolygonSelection (int *polygonPoints, vtkIdType count)
Static Public Member Functions
static vtkHardwareSelector *	New ()
static int	IsTypeOf (const char *type)
static vtkHardwareSelector *	SafeDownCast (vtkObjectBase *o)
static void	Convert (int id, float tcoord[3])
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkHardwareSelector ()
	~vtkHardwareSelector ()
virtual void	BeginRenderProp (vtkRenderWindow *)=0
virtual void	EndRenderProp (vtkRenderWindow *)=0
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))
Protected Attributes
unsigned char *	PixBuffer [10]
int	ProcessID
int	CurrentPass
int	InPropRender
int	PropID
float	PropColorValue [3]
vtkRenderer *	Renderer
unsigned int	Area [4]
int	FieldAssociation
bool	UseProcessIdFromData
vtkIdType	MaxAttributeId
void	ReleasePixBuffers ()

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(), RenderProcessId(), 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 75 of file vtkHardwareSelector.h.

Member Typedef Documentation

typedef vtkObject vtkHardwareSelector::Superclass

Reimplemented from vtkObject.

Reimplemented in vtkPHardwareSelector, vtkOpenGLHardwareSelector, and vtkOpenGLHardwareSelector.

Definition at line 99 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 239 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, vtkOpenGLHardwareSelector, and vtkOpenGLHardwareSelector.

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, vtkOpenGLHardwareSelector, and vtkOpenGLHardwareSelector.

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, vtkOpenGLHardwareSelector, and vtkOpenGLHardwareSelector.

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

Reimplemented from vtkObject.

Reimplemented in vtkPHardwareSelector, vtkOpenGLHardwareSelector, and vtkOpenGLHardwareSelector.

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

Reimplemented from vtkObject.

Reimplemented in vtkPHardwareSelector, vtkOpenGLHardwareSelector, and vtkOpenGLHardwareSelector.

vtkHardwareSelector* vtkHardwareSelector::NewInstance ( ) const

Reimplemented from vtkObject.

Reimplemented in vtkPHardwareSelector, vtkOpenGLHardwareSelector, and vtkOpenGLHardwareSelector.

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, vtkOpenGLHardwareSelector, and vtkOpenGLHardwareSelector.

virtual void vtkHardwareSelector::SetRenderer ( vtkRenderer * ) [virtual]

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]`

Get/Set the area to select as (xmin, ymin, xmax, ymax).

virtual void vtkHardwareSelector::SetArea ( unsigned int[4] ) [virtual]

Get/Set the area to select as (xmin, ymin, xmax, ymax).

virtual unsigned int* vtkHardwareSelector::GetArea ( ) [virtual]

Get/Set the area to select as (xmin, ymin, xmax, ymax).

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

Get/Set the area to select as (xmin, ymin, xmax, ymax).

virtual void vtkHardwareSelector::GetArea ( unsigned int[4] ) [virtual]

Get/Set the area to select as (xmin, ymin, xmax, ymax).

virtual void vtkHardwareSelector::SetFieldAssociation ( int ) [virtual]

Set the field type to select. Valid values are

vtkDataObject::FIELD_ASSOCIATION_POINTS
vtkDataObject::FIELD_ASSOCIATION_CELLS
vtkDataObject::FIELD_ASSOCIATION_VERTICES
vtkDataObject::FIELD_ASSOCIATION_EDGES
vtkDataObject::FIELD_ASSOCIATION_ROWS Currently only FIELD_ASSOCIATION_POINTS and FIELD_ASSOCIATION_CELLS are supported.

virtual int vtkHardwareSelector::GetFieldAssociation ( ) [virtual]

Set the field type to select. Valid values are

vtkDataObject::FIELD_ASSOCIATION_POINTS
vtkDataObject::FIELD_ASSOCIATION_CELLS
vtkDataObject::FIELD_ASSOCIATION_VERTICES
vtkDataObject::FIELD_ASSOCIATION_EDGES
vtkDataObject::FIELD_ASSOCIATION_ROWS Currently only FIELD_ASSOCIATION_POINTS and FIELD_ASSOCIATION_CELLS are supported.

virtual void vtkHardwareSelector::SetUseProcessIdFromData ( bool ) [virtual]

In some parallel rendering setups, the process id for elements must be obtained from the data itself, rather than the rendering process' id. In that case, set this flag to ON (default OFF).

virtual bool vtkHardwareSelector::GetUseProcessIdFromData ( ) [virtual]

In some parallel rendering setups, the process id for elements must be obtained from the data itself, rather than the rendering process' id. In that case, set this flag to ON (default OFF).

vtkSelection* vtkHardwareSelector::Select ( )

Perform the selection. Returns a new instance of vtkSelection containing the selection on success.

virtual bool vtkHardwareSelector::CaptureBuffers ( ) [virtual]

It is possible to use the vtkHardwareSelector for a custom picking. (Look at vtkScenePicker). In that case instead of Select() on can use CaptureBuffers() to render the selection buffers and then get information about pixel locations suing GetPixelInformation(). Use ClearBuffers() to clear buffers after one's done with the scene. The optional final parameter maxDist will look for a cell within the specified number of pixels from display_position.

Reimplemented in vtkPHardwareSelector.

PixelInformation vtkHardwareSelector::GetPixelInformation ( unsigned int display_position[2] ) [inline]

It is possible to use the vtkHardwareSelector for a custom picking. (Look at vtkScenePicker). In that case instead of Select() on can use CaptureBuffers() to render the selection buffers and then get information about pixel locations suing GetPixelInformation(). Use ClearBuffers() to clear buffers after one's done with the scene. The optional final parameter maxDist will look for a cell within the specified number of pixels from display_position.

Definition at line 147 of file vtkHardwareSelector.h.

PixelInformation vtkHardwareSelector::GetPixelInformation	(	unsigned int	display_position[2],
		int	maxDist
	)

It is possible to use the vtkHardwareSelector for a custom picking. (Look at vtkScenePicker). In that case instead of Select() on can use CaptureBuffers() to render the selection buffers and then get information about pixel locations suing GetPixelInformation(). Use ClearBuffers() to clear buffers after one's done with the scene. The optional final parameter maxDist will look for a cell within the specified number of pixels from display_position.

void vtkHardwareSelector::ClearBuffers ( ) [inline]

It is possible to use the vtkHardwareSelector for a custom picking. (Look at vtkScenePicker). In that case instead of Select() on can use CaptureBuffers() to render the selection buffers and then get information about pixel locations suing GetPixelInformation(). Use ClearBuffers() to clear buffers after one's done with the scene. The optional final parameter maxDist will look for a cell within the specified number of pixels from display_position.

Definition at line 151 of file vtkHardwareSelector.h.

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

Deprecated:: Replaced by PixelInformation* GetPixelInformation(unsigned int position[2]);

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

Deprecated:: Replaced by PixelInformation* GetPixelInformation(unsigned int position[2], int maxDist);

virtual void vtkHardwareSelector::RenderCompositeIndex ( unsigned int index ) [virtual]

Called by any vtkMapper or vtkProp subclass to render a composite-index. Currently indices >= 0xffffff are not supported.

Reimplemented in vtkOpenGLHardwareSelector.

virtual void vtkHardwareSelector::RenderAttributeId ( vtkIdType attribid ) [virtual]

Called by any vtkMapper or vtkProp subclass to render an attribute's id.

Reimplemented in vtkOpenGLHardwareSelector.

virtual void vtkHardwareSelector::RenderProcessId ( unsigned int processid ) [virtual]

Called by any vtkMapper or subclass to render process id. This has any effect when this->UseProcessIdFromData is true.

Reimplemented in vtkOpenGLHardwareSelector.

int vtkHardwareSelector::Render	(	vtkRenderer *	renderer,
		vtkProp **	propArray,
		int	propArrayCount
	)

Called by vtkRenderer to render the selection pass. Returns the number of props rendered.

virtual void vtkHardwareSelector::BeginRenderProp ( ) [virtual]

Called by the mapper (vtkHardwareSelectionPolyDataPainter) before and after rendering each prop.

Reimplemented in vtkOpenGLHardwareSelector, and vtkOpenGLHardwareSelector.

virtual void vtkHardwareSelector::EndRenderProp ( ) [virtual]

Called by the mapper (vtkHardwareSelectionPolyDataPainter) before and after rendering each prop.

Reimplemented in vtkOpenGLHardwareSelector, and vtkOpenGLHardwareSelector.

virtual void vtkHardwareSelector::SetProcessID ( int ) [virtual]

Get/Set the process id. If process id < 0 (default -1), then the PROCESS_PASS is not rendered.

virtual int vtkHardwareSelector::GetProcessID ( ) [virtual]

Get/Set the process id. If process id < 0 (default -1), then the PROCESS_PASS is not rendered.

virtual float* vtkHardwareSelector::GetPropColorValue ( ) [virtual]