VTK  9.0.20201021
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkRenderPass Class Referenceabstract

Perform part of the rendering of a vtkRenderer. More...

#include <vtkRenderPass.h>

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

Public Types

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...
 
vtkRenderPassNewInstance () 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 int GetNumberOfRenderedProps ()
 Number of props rendered at the last Render call. More...
 
virtual void ReleaseGraphicsResources (vtkWindow *w)
 Release graphics resources and ask components to release their own resources. 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 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
 
 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

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

Perform part of the rendering of a vtkRenderer.

vtkRenderPass is a deferred class with a simple deferred method Render. This method performs a rendering pass of the scene described in vtkRenderState. Subclasses define what really happens during rendering.

Directions to write a subclass of vtkRenderPass: It is up to the subclass to decide if it needs to delegate part of its job to some other vtkRenderPass objects ("delegates").

Definition at line 56 of file vtkRenderPass.h.

Member Typedef Documentation

◆ Superclass

Definition at line 59 of file vtkRenderPass.h.

Constructor & Destructor Documentation

◆ vtkRenderPass()

vtkRenderPass::vtkRenderPass ( )
protected

Default constructor.

Do nothing.

◆ ~vtkRenderPass()

vtkRenderPass::~vtkRenderPass ( )
overrideprotected

Destructor.

Do nothing.

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkRenderPass::IsA ( const char *  name)
virtual

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkRenderPass::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkRenderPass* vtkRenderPass::NewInstance ( ) const

◆ PrintSelf()

void vtkRenderPass::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

◆ Render()

virtual void vtkRenderPass::Render ( const vtkRenderState s)
pure virtual

◆ GetNumberOfRenderedProps()

virtual int vtkRenderPass::GetNumberOfRenderedProps ( )
virtual

Number of props rendered at the last Render call.

◆ ReleaseGraphicsResources()

virtual void vtkRenderPass::ReleaseGraphicsResources ( vtkWindow w)
virtual

◆ UpdateCamera()

void vtkRenderPass::UpdateCamera ( vtkRenderer renderer)
protected

Call UpdateCamera() on Renderer.

This ugly mechanism gives access to a protected method of Renderer to subclasses of vtkRenderPass.

Precondition
renderer_exists: renderer!=0

◆ ClearLights()

void vtkRenderPass::ClearLights ( vtkRenderer renderer)
protected

Call ClearLights() on Renderer.

See note about UpdateCamera().

Precondition
renderer_exists: renderer!=0

◆ UpdateLightGeometry()

void vtkRenderPass::UpdateLightGeometry ( vtkRenderer renderer)
protected

Call UpdateLightGeometry() on Renderer.

See note about UpdateCamera().

Precondition
renderer_exists: renderer!=0

◆ UpdateLights()

void vtkRenderPass::UpdateLights ( vtkRenderer renderer)
protected

Call UpdateLights() on Renderer.

See note about UpdateCamera().

Precondition
renderer_exists: renderer!=0

◆ UpdateGeometry()

void vtkRenderPass::UpdateGeometry ( vtkRenderer renderer,
vtkFrameBufferObjectBase fbo = nullptr 
)
protected

Call UpdateGeometry() on Renderer.

See note about UpdateCamera().

Precondition
renderer_exists: renderer!=0

◆ SetLastRenderingUsedDepthPeeling()

void vtkRenderPass::SetLastRenderingUsedDepthPeeling ( vtkRenderer renderer,
bool  value 
)
protected

Modify protected member LastRenderingUsedDepthPeeling on Renderer.

See note about UpdateCamera().

Precondition
renderer_exists: renderer!=0 Note - OpenGL1 specific, remove when completely switched to OpenGL2

Member Data Documentation

◆ NumberOfRenderedProps

int vtkRenderPass::NumberOfRenderedProps
protected

Definition at line 133 of file vtkRenderPass.h.


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