VTK  9.0.20200920
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPanoramicProjectionPass Class Reference

Render pass that render the scene in a cubemap and project these six renderings to a single quad. There are currently two different 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) More...

#include <vtkPanoramicProjectionPass.h>

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

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...
 
vtkPanoramicProjectionPassNewInstance () 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)
 
virtual int GetProjectionType ()
 Get/Set the type of projection. More...
 
virtual void SetProjectionType (int)
 
void SetProjectionTypeToEquirectangular ()
 
void SetProjectionTypeToAzimuthal ()
 
virtual double GetAngle ()
 Get/Set the vertical angle of projection. More...
 
virtual void SetAngle (double)
 
virtual bool GetInterpolate ()
 Get/Set the interpolation mode. More...
 
virtual void SetInterpolate (bool)
 
virtual void InterpolateOn ()
 
virtual void InterpolateOff ()
 
- Public Member Functions inherited from vtkImageProcessingPass
vtkImageProcessingPassNewInstance () const
 
virtual vtkRenderPassGetDelegatePass ()
 Delegate for rendering the image to be processed. More...
 
virtual void SetDelegatePass (vtkRenderPass *delegatePass)
 
- Public Member Functions inherited from vtkOpenGLRenderPass
vtkOpenGLRenderPassNewInstance () 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
vtkRenderPassNewInstance () 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...
 
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 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 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkPanoramicProjectionPassNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPanoramicProjectionPassSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImageProcessingPass
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageProcessingPassSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkOpenGLRenderPass
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenGLRenderPassSafeDownCast (vtkObjectBase *o)
 
static vtkInformationObjectBaseVectorKeyRenderPasses ()
 Key containing information about the current pass. More...
 
- Static Public Member Functions inherited from vtkRenderPass
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRenderPassSafeDownCast (vtkObjectBase *o)
 
- 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 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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () 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, 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkOpenGLFramebufferObjectFrameBufferObject = nullptr
 Graphics resources. More...
 
vtkTextureObjectCubeMapTexture = nullptr
 
vtkOpenGLQuadHelperQuadHelper = nullptr
 
unsigned int CubeResolution = 300
 
int ProjectionType = Equirectangular
 
double Angle = 180.0
 
bool Interpolate = false
 
- Protected Attributes inherited from vtkImageProcessingPass
vtkRenderPassDelegatePass
 
- 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
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

Render pass that render the scene in a cubemap and project these six renderings to a single quad. There are currently two different 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

◆ Superclass

Definition at line 44 of file vtkPanoramicProjectionPass.h.

Member Enumeration Documentation

◆ anonymous enum

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::vtkPanoramicProjectionPass ( )
protecteddefault

◆ ~vtkPanoramicProjectionPass()

vtkPanoramicProjectionPass::~vtkPanoramicProjectionPass ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkPanoramicProjectionPass* vtkPanoramicProjectionPass::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPanoramicProjectionPass::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImageProcessingPass.

◆ NewInstance()

vtkPanoramicProjectionPass* vtkPanoramicProjectionPass::NewInstance ( ) const

◆ PrintSelf()

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.

◆ Render()

void vtkPanoramicProjectionPass::Render ( const vtkRenderState s)
overridevirtual

Perform rendering according to a render state.

Implements vtkRenderPass.

◆ ReleaseGraphicsResources()

void vtkPanoramicProjectionPass::ReleaseGraphicsResources ( vtkWindow w)
overridevirtual

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

Reimplemented from vtkImageProcessingPass.

◆ GetCubeResolution()

virtual unsigned int vtkPanoramicProjectionPass::GetCubeResolution ( )
virtual

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

Default is 300.

◆ SetCubeResolution()

virtual void vtkPanoramicProjectionPass::SetCubeResolution ( unsigned int  )
virtual

◆ GetProjectionType()

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.

◆ SetProjectionType()

virtual void vtkPanoramicProjectionPass::SetProjectionType ( int  )
virtual

◆ SetProjectionTypeToEquirectangular()

void vtkPanoramicProjectionPass::SetProjectionTypeToEquirectangular ( )
inline

Definition at line 86 of file vtkPanoramicProjectionPass.h.

◆ SetProjectionTypeToAzimuthal()

void vtkPanoramicProjectionPass::SetProjectionTypeToAzimuthal ( )
inline

Definition at line 87 of file vtkPanoramicProjectionPass.h.

◆ GetAngle()

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.

◆ SetAngle()

virtual void vtkPanoramicProjectionPass::SetAngle ( double  )
virtual

◆ GetInterpolate()

virtual bool vtkPanoramicProjectionPass::GetInterpolate ( )
virtual

Get/Set the interpolation mode.

If true, the projection of the cubemap use hardware interpolation. Default is off.

◆ SetInterpolate()

virtual void vtkPanoramicProjectionPass::SetInterpolate ( bool  )
virtual

◆ InterpolateOn()

virtual void vtkPanoramicProjectionPass::InterpolateOn ( )
virtual

◆ InterpolateOff()

virtual void vtkPanoramicProjectionPass::InterpolateOff ( )
virtual

◆ RenderOnFace()

void vtkPanoramicProjectionPass::RenderOnFace ( const vtkRenderState s,
int  index 
)
protected

◆ Project()

void vtkPanoramicProjectionPass::Project ( vtkOpenGLRenderWindow renWin)
protected

◆ InitOpenGLResources()

void vtkPanoramicProjectionPass::InitOpenGLResources ( vtkOpenGLRenderWindow renWin)
protected

Member Data Documentation

◆ FrameBufferObject

vtkOpenGLFramebufferObject* vtkPanoramicProjectionPass::FrameBufferObject = nullptr
protected

Graphics resources.

Definition at line 125 of file vtkPanoramicProjectionPass.h.

◆ CubeMapTexture

vtkTextureObject* vtkPanoramicProjectionPass::CubeMapTexture = nullptr
protected

Definition at line 126 of file vtkPanoramicProjectionPass.h.

◆ QuadHelper

vtkOpenGLQuadHelper* vtkPanoramicProjectionPass::QuadHelper = nullptr
protected

Definition at line 127 of file vtkPanoramicProjectionPass.h.

◆ CubeResolution

unsigned int vtkPanoramicProjectionPass::CubeResolution = 300
protected

Definition at line 129 of file vtkPanoramicProjectionPass.h.

◆ ProjectionType

int vtkPanoramicProjectionPass::ProjectionType = Equirectangular
protected

Definition at line 130 of file vtkPanoramicProjectionPass.h.

◆ Angle

double vtkPanoramicProjectionPass::Angle = 180.0
protected

Definition at line 131 of file vtkPanoramicProjectionPass.h.

◆ Interpolate

bool vtkPanoramicProjectionPass::Interpolate = false
protected

Definition at line 132 of file vtkPanoramicProjectionPass.h.


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