Show / Hide Table of Contents

Class LightResult

This struct saves a light and all its parameters, as found by a Visitor.

Inheritance
System.Object
LightResult
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Fusee.Engine.Core
Assembly: Fusee.Engine.Core.dll
Syntax
public class LightResult

Constructors

LightResult()

Creates a new instance of type LightResult.

Declaration
public LightResult()

LightResult(Light)

Creates a new instance of type LightResult.

Declaration
public LightResult(Light light)
Parameters
Type Name Description
Light light

The LightComponent.

Fields

Id

The session unique identifier of tis LightResult.

Declaration
public Suid Id
Field Value
Type Description
Suid

Light

The light component as present (1 to n times) in the scene graph.

Declaration
public Light Light
Field Value
Type Description
Light

Properties

Rotation

The rotation matrix. Determines the direction of the light, also set while traversing the scene graph.

Declaration
public float4x4 Rotation { get; set; }
Property Value
Type Description
float4x4

WorldSpacePos

It should be possible for one instance of type LightComponent to be used multiple times in the scene graph. Therefore the LightComponent itself has no position information - it gets set while traversing the scene graph.

Declaration
public float3 WorldSpacePos { get; set; }
Property Value
Type Description
float3

Methods

Equals(Object)

Override for the Equals method.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj

The object to compare with.

Returns
Type Description
System.Boolean
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Override of the GetHashCode method. Returns the session unique identifier as hash code.

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()

Operators

Equality(LightResult, LightResult)

Override of the == operator.

Declaration
public static bool operator ==(LightResult thisLc, LightResult otherLc)
Parameters
Type Name Description
LightResult thisLc

The first LightResult that will be compared with a second one.

LightResult otherLc

The second LightResult that will be compared with the first one.

Returns
Type Description
System.Boolean

Inequality(LightResult, LightResult)

Override of the != operator.

Declaration
public static bool operator !=(LightResult thisLc, LightResult otherLc)
Parameters
Type Name Description
LightResult thisLc

The first LightResult that will be compared with a second one.

LightResult otherLc

The second LightResult that will be compared with the first one.

Returns
Type Description
System.Boolean
Generated by DocFX
GitHub Repo
Back to top