a render pass that uses OSPRay instead of GL More...

#include <vtkOSPRayPass.h>

Inheritance diagram for vtkOSPRayPass:

Collaboration diagram for vtkOSPRayPass:

Public Types
typedef vtkRenderPass	Superclass

Public Types inherited from vtkRenderPass
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...

vtkOSPRayPass *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	Render (const vtkRenderState *s) override
	Perform rendering according to a render state s. More...

virtual void	RenderInternal (const vtkRenderState *s)
	Called by the internals of this class. More...


void	SetSceneGraph (vtkOSPRayRendererNode *)
	Tells the pass what it will render. More...

virtual vtkOSPRayRendererNode *	GetSceneGraph ()
	Tells the pass what it will render. More...

Public Member Functions inherited from vtkRenderPass
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkRenderPass *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	Render (const vtkRenderState *s)=0
	Perform rendering according to a render state `s`. More...

virtual void	ReleaseGraphicsResources (vtkWindow *w)
	Release graphics resources and ask components to release their own resources. More...

virtual int	GetNumberOfRenderedProps ()
	Number of props rendered at the last Render call. 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	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. 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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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

vtkCommand *	GetCommand (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...

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)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. 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...

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

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

Static Public Member Functions
static vtkOSPRayPass *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkOSPRayPass *	SafeDownCast (vtkObjectBase *o)

static void	RTInit ()
	Wrapper around ospray's init and shutdown that protect with a reference count. More...

static void	RTShutdown ()

static bool	IsSupported ()
	A run time query to see if OSPRay can possibly work. More...

static bool	IsBackendAvailable (const char *name)
	A run time query to see if a particular backend is available. More...

Static Public Member Functions inherited from vtkRenderPass
static vtkTypeBool	IsTypeOf (const char *type)

static vtkRenderPass *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 ()
	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 int	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 vtkObjectBase *	New ()
	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 vtkObjectBase *	NewInstanceInternal () const

	vtkOSPRayPass ()
	Default constructor. More...

	~vtkOSPRayPass () override
	Destructor. More...

Protected Member Functions inherited from vtkRenderPass
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkRenderPass ()
	Default constructor. More...

	~vtkRenderPass () override
	Destructor. More...

void	UpdateCamera (vtkRenderer *renderer)
	Call UpdateCamera() on Renderer. More...

void	ClearLights (vtkRenderer *renderer)
	Call ClearLights() on Renderer. More...

void	UpdateLightGeometry (vtkRenderer *renderer)
	Call UpdateLightGeometry() on Renderer. More...

void	UpdateLights (vtkRenderer *renderer)
	Call UpdateLights() on Renderer. More...

void	UpdateGeometry (vtkRenderer renderer, vtkFrameBufferObjectBase fbo=nullptr)
	Call UpdateGeometry() on Renderer. More...

void	SetLastRenderingUsedDepthPeeling (vtkRenderer *renderer, bool value)
	Modify protected member LastRenderingUsedDepthPeeling on Renderer. 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	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkOSPRayRendererNode *	SceneGraph

vtkCameraPass *	CameraPass

vtkLightsPass *	LightsPass

vtkOverlayPass *	OverlayPass

vtkVolumetricPass *	VolumetricPass

vtkSequencePass *	SequencePass

vtkRenderPassCollection *	RenderPassCollection

Protected Attributes inherited from vtkRenderPass
int	NumberOfRenderedProps

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

a render pass that uses OSPRay instead of GL

This is a render pass that can be put into a vtkRenderWindow which makes it use OSPRay instead of OpenGL to render. Adding/Removing the pass will swap back and forth between the two.

OSPRay MPI - OSPRay can use its own internal MPI layer to replicate the scene data across mpi processes and composite the image. This results in linear performance scaling and supports secondary rays. To run in this mode, a special environment variable is supplied called VTKOSPRAY_ARGS where commandline flags can be inserted for OSPRay's init call. As an example of this, below is a commandline for running paraview on localhost, but having OSPRay's rendering occur on 2 remote nodes. ospray_mpi_worker is a separate application supplied with OSPRay binary packages or when built with MPI support from source. 'mpirun -ppn 1 -hosts localhost VTKOSPRAY_ARGS="-osp:mpi" ./paraview : -hosts n1, n2 ./ospray_mpi_worker -osp:mpi'

Definition at line 54 of file vtkOSPRayPass.h.

Member Typedef Documentation

◆ Superclass

typedef vtkRenderPass vtkOSPRayPass::Superclass

Definition at line 58 of file vtkOSPRayPass.h.

Constructor & Destructor Documentation

◆ vtkOSPRayPass()

vtkOSPRayPass::vtkOSPRayPass ( )

protected

Default constructor.

◆ ~vtkOSPRayPass()

vtkOSPRayPass::~vtkOSPRayPass ( )

overrideprotected

Destructor.

Member Function Documentation

◆ New()

static vtkOSPRayPass * vtkOSPRayPass::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkOSPRayPass::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 vtkRenderPass.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkOSPRayPass::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkRenderPass.

◆ NewInstance()

vtkOSPRayPass * vtkOSPRayPass::NewInstance ( ) const

◆ PrintSelf()

void vtkOSPRayPass::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 vtkRenderPass.

◆ Render()

void vtkOSPRayPass::Render ( const vtkRenderState * s )

overridevirtual

Perform rendering according to a render state s.

Implements vtkRenderPass.

◆ SetSceneGraph()

void vtkOSPRayPass::SetSceneGraph ( vtkOSPRayRendererNode * )

Tells the pass what it will render.

◆ GetSceneGraph()

virtual vtkOSPRayRendererNode * vtkOSPRayPass::GetSceneGraph ( )

virtual

Tells the pass what it will render.

◆ RenderInternal()

virtual void vtkOSPRayPass::RenderInternal ( const vtkRenderState * s )

virtual

Called by the internals of this class.

◆ RTInit()

static void vtkOSPRayPass::RTInit ( )

static

Wrapper around ospray's init and shutdown that protect with a reference count.

◆ RTShutdown()

static void vtkOSPRayPass::RTShutdown ( )

static

◆ IsSupported()

static bool vtkOSPRayPass::IsSupported ( )

static

A run time query to see if OSPRay can possibly work.

◆ IsBackendAvailable()

static bool vtkOSPRayPass::IsBackendAvailable ( const char * name )

static

A run time query to see if a particular backend is available.

Eg. "OSPRay raycaster", "OSPRay pathtracer" or "OptiX pathtracer".

Member Data Documentation

◆ SceneGraph

vtkOSPRayRendererNode* vtkOSPRayPass::SceneGraph

protected

Definition at line 110 of file vtkOSPRayPass.h.

◆ CameraPass

vtkCameraPass* vtkOSPRayPass::CameraPass

protected

Definition at line 111 of file vtkOSPRayPass.h.

◆ LightsPass

vtkLightsPass* vtkOSPRayPass::LightsPass

protected

Definition at line 112 of file vtkOSPRayPass.h.

◆ OverlayPass

vtkOverlayPass* vtkOSPRayPass::OverlayPass

protected

Definition at line 113 of file vtkOSPRayPass.h.

◆ VolumetricPass

vtkVolumetricPass* vtkOSPRayPass::VolumetricPass

protected

Definition at line 114 of file vtkOSPRayPass.h.

◆ SequencePass

vtkSequencePass* vtkOSPRayPass::SequencePass

protected

Definition at line 115 of file vtkOSPRayPass.h.

◆ RenderPassCollection

vtkRenderPassCollection* vtkOSPRayPass::RenderPassCollection

protected

Definition at line 116 of file vtkOSPRayPass.h.

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

Rendering/RayTracing/vtkOSPRayPass.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkOSPRayPass()

◆ ~vtkOSPRayPass()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ Render()

◆ SetSceneGraph()

◆ GetSceneGraph()

◆ RenderInternal()

◆ RTInit()

◆ RTShutdown()

◆ IsSupported()

◆ IsBackendAvailable()

Member Data Documentation

◆ SceneGraph

◆ CameraPass

◆ LightsPass

◆ OverlayPass

◆ VolumetricPass

◆ SequencePass

◆ RenderPassCollection