Kanzi  3.9.4
Kanzi Engine API
kanzi::RenderStatePropertyNotificationHandler Class Referenceabstract

Render value updater for render state. More...

#include <kanzi/core.ui/platform/graphics_backend/gl/render_state_property_notification_handler.hpp>

Inheritance diagram for kanzi::RenderStatePropertyNotificationHandler:
[legend]

Public Member Functions

int getHandle () const
 Access handle. More...
 
void update (GlRenderState &renderState, PropertyObject *object, Material &material)
 Update render state with new values acquirable from this. More...
 
- Public Member Functions inherited from kanzi::RenderValuePropertyNotificationHandlerBase
bool isDirty () const
 Is the container dirty? More...
 
RenderValuePropertyNotificationHandlerBaseoperator= (RenderValuePropertyNotificationHandlerBase &&other)
 Assignment operator. More...
 
void setDirty (bool enabled)
 Set dirty flag state. More...
 
- Public Member Functions inherited from kanzi::NodePropertyNotificationHandler
NodegetNode () const
 Access the node. More...
 
void invalidate ()
 Invalidates the state of the notification handler. More...
 
bool isValid () const
 Tell if this notification handler is valid. More...
 
- Public Member Functions inherited from kanzi::AbstractPropertyNotificationHandler
AbstractPropertyType getPropertyType () const
 Get the property type this handler is listening. More...
 

Protected Member Functions

 RenderStatePropertyNotificationHandler ()
 Empty constructor. More...
 
 RenderStatePropertyNotificationHandler (AbstractPropertyType propertyType, Node *node)
 Constructor Has no handle. More...
 
 RenderStatePropertyNotificationHandler (AbstractPropertyType propertyType, Node *node, GlRenderState::HandleType handle, ShaderProgram::UniformTransformation transformation)
 Constructor. More...
 
virtual void updateOverride (GlRenderState &renderState, PropertyObject *object, Material &material)=0
 Perform type-specific update. More...
 
- Protected Member Functions inherited from kanzi::RenderValuePropertyNotificationHandlerBase
ShaderProgram::UniformTransformation getTransformation () const
 Gets the uniform transformation. More...
 
void onPropertyChanged (PropertyNotificationReason) override
 AbstractPropertyNotificationHandler::onPropertyChanged() implementation. More...
 
 RenderValuePropertyNotificationHandlerBase ()
 Empty constructor. More...
 
 RenderValuePropertyNotificationHandlerBase (AbstractPropertyType propertyType, Node *node)
 Constructor. More...
 
 RenderValuePropertyNotificationHandlerBase (AbstractPropertyType propertyType, Node *node, ShaderProgram::UniformTransformation transformation)
 Constructor. More...
 
 RenderValuePropertyNotificationHandlerBase (RenderValuePropertyNotificationHandlerBase &&other)
 Move constructor. More...
 
- Protected Member Functions inherited from kanzi::NodePropertyNotificationHandler
 NodePropertyNotificationHandler ()
 Empty constructor. More...
 
 NodePropertyNotificationHandler (const NodePropertyNotificationHandler &rhs)
 Copy constructor. More...
 
 NodePropertyNotificationHandler (AbstractPropertyType propertyType, Node *node)
 Constructor. More...
 
NodePropertyNotificationHandleroperator= (const NodePropertyNotificationHandler &rhs)
 Assignment operator. More...
 
 ~NodePropertyNotificationHandler () override
 Destructor. More...
 
- Protected Member Functions inherited from kanzi::AbstractPropertyNotificationHandler
 AbstractPropertyNotificationHandler ()
 Empty constructor. More...
 
 AbstractPropertyNotificationHandler (AbstractPropertyType propertyType)
 Constructor. More...
 
virtual ~AbstractPropertyNotificationHandler ()=default
 

Detailed Description

Render value updater for render state.

This is an abstract class that is inherited and specialized by property value type.

Constructor & Destructor Documentation

◆ RenderStatePropertyNotificationHandler() [1/3]

kanzi::RenderStatePropertyNotificationHandler::RenderStatePropertyNotificationHandler ( )
inlineexplicitprotected

Empty constructor.

◆ RenderStatePropertyNotificationHandler() [2/3]

kanzi::RenderStatePropertyNotificationHandler::RenderStatePropertyNotificationHandler ( AbstractPropertyType  propertyType,
Node node 
)
inlineexplicitprotected

Constructor Has no handle.

Should only used for blend mode.

Parameters
propertyTypeProperty type to listen on.
nodeNode to listen for changes on.

◆ RenderStatePropertyNotificationHandler() [3/3]

kanzi::RenderStatePropertyNotificationHandler::RenderStatePropertyNotificationHandler ( AbstractPropertyType  propertyType,
Node node,
GlRenderState::HandleType  handle,
ShaderProgram::UniformTransformation  transformation 
)
inlineexplicitprotected

Constructor.

Parameters
propertyTypeProperty type to listen on.
nodeNode to listen for changes on.
handleHandle into the render state.
transformationUniform transformation.

Member Function Documentation

◆ update()

void kanzi::RenderStatePropertyNotificationHandler::update ( GlRenderState renderState,
PropertyObject object,
Material material 
)

Update render state with new values acquirable from this.

Do not update if dirty flag has not been set (property is not marked as dirty).

Parameters
renderStateRender state to update.
objectFallback object for property value. Can be 0.
materialFallback material for property value.
Since
Kanzi 3.9.1 data type of object parameter changed from Object* to PropertyObject*.

◆ getHandle()

int kanzi::RenderStatePropertyNotificationHandler::getHandle ( ) const
inline

Access handle.

Returns
Handle.

◆ updateOverride()

virtual void kanzi::RenderStatePropertyNotificationHandler::updateOverride ( GlRenderState renderState,
PropertyObject object,
Material material 
)
protectedpure virtual

Perform type-specific update.

Parameters
renderStateRender state to update.
objectFallback object for property value, may be 0 for no object.
materialFallback material for property value.
Since
Kanzi 3.9.1 data type of object parameter changed from Object* to PropertyObject*.

Implemented in kanzi::TypedRenderStatePropertyNotificationHandler< TextureSharedPtr >, kanzi::BlendModeRenderStatePropertyNotificationHandler, and kanzi::TypedRenderStatePropertyNotificationHandler< T >.


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