Place this on an object to make it puncturable by a needle. This allows puncturables to know they've been punctured without needing to be aware of the needle. The Puncturable supports multiple local ids. More...
#include <imstkPuncturable.h>
Inheritance diagram for imstk::Puncturable:
Collaboration diagram for imstk::Puncturable:
Public Member Functions | |
| Puncturable (const std::string &name="Puncturable") | |
| bool | getPunctured () const |
| void | setPuncture (const PunctureId &id, std::shared_ptr< Puncture > data) |
| Get/Set puncture data. | |
| std::shared_ptr< Puncture > | getPuncture (const PunctureId &id) |
 Public Member Functions inherited from imstk::Component | |
| const std::string & | getName () const |
| void | setName (const std::string &name) |
| std::weak_ptr< Entity > | getEntity () const |
| Get parent entity. | |
| void | initialize () |
| Initialize the component, called at a later time after all component construction is complete. | |
Protected Attributes | |
| PunctureMap | m_punctures |
| Protected Attributes inherited from imstk::Component | |
| std::string | m_name |
| std::weak_ptr< Entity > | m_entity |
| Parent entity this component exists on. | |
Additional Inherited Members | |
| Protected Member Functions inherited from imstk::Component | |
| Component (const std::string &name="Component") | |
| virtual void | init () |
| Initialize the component, called at a later time after all component construction is complete. | |
Detailed Description
Place this on an object to make it puncturable by a needle. This allows puncturables to know they've been punctured without needing to be aware of the needle. The Puncturable supports multiple local ids.
Definition at line 26 of file imstkPuncturable.h.
The documentation for this class was generated from the following files:
- Source/Needle/imstkPuncturable.h
- Source/Needle/imstkPuncturable.cpp
