Kanzi Framework  3.9.0
Kanzi Engine API
kanzi::BindingRenderValueLookupContext Class Reference

Binding lookup context for render value associations. More...

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

Inheritance diagram for kanzi::BindingRenderValueLookupContext:
[legend]

Public Member Functions

BindingLookupContextPtr clone () override
 BindingLookupContext::clone() implementation. More...
 
MaterialSharedPtr getMaterial () const
 Gets the associated material. More...
 
NodegetNode () const
 Gets the associated node, without lookup. More...
 
RenderPassgetRenderPass () const
 Gets the associated render pass, without lookup. More...
 
GlRenderStategetRenderState ()
 Access the render state for this lookup context. More...
 
ObjectSharedPtr lookup (string_view path) override
 BindingLookupContext::lookup() implementation. More...
 
void * lookupRaw (string_view path) override
 BindingLookupContext::lookupRaw() implementation. More...
 
void registerGlobalNotification (string_view path, BindingLookupNotificationBase &notificationObject) override
 BindingLookupContext::registerGlobalNotification() implementation. More...
 
void registerLocalNotification (PropertyObject *object, string_view path, BindingLookupNotificationBase &notificationObject) override
 BindingLookupContext::registerLocalNotification() implementation. More...
 
void unregisterGlobalNotification (string_view path, BindingLookupNotificationBase &notificationObject) override
 BindingLookupContext::unregisterGlobalNotification() implementation. More...
 
void unregisterLocalNotification (PropertyObject *object, string_view path, BindingLookupNotificationBase &notificationObject) override
 BindingLookupContext::unregisterLocalNotification() implementation. More...
 
- Public Member Functions inherited from kanzi::BindingLookupContext
virtual AbstractPropertyTypeDescriptor::ValueSourceOwnercreateValueSourceOwner (ValueSourceBindingTargetRuntime &targetRuntime, bool reuseAllowed)
 Creates an owner for the specific type of object with which this binding lookup context is associated. More...
 
virtual ~BindingLookupContext ()
 Destructor. More...
 

Static Public Member Functions

static BindingLookupContextPtr create (RenderEntry3D &renderStateAssociation)
 Creates a binding lookup context for given render pass. More...
 

Protected Member Functions

 BindingRenderValueLookupContext (RenderEntry3D &renderStateAssociation)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::BindingLookupContext
 BindingLookupContext ()=default
 Constructor. More...
 

Detailed Description

Binding lookup context for render value associations.

Allows connecting node and render pass with the render state.

Since
Kanzi 3.9.0

Constructor & Destructor Documentation

◆ BindingRenderValueLookupContext()

kanzi::BindingRenderValueLookupContext::BindingRenderValueLookupContext ( RenderEntry3D renderStateAssociation)
inlineexplicitprotected

Constructor.

Parameters
renderStateAssociationThe render state association used for lookup.

Member Function Documentation

◆ create()

static BindingLookupContextPtr kanzi::BindingRenderValueLookupContext::create ( RenderEntry3D renderStateAssociation)
static

Creates a binding lookup context for given render pass.

Parameters
renderStateAssociationThe render state association used for lookup.

◆ getRenderState()

GlRenderState& kanzi::BindingRenderValueLookupContext::getRenderState ( )

Access the render state for this lookup context.

Returns
Render state reference.

◆ clone()

BindingLookupContextPtr kanzi::BindingRenderValueLookupContext::clone ( )
overridevirtual

BindingLookupContext::clone() implementation.

Reimplemented from kanzi::BindingLookupContext.

◆ lookup()

ObjectSharedPtr kanzi::BindingRenderValueLookupContext::lookup ( string_view  path)
overridevirtual

◆ lookupRaw()

void* kanzi::BindingRenderValueLookupContext::lookupRaw ( string_view  path)
overridevirtual

◆ registerGlobalNotification()

void kanzi::BindingRenderValueLookupContext::registerGlobalNotification ( string_view  path,
BindingLookupNotificationBase notificationObject 
)
overridevirtual

◆ unregisterGlobalNotification()

void kanzi::BindingRenderValueLookupContext::unregisterGlobalNotification ( string_view  path,
BindingLookupNotificationBase notificationObject 
)
overridevirtual

◆ registerLocalNotification()

void kanzi::BindingRenderValueLookupContext::registerLocalNotification ( PropertyObject object,
string_view  path,
BindingLookupNotificationBase notificationObject 
)
overridevirtual

◆ unregisterLocalNotification()

void kanzi::BindingRenderValueLookupContext::unregisterLocalNotification ( PropertyObject object,
string_view  path,
BindingLookupNotificationBase notificationObject 
)
overridevirtual

◆ getNode()

Node* kanzi::BindingRenderValueLookupContext::getNode ( ) const

Gets the associated node, without lookup.

Returns
Pointer to node.

◆ getRenderPass()

RenderPass* kanzi::BindingRenderValueLookupContext::getRenderPass ( ) const

Gets the associated render pass, without lookup.

Returns
Pointer to render pass.

◆ getMaterial()

MaterialSharedPtr kanzi::BindingRenderValueLookupContext::getMaterial ( ) const

Gets the associated material.

This is the material attached to the contained render state.


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