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

A behaviour that renders a second copy of the controlled object at a lower opacity in the physical position as opposed to the original rendered at the virtual. More...

#include <imstkObjectControllerGhost.h>

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

Public Member Functions

 ObjectControllerGhost (const std::string &name="ObjectControllerGhost")
 
void setController (std::shared_ptr< PbdObjectController > controller)
 
std::shared_ptr< PbdObjectControllergetPbdController () const
 
void setController (std::shared_ptr< RigidObjectController > controller)
 
std::shared_ptr< RigidObjectControllergetRbdController () const
 
std::shared_ptr< VisualModelgetGhostModel () const
 
void visualUpdate (const double &dt) override
 
void setUseForceFade (bool useForceFade)
 Get/Set whether to use force fade or not. Force fade sets opacity of ghost geometry according to force. Low haptic force results in transparent geometry, high force makes it opaque.
 
bool getUseForceFade () const
 
- 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

std::shared_ptr< PbdObjectControllerm_pbdController = nullptr
 
std::shared_ptr< RigidObjectControllerm_rbdController = nullptr
 
std::shared_ptr< VisualModelm_ghostVisualModel = nullptr
 
bool m_useForceFade = false
 
- 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

A behaviour that renders a second copy of the controlled object at a lower opacity in the physical position as opposed to the original rendered at the virtual.

Todo:

: Device render mode to render the actual arm and body of the device

: This should be simplified when PbdObject and RbdObject are removed

Definition at line 26 of file imstkObjectControllerGhost.h.


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