Visual Servoing Platform  version 3.6.1 under development (2024-11-21)

#include <visp3/ar/vpPanda3DLight.h>

+ Inheritance diagram for vpPanda3DPointLight:

Public Member Functions

 vpPanda3DPointLight (const std::string &name, const vpRGBf &color, const vpColVector &position, const vpColVector &attenuation)
 
void addToScene (NodePath &scene) const VP_OVERRIDE
 
const std::string & getName () const
 
const vpRGBfgetColor () const
 

Protected Attributes

std::string m_name
 
vpRGBf m_color
 

Detailed Description

Class representing a Point Light.

Point lights emit light all around them, from a single point. Their light can be subject to a distance-based attenuation.

Examples
tutorial-panda3d-renderer.cpp.

Definition at line 131 of file vpPanda3DLight.h.

Constructor & Destructor Documentation

◆ vpPanda3DPointLight()

vpPanda3DPointLight::vpPanda3DPointLight ( const std::string &  name,
const vpRGBf color,
const vpColVector position,
const vpColVector attenuation 
)
inline

Build a new point light.

See also
vpPanda3DLight constructor.
Parameters
namename of the light
colorcolor of the light
positionPosition in the scene of the light. Uses ViSP coordinates.
attenuationAttenuation components of the light as a function of distance. Should be a vector of size 3 where the first component is the constant intensity factor (no falloff), the second is a linear falloff coefficient, and the last one is the quadratic falloff component. To follow the inverse square law, set this value vector to [0, 0, 1] To have no falloff, set it to [1, 0, 0].

Definition at line 148 of file vpPanda3DLight.h.

References vpException::dimensionError, and vpArray2D< Type >::size().

Member Function Documentation

◆ addToScene()

void vpPanda3DPointLight::addToScene ( NodePath &  scene) const
inlinevirtual

Add the light to the scene.

Parameters
sceneScene where the light should be added.

Implements vpPanda3DLight.

Definition at line 162 of file vpPanda3DLight.h.

◆ getColor()

const vpRGBf& vpPanda3DLight::getColor ( ) const
inlineinherited

Get the light's color.

Returns
const vpRGBf&

Definition at line 84 of file vpPanda3DLight.h.

◆ getName()

const std::string& vpPanda3DLight::getName ( ) const
inlineinherited

Get the name of the light.

This name should be unique and will be required when interacting with Panda3D to fetch the node.

Definition at line 78 of file vpPanda3DLight.h.

Member Data Documentation

◆ m_color

vpRGBf vpPanda3DLight::m_color
protectedinherited

Name of the light. Should be unique in the scene.

Definition at line 95 of file vpPanda3DLight.h.

◆ m_name

std::string vpPanda3DLight::m_name
protectedinherited

Definition at line 94 of file vpPanda3DLight.h.