iMSTK: imstk::Needle Class Reference

Base for all needles in imstk it supports global puncture state, per object puncture state, and per id/cell puncture state. More...

Inheritance diagram for imstk::Needle:

[legend]

Collaboration diagram for imstk::Needle:

Public Member Functions
	Needle (const std::string &name="Needle")

PunctureMap &	getPunctures ()

bool	getInserted () const
	Get if inserted at all.

virtual Vec3d	getNeedleDirection () const
	Returns direction at needle tip.

virtual Vec3d	getNeedleTip () const


void	setPuncture (const PunctureId &id, std::shared_ptr< Puncture > data)
	Get/Set puncture data.

std::shared_ptr< Puncture >	getPuncture (const PunctureId &id)


void	setState (const PunctureId &id, const Puncture::State state)
	Get/set puncture state. This can be done through data too but this supports the allocation of new puncture data should you query a non-existent puncture.

Puncture::State	getState (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

Base for all needles in imstk it supports global puncture state, per object puncture state, and per id/cell puncture state.

Definition at line 20 of file imstkNeedle.h.

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