Kanzi  3.9.7
Kanzi Engine API
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...
 
LightgetLight () 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...
 
LightInfooperator= (const LightInfo &other)
 Copy operator. More...
 
LightInfooperator= (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
lightGathered light.
kanzi::GatherLightsRenderPass::LightInfo::LightInfo ( Light light,
const Matrix4x4 transformModifier 
)
inlineexplicit

Constructor.

Parameters
lightGathered light.
transformModifierModifier for final transformation.
kanzi::GatherLightsRenderPass::LightInfo::LightInfo ( const LightInfo other)
inline

Copy constructor.

Parameters
otherSource object.
kanzi::GatherLightsRenderPass::LightInfo::LightInfo ( LightInfo &&  other)
inline

Move constructor.

Parameters
otherSource 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
valueValue to write to.
propertyTypeProperty 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
otherSource object.
LightInfo& kanzi::GatherLightsRenderPass::LightInfo::operator= ( LightInfo &&  other)
inline

Move operator.

Parameters
otherSource object.

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