iMSTK
Interactive Medical Simulation Toolkit
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
imstk::Burnable Class Reference

Defines the behaviour to allow a Pbd Object to be burned. This object creates the state data on the mesh to store both the damage state that controls when a cell gets deleted and state data for visualization. This is currently defined as [0,1] where 0 is no damage and value >= 1 deletes the cell. The visual data is purely for visualization, and can be used as the user desires. The model that changes the state is defined by the burning object. More...

#include <imstkBurnable.h>

Inheritance diagram for imstk::Burnable:
Inheritance graph
[legend]
Collaboration diagram for imstk::Burnable:
Collaboration graph
[legend]

Public Member Functions

 Burnable (const std::string &name="BurnableBehaviour")
 
void setTrackOnly (bool val)
 
bool getTrackOnly () const
 
void visualUpdate (const double &dt) override
 
void setUpdateType (PbdObjectCellRemoval::OtherMeshUpdateType updateType)
 
PbdObjectCellRemoval::OtherMeshUpdateType getUpdateType () const
 
std::shared_ptr< PbdObjectCellRemovalgetCellRemover () const
 
std::shared_ptr< PbdObjectgetPbdObject () const
 Get the PBD object to be torn.
 
- Public Member Functions inherited from imstk::Behaviour< UpdateInfo >
virtual void update (const UpdateInfo &imstkNotUsed(updateData))
 
virtual void visualUpdate (const UpdateInfo &imstkNotUsed(updateData))
 
void initTaskGraphEdges ()
 Setup the edges/connections of the TaskGraph.
 
std::shared_ptr< TaskGraphgetTaskGraph () const
 
- Public Member Functions inherited from imstk::Component
const std::string & getName () const
 
void setName (const std::string &name)
 
std::weak_ptr< EntitygetEntity () const
 Get parent entity.
 
void initialize ()
 Initialize the component, called at a later time after all component construction is complete.
 

Protected Member Functions

void init () override
 Initialize the component, called at a later time after all component construction is complete.
 
- Protected Member Functions inherited from imstk::Behaviour< UpdateInfo >
 Behaviour (const std::string &name="Behaviour")
 
 Behaviour (const bool useTaskGraph, const std::string &name="Behaviour")
 
virtual void initGraphEdges (std::shared_ptr< TaskNode > imstkNotUsed(source), std::shared_ptr< TaskNode > imstkNotUsed(sink))
 Setup the edges/connections of the TaskGraph. More...
 
- Protected Member Functions inherited from imstk::Component
 Component (const std::string &name="Component")
 

Protected Attributes

bool m_trackOnly = false
 
PbdObjectCellRemoval::OtherMeshUpdateType m_updateType = PbdObjectCellRemoval::OtherMeshUpdateType::None
 
std::shared_ptr< PbdObjectm_burnableObject
 Object being burned.
 
std::shared_ptr< PbdObjectCellRemovalm_cellRemover
 Cell remover for removing cells.
 
std::shared_ptr< DataArray< double > > m_burnDamagePtr
 
std::shared_ptr< DataArray< double > > m_burnVisualPtr
 
- Protected Attributes inherited from imstk::Behaviour< UpdateInfo >
std::shared_ptr< TaskGraphm_taskGraph = nullptr
 
- Protected Attributes inherited from imstk::Component
std::string m_name
 
std::weak_ptr< Entitym_entity
 Parent entity this component exists on.
 

Detailed Description

Defines the behaviour to allow a Pbd Object to be burned. This object creates the state data on the mesh to store both the damage state that controls when a cell gets deleted and state data for visualization. This is currently defined as [0,1] where 0 is no damage and value >= 1 deletes the cell. The visual data is purely for visualization, and can be used as the user desires. The model that changes the state is defined by the burning object.

Definition at line 29 of file imstkBurnable.h.


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