Urho3D
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
Urho3D::Light Class Reference

Light component. More...

#include <Light.h>

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

List of all members.

Public Member Functions

 Light (Context *context)
 Construct.
virtual ~Light ()
 Destruct.
virtual void OnSetAttribute (const AttributeInfo &attr, const Variant &src)
 Handle attribute change.
virtual void ProcessRayQuery (const RayOctreeQuery &query, PODVector< RayQueryResult > &results)
 Process octree raycast. May be called from a worker thread.
virtual void UpdateBatches (const FrameInfo &frame)
 Calculate distance and prepare batches for rendering. May be called from worker thread(s), possibly re-entrantly.
virtual void DrawDebugGeometry (DebugRenderer *debug, bool depthTest)
 Visualize the component as debug geometry.
void SetLightType (LightType type)
 Set light type.
void SetPerVertex (bool enable)
 Set vertex lighting mode.
void SetColor (const Color &color)
 Set color.
void SetSpecularIntensity (float intensity)
 Set specular intensity.
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 shadow intensity 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.
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 ColorGetColor () const
 Return color.
float GetSpecularIntensity () const
 Return specular intensity.
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 BiasParametersGetShadowBias () const
 Return shadow depth bias parameters.
const CascadeParametersGetShadowCascade () const
 Return directional light cascaded shadow parameters.
const FocusParametersGetShadowFocus () const
 Return shadow map focus parameters.
float GetShadowIntensity () const
 Return shadow intensity.
float GetShadowResolution () const
 Return shadow resolution.
float GetShadowNearFarRatio () const
 Return shadow camera near/far clip distance ratio.
TextureGetRampTexture () const
 Return range attenuation texture.
TextureGetShapeTexture () const
 Return spotlight attenuation texture.
Frustum GetFrustum () const
 Return spotlight frustum.
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.
Matrix3x4 GetDirLightTransform (Camera *camera, bool getNearQuad=false)
 Return directional light quad transform for either near or far split.
const Matrix3x4GetVolumeTransform (Camera *camera)
 Return light volume model transform.
LightBatchQueueGetLightQueue () const
 Return light queue. Called by View.
void SetRampTextureAttr (ResourceRef value)
 Set ramp texture attribute.
void SetShapeTextureAttr (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.
virtual ~Drawable ()
 Destruct.
virtual void Update (const FrameInfo &frame)
 Update before octree reinsertion. Is called from a worker thread. Needs to be requested with MarkForUpdate().
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)
 Set draw distance.
void SetShadowDistance (float distance)
 Set shadow draw distance.
void SetLodBias (float bias)
 Set LOD bias.
void SetViewMask (unsigned mask)
 Set view mask. Is and'ed with camera's view mask to see if the object should be rendered.
void SetLightMask (unsigned 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 (unsigned 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 (unsigned mask)
 Set zone mask. Is and'ed with zone's zone mask to see if the object should belong to the zone.
void SetMaxLights (unsigned num)
 Set maximum number of per-pixel lights. Default 0 is unlimited.
void SetVisible (bool enable)
 Set visible flag.
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 before octree reinsertion.
const BoundingBoxGetWorldBoundingBox ()
 Return world bounding box.
unsigned char GetDrawableFlags () const
 Return drawable flags.
float GetDrawDistance () const
 Return draw distance.
float GetShadowDistance () const
 Return shadow draw distance.
float GetLodBias () const
 Return LOD bias.
unsigned GetViewMask () const
 Return view mask.
unsigned GetLightMask () const
 Return light mask.
unsigned GetShadowMask () const
 Return shadow mask.
unsigned GetZoneMask () const
 Return zone mask.
unsigned GetMaxLights () const
 Return maximum number of per-pixel lights.
bool IsVisible () const
 Return visible flag.
bool GetCastShadows () const
 Return shadowcaster flag.
bool IsOccluder () const
 Return occluder flag.
bool IsOccludee () const
 Return occludee flag.
const Vector< SourceBatch > & GetBatches () const
 Return draw call source data.
void SetZone (Zone *zone, bool temporary=false)
 Set new zone.
void SetSortValue (float value)
 Set sorting value.
void SetMinMaxZ (float minZ, float maxZ)
 Set view-space depth bounds.
void MarkInView (const FrameInfo &frame, bool mainView=true)
 Mark in view (either the main camera, or a shadow camera view) this frame.
void ClearLights ()
 Clear lights and base pass flags for a new frame.
void AddLight (Light *light)
 Add a per-pixel light.
void AddVertexLight (Light *light)
 Add a per-vertex light.
void LimitLights ()
 Sort and limit per-pixel lights to maximum allowed. Convert extra lights into vertex lights.
void LimitVertexLights ()
 Sort and limit per-vertex lights to maximum allowed.
void SetBasePass (unsigned batchIndex)
 Set base pass flag for a batch.
OctantGetOctant () const
 Return octree octant.
ZoneGetZone () const
 Return current zone.
ZoneGetLastZone () const
 Return previous zone.
float GetDistance () const
 Return distance from camera.
float GetLodDistance () const
 Return LOD scaled distance from camera.
float GetSortValue () const
 Return sorting value.
bool IsInView (unsigned frameNumber) const
 Return whether is in view this frame.
bool IsInView (const FrameInfo &frame, bool mainView=true) const
 Return whether is visible in a specific view this frame.
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.
LightGetFirstLight () 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.
- Public Member Functions inherited from Urho3D::Component
 Component (Context *context)
 Construct.
virtual ~Component ()
 Destruct.
virtual bool Save (Serializer &dest)
 Save as binary data. Return true if successful.
virtual bool SaveXML (XMLElement &dest)
 Save as XML data. Return true if successful.
virtual void GetDependencyNodes (PODVector< Node * > &dest)
 Return the depended on nodes to order network updates.
void Remove ()
 Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
unsigned GetID () const
 Return ID.
NodeGetNode () const
 Return scene node.
SceneGetScene () const
 Return the scene the node belongs to.
void GetComponents (PODVector< Component * > &dest, ShortStringHash type) const
 Return components in the same scene node by type.
ComponentGetComponent (ShortStringHash 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.
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.
void MarkNetworkUpdate ()
 Mark for attribute check on the next network update.
- Public Member Functions inherited from Urho3D::Serializable
 Serializable (Context *context)
 Construct.
virtual ~Serializable ()
 Destruct.
virtual void OnGetAttribute (const AttributeInfo &attr, Variant &dest)
 Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor.
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 void ApplyAttributes ()
 Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
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 AllocateNetworkState ()
 Allocate network attribute state.
void WriteInitialDeltaUpdate (Serializer &dest)
 Write initial delta network update.
void WriteDeltaUpdate (Serializer &dest, const DirtyBits &attributeBits)
 Write a delta network update according to dirty attribute bits.
void WriteLatestDataUpdate (Serializer &dest)
 Write a latest data network update.
void ReadDeltaUpdate (Deserializer &source)
 Read and apply a network delta update.
void ReadLatestDataUpdate (Deserializer &source)
 Read and apply a network latest data update.
Variant GetAttribute (unsigned index)
 Return attribute value by index. Return empty if illegal index.
Variant GetAttribute (const String &name)
 Return attribute value by name. Return empty if not found.
unsigned GetNumAttributes () const
 Return number of attributes.
unsigned GetNumNetworkAttributes () const
 Return number of network replication attributes.
const Vector< AttributeInfo > * GetAttributes () const
 Return attribute descriptions, or null if none defined.
const Vector< AttributeInfo > * GetNetworkAttributes () const
 Return network replication attribute descriptions, or null if none defined.
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 Construct.
virtual ~Object ()
 Destruct. Clean up self from event sender & receiver structures.
virtual ShortStringHash GetType () const =0
 Return type hash.
virtual const StringGetTypeName () const =0
 Return type name.
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
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 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.
ContextGetContext () const
 Return execution context.
ObjectGetSubsystem (ShortStringHash 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.
template<class T >
T * GetSubsystem () const
 Template version of returning a subsystem.
- 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.
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.
RefCountRefCountPtr ()
 Return pointer to the reference count structure.

Static Public Member Functions

static void RegisterObject (Context *context)
 Register object factory. Drawable must be registered first.

Protected Member Functions

virtual void OnWorldBoundingBoxUpdate ()
 Recalculate the world-space bounding box.
- Protected Member Functions inherited from Urho3D::Drawable
virtual void OnNodeSet (Node *node)
 Handle node being assigned.
virtual void OnMarkedDirty (Node *node)
 Handle node transform being dirtied.
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 SetID (unsigned id)
 Set ID. Called by Scene.
void SetNode (Node *node)
 Set scene node. Called by Node when creating the component.

Private Member Functions

 OBJECT (Light)

Private Attributes

LightType lightType_
 Light type.
Color color_
 Color.
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.
LightBatchQueuelightQueue_
 Light queue.
float specularIntensity_
 Specular intensity.
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_
 Shadow intensity.
float shadowResolution_
 Shadow resolution.
float shadowNearFarRatio_
 Shadow camera near/far clip distance ratio.
bool perVertex_
 Per-vertex lighting flag.

Additional Inherited Members

- Protected Attributes inherited from Urho3D::Drawable
BoundingBox worldBoundingBox_
 World bounding box.
Vector< SourceBatchbatches_
 Draw call source data.
unsigned char drawableFlags_
 Drawable flags.
bool worldBoundingBoxDirty_
 Bounding box dirty flag.
bool visible_
 Visible flag.
bool castShadows_
 Shadowcaster flag.
bool occluder_
 Occluder flag.
bool occludee_
 Occludee flag.
bool updateQueued_
 Octree update queued flag.
bool reinsertionQueued_
 Octree reinsertion queued flag.
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.
unsigned maxLights_
 Maximum lights.
Octantoctant_
 Octree octant.
LightfirstLight_
 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.
WeakPtr< Zonezone_
 Current zone.
WeakPtr< ZonelastZone_
 Previous zone.
const FrameInfoviewFrame_
 Last view's frameinfo. Not safe to dereference.
CameraviewCamera_
 Last view's camera. Not safe to dereference.
bool temporaryZone_
 Zone assignment temporary flag.
- Protected Attributes inherited from Urho3D::Component
Nodenode_
 Scene node.
unsigned id_
 Unique ID within the scene.
bool networkUpdate_
 Network update queued flag.
- Protected Attributes inherited from Urho3D::Serializable
NetworkStatenetworkState_
 Network attribute state.
- Protected Attributes inherited from Urho3D::Object
Contextcontext_
 Execution context.

Detailed Description

Light component.


Member Function Documentation

Matrix3x4 Urho3D::Light::GetDirLightTransform ( Camera camera,
bool  getNearQuad = false 
)

Return directional light quad transform for either near or far split.

Todo:
Rather set an identity projection matrix

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