Urho3D::Light Class Reference

Light component. More...

#include </home/runner/work/urho3d-doxygen.github.io/urho3d-doxygen.github.io/urho3d_repo/Source/Urho3D/Graphics/Light.h>

Inheritance diagram for Urho3D::Light:

Public Member Functions
	Light (Context *context)
	Construct.
	~Light () override
	Destruct.
void	ProcessRayQuery (const RayOctreeQuery &query, Vector< RayQueryResult > &results) override
	Process octree raycast. May be called from a worker thread. More...
void	UpdateBatches (const FrameInfo &frame) override
	Calculate distance and prepare batches for rendering. May be called from worker thread(s), possibly re-entrantly. More...
void	DrawDebugGeometry (DebugRenderer *debug, bool depthTest) override
	Visualize the component as debug geometry. More...
void	SetLightType (LightType type)
	Set light type.
void	SetPerVertex (bool enable)
	Set vertex lighting mode.
void	SetColor (const Color &color)
	Set color.
void	SetTemperature (float temperature)
	Set temperature of the light in Kelvin. Modulates the light color when "use physical values" is enabled.
void	SetRadius (float radius)
	Set area light radius. Greater than zero activates area light mode. Works only with PBR shaders.
void	SetLength (float length)
	Set tube area light length. Works only with PBR shaders.
void	SetUsePhysicalValues (bool enable)
	Set use physical light values.
void	SetSpecularIntensity (float intensity)
	Set specular intensity. Zero disables specular calculations.
void	SetBrightness (float brightness)
	Set light brightness multiplier. Both the color and specular intensity are multiplied with this. When "use physical values" is enabled, the value is specified in lumens.
void	SetRange (float range)
	Set range.
void	SetFov (float fov)
	Set spotlight field of view.
void	SetAspectRatio (float aspectRatio)
	Set spotlight aspect ratio.
void	SetFadeDistance (float distance)
	Set fade out start distance.
void	SetShadowFadeDistance (float distance)
	Set shadow fade out start distance. Only has effect if shadow distance is also non-zero.
void	SetShadowBias (const BiasParameters &parameters)
	Set shadow depth bias parameters.
void	SetShadowCascade (const CascadeParameters &parameters)
	Set directional light cascaded shadow parameters.
void	SetShadowFocus (const FocusParameters &parameters)
	Set shadow map focusing parameters.
void	SetShadowIntensity (float intensity)
	Set light intensity in shadow between 0.0 - 1.0. 0.0 (the default) gives fully dark shadows.
void	SetShadowResolution (float resolution)
	Set shadow resolution between 0.25 - 1.0. Determines the shadow map to use.
void	SetShadowNearFarRatio (float nearFarRatio)
	Set shadow camera near/far clip distance ratio for spot and point lights. Does not affect directional lights, since they are orthographic and have near clip 0.
void	SetShadowMaxExtrusion (float extrusion)
	Set maximum shadow extrusion for directional lights. The actual extrusion will be the smaller of this and camera far clip. Default 1000.
void	SetRampTexture (Texture *texture)
	Set range attenuation texture.
void	SetShapeTexture (Texture *texture)
	Set spotlight attenuation texture.
LightType	GetLightType () const
	Return light type.
bool	GetPerVertex () const
	Return vertex lighting mode.
const Color &	GetColor () const
	Return color.
float	GetTemperature () const
	Return the temperature of the light in Kelvin.
float	GetRadius () const
	Return area light mode radius. Works only with PBR shaders.
float	GetLength () const
	Return area tube light length. Works only with PBR shaders.
bool	GetUsePhysicalValues () const
	Return if light uses temperature and brightness in lumens.
Color	GetColorFromTemperature () const
	Return the color value of the temperature in Kelvin.
float	GetSpecularIntensity () const
	Return specular intensity.
float	GetBrightness () const
	Return brightness multiplier. Specified in lumens when "use physical values" is enabled.
Color	GetEffectiveColor () const
	Return effective color, multiplied by brightness and affected by temperature when "use physical values" is enabled. Alpha is always 1 so that can compare against the default black color to detect a light with no effect.
float	GetEffectiveSpecularIntensity () const
	Return effective specular intensity, multiplied by absolute value of brightness.
float	GetRange () const
	Return range.
float	GetFov () const
	Return spotlight field of view.
float	GetAspectRatio () const
	Return spotlight aspect ratio.
float	GetFadeDistance () const
	Return fade start distance.
float	GetShadowFadeDistance () const
	Return shadow fade start distance.
const BiasParameters &	GetShadowBias () const
	Return shadow depth bias parameters.
const CascadeParameters &	GetShadowCascade () const
	Return directional light cascaded shadow parameters.
const FocusParameters &	GetShadowFocus () const
	Return shadow map focus parameters.
float	GetShadowIntensity () const
	Return light intensity in shadow.
float	GetShadowResolution () const
	Return shadow resolution.
float	GetShadowNearFarRatio () const
	Return shadow camera near/far clip distance ratio.
float	GetShadowMaxExtrusion () const
	Return maximum shadow extrusion distance for directional lights.
Texture *	GetRampTexture () const
	Return range attenuation texture.
Texture *	GetShapeTexture () const
	Return spotlight attenuation texture.
Frustum	GetFrustum () const
	Return spotlight frustum.
Frustum	GetViewSpaceFrustum (const Matrix3x4 &view) const
	Return spotlight frustum in the specified view space.
i32	GetNumShadowSplits () const
	Return number of shadow map cascade splits for a directional light, considering also graphics API limitations.
bool	IsNegative () const
	Return whether light has negative (darkening) color.
void	SetIntensitySortValue (float distance)
	Set sort value based on intensity and view distance.
void	SetIntensitySortValue (const BoundingBox &box)
	Set sort value based on overall intensity over a bounding box.
void	SetLightQueue (LightBatchQueue *queue)
	Set light queue used for this light. Called by View.
const Matrix3x4 &	GetVolumeTransform (Camera *camera)
	Return light volume model transform.
LightBatchQueue *	GetLightQueue () const
	Return light queue. Called by View.
float	GetIntensityDivisor (float attenuation=1.0f) const
	Return a divisor value based on intensity for calculating the sort value.
void	SetRampTextureAttr (const ResourceRef &value)
	Set ramp texture attribute.
void	SetShapeTextureAttr (const ResourceRef &value)
	Set shape texture attribute.
ResourceRef	GetRampTextureAttr () const
	Return ramp texture attribute.
ResourceRef	GetShapeTextureAttr () const
	Return shape texture attribute.
Public Member Functions inherited from Urho3D::Drawable
	Drawable (Context *context, DrawableTypes drawableType)
	Construct.
	~Drawable () override
	Destruct.
void	OnSetEnabled () override
	Handle enabled/disabled state change. More...
virtual void	ProcessRayQuery (const RayOctreeQuery &query, Vector< RayQueryResult > &results)
	Process octree raycast. May be called from a worker thread. More...
virtual void	Update (const FrameInfo &frame)
	Update before octree reinsertion. Is called from a worker thread. More...
virtual void	UpdateBatches (const FrameInfo &frame)
	Calculate distance and prepare batches for rendering. May be called from worker thread(s), possibly re-entrantly. More...
virtual void	UpdateGeometry (const FrameInfo &frame)
	Prepare geometry for rendering. More...
virtual UpdateGeometryType	GetUpdateGeometryType ()
	Return whether a geometry update is necessary, and if it can happen in a worker thread. More...
virtual Geometry *	GetLodGeometry (i32 batchIndex, i32 level)
	Return the geometry for a specific LOD level. More...
virtual i32	GetNumOccluderTriangles ()
	Return number of occlusion geometry triangles. More...
virtual bool	DrawOcclusion (OcclusionBuffer *buffer)
	Draw to occlusion buffer. Return true if did not run out of triangles. More...
void	DrawDebugGeometry (DebugRenderer *debug, bool depthTest) override
	Visualize the component as debug geometry. More...
void	SetDrawDistance (float distance)
	Set draw distance.
void	SetShadowDistance (float distance)
	Set shadow draw distance.
void	SetLodBias (float bias)
	Set LOD bias.
void	SetViewMask (mask32 mask)
	Set view mask. Is and'ed with camera's view mask to see if the object should be rendered.
void	SetLightMask (mask32 mask)
	Set light mask. Is and'ed with light's and zone's light mask to see if the object should be lit.
void	SetShadowMask (mask32 mask)
	Set shadow mask. Is and'ed with light's light mask and zone's shadow mask to see if the object should be rendered to a shadow map.
void	SetZoneMask (mask32 mask)
	Set zone mask. Is and'ed with zone's zone mask to see if the object should belong to the zone.
void	SetMaxLights (i32 num)
	Set maximum number of per-pixel lights. Default 0 is unlimited.
void	SetCastShadows (bool enable)
	Set shadowcaster flag.
void	SetOccluder (bool enable)
	Set occlusion flag.
void	SetOccludee (bool enable)
	Set occludee flag.
void	MarkForUpdate ()
	Mark for update and octree reinsertion. Update is automatically queued when the drawable's scene node moves or changes scale.
const BoundingBox &	GetBoundingBox () const
	Return local space bounding box. May not be applicable or properly updated on all drawables.
const BoundingBox &	GetWorldBoundingBox ()
	Return world-space bounding box.
DrawableTypes	GetDrawableType () const
	Return drawable type.
float	GetDrawDistance () const
	Return draw distance.
float	GetShadowDistance () const
	Return shadow draw distance.
float	GetLodBias () const
	Return LOD bias.
mask32	GetViewMask () const
	Return view mask.
mask32	GetLightMask () const
	Return light mask.
mask32	GetShadowMask () const
	Return shadow mask.
mask32	GetZoneMask () const
	Return zone mask.
i32	GetMaxLights () const
	Return maximum number of per-pixel lights.
bool	GetCastShadows () const
	Return shadowcaster flag.
bool	IsOccluder () const
	Return occluder flag.
bool	IsOccludee () const
	Return occludee flag.
bool	IsInView () const
	Return whether is in view this frame from any viewport camera. Excludes shadow map cameras.
bool	IsInView (Camera *camera) const
	Return whether is in view of a specific camera this frame. Pass in a null camera to allow any camera, including shadow map cameras.
const Vector< SourceBatch > &	GetBatches () const
	Return draw call source data.
void	SetZone (Zone *zone, bool temporary=false)
	Set new zone. Zone assignment may optionally be temporary, meaning it needs to be re-evaluated on the next frame.
void	SetSortValue (float value)
	Set sorting value.
void	SetMinMaxZ (float minZ, float maxZ)
	Set view-space depth bounds.
void	MarkInView (const FrameInfo &frame)
	Mark in view. Also clear the light list.
void	MarkInView (i32 frameNumber)
	Mark in view without specifying a camera. Used for shadow casters.
void	LimitLights ()
	Sort and limit per-pixel lights to maximum allowed. Convert extra lights into vertex lights.
void	LimitVertexLights (bool removeConvertedLights)
	Sort and limit per-vertex lights to maximum allowed.
void	SetBasePass (i32 batchIndex)
	Set base pass flag for a batch.
Octant *	GetOctant () const
	Return octree octant.
Zone *	GetZone () const
	Return current zone.
bool	IsZoneDirty () const
	Return whether current zone is inconclusive or dirty due to the drawable moving.
float	GetDistance () const
	Return distance from camera.
float	GetLodDistance () const
	Return LOD scaled distance from camera.
float	GetSortValue () const
	Return sorting value.
bool	IsInView (const FrameInfo &frame, bool anyCamera=false) const
	Return whether is in view on the current frame. Called by View.
bool	HasBasePass (i32 batchIndex) const
	Return whether has a base pass.
const Vector< Light * > &	GetLights () const
	Return per-pixel lights.
const Vector< Light * > &	GetVertexLights () const
	Return per-vertex lights.
Light *	GetFirstLight () const
	Return the first added per-pixel light.
float	GetMinZ () const
	Return the minimum view-space depth.
float	GetMaxZ () const
	Return the maximum view-space depth.
void	AddLight (Light *light)
	Add a per-pixel light affecting the object this frame.
void	AddVertexLight (Light *light)
	Add a per-vertex light affecting the object this frame.
Public Member Functions inherited from Urho3D::Component
	Component (Context *context)
	Construct.
	~Component () override
	Destruct.
virtual void	OnSetEnabled ()
	Handle enabled/disabled state change. More...
bool	Save (Serializer &dest) const override
	Save as binary data. Return true if successful. More...
bool	SaveXML (XMLElement &dest) const override
	Save as XML data. Return true if successful. More...
bool	SaveJSON (JSONValue &dest) const override
	Save as JSON data. Return true if successful. More...
void	MarkNetworkUpdate () override
	Mark for attribute check on the next network update. More...
virtual void	GetDependencyNodes (Vector< Node * > &dest)
	Return the depended on nodes to order network updates. More...
virtual void	DrawDebugGeometry (DebugRenderer *debug, bool depthTest)
	Visualize the component as debug geometry. More...
void	SetEnabled (bool enable)
	Set enabled/disabled state.
void	Remove ()
	Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
ComponentId	GetID () const
	Return ID.
bool	IsReplicated () const
	Return whether the component is replicated or local to a scene.
Node *	GetNode () const
	Return scene node.
Scene *	GetScene () const
	Return the scene the node belongs to.
bool	IsEnabled () const
	Return whether is enabled.
bool	IsEnabledEffective () const
	Return whether is effectively enabled (node is also enabled).
Component *	GetComponent (StringHash type) const
	Return component in the same scene node by type. If there are several, returns the first.
void	GetComponents (Vector< Component * > &dest, StringHash type) const
	Return components in the same scene node by type.
template<class T >
T *	GetComponent () const
	Template version of returning a component in the same scene node by type.
template<class T >
void	GetComponents (Vector< T * > &dest) const
	Template version of returning components in the same scene node by type.
void	AddReplicationState (ComponentReplicationState *state)
	Add a replication state that is tracking this component.
void	PrepareNetworkUpdate ()
	Prepare network update by comparing attributes and marking replication states dirty as necessary.
void	CleanupConnection (Connection *connection)
	Clean up all references to a network connection that is about to be removed.
Public Member Functions inherited from Urho3D::Animatable
	Animatable (Context *context)
	Construct.
	~Animatable () override
	Destruct.
bool	LoadXML (const XMLElement &source) override
	Load from XML data. Return true if successful. More...
bool	SaveXML (XMLElement &dest) const override
	Save as XML data. Return true if successful. More...
bool	LoadJSON (const JSONValue &source) override
	Load from JSON data. Return true if successful. More...
bool	SaveJSON (JSONValue &dest) const override
	Save as JSON data. Return true if successful. More...
void	SetAnimationEnabled (bool enable)
	Set automatic update of animation, default true.
void	SetAnimationTime (float time)
	Set time position of all attribute animations or an object animation manually. Automatic update should be disabled in this case.
void	SetObjectAnimation (ObjectAnimation *objectAnimation)
	Set object animation.
void	SetAttributeAnimation (const String &name, ValueAnimation *attributeAnimation, WrapMode wrapMode=WM_LOOP, float speed=1.0f)
	Set attribute animation.
void	SetAttributeAnimationWrapMode (const String &name, WrapMode wrapMode)
	Set attribute animation wrap mode.
void	SetAttributeAnimationSpeed (const String &name, float speed)
	Set attribute animation speed.
void	SetAttributeAnimationTime (const String &name, float time)
	Set attribute animation time position manually. Automatic update should be disabled in this case.
void	RemoveObjectAnimation ()
	Remove object animation. Same as calling SetObjectAnimation with a null pointer.
void	RemoveAttributeAnimation (const String &name)
	Remove attribute animation. Same as calling SetAttributeAnimation with a null pointer.
bool	GetAnimationEnabled () const
	Return animation enabled.
ObjectAnimation *	GetObjectAnimation () const
	Return object animation.
ValueAnimation *	GetAttributeAnimation (const String &name) const
	Return attribute animation.
WrapMode	GetAttributeAnimationWrapMode (const String &name) const
	Return attribute animation wrap mode.
float	GetAttributeAnimationSpeed (const String &name) const
	Return attribute animation speed.
float	GetAttributeAnimationTime (const String &name) const
	Return attribute animation time position.
void	SetObjectAnimationAttr (const ResourceRef &value)
	Set object animation attribute.
ResourceRef	GetObjectAnimationAttr () const
	Return object animation attribute.
Public Member Functions inherited from Urho3D::Serializable
	Serializable (Context *context)
	Construct.
	~Serializable () override
	Destruct.
virtual void	OnSetAttribute (const AttributeInfo &attr, const Variant &src)
	Handle attribute write access. Default implementation writes to the variable at offset, or invokes the set accessor.
virtual void	OnGetAttribute (const AttributeInfo &attr, Variant &dest) const
	Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor.
virtual const Vector< AttributeInfo > *	GetAttributes () const
	Return attribute descriptions, or null if none defined. More...
virtual const Vector< AttributeInfo > *	GetNetworkAttributes () const
	Return network replication attribute descriptions, or null if none defined.
virtual bool	Load (Deserializer &source)
	Load from binary data. Return true if successful. More...
virtual bool	Save (Serializer &dest) const
	Save as binary data. Return true if successful. More...
virtual bool	LoadXML (const XMLElement &source)
	Load from XML data. Return true if successful. More...
virtual bool	SaveXML (XMLElement &dest) const
	Save as XML data. Return true if successful. More...
virtual bool	LoadJSON (const JSONValue &source)
	Load from JSON data. Return true if successful. More...
virtual bool	SaveJSON (JSONValue &dest) const
	Save as JSON data. Return true if successful. More...
virtual void	ApplyAttributes ()
	Apply attribute changes that can not be applied immediately. Called after scene load or a network update. More...
virtual bool	SaveDefaultAttributes () const
	Return whether should save default-valued attributes into XML. Default false. More...
virtual void	MarkNetworkUpdate ()
	Mark for attribute check on the next network update. More...
bool	SetAttribute (unsigned index, const Variant &value)
	Set attribute by index. Return true if successfully set.
bool	SetAttribute (const String &name, const Variant &value)
	Set attribute by name. Return true if successfully set.
void	SetInstanceDefault (bool enable)
	Set instance-level default flag.
void	ResetToDefault ()
	Reset all editable attributes to their default values.
void	RemoveInstanceDefault ()
	Remove instance's default values if they are set previously.
void	SetTemporary (bool enable)
	Set temporary flag. Temporary objects will not be saved.
void	SetInterceptNetworkUpdate (const String &attributeName, bool enable)
	Enable interception of an attribute from network updates. Intercepted attributes are sent as events instead of applying directly. This can be used to implement client side prediction.
void	AllocateNetworkState ()
	Allocate network attribute state.
void	WriteInitialDeltaUpdate (Serializer &dest, unsigned char timeStamp)
	Write initial delta network update.
void	WriteDeltaUpdate (Serializer &dest, const DirtyBits &attributeBits, unsigned char timeStamp)
	Write a delta network update according to dirty attribute bits.
void	WriteLatestDataUpdate (Serializer &dest, unsigned char timeStamp)
	Write a latest data network update.
bool	ReadDeltaUpdate (Deserializer &source)
	Read and apply a network delta update. Return true if attributes were changed.
bool	ReadLatestDataUpdate (Deserializer &source)
	Read and apply a network latest data update. Return true if attributes were changed.
Variant	GetAttribute (unsigned index) const
	Return attribute value by index. Return empty if illegal index.
Variant	GetAttribute (const String &name) const
	Return attribute value by name. Return empty if not found.
Variant	GetAttributeDefault (unsigned index) const
	Return attribute default value by index. Return empty if illegal index.
Variant	GetAttributeDefault (const String &name) const
	Return attribute default value by name. Return empty if not found.
unsigned	GetNumAttributes () const
	Return number of attributes.
unsigned	GetNumNetworkAttributes () const
	Return number of network replication attributes.
bool	IsTemporary () const
	Return whether is temporary.
bool	GetInterceptNetworkUpdate (const String &attributeName) const
	Return whether an attribute's network updates are being intercepted.
NetworkState *	GetNetworkState () const
	Return the network attribute state, if allocated.
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
	~Object () override
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
	Return type hash. More...
virtual const String &	GetTypeName () const =0
	Return type name. More...
virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
bool	IsInstanceOf (StringHash type) const
	Check current instance is type of specified type.
bool	IsInstanceOf (const TypeInfo *typeInfo) const
	Check current instance is type of specified type.
template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.
template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.
template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.
void	SubscribeToEvent (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler)
	Subscribe to a specific sender's event.
void	SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
	Subscribe to a specific sender's event.
void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.
void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.
void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.
void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.
void	UnsubscribeFromAllEventsExcept (const Vector< StringHash > &exceptions, bool onlyUserData)
	Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events).
void	SendEvent (StringHash eventType)
	Send event to all subscribers.
void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
template<typename... Args>
void	SendEvent (StringHash eventType, Args... args)
	Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
	Return global variable based on key.
const VariantMap &	GetGlobalVars () const
	Return all global variables.
void	SetGlobalVar (StringHash key, const Variant &value)
	Set global variable with the respective key and value.
Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.
Object *	GetEventSender () const
	Return active event sender. Null outside event handling.
EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.
bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.
bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.
bool	HasEventHandlers () const
	Return whether has subscribed to any event.
template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.
const String &	GetCategory () const
	Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
void	SetBlockEvents (bool block)
	Block object from sending and receiving events.
bool	GetBlockEvents () const
	Return sending and receiving events blocking status.
Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.
virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.
RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.
void	AddRef ()
	Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
void	ReleaseRef ()
	Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
int	Refs () const
	Return reference count.
int	WeakRefs () const
	Return weak reference count.
RefCount *	RefCountPtr ()
	Return pointer to the reference count structure.

Static Public Member Functions
static void	RegisterObject (Context *context)
	Register object factory. Drawable must be registered first.
static Matrix3x4	GetFullscreenQuadTransform (Camera *camera)
	Return a transform for deferred fullscreen quad (directional light) rendering.
Static Public Member Functions inherited from Urho3D::Drawable
static void	RegisterObject (Context *context)
	Register object attributes. Drawable must be registered first.
Static Public Member Functions inherited from Urho3D::Animatable
static void	RegisterObject (Context *context)
	Register object factory.
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Protected Member Functions
void	OnWorldBoundingBoxUpdate () override
	Recalculate the world-space bounding box. More...
Protected Member Functions inherited from Urho3D::Drawable
void	OnNodeSet (Node *node) override
	Handle node being assigned. More...
void	OnSceneSet (Scene *scene) override
	Handle scene being assigned. More...
void	OnMarkedDirty (Node *node) override
	Handle node transform being dirtied. More...
virtual void	OnWorldBoundingBoxUpdate ()=0
	Recalculate the world-space bounding box. More...
virtual void	OnRemoveFromOctree ()
	Handle removal from octree. More...
void	AddToOctree ()
	Add to octree.
void	RemoveFromOctree ()
	Remove from octree.
void	SetOctant (Octant *octant)
	Move into another octree octant.
Protected Member Functions inherited from Urho3D::Component
void	OnAttributeAnimationAdded () override
	Handle attribute animation added. More...
void	OnAttributeAnimationRemoved () override
	Handle attribute animation removed. More...
virtual void	OnNodeSet (Node *node)
	Handle scene node being assigned at creation. More...
virtual void	OnSceneSet (Scene *scene)
	Handle scene being assigned. This may happen several times during the component's lifetime. Scene-wide subsystems and events are subscribed to here. More...
virtual void	OnMarkedDirty (Node *node)
	Handle scene node transform dirtied. More...
virtual void	OnNodeSetEnabled (Node *node)
	Handle scene node enabled status changing. More...
void	SetID (ComponentId id)
	Set ID. Called by Scene.
void	SetNode (Node *node)
	Set scene node. Called by Node when creating the component.
void	HandleAttributeAnimationUpdate (StringHash eventType, VariantMap &eventData)
	Handle scene attribute animation update event.
Component *	GetFixedUpdateSource ()
	Return a component from the scene root that sends out fixed update events (either PhysicsWorld or PhysicsWorld2D). Return null if neither exists.
void	DoAutoRemove (AutoRemoveMode mode)
	Perform autoremove. Called by subclasses. Caller should keep a weak pointer to itself to check whether was actually removed, and return immediately without further member operations in that case.
Protected Member Functions inherited from Urho3D::Animatable
virtual void	OnAttributeAnimationAdded ()=0
	Handle attribute animation added. More...
virtual void	OnAttributeAnimationRemoved ()=0
	Handle attribute animation removed. More...
virtual Animatable *	FindAttributeAnimationTarget (const String &name, String &outName)
	Find target of an attribute animation from object hierarchy by name. More...
void	SetObjectAttributeAnimation (const String &name, ValueAnimation *attributeAnimation, WrapMode wrapMode, float speed)
	Set object attribute animation internal.
void	OnObjectAnimationAdded (ObjectAnimation *objectAnimation)
	Handle object animation added.
void	OnObjectAnimationRemoved (ObjectAnimation *objectAnimation)
	Handle object animation removed.
void	UpdateAttributeAnimations (float timeStep)
	Update attribute animations.
bool	IsAnimatedNetworkAttribute (const AttributeInfo &attrInfo) const
	Is animated network attribute.
AttributeAnimationInfo *	GetAttributeAnimationInfo (const String &name) const
	Return attribute animation info.
void	HandleAttributeAnimationAdded (StringHash eventType, VariantMap &eventData)
	Handle attribute animation added.
void	HandleAttributeAnimationRemoved (StringHash eventType, VariantMap &eventData)
	Handle attribute animation removed.

Private Member Functions
	URHO3D_OBJECT (Light, Drawable)
void	ValidateShadowFocus ()
	Validate shadow focus.
void	ValidateShadowCascade ()
	Validate shadow cascade.
void	ValidateShadowBias ()
	Validate shadow bias.

Private Attributes
LightType	lightType_
	Light type.
Color	color_
	Color.
float	temperature_
	Light temperature.
float	lightRad_
	Radius of the light source. If above 0 it will turn the light into an area light. Works only with PBR shaders.
float	lightLength_
	Length of the light source. If above 0 and radius is above 0 it will create a tube light. Works only with PBR shaders.
BiasParameters	shadowBias_
	Shadow depth bias parameters.
CascadeParameters	shadowCascade_
	Directional light cascaded shadow parameters.
FocusParameters	shadowFocus_
	Shadow map focus parameters.
Matrix3x4	volumeTransform_
	Custom world transform for the light volume.
SharedPtr< Texture >	rampTexture_
	Range attenuation texture.
SharedPtr< Texture >	shapeTexture_
	Spotlight attenuation texture.
LightBatchQueue *	lightQueue_
	Light queue.
float	specularIntensity_
	Specular intensity.
float	brightness_
	Brightness multiplier.
float	range_
	Range.
float	fov_
	Spotlight field of view.
float	aspectRatio_
	Spotlight aspect ratio.
float	fadeDistance_
	Fade start distance.
float	shadowFadeDistance_
	Shadow fade start distance.
float	shadowIntensity_
	Light intensity in shadow.
float	shadowResolution_
	Shadow resolution.
float	shadowNearFarRatio_
	Shadow camera near/far clip distance ratio.
float	shadowMaxExtrusion_
	Directional shadow max. extrusion distance.
bool	perVertex_
	Per-vertex lighting flag.
bool	usePhysicalValues_
	Use physical light values flag.

Additional Inherited Members
Protected Attributes inherited from Urho3D::Drawable
BoundingBox	worldBoundingBox_
	World-space bounding box.
BoundingBox	boundingBox_
	Local-space bounding box.
Vector< SourceBatch >	batches_
	Draw call source data.
DrawableTypes	drawableType_
	Drawable type.
bool	worldBoundingBoxDirty_
	Bounding box dirty flag.
bool	castShadows_
	Shadowcaster flag.
bool	occluder_
	Occluder flag.
bool	occludee_
	Occludee flag.
bool	updateQueued_
	Octree update queued flag.
bool	zoneDirty_
	Zone inconclusive or dirtied flag.
Octant *	octant_
	Octree octant.
Zone *	zone_
	Current zone.
mask32	viewMask_
	View mask.
mask32	lightMask_
	Light mask.
mask32	shadowMask_
	Shadow mask.
mask32	zoneMask_
	Zone mask.
i32	viewFrameNumber_
	Last visible frame number.
float	distance_
	Current distance to camera.
float	lodDistance_
	LOD scaled distance.
float	drawDistance_
	Draw distance.
float	shadowDistance_
	Shadow distance.
float	sortValue_
	Current sort value.
float	minZ_
	Current minimum view space depth.
float	maxZ_
	Current maximum view space depth.
float	lodBias_
	LOD bias.
flagset32	basePassFlags_
	Base pass flags, bit per batch.
i32	maxLights_
	Maximum per-pixel lights.
Vector< Camera * >	viewCameras_
	List of cameras from which is seen on the current frame.
Light *	firstLight_
	First per-pixel light added this frame.
Vector< Light * >	lights_
	Per-pixel lights affecting this drawable.
Vector< Light * >	vertexLights_
	Per-vertex lights affecting this drawable.
Protected Attributes inherited from Urho3D::Component
Node *	node_
	Scene node.
ComponentId	id_
	Unique ID within the scene.
bool	networkUpdate_
	Network update queued flag.
bool	enabled_
	Enabled flag.
Protected Attributes inherited from Urho3D::Animatable
bool	animationEnabled_
	Animation enabled.
SharedPtr< ObjectAnimation >	objectAnimation_
	Animation.
HashSet< const AttributeInfo * >	animatedNetworkAttributes_
	Animated network attribute set.
HashMap< String, SharedPtr< AttributeAnimationInfo > >	attributeAnimationInfos_
	Attribute animation infos.
Protected Attributes inherited from Urho3D::Serializable
std::unique_ptr< NetworkState >	networkState_
	Network attribute state.
Protected Attributes inherited from Urho3D::Object
Context *	context_
	Execution context.

Detailed Description

Light component.

Member Function Documentation

DrawDebugGeometry()

void Urho3D::Light::DrawDebugGeometry ( DebugRenderer *  debug, bool  depthTest  )

overridevirtual

Visualize the component as debug geometry.

Reimplemented from Urho3D::Drawable.

OnWorldBoundingBoxUpdate()

void Urho3D::Light::OnWorldBoundingBoxUpdate ( )

overrideprotectedvirtual

Recalculate the world-space bounding box.

Implements Urho3D::Drawable.

ProcessRayQuery()

void Urho3D::Light::ProcessRayQuery ( const RayOctreeQuery &  query, Vector< RayQueryResult > &  results  )

overridevirtual

Process octree raycast. May be called from a worker thread.

Reimplemented from Urho3D::Drawable.

UpdateBatches()

void Urho3D::Light::UpdateBatches ( const FrameInfo &  frame )

overridevirtual

Calculate distance and prepare batches for rendering. May be called from worker thread(s), possibly re-entrantly.

Reimplemented from Urho3D::Drawable.

---

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

• /home/runner/work/urho3d-doxygen.github.io/urho3d-doxygen.github.io/urho3d_repo/Source/Urho3D/Graphics/Light.h
• /home/runner/work/urho3d-doxygen.github.io/urho3d-doxygen.github.io/urho3d_repo/Source/Urho3D/Graphics/Light.cpp