OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::PlaneOptimalShadowCameraSetup Class Reference

Implements the plane optimal shadow camera algorithm. More...

#include <OgreShadowCameraSetupPlaneOptimal.h>

+ Inheritance diagram for Ogre::PlaneOptimalShadowCameraSetup:
+ Collaboration diagram for Ogre::PlaneOptimalShadowCameraSetup:

Public Member Functions

 PlaneOptimalShadowCameraSetup (MovablePlane *plane)
 Constructor – requires a plane of interest. More...
 
virtual ~PlaneOptimalShadowCameraSetup ()
 Destructor. More...
 
Real getMaxDistance () const
 
Real getMinDistance () const
 
virtual void getShadowCamera (const SceneManager *sm, const Camera *cam, const Light *light, Camera *texCam, size_t iteration) const
 Returns shadow camera configured to get 1-1 homography between screen and shadow map when restricted to plane. More...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 

Protected Attributes

Real mMaxDistance
 
Real mMinDistance
 Defines the min & max frustum distance. TODO: put as output from getShadowCamera. More...
 

Private Member Functions

 PlaneOptimalShadowCameraSetup ()
 Default constructor is private. More...
 
Matrix4 computeConstrainedProjection (const Vector4 &pinhole, const vector< Vector4 >::type &fpoint, const vector< Vector2 >::type &constraint) const
 helper function computing projection matrix given constraints More...
 

Private Attributes

MovablePlanemPlane
 pointer to plane of interest More...
 

Detailed Description

Implements the plane optimal shadow camera algorithm.

Remarks
Given a plane of interest, it is possible to set up the shadow camera matrix such that the mapping between screen and shadow map is the identity (when restricted to pixels that view the plane of interest). Therefore, if the shadow map resolution matches the screen space resolution (of the seen planar receiver), we can get pixel perfect shadowing on the plane. Off the plane, the shadowing is not guaranteed to be perfect and will likely exhibit the usual sampling artifacts associated with shadow mapping.
Note
Important: this routine requires double-precision calculations. When you are running under Direct3D, you must ensure that you set the floating point mode to 'Consistent' rather than 'Fastest' to ensure this precision. This does allegedly come with some performance cost but when measuring it appears to be negligible in modern systems for normal usage.
Second important note: this projection also only works for lights with a finite position. Therefore you cannot use it for directional lights at this time.

Definition at line 62 of file OgreShadowCameraSetupPlaneOptimal.h.

Constructor & Destructor Documentation

Ogre::PlaneOptimalShadowCameraSetup::PlaneOptimalShadowCameraSetup ( )
inlineprivate

Default constructor is private.

Definition at line 67 of file OgreShadowCameraSetupPlaneOptimal.h.

Ogre::PlaneOptimalShadowCameraSetup::PlaneOptimalShadowCameraSetup ( MovablePlane plane)

Constructor – requires a plane of interest.

virtual Ogre::PlaneOptimalShadowCameraSetup::~PlaneOptimalShadowCameraSetup ( )
virtual

Destructor.

Member Function Documentation

Matrix4 Ogre::PlaneOptimalShadowCameraSetup::computeConstrainedProjection ( const Vector4 pinhole,
const vector< Vector4 >::type &  fpoint,
const vector< Vector2 >::type &  constraint 
) const
private

helper function computing projection matrix given constraints

Real Ogre::ShadowCameraSetup::getMaxDistance ( ) const
inlineinherited

Definition at line 82 of file OgreShadowCameraSetup.h.

Real Ogre::ShadowCameraSetup::getMinDistance ( ) const
inlineinherited

Definition at line 81 of file OgreShadowCameraSetup.h.

virtual void Ogre::PlaneOptimalShadowCameraSetup::getShadowCamera ( const SceneManager sm,
const Camera cam,
const Light light,
Camera texCam,
size_t  iteration 
) const
virtual

Returns shadow camera configured to get 1-1 homography between screen and shadow map when restricted to plane.

Implements Ogre::ShadowCameraSetup.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

Member Data Documentation

Real Ogre::ShadowCameraSetup::mMaxDistance
mutableprotectedinherited

Definition at line 71 of file OgreShadowCameraSetup.h.

Real Ogre::ShadowCameraSetup::mMinDistance
mutableprotectedinherited

Defines the min & max frustum distance. TODO: put as output from getShadowCamera.

Definition at line 70 of file OgreShadowCameraSetup.h.

MovablePlane* Ogre::PlaneOptimalShadowCameraSetup::mPlane
private

pointer to plane of interest

Definition at line 65 of file OgreShadowCameraSetupPlaneOptimal.h.


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