chrono::sensor::ChScene Class Reference

Description

Scene class used for camera renderings. Includes environment colors, lights, etc.

#include <ChScene.h>

Public Member Functions

 ChScene ()
 Class constructor.
 
 ~ChScene ()
 Class destructor.
 
void AddPointLight (ChVector< float > pos, ChVector< float > color, float max_range)
 Add a point light that emits light in all directions. More...
 
std::vector< PointLight > & GetPointLights ()
 Function for gaining access to the vector of point lights and can be used to modify lighting dynamically. More...
 
Background & GetBackground ()
 Function for gaining access to the background. More...
 

Member Function Documentation

◆ AddPointLight()

void chrono::sensor::ChScene::AddPointLight ( ChVector< float >  pos,
ChVector< float >  color,
float  max_range 
)

Add a point light that emits light in all directions.

Parameters
posThe global position of the light source
colorThe golor of the light source
max_rangethe range at which the light intensity is equal to 1% of its maximum intensity

◆ GetBackground()

Background& chrono::sensor::ChScene::GetBackground ( )
inline

Function for gaining access to the background.

Can be used to dynamically change the background color, or texture

Returns
m_background A reference to the scene background used for rendering

◆ GetPointLights()

std::vector<PointLight>& chrono::sensor::ChScene::GetPointLights ( )
inline

Function for gaining access to the vector of point lights and can be used to modify lighting dynamically.

Returns
m_pointlights A reference to the vector of point lights

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