M3D / M3D / Shapes / DirectionalLight

Class: DirectionalLight

M3D.Shapes.DirectionalLight

Memberof

M3D.Shapes

Description

平行光

Date

2022-1-12

Version

1.0

Copyright

All Rights Reserved. Copyright (C) 2022 HOTEAMSOFT, Ltd

Hierarchy

• Light

  ↳ DirectionalLight

Table of contents

Constructors

• constructor

Properties

• id
• count
• isProto
• pVertexHeader

Accessors

• isProto

Methods

• addEffect
• getAlpha
• getAmbient
• getAspectRatio
• getBoundingBox
• getBrightness
• getCastShadow
• getColor
• getConstantAttenuation
• getDiffuse
• getDrawables
• getEffect
• getEffectiveColor
• getEffectiveSpecularIntensity
• getEvents
• getFov
• getId
• getIntensity
• getIsFrontShow
• getIsInWorld
• getIsTurnOn
• getLightColor
• getLightDirection
• getLightId
• getLightModelAmbient
• getLightShadow
• getLightSourceType
• getLightType
• getLinearAttenuation
• getLocalTransform
• getName
• getNeedClip
• getNeedUpdateInfo
• getNodeWorldPosition
• getObjectId
• getPerVertex
• getPosition
• getPositionOld
• getProperties
• getProto
• getQuadraticAttenuation
• getRange
• getRenderColor
• getRenderShapes
• getRenderWorldMatrix
• getRotation
• getScene
• getShapeType
• getShowAllSign
• getShowSimpleSign
• getSpecular
• getSpotCosCutoff
• getSpotCutoff
• getSpotDirection
• getSpotExponent
• getType
• getWorldBoundingBox
• getWorldPosition
• getWorldRotation
• getWorldTransform
• isPreSelected
• isSelected
• isVisible
• post
• registerEvent
• removeEffect
• removeEvent
• send
• sendClipMessage
• sendEffectMessage
• setAlpha
• setAmbient
• setAspectRatio
• setBrightness
• setCastShadow
• setColor
• setConstantAttenuation
• setDiffuse
• setEffect
• setFov
• setFrontShow
• setId
• setIntensity
• setIsInWorld
• setIsTurnOn
• setLightColor
• setLightDirection
• setLightId
• setLightModelAmbient
• setLightSourceType
• setLightType
• setLinearAttenuation
• setName
• setNeedClip
• setNeedUpdateInfo
• setNodeWorldPosition
• setObjectId
• setPerVertex
• setPosition
• setPositionOld
• setQuadraticAttenuation
• setRange
• setRenderWorldMatrix
• setScene
• setSelected
• setShapeType
• setShowAllSign
• setShowSimpleSign
• setSpecular
• setSpotCosCutoff
• setSpotCutoff
• setSpotDirection
• setSpotExponent
• setVisible
• setWorldPosition
• setWorldRotation
• setWorldTransform
• update

Constructors

constructor

• new DirectionalLight(): DirectionalLight

Returns

DirectionalLight

Description

构造函数

Overrides

Light.constructor

Properties

id

• id: number

Inherited from

Light.id

---

count

▪ Static count: number

Inherited from

Light.count

---

isProto

▪ Static isProto: string

Inherited from

Light.isProto

---

pVertexHeader

▪ Static pVertexHeader: string

Inherited from

Light.pVertexHeader

Accessors

isProto

• get isProto(): boolean

Returns

boolean

Description

获取是否为原型对象

Inherited from

Light.isProto

• set isProto(v): void

Parameters

Name	Type
v	boolean

Returns

void

Description

设置是否为原型对象

Inherited from

Light.isProto

Methods

addEffect

▸ addEffect(effectType): void

Parameters

Name	Type
effectType	number

Returns

void

Description

添加特效效果

Inherited from

Light.addEffect

---

getAlpha

▸ getAlpha(): number

Returns

number

Description

获取透明度

Inherited from

Light.getAlpha

---

getAmbient

▸ getAmbient(): Color

Returns

Color

Description

获取环境光颜色

---

getAspectRatio

▸ getAspectRatio(): number

Returns

number

Description

获取聚光灯长宽比

---

getBoundingBox

▸ getBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取包围盒

Inherited from

Light.getBoundingBox

---

getBrightness

▸ getBrightness(): number

Returns

number

Description

获取亮度

---

getCastShadow

▸ getCastShadow(): boolean

Returns

boolean

Description

获取是否采用投射阴影

Inherited from

Light.getCastShadow

---

getColor

▸ getColor(): Color

Returns

Color

Description

获取颜色

Inherited from

Light.getColor

---

getConstantAttenuation

▸ getConstantAttenuation(): number

Returns

number

Description

获取ConstantAttenuation参数

---

getDiffuse

▸ getDiffuse(): Color

Returns

Color

Description

获取漫反射光颜色

---

getDrawables

▸ getDrawables(): void

Returns

void

Description

获取渲染数据

Inherited from

Light.getDrawables

---

getEffect

▸ getEffect(): number

Returns

number

Description

获取效果

Inherited from

Light.getEffect

---

getEffectiveColor

▸ getEffectiveColor(): Color

Returns

Color

Description

获取有效颜色，与亮度相乘。（不乘透明度，以便与默认的黑色进行比较，检测没有效果的光）

---

getEffectiveSpecularIntensity

▸ getEffectiveSpecularIntensity(): number

Returns

number

Description

获取有效高光强度（高光强度 * 亮度绝对值）；

---

getEvents

▸ getEvents(): M3DEvent[]

Returns

M3DEvent[]

Description

获得事件列表

Inherited from

Light.getEvents

---

getFov

▸ getFov(): number

Returns

number

Description

获取聚光灯视野

---

getId

▸ getId(): number

Returns

number

Description

获取id

Inherited from

Light.getId

---

getIntensity

▸ getIntensity(): number

Returns

number

Description

获取光强

Overrides

Light.getIntensity

---

getIsFrontShow

▸ getIsFrontShow(): boolean

Returns

boolean

Description

获取是否前端显示

Inherited from

Light.getIsFrontShow

---

getIsInWorld

▸ getIsInWorld(): boolean

Returns

boolean

Description

获取是否在世界内

Inherited from

Light.getIsInWorld

---

getIsTurnOn

▸ getIsTurnOn(): boolean

Returns

boolean

Description

获取是否开启

Inherited from

Light.getIsTurnOn

---

getLightColor

▸ getLightColor(): Color

Returns

Color

Description

获取灯光颜色

Inherited from

Light.getLightColor

---

getLightDirection

▸ getLightDirection(): Vector3

Returns

Vector3

Description

获取灯光方向

Inherited from

Light.getLightDirection

---

getLightId

▸ getLightId(): number

Returns

number

Description

获取.info文件中灯光id

Inherited from

Light.getLightId

---

getLightModelAmbient

▸ getLightModelAmbient(): Color

Returns

Color

Description

获取LightModelAmbient

---

getLightShadow

▸ getLightShadow(): DirectionalLightShadow

Returns

DirectionalLightShadow

Description

获取灯光遮罩

Overrides

Light.getLightShadow

---

getLightSourceType

▸ getLightSourceType(): LightType

Returns

LightType

Description

获取光源类型

Inherited from

Light.getLightSourceType

---

getLightType

▸ getLightType(): LightType

Returns

LightType

Description

获取灯光类型

---

getLinearAttenuation

▸ getLinearAttenuation(): number

Returns

number

Description

获取LinearAttenuation参数

---

getLocalTransform

▸ getLocalTransform(): Matrix4

Returns

Matrix4

Description

获取shape的局部矩阵

Inherited from

Light.getLocalTransform

---

getName

▸ getName(): string

Returns

string

Description

获取实例名称

Inherited from

Light.getName

---

getNeedClip

▸ getNeedClip(): boolean

Returns

boolean

Description

获取是否需要剖切

Inherited from

Light.getNeedClip

---

getNeedUpdateInfo

▸ getNeedUpdateInfo(): boolean

Returns

boolean

Description

获取是否需要更新信息

Inherited from

Light.getNeedUpdateInfo

---

getNodeWorldPosition

▸ getNodeWorldPosition(): Vector3

Returns

Vector3

Description

获取节点位置

Inherited from

Light.getNodeWorldPosition

---

getObjectId

▸ getObjectId(): number

Returns

number

Description

获取ObjectId

Inherited from

Light.getObjectId

---

getPerVertex

▸ getPerVertex(): boolean

Returns

boolean

Description

获取是否使用逐顶点光照模式

---

getPosition

▸ getPosition(): Vector3

Returns

Vector3

Description

获取位置

Inherited from

Light.getPosition

---

getPositionOld

▸ getPositionOld(): Vector4

Returns

Vector4

Description

获取灯光位置

---

getProperties

▸ getProperties(): PropertySet

Returns

PropertySet

Description

获取属性管理器

Inherited from

Light.getProperties

---

getProto

▸ getProto(): Shape

Returns

Shape

Description

获取原型

Inherited from

Light.getProto

---

getQuadraticAttenuation

▸ getQuadraticAttenuation(): number

Returns

number

Description

获取QuadraticAttenuation参数

---

getRange

▸ getRange(): number

Returns

number

Description

获取范围

---

getRenderColor

▸ getRenderColor(): Color

Returns

Color

Description

获取绘制时的颜色

Inherited from

Light.getRenderColor

---

getRenderShapes

▸ getRenderShapes(): RenderableShape[]

Returns

RenderableShape[]

Description

获取可绘制对象列表

Inherited from

Light.getRenderShapes

---

getRenderWorldMatrix

▸ getRenderWorldMatrix(): Matrix4

Returns

Matrix4

Description

获取绘制时所需的世界矩阵

Inherited from

Light.getRenderWorldMatrix

---

getRotation

▸ getRotation(): Quaternion

Returns

Quaternion

Description

获取空间旋转信息

Inherited from

Light.getRotation

---

getScene

▸ getScene(): Scene

Returns

Scene

场景对象

Description

获取场景对象

Inherited from

Light.getScene

---

getShapeType

▸ getShapeType(): ShapeType

Returns

ShapeType

Description

获取Shape类型

Inherited from

Light.getShapeType

---

getShowAllSign

▸ getShowAllSign(): boolean

Returns

boolean

Description

获取是否显示所有标记（暂时记录在此，待完善）

Inherited from

Light.getShowAllSign

---

getShowSimpleSign

▸ getShowSimpleSign(): boolean

Returns

boolean

Description

获取是否显示简单标记（暂时记录在此，待完善）

Inherited from

Light.getShowSimpleSign

---

getSpecular

▸ getSpecular(): Color

Returns

Color

Description

获取高光颜色

---

getSpotCosCutoff

▸ getSpotCosCutoff(): number

Returns

number

Description

获取SpotCosCutoff

---

getSpotCutoff

▸ getSpotCutoff(): number

Returns

number

Description

获取SpotCutoff

---

getSpotDirection

▸ getSpotDirection(): Vector3

Returns

Vector3

Description

获取聚光灯方向

---

getSpotExponent

▸ getSpotExponent(): number

Returns

number

Description

获取聚光程度

---

getType

▸ getType(): ShapeType

Returns

ShapeType

Description

获取可见对象类型

Overrides

Light.getType

---

getWorldBoundingBox

▸ getWorldBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取世界包围盒

Inherited from

Light.getWorldBoundingBox

---

getWorldPosition

▸ getWorldPosition(): Vector3

Returns

Vector3

Description

获取世界位置

Inherited from

Light.getWorldPosition

---

getWorldRotation

▸ getWorldRotation(): Quaternion

Returns

Quaternion

Description

获取旋转角度

Inherited from

Light.getWorldRotation

---

getWorldTransform

▸ getWorldTransform(): Matrix4

Returns

Matrix4

Description

获取shape的世界矩阵

Inherited from

Light.getWorldTransform

---

isPreSelected

▸ isPreSelected(): boolean

Returns

boolean

Description

是否预选中

Inherited from

Light.isPreSelected

---

isSelected

▸ isSelected(): boolean

Returns

boolean

Description

是否被选中

Inherited from

Light.isSelected

---

isVisible

▸ isVisible(orginVisible?): boolean

Parameters

Name	Type	Description
orginVisible?	boolean	是否获取原始可见性

Returns

boolean

Description

获取可见性

Inherited from

Light.isVisible

---

post

▸ post(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息发送者必须实现方法

Inherited from

Light.post

---

registerEvent

▸ registerEvent(event): void

Parameters

Name	Type	Description
event	M3DEvent	M3D事件

Returns

void

Description

注册事件

Inherited from

Light.registerEvent

---

removeEffect

▸ removeEffect(effectType): void

Parameters

Name	Type
effectType	EffectType

Returns

void

Description

移除效果

Inherited from

Light.removeEffect

---

removeEvent

▸ removeEvent(): void

Returns

void

Description

删除事件

Inherited from

Light.removeEvent

---

send

▸ send(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息发送者必须实现方法

Inherited from

Light.send

---

sendClipMessage

▸ sendClipMessage(): void

Returns

void

Description

发送剖切更新消息

Inherited from

Light.sendClipMessage

---

sendEffectMessage

▸ sendEffectMessage(): void

Returns

void

Description

发送特效更新消息

Inherited from

Light.sendEffectMessage

---

setAlpha

▸ setAlpha(alpha): void

Parameters

Name	Type
alpha	number

Returns

void

Description

设置透明度

Inherited from

Light.setAlpha

---

setAmbient

▸ setAmbient(ambient): void

Parameters

Name	Type
ambient	Color

Returns

void

Description

设置环境光颜色

---

setAspectRatio

▸ setAspectRatio(aspectRatio): void

Parameters

Name	Type
aspectRatio	number

Returns

void

Description

设置聚光灯长宽比

---

setBrightness

▸ setBrightness(brightness): void

Parameters

Name	Type
brightness	number

Returns

void

Description

设置亮度（颜色和高光强度都会影响最后用于渲染的值）

---

setCastShadow

▸ setCastShadow(castShadow): void

Parameters

Name	Type	Description
castShadow	boolean	是否

Returns

void

Description

设置是否采用投射阴影

Inherited from

Light.setCastShadow

---

setColor

▸ setColor(color): void

Parameters

Name	Type
color	Color

Returns

void

Description

设置颜色

Inherited from

Light.setColor

---

setConstantAttenuation

▸ setConstantAttenuation(constantAttenuation): void

Parameters

Name	Type
constantAttenuation	number

Returns

void

Description

设置ConstantAttenuation参数

---

setDiffuse

▸ setDiffuse(diffuse): void

Parameters

Name	Type
diffuse	Color

Returns

void

Description

设置漫反射光颜色

---

setEffect

▸ setEffect(effectType): void

Parameters

Name	Type
effectType	number

Returns

void

Description

设置效果，包括高亮、轮廓等

Inherited from

Light.setEffect

---

setFov

▸ setFov(fov): void

Parameters

Name	Type
fov	number

Returns

void

Description

设置聚光灯视野

---

setFrontShow

▸ setFrontShow(frontShow): void

Parameters

Name	Type
frontShow	boolean

Returns

void

Description

设置是否前端显示

Inherited from

Light.setFrontShow

---

setId

▸ setId(v): void

Parameters

Name	Type	Description
v	number	ShapeId

Returns

void

Description

设置id

Inherited from

Light.setId

---

setIntensity

▸ setIntensity(intensity): void

Parameters

Name	Type
intensity	number

Returns

void

Description

设置光强（强度为0时，禁用高光计算）

Overrides

Light.setIntensity

---

setIsInWorld

▸ setIsInWorld(value): void

Parameters

Name	Type
value	boolean

Returns

void

Description

设置是否在世界内

Inherited from

Light.setIsInWorld

---

setIsTurnOn

▸ setIsTurnOn(value): void

Parameters

Name	Type
value	boolean

Returns

void

Description

设置是否开启

Inherited from

Light.setIsTurnOn

---

setLightColor

▸ setLightColor(val): void

Parameters

Name	Type	Description
val	Color	颜色

Returns

void

Description

设置灯光颜色

Inherited from

Light.setLightColor

---

setLightDirection

▸ setLightDirection(value): void

Parameters

Name	Type
value	Vector3

Returns

void

Description

设置灯光方向

Inherited from

Light.setLightDirection

---

setLightId

▸ setLightId(id): void

Parameters

Name	Type
id	number

Returns

void

Description

设置.info文件中灯光id

Inherited from

Light.setLightId

---

setLightModelAmbient

▸ setLightModelAmbient(lightModelAmbient): void

Parameters

Name	Type
lightModelAmbient	Color

Returns

void

Description

设置LightModelAmbient

---

setLightSourceType

▸ setLightSourceType(val): void

Parameters

Name	Type	Description
val	LightType	光源类型

Returns

void

Description

设置光源类型

Inherited from

Light.setLightSourceType

---

setLightType

▸ setLightType(type): void

Parameters

Name	Type	Description
type	ShapeType	灯光类型

Returns

void

Description

设置灯光类型

---

setLinearAttenuation

▸ setLinearAttenuation(linearAttenuation): void

Parameters

Name	Type
linearAttenuation	number

Returns

void

Description

设置LinearAttenuation参数

---

setName

▸ setName(name): void

Parameters

Name	Type	Description
name	string	名称

Returns

void

Description

设置实例名称

Inherited from

Light.setName

---

setNeedClip

▸ setNeedClip(isClip): void

Parameters

Name	Type
isClip	boolean

Returns

void

Description

设置是否需要剖切

Inherited from

Light.setNeedClip

---

setNeedUpdateInfo

▸ setNeedUpdateInfo(val): void

Parameters

Name	Type	Description
val	boolean	是否

Returns

void

Description

设置是否需要更新信息

Inherited from

Light.setNeedUpdateInfo

---

setNodeWorldPosition

▸ setNodeWorldPosition(position): void

Parameters

Name	Type
position	Vector3

Returns

void

Description

设置节点位置

Inherited from

Light.setNodeWorldPosition

---

setObjectId

▸ setObjectId(id): void

Parameters

Name	Type
id	number

Returns

void

Description

设置ObjectId

Inherited from

Light.setObjectId

---

setPerVertex

▸ setPerVertex(enable): void

Parameters

Name	Type
enable	boolean

Returns

void

Description

设置是否使用逐顶点光照模式

---

setPosition

▸ setPosition(postion): void

Parameters

Name	Type	Description
postion	Vector3	位置

Returns

void

Description

设置位置

Inherited from

Light.setPosition

---

setPositionOld

▸ setPositionOld(position): void

Parameters

Name	Type
position	Vector4

Returns

void

Description

设置灯光位置

---

setQuadraticAttenuation

▸ setQuadraticAttenuation(quadraticAttenuation): void

Parameters

Name	Type
quadraticAttenuation	number

Returns

void

Description

设置QuadraticAttenuation参数

---

setRange

▸ setRange(range): void

Parameters

Name	Type
range	number

Returns

void

Description

设置范围

---

setRenderWorldMatrix

▸ setRenderWorldMatrix(worldMatrix): void

Parameters

Name	Type
worldMatrix	Matrix4

Returns

void

Description

设置绘制时所需的世界矩阵

Inherited from

Light.setRenderWorldMatrix

---

setScene

▸ setScene(scene): void

Parameters

Name	Type	Description
scene	Scene	场景对象

Returns

void

Description

设置场景对象

Inherited from

Light.setScene

---

setSelected

▸ setSelected(selected): void

Parameters

Name	Type
selected	boolean

Returns

void

Description

设置是否被选中

Inherited from

Light.setSelected

---

setShapeType

▸ setShapeType(v): void

Parameters

Name	Type	Description
v	ShapeType	类型

Returns

void

Description

设置类型

Inherited from

Light.setShapeType

---

setShowAllSign

▸ setShowAllSign(val): void

Parameters

Name	Type
val	boolean

Returns

void

Description

设置是否显示所有标记（暂时记录在此，待完善）

Inherited from

Light.setShowAllSign

---

setShowSimpleSign

▸ setShowSimpleSign(val): void

Parameters

Name	Type
val	boolean

Returns

void

Description

设置是否显示简单标记（暂时记录在此，待完善）

Inherited from

Light.setShowSimpleSign

---

setSpecular

▸ setSpecular(specular): void

Parameters

Name	Type
specular	Color

Returns

void

Description

设置高光颜色

---

setSpotCosCutoff

▸ setSpotCosCutoff(spotCosCutoff): void

Parameters

Name	Type
spotCosCutoff	number

Returns

void

Description

设置SpotCosCutoff

---

setSpotCutoff

▸ setSpotCutoff(spotCutoff): void

Parameters

Name	Type
spotCutoff	number

Returns

void

Description

设置SpotCutoff

---

setSpotDirection

▸ setSpotDirection(spotDirection): void

Parameters

Name	Type
spotDirection	Vector3

Returns

void

Description

设置聚光灯方向

---

setSpotExponent

▸ setSpotExponent(spotExponent): void

Parameters

Name	Type
spotExponent	number

Returns

void

Description

设置聚光程度

---

setVisible

▸ setVisible(visible, originVisible?): void

Parameters

Name	Type	Description
visible	boolean	是否可见 boolean类型
originVisible?	boolean	-

Returns

void

Description

设置是否可见

Inherited from

Light.setVisible

---

setWorldPosition

▸ setWorldPosition(position): void

Parameters

Name	Type
position	Vector3

Returns

void

Description

设置世界位置

Inherited from

Light.setWorldPosition

---

setWorldRotation

▸ setWorldRotation(rotation): void

Parameters

Name	Type
rotation	Quaternion

Returns

void

Description

设置旋转角度

Inherited from

Light.setWorldRotation

---

setWorldTransform

▸ setWorldTransform(matrix): void

Parameters

Name	Type
matrix	Matrix4

Returns

void

Description

设置世界矩阵

Inherited from

Light.setWorldTransform

---

update

▸ update(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息接收者必须实现方法

Inherited from

Light.update