SOFA API  df6198ac
Open source framework for multi-physics simuation
sofa::core::objectmodel::DetachNodeEvent Class Reference

#include <DetachNodeEvent.h>

Inheritance diagram for sofa::core::objectmodel::DetachNodeEvent:

Detailed Description

Event indicating that a child node is being detached from the scene. Any reference to one of its descendant (such as active contacts) should be removed.

Protected Attributes

- Protected Attributes inherited from sofa::core::objectmodel::Event
bool m_handled

Public Member Functions

 DetachNodeEvent (BaseNode *n)
 ~DetachNodeEvent () override
BaseNodegetNode () const
bool contains (BaseNode *n) const
bool contains (BaseObject *o) const
- Public Member Functions inherited from sofa::core::objectmodel::Event
 Event ()
virtual ~Event ()
void setHandled ()
 Tag the event as handled, i.e. the event needs not be propagated further. More...
bool isHandled () const
 Returns true of the event has been handled. More...
virtual const chargetClassName () const
virtual size_t getEventTypeIndex () const =0

Static Public Member Functions

static const charGetClassName ()
- Static Public Member Functions inherited from sofa::core::objectmodel::Event
static const charGetClassName ()
static size_t getEventTypeCount ()

Additional Inherited Members

- Static Protected Attributes inherited from sofa::core::objectmodel::Event
static size_t s_lastEventTypeIndex = 0
 storing the last given id More...

Attribute details

◆ node

BaseNode* sofa::core::objectmodel::DetachNodeEvent::node

Constructor details

◆ DetachNodeEvent()

sofa::core::objectmodel::DetachNodeEvent::DetachNodeEvent ( BaseNode n)

◆ ~DetachNodeEvent()

sofa::core::objectmodel::DetachNodeEvent::~DetachNodeEvent ( )

Function details

◆ contains() [1/2]

bool sofa::core::objectmodel::DetachNodeEvent::contains ( BaseNode n) const

◆ contains() [2/2]

bool sofa::core::objectmodel::DetachNodeEvent::contains ( BaseObject o) const

◆ GetClassName()

static const char* sofa::core::objectmodel::DetachNodeEvent::GetClassName ( )

◆ getNode()

BaseNode * sofa::core::objectmodel::DetachNodeEvent::getNode ( ) const