#include <OgreShadowCameraSetupPSSM.h>
Public Types | |
typedef std::vector < Real > | SplitPointList |
typedef std::vector < Real > | OptimalAdjustFactorList |
Public Member Functions | |
PSSMShadowCameraSetup () | |
Constructor, defaults to 3 splits. | |
~PSSMShadowCameraSetup () | |
void | calculateSplitPoints (size_t splitCount, Real nearDist, Real farDist, Real lambda=0.95) |
Calculate a new splitting scheme. | |
void | setSplitPoints (const SplitPointList &newSplitPoints) |
Manually configure a new splitting scheme. | |
void | setOptimalAdjustFactor (size_t splitIndex, Real factor) |
Set the LiSPSM optimal adjust factor for a given split (call after configuring splits). | |
void | setSplitPadding (Real pad) |
Set the padding factor to apply to the near & far distances when matching up splits to one another, to avoid 'cracks'. | |
Real | getSplitPadding () const |
Get the padding factor to apply to the near & far distances when matching up splits to one another, to avoid 'cracks'. | |
size_t | getSplitCount () const |
Get the number of splits. | |
virtual void | getShadowCamera (const Ogre::SceneManager *sm, const Ogre::Camera *cam, const Ogre::Viewport *vp, const Ogre::Light *light, Ogre::Camera *texCam, size_t iteration) const |
Returns a LiSPSM shadow camera with PSSM splits base on iteration. | |
const SplitPointList & | getSplitPoints () const |
Returns the calculated split points. | |
Real | getOptimalAdjustFactor (size_t splitIndex) const |
Returns the optimal adjust factor for a given split. | |
Real | getOptimalAdjustFactor () const |
Overridden, recommended internal use only since depends on current iteration. | |
virtual void | setOptimalAdjustFactor (Real n) |
Adjusts the parameter n to produce optimal shadows. | |
virtual void | setUseSimpleOptimalAdjust (bool s) |
Sets whether or not to use a slightly simpler version of the camera near point derivation (default is true). | |
virtual bool | getUseSimpleOptimalAdjust () const |
Gets whether or not to use a slightly simpler version of the camera near point derivation (default is true). | |
void | setUseAggressiveFocusRegion (bool aggressive) |
Sets whether or not to use the more aggressive approach to deciding on the focus region or not. | |
bool | getUseAggressiveFocusRegion () const |
void * | operator new (size_t sz, const char *file, int line, const char *func) |
operator new, with debug line info | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *ptr) |
placement operator new | |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info | |
void * | operator new[] (size_t sz) |
void | operator delete (void *ptr) |
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 *) |
Protected Member Functions | |
Matrix4 | calculateLiSPSM (const Matrix4 &lightSpace, const PointListBody &bodyB, const PointListBody &bodyLVS, const SceneManager &sm, const Camera &cam, const Light &light) const |
Calculates the LiSPSM projection matrix P. | |
Real | calculateNOpt (const Matrix4 &lightSpace, const AxisAlignedBox &bodyBABB_ls, const PointListBody &bodyLVS, const Camera &cam) const |
Calculates the distance between camera position and near clipping plane. | |
Real | calculateNOptSimple (const PointListBody &bodyLVS, const Camera &cam) const |
Calculates a simpler version than the one above. | |
Vector3 | calculateZ0_ls (const Matrix4 &lightSpace, const Vector3 &e, Real bodyB_zMax_ls, const Camera &cam) const |
Calculates the visible point on the near plane for the n_opt calculation. | |
Matrix4 | buildFrustumProjection (Real left, Real right, Real bottom, Real top, Real near, Real far) const |
Builds a frustum matrix. | |
void | calculateShadowMappingMatrix (const SceneManager &sm, const Camera &cam, const Light &light, Matrix4 *out_view, Matrix4 *out_proj, Camera *out_cam) const |
Calculates the standard shadow mapping matrix. | |
void | calculateB (const SceneManager &sm, const Camera &cam, const Light &light, const AxisAlignedBox &sceneBB, PointListBody *out_bodyB) const |
Calculates the intersection bodyB. | |
void | calculateLVS (const SceneManager &sm, const Camera &cam, const Light &light, const AxisAlignedBox &sceneBB, PointListBody *out_LVS) const |
Calculates the bodyLVS. | |
Vector3 | getLSProjViewDir (const Matrix4 &lightSpace, const Camera &cam, const PointListBody &bodyLVS) const |
Returns the projection view direction. | |
Vector3 | getNearCameraPoint_ws (const Matrix4 &viewMatrix, const PointListBody &bodyLVS) const |
Returns a valid near-point seen by the camera. | |
Matrix4 | transformToUnitCube (const Matrix4 &m, const PointListBody &body) const |
Transforms a given body to the unit cube (-1,-1,-1) / (+1,+1,+1) with a specific shadow matrix enabled. | |
Matrix4 | buildViewMatrix (const Vector3 &pos, const Vector3 &dir, const Vector3 &up) const |
Builds a view matrix. | |
Protected Attributes | |
size_t | mSplitCount |
SplitPointList | mSplitPoints |
OptimalAdjustFactorList | mOptimalAdjustFactors |
Real | mSplitPadding |
size_t | mCurrentIteration |
Real | mOptAdjustFactor |
Warp factor adjustment. | |
bool | mUseSimpleNOpt |
Use simple nopt derivation? | |
Frustum * | mTempFrustum |
Temporary preallocated frustum to set up a projection matrix in calculateShadowMappingMatrix(). | |
Camera * | mLightFrustumCamera |
Temporary preallocated camera to set up a light frustum for clipping in calculateB. | |
bool | mLightFrustumCameraCalculated |
bool | mUseAggressiveRegion |
Use tighter focus region? | |
ConvexBody | mBodyB |
PointListBody | mPointListBodyB |
PointListBody | mPointListBodyLVS |
Static Protected Attributes | |
static const Matrix4 | msNormalToLightSpace |
Transform to or from light space as defined by Wimmer et al. | |
static const Matrix4 | msLightSpaceToNormal |
Definition at line 50 of file OgreShadowCameraSetupPSSM.h.
typedef std::vector<Real> Ogre::PSSMShadowCameraSetup::SplitPointList |
Definition at line 53 of file OgreShadowCameraSetupPSSM.h.
typedef std::vector<Real> Ogre::PSSMShadowCameraSetup::OptimalAdjustFactorList |
Definition at line 54 of file OgreShadowCameraSetupPSSM.h.
Ogre::PSSMShadowCameraSetup::PSSMShadowCameraSetup | ( | ) |
Constructor, defaults to 3 splits.
Ogre::PSSMShadowCameraSetup::~PSSMShadowCameraSetup | ( | ) |
void Ogre::PSSMShadowCameraSetup::calculateSplitPoints | ( | size_t | splitCount, | |
Real | nearDist, | |||
Real | farDist, | |||
Real | lambda = 0.95 | |||
) |
Calculate a new splitting scheme.
splitCount | The number of splits to use | |
nearDist | The near plane to use for the first split | |
farDist | The far plane to use for the last split | |
lambda | Factor to use to reduce the split size |
void Ogre::PSSMShadowCameraSetup::setSplitPoints | ( | const SplitPointList & | newSplitPoints | ) |
Manually configure a new splitting scheme.
newSplitPoints | A list which is splitCount + 1 entries long, containing the split points. The first value is the near point, the last value is the far point, and each value in between is both a far point of the previous split, and a near point for the next one. |
void Ogre::PSSMShadowCameraSetup::setOptimalAdjustFactor | ( | size_t | splitIndex, | |
Real | factor | |||
) |
Set the LiSPSM optimal adjust factor for a given split (call after configuring splits).
void Ogre::PSSMShadowCameraSetup::setSplitPadding | ( | Real | pad | ) |
Set the padding factor to apply to the near & far distances when matching up splits to one another, to avoid 'cracks'.
Definition at line 93 of file OgreShadowCameraSetupPSSM.h.
Real Ogre::PSSMShadowCameraSetup::getSplitPadding | ( | ) | const |
Get the padding factor to apply to the near & far distances when matching up splits to one another, to avoid 'cracks'.
Definition at line 98 of file OgreShadowCameraSetupPSSM.h.
size_t Ogre::PSSMShadowCameraSetup::getSplitCount | ( | ) | const |
virtual void Ogre::PSSMShadowCameraSetup::getShadowCamera | ( | const Ogre::SceneManager * | sm, | |
const Ogre::Camera * | cam, | |||
const Ogre::Viewport * | vp, | |||
const Ogre::Light * | light, | |||
Ogre::Camera * | texCam, | |||
size_t | iteration | |||
) | const [virtual] |
Returns a LiSPSM shadow camera with PSSM splits base on iteration.
Reimplemented from Ogre::LiSPSMShadowCameraSetup.
const SplitPointList& Ogre::PSSMShadowCameraSetup::getSplitPoints | ( | ) | const |
Real Ogre::PSSMShadowCameraSetup::getOptimalAdjustFactor | ( | size_t | splitIndex | ) | const |
Returns the optimal adjust factor for a given split.
Definition at line 111 of file OgreShadowCameraSetupPSSM.h.
Real Ogre::PSSMShadowCameraSetup::getOptimalAdjustFactor | ( | ) | const [virtual] |
Overridden, recommended internal use only since depends on current iteration.
Reimplemented from Ogre::LiSPSMShadowCameraSetup.
Matrix4 Ogre::LiSPSMShadowCameraSetup::calculateLiSPSM | ( | const Matrix4 & | lightSpace, | |
const PointListBody & | bodyB, | |||
const PointListBody & | bodyLVS, | |||
const SceneManager & | sm, | |||
const Camera & | cam, | |||
const Light & | light | |||
) | const [protected, inherited] |
Calculates the LiSPSM projection matrix P.
lightSpace,: | matrix of the light space transformation | |
bodyB,: | intersection body B | |
bodyLVS,: | intersection body LVS (relevant space in front of the camera) | |
sm,: | scene manager | |
cam,: | currently active camera | |
light,: | currently active light |
Real Ogre::LiSPSMShadowCameraSetup::calculateNOpt | ( | const Matrix4 & | lightSpace, | |
const AxisAlignedBox & | bodyBABB_ls, | |||
const PointListBody & | bodyLVS, | |||
const Camera & | cam | |||
) | const [protected, inherited] |
Calculates the distance between camera position and near clipping plane.
Parameters: d: distance between the near and the far clipping plane z0: located on the near clipping plane of the intersection body b z1: located on the far clipping plane with the same x/y values as z0
lightSpace,: | matrix of the light space transformation | |
bodyBABB_ls,: | bounding box of the tranformed (light space) bodyB | |
bodyLVS,: | point list of the bodyLVS which describes the scene space which is in front of the light and the camera | |
cam,: | currently active camera |
Real Ogre::LiSPSMShadowCameraSetup::calculateNOptSimple | ( | const PointListBody & | bodyLVS, | |
const Camera & | cam | |||
) | const [protected, inherited] |
Calculates a simpler version than the one above.
Vector3 Ogre::LiSPSMShadowCameraSetup::calculateZ0_ls | ( | const Matrix4 & | lightSpace, | |
const Vector3 & | e, | |||
Real | bodyB_zMax_ls, | |||
const Camera & | cam | |||
) | const [protected, inherited] |
Calculates the visible point on the near plane for the n_opt calculation.
lightSpace,: | matrix of the light space transformation | |
e,: | the LiSPSM parameter e is located near or on the near clipping plane of the LiSPSM frustum C | |
bodyB_zMax_ls,: | maximum z-value of the light space bodyB bounding box | |
cam,: | currently active camera |
Matrix4 Ogre::LiSPSMShadowCameraSetup::buildFrustumProjection | ( | Real | left, | |
Real | right, | |||
Real | bottom, | |||
Real | top, | |||
Real | near, | |||
Real | far | |||
) | const [protected, inherited] |
Builds a frustum matrix.
virtual void Ogre::LiSPSMShadowCameraSetup::setOptimalAdjustFactor | ( | Real | n | ) | [virtual, inherited] |
Adjusts the parameter n to produce optimal shadows.
n | The adjustment factor - default is 0.1f. |
Definition at line 207 of file OgreShadowCameraSetupLiSPSM.h.
virtual void Ogre::LiSPSMShadowCameraSetup::setUseSimpleOptimalAdjust | ( | bool | s | ) | [virtual, inherited] |
Sets whether or not to use a slightly simpler version of the camera near point derivation (default is true).
Definition at line 215 of file OgreShadowCameraSetupLiSPSM.h.
virtual bool Ogre::LiSPSMShadowCameraSetup::getUseSimpleOptimalAdjust | ( | ) | const [virtual, inherited] |
Gets whether or not to use a slightly simpler version of the camera near point derivation (default is true).
Definition at line 219 of file OgreShadowCameraSetupLiSPSM.h.
void Ogre::FocusedShadowCameraSetup::calculateShadowMappingMatrix | ( | const SceneManager & | sm, | |
const Camera & | cam, | |||
const Light & | light, | |||
Matrix4 * | out_view, | |||
Matrix4 * | out_proj, | |||
Camera * | out_cam | |||
) | const [protected, inherited] |
Calculates the standard shadow mapping matrix.
sm,: | scene manager | |
cam,: | currently active camera | |
light,: | currently active light | |
out_view,: | calculated uniform view shadow mapping matrix (may be NULL) | |
out_proj,: | calculated uniform projection shadow mapping matrix (may be NULL) | |
out_cam,: | calculated uniform shadow camera (may be NULL) |
void Ogre::FocusedShadowCameraSetup::calculateB | ( | const SceneManager & | sm, | |
const Camera & | cam, | |||
const Light & | light, | |||
const AxisAlignedBox & | sceneBB, | |||
PointListBody * | out_bodyB | |||
) | const [protected, inherited] |
Calculates the intersection bodyB.
sm,: | scene manager | |
cam,: | currently active camera | |
light,: | currently active light | |
sceneBB,: | scene bounding box for clipping operations | |
out_bodyB,: | final intersection bodyB point list |
void Ogre::FocusedShadowCameraSetup::calculateLVS | ( | const SceneManager & | sm, | |
const Camera & | cam, | |||
const Light & | light, | |||
const AxisAlignedBox & | sceneBB, | |||
PointListBody * | out_LVS | |||
) | const [protected, inherited] |
Calculates the bodyLVS.
scene,: | holds all potential occluders / receivers as one single bounding box of the currently active scene node | |
cam,: | current viewer camera | |
light,: | current light | |
out_LVS,: | intersection body LVS (world coordinates) |
Vector3 Ogre::FocusedShadowCameraSetup::getLSProjViewDir | ( | const Matrix4 & | lightSpace, | |
const Camera & | cam, | |||
const PointListBody & | bodyLVS | |||
) | const [protected, inherited] |
Returns the projection view direction.
lightSpace,: | matrix of the light space transformation | |
cam,: | current viewer camera | |
bodyLVS,: | intersection body LVS (relevant space in front of the camera) |
Vector3 Ogre::FocusedShadowCameraSetup::getNearCameraPoint_ws | ( | const Matrix4 & | viewMatrix, | |
const PointListBody & | bodyLVS | |||
) | const [protected, inherited] |
Returns a valid near-point seen by the camera.
viewMatrix,: | view matrix of the current camera | |
bodyLVS,: | intersection body LVS (relevant space in front of the camera) |
Matrix4 Ogre::FocusedShadowCameraSetup::transformToUnitCube | ( | const Matrix4 & | m, | |
const PointListBody & | body | |||
) | const [protected, inherited] |
Transforms a given body to the unit cube (-1,-1,-1) / (+1,+1,+1) with a specific shadow matrix enabled.
m,: | transformation matrix applied on the point list body | |
body,: | contains the points of the extends of all valid scene elements which are mapped to the unit cube |
Matrix4 Ogre::FocusedShadowCameraSetup::buildViewMatrix | ( | const Vector3 & | pos, | |
const Vector3 & | dir, | |||
const Vector3 & | up | |||
) | const [protected, inherited] |
Builds a view matrix.
void Ogre::FocusedShadowCameraSetup::setUseAggressiveFocusRegion | ( | bool | aggressive | ) | [inherited] |
Sets whether or not to use the more aggressive approach to deciding on the focus region or not.
aggressive | True to use the more aggressive approach, false otherwise. |
Definition at line 272 of file OgreShadowCameraSetupFocused.h.
bool Ogre::FocusedShadowCameraSetup::getUseAggressiveFocusRegion | ( | ) | const [inherited] |
Definition at line 274 of file OgreShadowCameraSetupFocused.h.
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, | |
const char * | file, | |||
int | line, | |||
const char * | func | |||
) | [inherited] |
operator new, with debug line info
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, | |
void * | ptr | |||
) | [inherited] |
placement operator new
void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz, | |
const char * | file, | |||
int | line, | |||
const char * | func | |||
) | [inherited] |
array operator new, with debug line info
void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) | [inherited] |
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) | [inherited] |
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, | |
const char * | , | |||
int | , | |||
const char * | ||||
) | [inherited] |
void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) | [inherited] |
void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr, | |
const char * | , | |||
int | , | |||
const char * | ||||
) | [inherited] |
size_t Ogre::PSSMShadowCameraSetup::mSplitCount [protected] |
Definition at line 57 of file OgreShadowCameraSetupPSSM.h.
Definition at line 58 of file OgreShadowCameraSetupPSSM.h.
Definition at line 59 of file OgreShadowCameraSetupPSSM.h.
Real Ogre::PSSMShadowCameraSetup::mSplitPadding [protected] |
Definition at line 60 of file OgreShadowCameraSetupPSSM.h.
size_t Ogre::PSSMShadowCameraSetup::mCurrentIteration [mutable, protected] |
Definition at line 62 of file OgreShadowCameraSetupPSSM.h.
Real Ogre::LiSPSMShadowCameraSetup::mOptAdjustFactor [protected, inherited] |
bool Ogre::LiSPSMShadowCameraSetup::mUseSimpleNOpt [protected, inherited] |
const Matrix4 Ogre::FocusedShadowCameraSetup::msNormalToLightSpace [static, protected, inherited] |
Transform to or from light space as defined by Wimmer et al.
Definition at line 62 of file OgreShadowCameraSetupFocused.h.
const Matrix4 Ogre::FocusedShadowCameraSetup::msLightSpaceToNormal [static, protected, inherited] |
Definition at line 63 of file OgreShadowCameraSetupFocused.h.
Frustum* Ogre::FocusedShadowCameraSetup::mTempFrustum [protected, inherited] |
Temporary preallocated frustum to set up a projection matrix in calculateShadowMappingMatrix().
Definition at line 68 of file OgreShadowCameraSetupFocused.h.
Camera* Ogre::FocusedShadowCameraSetup::mLightFrustumCamera [protected, inherited] |
Temporary preallocated camera to set up a light frustum for clipping in calculateB.
Definition at line 72 of file OgreShadowCameraSetupFocused.h.
bool Ogre::FocusedShadowCameraSetup::mLightFrustumCameraCalculated [mutable, protected, inherited] |
Definition at line 73 of file OgreShadowCameraSetupFocused.h.
bool Ogre::FocusedShadowCameraSetup::mUseAggressiveRegion [protected, inherited] |
ConvexBody Ogre::FocusedShadowCameraSetup::mBodyB [mutable, protected, inherited] |
Definition at line 139 of file OgreShadowCameraSetupFocused.h.
PointListBody Ogre::FocusedShadowCameraSetup::mPointListBodyB [mutable, protected, inherited] |
Definition at line 140 of file OgreShadowCameraSetupFocused.h.
PointListBody Ogre::FocusedShadowCameraSetup::mPointListBodyLVS [mutable, protected, inherited] |
Definition at line 141 of file OgreShadowCameraSetupFocused.h.
Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Thu Aug 28 21:01:31 2008