chrono::fsi::ChFsiVisualizationVSG Class Reference
Description
Run-time visualization support for Chrono::FSI systems.
Requires the Chrono::VSG module. Note that using run-time visualization for a Chrono::FSI system incurs the penalty of collecting positions of all particles every time the Render() function is invoked.
#include <ChFsiVisualizationVSG.h>
Inheritance diagram for chrono::fsi::ChFsiVisualizationVSG:
Collaboration diagram for chrono::fsi::ChFsiVisualizationVSG:
Public Member Functions | |
| ChFsiVisualizationVSG (ChSystemFsi *sysFSI) | |
| Create a run-time FSI visualization object associated with a given Chrono::Fsi system. | |
| virtual void | SetTitle (const std::string &title) override |
| Set title of the visualization window (default: ""). | |
| virtual void | SetSize (int width, int height) override |
| Set window dimensions (default: 1280x720). | |
| virtual void | AddCamera (const ChVector3d &pos, const ChVector3d &target) override |
| Add a camera initially at the specified position and target (look at) point. | |
| virtual void | UpdateCamera (const ChVector3d &pos, const ChVector3d &target) override |
| Set camera position and target (look at) point. | |
| virtual void | SetCameraVertical (CameraVerticalDir up) override |
| Set camera up vector (default: Z). | |
| virtual void | SetCameraMoveScale (float scale) override |
| Set scale for camera movement increments (default: 0.1). | |
| virtual void | SetParticleRenderMode (RenderMode mode) override |
| Set rendering mode for SPH particles (default: SOLID). More... | |
| virtual void | SetRenderMode (RenderMode mode) override |
| Set rendering mode for mesh objects (default: WIREFRAME). | |
| void | SetUseSkyBox (bool val) |
| Enable/disable use of shy box textures (default: false). | |
| void | SetClearColor (const ChColor &color) |
| Set background color. | |
| virtual void | EnableInfoOverlay (bool val) override |
| Enable/disable information overlay (default: false). | |
| virtual void | Initialize () override |
| Initialize the run-time visualization system. | |
| virtual bool | Render () override |
| Render the current state of the Chrono::Fsi system. More... | |
| virtual ChVisualSystem * | GetVisualSystem () const override |
| Return the underlying VSG visualization system. | |
 Public Member Functions inherited from chrono::fsi::ChFsiVisualization | |
| ChFsiVisualization (ChSystemFsi *sysFSI) | |
| Create a run-time FSI visualization object associated with a given Chrono::Fsi system. | |
| void | SetVerbose (bool verbose) |
| Enable/disable information terminal output during initialization (default: false). | |
| void | SetColorFluidMarkers (const ChColor &col) |
| Set default color for fluid SPH particles (default: [0.10, 0.40, 0.65]). | |
| void | SetColorBoundaryMarkers (const ChColor &col) |
| Set default color for boundary BCE markers (default: [0.65, 0.30, 0.03]). | |
| void | SetColorRigidBodyMarkers (const ChColor &col) |
| Set default color for rigid body BCE markers (default: [0.10, 0.60, 0.30]). | |
| void | SetColorFlexBodyMarkers (const ChColor &col) |
| Set default color for flex body BCE markers (default: [0.40, 0.10, 0.65]). | |
| void | SetSPHColorCallback (std::shared_ptr< ChParticleCloud::ColorCallback > functor) |
| Set a callback for dynamic coloring of SPH particles. More... | |
| void | SetSPHVisibilityCallback (std::shared_ptr< ChParticleCloud::VisibilityCallback > functor) |
| Set a callback for dynamic visibility of SPH particles. More... | |
| void | SetBCEVisibilityCallback (std::shared_ptr< ChParticleCloud::VisibilityCallback > functor) |
| Set a callback for dynamic visibility of boundary BCE markers. 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 | EnableFluidMarkers (bool val) |
| Enable/disable rendering of fluid SPH particles (default: true). | |
| void | EnableRigidBodyMarkers (bool val) |
| Enable/disable rendering of rigid-body BCE markers (default: true). | |
| void | EnableFlexBodyMarkers (bool val) |
| Enable/disable rendering of flex-body BCE markers (default: true). | |
| void | EnableBoundaryMarkers (bool val) |
| Enable/disable rendering of boundary BCE markers (default: false). | |
| void | AttachSystem (ChSystem *system) |
| Attach a user-provided Chrono system for rendering. More... | |
| 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. | |
Friends | |
| class | FSIStatsVSG |
Additional Inherited Members | |
| Public Types inherited from chrono::fsi::ChFsiVisualization | |
| enum | RenderMode { POINTS, WIREFRAME, SOLID } |
| Rendering mode for particles and mesh objects. | |
| Protected Attributes inherited from chrono::fsi::ChFsiVisualization | |
| ChSystemFsi * | m_systemFSI |
| associated Chrono::FSI system | |
| ChSystem * | m_system |
| internal Chrono system (holds proxies) | |
| ChSystem * | m_user_system |
| optional user-provided system | |
| bool | m_sph_markers |
| render fluid SPH particles? | |
| bool | m_bndry_bce_markers |
| render boundary BCE markers? | |
| bool | m_rigid_bce_markers |
| render rigid-body BCE markers? | |
| bool | m_flex_bce_markers |
| render flex-body markers? | |
| std::shared_ptr< ChParticleCloud > | m_sph_cloud |
| particle cloud proxy for SPH particles | |
| std::shared_ptr< ChParticleCloud > | m_bndry_bce_cloud |
| particle cloud proxy for boundary BCE markers | |
| std::shared_ptr< ChParticleCloud > | m_rigid_bce_cloud |
| particle cloud proxy for BCE markers on rigid bodies | |
| std::shared_ptr< ChParticleCloud > | m_flex_bce_cloud |
| particle cloud proxy for BCE markers on flex bodies | |
| ChColor | m_sph_color |
| color for SPH particles | |
| ChColor | m_bndry_bce_color |
| color for boundary BCE markers | |
| ChColor | m_rigid_bce_color |
| color for BCE markers on rigid bodies | |
| ChColor | m_flex_bce_color |
| color for BCE markers on flex bodies | |
| std::shared_ptr< ChParticleCloud::ColorCallback > | m_color_fun |
| color functor for SPH particles | |
| std::shared_ptr< ChParticleCloud::VisibilityCallback > | m_vis_sph_fun |
| visibility functor for SPH particles | |
| std::shared_ptr< ChParticleCloud::VisibilityCallback > | m_vis_bndry_fun |
| visibility functor for bndry BCE markers | |
| bool | m_write_images |
| if true, save snapshots | |
| std::string | m_image_dir |
| directory for image files | |
Member Function Documentation
◆ Render()
|
overridevirtual |
Render the current state of the Chrono::Fsi system.
This function, typically invoked from within the main simulation loop, can only be called after construction of the FSI system was completed (i.e., the system was initialized). This function querries the positions of all particles in the FSI system in order to update the positions of the proxy bodies. Returns false if the visualization window was closed.
Implements chrono::fsi::ChFsiVisualization.
◆ SetParticleRenderMode()
|
overridevirtual |
Set rendering mode for SPH particles (default: SOLID).
Must be called before Initialize().
Reimplemented from chrono::fsi::ChFsiVisualization.
The documentation for this class was generated from the following files:
- /builds/uwsbel/chrono/src/chrono_fsi/visualization/ChFsiVisualizationVSG.h
- /builds/uwsbel/chrono/src/chrono_fsi/visualization/ChFsiVisualizationVSG.cpp
