kanzi::GatherLightsRenderPass::LightRange Class Reference

Light range is a range type for retrieving light values. More...

#include <kanzi/core.ui/graphics3d/gather_lights_render_pass.hpp>

Inheritance diagram for kanzi::GatherLightsRenderPass::LightRange:

Classes
class	LightRangeLocation
	Light range location implementation. More...

Public Member Functions
void	addLight (Light &light)
	Adds a new light info.
void	addLight (Light &light, const Matrix4x4 &modifierTransform)
	Adds a new light info with modifier transform.
Public Member Functions inherited from kanzi::TypedValueRange< LightInfo >
iterator	begin ()
	Gets an iterator to the beginning of the range.
const_iterator	begin () const
	Gets an iterator to the beginning of the range.
const_iterator	cbegin () const
	Gets an iterator to the beginning of the range.
const_iterator	cend () const
	Gets an iterator to the end of the range.
void	clear ()
	Clears all values from internal storage.
iterator	end ()
	Gets an iterator to the end of the range.
const_iterator	end () const
	Gets an iterator to the end of the range.
vector< LightInfo >::reference	operator[] (size_t index)
	Access operator.
vector< LightInfo >::const_reference	operator[] (size_t index) const
	Const access operator.
void	push_back (const LightInfo &value)
	Appends a value to the end of internal storage.
void	push_back (LightInfo &&value)
	Appends a value to the end of internal storage.
void	setValue (size_t index, const LightInfo &value)
	Sets a value to the internal storage index.
size_t	size () const
	Tells the number of elements in the range.
Public Member Functions inherited from kanzi::AbstractIndexedRange
PropertyObjectSharedPtr	getPropertyObjectByIndex (size_t index)
	Gets a property object by index.
bool	getPropertyValueByIndex (size_t index, AbstractPropertyType propertyType, Variant &value)
	Access a property in a property object at an index.
size_t	getSize ()
	Gets the size of the indexed range.
bool	getValueByIndex (size_t index, Variant &value)
	Reads a value by index and writes it to a variant.
Public Member Functions inherited from kanzi::AbstractRange
bool	adaptView (AbstractRange &potentialViewRange, size_t length)
	Attempts to reuse a view over this range.
AbstractRangeIterator	beginIteration ()
	Gets an iterator to the beginning of this range.
AbstractRangeSharedPtr	createView (size_t length)
	Creates a view over this range.
AbstractRangeSharedPtr	evaluate ()
	Evaluate the abstract range.
AbstractRangeLocationPtr	locationBegin ()
	Gets an iteratable location to beginning of the range.
virtual	~AbstractRange ()=default
	Destructor.

Static Public Member Functions
static shared_ptr< LightRange >	create ()
	Creates a new light range.
Static Public Member Functions inherited from kanzi::TypedValueRange< LightInfo >
static shared_ptr< TypedValueRange >	create ()
	Creates a new typed value range.

Protected Member Functions
PropertyObjectSharedPtr	getPropertyObjectByIndexOverride (size_t index) override
	AbstractIndexedRangeLocation::getPropertyObjectByIndexOverride() implementation.
bool	getPropertyValueByIndexOverride (size_t index, AbstractPropertyType propertyType, Variant &value) override
	AbstractIndexedRangeLocation::getPropertyValueByIndexOverride() implementation.
	LightRange ()=default
	Constructor.
AbstractRangeLocationPtr	locationBeginOverride () override
	AbstractRange::locationBeginOverride() implementation.
Protected Member Functions inherited from kanzi::TypedValueRange< LightInfo >
PropertyObjectSharedPtr	getPropertyObjectByIndexOverride (size_t index) override
	AbstractIndexedRange::getPropertyObjectByIndexOverride() implementation.
bool	getPropertyValueByIndexOverride (size_t index, AbstractPropertyType propertyType, Variant &value) override
	AbstractIndexedRange::getPropertyValueByIndexOverride() implementation.
size_t	getSizeOverride () override
	AbstractIndexedRange::getSizeOverride() implementation.
bool	getValueByIndexOverride (size_t index, Variant &value) override
	AbstractIndexedRange::getValueByIndexOverride() implementation.
AbstractRangeLocationPtr	locationBeginOverride () override
	AbstractRange::locationBeginOverride() implementation.
	TypedValueRange ()=default
	Default constructor.
Protected Member Functions inherited from kanzi::AbstractIndexedRange
bool	adaptViewOverride (AbstractRange &potentialViewRange, size_t length) override
	AbstractRange::adaptViewOverride() implementation.
AbstractRangeSharedPtr	createViewOverride (size_t length) override
	AbstractRange::createViewOverride() implementation.
Protected Member Functions inherited from kanzi::AbstractRange
	AbstractRange ()=default
	Constructor.
virtual AbstractRangeSharedPtr	evaluateOverride ()
	Implementation-dependent evaluation of the range.

Additional Inherited Members
Public Types inherited from kanzi::TypedValueRange< LightInfo >
using	const_iterator
	Const iterator type for values.
using	iterator
	Iterator type for values.
Protected Attributes inherited from kanzi::TypedValueRange< LightInfo >
vector< LightInfo >	m_values
	Container for single type of value.

Detailed Description

Light range is a range type for retrieving light values.

Gather Lights Render Pass creates the light range. Render value bindings, which gather light information, use the light ranges.

Constructor & Destructor Documentation

LightRange()

kanzi::GatherLightsRenderPass::LightRange::LightRange ( )

explicitprotecteddefault

Constructor.

Member Function Documentation

create()

static shared_ptr< LightRange > kanzi::GatherLightsRenderPass::LightRange::create ( )

static

Creates a new light range.

addLight() [1/2]

void kanzi::GatherLightsRenderPass::LightRange::addLight ( Light & light )

inline

Adds a new light info.

Parameters

light

Light to add.

addLight() [2/2]

void kanzi::GatherLightsRenderPass::LightRange::addLight ( Light & light, const Matrix4x4 & modifierTransform )

inline

Adds a new light info with modifier transform.

Parameters

light	Light to add.
modifierTransform	Modifier transformation to use.

locationBeginOverride()

AbstractRangeLocationPtr kanzi::GatherLightsRenderPass::LightRange::locationBeginOverride ( )

overrideprotectedvirtual

AbstractRange::locationBeginOverride() implementation.

Implements kanzi::AbstractRange.

getPropertyObjectByIndexOverride()

PropertyObjectSharedPtr kanzi::GatherLightsRenderPass::LightRange::getPropertyObjectByIndexOverride ( size_t index )

overrideprotectedvirtual

AbstractIndexedRangeLocation::getPropertyObjectByIndexOverride() implementation.

Implements kanzi::AbstractIndexedRange.

getPropertyValueByIndexOverride()

bool kanzi::GatherLightsRenderPass::LightRange::getPropertyValueByIndexOverride ( size_t index, AbstractPropertyType propertyType, Variant & value )

overrideprotectedvirtual

AbstractIndexedRangeLocation::getPropertyValueByIndexOverride() implementation.

Implements kanzi::AbstractIndexedRange.

---

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

• kanzi/core.ui/graphics3d/gather_lights_render_pass.hpp