X3DTK::X3DComponentVisitor Class Reference
[processor]

Abstract class declared in <X3DTK/kernel.h> defining the concept of component visitor. More...

Inheritance diagram for X3DTK::X3DComponentVisitor:

List of all members.

Public Member Functions

• X3DComponentVisitor ()
• virtual ~X3DComponentVisitor ()=0
• EnterFunction * getEnterFunctionOf (const SFType *type) const
• WalkOnFunction * getWalkOnFunctionOf (const SFType *type) const
• LeaveFunction * getLeaveFunctionOf (const SFType *type) const

Protected Member Functions

• template<class T> void defineEnterFunction (void(*ptrF)(T *))
• template<class T> void defineWalkOnFunction (bool(*ptrF)(T *, SFNode))
• template<class T> void defineLeaveFunction (void(*ptrF)(T *))
• void define (const std::pair< StringType, EnterFunction * > &entry)
• void define (const std::pair< StringType, WalkOnFunction * > &entry)
• void define (const std::pair< StringType, LeaveFunction * > &entry)

---

Detailed Description

Abstract class declared in <X3DTK/kernel.h> defining the concept of component visitor.

A component visitor is a visitor for a component of the X3D nodes. It records callbacks of three different types. Enter, walkOn and leave functions can be recorded. For more details about defining and recording callbacks, see the processor page. Two syntaxes can be used depending on the compiler used.

---

Constructor & Destructor Documentation

X3DTK::X3DComponentVisitor::X3DComponentVisitor (   )

Constructor.

virtual X3DTK::X3DComponentVisitor::~X3DComponentVisitor (   )  [pure virtual]

Destructor.

---

Member Function Documentation

void X3DTK::X3DComponentVisitor::define (  const std::pair< StringType, LeaveFunction * > &  entry  )  [protected]

Define a new leave function. The node of type T must belong to the component, otherwise the function is not recorded. Portable syntax.

void X3DTK::X3DComponentVisitor::define (  const std::pair< StringType, WalkOnFunction * > &  entry  )  [protected]

Define a new walk On function. The node of type T must belong to the component, otherwise the function is not recorded. Portable syntax.

void X3DTK::X3DComponentVisitor::define (  const std::pair< StringType, EnterFunction * > &  entry  )  [protected]

Define a new enter function. The node of type T must belong to the component, otherwise the function is not recorded. Portable syntax.

template<class T> void X3DTK::X3DComponentVisitor::defineEnterFunction (  void(*  ptrF)(T *)  )  [protected]

Define a new enter function. The node of type T must belong to the component, otherwise the function is not recorded. Preferred syntax.

template<class T> void X3DTK::X3DComponentVisitor::defineLeaveFunction (  void(*  ptrF)(T *)  )  [protected]

Define a new leave function. The node of type T must belong to the component, otherwise the function is not recorded. Preferred syntax.

template<class T> void X3DTK::X3DComponentVisitor::defineWalkOnFunction (  bool(*  ptrF)(T *, SFNode)  )  [protected]

Define a new walk On function. The node of type T must belong to the component, otherwise the function is not recorded. Preferred syntax.

EnterFunction* X3DTK::X3DComponentVisitor::getEnterFunctionOf (  const SFType *  type  )  const

Gets the enter function of SFType type.

LeaveFunction* X3DTK::X3DComponentVisitor::getLeaveFunctionOf (  const SFType *  type  )  const

Gets the leave function of SFType type.

WalkOnFunction* X3DTK::X3DComponentVisitor::getWalkOnFunctionOf (  const SFType *  type  )  const

Gets the WalkOn function of SFType type.

---