Class ShadowsInfo

Scene level planar shadow related information

Hierarchy

ShadowsInfo

Index

Properties

Accessors

Methods

Properties

Protected _aspect

_aspect: number = 1

Protected _distance

_distance: number = 0

Protected _enabled

_enabled: boolean = false

Protected _far

_far: number = 30

Protected _near

_near: number = 1

Protected _normal

_normal: Vec3 = new Vec3(0, 1, 0)

Protected _orthoSize

_orthoSize: number = 5

Protected _pcf

_pcf: number = PCFType.HARD

Protected _resource

_resource: Shadows | null = null

Protected _shadowColor

_shadowColor: Color = new Color(0, 0, 0, 76)

Protected _size

_size: Vec2 = new Vec2(512, 512)

Protected _type

_type: number = ShadowType.Planar

Accessors

aspect

get aspect(): number
set aspect(val: number): void

- Defined in cocos/core/scene-graph/scene-globals.ts:552
get or set shadow camera orthoSize

Returns number
- Defined in cocos/core/scene-graph/scene-globals.ts:548
get or set shadow camera orthoSize

Parameters
- val: number
Returns void

distance

get distance(): number
set distance(val: number): void

- Defined in cocos/core/scene-graph/scene-globals.ts:469
The distance from coordinate origin to the receiving plane.

Returns number
- Defined in cocos/core/scene-graph/scene-globals.ts:465
The distance from coordinate origin to the receiving plane.

Parameters
- val: number
Returns void

enabled

get enabled(): boolean
set enabled(val: boolean): void

- Defined in cocos/core/scene-graph/scene-globals.ts:419
Whether activate planar shadow

Returns boolean
- Defined in cocos/core/scene-graph/scene-globals.ts:415
Whether activate planar shadow

Parameters
- val: boolean
Returns void

far

get far(): number
set far(val: number): void

- Defined in cocos/core/scene-graph/scene-globals.ts:511
get or set shadow camera far

Returns number
- Defined in cocos/core/scene-graph/scene-globals.ts:507
get or set shadow camera far

Parameters
- val: number
Returns void

near

get near(): number
set near(val: number): void

- Defined in cocos/core/scene-graph/scene-globals.ts:497
get or set shadow camera near

Returns number
- Defined in cocos/core/scene-graph/scene-globals.ts:493
get or set shadow camera near

Parameters
- val: number
Returns void

normal

get normal(): Vec3
set normal(val: Vec3): void

- Defined in cocos/core/scene-graph/scene-globals.ts:455
The normal of the plane which receives shadow

Returns Vec3
- Defined in cocos/core/scene-graph/scene-globals.ts:451
The normal of the plane which receives shadow

Parameters
- val: Vec3
Returns void

orthoSize

get orthoSize(): number
set orthoSize(val: number): void

- Defined in cocos/core/scene-graph/scene-globals.ts:525
get or set shadow camera orthoSize

Returns number
- Defined in cocos/core/scene-graph/scene-globals.ts:521
get or set shadow camera orthoSize

Parameters
- val: number
Returns void

pcf

get pcf(): number
set pcf(val: number): void

- Defined in cocos/core/scene-graph/scene-globals.ts:483
The normal of the plane which receives shadow

Returns number
- Defined in cocos/core/scene-graph/scene-globals.ts:479
The normal of the plane which receives shadow

Parameters
- val: number
Returns void

shadowColor

get shadowColor(): Color
set shadowColor(val: Color): void

- Defined in cocos/core/scene-graph/scene-globals.ts:442
Shadow color

Returns Color
- Defined in cocos/core/scene-graph/scene-globals.ts:438
Shadow color

Parameters
- val: Color
Returns void

shadowMapSize

get shadowMapSize(): Vec2
set shadowMapSize(val: Vec2): void

- Defined in cocos/core/scene-graph/scene-globals.ts:538
get or set shadow camera orthoSize

Returns Vec2
- Defined in cocos/core/scene-graph/scene-globals.ts:534
get or set shadow camera orthoSize

Parameters
- val: Vec2
Returns void

type

get type(): number
set type(val: number): void

- Defined in cocos/core/scene-graph/scene-globals.ts:429
Returns number
- Defined in cocos/core/scene-graph/scene-globals.ts:425
Parameters
- val: number
Returns void

Methods

activate

activate(resource: Shadows): void

- Defined in cocos/core/scene-graph/scene-globals.ts:568
Parameters
- resource: Shadows
Returns void

setPlaneFromNode

setPlaneFromNode(node: Node): void

- Defined in cocos/core/scene-graph/scene-globals.ts:561
Set plane which receives shadow with the given node's world transformation

Parameters
- node: Node
  
  The node for setting up the plane
Returns void

Generated using TypeDoc