Urho3D::Light Class Reference
Public Member Functions |
Static Public Member Functions |
Protected Member Functions |
Private Member Functions |
Private Attributes |
List of all members
Urho3D::Light Class Reference
Light component. More...
#include <Urho3D/Graphics/Light.h>
Inheritance diagram for Urho3D::Light:
Collaboration diagram for Urho3D::Light:
Public Member Functions | |
| Light (Context *context) | |
| Construct. | |
| ~Light () override | |
| Destruct. | |
| void | ProcessRayQuery (const RayOctreeQuery &query, PODVector< 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 | SetPerVertex (bool enable) |
| 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 | SetRange (float range) |
| void | SetFov (float fov) |
| void | SetAspectRatio (float aspectRatio) |
| void | SetFadeDistance (float distance) |
| void | SetShadowFadeDistance (float distance) |
| void | SetShadowBias (const BiasParameters ¶meters) |
| void | SetShadowCascade (const CascadeParameters ¶meters) |
| void | SetShadowFocus (const FocusParameters ¶meters) |
| 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 |
| bool | GetPerVertex () const |
| const Color & | GetColor () const |
| float | GetTemperature () const |
| float | GetRadius () const |
| float | GetLength () const |
| bool | GetUsePhysicalValues () const |
| Color | GetColorFromTemperature () const |
| float | GetSpecularIntensity () const |
| float | GetBrightness () const |
| Color | GetEffectiveColor () const |
| float | GetEffectiveSpecularIntensity () const |
| float | GetRange () const |
| float | GetFov () const |
| float | GetAspectRatio () const |
| float | GetFadeDistance () const |
| float | GetShadowFadeDistance () const |
| const BiasParameters & | GetShadowBias () const |
| const CascadeParameters & | GetShadowCascade () const |
| const FocusParameters & | GetShadowFocus () const |
| float | GetShadowIntensity () const |
| float | GetShadowResolution () const |
| float | GetShadowNearFarRatio () const |
| float | GetShadowMaxExtrusion () const |
| Texture * | GetRampTexture () const |
| Texture * | GetShapeTexture () const |
| Frustum | GetFrustum () const |
| Frustum | GetViewSpaceFrustum (const Matrix3x4 &view) const |
| Return spotlight frustum in the specified view space. | |
| 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 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, unsigned char drawableFlags) | |
| Construct. | |
| ~Drawable () override | |
| Destruct. | |
| void | OnSetEnabled () override |
| Handle enabled/disabled state change. | |
| virtual void | Update (const FrameInfo &frame) |
| Update before octree reinsertion. Is called from a worker thread. | |
| 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 Geometry * | GetLodGeometry (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 | SetMaxLights (unsigned num) |
| void | SetCastShadows (bool enable) |
| void | SetOccluder (bool enable) |
| void | SetOccludee (bool enable) |
| 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 |
| const BoundingBox & | GetWorldBoundingBox () |
| unsigned char | 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 |
| unsigned | GetMaxLights () const |
| bool | GetCastShadows () const |
| bool | IsOccluder () const |
| bool | IsOccludee () const |
| 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 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 (unsigned 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 (unsigned batchIndex) |
| Set base pass flag for a batch. | |
| Octant * | GetOctant () const |
| Return octree octant. | |
| Zone * | GetZone () 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. | |
| bool | HasBasePass (unsigned batchIndex) const |
| Return whether has a base pass. | |
| const PODVector< Light * > & | GetLights () const |
| Return per-pixel lights. | |
| const PODVector< 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. | |
| 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. | |
| void | MarkNetworkUpdate () override |
| Mark for attribute check on the next network update. | |
| virtual void | GetDependencyNodes (PODVector< Node * > &dest) |
| Return the depended on nodes to order network updates. | |
| void | SetEnabled (bool enable) |
| void | Remove () |
| Remove from the scene node. If no other shared pointer references exist, causes immediate deletion. | |
| unsigned | GetID () const |
| bool | IsReplicated () const |
| Node * | GetNode () const |
| Scene * | GetScene () const |
| Return the scene the node belongs to. | |
| bool | IsEnabled () const |
| bool | IsEnabledEffective () const |
| Component * | GetComponent (StringHash type) const |
| Return component in the same scene node by type. If there are several, returns the first. | |
| void | GetComponents (PODVector< 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 (PODVector< 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. | |
| bool | LoadJSON (const JSONValue &source) override |
| Load from JSON data. Return true if successful. | |
| void | SetAnimationEnabled (bool enable) |
| 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) |
| 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 |
| ObjectAnimation * | GetObjectAnimation () const |
| 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. | |
| 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. | |
| virtual void | ApplyAttributes () |
| Apply attribute changes that can not be applied immediately. Called after scene load or a network update. | |
| virtual bool | SaveDefaultAttributes () const |
| Return whether should save default-valued attributes into XML. Default false. | |
| bool | SetAttribute (unsigned index, const Variant &value) |
| 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) |
| 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 |
| Variant | GetAttribute (const String &name) const |
| Return attribute value by name. Return empty if not found. | |
| Variant | GetAttributeDefault (unsigned index) const |
| Variant | GetAttributeDefault (const String &name) const |
| Return attribute default value by name. Return empty if not found. | |
| unsigned | GetNumAttributes () const |
| unsigned | GetNumNetworkAttributes () const |
| Return number of network replication attributes. | |
| bool | IsTemporary () const |
| 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 |
| virtual const String & | GetTypeName () const =0 |
| 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 PODVector< 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 |
| const VariantMap & | GetGlobalVars () const |
| void | SetGlobalVar (StringHash key, const Variant &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 |
| 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 |
| int | WeakRefs () const |
| 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. | |
| Protected Member Functions inherited from Urho3D::Drawable | |
| void | OnNodeSet (Node *node) 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 | SetOctant (Octant *octant) |
| Move into another octree octant. | |
| Protected Member Functions inherited from Urho3D::Component | |
| void | OnAttributeAnimationAdded () override |
| Handle attribute animation added. | |
| void | OnAttributeAnimationRemoved () override |
| Handle attribute animation removed. | |
| 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. | |
| 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 Animatable * | FindAttributeAnimationTarget (const String &name, String &outName) |
| Find target of an attribute animation from object hierarchy by name. | |
| 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. | |
| unsigned char | drawableFlags_ |
| Drawable flags. | |
| 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. | |
| 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 | minZ_ |
| Current minimum view space depth. | |
| float | maxZ_ |
| Current maximum view space depth. | |
| float | lodBias_ |
| LOD bias. | |
| unsigned | basePassFlags_ |
| Base pass flags, bit per batch. | |
| unsigned | maxLights_ |
| Maximum per-pixel lights. | |
| PODVector< Camera * > | viewCameras_ |
| List of cameras from which is seen on the current frame. | |
| Light * | firstLight_ |
| First per-pixel light added this frame. | |
| PODVector< Light * > | lights_ |
| Per-pixel lights affecting this drawable. | |
| PODVector< Light * > | vertexLights_ |
| Per-vertex lights affecting this drawable. | |
| 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::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 | |
| UniquePtr< NetworkState > | networkState_ |
| Network attribute state. | |
| Protected Attributes inherited from Urho3D::Object | |
| Context * | context_ |
| Execution context. | |
Detailed Description
Light component.
Member Function Documentation
◆ GetAspectRatio()
|
inline |
Return spotlight aspect ratio.
Here is the caller graph for this function:
◆ GetBrightness()
|
inline |
Return brightness multiplier. Specified in lumens when "use physical values" is enabled.
Here is the caller graph for this function:
◆ GetColor()
|
inline |
Return color.
Here is the caller graph for this function:
◆ GetColorFromTemperature()
| Color Urho3D::Light::GetColorFromTemperature | ( | ) | const |
Return the color value of the temperature in Kelvin.
Here is the caller graph for this function:
◆ 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.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ GetEffectiveSpecularIntensity()
|
inline |
Return effective specular intensity, multiplied by absolute value of brightness.
Here is the call graph for this function:
◆ GetFadeDistance()
|
inline |
Return fade start distance.
Here is the caller graph for this function:
◆ GetFov()
|
inline |
Return spotlight field of view.
Here is the caller graph for this function:
◆ GetFrustum()
| Frustum Urho3D::Light::GetFrustum | ( | ) | const |
Return spotlight frustum.
Here is the call graph for this function:
◆ GetLength()
|
inline |
Return area tube light length. Works only with PBR shaders.
Here is the caller graph for this function:
◆ GetLightType()
|
inline |
Return light type.
Here is the caller graph for this function:
◆ GetNumShadowSplits()
| int Urho3D::Light::GetNumShadowSplits | ( | ) | const |
Return number of shadow map cascade splits for a directional light, considering also graphics API limitations.
Here is the call graph for this function:
◆ GetPerVertex()
|
inline |
Return vertex lighting mode.
Here is the caller graph for this function:
◆ GetRadius()
|
inline |
Return area light mode radius. Works only with PBR shaders.
Here is the caller graph for this function:
◆ GetRampTexture()
|
inline |
Return range attenuation texture.
◆ GetRange()
|
inline |
Return range.
Here is the caller graph for this function:
◆ GetShadowBias()
|
inline |
Return shadow depth bias parameters.
◆ GetShadowCascade()
|
inline |
Return directional light cascaded shadow parameters.
◆ GetShadowFadeDistance()
|
inline |
Return shadow fade start distance.
Here is the caller graph for this function:
◆ GetShadowFocus()
|
inline |
Return shadow map focus parameters.
Here is the caller graph for this function:
◆ GetShadowIntensity()
|
inline |
Return light intensity in shadow.
Here is the caller graph for this function:
◆ GetShadowMaxExtrusion()
|
inline |
Return maximum shadow extrusion distance for directional lights.
Here is the caller graph for this function:
◆ GetShadowNearFarRatio()
|
inline |
Return shadow camera near/far clip distance ratio.
◆ GetShadowResolution()
|
inline |
Return shadow resolution.
Here is the caller graph for this function:
◆ GetShapeTexture()
|
inline |
Return spotlight attenuation texture.
◆ GetSpecularIntensity()
|
inline |
Return specular intensity.
Here is the caller graph for this function:
◆ GetTemperature()
|
inline |
Return the temperature of the light in Kelvin.
Here is the caller graph for this function:
◆ GetUsePhysicalValues()
|
inline |
Return if light uses temperature and brightness in lumens.
◆ IsNegative()
|
inline |
Return whether light has negative (darkening) color.
Here is the caller graph for this function:
◆ SetAspectRatio()
| void Urho3D::Light::SetAspectRatio | ( | float | aspectRatio | ) |
Set spotlight aspect ratio.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ 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.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ SetColor()
| void Urho3D::Light::SetColor | ( | const Color & | color | ) |
Set color.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ SetFadeDistance()
| void Urho3D::Light::SetFadeDistance | ( | float | distance | ) |
Set fade out start distance.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ SetFov()
| void Urho3D::Light::SetFov | ( | float | fov | ) |
Set spotlight field of view.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ SetLength()
| void Urho3D::Light::SetLength | ( | float | length | ) |
Set tube area light length. Works only with PBR shaders.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ SetLightType()
| void Urho3D::Light::SetLightType | ( | LightType | type | ) |
Set light type.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ SetPerVertex()
| void Urho3D::Light::SetPerVertex | ( | bool | enable | ) |
Set vertex lighting mode.
Here is the call graph for this function:
◆ SetRadius()
| void Urho3D::Light::SetRadius | ( | float | radius | ) |
Set area light radius. Greater than zero activates area light mode. Works only with PBR shaders.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ SetRampTexture()
| void Urho3D::Light::SetRampTexture | ( | Texture * | texture | ) |
Set range attenuation texture.
Here is the call graph for this function:
◆ SetRange()
| void Urho3D::Light::SetRange | ( | float | range | ) |
Set range.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ SetShadowBias()
| void Urho3D::Light::SetShadowBias | ( | const BiasParameters & | parameters | ) |
Set shadow depth bias parameters.
Here is the call graph for this function:
◆ SetShadowCascade()
| void Urho3D::Light::SetShadowCascade | ( | const CascadeParameters & | parameters | ) |
Set directional light cascaded shadow parameters.
Here is the call graph for this function:
◆ SetShadowFadeDistance()
| void Urho3D::Light::SetShadowFadeDistance | ( | float | distance | ) |
Set shadow fade out start distance. Only has effect if shadow distance is also non-zero.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ SetShadowFocus()
| void Urho3D::Light::SetShadowFocus | ( | const FocusParameters & | parameters | ) |
Set shadow map focusing parameters.
Here is the call graph for this function:
◆ 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.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ 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.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ 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.
Here is the call graph for this function:
◆ SetShadowResolution()
| void Urho3D::Light::SetShadowResolution | ( | float | resolution | ) |
Set shadow resolution between 0.25 - 1.0. Determines the shadow map to use.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ SetShapeTexture()
| void Urho3D::Light::SetShapeTexture | ( | Texture * | texture | ) |
Set spotlight attenuation texture.
Here is the call graph for this function:
◆ SetSpecularIntensity()
| void Urho3D::Light::SetSpecularIntensity | ( | float | intensity | ) |
Set specular intensity. Zero disables specular calculations.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ SetTemperature()
| void Urho3D::Light::SetTemperature | ( | float | temperature | ) |
Set temperature of the light in Kelvin. Modulates the light color when "use physical values" is enabled.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ SetUsePhysicalValues()
| void Urho3D::Light::SetUsePhysicalValues | ( | bool | enable | ) |
Set use physical light values.
Here is the call graph for this function:
The documentation for this class was generated from the following files:
- Source/Urho3D/Graphics/Light.h
- Source/Urho3D/Graphics/Light.cpp