Kanzi  3.9.4
Kanzi Engine API
kanzi::Instantiator3D::FinalTransformModifier Class Reference

Container for property modifiers for instantiated nodes. More...

#include <kanzi/core.ui/node/instantiator3d.hpp>

Public Member Functions

 FinalTransformModifier (Instantiator3D &instantiator, Node3DSharedPtr node)
 Constructor. More...
 
void invalidate ()
 Invalidates the transform modifier. More...
 
void runModifier (Matrix4x4 &storage)
 Executes the transform modifier. More...
 
void setEnabled (bool enabled)
 Sets the enabled status of the transform modifier. More...
 
 ~FinalTransformModifier ()
 Destructor. More...
 

Public Attributes

optional< Matrix4x4m_cachedTransform
 Cached matrix that can be returned. More...
 
bool m_cachedTransformNotificationGuard
 Notification guard for cached transform invalidation. More...
 
bool m_enabled
 Indicates whether the transform modifier is enabled. More...
 
Node3DWeakPtr m_node
 Weak reference to the node whose transform is being modified. More...
 
Instantiator3Dm_parentInstantiator
 Instantiator parent. More...
 

Detailed Description

Container for property modifiers for instantiated nodes.

Constructor & Destructor Documentation

◆ FinalTransformModifier()

kanzi::Instantiator3D::FinalTransformModifier::FinalTransformModifier ( Instantiator3D instantiator,
Node3DSharedPtr  node 
)

Constructor.

Registers the modifier callback and notification handler for this construct.

Parameters
instantiatorInstantiator parent.
nodeSource node.

◆ ~FinalTransformModifier()

kanzi::Instantiator3D::FinalTransformModifier::~FinalTransformModifier ( )

Destructor.

Member Function Documentation

◆ invalidate()

void kanzi::Instantiator3D::FinalTransformModifier::invalidate ( )

Invalidates the transform modifier.

Ran whenever source properties change. If the guard flag is set, the transformation is not reset.

◆ runModifier()

void kanzi::Instantiator3D::FinalTransformModifier::runModifier ( Matrix4x4 storage)

Executes the transform modifier.

Parameters
storageStorage to write to.

◆ setEnabled()

void kanzi::Instantiator3D::FinalTransformModifier::setEnabled ( bool  enabled)

Sets the enabled status of the transform modifier.

Adds or removes the transform modifier.

Parameters
enabledNew enabled flag.

Member Data Documentation

◆ m_parentInstantiator

Instantiator3D& kanzi::Instantiator3D::FinalTransformModifier::m_parentInstantiator

Instantiator parent.

◆ m_node

Node3DWeakPtr kanzi::Instantiator3D::FinalTransformModifier::m_node

Weak reference to the node whose transform is being modified.

◆ m_cachedTransform

optional<Matrix4x4> kanzi::Instantiator3D::FinalTransformModifier::m_cachedTransform

Cached matrix that can be returned.

Reset when the value is dirtied.

◆ m_cachedTransformNotificationGuard

bool kanzi::Instantiator3D::FinalTransformModifier::m_cachedTransformNotificationGuard

Notification guard for cached transform invalidation.

◆ m_enabled

bool kanzi::Instantiator3D::FinalTransformModifier::m_enabled

Indicates whether the transform modifier is enabled.


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