VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkShadowMapBakerPass Class Reference

Implement a builder of shadow map pass. More...

#include <vtkShadowMapBakerPass.h>

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

List of all members.

Public Types

typedef vtkRenderPass Superclass
- Public Types inherited from vtkRenderPass
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void ReleaseGraphicsResources (vtkWindow *w)
bool GetHasShadows ()
bool LightCreatesShadow (vtkLight *l)
vtkShadowMapBakerPassTexturesGetShadowMaps ()
bool GetNeedUpdate ()
void SetUpToDate ()
virtual void Render (const vtkRenderState *s)
virtual vtkRenderPassGetOpaquePass ()
virtual void SetOpaquePass (vtkRenderPass *opaquePass)
virtual vtkRenderPassGetCompositeZPass ()
virtual void SetCompositeZPass (vtkRenderPass *compositeZPass)
virtual void SetResolution (unsigned int)
virtual unsigned int GetResolution ()
virtual void SetPolygonOffsetFactor (float)
virtual float GetPolygonOffsetFactor ()
virtual void SetPolygonOffsetUnits (float)
virtual float GetPolygonOffsetUnits ()
vtkShadowMapBakerPassLightCamerasGetLightCameras ()
- Public Member Functions inherited from vtkRenderPass
virtual int GetNumberOfRenderedProps ()
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
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 *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
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
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkShadowMapBakerPassNew ()
static int IsTypeOf (const char *type)
static vtkShadowMapBakerPassSafeDownCast (vtkObject *o)
static vtkInformationIntegerKeyOCCLUDER ()
static vtkInformationIntegerKeyRECEIVER ()

Protected Member Functions

 vtkShadowMapBakerPass ()
virtual ~vtkShadowMapBakerPass ()
void CheckSupport (vtkOpenGLRenderWindow *w)
void PointNearFar (double *v, double *pt, double *dir, double &mNear, double &mFar, bool initialized)
void BoxNearFar (double *bb, double *pt, double *dir, double &mNear, double &mFar)
void BuildCameraLight (vtkLight *light, double *boundingBox, vtkCamera *lcamera)
- Protected Member Functions inherited from vtkRenderPass
 vtkRenderPass ()
virtual ~vtkRenderPass ()
void UpdateCamera (vtkRenderer *renderer)
void ClearLights (vtkRenderer *renderer)
void UpdateLightGeometry (vtkRenderer *renderer)
void UpdateLights (vtkRenderer *renderer)
void UpdateGeometry (vtkRenderer *renderer)
void SetLastRenderingUsedDepthPeeling (vtkRenderer *renderer, bool value)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkRenderPassOpaquePass
vtkRenderPassCompositeZPass
unsigned int Resolution
float PolygonOffsetFactor
float PolygonOffsetUnits
bool HasShadows
vtkFrameBufferObjectFrameBufferObject
vtkShadowMapBakerPassTexturesShadowMaps
vtkShadowMapBakerPassLightCamerasLightCameras
vtkTimeStamp LastRenderTime
bool NeedUpdate
- Protected Attributes inherited from vtkRenderPass
int NumberOfRenderedProps
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

Detailed Description

Implement a builder of shadow map pass.

Bake a list of shadow maps, once per spot light. It work in conjunction with the vtkShadowMapPass, which uses the shadow maps for rendering the opaque geometry (a technique to render hard shadows in hardware).

This pass expects an initialized depth buffer and color buffer. Initialized buffers means they have been cleared with farest z-value and background color/gradient/transparent color. An opaque pass may have been performed right after the initialization.

Its delegate is usually set to a vtkOpaquePass.

Implementation:
The first pass of the algorithm is to generate a shadow map per light (depth map from the light point of view) by rendering the opaque objects with the vtkShadowMapBakerPass::OCCLUDER property keys. The second pass is to render the opaque objects with the vtkShadowMap::RECEIVER keys.
See also:
vtkRenderPass, vtkOpaquePass, vtkShadowMapPass
Tests:
vtkShadowMapBakerPass (Tests)

Definition at line 58 of file vtkShadowMapBakerPass.h.


Member Typedef Documentation

Reimplemented from vtkRenderPass.

Definition at line 62 of file vtkShadowMapBakerPass.h.


Constructor & Destructor Documentation

vtkShadowMapBakerPass::vtkShadowMapBakerPass ( )
protected

Default constructor. DelegatetPass is set to NULL.

virtual vtkShadowMapBakerPass::~vtkShadowMapBakerPass ( )
protectedvirtual

Destructor.


Member Function Documentation

static vtkShadowMapBakerPass* vtkShadowMapBakerPass::New ( )
static

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkShadowMapBakerPass::GetClassName ( )
virtual

Reimplemented from vtkRenderPass.

static int vtkShadowMapBakerPass::IsTypeOf ( const char *  name)
static

Return 1 if this class type 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.

virtual int vtkShadowMapBakerPass::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 vtkShadowMapBakerPass* vtkShadowMapBakerPass::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkRenderPass.

void vtkShadowMapBakerPass::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

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.

static vtkInformationIntegerKey* vtkShadowMapBakerPass::OCCLUDER ( )
static

If this key exists on the PropertyKeys of a prop, the prop is viewed as a light occluder (ie it casts shadows). This key is not mutually exclusive with the RECEIVER() key.

static vtkInformationIntegerKey* vtkShadowMapBakerPass::RECEIVER ( )
static
virtual void vtkShadowMapBakerPass::Render ( const vtkRenderState s)
virtual

Perform rendering according to a render state s.

Precondition:
s_exists: s!=0

Implements vtkRenderPass.

void vtkShadowMapBakerPass::ReleaseGraphicsResources ( vtkWindow w)
virtual

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

Precondition:
w_exists: w!=0

Reimplemented from vtkRenderPass.

virtual vtkRenderPass* vtkShadowMapBakerPass::GetOpaquePass ( )
virtual

Delegate for rendering the opaque polygonal geometry. If it is NULL, nothing will be rendered and a warning will be emitted. It is usually set to a vtkCameraPass with a sequence of vtkLightPass/vtkOpaquePass. Initial value is a NULL pointer.

virtual void vtkShadowMapBakerPass::SetOpaquePass ( vtkRenderPass opaquePass)
virtual

Delegate for rendering the opaque polygonal geometry. If it is NULL, nothing will be rendered and a warning will be emitted. It is usually set to a vtkCameraPass with a sequence of vtkLightPass/vtkOpaquePass. Initial value is a NULL pointer.

virtual vtkRenderPass* vtkShadowMapBakerPass::GetCompositeZPass ( )
virtual

Delegate for compositing of the shadow maps accross processors. If it is NULL, there is no z compositing. It is usually set to a vtkCompositeZPass (Parallel package). Initial value is a NULL pointer.

virtual void vtkShadowMapBakerPass::SetCompositeZPass ( vtkRenderPass compositeZPass)
virtual

Delegate for compositing of the shadow maps accross processors. If it is NULL, there is no z compositing. It is usually set to a vtkCompositeZPass (Parallel package). Initial value is a NULL pointer.

virtual void vtkShadowMapBakerPass::SetResolution ( unsigned  int)
virtual

Set/Get the number of pixels in each dimension of the shadow maps (shadow maps are square). Initial value is 256. The greater the better. Resolution does not have to be a power-of-two value.

virtual unsigned int vtkShadowMapBakerPass::GetResolution ( )
virtual

Set/Get the number of pixels in each dimension of the shadow maps (shadow maps are square). Initial value is 256. The greater the better. Resolution does not have to be a power-of-two value.

virtual void vtkShadowMapBakerPass::SetPolygonOffsetFactor ( float  )
virtual

Factor used to scale the maximum depth slope of a polygon (definition from OpenGL 2.1 spec section 3.5.5 "Depth Offset" page 112). This is used during the creation the shadow maps (not during mapping of the shadow maps onto the geometry) Play with this value and PolygonOffsetUnits to solve self-shadowing. Valid values can be either positive or negative. Initial value is 1.1f (recommended by the nVidia presentation about Shadow Mapping by Cass Everitt). 3.1f works well with the regression test.

virtual float vtkShadowMapBakerPass::GetPolygonOffsetFactor ( )
virtual

Factor used to scale the maximum depth slope of a polygon (definition from OpenGL 2.1 spec section 3.5.5 "Depth Offset" page 112). This is used during the creation the shadow maps (not during mapping of the shadow maps onto the geometry) Play with this value and PolygonOffsetUnits to solve self-shadowing. Valid values can be either positive or negative. Initial value is 1.1f (recommended by the nVidia presentation about Shadow Mapping by Cass Everitt). 3.1f works well with the regression test.

virtual void vtkShadowMapBakerPass::SetPolygonOffsetUnits ( float  )
virtual

Factor used to scale an implementation dependent constant that relates to the usable resolution of the depth buffer (definition from OpenGL 2.1 spec section 3.5.5 "Depth Offset" page 112). This is used during the creation the shadow maps (not during mapping of the shadow maps onto the geometry) Play with this value and PolygonOffsetFactor to solve self-shadowing. Valid values can be either positive or negative. Initial value is 4.0f (recommended by the nVidia presentation about Shadow Mapping by Cass Everitt). 10.0f works well with the regression test.

virtual float vtkShadowMapBakerPass::GetPolygonOffsetUnits ( )
virtual

Factor used to scale an implementation dependent constant that relates to the usable resolution of the depth buffer (definition from OpenGL 2.1 spec section 3.5.5 "Depth Offset" page 112). This is used during the creation the shadow maps (not during mapping of the shadow maps onto the geometry) Play with this value and PolygonOffsetFactor to solve self-shadowing. Valid values can be either positive or negative. Initial value is 4.0f (recommended by the nVidia presentation about Shadow Mapping by Cass Everitt). 10.0f works well with the regression test.

bool vtkShadowMapBakerPass::GetHasShadows ( )

INTERNAL USE ONLY. Internally used by vtkShadowMapBakerPass and vtkShadowMapPass. Tell if there is at least one shadow. Initial value is false.

bool vtkShadowMapBakerPass::LightCreatesShadow ( vtkLight l)

INTERNAL USE ONLY. Internally used by vtkShadowMapBakerPass and vtkShadowMapPass. Tell if the light `l' can create shadows. The light has to not be a head light and to be directional or positional with an angle less than 180 degrees.

Precondition:
l_exists: l!=0
vtkShadowMapBakerPassTextures* vtkShadowMapBakerPass::GetShadowMaps ( )

INTERNAL USE ONLY Internally used by vtkShadowMapBakerPass and vtkShadowMapPass. Give access to the baked shadow maps.

vtkShadowMapBakerPassLightCameras* vtkShadowMapBakerPass::GetLightCameras ( )

INTERNAL USE ONLY. Internally used by vtkShadowMapBakerPass and vtkShadowMapPass. Give access the cameras builds from the ligths.

bool vtkShadowMapBakerPass::GetNeedUpdate ( )

INTERNAL USE ONLY. Internally used by vtkShadowMapBakerPass and vtkShadowMapPass. Do the shadows need to be updated? Value changed by vtkShadowMapBakerPass and used by vtkShadowMapPass. Initial value is true.

void vtkShadowMapBakerPass::SetUpToDate ( )
void vtkShadowMapBakerPass::PointNearFar ( double *  v,
double *  pt,
double *  dir,
double &  mNear,
double &  mFar,
bool  initialized 
)
protected

Helper method to compute the mNearest point in a given direction. To be called several times, with initialized = false the first time. v: point pt: origin of the direction dir: direction

void vtkShadowMapBakerPass::BoxNearFar ( double *  bb,
double *  pt,
double *  dir,
double &  mNear,
double &  mFar 
)
protected

Compute the min/max of the projection of a box in a given direction. bb: bounding box pt: origin of the direction dir: direction

void vtkShadowMapBakerPass::BuildCameraLight ( vtkLight light,
double *  boundingBox,
vtkCamera lcamera 
)
protected

Build a camera from spot light parameters.

Precondition:
light_exists: light!=0
lcamera_exists: lcamera!=0
void vtkShadowMapBakerPass::CheckSupport ( vtkOpenGLRenderWindow w)
protected

Check if shadow mapping is supported by the current OpenGL context.

Precondition:
w_exists: w!=0

Member Data Documentation

vtkRenderPass* vtkShadowMapBakerPass::OpaquePass
protected

Definition at line 219 of file vtkShadowMapBakerPass.h.

vtkRenderPass* vtkShadowMapBakerPass::CompositeZPass
protected

Definition at line 221 of file vtkShadowMapBakerPass.h.

unsigned int vtkShadowMapBakerPass::Resolution
protected

Definition at line 223 of file vtkShadowMapBakerPass.h.

float vtkShadowMapBakerPass::PolygonOffsetFactor
protected

Definition at line 225 of file vtkShadowMapBakerPass.h.

float vtkShadowMapBakerPass::PolygonOffsetUnits
protected

Definition at line 226 of file vtkShadowMapBakerPass.h.

bool vtkShadowMapBakerPass::HasShadows
protected

Definition at line 228 of file vtkShadowMapBakerPass.h.

vtkFrameBufferObject* vtkShadowMapBakerPass::FrameBufferObject
protected

Graphics resources.

Definition at line 231 of file vtkShadowMapBakerPass.h.

vtkShadowMapBakerPassTextures* vtkShadowMapBakerPass::ShadowMaps
protected

Definition at line 233 of file vtkShadowMapBakerPass.h.

vtkShadowMapBakerPassLightCameras* vtkShadowMapBakerPass::LightCameras
protected

Definition at line 234 of file vtkShadowMapBakerPass.h.

vtkTimeStamp vtkShadowMapBakerPass::LastRenderTime
protected

Definition at line 237 of file vtkShadowMapBakerPass.h.

bool vtkShadowMapBakerPass::NeedUpdate
protected

Definition at line 238 of file vtkShadowMapBakerPass.h.


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