OpenGl_LightSourceState Class Reference

Defines state of OCCT light sources. More...

#include <OpenGl_ShaderStates.hxx>

Inheritance diagram for OpenGl_LightSourceState:

Public Member Functions
	OpenGl_LightSourceState ()
	Creates uninitialized state of light sources.
void	Set (const Handle< Graphic3d_LightSet > &theLightSources)
	Sets new light sources.
const Handle< Graphic3d_LightSet > &	LightSources () const
	Returns current list of light sources.
Standard_Integer	SpecIBLMapLevels () const
	Returns number of mipmap levels used in specular IBL map. 0 by default or in case of using non-PBR shading model.
void	SetSpecIBLMapLevels (Standard_Integer theSpecIBLMapLevels)
	Sets number of mipmap levels used in specular IBL map.
bool	HasShadowMaps () const
	Returns TRUE if shadowmap is set.
const Handle< OpenGl_ShadowMapArray > &	ShadowMaps () const
	Returns shadowmap.
void	SetShadowMaps (const Handle< OpenGl_ShadowMapArray > &theMap)
	Sets shadowmap.
bool	ToCastShadows () const
	Returns TRUE if shadowmap should be enabled when available; TRUE by default.
void	SetCastShadows (bool theToCast)
	Set if shadowmap should be enabled when available.
Public Member Functions inherited from OpenGl_StateInterface
	OpenGl_StateInterface ()
	Creates new state.
Standard_Size	Index () const
	Returns current state index.
void	Update ()
	Increment current state.

Additional Inherited Members
Protected Attributes inherited from OpenGl_StateInterface
Standard_Size	myIndex
	current state index

Detailed Description

Defines state of OCCT light sources.

Constructor & Destructor Documentation

OpenGl_LightSourceState()

OpenGl_LightSourceState::OpenGl_LightSourceState ( )

inline

Creates uninitialized state of light sources.

Member Function Documentation

HasShadowMaps()

bool OpenGl_LightSourceState::HasShadowMaps ( ) const

inline

Returns TRUE if shadowmap is set.

LightSources()

const Handle< Graphic3d_LightSet > & OpenGl_LightSourceState::LightSources ( ) const

inline

Returns current list of light sources.

Set()

void OpenGl_LightSourceState::Set ( const Handle< Graphic3d_LightSet > &  theLightSources )

inline

Sets new light sources.

SetCastShadows()

void OpenGl_LightSourceState::SetCastShadows ( bool  theToCast )

inline

Set if shadowmap should be enabled when available.

SetShadowMaps()

void OpenGl_LightSourceState::SetShadowMaps ( const Handle< OpenGl_ShadowMapArray > &  theMap )

inline

Sets shadowmap.

SetSpecIBLMapLevels()

void OpenGl_LightSourceState::SetSpecIBLMapLevels ( Standard_Integer  theSpecIBLMapLevels )

inline

Sets number of mipmap levels used in specular IBL map.

ShadowMaps()

const Handle< OpenGl_ShadowMapArray > & OpenGl_LightSourceState::ShadowMaps ( ) const

inline

Returns shadowmap.

SpecIBLMapLevels()

Standard_Integer OpenGl_LightSourceState::SpecIBLMapLevels ( ) const

inline

Returns number of mipmap levels used in specular IBL map. 0 by default or in case of using non-PBR shading model.

ToCastShadows()

bool OpenGl_LightSourceState::ToCastShadows ( ) const

inline

Returns TRUE if shadowmap should be enabled when available; TRUE by default.

---

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

• OpenGl_ShaderStates.hxx