VTK  9.3.20240327
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkLightingMapPass Class Reference

TO DO. More...

#include <vtkLightingMapPass.h>

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

Public Types

typedef vtkDefaultPass Superclass
 
- Public Types inherited from vtkDefaultPass
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...
 
vtkLightingMapPassNewInstance () 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...
 
- Public Member Functions inherited from vtkDefaultPass
vtkDefaultPassNewInstance () const
 
- Public Member Functions inherited from vtkRenderPass
vtkRenderPassNewInstance () 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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. 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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (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...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- 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...
 
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...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkLightingMapPassNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkLightingMapPassSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyRENDER_LUMINANCE ()
 If this key exists on the PropertyKeys of a prop, the active scalar array on the prop will be rendered as its color. More...
 
static vtkInformationIntegerKeyRENDER_NORMALS ()
 if this key exists on the ProperyKeys of a prop, the active vector array on the prop will be rendered as its color. More...
 
- Static Public Member Functions inherited from vtkDefaultPass
static vtkDefaultPassNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDefaultPassSafeDownCast (vtkObjectBase *o)
 
- 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 (vtkTypeBool 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 vtkTypeBool 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 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
 
 vtkLightingMapPass ()
 Default constructor. More...
 
 ~vtkLightingMapPass () override
 Destructor. More...
 
void RenderOpaqueGeometry (const vtkRenderState *s) override
 Opaque pass with key checking. More...
 
- Protected Member Functions inherited from vtkDefaultPass
 vtkDefaultPass ()
 Default constructor. More...
 
 ~vtkDefaultPass () override
 Destructor. More...
 
virtual void RenderFilteredOpaqueGeometry (const vtkRenderState *s)
 Opaque pass with key checking. More...
 
virtual void RenderTranslucentPolygonalGeometry (const vtkRenderState *s)
 Translucent pass without key checking. More...
 
virtual void RenderFilteredTranslucentPolygonalGeometry (const vtkRenderState *s)
 Translucent pass with key checking. More...
 
virtual void RenderVolumetricGeometry (const vtkRenderState *s)
 Volume pass without key checking. More...
 
virtual void RenderFilteredVolumetricGeometry (const vtkRenderState *s)
 Translucent pass with key checking. More...
 
virtual void RenderOverlay (const vtkRenderState *s)
 Overlay pass without key checking. More...
 
virtual void RenderFilteredOverlay (const vtkRenderState *s)
 Overlay pass with key checking. 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 
enum  RenderMode { LUMINANCE , NORMALS }
 Set the type of lighting render to perform. More...
 
virtual void SetRenderType (RenderMode)
 Set the type of lighting render to perform. More...
 
virtual RenderMode GetRenderType ()
 Set the type of lighting render to perform. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Protected Attributes inherited from vtkRenderPass
int NumberOfRenderedProps
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

TO DO.

Renders lighting information directly instead of final shaded colors. The information keys allow the selection of either normal rendering or luminance. For normals, the (nx, ny, nz) tuple are rendered directly into the (r,g,b) fragment. For luminance, the diffuse and specular intensities are rendered into the red and green channels, respectively. The blue channel is zero. For both luminances and normals, the alpha channel is set to 1.0 if present.

See also
vtkRenderPass vtkDefaultPass
Tests:
vtkLightingMapPass (Tests)

Definition at line 31 of file vtkLightingMapPass.h.

Member Typedef Documentation

◆ Superclass

Definition at line 35 of file vtkLightingMapPass.h.

Member Enumeration Documentation

◆ RenderMode

Set the type of lighting render to perform.

Enumerator
LUMINANCE 
NORMALS 

Definition at line 42 of file vtkLightingMapPass.h.

Constructor & Destructor Documentation

◆ vtkLightingMapPass()

vtkLightingMapPass::vtkLightingMapPass ( )
protected

Default constructor.

◆ ~vtkLightingMapPass()

vtkLightingMapPass::~vtkLightingMapPass ( )
overrideprotected

Destructor.

Member Function Documentation

◆ New()

static vtkLightingMapPass* vtkLightingMapPass::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkLightingMapPass::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 vtkDefaultPass.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkLightingMapPass::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDefaultPass.

◆ NewInstance()

vtkLightingMapPass* vtkLightingMapPass::NewInstance ( ) const

◆ PrintSelf()

void vtkLightingMapPass::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 vtkDefaultPass.

◆ SetRenderType()

virtual void vtkLightingMapPass::SetRenderType ( RenderMode  )
virtual

Set the type of lighting render to perform.

◆ GetRenderType()

virtual RenderMode vtkLightingMapPass::GetRenderType ( )
virtual

Set the type of lighting render to perform.

◆ RENDER_LUMINANCE()

static vtkInformationIntegerKey* vtkLightingMapPass::RENDER_LUMINANCE ( )
static

If this key exists on the PropertyKeys of a prop, the active scalar array on the prop will be rendered as its color.

This key is mutually exclusive with the RENDER_LUMINANCE key.

◆ RENDER_NORMALS()

static vtkInformationIntegerKey* vtkLightingMapPass::RENDER_NORMALS ( )
static

if this key exists on the ProperyKeys of a prop, the active vector array on the prop will be rendered as its color.

This key is mutually exclusive with the RENDER_LUMINANCE key.

◆ Render()

void vtkLightingMapPass::Render ( const vtkRenderState s)
overridevirtual

Perform rendering according to a render state s.

Precondition
s_exists: s!=0

Reimplemented from vtkDefaultPass.

◆ RenderOpaqueGeometry()

void vtkLightingMapPass::RenderOpaqueGeometry ( const vtkRenderState s)
overrideprotectedvirtual

Opaque pass with key checking.

Precondition
s_exists: s!=0

Reimplemented from vtkDefaultPass.


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