OpenGl_ShadowMap Class Reference

This class contains shadow mapping resources. More...

#include <OpenGl_ShadowMap.hxx>

Inheritance diagram for OpenGl_ShadowMap:

Public Member Functions
	OpenGl_ShadowMap ()
	Empty constructor.
virtual void	Release (OpenGl_Context *theCtx) override
	Releases all OpenGL resources.
virtual Standard_Size	EstimatedDataSize () const override
	Returns estimated GPU memory usage for holding data without considering overheads and allocation alignment rules.
virtual	~OpenGl_ShadowMap ()
	Destructor.
bool	IsValid () const
	Return TRUE if defined.
const Handle< OpenGl_FrameBuffer > &	FrameBuffer () const
	Return framebuffer.
const Handle< OpenGl_Texture > &	Texture () const
	Return depth texture.
const Handle< Graphic3d_CLight > &	LightSource () const
	Return light source casting the shadow or NULL if undefined.
void	SetLightSource (const Handle< Graphic3d_CLight > &theLight)
	Set light source casting the shadow.
const Handle< Graphic3d_Camera > &	Camera () const
	Return rendering camera.
const Graphic3d_Mat4 &	LightSourceMatrix () const
	Return light source mapping matrix.
void	SetLightSourceMatrix (const Graphic3d_Mat4 &theMat)
	Set light source mapping matrix.
Standard_ShortReal	ShadowMapBias () const
	Returns shadowmap bias.
void	SetShadowMapBias (Standard_ShortReal theBias)
	Sets shadowmap bias.
bool	UpdateCamera (const Graphic3d_CView &theView, const gp_XYZ *theOrigin=NULL)
	Compute camera.
Public Member Functions inherited from OpenGl_NamedResource
	OpenGl_NamedResource (const TCollection_AsciiString &theId)
	Empty constructor.
const TCollection_AsciiString &	ResourceId () const
	Return resource name.
Public Member Functions inherited from OpenGl_Resource
	OpenGl_Resource ()
	Empty constructor.
virtual	~OpenGl_Resource ()
	Destructor. Inheritors should call Clean (NULL) within it.
virtual void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
	Dumps the content of me into the stream.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.
Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.
Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.
virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.
Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.
Protected Attributes inherited from OpenGl_NamedResource
TCollection_AsciiString	myResourceId
	resource name

Detailed Description

This class contains shadow mapping resources.

Constructor & Destructor Documentation

OpenGl_ShadowMap()

OpenGl_ShadowMap::OpenGl_ShadowMap

(

)

Empty constructor.

~OpenGl_ShadowMap()

virtual OpenGl_ShadowMap::~OpenGl_ShadowMap ( )

virtual

Destructor.

Member Function Documentation

Camera()

const Handle< Graphic3d_Camera > & OpenGl_ShadowMap::Camera ( ) const

inline

Return rendering camera.

EstimatedDataSize()

virtual Standard_Size OpenGl_ShadowMap::EstimatedDataSize ( ) const

overridevirtual

Returns estimated GPU memory usage for holding data without considering overheads and allocation alignment rules.

Implements OpenGl_Resource.

FrameBuffer()

const Handle< OpenGl_FrameBuffer > & OpenGl_ShadowMap::FrameBuffer ( ) const

inline

Return framebuffer.

IsValid()

bool OpenGl_ShadowMap::IsValid

(

)

const

Return TRUE if defined.

LightSource()

const Handle< Graphic3d_CLight > & OpenGl_ShadowMap::LightSource ( ) const

inline

Return light source casting the shadow or NULL if undefined.

LightSourceMatrix()

const Graphic3d_Mat4 & OpenGl_ShadowMap::LightSourceMatrix ( ) const

inline

Return light source mapping matrix.

Release()

virtual void OpenGl_ShadowMap::Release ( OpenGl_Context *  theCtx )

overridevirtual

Releases all OpenGL resources.

Implements OpenGl_Resource.

SetLightSource()

void OpenGl_ShadowMap::SetLightSource ( const Handle< Graphic3d_CLight > &  theLight )

inline

Set light source casting the shadow.

SetLightSourceMatrix()

void OpenGl_ShadowMap::SetLightSourceMatrix ( const Graphic3d_Mat4 &  theMat )

inline

Set light source mapping matrix.

SetShadowMapBias()

void OpenGl_ShadowMap::SetShadowMapBias ( Standard_ShortReal  theBias )

inline

Sets shadowmap bias.

ShadowMapBias()

Standard_ShortReal OpenGl_ShadowMap::ShadowMapBias ( ) const

inline

Returns shadowmap bias.

Texture()

const Handle< OpenGl_Texture > & OpenGl_ShadowMap::Texture

(

)

const

Return depth texture.

UpdateCamera()

bool OpenGl_ShadowMap::UpdateCamera	(	const Graphic3d_CView &	theView,
		const gp_XYZ *	theOrigin = NULL
	)

Compute camera.

Parameters

theView	[in] active view
theOrigin	[in] when not-NULL - displace shadow map camera to specified Z-Layer origin

---

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

• OpenGl_ShadowMap.hxx