Rebel Fork Framework
Urho3D::Light Class Reference

Light component. More...

#include <Urho3D/Graphics/Light.h>

Inheritance diagram for Urho3D::Light:
Urho3D::Drawable Urho3D::Component Urho3D::PipelineStateTracker Urho3D::Serializable Urho3D::Object Urho3D::RefCounted

Public Member Functions

 Light (Context *context)
 Construct.
 
 ~Light () override
 Destruct.
 
void ProcessRayQuery (const RayOctreeQuery &query, ea::vector< RayQueryResult > &results) override
 Process octree raycast. May be called from a worker thread.
 
void UpdateBatches (const FrameInfo &frame) override
 Calculate distance and prepare batches for rendering. May be called from worker thread(s), possibly re-entrantly.
 
void DrawDebugGeometry (DebugRenderer *debug, bool depthTest) override
 Visualize the component as debug geometry.
 
void SetLightType (LightType type)
 
void SetLightImportance (LightImportance importance)
 Set light importance.
 
void SetLightMode (LightMode mode)
 Set light mode.
 
void SetColor (const Color &color)
 
void SetTemperature (float temperature)
 
void SetRadius (float radius)
 
void SetLength (float length)
 
void SetUsePhysicalValues (bool enable)
 
void SetSpecularIntensity (float intensity)
 
void SetBrightness (float brightness)
 
void SetIndirectBrightness (float indirectBrightness)
 Set indirect light brightness multiplier. May have no effect for realtime lights.
 
void SetRange (float range)
 
void SetFov (float fov)
 
void SetAspectRatio (float aspectRatio)
 
void SetFadeDistance (float distance)
 
void SetShadowFadeDistance (float distance)
 
void SetShadowBias (const BiasParameters &parameters)
 
void SetShadowCascade (const CascadeParameters &parameters)
 
void SetShadowFocus (const FocusParameters &parameters)
 
void SetShadowIntensity (float intensity)
 
void SetShadowResolution (float resolution)
 
void SetShadowNearFarRatio (float nearFarRatio)
 
void SetShadowMaxExtrusion (float extrusion)
 
void SetRampTexture (Texture *texture)
 
void SetShapeTexture (Texture *texture)
 
LightType GetLightType () const
 
LightMode GetLightMode () const
 Return light mode.
 
LightImportance GetLightImportance () const
 Return light importance.
 
unsigned GetLightMaskEffective () const
 Return effective light mask. Baked lights have zero light mask.
 
bool GetPerVertex () const
 
const ColorGetColor () const
 
float GetTemperature () const
 
float GetRadius () const
 
float GetLength () const
 
bool GetUsePhysicalValues () const
 
Color GetColorFromTemperature () const
 
float GetSpecularIntensity () const
 
float GetBrightness () const
 
float GetIndirectBrightness () const
 Return indirect brightness multiplier.
 
Color GetEffectiveColor () const
 
float GetEffectiveSpecularIntensity () const
 
float GetRange () const
 
float GetFov () const
 
float GetAspectRatio () const
 
float GetFadeDistance () const
 
float GetShadowFadeDistance () const
 
const BiasParametersGetShadowBias () const
 
const CascadeParametersGetShadowCascade () const
 
const FocusParametersGetShadowFocus () const
 
float GetShadowIntensity () const
 
float GetShadowResolution () const
 
float GetShadowNearFarRatio () const
 
float GetShadowMaxExtrusion () const
 
TextureGetRampTexture () const
 
TextureGetShapeTexture () const
 
Frustum GetFrustum () const
 
Frustum GetViewSpaceFrustum (const Matrix3x4 &view) const
 Return spotlight frustum in the specified view space.
 
float GetDistanceTo (Drawable *drawable) const
 Return distance from light to drawable.
 
int GetNumShadowSplits () const
 
bool IsNegative () const
 
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 Matrix3x4GetVolumeTransform (const 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.
 
ea::pair< float, float > GetCutoffParams () const
 
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, DrawableFlags drawableFlags=DRAWABLE_UNDEFINED)
 Construct.
 
 ~Drawable () override
 Destruct.
 
void OnSetEnabled () override
 Handle enabled/disabled state change.
 
void ProcessCustomRayQuery (const RayOctreeQuery &query, const BoundingBox &worldBoundingBox, ea::vector< RayQueryResult > &results)
 Process raycast with custom transform.
 
virtual void Update (const FrameInfo &frame)
 Update before octree reinsertion. Is called from a worker thread.
 
virtual void UpdateBatchesDelayed (const FrameInfo &frame)
 Batch update from main thread. Called on demand only if RequestUpdateBatchesDelayed() is called from UpdateBatches().
 
virtual void UpdateGeometry (const FrameInfo &frame)
 Prepare geometry for rendering.
 
virtual UpdateGeometryType GetUpdateGeometryType ()
 Return whether a geometry update is necessary, and if it can happen in a worker thread.
 
virtual GeometryGetLodGeometry (unsigned batchIndex, unsigned level)
 Return the geometry for a specific LOD level.
 
virtual unsigned GetNumOccluderTriangles ()
 Return number of occlusion geometry triangles.
 
virtual bool DrawOcclusion (OcclusionBuffer *buffer)
 Draw to occlusion buffer. Return true if did not run out of triangles.
 
void SetDrawDistance (float distance)
 
void SetShadowDistance (float distance)
 
void SetLodBias (float bias)
 
void SetViewMask (unsigned mask)
 
void SetLightMask (unsigned mask)
 
void SetShadowMask (unsigned mask)
 
void SetZoneMask (unsigned mask)
 
void SetCastShadows (bool enable)
 
void SetOccluder (bool enable)
 
void SetOccludee (bool enable)
 
void SetGlobalIlluminationType (GlobalIlluminationType type)
 Set GI type.
 
void SetReflectionMode (ReflectionMode mode)
 Set reflection mode.
 
void MarkForUpdate ()
 Mark for update and octree reinsertion. Update is automatically queued when the drawable's scene node moves or changes scale.
 
const BoundingBoxGetBoundingBox () const
 
const BoundingBoxGetWorldBoundingBox ()
 
DrawableFlags GetDrawableFlags () const
 Return drawable flags.
 
float GetDrawDistance () const
 
float GetShadowDistance () const
 
float GetLodBias () const
 
unsigned GetViewMask () const
 
unsigned GetLightMask () const
 
unsigned GetShadowMask () const
 
unsigned GetZoneMask () const
 
bool GetCastShadows () const
 
bool IsOccluder () const
 
bool IsOccludee () const
 
GlobalIlluminationType GetGlobalIlluminationType () const
 Return global illumination type.
 
ReflectionMode GetReflectionMode () const
 Return reflection mode.
 
bool IsInView () const
 
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 ea::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 MarkInView (const FrameInfo &frame)
 Mark in view. Also clear the light list.
 
void MarkInView (unsigned frameNumber)
 Mark in view without specifying a camera. Used for shadow casters.
 
OctantGetOctant () const
 Return octree octant.
 
unsigned GetDrawableIndex () const
 Return index in octree.
 
bool IsInOctree () const
 Return whether the drawable is added to Octree.
 
ZoneGetZone () const
 
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.
 
unsigned & GetMutableLightProbeTetrahedronHint ()
 Return mutable light probe tetrahedron hint.
 
CachedDrawableZoneGetMutableCachedZone ()
 Return mutable cached zone data.
 
CachedDrawableReflectionGetMutableCachedReflection ()
 Return mutable cached reflection data.
 
unsigned GetLightMaskInZone () const
 Return combined light masks of Drawable and its currently cached Zone.
 
unsigned GetShadowMaskInZone () const
 Return combined shadow masks of Drawable and its currently cached Zone.
 
- Public Member Functions inherited from Urho3D::Component
 Component (Context *context)
 Construct.
 
 ~Component () override
 Destruct.
 
AttributeScopeHint GetEffectiveScopeHint () const
 
bool Save (Serializer &dest) const override
 Save as binary data. Return true if successful.
 
bool SaveXML (XMLElement &dest) const override
 Save as XML data. Return true if successful.
 
bool SaveJSON (JSONValue &dest) const override
 Save as JSON data. Return true if successful.
 
virtual void GetDependencyNodes (ea::vector< Node * > &dest)
 Return the depended on nodes to order network updates.
 
virtual bool HasAuxiliaryData () const
 
virtual void SerializeAuxiliaryData (Archive &archive)
 Serialize auxiliary data from/to the current block of the archive. May throw ArchiveException.
 
void SetEnabled (bool enable)
 
void Remove ()
 Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
 
unsigned GetID () const
 
Node * GetNode () const
 
SceneGetScene () const
 Return the scene the node belongs to.
 
bool IsEnabled () const
 
bool IsEnabledEffective () const
 
ea::string GetFullNameDebug () const
 Return full component name for debugging. Unique for each component in the scene. Slow!
 
ComponentGetComponent (StringHash type) const
 Return component in the same scene node by type. If there are several, returns the first.
 
template<class T >
T * GetComponent () const
 Template version of returning a component in the same scene node by type.
 
unsigned GetIndexInParent () const
 Return index of this component in the node.
 
- 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 ObjectReflectionGetReflection () const
 Return reflection used for serialization.
 
virtual const ea::vector< AttributeInfo > * GetAttributes () const
 Return attribute descriptions, or null if none defined.
 
void SerializeInBlock (Archive &archive) override
 Serialize content from/to archive. May throw ArchiveException.
 
void SerializeInBlock (Archive &archive, bool serializeTemporary)
 
virtual bool Load (Deserializer &source)
 Load from binary data. Return true if successful.
 
virtual bool LoadXML (const XMLElement &source)
 Load from XML data. Return true if successful.
 
virtual bool LoadJSON (const JSONValue &source)
 Load from JSON data. Return true if successful.
 
virtual bool Load (const ea::string &resourceName)
 Load from binary resource.
 
virtual bool LoadXML (const ea::string &resourceName)
 Load from XML resource.
 
virtual bool LoadJSON (const ea::string &resourceName)
 Load from JSON resource.
 
virtual bool LoadFile (const ea::string &resourceName)
 Load from resource of automatically detected type.
 
virtual void ApplyAttributes ()
 Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
 
virtual bool SaveDefaultAttributes (const AttributeInfo &attr) const
 Return whether should save default-valued attributes into XML. Default false.
 
bool SetAttribute (unsigned index, const Variant &value)
 
bool SetAttribute (const ea::string &name, const Variant &value)
 Set attribute by name. Return true if successfully set.
 
void SetInstanceDefault (bool enable)
 (Internal use) Set instance-level default flag.
 
void SetInstanceDefault (const ea::string &name, const Variant &defaultValue)
 (Internal use) Set instance-level default value. Allocate the internal data structure as necessary.
 
virtual Variant GetInstanceDefault (const ea::string &name) const
 (Internal use) Get instance-level default value.
 
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)
 
Variant GetAttribute (unsigned index) const
 
Variant GetAttribute (const ea::string &name) const
 Return attribute value by name. Return empty if not found.
 
Variant GetAttributeDefault (unsigned index) const
 
Variant GetAttributeDefault (const ea::string &name) const
 Return attribute default value by name. Return empty if not found.
 
unsigned GetNumAttributes () const
 
void CopyAttributes (const Serializable *source, bool resetToDefault=true)
 Copy all attributes from another serializable.
 
bool IsTemporary () const
 
- 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
 
virtual const ea::string & GetTypeName () const =0
 
virtual const TypeInfoGetTypeInfo () const =0
 Return type info.
 
virtual bool IsInstanceOf (StringHash type) const =0
 Check whether current instance implements specified type.
 
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
 
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 SubscribeToEventManual (StringHash eventType, EventHandler *handler)
 Subscribe to an event that can be sent by any sender.
 
void SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
 Subscribe to a specific sender's event.
 
template<class T >
void SubscribeToEvent (StringHash eventType, T handler)
 Subscribe to an event that can be sent by any sender.
 
template<class T >
void SubscribeToEvent (Object *sender, StringHash eventType, T handler)
 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 ea::vector< StringHash > &exceptions)
 Unsubscribe from all events except those listed.
 
void UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
 Unsubscribe from all events except those with listed senders.
 
void SendEvent (StringHash eventType)
 Send event to all subscribers.
 
void SendEvent (StringHash eventType, VariantMap &eventData)
 Send event with parameters to all subscribers.
 
VariantMapGetEventDataMap () 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, const Args &... args)
 Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
 
ContextGetContext () const
 Return execution context.
 
const VariantGetGlobalVar (StringHash key) const
 
const VariantMapGetGlobalVars () const
 
void SetGlobalVar (StringHash key, const Variant &value)
 
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
 
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
 
EventHandlerGetEventHandler () 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 ea::string & GetCategory () const
 
void SendEvent (StringHash eventType, const VariantMap &eventData)
 Send event with parameters to all subscribers.
 
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.
 
RefCountedoperator= (const RefCounted &rhs)=delete
 Prevent assignment.
 
int AddRef ()
 
int ReleaseRef ()
 
int Refs () const
 
int WeakRefs () const
 
RefCountRefCountPtr () const
 Return pointer to the reference count structure.
 
bool HasScriptObject () const
 Return true if script runtime object wrapping this native object exists.
 
bool IsScriptStrongRef () const
 Return true if script reference is strong.
 
- Public Member Functions inherited from Urho3D::PipelineStateTracker
virtual ~PipelineStateTracker ()
 Destruct.
 
unsigned GetPipelineStateHash () const
 Return (partial) pipeline state hash. Save to call from multiple threads as long as the object is not changing.
 
void MarkPipelineStateHashDirty ()
 Mark pipeline state hash as dirty.
 

Static Public Member Functions

static void RegisterObject (Context *context)
 
static Matrix3x4 GetFullscreenQuadTransform (const 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)
 
- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.
 

Protected Member Functions

void OnWorldBoundingBoxUpdate () override
 Recalculate the world-space bounding box.
 
- Protected Member Functions inherited from Urho3D::Drawable
unsigned RecalculatePipelineStateHash () const override
 Recalculate hash. Shall be save to call from multiple threads as long as the object is not changing.
 
void OnNodeSet (Node *previousNode, Node *currentNode) override
 Handle node being assigned.
 
void OnSceneSet (Scene *scene) override
 Handle scene being assigned.
 
void OnMarkedDirty (Node *node) override
 Handle node transform being dirtied.
 
virtual void OnRemoveFromOctree ()
 Handle removal from octree.
 
void AddToOctree ()
 Add to octree.
 
void RemoveFromOctree ()
 Remove from octree.
 
void RequestUpdateBatchesDelayed (const FrameInfo &frame)
 Request UpdateBatchesDelayed call from main thread.
 
void SetOctant (Octant *octant)
 Move into another octree octant.
 
void SetDrawableIndex (unsigned drawableIndex)
 Update drawable index.
 
- Protected Member Functions inherited from Urho3D::Component
virtual void OnNodeSetEnabled (Node *node)
 Handle scene node enabled status changing.
 
void SetID (unsigned id)
 
void SetNode (Node *node)
 Set scene node. Called by Node when creating the component.
 
ComponentGetFixedUpdateSource ()
 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::PipelineStateTracker
PipelineStateSubscription CreateDependency (PipelineStateTracker *dependency)
 Create dependency onto another pipeline state.
 
void AddSubscriberReference (PipelineStateTracker *subscriber)
 Add reference to subscriber pipeline state tracker.
 
void RemoveSubscriberReference (PipelineStateTracker *subscriber)
 Remove reference to subscriber pipeline state tracker.
 

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.
 
LightImportance lightImportance_ {}
 Light importance.
 
LightMode lightMode_ {}
 Light baking mode.
 
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< TexturerampTexture_
 Range attenuation texture.
 
SharedPtr< TextureshapeTexture_
 Spotlight attenuation texture.
 
LightBatchQueue * lightQueue_
 Light queue.
 
float specularIntensity_
 Specular intensity.
 
float brightness_
 Brightness multiplier.
 
float indirectBrightness_ { 1.0f }
 Indirect 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 usePhysicalValues_
 Use physical light values flag.
 

Additional Inherited Members

- Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 > TypeHierarchy {}
 
- Static Protected Member Functions inherited from Urho3D::Drawable
static GeometryGetGeometryIfNotEmpty (Geometry *geometry)
 Get Geometry pointer if the source one is not null or empty.
 
- Protected Attributes inherited from Urho3D::Drawable
BoundingBox worldBoundingBox_
 World-space bounding box.
 
BoundingBox boundingBox_
 Local-space bounding box.
 
ea::vector< SourceBatchbatches_
 Draw call source data.
 
DrawableFlags drawableFlags_
 Drawable flags.
 
GlobalIlluminationType giType_ {}
 Global illumination type.
 
ReflectionMode reflectionMode_ {ReflectionMode::BlendProbesAndZone}
 Reflection mode.
 
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.
 
Octantoctant_
 Octree octant.
 
unsigned drawableIndex_ { M_MAX_UNSIGNED }
 Index of Drawable in Scene. May be updated.
 
CachedDrawableZone cachedZone_
 Current zone.
 
CachedDrawableReflection cachedReflection_
 Current reflection.
 
unsigned viewMask_
 View mask.
 
unsigned lightMask_
 Light mask.
 
unsigned shadowMask_
 Shadow mask.
 
unsigned zoneMask_
 Zone mask.
 
unsigned 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 lodBias_
 LOD bias.
 
unsigned lightProbeTetrahedronHint_ { M_MAX_UNSIGNED }
 Light probe tetrahedron hint.
 
ea::vector< Camera * > viewCameras_
 List of cameras from which is seen on the current frame.
 
- Protected Attributes inherited from Urho3D::Component
Node * node_
 Scene node.
 
unsigned id_
 Unique ID within the scene.
 
bool networkUpdate_
 Network update queued flag.
 
bool enabled_
 Enabled flag.
 
- Protected Attributes inherited from Urho3D::Serializable
ea::unique_ptr< VariantMapinstanceDefaultValues_
 Attribute default value at each instance level.
 
bool setInstanceDefault_
 When true, store the attribute value as instance's default value (internal use only).
 
bool temporary_
 Temporary flag.
 
- Protected Attributes inherited from Urho3D::Object
WeakPtr< Contextcontext_
 Execution context.
 

Detailed Description

Light component.

Member Function Documentation

◆ GetAspectRatio()

float Urho3D::Light::GetAspectRatio ( ) const
inline

Return spotlight aspect ratio.

◆ GetBrightness()

float Urho3D::Light::GetBrightness ( ) const
inline

Return brightness multiplier. Specified in lumens when "use physical values" is enabled.

◆ GetColor()

const Color& Urho3D::Light::GetColor ( ) const
inline

Return color.

◆ GetColorFromTemperature()

Color Urho3D::Light::GetColorFromTemperature ( ) const

Return the color value of the temperature in Kelvin.

◆ GetCutoffParams()

ea::pair<float, float> Urho3D::Light::GetCutoffParams ( ) const
inline

Return spot cutoff parameters. Considering the angle between spot light axis and direction from light to object, returns: first: cosine of the angle where lighting is zero. second: inverted difference between zero and full light cosines. For point and directional lights, (-2, 1) is returned, which corresponds to max lighting at angles with cosine >= -1, i.e all angles altogether.

◆ GetEffectiveColor()

Color Urho3D::Light::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.

◆ GetEffectiveSpecularIntensity()

float Urho3D::Light::GetEffectiveSpecularIntensity ( ) const
inline

Return effective specular intensity, multiplied by absolute value of brightness.

◆ GetFadeDistance()

float Urho3D::Light::GetFadeDistance ( ) const
inline

Return fade start distance.

◆ GetFov()

float Urho3D::Light::GetFov ( ) const
inline

Return spotlight field of view.

◆ GetFrustum()

Frustum Urho3D::Light::GetFrustum ( ) const

Return spotlight frustum.

◆ GetLength()

float Urho3D::Light::GetLength ( ) const
inline

Return area tube light length. Works only with PBR shaders.

◆ GetLightType()

LightType Urho3D::Light::GetLightType ( ) const
inline

Return light type.

◆ GetNumShadowSplits()

int Urho3D::Light::GetNumShadowSplits ( ) const

Return number of shadow map cascade splits for a directional light, considering also graphics API limitations.

◆ GetPerVertex()

bool Urho3D::Light::GetPerVertex ( ) const
inline

Return vertex lighting mode.

◆ GetRadius()

float Urho3D::Light::GetRadius ( ) const
inline

Return area light mode radius. Works only with PBR shaders.

◆ GetRampTexture()

Texture* Urho3D::Light::GetRampTexture ( ) const
inline

Return range attenuation texture.

◆ GetRange()

float Urho3D::Light::GetRange ( ) const
inline

Return range.

◆ GetShadowBias()

const BiasParameters& Urho3D::Light::GetShadowBias ( ) const
inline

Return shadow depth bias parameters.

◆ GetShadowCascade()

const CascadeParameters& Urho3D::Light::GetShadowCascade ( ) const
inline

Return directional light cascaded shadow parameters.

◆ GetShadowFadeDistance()

float Urho3D::Light::GetShadowFadeDistance ( ) const
inline

Return shadow fade start distance.

◆ GetShadowFocus()

const FocusParameters& Urho3D::Light::GetShadowFocus ( ) const
inline

Return shadow map focus parameters.

◆ GetShadowIntensity()

float Urho3D::Light::GetShadowIntensity ( ) const
inline

Return light intensity in shadow.

◆ GetShadowMaxExtrusion()

float Urho3D::Light::GetShadowMaxExtrusion ( ) const
inline

Return maximum shadow extrusion distance for directional lights.

◆ GetShadowNearFarRatio()

float Urho3D::Light::GetShadowNearFarRatio ( ) const
inline

Return shadow camera near/far clip distance ratio.

◆ GetShadowResolution()

float Urho3D::Light::GetShadowResolution ( ) const
inline

Return shadow resolution.

◆ GetShapeTexture()

Texture* Urho3D::Light::GetShapeTexture ( ) const
inline

Return spotlight attenuation texture.

◆ GetSpecularIntensity()

float Urho3D::Light::GetSpecularIntensity ( ) const
inline

Return specular intensity.

◆ GetTemperature()

float Urho3D::Light::GetTemperature ( ) const
inline

Return the temperature of the light in Kelvin.

◆ GetUsePhysicalValues()

bool Urho3D::Light::GetUsePhysicalValues ( ) const
inline

Return if light uses temperature and brightness in lumens.

◆ IsNegative()

bool Urho3D::Light::IsNegative ( ) const
inline

Return whether light has negative (darkening) color.

◆ RegisterObject()

void Urho3D::Light::RegisterObject ( Context context)
static

Register object factory. Drawable must be registered first.

◆ SetAspectRatio()

void Urho3D::Light::SetAspectRatio ( float  aspectRatio)

Set spotlight aspect ratio.

◆ SetBrightness()

void Urho3D::Light::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.

◆ SetColor()

void Urho3D::Light::SetColor ( const Color color)

Set color.

◆ SetFadeDistance()

void Urho3D::Light::SetFadeDistance ( float  distance)

Set fade out start distance.

◆ SetFov()

void Urho3D::Light::SetFov ( float  fov)

Set spotlight field of view.

◆ SetLength()

void Urho3D::Light::SetLength ( float  length)

Set tube area light length. Works only with PBR shaders.

◆ SetLightType()

void Urho3D::Light::SetLightType ( LightType  type)

Set light type.

◆ SetRadius()

void Urho3D::Light::SetRadius ( float  radius)

Set area light radius. Greater than zero activates area light mode. Works only with PBR shaders.

◆ SetRampTexture()

void Urho3D::Light::SetRampTexture ( Texture texture)

Set range attenuation texture.

◆ SetRange()

void Urho3D::Light::SetRange ( float  range)

Set range.

◆ SetShadowBias()

void Urho3D::Light::SetShadowBias ( const BiasParameters parameters)

Set shadow depth bias parameters.

◆ SetShadowCascade()

void Urho3D::Light::SetShadowCascade ( const CascadeParameters parameters)

Set directional light cascaded shadow parameters.

◆ SetShadowFadeDistance()

void Urho3D::Light::SetShadowFadeDistance ( float  distance)

Set shadow fade out start distance. Only has effect if shadow distance is also non-zero.

◆ SetShadowFocus()

void Urho3D::Light::SetShadowFocus ( const FocusParameters parameters)

Set shadow map focusing parameters.

◆ SetShadowIntensity()

void Urho3D::Light::SetShadowIntensity ( float  intensity)

Set light intensity in shadow between 0.0 - 1.0. 0.0 (the default) gives fully dark shadows.

◆ SetShadowMaxExtrusion()

void Urho3D::Light::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.

◆ SetShadowNearFarRatio()

void Urho3D::Light::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.

◆ SetShadowResolution()

void Urho3D::Light::SetShadowResolution ( float  resolution)

Set shadow resolution between 0.25 - 1.0. Determines the shadow map to use.

◆ SetShapeTexture()

void Urho3D::Light::SetShapeTexture ( Texture texture)

Set spotlight attenuation texture.

◆ SetSpecularIntensity()

void Urho3D::Light::SetSpecularIntensity ( float  intensity)

Set specular intensity. Zero disables specular calculations.

◆ SetTemperature()

void Urho3D::Light::SetTemperature ( float  temperature)

Set temperature of the light in Kelvin. Modulates the light color when "use physical values" is enabled.

◆ SetUsePhysicalValues()

void Urho3D::Light::SetUsePhysicalValues ( bool  enable)

Set use physical light values.


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