OSG  3.4.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osgShadow::SoftShadowMap Class Reference

#include <SoftShadowMap.h>

Inheritance diagram for osgShadow::SoftShadowMap:
Inheritance graph
[legend]
Collaboration diagram for osgShadow::SoftShadowMap:
Collaboration graph
[legend]

Public Member Functions

 SoftShadowMap ()
 
 SoftShadowMap (const SoftShadowMap &es, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 
 META_Object (osgShadow, SoftShadowMap)
 
void setSoftnessWidth (float softnessWidth)
 
float getSoftnessWidth () const
 
void setJitteringScale (float jitteringScale)
 
float getJitteringScale () const
 
void setJitterTextureUnit (unsigned int jitterTextureUnit)
 
unsigned int getJitterTextureUnit () const
 
void setBias (float bias)
 
float getBias () const
 
- Public Member Functions inherited from osgShadow::ShadowMap
 ShadowMap ()
 
 ShadowMap (const ShadowMap &es, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 
 META_Object (osgShadow, ShadowMap)
 
void setTextureUnit (unsigned int unit)
 
unsigned int getTextureUnit () const
 
void setPolygonOffset (const osg::Vec2 &polyOffset)
 
const osg::Vec2getPolygonOffset () const
 
void setAmbientBias (const osg::Vec2 &ambientBias)
 
const osg::Vec2getAmbientBias () const
 
void setTextureSize (const osg::Vec2s &textureSize)
 
const osg::Vec2sgetTextureSize () const
 
void setLight (osg::Light *light)
 
void setLight (osg::LightSource *ls)
 
void addShader (osg::Shader *shader)
 
void clearShaderList ()
 
virtual void init ()
 
virtual void update (osg::NodeVisitor &nv)
 
virtual void cull (osgUtil::CullVisitor &cv)
 
virtual void cleanSceneGraph ()
 
osg::ref_ptr< osg::CameramakeDebugHUD ()
 
- Public Member Functions inherited from osgShadow::ShadowTechnique
 ShadowTechnique ()
 
 ShadowTechnique (const ShadowTechnique &es, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 
 META_Object (osgShadow, ShadowTechnique)
 
ShadowedScenegetShadowedScene ()
 
const ShadowedScenegetShadowedScene () const
 
virtual void traverse (osg::NodeVisitor &nv)
 
virtual void dirty ()
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const =0
 
virtual Objectclone (const CopyOp &) const =0
 
virtual bool isSameKindAs (const Object *) const
 
virtual const char * libraryName () const =0
 
virtual const char * className () const =0
 
std::string getCompoundClassName () const
 
virtual NodeasNode ()
 
virtual const NodeasNode () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
virtual StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () const
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
virtual void setName (const std::string &name)
 
void setName (const char *name)
 
const std::string & getName () const
 
void setDataVariance (DataVariance dv)
 
DataVariance getDataVariance () const
 
virtual void computeDataVariance ()
 
void setUserDataContainer (osg::UserDataContainer *udc)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
virtual ReferencedgetUserData ()
 
virtual const ReferencedgetUserData () const
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 
virtual void resizeGLObjectBuffers (unsigned int)
 
virtual void releaseGLObjects (osg::State *=0) const
 
template<typename T >
BoolValueObject
UCharValueObject
UShortValueObject
UIntValueObject
DoubleValueObject
Vec3fValueObject
Vec2dValueObject
Vec4dValueObject
PlaneValueObject
MatrixdValueObject
BoundingBoxdValueObject
BoundingSpheredValueObject
bool 
getUserValue (const std::string &name, T &value) const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::MutexgetRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSetgetObserverSet () const
 
ObserverSetgetOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 

Protected Member Functions

virtual ~SoftShadowMap (void)
 
void createUniforms ()
 
void createShaders ()
 
void initJittering (osg::StateSet *ss)
 
- Protected Member Functions inherited from osgShadow::ShadowMap
virtual ~ShadowMap (void)
 
- Protected Member Functions inherited from osgShadow::ShadowTechnique
osg::Vec3 computeOrthogonalVector (const osg::Vec3 &direction) const
 
virtual ~ShadowTechnique ()
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

osg::ref_ptr< osg::Uniform_softnessWidthUniform
 
osg::ref_ptr< osg::Uniform_jitteringScaleUniform
 
float _softnessWidth
 
float _jitteringScale
 
unsigned int _jitterTextureUnit
 
- Protected Attributes inherited from osgShadow::ShadowMap
osg::ref_ptr< osg::Camera_camera
 
osg::ref_ptr< osg::TexGen_texgen
 
osg::ref_ptr< osg::Texture2D_texture
 
osg::ref_ptr< osg::StateSet_stateset
 
osg::ref_ptr< osg::Program_program
 
osg::ref_ptr< osg::Light_light
 
osg::ref_ptr< osg::LightSource_ls
 
osg::ref_ptr< osg::Uniform_ambientBiasUniform
 
UniformList _uniformList
 
ShaderList _shaderList
 
unsigned int _baseTextureUnit
 
unsigned int _shadowTextureUnit
 
osg::Vec2 _polyOffset
 
osg::Vec2 _ambientBias
 
osg::Vec2s _textureSize
 
- Protected Attributes inherited from osgShadow::ShadowTechnique
ShadowedScene_shadowedScene
 
bool _dirty
 
- Protected Attributes inherited from osg::Object
std::string _name
 
DataVariance _dataVariance
 
osg::UserDataContainer_userDataContainer
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Additional Inherited Members

- Public Types inherited from osgShadow::ShadowMap
typedef std::vector
< osg::ref_ptr< osg::Uniform > > 
UniformList
 
typedef std::vector
< osg::ref_ptr< osg::Shader > > 
ShaderList
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 
static bool getThreadSafeReferenceCounting ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 

Detailed Description

SoftShadowMap provides an implementation of soft shadows with shadow maps.

Definition at line 27 of file SoftShadowMap.h.

Constructor & Destructor Documentation

osgShadow::SoftShadowMap::SoftShadowMap ( )
osgShadow::SoftShadowMap::SoftShadowMap ( const SoftShadowMap es,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)
virtual osgShadow::SoftShadowMap::~SoftShadowMap ( void  )
inlineprotectedvirtual

Definition at line 73 of file SoftShadowMap.h.

Member Function Documentation

void osgShadow::SoftShadowMap::createShaders ( )
protectedvirtual

Reimplemented from osgShadow::ShadowMap.

void osgShadow::SoftShadowMap::createUniforms ( )
protectedvirtual

Create the managed Uniforms

Reimplemented from osgShadow::ShadowMap.

float osgShadow::SoftShadowMap::getBias ( ) const
inline

Return the bias value

Definition at line 69 of file SoftShadowMap.h.

float osgShadow::SoftShadowMap::getJitteringScale ( ) const
inline

Get the value used for jittering scale in the shader.

Definition at line 52 of file SoftShadowMap.h.

unsigned int osgShadow::SoftShadowMap::getJitterTextureUnit ( ) const
inline

Get the texture unit that the jitter texture will be applied on.

Definition at line 58 of file SoftShadowMap.h.

float osgShadow::SoftShadowMap::getSoftnessWidth ( ) const
inline

Get the value used for width of the soft penumbra in the shader.

Definition at line 42 of file SoftShadowMap.h.

void osgShadow::SoftShadowMap::initJittering ( osg::StateSet ss)
protected
osgShadow::SoftShadowMap::META_Object ( osgShadow  ,
SoftShadowMap   
)
void osgShadow::SoftShadowMap::setBias ( float  bias)
inline

Add a small bias to the z-value, this can reduce shadow acne problem. This is the same as calling setPolygonOffset(osg::Vec2(bias,0)); Suitable values are 0-0.005 Default is 0.

Definition at line 66 of file SoftShadowMap.h.

void osgShadow::SoftShadowMap::setJitteringScale ( float  jitteringScale)

Set the values for jittering scale the shader will use. Zero is no jittering (i.e. see the banding in penumbra) High values (>64) cause 'pixelization' of the penumbra. Usually but not necessarily power of two number. Default is 32.

void osgShadow::SoftShadowMap::setJitterTextureUnit ( unsigned int  jitterTextureUnit)

Set the texture unit that the jitter texture will be applied on.

void osgShadow::SoftShadowMap::setSoftnessWidth ( float  softnessWidth)

Set the values for width of the soft penumbra the shader will use. Zero is for hard shadow (no penumbra). 0.01 is already very soft penumbra. Default is 0.005.

Member Data Documentation

float osgShadow::SoftShadowMap::_jitteringScale
protected

Definition at line 83 of file SoftShadowMap.h.

osg::ref_ptr<osg::Uniform> osgShadow::SoftShadowMap::_jitteringScaleUniform
protected

Definition at line 81 of file SoftShadowMap.h.

unsigned int osgShadow::SoftShadowMap::_jitterTextureUnit
protected

Definition at line 84 of file SoftShadowMap.h.

float osgShadow::SoftShadowMap::_softnessWidth
protected

Definition at line 82 of file SoftShadowMap.h.

osg::ref_ptr<osg::Uniform> osgShadow::SoftShadowMap::_softnessWidthUniform
protected

Definition at line 80 of file SoftShadowMap.h.


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