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

vtkHardwareSelector useful for parallel rendering. More...

#include <vtkPHardwareSelector.h>

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

Public Types

typedef vtkOpenGLHardwareSelector Superclass
 
- Public Types inherited from vtkOpenGLHardwareSelector
typedef vtkHardwareSelector Superclass
 
- Public Types inherited from vtkHardwareSelector
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...
 
vtkPHardwareSelectorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetProcessIsRoot (bool)
 Set/Get the is the root process. More...
 
virtual bool GetProcessIsRoot ()
 
virtual void ProcessIsRootOn ()
 
virtual void ProcessIsRootOff ()
 
bool CaptureBuffers () override
 Overridden to only allow the superclass implementation on the root node. More...
 
- Public Member Functions inherited from vtkOpenGLHardwareSelector
vtkOpenGLHardwareSelectorNewInstance () const
 
void BeginRenderProp () override
 Called by the mapper before and after rendering each prop. More...
 
void EndRenderProp () override
 
void RenderCompositeIndex (unsigned int index) override
 Called by any vtkMapper or vtkProp subclass to render a composite-index. More...
 
void RenderProcessId (unsigned int processid) override
 Called by any vtkMapper or subclass to render process id. More...
 
void BeginSelection () override
 
void EndSelection () override
 
- 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 int * GetArea ()
 
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...
 
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 ()
 
unsigned char * GetRawPixelBuffer (int passNo)
 
unsigned char * GetPixelBuffer (int passNo)
 
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)
 
int Render (vtkRenderer *renderer, vtkProp **propArray, int propArrayCount)
 Called by vtkRenderer to render the selection pass. More...
 
virtual bool GetActorPassOnly ()
 Get/Set to only do the actor pass. More...
 
virtual void SetActorPassOnly (bool)
 
virtual bool GetCaptureZValues ()
 Get/Set to capture the zvalue. More...
 
virtual void SetCaptureZValues (bool)
 
virtual void SetProcessID (int)
 Get/Set the process id. More...
 
virtual int GetProcessID ()
 
virtual float * GetPropColorValue ()
 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])
 
void SetPropColorValue (vtkIdType val)
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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 vtkPHardwareSelectorNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPHardwareSelectorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkOpenGLHardwareSelector
static vtkOpenGLHardwareSelectorNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenGLHardwareSelectorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkHardwareSelector
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 (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
 
 vtkPHardwareSelector ()
 
 ~vtkPHardwareSelector () override
 
void StartRender ()
 
void EndRender ()
 
- Protected Member Functions inherited from vtkOpenGLHardwareSelector
 vtkOpenGLHardwareSelector ()
 
 ~vtkOpenGLHardwareSelector () override
 
void PreCapturePass (int pass) override
 
void PostCapturePass (int pass) override
 
void BeginRenderProp (vtkRenderWindow *) override
 
void EndRenderProp (vtkRenderWindow *) override
 
void SavePixelBuffer (int passNo) override
 
- Protected Member Functions inherited from vtkHardwareSelector
 vtkHardwareSelector ()
 
 ~vtkHardwareSelector () override
 
double GetZValue (int propid)
 
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 ProcessPixelBuffers ()
 
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=nullptr)
 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

bool ProcessIsRoot
 
- Protected Attributes inherited from vtkOpenGLHardwareSelector
bool OriginalMultisample
 
bool OriginalBlending
 
- Protected Attributes inherited from vtkHardwareSelector
vtkRendererRenderer
 
unsigned int Area [4]
 
int FieldAssociation
 
bool UseProcessIdFromData
 
vtkIdType MaximumPointId
 
vtkIdType MaximumCellId
 
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
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkObserver
 

Detailed Description

vtkHardwareSelector useful for parallel rendering.

vtkPHardwareSelector is a vtkHardwareSelector that is parallel aware. It relies on the fact that the application is going to use some other mechanism to ensure that renders are synchronized among windows on all processes. The synchronization happens from the root node. When the root node renders, all processes render. Only vtkPHardwareSelector instance on the root node triggers the renders. All other processes, simply listen to the StartEvent fired and beginning of the render to ensure that vtkHardwareSelector's CurrentPass is updated appropriately.

Definition at line 36 of file vtkPHardwareSelector.h.

Member Typedef Documentation

◆ Superclass

Definition at line 40 of file vtkPHardwareSelector.h.

Constructor & Destructor Documentation

◆ vtkPHardwareSelector()

vtkPHardwareSelector::vtkPHardwareSelector ( )
protected

◆ ~vtkPHardwareSelector()

vtkPHardwareSelector::~vtkPHardwareSelector ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkPHardwareSelector* vtkPHardwareSelector::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkPHardwareSelector::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 vtkOpenGLHardwareSelector.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPHardwareSelector::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkOpenGLHardwareSelector.

◆ NewInstance()

vtkPHardwareSelector* vtkPHardwareSelector::NewInstance ( ) const

◆ PrintSelf()

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

◆ SetProcessIsRoot()

virtual void vtkPHardwareSelector::SetProcessIsRoot ( bool  )
virtual

Set/Get the is the root process.

The root processes is the only processes which has the composited result and hence the only processes that capture buffers and builds selected list ids.

◆ GetProcessIsRoot()

virtual bool vtkPHardwareSelector::GetProcessIsRoot ( )
virtual

◆ ProcessIsRootOn()

virtual void vtkPHardwareSelector::ProcessIsRootOn ( )
virtual

◆ ProcessIsRootOff()

virtual void vtkPHardwareSelector::ProcessIsRootOff ( )
virtual

◆ CaptureBuffers()

bool vtkPHardwareSelector::CaptureBuffers ( )
overridevirtual

Overridden to only allow the superclass implementation on the root node.

On all other processes, the updating the internal state of the vtkHardwareSelector as the capturing of buffers progresses is done as a slave to the master render.

Reimplemented from vtkHardwareSelector.

◆ StartRender()

void vtkPHardwareSelector::StartRender ( )
protected

◆ EndRender()

void vtkPHardwareSelector::EndRender ( )
protected

Friends And Related Function Documentation

◆ vtkObserver

friend class vtkObserver
friend

Definition at line 75 of file vtkPHardwareSelector.h.

Member Data Documentation

◆ ProcessIsRoot

bool vtkPHardwareSelector::ProcessIsRoot
protected

Definition at line 69 of file vtkPHardwareSelector.h.


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