Kanzi  3.9.4
Kanzi Engine API
kanzi::FilterObjectSourceRuntime Class Reference

Base class for filter runtime classes. More...

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

Inheritance diagram for kanzi::FilterObjectSourceRuntime:
[legend]

Public Member Functions

bool filterNode (Node &node)
 Runs a filter on the given node. More...
 
- Public Member Functions inherited from kanzi::ObjectSourceRuntime
void filter (NodeList &outputNodes)
 Runs the filter on a given node. More...
 
NodeListSharedPtr getInputNodeList ()
 Gets the input node list for this particular object source. More...
 
ObjectSourceRuntimeSharedPtr getParentRuntime () const
 Gets the parent runtime. More...
 
NodeListSharedPtr getRootNodeList ()
 Gets the root node list, parents included. More...
 
bool isDirty ()
 Tells if the node filter considers itself dirty and needs re-executing. More...
 
bool matches (NodeListSharedPtr nodeList, ObjectSourceSharedPtr filter)
 Tells if this filter runtime matches the given node list and filter. More...
 
void setCamera (CameraSharedPtr camera)
 Sets the camera for this object source runtime. More...
 
void update (NodeList &nodes)
 Perform implementation-dependent per-frame update for internal data of the filter. More...
 
virtual ~ObjectSourceRuntime ()=default
 Destructor. More...
 

Protected Member Functions

virtual bool filterNodeOverride (Node &node)
 Filter-specific implemention of the filtering process. More...
 
 FilterObjectSourceRuntime (NodeListSharedPtr nodeList, ObjectSourceSharedPtr filter)
 Constructor. More...
 
void filterOverride (NodeList &inputNodes, NodeList &outputNodes) override
 ObjectSourceRuntime::filterOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::ObjectSourceRuntime
virtual bool isDirtyOverride ()
 Object source -specific implementation of dirty check. More...
 
 ObjectSourceRuntime (NodeListSharedPtr nodeList, ObjectSourceSharedPtr objectSource)
 Constructor. More...
 
virtual void setCameraOverride (CameraSharedPtr camera)
 Object source -specific camera assignment. More...
 
virtual void updateOverride (NodeList &nodes)
 Object source -specific implementation of per-frame update. More...
 

Protected Attributes

bool m_isExclusive
 Exclusivity flag, copied from the filter object source. More...
 
- Protected Attributes inherited from kanzi::ObjectSourceRuntime
NodeListWeakPtr m_inputNodes
 Input node list. More...
 
ObjectSourceWeakPtr m_objectSource
 Parent object source. More...
 
NodeListSharedPtr m_parentNodeList
 Node list that is the result of the parent runtime being executed. More...
 
ObjectSourceRuntimeSharedPtr m_parentRuntime
 Runtime for the object source chain. More...
 

Detailed Description

Base class for filter runtime classes.

Since
Kanzi 3.9.0

Constructor & Destructor Documentation

◆ FilterObjectSourceRuntime()

kanzi::FilterObjectSourceRuntime::FilterObjectSourceRuntime ( NodeListSharedPtr  nodeList,
ObjectSourceSharedPtr  filter 
)
explicitprotected

Constructor.

Member Function Documentation

◆ filterNode()

bool kanzi::FilterObjectSourceRuntime::filterNode ( Node node)

Runs a filter on the given node.

Parameters
nodeThe node to apply the filter to.
Returns
Returns true if the filter passes for the node, false otherwise.

◆ filterNodeOverride()

virtual bool kanzi::FilterObjectSourceRuntime::filterNodeOverride ( Node node)
protectedvirtual

Filter-specific implemention of the filtering process.

Parameters
nodeThe node to apply the filter to.
Returns
Returns true if the filter passes for the node, false otherwise.

Reimplemented in kanzi::FrustumCullFilterRuntime, kanzi::DistanceFilterRuntime, kanzi::CombinerObjectSourceRuntime, kanzi::ContainsPropertyFilterRuntime, kanzi::ObjectTypeFilterRuntime, kanzi::PropertyIsEqualFilterRuntime, and kanzi::TagFilterRuntime.

◆ filterOverride()

void kanzi::FilterObjectSourceRuntime::filterOverride ( NodeList inputNodes,
NodeList outputNodes 
)
overrideprotectedvirtual

Member Data Documentation

◆ m_isExclusive

bool kanzi::FilterObjectSourceRuntime::m_isExclusive
protected

Exclusivity flag, copied from the filter object source.


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