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

virtual 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
vtkRenderPass *	NewInstance () const

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

void	PrintRevisions (ostream &)
	Legacy. 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 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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkOSPRayPass ()
	Default constructor. More...

virtual	~vtkOSPRayPass ()
	Destructor. More...

Protected Member Functions inherited from vtkRenderPass
	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)
	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	CollectRevisions (ostream &)

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
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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'

Tests:: vtkOSPRayPass (Tests)

Definition at line 55 of file vtkOSPRayPass.h.

Member Typedef Documentation

typedef vtkRenderPass vtkOSPRayPass::Superclass

Definition at line 59 of file vtkOSPRayPass.h.

Constructor & Destructor Documentation

vtkOSPRayPass::vtkOSPRayPass ( )

protected

Default constructor.

virtual vtkOSPRayPass::~vtkOSPRayPass ( )

protectedvirtual

Destructor.

Member Function Documentation

static vtkOSPRayPass* vtkOSPRayPass::New ( )

static

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

static

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.

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

static

virtual vtkObjectBase* vtkOSPRayPass::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkRenderPass.

vtkOSPRayPass* vtkOSPRayPass::NewInstance ( ) const

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.

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

overridevirtual

Perform rendering according to a render state s.

Implements vtkRenderPass.

void vtkOSPRayPass::SetSceneGraph ( vtkOSPRayRendererNode * )

Tells the pass what it will render.

virtual vtkOSPRayRendererNode* vtkOSPRayPass::GetSceneGraph ( )

virtual

Tells the pass what it will render.

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

virtual

Called by the internals of this class.

Member Data Documentation

vtkOSPRayRendererNode* vtkOSPRayPass::SceneGraph

protected

Definition at line 91 of file vtkOSPRayPass.h.

vtkCameraPass* vtkOSPRayPass::CameraPass

protected

Definition at line 92 of file vtkOSPRayPass.h.

vtkLightsPass* vtkOSPRayPass::LightsPass

protected

Definition at line 93 of file vtkOSPRayPass.h.

vtkOverlayPass* vtkOSPRayPass::OverlayPass

protected

Definition at line 94 of file vtkOSPRayPass.h.

vtkVolumetricPass* vtkOSPRayPass::VolumetricPass

protected

Definition at line 95 of file vtkOSPRayPass.h.

vtkSequencePass* vtkOSPRayPass::SequencePass

protected

Definition at line 96 of file vtkOSPRayPass.h.

vtkRenderPassCollection* vtkOSPRayPass::RenderPassCollection

protected

Definition at line 97 of file vtkOSPRayPass.h.

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

/home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Rendering/OSPRay/vtkOSPRayPass.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation