vtkPHardwareSelector - vtkHardwareSelector useful for parallel rendering. More...

Inheritance diagram for Kitware.VTK.vtkPHardwareSelector:

Collaboration diagram for Kitware.VTK.vtkPHardwareSelector:

Public Member Functions
	vtkPHardwareSelector (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkPHardwareSelector ()
	*Undocumented Block
override bool	CaptureBuffers ()
	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.
virtual bool	GetProcessIsRoot ()
	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.
override int	IsA (string type)
	*Undocumented Block
new vtkPHardwareSelector	NewInstance ()
	*Undocumented Block
virtual void	ProcessIsRootOff ()
	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.
virtual void	ProcessIsRootOn ()
	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.
virtual void	SetProcessIsRoot (bool _arg)
	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.
Public Member Functions inherited from Kitware.VTK.vtkHardwareSelector
	vtkHardwareSelector (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkHardwareSelector ()
	Struct used to return information about a pixel location.
void	BeginRenderProp ()
	Called by the mapper (vtkHardwareSelectionPolyDataPainter) before and after rendering each prop.
void	ClearBuffers ()
	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	EndRenderProp ()
	Called by the mapper (vtkHardwareSelectionPolyDataPainter) before and after rendering each prop.
virtual vtkSelection	GenerateSelection ()
	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.
virtual vtkSelection	GenerateSelection (IntPtr r)
	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.
virtual vtkSelection	GenerateSelection (uint x1, uint y1, uint x2, uint y2)
	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.
virtual uint[]	GetArea ()
	Get/Set the area to select as (xmin, ymin, xmax, ymax).
virtual void	GetArea (ref uint _arg1, ref uint _arg2, ref uint _arg3, ref uint _arg4)
	Get/Set the area to select as (xmin, ymin, xmax, ymax).
virtual void	GetArea (IntPtr _arg)
	Get/Set the area to select as (xmin, ymin, xmax, ymax).
virtual int	GetCurrentPass ()
	Get the current pass number.
virtual int	GetFieldAssociation ()
	Set the field type to select. Valid values are.
bool	GetPixelInformation (IntPtr display_position, ref int processId, ref int attrId, vtkProp prop)
bool	GetPixelInformation (IntPtr display_position, ref int processId, ref int attrId, vtkProp prop, int maxDist)
virtual int	GetProcessID ()
	Get/Set the process id. If process id < 0 (default -1), then the PROCESS_PASS is not rendered.
vtkProp	GetPropFromID (int id)
	returns the prop associated with a ID. This is valid only until ReleasePixBuffers() gets called.
virtual vtkRenderer	GetRenderer ()
	Get/Set the renderer to perform the selection on.
void	RenderAttributeId (int attribid)
	Called by any vtkMapper or vtkProp subclass to render an attribute's id.
void	RenderCompositeIndex (uint index)
	Called by any vtkMapper or vtkProp subclass to render a composite-index. Currently indices > 0xffffff are not supported.
vtkSelection	Select ()
	Perform the selection. Returns a new instance of vtkSelection containing the selection on success.
virtual void	SetArea (uint _arg1, uint _arg2, uint _arg3, uint _arg4)
	Get/Set the area to select as (xmin, ymin, xmax, ymax).
virtual void	SetArea (IntPtr _arg)
	Get/Set the area to select as (xmin, ymin, xmax, ymax).
virtual void	SetFieldAssociation (int _arg)
	Set the field type to select. Valid values are.
virtual void	SetProcessID (int _arg)
	Get/Set the process id. If process id < 0 (default -1), then the PROCESS_PASS is not rendered.
void	SetRenderer (vtkRenderer arg0)
	Get/Set the renderer to perform the selection on.
Public Member Functions inherited from Kitware.VTK.vtkObject
	vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkObject ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint	AddObserver (uint arg0, vtkCommand arg1, float priority)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
uint	AddObserver (string arg0, vtkCommand arg1, float priority)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void	DebugOff ()
	Turn debugging output off.
virtual void	DebugOn ()
	Turn debugging output on.
vtkCommand	GetCommand (uint tag)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
byte	GetDebug ()
	Get the value of the debug flag.
virtual uint	GetMTime ()
	Return this object's modified time.
int	HasObserver (uint arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (string arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (uint arg0, IntPtr callData)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (string arg0, IntPtr callData)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void	Modified ()
	Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void	RemoveAllObservers ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObserver (vtkCommand arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObserver (uint tag)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (uint arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (string arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	SetDebug (byte debugFlag)
	Set the value of the debug flag. A non-zero value turns debugging on.
override string	ToString ()
	Returns the result of calling vtkObject::Print as a C# string.
delegate void	vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
	Generic signature for all vtkObject events.
void	RemoveAllHandlersForAllEvents ()
	Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
Public Member Functions inherited from Kitware.VTK.vtkObjectBase
	vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkObjectBase ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void	Register (vtkObjectBase o)
	Increase the reference count (mark as used by another object).
virtual void	FastDelete ()
	Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string	GetClassName ()
	Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int arg0)
	Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions
static new vtkPHardwareSelector	New ()
	*Undocumented Block
static new int	IsTypeOf (string type)
	*Undocumented Block
static new vtkPHardwareSelector	SafeDownCast (vtkObjectBase o)
	*Undocumented Block

Public Attributes
new const string	MRFullTypeName = "Kitware.VTK.vtkPHardwareSelector"
	Automatically generated type registration mechanics.
Public Attributes inherited from Kitware.VTK.vtkHardwareSelector
Public Attributes inherited from Kitware.VTK.vtkObject
Public Attributes inherited from Kitware.VTK.vtkObjectBase
Public Attributes inherited from Kitware.VTK.WrappedObject
const string	vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
	Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string	vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
	Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string	vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
	Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string	vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
	Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string	vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
	Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string	vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
	Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string	vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
	Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string	vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
	Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string	vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
	Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string	vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
	Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string	vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
	Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string	vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
	Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string	vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
	Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string	vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
	Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string	vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
	Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes
static new readonly string	MRClassNameKey = "20vtkPHardwareSelector"
	Automatically generated type registration mechanics.
Static Public Attributes inherited from Kitware.VTK.vtkHardwareSelector
Static Public Attributes inherited from Kitware.VTK.vtkObject
Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

Protected Member Functions
override void	Dispose (bool disposing)
	Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Static Private Member Functions
static	vtkPHardwareSelector ()
	Automatically generated type registration mechanics.

Additional Inherited Members
Public Types inherited from Kitware.VTK.vtkHardwareSelector
enum	PassTypes { ACTOR_PASS = 1, COMPOSITE_INDEX_PASS = 2, ID_HIGH16 = 5, ID_LOW24 = 3, ID_MID24 = 4, MAX_KNOWN_PASS = 5, MIN_KNOWN_PASS = 0, PROCESS_PASS = 0 }
	returns the prop associated with a ID. This is valid only until ReleasePixBuffers() gets called. More...

Detailed Description

vtkPHardwareSelector - vtkHardwareSelector useful for parallel rendering.

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

Constructor & Destructor Documentation

static Kitware.VTK.vtkPHardwareSelector.vtkPHardwareSelector ( )

staticprivate

Automatically generated type registration mechanics.

Kitware.VTK.vtkPHardwareSelector.vtkPHardwareSelector	(	IntPtr	rawCppThis,
		bool	callDisposalMethod,
		bool	strong
	)

Automatically generated constructor - called from generated code. DO NOT call directly.

Kitware.VTK.vtkPHardwareSelector.vtkPHardwareSelector ( )

*Undocumented Block

Member Function Documentation

override bool Kitware.VTK.vtkPHardwareSelector.CaptureBuffers ( )

virtual

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 Kitware.VTK.vtkHardwareSelector.

override void Kitware.VTK.vtkPHardwareSelector.Dispose ( bool disposing )

protected

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkHardwareSelector.

virtual bool Kitware.VTK.vtkPHardwareSelector.GetProcessIsRoot ( )

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.

override int Kitware.VTK.vtkPHardwareSelector.IsA ( string type )

virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkHardwareSelector.

static new int Kitware.VTK.vtkPHardwareSelector.IsTypeOf ( string type )

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkHardwareSelector.

static new vtkPHardwareSelector Kitware.VTK.vtkPHardwareSelector.New ( )

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkHardwareSelector.

new vtkPHardwareSelector Kitware.VTK.vtkPHardwareSelector.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkHardwareSelector.

virtual void Kitware.VTK.vtkPHardwareSelector.ProcessIsRootOff ( )

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.

virtual void Kitware.VTK.vtkPHardwareSelector.ProcessIsRootOn ( )

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.

static new vtkPHardwareSelector Kitware.VTK.vtkPHardwareSelector.SafeDownCast ( vtkObjectBase o )

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkHardwareSelector.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkPHardwareSelector.SetProcessIsRoot ( bool _arg )

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.