Render pass that render the scene in a cubemap and project these six renderings to a single quad. More...

#include <vtkPanoramicProjectionPass.h>

Inheritance diagram for vtkPanoramicProjectionPass:

Collaboration diagram for vtkPanoramicProjectionPass:

Public Types
enum	: int { Equirectangular = 1, Azimuthal = 2 }
	Enumeration of projection types. More...

typedef vtkImageProcessingPass	Superclass

Public Types inherited from vtkImageProcessingPass
typedef vtkOpenGLRenderPass	Superclass

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

vtkPanoramicProjectionPass *	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. More...

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


virtual unsigned int	GetCubeResolution ()
	Get/Set the cubemap textures resolution used to render (offscreen) all directions. More...

virtual void	SetCubeResolution (unsigned int)
	Get/Set the cubemap textures resolution used to render (offscreen) all directions. More...


virtual int	GetProjectionType ()
	Get/Set the type of projection. More...

virtual void	SetProjectionType (int)
	Get/Set the type of projection. More...

void	SetProjectionTypeToEquirectangular ()
	Get/Set the type of projection. More...

void	SetProjectionTypeToAzimuthal ()
	Get/Set the type of projection. More...


virtual double	GetAngle ()
	Get/Set the vertical angle of projection. More...

virtual void	SetAngle (double)
	Get/Set the vertical angle of projection. More...

Public Member Functions inherited from vtkImageProcessingPass
vtkImageProcessingPass *	NewInstance () const

virtual vtkRenderPass *	GetDelegatePass ()
	Delegate for rendering the image to be processed. More...

virtual void	SetDelegatePass (vtkRenderPass *delegatePass)
	Delegate for rendering the image to be processed. More...

Public Member Functions inherited from vtkOpenGLRenderPass
vtkOpenGLRenderPass *	NewInstance () const

virtual bool	PreReplaceShaderValues (std::string &vertexShader, std::string &geometryShader, std::string &fragmentShader, vtkAbstractMapper mapper, vtkProp prop)
	Use vtkShaderProgram::Substitute to replace //VTK::XXX:YYY declarations in the shader sources. More...

virtual bool	PostReplaceShaderValues (std::string &vertexShader, std::string &geometryShader, std::string &fragmentShader, vtkAbstractMapper mapper, vtkProp prop)
	Use vtkShaderProgram::Substitute to replace //VTK::XXX:YYY declarations in the shader sources. More...

virtual bool	SetShaderParameters (vtkShaderProgram program, vtkAbstractMapper mapper, vtkProp prop, vtkOpenGLVertexArrayObject VAO=nullptr)
	Update the uniforms of the shader program. More...

virtual vtkMTimeType	GetShaderStageMTime ()
	For multi-stage render passes that need to change shader code during a single pass, use this method to notify a mapper that the shader needs to be rebuilt (rather than reuse the last cached shader. More...

virtual void	SetActiveDrawBuffers (unsigned int)
	Number of active draw buffers. More...

virtual unsigned int	GetActiveDrawBuffers ()

Public Member Functions inherited from vtkRenderPass
vtkRenderPass *	NewInstance () const

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 vtkPanoramicProjectionPass *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkPanoramicProjectionPass *	SafeDownCast (vtkObjectBase *o)

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

static vtkImageProcessingPass *	SafeDownCast (vtkObjectBase *o)

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

static vtkOpenGLRenderPass *	SafeDownCast (vtkObjectBase *o)

static vtkInformationObjectBaseVectorKey *	RenderPasses ()
	Key containing information about the current pass. 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 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

	vtkPanoramicProjectionPass ()=default

	~vtkPanoramicProjectionPass () override=default

void	RenderOnFace (const vtkRenderState *s, int index)

void	Project (vtkOpenGLRenderWindow *renWin)

void	InitOpenGLResources (vtkOpenGLRenderWindow *renWin)

Protected Member Functions inherited from vtkImageProcessingPass
	vtkImageProcessingPass ()
	Default constructor. More...

	~vtkImageProcessingPass () override
	Destructor. More...

void	RenderDelegate (const vtkRenderState s, int width, int height, int newWidth, int newHeight, vtkOpenGLFramebufferObject fbo, vtkTextureObject *target)
	Render delegate with a image of different dimensions than the original one. More...

Protected Member Functions inherited from vtkOpenGLRenderPass
	vtkOpenGLRenderPass ()

	~vtkOpenGLRenderPass () override

void	PreRender (const vtkRenderState *s)
	Call before rendering to update the actors' information keys. More...

void	PostRender (const vtkRenderState *s)
	Call after rendering to clean up the actors' information keys. 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
vtkOpenGLFramebufferObject *	FrameBufferObject = nullptr
	Graphics resources. More...

vtkTextureObject *	CubeMapTexture = nullptr

vtkOpenGLQuadHelper *	QuadHelper = nullptr

unsigned int	CubeResolution = 300

int	ProjectionType = Equirectangular

double	Angle = 180.0

Protected Attributes inherited from vtkImageProcessingPass
vtkRenderPass *	DelegatePass

Protected Attributes inherited from vtkOpenGLRenderPass
unsigned int	ActiveDrawBuffers = 0

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

Render pass that render the scene in a cubemap and project these six renderings to a single quad.

There are currently two differents projections implemented (Equirectangular and Azimuthal). This pass can be used to produce images that can be visualize with specific devices that re-maps the distorted image to a panoramic view (for instance VR headsets, domes, panoramic screens)

Note that it is often necessary to disable frustum cullers in order to render properly objects that are behind the camera.

See also: vtkRenderPass

Definition at line 40 of file vtkPanoramicProjectionPass.h.

Member Typedef Documentation

typedef vtkImageProcessingPass vtkPanoramicProjectionPass::Superclass

Definition at line 44 of file vtkPanoramicProjectionPass.h.

Member Enumeration Documentation

anonymous enum : int

Enumeration of projection types.

Enumerator
Equirectangular	Equirectangular projection.
Azimuthal	Azimuthal equidistant projection.

Definition at line 69 of file vtkPanoramicProjectionPass.h.

Constructor & Destructor Documentation

vtkPanoramicProjectionPass::vtkPanoramicProjectionPass ( )

protecteddefault

vtkPanoramicProjectionPass::~vtkPanoramicProjectionPass ( )

overrideprotecteddefault

Member Function Documentation

static vtkPanoramicProjectionPass* vtkPanoramicProjectionPass::New ( )

static

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

static

virtual vtkTypeBool vtkPanoramicProjectionPass::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 vtkImageProcessingPass.

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

static

virtual vtkObjectBase* vtkPanoramicProjectionPass::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImageProcessingPass.

vtkPanoramicProjectionPass* vtkPanoramicProjectionPass::NewInstance ( ) const

void vtkPanoramicProjectionPass::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 vtkImageProcessingPass.

void vtkPanoramicProjectionPass::Render ( const vtkRenderState * s )

overridevirtual

Perform rendering according to a render state.

Implements vtkRenderPass.

void vtkPanoramicProjectionPass::ReleaseGraphicsResources ( vtkWindow * w )

overridevirtual

Release graphics resources and ask components to release their own resources.

Reimplemented from vtkImageProcessingPass.

virtual unsigned int vtkPanoramicProjectionPass::GetCubeResolution ( )

virtual

Get/Set the cubemap textures resolution used to render (offscreen) all directions.

Default is 300.

virtual void vtkPanoramicProjectionPass::SetCubeResolution ( unsigned int )

virtual

Get/Set the cubemap textures resolution used to render (offscreen) all directions.

Default is 300.

virtual int vtkPanoramicProjectionPass::GetProjectionType ( )

virtual

Get/Set the type of projection.

Equirectangular projection maps meridians to vertical straight lines and circles of latitude to horizontal straight lines. Azimuthal equidistant projection maps all points of the scene based on their distance to the view direction. This projection produces a fisheye effect. Default is Equirectangular.

virtual void vtkPanoramicProjectionPass::SetProjectionType ( int )

virtual

Get/Set the type of projection.

Equirectangular projection maps meridians to vertical straight lines and circles of latitude to horizontal straight lines. Azimuthal equidistant projection maps all points of the scene based on their distance to the view direction. This projection produces a fisheye effect. Default is Equirectangular.

void vtkPanoramicProjectionPass::SetProjectionTypeToEquirectangular ( )

inline

Get/Set the type of projection.

Equirectangular projection maps meridians to vertical straight lines and circles of latitude to horizontal straight lines. Azimuthal equidistant projection maps all points of the scene based on their distance to the view direction. This projection produces a fisheye effect. Default is Equirectangular.

Definition at line 86 of file vtkPanoramicProjectionPass.h.

void vtkPanoramicProjectionPass::SetProjectionTypeToAzimuthal ( )

inline

Get/Set the type of projection.

Equirectangular projection maps meridians to vertical straight lines and circles of latitude to horizontal straight lines. Azimuthal equidistant projection maps all points of the scene based on their distance to the view direction. This projection produces a fisheye effect. Default is Equirectangular.

Definition at line 87 of file vtkPanoramicProjectionPass.h.

virtual double vtkPanoramicProjectionPass::GetAngle ( )

virtual

Get/Set the vertical angle of projection.

180 degrees is a half sphere, 360 degrees is a full sphere, but any values in the range (90;360) can be set. Default is 180 degrees.

virtual void vtkPanoramicProjectionPass::SetAngle ( double )

virtual

Get/Set the vertical angle of projection.

180 degrees is a half sphere, 360 degrees is a full sphere, but any values in the range (90;360) can be set. Default is 180 degrees.