Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
chrono::vsg3d::ChVisualSystemVSGPlugin Class Reference
VSG module

Description

Base class for a plugin for a VSG visual system.

Plugins offer a mechanism for extending a base VSG visual system with custom functionality; e.g., for rendering, controlling, and displaying information for specific types of Chrono systems. An arbitrary number of plugins can be attached to a VSG visual system.

#include <ChVisualSystemVSG.h>

Inheritance diagram for chrono::vsg3d::ChVisualSystemVSGPlugin:
Inheritance graph
[legend]
Collaboration diagram for chrono::vsg3d::ChVisualSystemVSGPlugin:
Collaboration graph
[legend]

Public Member Functions

void AddEventHandler (std::shared_ptr< ChEventHandlerVSG > eh)
 TODO - remove AddEventHandler? A plugin can call the VSG system's AddEventHandler in its OnAttach() function. More...
 
ChVisualSystemVSG & GetVisualSystemVSG () const
 Get a reference to the VSG visual system to which the plugin was attached.
 

Protected Member Functions

virtual void OnAttach ()
 Allow this plugin to perform any operations when it is attached to a VSG visual system. More...
 
virtual void OnInitialize ()
 Allow this plugin to perform any pre-initialization operations. More...
 
virtual void OnRender ()
 Allow this plugin to perform any pre-rendering operations. More...
 

Protected Attributes

std::vector< std::shared_ptr< ChEventHandlerVSG > > m_evhandler
 list of all additional event handlers
 
ChVisualSystemVSG * m_vsys
 associated VSG visual system
 

Friends

class ChVisualSystemVSG
 

Member Function Documentation

◆ AddEventHandler()

void chrono::vsg3d::ChVisualSystemVSGPlugin::AddEventHandler ( std::shared_ptr< ChEventHandlerVSG >  eh)
inline

TODO - remove AddEventHandler? A plugin can call the VSG system's AddEventHandler in its OnAttach() function.

Add custom event handlers for this plugin.

◆ OnAttach()

virtual void chrono::vsg3d::ChVisualSystemVSGPlugin::OnAttach ( )
inlineprotectedvirtual

Allow this plugin to perform any operations when it is attached to a VSG visual system.

The pointer m_vsys to the associated VSG visual system is set before calling OnAttach.

Reimplemented in chrono::fsi::sph::ChFsiVisualizationVSG.

◆ OnInitialize()

virtual void chrono::vsg3d::ChVisualSystemVSGPlugin::OnInitialize ( )
inlineprotectedvirtual

Allow this plugin to perform any pre-initialization operations.

This function is called before the initialization of the associated VSG visual system.

Reimplemented in chrono::fsi::sph::ChFsiVisualizationVSG.

◆ OnRender()

virtual void chrono::vsg3d::ChVisualSystemVSGPlugin::OnRender ( )
inlineprotectedvirtual

Allow this plugin to perform any pre-rendering operations.

This function is called before updating and rendering the associated VSG visual system.

Reimplemented in chrono::fsi::sph::ChFsiVisualizationVSG.

The documentation for this class was generated from the following file:
  • /builds/uwsbel/chrono/src/chrono_vsg/ChVisualSystemVSG.h