kanzi::DistanceFilterRuntime Class Reference

Runtime for distance filter. More...

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

Inheritance diagram for kanzi::DistanceFilterRuntime:

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

Static Public Member Functions
static DistanceFilterRuntimeSharedPtr	create (NodeListSharedPtr nodeList, ObjectSourceSharedPtr filter)
	Creates a distance filter runtime.

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

Protected Attributes
Vector3	m_referencePosition
	Position of the target node.
Node3DWeakPtr	m_targetNode
	Node to filter against.
Protected Attributes inherited from kanzi::FilterObjectSourceRuntime
bool	m_isExclusive
	Exclusivity flag, copied from the filter object source.
Protected Attributes inherited from kanzi::ObjectSourceRuntime
NodeListWeakPtr	m_inputNodes
	Input node list.
ObjectSourceWeakPtr	m_objectSource
	Parent object source.
NodeListSharedPtr	m_parentNodeList
	Node list that is the result of the parent runtime being executed.
ObjectSourceRuntimeSharedPtr	m_parentRuntime
	Runtime for the object source chain.

Detailed Description

Runtime for distance filter.

Since

Kanzi 3.9.0

Constructor & Destructor Documentation

DistanceFilterRuntime()

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

inlineexplicitprotected

Constructor.

Parameters

nodeList	Node list to filter.
filter	Parent filter.

Member Function Documentation

create()

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

static

Creates a distance filter runtime.

Parameters

nodeList	Node list to filter.
filter	Parent filter.

Returns

Newly created Distance filter runtime.

getTargetNode()

Node3DSharedPtr kanzi::DistanceFilterRuntime::getTargetNode ( ) const

inline

Gets the target object node.

Returns

Currently used target node.

setTargetNode()

void kanzi::DistanceFilterRuntime::setTargetNode ( Node3DSharedPtr node )

inline

Sets the target object node.

Parameters

node	Node to use.

filterNodeOverride()

bool kanzi::DistanceFilterRuntime::filterNodeOverride ( Node & node )

overrideprotectedvirtual

FilterObjectSourceRuntime::filterNodeOverride() implementation.

Reimplemented from kanzi::FilterObjectSourceRuntime.

filterOverride()

void kanzi::DistanceFilterRuntime::filterOverride ( NodeList & inputNodes, NodeList & outputNodes )

overrideprotectedvirtual

ObjectSourceRuntime::filterOverride() implementation.

Reimplemented from kanzi::ObjectSourceRuntime.

isDirtyOverride()

bool kanzi::DistanceFilterRuntime::isDirtyOverride ( )

overrideprotectedvirtual

ObjectSourceRuntime::isDirtyOverride() implementation.

Reimplemented from kanzi::ObjectSourceRuntime.

Member Data Documentation

m_targetNode

Node3DWeakPtr kanzi::DistanceFilterRuntime::m_targetNode

protected

Node to filter against.

m_referencePosition

Vector3 kanzi::DistanceFilterRuntime::m_referencePosition

protected

Position of the target node.

---

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

• kanzi/core.ui/graphics3d/distance_filter_runtime.hpp