Description

Base class for assets that define something about visualization (rendering, post processing, etc.) It contains basic information about position, color, and visibility.

#include <ChVisualization.h>

Inheritance diagram for chrono::ChVisualization:
Collaboration diagram for chrono::ChVisualization:

Public Member Functions

void SetVisible (bool mv)
 Set this visualization asset as visible.
 
bool IsVisible () const
 Return true if the asset is set as visible.
 
void SetColor (const ChColor &mc)
 Set the color of the surface (default: white). More...
 
const ChColorGetColor () const
 Return the color assigned to this asset.
 
void SetFading (const float mc)
 Set the fading level, a value in [0,1] (default: 0). More...
 
float GetFading () const
 Get the fading level.
 
void SetStatic (bool val)
 Set this visualization asset as static (default: false). More...
 
bool IsStatic () const
 Return true if the visualization asset is marked as static.
 
- Public Member Functions inherited from chrono::ChAsset
virtual void Update (ChPhysicsItem *updater, const ChCoordsys<> &coords)
 This is called by the owner, i.e. More...
 

Public Attributes

ChVector Pos
 Position of Asset.
 
ChMatrix33 Rot
 Rotation of Asset.
 

Protected Member Functions

virtual void ArchiveOUT (ChArchiveOut &marchive) override
 Method to allow serialization of transient data to archives.
 
virtual void ArchiveIN (ChArchiveIn &marchive) override
 Method to allow de-serialization of transient data from archives.
 

Protected Attributes

bool visible
 
bool is_static
 
ChColor color
 
float fading
 

Member Function Documentation

◆ SetColor()

void chrono::ChVisualization::SetColor ( const ChColor mc)
inline

Set the color of the surface (default: white).

This information can optionally be used by a visualization system.

◆ SetFading()

void chrono::ChVisualization::SetFading ( const float  mc)
inline

Set the fading level, a value in [0,1] (default: 0).

If fading = 0, the surface is completely opaque. If fading = 1, the surface is completely transparent.

◆ SetStatic()

void chrono::ChVisualization::SetStatic ( bool  val)
inline

Set this visualization asset as static (default: false).

Set to true to indicate that the asset never changes and therefore does not require updates (e.g. for a non-deformable triangular mesh). A particular visualization system may take advantage of this setting to accelerate rendering.


The documentation for this class was generated from the following files:
  • /builds/uwsbel/chrono/src/chrono/assets/ChVisualization.h
  • /builds/uwsbel/chrono/src/chrono/assets/ChVisualization.cpp