VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkOpenGLHardwareSelector Class Reference

implements the device specific code of vtkOpenGLHardwareSelector. More...

#include <vtkOpenGLHardwareSelector.h>

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

Public Types

typedef vtkHardwareSelector Superclass
 
typedef vtkHardwareSelector Superclass
 
- Public Types inherited from vtkHardwareSelector
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)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkOpenGLHardwareSelectorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void BeginRenderProp ()
 Called by the mapper (vtkHardwareSelectionPolyDataPainter) before and after rendering each prop. More...
 
virtual void EndRenderProp ()
 
virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkOpenGLHardwareSelectorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void BeginRenderProp ()
 Called by the mapper before and after rendering each prop. More...
 
virtual void EndRenderProp ()
 
virtual void RenderCompositeIndex (unsigned int index)
 Called by any vtkMapper or vtkProp subclass to render a composite-index. More...
 
virtual void RenderAttributeId (vtkIdType attribid)
 Called by any vtkMapper or vtkProp subclass to render an attribute's id. More...
 
virtual void RenderProcessId (unsigned int processid)
 Called by any vtkMapper or subclass to render process id. More...
 
virtual void BeginSelection ()
 
- Public Member Functions inherited from vtkHardwareSelector
vtkHardwareSelectorNewInstance () const
 
virtual void SetRenderer (vtkRenderer *)
 Get/Set the renderer to perform the selection on. More...
 
virtual vtkRendererGetRenderer ()
 
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])
 
virtual unsigned intGetArea ()
 
virtual void GetArea (unsigned int &, unsigned int &, unsigned int &, unsigned int &)
 
virtual void GetArea (unsigned int[4])
 
virtual void SetFieldAssociation (int)
 Set the field type to select. More...
 
virtual int GetFieldAssociation ()
 
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 ()
 
vtkSelectionSelect ()
 Perform the selection. More...
 
virtual bool CaptureBuffers ()
 It is possible to use the vtkHardwareSelector for a custom picking. More...
 
PixelInformation GetPixelInformation (const unsigned int display_position[2])
 
PixelInformation GetPixelInformation (const unsigned int display_position[2], int maxDist)
 
PixelInformation GetPixelInformation (const unsigned int display_position[2], int maxDist, unsigned int selected_position[2])
 
void ClearBuffers ()
 
int Render (vtkRenderer *renderer, vtkProp **propArray, int propArrayCount)
 Called by vtkRenderer to render the selection pass. More...
 
virtual void SetProcessID (int)
 Get/Set the process id. More...
 
virtual int GetProcessID ()
 
virtual floatGetPropColorValue ()
 Get/Set the color to be used by the prop when drawing. More...
 
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 ()
 Get the current pass number. 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...
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
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)
 
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...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual 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...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkOpenGLHardwareSelectorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkOpenGLHardwareSelectorSafeDownCast (vtkObjectBase *o)
 
static vtkOpenGLHardwareSelectorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkOpenGLHardwareSelectorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkHardwareSelector
static vtkHardwareSelectorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkHardwareSelectorSafeDownCast (vtkObjectBase *o)
 
static void Convert (int 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 (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkOpenGLHardwareSelector ()
 
virtual ~vtkOpenGLHardwareSelector ()
 
virtual void BeginRenderProp (vtkRenderWindow *)
 
virtual void EndRenderProp (vtkRenderWindow *)
 
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkOpenGLHardwareSelector ()
 
virtual ~vtkOpenGLHardwareSelector ()
 
void PreCapturePass (int pass) override
 
void PostCapturePass (int pass) override
 
virtual void BeginRenderProp (vtkRenderWindow *)
 
virtual void EndRenderProp (vtkRenderWindow *)
 
virtual void SavePixelBuffer (int passNo)
 
- Protected Member Functions inherited from vtkHardwareSelector
 vtkHardwareSelector ()
 
 ~vtkHardwareSelector ()
 
int Convert (unsigned long offset, unsigned char *pb)
 
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)
 
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 EndSelection ()
 
void BuildPropHitList (unsigned char *rgbData)
 
void ReleasePixBuffers ()
 Clears all pixel buffers. 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=NULL)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkInternals * Internals
 
- Protected Attributes inherited from vtkHardwareSelector
vtkRendererRenderer
 
unsigned int Area [4]
 
int FieldAssociation
 
bool UseProcessIdFromData
 
vtkIdType MaxAttributeId
 
unsigned char * PixBuffer [10]
 
int ProcessID
 
int CurrentPass
 
int InPropRender
 
int PropID
 
float PropColorValue [3]
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

implements the device specific code of vtkOpenGLHardwareSelector.

Implements the device specific code of vtkOpenGLHardwareSelector.

See also
vtkHardwareSelector

Definition at line 33 of file vtkOpenGLHardwareSelector.h.

Member Typedef Documentation

◆ Superclass [1/2]

Definition at line 37 of file vtkOpenGLHardwareSelector.h.

◆ Superclass [2/2]

Definition at line 37 of file vtkOpenGLHardwareSelector.h.

Constructor & Destructor Documentation

◆ vtkOpenGLHardwareSelector() [1/2]

vtkOpenGLHardwareSelector::vtkOpenGLHardwareSelector ( )
protected

◆ ~vtkOpenGLHardwareSelector() [1/2]

virtual vtkOpenGLHardwareSelector::~vtkOpenGLHardwareSelector ( )
protectedvirtual

◆ vtkOpenGLHardwareSelector() [2/2]

vtkOpenGLHardwareSelector::vtkOpenGLHardwareSelector ( )
protected

◆ ~vtkOpenGLHardwareSelector() [2/2]

virtual vtkOpenGLHardwareSelector::~vtkOpenGLHardwareSelector ( )
protectedvirtual

Member Function Documentation

◆ New() [1/2]

static vtkOpenGLHardwareSelector* vtkOpenGLHardwareSelector::New ( )
static

◆ IsTypeOf() [1/2]

static int vtkOpenGLHardwareSelector::IsTypeOf ( const char *  type)
static

◆ IsA() [1/2]

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

Reimplemented in vtkPHardwareSelector.

◆ SafeDownCast() [1/2]

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

◆ NewInstanceInternal() [1/2]

virtual vtkObjectBase* vtkOpenGLHardwareSelector::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkHardwareSelector.

Reimplemented in vtkPHardwareSelector.

◆ NewInstance() [1/2]

vtkOpenGLHardwareSelector* vtkOpenGLHardwareSelector::NewInstance ( ) const

◆ PrintSelf() [1/2]

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

Reimplemented in vtkPHardwareSelector.

◆ BeginRenderProp() [1/4]

virtual void vtkOpenGLHardwareSelector::BeginRenderProp ( )
inlinevirtual

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

Reimplemented from vtkHardwareSelector.

Definition at line 44 of file vtkOpenGLHardwareSelector.h.

◆ EndRenderProp() [1/4]

virtual void vtkOpenGLHardwareSelector::EndRenderProp ( )
inlinevirtual

Reimplemented from vtkHardwareSelector.

Definition at line 47 of file vtkOpenGLHardwareSelector.h.

◆ BeginRenderProp() [2/4]

virtual void vtkOpenGLHardwareSelector::BeginRenderProp ( vtkRenderWindow )
protectedvirtual

Implements vtkHardwareSelector.

◆ EndRenderProp() [2/4]

virtual void vtkOpenGLHardwareSelector::EndRenderProp ( vtkRenderWindow )
protectedvirtual

Implements vtkHardwareSelector.

◆ New() [2/2]

static vtkOpenGLHardwareSelector* vtkOpenGLHardwareSelector::New ( )
static

◆ IsTypeOf() [2/2]

static int vtkOpenGLHardwareSelector::IsTypeOf ( const char *  type)
static

◆ IsA() [2/2]

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

Reimplemented in vtkPHardwareSelector.

◆ SafeDownCast() [2/2]

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

◆ NewInstanceInternal() [2/2]

virtual vtkObjectBase* vtkOpenGLHardwareSelector::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkHardwareSelector.

Reimplemented in vtkPHardwareSelector.

◆ NewInstance() [2/2]

vtkOpenGLHardwareSelector* vtkOpenGLHardwareSelector::NewInstance ( ) const

◆ PrintSelf() [2/2]

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

Reimplemented in vtkPHardwareSelector.

◆ BeginRenderProp() [3/4]

virtual void vtkOpenGLHardwareSelector::BeginRenderProp ( )
virtual

Called by the mapper before and after rendering each prop.

Reimplemented from vtkHardwareSelector.

◆ EndRenderProp() [3/4]

virtual void vtkOpenGLHardwareSelector::EndRenderProp ( )
inlinevirtual

Reimplemented from vtkHardwareSelector.

Definition at line 45 of file vtkOpenGLHardwareSelector.h.

◆ RenderCompositeIndex()

virtual void vtkOpenGLHardwareSelector::RenderCompositeIndex ( unsigned int  index)
virtual

Called by any vtkMapper or vtkProp subclass to render a composite-index.

Currently indices >= 0xffffff are not supported.

Reimplemented from vtkHardwareSelector.

◆ RenderAttributeId()

virtual void vtkOpenGLHardwareSelector::RenderAttributeId ( vtkIdType  attribid)
virtual

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

Reimplemented from vtkHardwareSelector.

◆ RenderProcessId()

virtual void vtkOpenGLHardwareSelector::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 from vtkHardwareSelector.

◆ BeginSelection()

virtual void vtkOpenGLHardwareSelector::BeginSelection ( )
virtual

Reimplemented from vtkHardwareSelector.

◆ PreCapturePass()

void vtkOpenGLHardwareSelector::PreCapturePass ( int  pass)
overrideprotectedvirtual

Reimplemented from vtkHardwareSelector.

◆ PostCapturePass()

void vtkOpenGLHardwareSelector::PostCapturePass ( int  pass)
overrideprotectedvirtual

Reimplemented from vtkHardwareSelector.

◆ BeginRenderProp() [4/4]

virtual void vtkOpenGLHardwareSelector::BeginRenderProp ( vtkRenderWindow )
protectedvirtual

Implements vtkHardwareSelector.

◆ EndRenderProp() [4/4]

virtual void vtkOpenGLHardwareSelector::EndRenderProp ( vtkRenderWindow )
protectedvirtual

Implements vtkHardwareSelector.

◆ SavePixelBuffer()

virtual void vtkOpenGLHardwareSelector::SavePixelBuffer ( int  passNo)
protectedvirtual

Reimplemented from vtkHardwareSelector.

Member Data Documentation

◆ Internals

vtkInternals * vtkOpenGLHardwareSelector::Internals
protected

Definition at line 61 of file vtkOpenGLHardwareSelector.h.


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