目录

Light

Class Info

class Light : public IComponent

灯光类。主要提供灯光颜色,类型,强度,光源位置,光照方向、聚光灯内外切角、冯氏光照模型参数的设置及获取等功能。

Public Constructor Summary

Constructor Name

Light(SceneObject* sceneObject = nullptr)

构造函数。

Public Destructor Summary

Destructor Name

virtual ~Light()

析构函数。

Public Method Summary

Qualifier and Type

Method Name and Description

virtual void

Start() override

创建灯光信息,初始化灯光的颜色、位置、照射方向、类型。

virtual void

Update(f32 deltaTime) override

更新灯光的位置(点光源、聚光灯)或方向(平行光)。

void

SetLightType(LightType type)

设置灯光类型。

void

SetColor(const Vector3& color)

设置灯光颜色。

void

SetIntensity(f32 intensity)

设置灯光强度。

void

SetPosition(const Vector3& position)

设置光源位置。

void

SetDirection(const Vector3& direction)

设置灯光照射方向。

void

SetCutoff(const Vector2& cutoff)

设置聚光灯的内外切角信息。

void

SetAmbient(const Vector3& ambient)

设置光源的ambient分量。

void

SetDiffuse(const Vector3& diffuse)

设置光源的diffuse分量。

void

SetSpecular(const Vector3& specular)

设置光源的specular分量。

void

SetAttenuation(const Vector3& attenuation)

设置光源的衰减项。

void

SetRange(f32 range)

设置从光源中心发射的光的传播距离(仅限点光源)。

LightType

GetLightType() const

获取灯光类型,如平行光、点光源。

Vector3

GetColor() const

获取灯光颜色。

f32

GetIntensity() const

获取灯光强度。

Vector3

GetPosition() const

获取光源位置。

Vector3

GetDirection() const

获取灯光照射方向。

Vector2

GetCutoff() const

获取聚光灯的内外切角信息。

Vector3

GetAmbient() const

获取光源的ambient分量。

Vector3

GetDiffuse() const

获取光源的diffuse分量。

Vector3

GetSpecular() const

获取光源的specular分量。

Vector3

GetAttenuation() const

获取光源的衰减项。

f32

GetRange() const

获取从光源中心发射的光的传播距离(仅限点光源)。

bool

SetShadowParam(bool shadowEnable, u32 cascadeCount = 2)

设置阴影参数(仅限方向光)。

bool

IsShadowEnable() const

判断阴影功能是否开启(仅限方向光)。

const Texture*

GetShadowTexture() const

获取阴影贴图纹理。

void

SetShadowVisable(bool isShadowVisable)

设置阴影的显示和隐藏。

bool

IsShadowVisable() const

查询阴影是否显示。

u32

GetShadowCascadeCount() const

获取阴影级联拆分的值。

void

SetShadowInfoCascadeViewProjMatrixUniformBuffer(UniformBuffer& uniformBuffer)

更新一致性变量级联拆分的值。

Public Constructors

[h2]Light

Constructor

Light(SceneObject* sceneObject = nullptr)

构造函数。

Parameters

Name

Description

sceneObject

指定初始化的场景对象。

Public Destructors

[h2]~Light

Destructor

virtual ~Light()

析构函数。

Public Methods

[h2]Start

Method

virtual void Start() override

创建灯光信息,初始化灯光的颜色、位置、照射方向、类型。

[h2]Update

Method

virtual void Update(f32 deltaTime) override

更新灯光的位置(点光源、聚光灯)或方向(平行光)。

Parameters

Name

Description

deltaTime

帧间隔时间,单位为秒。

[h2]SetLightType

Method

void SetLightType(LightType type)

设置灯光类型。

Parameters

Name

Description

type

LightType类型的灯光类型,如平行光、点光源。

[h2]SetColor

Method

void SetColor(const Vector3& color)

设置灯光颜色。

Parameters

Name

Description

color

Vector3类型的灯光颜色,取值范围为(0.0, 1.0)。

[h2]SetIntensity

Method

void SetIntensity(f32 intensity)

设置灯光强度。

Parameters

Name

Description

intensity

浮点类型的灯光强度。可以是任意大于0的值,默认为1.0。

[h2]SetPosition

Method

void SetPosition(const Vector3& position)

设置光源位置。

Parameters

Name

Description

position

Vector3类型的光源位置。

[h2]SetDirection

Method

void SetDirection(const Vector3& direction)

设置灯光照射方向。

Parameters

Name

Description

direction

Vector3类型的灯光照射方向。

[h2]SetCutoff

Method

void SetCutoff(const Vector2& cutoff)

设置聚光灯的内外切角信息。

Parameters

Name

Description

cutoff

Vector2类型的内外切角值。

[h2]SetAmbient

Method

void SetAmbient(const Vector3& ambient)

设置光源的ambient分量。

Parameters

Name

Description

ambient

Vector3类型的颜色值。

[h2]SetDiffuse

Method

void SetDiffuse(const Vector3& diffuse)

设置光源的diffuse分量。

Parameters

Name

Description

diffuse

Vector3类型的颜色值。

[h2]SetSpecular

Method

SetSpecular(const Vector3& specular)

设置光源的specular分量。

Parameters

Name

Description

specular

Vector3类型的颜色值。

[h2]SetAttenuation

Method

void SetAttenuation(const Vector3& attenuation)

设置光源的衰减项。

Parameters

Name

Description

attenuation

Vector3类型的常数衰减项,一次衰减项,二次衰减项。

[h2]SetRange

Method

void SetRange(f32 range)

设置从光源中心发射的光的传播距离(仅限点光源)。

Parameters

Name

Description

range

f32类型的传播距离。取值为任意大于0的值,默认为1.0。

[h2]GetLightType

Method

LightType GetLightType() const

获取灯光类型,如平行光、点光源。

Returns

Type

Description

LightType

返回LightType类型的灯光类型,如平行光、点光源。

[h2]GetColor

Method

Vector3 GetColor() const

获取灯光颜色。

Returns

Type

Description

Vector3

返回Vector3类型的灯光颜色。

[h2]GetIntensity

Method

f32 GetIntensity() const

获取灯光强度。

Returns

Type

Description

f32

返回浮点类型灯光强度。

[h2]GetPosition

Method

Vector3 GetPosition() const

获取光源位置。

Returns

Type

Description

Vector3

返回Vector3类型光源位置。

[h2]GetDirection

Method

Vector3 GetDirection() const

获取灯光照射方向。

Returns

Type

Description

Vector3

返回Vector3类型灯光照射方向。

[h2]GetCutoff

Method

Vector2 GetCutoff() const

获取聚光灯的内外切角信息。

Returns

Type

Description

Vector2

返回Vector2类型的内外切角值。

[h2]GetAmbient

Method

Vector3 GetAmbient() const

获取光源的ambient分量,返回Vector3类型的颜色值。

Returns

Type

Description

Vector3

返回Vector3类型的颜色值。

[h2]GetDiffuse

Method

Vector3 GetDiffuse() const

获取光源的diffuse分量,返回Vector3类型的颜色值。

Returns

Type

Description

Vector3

返回Vector3类型的颜色值。

[h2]GetSpecular

Method

Vector3 GetSpecular() const

获取光源的specular分量,返回Vector3类型的颜色值。

Returns

Type

Description

Vector3

返回Vector3类型的颜色值。

[h2]GetAttenuation

Method

Vector3 GetAttenuation() const

获取光源的衰减项,返回Vector3类型的常数衰减项,一次衰减项,二次衰减项。

Returns

Type

Description

Vector3

返回Vector3类型的常数衰减项,一次衰减项,二次衰减项。

[h2]GetRange

Method

f32 GetRange() const

获取从光源中心发射的光的传播距离(仅限点光源)。

Returns

Type

Description

f32

返回f32类型的从光源中心发射的光的传播距离(仅限点光源)。

[h2]SetShadowParam

Method

bool SetShadowParam(bool shadowEnable, u32 cascadeCount = 2)

设置阴影参数。

Parameters

Name

Description

shadowEnable

是否开启阴影功能。

  • true:开启。
  • false:不开启。

cascadeCount

级联阴影贴图数量(仅限方向光)。取值范围为:2,3,4。

Returns

Type

Description

bool

设置阴影参数是否成功(仅限方向光)。

  • true:成功。
  • false:失败。

[h2]IsShadowEnable

Method

bool IsShadowEnable() const

查询阴影功能是否开启(仅限方向光)。

Returns

Type

Description

bool

查询阴影功能是否开启(仅限方向光)。

  • true:开启。
  • false:未开启。

[h2]GetShadowTexture

Method

const Texture* GetShadowTexture() const

获取阴影贴图的纹理。

Returns

Type

Description

const Texture*

阴影贴图的纹理指针。

[h2]SetShadowVisable

Method

void SetShadowVisable(bool isShadowVisable)

设置阴影的显示和隐藏。

Parameters

Name

Description

isShadowVisable

阴影的显示和隐藏。

  • true:显示。
  • false:隐藏。

[h2]IsShadowVisable

Method

bool IsShadowVisable() const

查询阴影功能是否显示。

Returns

Type

Description

bool

查询阴影功能是否显示。

  • true:显示。
  • false:不显示。

[h2]GetShadowCascadeCount

Method

u32 GetShadowCascadeCount() const

获取阴影级联拆分的值。

Returns

Type

Description

u32

级联拆分的值。

[h2]SetShadowInfoCascadeViewProjMatrixUniformBuffer

Method

void SetShadowInfoCascadeViewProjMatrixUniformBuffer(UniformBuffer& uniformBuffer)

更新一致性变量级联拆分的值。

Parameters

Name

Description

uniformBuffer

一致性变量缓存。