OpenSceneGraph
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osgShadow::ShadowMap Class Reference

ShadowedTexture provides an implementation of shadow textures. More...

Inheritance diagram for osgShadow::ShadowMap:
Inheritance graph
[legend]

Public Types

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 }
 

Public Member Functions

 ShadowMap ()
 
 ShadowMap (const ShadowMap &es, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 
 META_Object (osgShadow, ShadowMap)
 
void setTextureUnit (unsigned int unit)
 Set the texture unit that the shadow texture will be applied on. More...
 
unsigned int getTextureUnit () const
 Get the texture unit that the shadow texture will be applied on. More...
 
void setPolygonOffset (const osg::Vec2 &polyOffset)
 set the polygon offset used initially More...
 
const osg::Vec2getPolygonOffset () const
 get the used polygon offset More...
 
void setAmbientBias (const osg::Vec2 &ambientBias)
 Set the values for the ambient bias the shader will use. More...
 
const osg::Vec2getAmbientBias () const
 Get the values that are used for the ambient bias in the shader. More...
 
void setTextureSize (const osg::Vec2s &textureSize)
 set the size in pixels x / y for the shadow texture. More...
 
const osg::Vec2sgetTextureSize () const
 Get the values that are used for the ambient bias in the shader. More...
 
void setLight (osg::Light *light)
 Set the Light that will cast shadows. More...
 
void setLight (osg::LightSource *ls)
 
void addShader (osg::Shader *shader)
 Add a shader to internal list, will be used instead of the default ones. More...
 
template<class T >
void addShader (const osg::ref_ptr< T > &shader)
 
void clearShaderList ()
 Reset internal shader list. More...
 
virtual void init ()
 initialize the ShadowedScene and local cached data structures. More...
 
virtual void update (osg::NodeVisitor &nv)
 run the update traversal of the ShadowedScene and update any loca chached data structures. More...
 
virtual void cull (osgUtil::CullVisitor &cv)
 run the cull traversal of the ShadowedScene and set up the rendering for this ShadowTechnique. More...
 
virtual void cleanSceneGraph ()
 Clean scene graph from any shadow technique specific nodes, state and drawables. More...
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size. More...
 
virtual void releaseGLObjects (osg::State *=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...
 
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)
 
virtual bool isSameKindAs (const osg::Object *obj) const
 
virtual const char * libraryName () const
 return the name of the object's library. More...
 
virtual const char * className () const
 return the name of the object's class type. More...
 
virtual void setShadowedScene (ShadowedScene *ss)
 
ShadowedScenegetShadowedScene ()
 
const ShadowedScenegetShadowedScene () const
 
virtual void traverse (osg::NodeVisitor &nv)
 
virtual void dirty ()
 Dirty so that cached data structures are updated. More...
 
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object. More...
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...
 
virtual ObjectcloneType () const =0
 Clone the type of an object, with Object* return type. More...
 
virtual Objectclone (const CopyOp &) const =0
 Clone an object, with Object* return type. More...
 
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name. More...
 
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
 
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
 
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual StateSetasStateSet ()
 Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual const StateSetasStateSet () const
 convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual Uniform * asUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const UniformBaseasUniformBase () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual UniformBaseasUniformBase ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const Uniform * asUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual CameraasCamera ()
 Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual const CameraasCamera () const
 convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual DrawableasDrawable ()
 Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0. More...
 
virtual const DrawableasDrawable () const
 convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0. More...
 
virtual CallbackasCallback ()
 Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual const CallbackasCallback () const
 convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual CallbackObjectasCallbackObject ()
 Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual const CallbackObjectasCallbackObject () const
 convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual UserDataContainerasUserDataContainer ()
 Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual const UserDataContainerasUserDataContainer () const
 convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual ValueObjectasValueObject ()
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual const ValueObjectasValueObject () const
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual ImageasImage ()
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
 
virtual const ImageasImage () const
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
virtual void setName (const std::string &name)
 Set the name of object using C++ style string. More...
 
void setName (const char *name)
 Set the name of object using a C style string. More...
 
const std::string & getName () const
 Get the name of object. More...
 
void setDataVariance (DataVariance dv)
 Set the data variance of this object. More...
 
DataVariance getDataVariance () const
 Get the data variance of this object. More...
 
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc. More...
 
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object. More...
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...
 
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () const
 Get const user data. More...
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 provide implementation of osg::Object::getUserValue(..) template More...
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. More...
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::MutexgetRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 

Protected Member Functions

virtual ~ShadowMap (void)
 
virtual void createUniforms ()
 Create the managed Uniforms. More...
 
virtual void createShaders ()
 
- 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 ()
 Object destructor. More...
 
- 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::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

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 

Detailed Description

ShadowedTexture provides an implementation of shadow textures.

Member Typedef Documentation

◆ ShaderList

◆ UniformList

typedef std::vector< osg::ref_ptr<osg::Uniform> > osgShadow::ShadowMap::UniformList

Constructor & Destructor Documentation

◆ ShadowMap() [1/2]

osgShadow::ShadowMap::ShadowMap ( )

◆ ShadowMap() [2/2]

osgShadow::ShadowMap::ShadowMap ( const ShadowMap es,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)

◆ ~ShadowMap()

virtual osgShadow::ShadowMap::~ShadowMap ( void  )
inlineprotectedvirtual

Member Function Documentation

◆ addShader() [1/2]

void osgShadow::ShadowMap::addShader ( osg::Shader shader)
inline

Add a shader to internal list, will be used instead of the default ones.

◆ addShader() [2/2]

template<class T >
void osgShadow::ShadowMap::addShader ( const osg::ref_ptr< T > &  shader)
inline

References addShader(), and osg::ref_ptr< T >::get().

Referenced by addShader().

◆ cleanSceneGraph()

virtual void osgShadow::ShadowMap::cleanSceneGraph ( )
virtual

Clean scene graph from any shadow technique specific nodes, state and drawables.

Reimplemented from osgShadow::ShadowTechnique.

◆ clearShaderList()

void osgShadow::ShadowMap::clearShaderList ( )
inline

Reset internal shader list.

References osg::releaseGLObjects(), and osg::resizeGLObjectBuffers().

◆ createShaders()

virtual void osgShadow::ShadowMap::createShaders ( )
protectedvirtual

Reimplemented in osgShadow::SoftShadowMap.

◆ createUniforms()

virtual void osgShadow::ShadowMap::createUniforms ( )
protectedvirtual

Create the managed Uniforms.

Reimplemented in osgShadow::SoftShadowMap.

◆ cull()

virtual void osgShadow::ShadowMap::cull ( osgUtil::CullVisitor cv)
virtual

run the cull traversal of the ShadowedScene and set up the rendering for this ShadowTechnique.

Reimplemented from osgShadow::ShadowTechnique.

◆ getAmbientBias()

const osg::Vec2& osgShadow::ShadowMap::getAmbientBias ( ) const
inline

Get the values that are used for the ambient bias in the shader.

◆ getPolygonOffset()

const osg::Vec2& osgShadow::ShadowMap::getPolygonOffset ( ) const
inline

get the used polygon offset

◆ getTextureSize()

const osg::Vec2s& osgShadow::ShadowMap::getTextureSize ( ) const
inline

Get the values that are used for the ambient bias in the shader.

◆ getTextureUnit()

unsigned int osgShadow::ShadowMap::getTextureUnit ( ) const
inline

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

◆ init()

virtual void osgShadow::ShadowMap::init ( )
virtual

initialize the ShadowedScene and local cached data structures.

Reimplemented from osgShadow::ShadowTechnique.

◆ makeDebugHUD()

osg::ref_ptr<osg::Camera> osgShadow::ShadowMap::makeDebugHUD ( )

◆ META_Object()

osgShadow::ShadowMap::META_Object ( osgShadow  ,
ShadowMap   
)

◆ releaseGLObjects()

virtual void osgShadow::ShadowMap::releaseGLObjects ( osg::State = 0) const
virtual

If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context.

Otherwise, releases OpenGL objects for all graphics contexts.

Implements osgShadow::ShadowTechnique.

◆ resizeGLObjectBuffers()

virtual void osgShadow::ShadowMap::resizeGLObjectBuffers ( unsigned int  maxSize)
virtual

Resize any per context GLObject buffers to specified size.

Implements osgShadow::ShadowTechnique.

◆ setAmbientBias()

void osgShadow::ShadowMap::setAmbientBias ( const osg::Vec2 ambientBias)

Set the values for the ambient bias the shader will use.

◆ setLight() [1/2]

void osgShadow::ShadowMap::setLight ( osg::Light light)

Set the Light that will cast shadows.

◆ setLight() [2/2]

void osgShadow::ShadowMap::setLight ( osg::LightSource ls)

◆ setPolygonOffset()

void osgShadow::ShadowMap::setPolygonOffset ( const osg::Vec2 polyOffset)

set the polygon offset used initially

◆ setTextureSize()

void osgShadow::ShadowMap::setTextureSize ( const osg::Vec2s textureSize)

set the size in pixels x / y for the shadow texture.

◆ setTextureUnit()

void osgShadow::ShadowMap::setTextureUnit ( unsigned int  unit)

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

◆ update()

virtual void osgShadow::ShadowMap::update ( osg::NodeVisitor nv)
virtual

run the update traversal of the ShadowedScene and update any loca chached data structures.

Reimplemented from osgShadow::ShadowTechnique.

Member Data Documentation

◆ _ambientBias

osg::Vec2 osgShadow::ShadowMap::_ambientBias
protected

◆ _ambientBiasUniform

osg::ref_ptr<osg::Uniform> osgShadow::ShadowMap::_ambientBiasUniform
protected

◆ _baseTextureUnit

unsigned int osgShadow::ShadowMap::_baseTextureUnit
protected

◆ _camera

osg::ref_ptr<osg::Camera> osgShadow::ShadowMap::_camera
protected

◆ _light

osg::ref_ptr<osg::Light> osgShadow::ShadowMap::_light
protected

◆ _ls

osg::ref_ptr<osg::LightSource> osgShadow::ShadowMap::_ls
protected

◆ _polyOffset

osg::Vec2 osgShadow::ShadowMap::_polyOffset
protected

◆ _program

osg::ref_ptr<osg::Program> osgShadow::ShadowMap::_program
protected

◆ _shaderList

ShaderList osgShadow::ShadowMap::_shaderList
protected

◆ _shadowTextureUnit

unsigned int osgShadow::ShadowMap::_shadowTextureUnit
protected

◆ _stateset

osg::ref_ptr<osg::StateSet> osgShadow::ShadowMap::_stateset
protected

◆ _texgen

osg::ref_ptr<osg::TexGen> osgShadow::ShadowMap::_texgen
protected

◆ _texture

osg::ref_ptr<osg::Texture2D> osgShadow::ShadowMap::_texture
protected

◆ _textureSize

osg::Vec2s osgShadow::ShadowMap::_textureSize
protected

◆ _uniformList

UniformList osgShadow::ShadowMap::_uniformList
protected

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