chrono::vehicle::ChScmVisualizationVSG Class Reference

Description

VSG-based run-time visualization system for SCM terrain.

Used as a plugin to a Chrono::VSG visualization system.

#include <ChScmVisualizationVSG.h>

Inheritance diagram for chrono::vehicle::ChScmVisualizationVSG:

Collaboration diagram for chrono::vehicle::ChScmVisualizationVSG:

Public Types
enum	RenderMode { POINTS, WIREFRAME, SOLID }
	Rendering mode for particles and mesh objects.

Public Member Functions
	ChScmVisualizationVSG (SCMTerrain *scm)
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	SetActiveBoxVisibility (bool vis, int tag)
	Set the visibility of active boxes with specified tag to the provided value. 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	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	SCMStatsVSG

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::vehicle::ChScmVisualizationVSG::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::vehicle::ChScmVisualizationVSG::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::vehicle::ChScmVisualizationVSG::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::vehicle::ChScmVisualizationVSG::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::vehicle::ChScmVisualizationVSG::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.

SetActiveBoxVisibility()

void chrono::vehicle::ChScmVisualizationVSG::SetActiveBoxVisibility	(	bool	vis,
		int	tag
	)

Set the visibility of active boxes with specified tag to the provided value.

A tag value of -1 indicates that the visibility flag should be applied to all boxes.

---

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

• /builds/uwsbel/chrono/src/chrono_vehicle/visualization/ChScmVisualizationVSG.h
• /builds/uwsbel/chrono/src/chrono_vehicle/visualization/ChScmVisualizationVSG.cpp