VTK  9.3.20240318
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkHardwareSelector Class Referenceabstract

#include <vtkHardwareSelector.h>

Inheritance diagram for vtkHardwareSelector:
[legend]
Collaboration diagram for vtkHardwareSelector:
[legend]

Classes

struct  PixelInformation
 Struct used to return information about a pixel location. More...
 

Public Types

enum  PassTypes {
  ACTOR_PASS , COMPOSITE_INDEX_PASS , POINT_ID_LOW24 , POINT_ID_HIGH24 ,
  PROCESS_PASS , CELL_ID_LOW24 , CELL_ID_HIGH24 , MAX_KNOWN_PASS = CELL_ID_HIGH24 ,
  MIN_KNOWN_PASS = ACTOR_PASS
}
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkHardwareSelectorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkSelectionSelect ()
 Perform the selection. More...
 
virtual void RenderCompositeIndex (unsigned int index)
 Called by any vtkMapper or vtkProp subclass to render a composite-index. More...
 
virtual void RenderProcessId (unsigned int processid)
 Called by any vtkMapper or subclass to render process id. More...
 
int Render (vtkRenderer *renderer, vtkProp **propArray, int propArrayCount)
 Called by vtkRenderer to render the selection pass. More...
 
virtual vtkSelectionGenerateSelection ()
 Generates the vtkSelection from pixel buffers. More...
 
virtual vtkSelectionGenerateSelection (unsigned int r[4])
 
virtual vtkSelectionGenerateSelection (unsigned int x1, unsigned int y1, unsigned int x2, unsigned int y2)
 
virtual vtkSelectionGeneratePolygonSelection (int *polygonPoints, vtkIdType count)
 Generates the vtkSelection from pixel buffers. More...
 
vtkPropGetPropFromID (int id)
 returns the prop associated with a ID. More...
 
std::string PassTypeToString (PassTypes type)
 Convert a PassTypes enum value to a human readable string. More...
 
virtual void SavePixelBuffer (int passNo)
 
bool HasHighCellIds ()
 
bool HasHighPointIds ()
 
virtual void SetRenderer (vtkRenderer *)
 Get/Set the renderer to perform the selection on. More...
 
virtual vtkRendererGetRenderer ()
 Get/Set the renderer to perform the selection on. More...
 
virtual void SetArea (unsigned int, unsigned int, unsigned int, unsigned int)
 Get/Set the area to select as (xmin, ymin, xmax, ymax). More...
 
virtual void SetArea (unsigned int[4])
 Get/Set the area to select as (xmin, ymin, xmax, ymax). More...
 
virtual unsigned int * GetArea ()
 Get/Set the area to select as (xmin, ymin, xmax, ymax). More...
 
virtual void GetArea (unsigned int &, unsigned int &, unsigned int &, unsigned int &)
 Get/Set the area to select as (xmin, ymin, xmax, ymax). More...
 
virtual void GetArea (unsigned int[4])
 Get/Set the area to select as (xmin, ymin, xmax, ymax). More...
 
virtual void SetFieldAssociation (int)
 Set the field type to select. More...
 
virtual int GetFieldAssociation ()
 Set the field type to select. More...
 
virtual void SetUseProcessIdFromData (bool)
 In some parallel rendering setups, the process id for elements must be obtained from the data itself, rather than the rendering process' id. More...
 
virtual bool GetUseProcessIdFromData ()
 In some parallel rendering setups, the process id for elements must be obtained from the data itself, rather than the rendering process' id. More...
 
virtual bool CaptureBuffers ()
 It is possible to use the vtkHardwareSelector for a custom picking. More...
 
PixelInformation GetPixelInformation (const unsigned int display_position[2])
 It is possible to use the vtkHardwareSelector for a custom picking. More...
 
PixelInformation GetPixelInformation (const unsigned int display_position[2], int maxDist)
 It is possible to use the vtkHardwareSelector for a custom picking. More...
 
virtual PixelInformation GetPixelInformation (const unsigned int display_position[2], int maxDist, unsigned int selected_position[2])
 It is possible to use the vtkHardwareSelector for a custom picking. More...
 
void ClearBuffers ()
 It is possible to use the vtkHardwareSelector for a custom picking. More...
 
unsigned char * GetRawPixelBuffer (int passNo)
 It is possible to use the vtkHardwareSelector for a custom picking. More...
 
unsigned char * GetPixelBuffer (int passNo)
 It is possible to use the vtkHardwareSelector for a custom picking. More...
 
virtual void UpdateMaximumCellId (vtkIdType attribid)
 Called by any vtkMapper or vtkProp subclass to indicate the maximum cell or point attribute ID it uses. More...
 
virtual void UpdateMaximumPointId (vtkIdType attribid)
 Called by any vtkMapper or vtkProp subclass to indicate the maximum cell or point attribute ID it uses. More...
 
virtual bool GetActorPassOnly ()
 Get/Set to only do the actor pass. More...
 
virtual void SetActorPassOnly (bool)
 Get/Set to only do the actor pass. More...
 
virtual bool GetCaptureZValues ()
 Get/Set to capture the zvalue. More...
 
virtual void SetCaptureZValues (bool)
 Get/Set to capture the zvalue. More...
 
virtual void BeginRenderProp ()
 Called by the mapper before and after rendering each prop. More...
 
virtual void EndRenderProp ()
 Called by the mapper before and after rendering each prop. More...
 
virtual void SetProcessID (int)
 Get/Set the process id. More...
 
virtual int GetProcessID ()
 Get/Set the process id. More...
 
virtual float * GetPropColorValue ()
 Get/Set the color to be used by the prop when drawing. More...
 
virtual void GetPropColorValue (float &, float &, float &)
 Get/Set the color to be used by the prop when drawing. More...
 
virtual void GetPropColorValue (float[3])
 Get/Set the color to be used by the prop when drawing. More...
 
virtual void SetPropColorValue (float, float, float)
 Get/Set the color to be used by the prop when drawing. More...
 
virtual void SetPropColorValue (float[3])
 Get/Set the color to be used by the prop when drawing. More...
 
void SetPropColorValue (vtkIdType val)
 Get/Set the color to be used by the prop when drawing. More...
 
virtual int GetCurrentPass ()
 Get the current pass number. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkHardwareSelectorNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkHardwareSelectorSafeDownCast (vtkObjectBase *o)
 
static void Convert (vtkIdType id, float tcoord[3])
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkHardwareSelector ()
 
 ~vtkHardwareSelector () override
 
virtual void PreCapturePass (int pass)
 
virtual void PostCapturePass (int pass)
 
virtual void BeginRenderProp (vtkRenderWindow *)=0
 
virtual void EndRenderProp (vtkRenderWindow *)=0
 
double GetZValue (int propid)
 
int Convert (unsigned long offset, unsigned char *pb)
 
vtkIdType GetID (int low24, int mid24, int high16)
 
virtual bool PassRequired (int pass)
 Returns is the pass indicated is needed. More...
 
bool IsPropHit (int propid)
 After the ACTOR_PASS this return true or false depending upon whether the prop was hit in the ACTOR_PASS. More...
 
virtual int GetPropID (int idx, vtkProp *vtkNotUsed(prop))
 Return a unique ID for the prop. More...
 
virtual void BeginSelection ()
 
virtual void EndSelection ()
 
virtual void ProcessPixelBuffers ()
 
void BuildPropHitList (unsigned char *rgbData)
 
int Convert (unsigned int pos[2], unsigned char *pb)
 pos must be relative to the lower-left corner of this->Area. More...
 
int Convert (int xx, int yy, unsigned char *pb)
 pos must be relative to the lower-left corner of this->Area. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

unsigned char * PixBuffer [10]
 
unsigned char * RawPixBuffer [10]
 
int ProcessID
 
int CurrentPass
 
int Iteration
 
int InPropRender
 
int PropID
 
float PropColorValue [3]
 
bool ActorPassOnly
 
bool CaptureZValues
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
vtkRendererRenderer
 Clears all pixel buffers. More...
 
unsigned int Area [4]
 Clears all pixel buffers. More...
 
int FieldAssociation
 Clears all pixel buffers. More...
 
bool UseProcessIdFromData
 Clears all pixel buffers. More...
 
vtkIdType MaximumPointId
 Clears all pixel buffers. More...
 
vtkIdType MaximumCellId
 Clears all pixel buffers. More...
 
void ReleasePixBuffers ()
 Clears all pixel buffers. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

Definition at line 134 of file vtkHardwareSelector.h.

Member Typedef Documentation

◆ Superclass

Definition at line 162 of file vtkHardwareSelector.h.

Member Enumeration Documentation

◆ PassTypes

Enumerator
ACTOR_PASS 
COMPOSITE_INDEX_PASS 
POINT_ID_LOW24 
POINT_ID_HIGH24 
PROCESS_PASS 
CELL_ID_LOW24 
CELL_ID_HIGH24 
MAX_KNOWN_PASS 
MIN_KNOWN_PASS 

Definition at line 368 of file vtkHardwareSelector.h.

Constructor & Destructor Documentation

◆ vtkHardwareSelector()

vtkHardwareSelector::vtkHardwareSelector ( )
protected

◆ ~vtkHardwareSelector()

vtkHardwareSelector::~vtkHardwareSelector ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkHardwareSelector* vtkHardwareSelector::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkHardwareSelector::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool 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 vtkObjectBase.

Reimplemented in vtkWebGPUHardwareSelector, vtkPHardwareSelector, and vtkOpenGLHardwareSelector.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkHardwareSelector::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkHardwareSelector* vtkHardwareSelector::NewInstance ( ) const

◆ PrintSelf()

void vtkHardwareSelector::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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

◆ SetRenderer()

virtual void vtkHardwareSelector::SetRenderer ( vtkRenderer )
virtual

Get/Set the renderer to perform the selection on.

◆ GetRenderer()

virtual vtkRenderer* vtkHardwareSelector::GetRenderer ( )
virtual

Get/Set the renderer to perform the selection on.

◆ SetArea() [1/2]

virtual void vtkHardwareSelector::SetArea ( unsigned int  ,
unsigned int  ,
unsigned int  ,
unsigned int   
)
virtual

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

◆ SetArea() [2/2]

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

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

◆ GetArea() [1/3]

virtual unsigned int* vtkHardwareSelector::GetArea ( )
virtual

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

◆ GetArea() [2/3]

virtual void vtkHardwareSelector::GetArea ( unsigned int &  ,
unsigned int &  ,
unsigned int &  ,
unsigned int &   
)
virtual

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

◆ GetArea() [3/3]

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

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

◆ SetFieldAssociation()

virtual void vtkHardwareSelector::SetFieldAssociation ( int  )
virtual

Set the field type to select.

Valid values are

◆ GetFieldAssociation()

virtual int vtkHardwareSelector::GetFieldAssociation ( )
virtual

Set the field type to select.

Valid values are

◆ SetUseProcessIdFromData()

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).

◆ GetUseProcessIdFromData()

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).

◆ Select()

vtkSelection* vtkHardwareSelector::Select ( )

Perform the selection.

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

◆ CaptureBuffers()

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. When using the overload with the optional selected_position argument, selected_position is filled with the position for which the PixelInformation is being returned. This is useful when maxDist > 0 to determine which position's pixel information is was returned.

Reimplemented in vtkPHardwareSelector.

◆ GetPixelInformation() [1/3]

PixelInformation vtkHardwareSelector::GetPixelInformation ( const 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. When using the overload with the optional selected_position argument, selected_position is filled with the position for which the PixelInformation is being returned. This is useful when maxDist > 0 to determine which position's pixel information is was returned.

Definition at line 227 of file vtkHardwareSelector.h.

◆ GetPixelInformation() [2/3]

PixelInformation vtkHardwareSelector::GetPixelInformation ( const unsigned int  display_position[2],
int  maxDist 
)
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. When using the overload with the optional selected_position argument, selected_position is filled with the position for which the PixelInformation is being returned. This is useful when maxDist > 0 to determine which position's pixel information is was returned.

Definition at line 231 of file vtkHardwareSelector.h.

◆ GetPixelInformation() [3/3]

virtual PixelInformation vtkHardwareSelector::GetPixelInformation ( const unsigned int  display_position[2],
int  maxDist,
unsigned int  selected_position[2] 
)
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. When using the overload with the optional selected_position argument, selected_position is filled with the position for which the PixelInformation is being returned. This is useful when maxDist > 0 to determine which position's pixel information is was returned.

◆ ClearBuffers()

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. When using the overload with the optional selected_position argument, selected_position is filled with the position for which the PixelInformation is being returned. This is useful when maxDist > 0 to determine which position's pixel information is was returned.

Definition at line 238 of file vtkHardwareSelector.h.

◆ GetRawPixelBuffer()

unsigned char* vtkHardwareSelector::GetRawPixelBuffer ( int  passNo)
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. When using the overload with the optional selected_position argument, selected_position is filled with the position for which the PixelInformation is being returned. This is useful when maxDist > 0 to determine which position's pixel information is was returned.

Definition at line 240 of file vtkHardwareSelector.h.

◆ GetPixelBuffer()

unsigned char* vtkHardwareSelector::GetPixelBuffer ( int  passNo)
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. When using the overload with the optional selected_position argument, selected_position is filled with the position for which the PixelInformation is being returned. This is useful when maxDist > 0 to determine which position's pixel information is was returned.

Definition at line 241 of file vtkHardwareSelector.h.

◆ RenderCompositeIndex()

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

◆ UpdateMaximumCellId()

virtual void vtkHardwareSelector::UpdateMaximumCellId ( vtkIdType  attribid)
virtual

Called by any vtkMapper or vtkProp subclass to indicate the maximum cell or point attribute ID it uses.

These values are used for determining if the POINT_ID_HIGH or CELL_ID_HIGH passes are required.

◆ UpdateMaximumPointId()

virtual void vtkHardwareSelector::UpdateMaximumPointId ( vtkIdType  attribid)
virtual

Called by any vtkMapper or vtkProp subclass to indicate the maximum cell or point attribute ID it uses.

These values are used for determining if the POINT_ID_HIGH or CELL_ID_HIGH passes are required.

◆ RenderProcessId()

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

◆ Render()

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

Called by vtkRenderer to render the selection pass.

Returns the number of props rendered.

◆ GetActorPassOnly()

virtual bool vtkHardwareSelector::GetActorPassOnly ( )
virtual

Get/Set to only do the actor pass.

If true all other passes will be skipped resulting in a faster pick.

◆ SetActorPassOnly()

virtual void vtkHardwareSelector::SetActorPassOnly ( bool  )
virtual

Get/Set to only do the actor pass.

If true all other passes will be skipped resulting in a faster pick.

◆ GetCaptureZValues()

virtual bool vtkHardwareSelector::GetCaptureZValues ( )
virtual

Get/Set to capture the zvalue.

If true the closest zvalue is stored for each prop that is in the selection. ZValue in this case is the value from the zbuffer which can be used in coordinate conversions

◆ SetCaptureZValues()

virtual void vtkHardwareSelector::SetCaptureZValues ( bool  )
virtual

Get/Set to capture the zvalue.

If true the closest zvalue is stored for each prop that is in the selection. ZValue in this case is the value from the zbuffer which can be used in coordinate conversions

◆ BeginRenderProp() [1/2]

virtual void vtkHardwareSelector::BeginRenderProp ( )
virtual

Called by the mapper before and after rendering each prop.

Reimplemented in vtkWebGPUHardwareSelector, and vtkOpenGLHardwareSelector.

◆ EndRenderProp() [1/2]

virtual void vtkHardwareSelector::EndRenderProp ( )
virtual

Called by the mapper before and after rendering each prop.

Reimplemented in vtkWebGPUHardwareSelector, and vtkOpenGLHardwareSelector.

◆ SetProcessID()

virtual void vtkHardwareSelector::SetProcessID ( int  )
virtual

Get/Set the process id.

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

◆ GetProcessID()

virtual int vtkHardwareSelector::GetProcessID ( )
virtual

Get/Set the process id.

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

◆ GetPropColorValue() [1/3]

virtual float* vtkHardwareSelector::GetPropColorValue ( )
virtual

Get/Set the color to be used by the prop when drawing.

◆ GetPropColorValue() [2/3]

virtual void vtkHardwareSelector::GetPropColorValue ( float &  ,
float &  ,
float &   
)
virtual

Get/Set the color to be used by the prop when drawing.

◆ GetPropColorValue() [3/3]

virtual void vtkHardwareSelector::GetPropColorValue ( float  [3])
virtual

Get/Set the color to be used by the prop when drawing.

◆ SetPropColorValue() [1/3]

virtual void vtkHardwareSelector::SetPropColorValue ( float  ,
float  ,
float   
)
virtual

Get/Set the color to be used by the prop when drawing.

◆ SetPropColorValue() [2/3]

virtual void vtkHardwareSelector::SetPropColorValue ( float  [3])
virtual

Get/Set the color to be used by the prop when drawing.

◆ SetPropColorValue() [3/3]

void vtkHardwareSelector::SetPropColorValue ( vtkIdType  val)

Get/Set the color to be used by the prop when drawing.

◆ GetCurrentPass()

virtual int vtkHardwareSelector::GetCurrentPass ( )
virtual

Get the current pass number.

◆ GenerateSelection() [1/3]

virtual vtkSelection* vtkHardwareSelector::GenerateSelection ( )
inlinevirtual

Generates the vtkSelection from pixel buffers.

Requires that CaptureBuffers() has already been called. Optionally you may pass a screen region (xmin, ymin, xmax, ymax) to generate a selection from. The region must be a subregion of the region specified by SetArea(), otherwise it will be clipped to that region.

Definition at line 334 of file vtkHardwareSelector.h.

◆ GenerateSelection() [2/3]

virtual vtkSelection* vtkHardwareSelector::GenerateSelection ( unsigned int  r[4])
inlinevirtual

Definition at line 335 of file vtkHardwareSelector.h.

◆ GenerateSelection() [3/3]

virtual vtkSelection* vtkHardwareSelector::GenerateSelection ( unsigned int  x1,
unsigned int  y1,
unsigned int  x2,
unsigned int  y2 
)
virtual

◆ GeneratePolygonSelection()

virtual vtkSelection* vtkHardwareSelector::GeneratePolygonSelection ( int *  polygonPoints,
vtkIdType  count 
)
virtual

Generates the vtkSelection from pixel buffers.

Same as GenerateSelection, except this one use a polygon, instead of a rectangle region, and select elements inside the polygon. NOTE: The CaptureBuffers() needs to be called first.

◆ GetPropFromID()

vtkProp* vtkHardwareSelector::GetPropFromID ( int  id)

returns the prop associated with a ID.

This is valid only until ReleasePixBuffers() gets called.

◆ PassTypeToString()

std::string vtkHardwareSelector::PassTypeToString ( PassTypes  type)

Convert a PassTypes enum value to a human readable string.

◆ Convert() [1/4]

static void vtkHardwareSelector::Convert ( vtkIdType  id,
float  tcoord[3] 
)
inlinestatic

Definition at line 391 of file vtkHardwareSelector.h.

◆ SavePixelBuffer()

virtual void vtkHardwareSelector::SavePixelBuffer ( int  passNo)
virtual

◆ HasHighCellIds()

bool vtkHardwareSelector::HasHighCellIds ( )

◆ HasHighPointIds()

bool vtkHardwareSelector::HasHighPointIds ( )

◆ PreCapturePass()

virtual void vtkHardwareSelector::PreCapturePass ( int  pass)
inlineprotectedvirtual

Reimplemented in vtkWebGPUHardwareSelector, and vtkOpenGLHardwareSelector.

Definition at line 415 of file vtkHardwareSelector.h.

◆ PostCapturePass()

virtual void vtkHardwareSelector::PostCapturePass ( int  pass)
inlineprotectedvirtual

Reimplemented in vtkWebGPUHardwareSelector, and vtkOpenGLHardwareSelector.

Definition at line 416 of file vtkHardwareSelector.h.

◆ BeginRenderProp() [2/2]

virtual void vtkHardwareSelector::BeginRenderProp ( vtkRenderWindow )
protectedpure virtual

◆ EndRenderProp() [2/2]

virtual void vtkHardwareSelector::EndRenderProp ( vtkRenderWindow )
protectedpure virtual

◆ GetZValue()

double vtkHardwareSelector::GetZValue ( int  propid)
protected

◆ Convert() [2/4]

int vtkHardwareSelector::Convert ( unsigned long  offset,
unsigned char *  pb 
)
inlineprotected

Definition at line 425 of file vtkHardwareSelector.h.

◆ Convert() [3/4]

int vtkHardwareSelector::Convert ( unsigned int  pos[2],
unsigned char *  pb 
)
inlineprotected

pos must be relative to the lower-left corner of this->Area.

Definition at line 449 of file vtkHardwareSelector.h.

◆ Convert() [4/4]

int vtkHardwareSelector::Convert ( int  xx,
int  yy,
unsigned char *  pb 
)
inlineprotected

pos must be relative to the lower-left corner of this->Area.

Definition at line 450 of file vtkHardwareSelector.h.

◆ GetID()

vtkIdType vtkHardwareSelector::GetID ( int  low24,
int  mid24,
int  high16 
)
inlineprotected

Definition at line 471 of file vtkHardwareSelector.h.

◆ PassRequired()

virtual bool vtkHardwareSelector::PassRequired ( int  pass)
protectedvirtual

Returns is the pass indicated is needed.

◆ IsPropHit()

bool vtkHardwareSelector::IsPropHit ( int  propid)
protected

After the ACTOR_PASS this return true or false depending upon whether the prop was hit in the ACTOR_PASS.

This makes it possible to skip props that are not involved in the selection after the first pass.

◆ GetPropID()

virtual int vtkHardwareSelector::GetPropID ( int  idx,
vtkProp vtkNotUsedprop 
)
inlineprotectedvirtual

Return a unique ID for the prop.

Definition at line 497 of file vtkHardwareSelector.h.

◆ BeginSelection()

virtual void vtkHardwareSelector::BeginSelection ( )
protectedvirtual

◆ EndSelection()

virtual void vtkHardwareSelector::EndSelection ( )
protectedvirtual

◆ ProcessPixelBuffers()

virtual void vtkHardwareSelector::ProcessPixelBuffers ( )
protectedvirtual

◆ BuildPropHitList()

void vtkHardwareSelector::BuildPropHitList ( unsigned char *  rgbData)
protected

◆ ReleasePixBuffers()

void vtkHardwareSelector::ReleasePixBuffers ( )
protected

Clears all pixel buffers.

Member Data Documentation

◆ Renderer

vtkRenderer* vtkHardwareSelector::Renderer
protected

Clears all pixel buffers.

Definition at line 510 of file vtkHardwareSelector.h.

◆ Area

unsigned int vtkHardwareSelector::Area[4]
protected

Clears all pixel buffers.

Definition at line 511 of file vtkHardwareSelector.h.

◆ FieldAssociation

int vtkHardwareSelector::FieldAssociation
protected

Clears all pixel buffers.

Definition at line 512 of file vtkHardwareSelector.h.

◆ UseProcessIdFromData

bool vtkHardwareSelector::UseProcessIdFromData
protected

Clears all pixel buffers.

Definition at line 513 of file vtkHardwareSelector.h.

◆ MaximumPointId

vtkIdType vtkHardwareSelector::MaximumPointId
protected

Clears all pixel buffers.

Definition at line 514 of file vtkHardwareSelector.h.

◆ MaximumCellId

vtkIdType vtkHardwareSelector::MaximumCellId
protected

Clears all pixel buffers.

Definition at line 515 of file vtkHardwareSelector.h.

◆ PixBuffer

unsigned char* vtkHardwareSelector::PixBuffer[10]
protected

Definition at line 519 of file vtkHardwareSelector.h.

◆ RawPixBuffer

unsigned char* vtkHardwareSelector::RawPixBuffer[10]
protected

Definition at line 520 of file vtkHardwareSelector.h.

◆ ProcessID

int vtkHardwareSelector::ProcessID
protected

Definition at line 521 of file vtkHardwareSelector.h.

◆ CurrentPass

int vtkHardwareSelector::CurrentPass
protected

Definition at line 522 of file vtkHardwareSelector.h.

◆ Iteration

int vtkHardwareSelector::Iteration
protected

Definition at line 523 of file vtkHardwareSelector.h.

◆ InPropRender

int vtkHardwareSelector::InPropRender
protected

Definition at line 524 of file vtkHardwareSelector.h.

◆ PropID

int vtkHardwareSelector::PropID
protected

Definition at line 525 of file vtkHardwareSelector.h.

◆ PropColorValue

float vtkHardwareSelector::PropColorValue[3]
protected

Definition at line 526 of file vtkHardwareSelector.h.

◆ ActorPassOnly

bool vtkHardwareSelector::ActorPassOnly
protected

Definition at line 528 of file vtkHardwareSelector.h.

◆ CaptureZValues

bool vtkHardwareSelector::CaptureZValues
protected

Definition at line 530 of file vtkHardwareSelector.h.


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