Represents a light source in the scene graph. More...
#include <ignition/rendering/Light.hh>
Public Member Functions | |
virtual | ~Light () |
Deconstructor. More... | |
virtual double | AttenuationConstant () const =0 |
Get the attenuation constant value. More... | |
virtual double | AttenuationLinear () const =0 |
Get the attenuation linear value. More... | |
virtual double | AttenuationQuadratic () const =0 |
Get the attenuation quadratic value. More... | |
virtual double | AttenuationRange () const =0 |
Get the attenuation ranage. More... | |
virtual bool | CastShadows () const =0 |
Determine if this light cast shadows. More... | |
virtual math::Color | DiffuseColor () const =0 |
Get the diffuse color. More... | |
virtual void | SetAttenuationConstant (double _value)=0 |
Set the attenuation constant value. More... | |
virtual void | SetAttenuationLinear (double _value)=0 |
Set the attenuation linear value. More... | |
virtual void | SetAttenuationQuadratic (double _value)=0 |
Set the attenuation quadratic value. More... | |
virtual void | SetAttenuationRange (double _range)=0 |
Set the attenuation ranage. More... | |
virtual void | SetCastShadows (bool _castShadows)=0 |
Specify if this light should cast shadows. More... | |
virtual void | SetDiffuseColor (double _r, double _g, double _b, double _a=1.0)=0 |
Set the diffuse color. More... | |
virtual void | SetDiffuseColor (const math::Color &_color)=0 |
Set the diffuse color. More... | |
virtual void | SetSpecularColor (double _r, double _g, double _b, double _a=1.0)=0 |
Set the specular color. More... | |
virtual void | SetSpecularColor (const math::Color &_color)=0 |
Set the specular color. More... | |
virtual math::Color | SpecularColor () const =0 |
Get the specular color. More... | |
Public Member Functions inherited from Node | |
virtual | ~Node () |
Deconstructor. More... | |
virtual bool | HasParent () const =0 |
Determine if this Geometry is attached to a Visual. More... | |
virtual math::Pose3d | LocalPose () const =0 |
Get the local pose. More... | |
virtual math::Vector3d | LocalPosition () const =0 |
Get the local position. More... | |
virtual math::Quaterniond | LocalRotation () const =0 |
Get the local rotation. More... | |
virtual math::Vector3d | Origin () const =0 |
Get position of origin. More... | |
virtual VisualPtr | Parent () const =0 |
Get the parent Visual. More... | |
virtual void | RemoveParent ()=0 |
Detach this Geometry from its parent Visual. If this Geometry does not have a parent, no work will be done. More... | |
virtual void | SetLocalPose (const math::Pose3d &_pose)=0 |
Set the local pose. More... | |
virtual void | SetLocalPosition (double _x, double _y, double _z)=0 |
Set the local position. More... | |
virtual void | SetLocalPosition (const math::Vector3d &_position)=0 |
Set the local position. More... | |
virtual void | SetLocalRotation (double _r, double _p, double _y)=0 |
Set the local rotation. More... | |
virtual void | SetLocalRotation (double _w, double _x, double _y, double _z)=0 |
Set the local rotation. More... | |
virtual void | SetLocalRotation (const math::Quaterniond &_rotation)=0 |
Set the local rotation. More... | |
virtual void | SetOrigin (double _x, double _y, double _z)=0 |
Set position of origin. The position should be relative to the original origin of the geometry. More... | |
virtual void | SetOrigin (const math::Vector3d &_origin)=0 |
Set position of origin. The position should be relative to the original origin of the geometry. More... | |
virtual void | SetWorldPose (const math::Pose3d &_pose)=0 |
Set the world pose. More... | |
virtual void | SetWorldPosition (double _x, double _y, double _z)=0 |
Set the world position. More... | |
virtual void | SetWorldPosition (const math::Vector3d &_position)=0 |
Set the world position. More... | |
virtual void | SetWorldRotation (double _r, double _p, double _y)=0 |
Set the world rotation. More... | |
virtual void | SetWorldRotation (double _w, double _x, double _y, double _z)=0 |
Set the world rotation. More... | |
virtual void | SetWorldRotation (const math::Quaterniond &_rotation)=0 |
Set the world rotation. More... | |
virtual math::Pose3d | WorldPose () const =0 |
Get the world pose. More... | |
virtual math::Vector3d | WorldPosition () const =0 |
Get the world position. More... | |
virtual math::Quaterniond | WorldRotation () const =0 |
Get the world rotation. More... | |
virtual math::Pose3d | WorldToLocal (const math::Pose3d &_pose) const =0 |
Convert given world pose to local pose. More... | |
Public Member Functions inherited from Object | |
virtual | ~Object () |
Deconstructor. More... | |
virtual void | Destroy ()=0 |
Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. More... | |
virtual unsigned int | Id () const =0 |
Get the object ID. This ID will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More... | |
virtual std::string | Name () const =0 |
Get the object name. This name will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More... | |
virtual void | PreRender ()=0 |
Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender. More... | |
virtual ScenePtr | Scene () const =0 |
Get the Scene that created this object. More... | |
Detailed Description
Represents a light source in the scene graph.
Constructor & Destructor Documentation
◆ ~Light()
|
inlinevirtual |
Deconstructor.
References Light::AttenuationConstant(), Light::AttenuationLinear(), Light::AttenuationQuadratic(), Light::AttenuationRange(), Light::CastShadows(), Light::DiffuseColor(), Light::SetAttenuationConstant(), Light::SetAttenuationLinear(), Light::SetAttenuationQuadratic(), Light::SetAttenuationRange(), Light::SetCastShadows(), Light::SetDiffuseColor(), Light::SetSpecularColor(), and Light::SpecularColor().
Member Function Documentation
◆ AttenuationConstant()
|
pure virtual |
Get the attenuation constant value.
- Returns
- The attenuation constant value
Implemented in OgreLight.
Referenced by Light::~Light().
◆ AttenuationLinear()
|
pure virtual |
Get the attenuation linear value.
- Returns
- The attenuation linear value
Implemented in OgreLight.
Referenced by Light::~Light().
◆ AttenuationQuadratic()
|
pure virtual |
Get the attenuation quadratic value.
- Returns
- The attenuation quadratic value
Implemented in OgreLight.
Referenced by Light::~Light().
◆ AttenuationRange()
|
pure virtual |
Get the attenuation ranage.
- Returns
- The attenuation ranage
Implemented in OgreLight.
Referenced by Light::~Light().
◆ CastShadows()
|
pure virtual |
Determine if this light cast shadows.
- Returns
- True if this light cast shadows
Implemented in OgreLight.
Referenced by Light::~Light().
◆ DiffuseColor()
|
pure virtual |
Get the diffuse color.
- Returns
- The diffuse color
Implemented in OgreLight.
Referenced by Light::~Light().
◆ SetAttenuationConstant()
|
pure virtual |
Set the attenuation constant value.
- Parameters
-
[in] _value New attenuation constant value
Implemented in OgreLight, BaseLight< T >, and BaseLight< OgreNode >.
Referenced by Light::~Light().
◆ SetAttenuationLinear()
|
pure virtual |
Set the attenuation linear value.
- Parameters
-
[in] _value New attenuation linear value
Implemented in OgreLight, BaseLight< T >, and BaseLight< OgreNode >.
Referenced by Light::~Light().
◆ SetAttenuationQuadratic()
|
pure virtual |
Set the attenuation quadratic value.
- Parameters
-
[in] _value New attenuation quadratic value
Implemented in OgreLight, BaseLight< T >, and BaseLight< OgreNode >.
Referenced by Light::~Light().
◆ SetAttenuationRange()
|
pure virtual |
Set the attenuation ranage.
- Parameters
-
[in] _value New attenuation ranage
Implemented in OgreLight, BaseLight< T >, and BaseLight< OgreNode >.
Referenced by Light::~Light().
◆ SetCastShadows()
|
pure virtual |
Specify if this light should cast shadows.
- Parameters
-
[in] _castShadows True if this light cast shadows
Implemented in OgreLight, BaseLight< T >, and BaseLight< OgreNode >.
Referenced by Light::~Light().
◆ SetDiffuseColor() [1/2]
|
pure virtual |
Set the diffuse color.
- Parameters
-
[in] _r Red value [in] _g Green value [in] _b Blue value [in] _a Alpha value
Implemented in BaseLight< T >, and BaseLight< OgreNode >.
Referenced by Light::~Light().
◆ SetDiffuseColor() [2/2]
|
pure virtual |
Set the diffuse color.
- Parameters
-
[in] _color New diffuse color
Implemented in OgreLight, BaseLight< T >, and BaseLight< OgreNode >.
◆ SetSpecularColor() [1/2]
|
pure virtual |
Set the specular color.
- Parameters
-
[in] _r Red value [in] _g Green value [in] _b Blue value [in] _a Alpha value
Implemented in BaseLight< T >, and BaseLight< OgreNode >.
Referenced by Light::~Light().
◆ SetSpecularColor() [2/2]
|
pure virtual |
Set the specular color.
- Parameters
-
[in] _color New specular color
Implemented in OgreLight, BaseLight< T >, and BaseLight< OgreNode >.
◆ SpecularColor()
|
pure virtual |
Get the specular color.
- Returns
- The specular color
Implemented in OgreLight.
Referenced by Light::~Light().
The documentation for this class was generated from the following file: