chrono::gpu::ChGpuVisualizationVSG Class Reference

Description

VSG-based run-time visualization system for SPH-based FSI systems.

Used as a plugin to a Chrono::VSG visualization system. Note that using run-time visualization for an FSI system incurs the penalty of collecting positions of all particles every time the Render() function is invoked.

#include <ChGpuVisualizationVSG.h>

Inheritance diagram for chrono::gpu::ChGpuVisualizationVSG:

Collaboration diagram for chrono::gpu::ChGpuVisualizationVSG:

Classes
class	ParticleColorCallback
	Class to be used as a callback interface for dynamic coloring of SPH particles. More...
class	ParticleVisibilityCallback
	Class to be used as a callback interface for dynamic visibility of SPH particles or BCE markers. More...

Public Member Functions
	ChGpuVisualizationVSG (ChSystemGpu *sysGPU)
virtual void	OnAttach () override
	Allow this plugin to perform any operations when it is attached to a VSG visual system. More...
virtual void	OnInitialize () override
	Allow this plugin to perform any pre-initialization operations. More...
virtual void	OnBindAssets () override
	Allow this plugin to perform any pre-binding operations. More...
virtual void	OnRender () override
	Allow this plugin to perform any pre-rendering operations. More...
void	SetDefaultColor (const ChColor &col)
	Set default color for granular material (default: [0.10, 0.40, 0.65]).
ChColormap::Type	GetColormapType () const
	Get the type of the colormap currently in use.
const ChColormap &	GetColormap () const
	Get the colormap object in current use.
void	SetColorCallback (std::shared_ptr< ParticleColorCallback > functor, ChColormap::Type type=ChColormap::Type::JET)
	Set a callback for dynamic coloring of SPH particles. More...
void	SetVisibilityCallback (std::shared_ptr< ParticleVisibilityCallback > functor)
	Set a callback for dynamic visibility of SPH particles. More...
void	SetImageOutputDirectory (const std::string &dir)
	Set output directory for saving frame snapshots (default: ".").
void	SetImageOutput (bool val)
	Enable/disable writing of frame snapshots to file.
void	EnableParticles (bool val)
	Enable/disable rendering of fluid SPH particles (default: true).
void	AddProxyBody (std::shared_ptr< ChBody > body)
	Add additional proxy body to supplemental system. More...
ChSystem *	GetSystem () const
	Return the internal Chrono system that holds visualization shapes.
Public Member Functions inherited from chrono::vsg3d::ChVisualSystemVSGPlugin
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.

Friends
class	GPUStatsVSG

Additional Inherited Members
Protected Attributes inherited from chrono::vsg3d::ChVisualSystemVSGPlugin
std::vector< std::shared_ptr< ChEventHandlerVSG > >	m_evhandler
	list of all additional event handlers
ChVisualSystemVSG *	m_vsys
	associated VSG visual system

Member Function Documentation

AddProxyBody()

void chrono::gpu::ChGpuVisualizationVSG::AddProxyBody ( std::shared_ptr< ChBody >  body )

inline

Add additional proxy body to supplemental system.

Must be called before Initialize(). The provided body is set fixed to ground and it is the caller's responsibility to update the position of this body before a call to Render().

OnAttach()

void chrono::gpu::ChGpuVisualizationVSG::OnAttach ( )

overridevirtual

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 from chrono::vsg3d::ChVisualSystemVSGPlugin.

OnBindAssets()

void chrono::gpu::ChGpuVisualizationVSG::OnBindAssets ( )

overridevirtual

Allow this plugin to perform any pre-binding operations.

This function is called during initialization of the associated VSG visual system, after the scene was created and before binding assets for the associated VSG visual system. A plugin can create and populate its own children in the VSG scene.

Reimplemented from chrono::vsg3d::ChVisualSystemVSGPlugin.

OnInitialize()

void chrono::gpu::ChGpuVisualizationVSG::OnInitialize ( )

overridevirtual

Allow this plugin to perform any pre-initialization operations.

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

Reimplemented from chrono::vsg3d::ChVisualSystemVSGPlugin.

OnRender()

void chrono::gpu::ChGpuVisualizationVSG::OnRender ( )

overridevirtual

Allow this plugin to perform any pre-rendering operations.

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

Reimplemented from chrono::vsg3d::ChVisualSystemVSGPlugin.

SetColorCallback()

void chrono::gpu::ChGpuVisualizationVSG::SetColorCallback	(	std::shared_ptr< ParticleColorCallback >	functor,
		ChColormap::Type	type = ChColormap::Type::JET
	)

Set a callback for dynamic coloring of SPH particles.

If none provided, SPH particles are rendered with a default color.

SetVisibilityCallback()

void chrono::gpu::ChGpuVisualizationVSG::SetVisibilityCallback ( std::shared_ptr< ParticleVisibilityCallback >  functor )

inline

Set a callback for dynamic visibility of SPH particles.

If none provided, all SPH particles are visible.

---

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

• /builds/uwsbel/chrono/src/chrono_gpu/visualization/ChGpuVisualizationVSG.h
• /builds/uwsbel/chrono/src/chrono_gpu/visualization/ChGpuVisualizationVSG.cpp