Search Results for

    Show / Hide Table of Contents

    Class DiskLight

    This class represents basic information about a disk area light.

    Inheritance
    object
    IdentifiableObject
    DependencyObject
    AttachableObject
    PrefabInstanceObject
    Component
    Light
    VolumeLight
    CubemapLight
    DiskLight
    PhotometricDiskAreaLight
    Implements
    IDependencyObject
    Inherited Members
    CubemapLight.CascadeCount
    CubemapLight.DebugMode
    CubemapLight.Position
    VolumeLight.OnLightVolumeChanged
    VolumeLight.FireOnLightVolumeChanged()
    Light.ShadowMapManager
    Light.boundingFrustum
    Light.view
    Light.projection
    Light.renderProjection
    Light.viewProjection
    Light.renderViewProjection
    Light.Transform
    Light.color
    Light.shadowBias
    Light.shadowOpacity
    Light.OnIntensityChanged
    Light.OnColorChanged
    Light.OnShadowEnabledChanged
    Light.IsShadowEnabled
    Light.BoundingFrustum
    Light.Projection
    Light.RenderProjection
    Light.View
    Light.ViewProjection
    Light.RenderViewProjection
    Light.ShadowBias
    Light.ShadowOpacity
    Light.Color
    Light.LinearColor
    Light.Intensity
    Light.LightDrawContext
    Light.FireOnShadowEnabledChanged()
    Component.Owner
    Component.Managers
    Component.ShouldBeActivated
    Component.Clone()
    Component.Attach(Entity)
    Component.OnLoaded()
    Component.OnActivated()
    Component.Start()
    Component.OnDeactivated()
    Component.OnDestroy()
    PrefabInstanceObject.PrefabSource
    PrefabInstanceObject.RefreshPrefab(Prefab)
    PrefabInstanceObject.PrefabElementId
    PrefabInstanceObject.IsPrefabInstance
    PrefabInstanceObject.IsMissingPrefabSource
    AttachableObject.AttachableStateChanged
    AttachableObject.IsEnabled
    AttachableObject.State
    AttachableObject.IsLoaded
    AttachableObject.IsAttached
    AttachableObject.IsActivated
    AttachableObject.IsStarted
    AttachableObject.IsDestroyed
    AttachableObject.Destroy()
    AttachableObject.DependencyBroken()
    DependencyObject.Dependencies
    DependencyObject.OnDependencyRemoved
    IdentifiableObject.Id
    IdentifiableObject.IdHasChanged(Guid)
    Namespace: Evergine.Framework.Graphics
    Assembly: Evergine.Framework.dll
    Syntax
    public class DiskLight : CubemapLight, IDependencyObject

    Constructors

    DiskLight()

    Initializes a new instance of the DiskLight class.

    Declaration
    public DiskLight()

    Properties

    Direction

    Gets the rectangular light direction.

    Declaration
    public Vector3 Direction { get; }
    Property Value
    Type Description
    Vector3

    Falloff

    Gets the light falloff (1 / LightRange^2).

    Declaration
    public float Falloff { get; }
    Property Value
    Type Description
    float

    LightRange

    Gets or sets the light range value.

    Declaration
    public override float LightRange { get; set; }
    Property Value
    Type Description
    float
    Overrides
    CubemapLight.LightRange

    LightType

    Gets the type of light.

    Declaration
    public override LightType LightType { get; }
    Property Value
    Type Description
    LightType
    Overrides
    Light.LightType

    Radius

    Gets or sets the width of the rectangle.

    Declaration
    public float Radius { get; set; }
    Property Value
    Type Description
    float

    Up

    Gets the rectangle light direction.

    Declaration
    public Vector3 Up { get; }
    Property Value
    Type Description
    Vector3

    Methods

    ComputeBoundingBox(out BoundingBox)

    Computes the bounding box of the light.

    Declaration
    public override void ComputeBoundingBox(out BoundingBox boundingBox)
    Parameters
    Type Name Description
    BoundingBox boundingBox

    The bounding box.

    Overrides
    Light.ComputeBoundingBox(out BoundingBox)

    Intersects(ref BoundingBox)

    Checks if the current light intersects with the specified bbox.

    Declaration
    public override bool Intersects(ref BoundingBox bbox)
    Parameters
    Type Name Description
    BoundingBox bbox
    Returns
    Type Description
    bool

    Whether the light is inside the frustum view.

    Overrides
    Light.Intersects(ref BoundingBox)

    Intersects(ref BoundingFrustum)

    Checks if the current light is inside the specified frustum.

    Declaration
    public override bool Intersects(ref BoundingFrustum frustum)
    Parameters
    Type Name Description
    BoundingFrustum frustum

    The frustum.

    Returns
    Type Description
    bool

    Whether the light is inside the frustum view.

    Overrides
    Light.Intersects(ref BoundingFrustum)

    OnAttached()

    Attaches the camera to the system.

    Declaration
    protected override bool OnAttached()
    Returns
    Type Description
    bool

    True if everything is OK.

    Overrides
    Light.OnAttached()

    OnDetach()

    Detaches the camera from the system.

    Declaration
    protected override void OnDetach()
    Overrides
    Light.OnDetach()

    Implements

    IDependencyObject

    Extension Methods

    ReflectionHelper.GetMemberAssembly(object)
    ReflectionHelper.GetTypeName(object)
    In this article
    Back to top
    Generated by DocFX