chrono::vsg3d::ChGuiComponentVSG Class Reference

Description

Base class for a GUI component for the VSG run-time visualization system.

#include <ChGuiComponentVSG.h>

Inherited by chrono::dem::DEMStatsVSG, chrono::fsi::sph::FSISPHStatsVSG, chrono::fsi::tdpf::FSITDPFStatsVSG, chrono::parsers::ChParserURDFStats, chrono::vehicle::ChSTRGuiComponentVSG, chrono::vehicle::ChTTRGuiComponentVSG, chrono::vehicle::ChVehicleGuiComponentVSG, chrono::vehicle::SCMStatsVSG, chrono::vsg3d::ChBaseGuiComponentVSG, chrono::vsg3d::ChCameraGuiComponentVSG, and chrono::vsg3d::ChColorbarGuiComponentVSG.

Collaboration diagram for chrono::vsg3d::ChGuiComponentVSG:

Public Member Functions
virtual void	Initialize ()
	Allow the GUI component to initialize itself. More...
virtual void	render (vsg::CommandBuffer &cb)=0
	Specify the ImGui elements to be rendered for this GUI component.
void	SetVisibility (bool visible)
	Set visibility for this GUI component.
void	ToggleVisibility ()
	Toggle GUI visibility for this GUI component.
bool	IsVisible () const
	Return boolean indicating whether or not this GUI component visible.

Static Public Member Functions
static void	DrawGauge (float val, float v_min, float v_max)
	Utility function to draw a gauge.
static void	Colorbar (vsg::ref_ptr< vsgImGui::Texture > texture, const ChVector2d &range, bool bimodal, float width, uint32_t deviceID)
	Utility function to draw a colorbar (colormap legend).
static void	HelpMarker (const char *desc)
	Utility function to display a (?) mark which shows a tooltip when hovered.

Static Public Attributes
static constexpr float	GUI_PADDING = 5.0f
	Padding between a GUI panel and the VSG window margin.

Protected Attributes
bool	m_visible
ChVisualSystemVSG *	m_vsys

Friends
class	ChVisualSystemVSG

Member Function Documentation

Initialize()

virtual void chrono::vsg3d::ChGuiComponentVSG::Initialize ( )

inlinevirtual

Allow the GUI component to initialize itself.

This function is called after the main GUI container is created.

---

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

• /builds/uwsbel/chrono/src/chrono_vsg/ChGuiComponentVSG.h
• /builds/uwsbel/chrono/src/chrono_vsg/ChGuiComponentVSG.cpp