kanzi::GatherLightsRenderPass::LightInfo Class Reference

Internal information structure for storing information on lights. More...

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

Public Member Functions
bool	extractLightRenderValue (Variant &value, AbstractPropertyType propertyType) const
	Extracts render value from this light info. More...
Matrix4x4	getFinalTransformation () const
	Gets the (potentially modified) final transformation from the light. More...
Light *	getLight () const
	Gets the referred light. More...
	LightInfo (Light &light)
	Constructor. More...
	LightInfo (Light &light, const Matrix4x4 &transformModifier)
	Constructor. More...
	LightInfo (const LightInfo &other)
	Copy constructor. More...
	LightInfo (LightInfo &&other)
	Move constructor. More...
LightInfo &	operator= (const LightInfo &other)
	Copy operator. More...
LightInfo &	operator= (LightInfo &&other)
	Move operator. More...

Detailed Description

Internal information structure for storing information on lights.

Constructor & Destructor Documentation

kanzi::GatherLightsRenderPass::LightInfo::LightInfo ( Light &  light )

inlineexplicit

Constructor.

Parameters

light

Gathered light.

kanzi::GatherLightsRenderPass::LightInfo::LightInfo ( Light &  light, const Matrix4x4 &  transformModifier  )

inlineexplicit

Constructor.

Parameters

light	Gathered light.
transformModifier	Modifier for final transformation.

kanzi::GatherLightsRenderPass::LightInfo::LightInfo ( const LightInfo &  other )

inline

Copy constructor.

Parameters

other

Source object.

kanzi::GatherLightsRenderPass::LightInfo::LightInfo ( LightInfo &&  other )

inline

Move constructor.

Parameters

other

Source object.

Member Function Documentation

Light* kanzi::GatherLightsRenderPass::LightInfo::getLight ( ) const

inline

Gets the referred light.

Returns

Pointer to light.

bool kanzi::GatherLightsRenderPass::LightInfo::extractLightRenderValue	(	Variant &	value,
		AbstractPropertyType	propertyType
	)		const

Extracts render value from this light info.

If property type is set, value name should be equal to property type name.

Parameters

value	Value to write to.
propertyType	Property type to extract.

Returns

If the render value was read successfully, true, otherwise false.

Matrix4x4 kanzi::GatherLightsRenderPass::LightInfo::getFinalTransformation ( ) const

inline

Gets the (potentially modified) final transformation from the light.

Returns

Final transformation.

LightInfo& kanzi::GatherLightsRenderPass::LightInfo::operator= ( const LightInfo &  other )

inline

Copy operator.

Parameters

other

Source object.

LightInfo& kanzi::GatherLightsRenderPass::LightInfo::operator= ( LightInfo &&  other )

inline

Move operator.

Parameters

other

Source object.

---

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

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