This class is the base class for all spot lights. More...

#include <SpotLight.h>

Inheritance diagram for Ocean::Rendering::SpotLight:

Public Member Functions
virtual Vector3	direction () const
	Returns the direction of this directional light.

virtual Scalar	coneAngle () const
	Returns the angle of the light cone in radian.

virtual Scalar	spotExponent () const
	Returns the sharpness of the spot as fall off exponent.

virtual void	setDirection (const Vector3 &direction)
	Sets the direction of this directional light.

virtual bool	setConeAngle (const Scalar angle)
	Sets the angle of the light cone in radian.

virtual bool	setSpotExponent (const Scalar exponent)
	Sets the sharpness of the spot as fall off exponent.

ObjectType	type () const override
	Returns the type of this object.

Public Member Functions inherited from Ocean::Rendering::PointLight
virtual Vector3	position () const
	Returns the position of the light object.

virtual Vector3	attenuation () const
	Returns the attenuation factors of the point light.

virtual void	setPosition (const Vector3 &position)
	Sets the position of the light object.

virtual bool	setAttenuation (const Vector3 &factors)
	Sets the attenuation factors for the point light.

Public Member Functions inherited from Ocean::Rendering::LightSource
virtual RGBAColor	ambientColor () const
	Returns the ambient color of this light source.

virtual RGBAColor	diffuseColor () const
	Returns the diffuse color of this light source.

virtual RGBAColor	specularColor () const
	Returns the specular color of this light source.

virtual Scalar	intensity () const
	Returns the intensity of this light source.

virtual TransformationType	transformationType () const
	Returns the transformation type of this light.

virtual bool	enabled () const
	Returns whether this light source is enabled.

virtual void	get (RGBAColor &ambient, RGBAColor &diffuse, RGBAColor &specular, Scalar &intensity)
	Gets all color values of the light at once.

virtual bool	setAmbientColor (const RGBAColor &color)
	Sets the ambient color of the light source.

virtual bool	setDiffuseColor (const RGBAColor &color)
	Sets the diffuse color of the light source.

virtual bool	setSpecularColor (const RGBAColor &color)
	Sets the specular color of the light source.

virtual bool	setIntensity (const Scalar intensity)
	Sets the specular exponent of this material.

virtual bool	set (const RGBAColor &ambient, const RGBAColor &diffuse, const RGBAColor &specular, const Scalar intensity)
	Sets all color values of the light source at once.

virtual void	setTransformationType (const TransformationType transformationType)
	Sets the transformation type of this light.

virtual void	setEnabled (const bool state)
	Sets whether the light source is enabled.

Public Member Functions inherited from Ocean::Rendering::Object
ObjectId	id () const
	Returns the unique object id of this object.

const std::string &	name () const
	Returns the name of this object.

virtual void	setName (const std::string &name)
	Sets or changes the name of this object.

virtual const std::string &	engineName () const =0
	Returns the name of the owner engine.

ObjectRefs	parentObjects () const
	Returns all parent objects.

ObjectRefSet	parentNodes () const
	Returns all parent nodes.

virtual std::string	descriptiveInformation () const
	Returns descriptive information about the object as string.

Protected Member Functions
	SpotLight ()
	Creates a new sport light.

	~SpotLight () override
	Destructs a spot light.

Protected Member Functions inherited from Ocean::Rendering::PointLight
	PointLight ()
	Creates a new point light.

	~PointLight () override
	Destructs a point light.

Protected Member Functions inherited from Ocean::Rendering::LightSource
	LightSource ()
	Creates a new light source object.

	~LightSource () override
	Destructs a light source object.

Protected Member Functions inherited from Ocean::Rendering::Object
	Object ()
	Creates a new object.

	Object (const Object &object)=delete
	Disabled copy constructor.

virtual	~Object ()
	Destructs an object.

Engine &	engine () const
	Returns the render engine which is owner of this object.

void	registerParent (const ObjectId parentId)
	Registers a parent node for this (child) node.

void	unregisterParent (const ObjectId parentId)
	Unregisters a parent node for this (child) node.

void	registerThisObjectAsParent (const ObjectRef &child)
	Registers this object at a child as parent object.

void	unregisterThisObjectAsParent (const ObjectRef &child)
	Unregisters this object from a child as parent.

Object &	operator= (const Object &object)=delete
	Disabled copy operator.

Additional Inherited Members
Public Types inherited from Ocean::Rendering::LightSource
enum	TransformationType { TT_PARENT , TT_WORLD }
	Defines different transformation types. More...

Public Types inherited from Ocean::Rendering::Object
enum	ObjectType { TYPE_UNKNOWN , TYPE_ABSOLUTE_TRANSFORM , TYPE_ATTRIBUTE , TYPE_ATTRIBUTE_SET , TYPE_BACKGROUND , TYPE_BILLBOARD , TYPE_BITMAP_FRAMEBUFFER , TYPE_BLEND_ATTRIBUTE , TYPE_BOX , TYPE_CONE , TYPE_CYLINDER , TYPE_DEPTH_ATTRIBUTE , TYPE_DIRECTIONAL_LIGHT , TYPE_FRAMEBUFFER , TYPE_FRAME_TEXTURE_2D , TYPE_GEOMETRY , TYPE_GROUP , TYPE_INDEPENDENT_PRIMITIVE , TYPE_LIGHT_SOURCE , TYPE_LINES , TYPE_LINE_STRIPS , TYPE_LOD , TYPE_MATERIAL , TYPE_NODE , TYPE_OBJECT , TYPE_PARALLEL_VIEW , TYPE_PERSPECTIVE_VIEW , TYPE_PHANTOM_ATTRIBUTE , TYPE_POINT_LIGHT , TYPE_POINTS , TYPE_PRIMITIVE , TYPE_PRIMITIVE_ATTRIBUTE , TYPE_QUAD_STRIPS , TYPE_QUADS , TYPE_RENDERABLE , TYPE_SCENE , TYPE_SHADER_PROGRAM , TYPE_SHAPE , TYPE_SKY_BACKGROUND , TYPE_SPHERE , TYPE_SPOT_LIGHT , TYPE_STEREO_ATTRIBUTE , TYPE_STEREO_VIEW , TYPE_STRIP_PRIMITIVE , TYPE_SWITCH , TYPE_TEXT , TYPE_TEXTURE , TYPE_TEXTURE_2D , TYPE_MEDIA_TEXTURE_2D , TYPE_TEXTURE_FRAMEBUFFER , TYPE_TEXTURES , TYPE_TRANSFORM , TYPE_TRIANGLE_FANS , TYPE_TRIANGLES , TYPE_TRIANGLE_STRIPS , TYPE_UNDISTORTED_BACKGROUND , TYPE_VERTEX_SET , TYPE_VIEW , TYPE_WINDOW_FRAMEBUFFER }
	Definition of different object type. More...

typedef std::unordered_map< ObjectId, unsigned int >	ObjectIdMap
	Definition of a map holding object ids to reference counters.

Static Public Member Functions inherited from Ocean::Rendering::Object
static std::string	translateObjectType (const ObjectType objectType)
	Translates an object type to a readable string.

Protected Attributes inherited from Ocean::Rendering::Object
Lock	objectLock
	Lock for the object.

Detailed Description

This class is the base class for all spot lights.

Constructor & Destructor Documentation

◆ SpotLight()

Ocean::Rendering::SpotLight::SpotLight ( )

protected

Creates a new sport light.

◆ ~SpotLight()

Ocean::Rendering::SpotLight::~SpotLight ( )

overrideprotected

Destructs a spot light.

Member Function Documentation

◆ coneAngle()

virtual Scalar Ocean::Rendering::SpotLight::coneAngle ( ) const

virtual

Returns the angle of the light cone in radian.

Objects outside this cone are unlit.

Returns: Angle of light cone in radian with range [0.0, Pi / 2]

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESSpotLight, and Ocean::Rendering::GlobalIllumination::GISpotLight.

◆ direction()

virtual Vector3 Ocean::Rendering::SpotLight::direction ( ) const

virtual

Returns the direction of this directional light.

The default value is (0, 0, -1).

Returns: Light direction

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESSpotLight, and Ocean::Rendering::GlobalIllumination::GISpotLight.

◆ setConeAngle()

virtual bool Ocean::Rendering::SpotLight::setConeAngle ( const Scalar angle )

virtual

Sets the angle of the light cone in radian.

Objects outside this conde are unlit.

Returns: True, if the angle is valid and could be set

Parameters

angle Angle of the light cone in radian with range [0.0, Pi / 2]

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESSpotLight, and Ocean::Rendering::GlobalIllumination::GISpotLight.

◆ setDirection()

virtual void Ocean::Rendering::SpotLight::setDirection ( const Vector3 & direction )

virtual

Sets the direction of this directional light.

The default value is (0, 0, -1).

Parameters

direction Direction to set

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESSpotLight, and Ocean::Rendering::GlobalIllumination::GISpotLight.

◆ setSpotExponent()

virtual bool Ocean::Rendering::SpotLight::setSpotExponent ( const Scalar exponent )

virtual

Sets the sharpness of the spot as fall off exponent.

Parameters

exponent Sharpness exponent to set with range [0.0, 1.0]

Returns: True, if the value is valid and could be set

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESSpotLight, and Ocean::Rendering::GlobalIllumination::GISpotLight.

◆ spotExponent()

virtual Scalar Ocean::Rendering::SpotLight::spotExponent ( ) const

virtual

Returns the sharpness of the spot as fall off exponent.

Returns: Spot exponent

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESSpotLight, and Ocean::Rendering::GlobalIllumination::GISpotLight.

◆ type()

ObjectType Ocean::Rendering::SpotLight::type ( ) const

overridevirtual

Returns the type of this object.

See also: Object::type().

Reimplemented from Ocean::Rendering::PointLight.

The documentation for this class was generated from the following file:

rendering/SpotLight.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SpotLight()

◆ ~SpotLight()

Member Function Documentation

◆ coneAngle()

◆ direction()

◆ setConeAngle()

◆ setDirection()

◆ setSpotExponent()

◆ spotExponent()

◆ type()