Kanzi  3.9.7
Kanzi Engine API
kanzi::DistanceFilterRuntime Class Reference

Runtime for distance filter. More...

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

Inheritance diagram for kanzi::DistanceFilterRuntime:
[legend]

Public Member Functions

Node3DSharedPtr getTargetNode () const
 Gets the target object node. More...
 
void setTargetNode (Node3DSharedPtr node)
 Sets the target object node. More...
 
- Public Member Functions inherited from kanzi::FilterObjectSourceRuntime
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...
 

Static Public Member Functions

static DistanceFilterRuntimeSharedPtr create (NodeListSharedPtr nodeList, ObjectSourceSharedPtr filter)
 Creates a distance filter runtime. More...
 

Protected Member Functions

 DistanceFilterRuntime (NodeListSharedPtr nodeList, ObjectSourceSharedPtr filter)
 Constructor. More...
 
bool filterNodeOverride (Node &node) override
 FilterObjectSourceRuntime::filterNodeOverride() implementation. More...
 
void filterOverride (NodeList &inputNodes, NodeList &outputNodes) override
 ObjectSourceRuntime::filterOverride() implementation. More...
 
bool isDirtyOverride () override
 ObjectSourceRuntime::isDirtyOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::FilterObjectSourceRuntime
 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
 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

Vector3 m_referencePosition
 Position of the target node. More...
 
Node3DWeakPtr m_targetNode
 Node to filter against. More...
 
- Protected Attributes inherited from kanzi::FilterObjectSourceRuntime
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

Runtime for distance filter.

Since
Kanzi 3.9.0

Constructor & Destructor Documentation

kanzi::DistanceFilterRuntime::DistanceFilterRuntime ( NodeListSharedPtr  nodeList,
ObjectSourceSharedPtr  filter 
)
inlineexplicitprotected

Constructor.

Parameters
nodeListNode list to filter.
filterParent filter.

Member Function Documentation

static DistanceFilterRuntimeSharedPtr kanzi::DistanceFilterRuntime::create ( NodeListSharedPtr  nodeList,
ObjectSourceSharedPtr  filter 
)
static

Creates a distance filter runtime.

Parameters
nodeListNode list to filter.
filterParent filter.
Returns
Newly created Distance filter runtime.
Node3DSharedPtr kanzi::DistanceFilterRuntime::getTargetNode ( ) const
inline

Gets the target object node.

Returns
Currently used target node.
void kanzi::DistanceFilterRuntime::setTargetNode ( Node3DSharedPtr  node)
inline

Sets the target object node.

Parameters
nodeNode to use.
bool kanzi::DistanceFilterRuntime::filterNodeOverride ( Node node)
overrideprotectedvirtual
void kanzi::DistanceFilterRuntime::filterOverride ( NodeList inputNodes,
NodeList outputNodes 
)
overrideprotectedvirtual
bool kanzi::DistanceFilterRuntime::isDirtyOverride ( )
overrideprotectedvirtual

Member Data Documentation

Node3DWeakPtr kanzi::DistanceFilterRuntime::m_targetNode
protected

Node to filter against.

Vector3 kanzi::DistanceFilterRuntime::m_referencePosition
protected

Position of the target node.


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