iMSTK: imstk::StraightNeedle Class Reference

Definition of straight, single segment needle. More...

Inheritance diagram for imstk::StraightNeedle:

Collaboration diagram for imstk::StraightNeedle:

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

void	setNeedleGeometry (std::shared_ptr< LineMesh > straightNeedleGeom)

std::shared_ptr< LineMesh >	getNeedleGeometry () const

Vec3d	getNeedleDirection () const override
	Returns axes/direciton of the needle.

Vec3d	getNeedleTip () const override
	Returns tip of the needle.

const Vec3d &	getNeedleStart () const

const Vec3d &	getNeedleEnd () const

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

PunctureMap &	getPunctures ()

bool	getInserted () const
	Get if inserted at all.

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
std::shared_ptr< LineMesh >	m_needleGeom

Protected Attributes inherited from imstk::Needle
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

Definition of straight, single segment needle.

Definition at line 20 of file imstkStraightNeedle.h.

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