PythonBaseList2DDetectorInterface Class Reference

#include <py_element_detector.h>

Inheritance diagram for PythonBaseList2DDetectorInterface:

Detailed Description

Creates PythonElementEmbeddedRef from a given BaseList2D IsValid is first called to check, only if true is returned, CreatePythonEmbeddedRef will be called to create a new python embedded element to be inserted into the PythonElementManager.

Public Member Functions

MAXON_METHOD Bool IsValid (BaseList2D *bl2D)
 
MAXON_METHOD Result< void > CreatePythonEmbeddedRef (BaseList2D *bl2D, ValueReceiver< PythonElementEmbeddedRef & > &out)
 

Private Member Functions

 MAXON_INTERFACE (PythonBaseList2DDetectorInterface, MAXON_REFERENCE_NORMAL, "net.maxon.interfaces.python_baselist2d_detector")
 

Member Function Documentation

◆ MAXON_INTERFACE()

MAXON_INTERFACE ( PythonBaseList2DDetectorInterface  ,
MAXON_REFERENCE_NORMAL  ,
"net.maxon.interfaces.python_baselist2d_detector"   
)
private

◆ IsValid()

MAXON_METHOD Bool IsValid ( BaseList2D bl2D)

Checks that the passed BaseList2D could be interpreted as a PythonElementEmbeddedRef.

Note
This method is called for each object Addition/Suppression, so take performance in consideration.
Parameters
[in]bl2DThe BaseList2D to scan if a Python embedded element can be built upon.
Returns
true if the BaseList2D can be interpreted as a PythonElementEmbeddedRef, otherwise false.

◆ CreatePythonEmbeddedRef()

MAXON_METHOD Result<void> CreatePythonEmbeddedRef ( BaseList2D bl2D,
ValueReceiver< PythonElementEmbeddedRef & > &  out 
)

Create one or multiple PythonElementEmbeddedInterface from a BaseList2D

Parameters
[in]bl2DThe BaseList2D to retrieve a Python embedded element from.
[out]outA ValueReceiver, that should be notified with each embedded python element created from the BaseList2D.