Documentation / scene / CullVisitor

Class: CullVisitor

Defined in: libs/scene/src/render/cull_visitor.ts:22

Node visitor for culling

Implements

• Visitor<SceneNode | OctreeNode>

Constructors

Constructor

new CullVisitor(renderPass, camera, renderQueue): CullVisitor

Defined in: libs/scene/src/render/cull_visitor.ts:42

Creates an instance of CullVisitor

Parameters

renderPass

RenderPass

Render pass for the culling task

camera

Camera

Camera that will be used for culling

renderQueue

RenderQueue

Returns

CullVisitor

Accessors

camera

Get Signature

get camera(): Camera

Defined in: libs/scene/src/render/cull_visitor.ts:51

The camera that will be used for culling

Returns

Camera

Set Signature

set camera(camera): void

Defined in: libs/scene/src/render/cull_visitor.ts:54

Parameters

camera

Camera

Returns

void

---

frustumCulling

Get Signature

get frustumCulling(): boolean

Defined in: libs/scene/src/render/cull_visitor.ts:58

true if cull with frustum culling, otherwise false. default is true

Returns

boolean

Set Signature

set frustumCulling(val): void

Defined in: libs/scene/src/render/cull_visitor.ts:61

Parameters

val

boolean

Returns

void

---

renderPass

Get Signature

get renderPass(): RenderPass

Defined in: libs/scene/src/render/cull_visitor.ts:65

Render pass for the culling task

Returns

RenderPass

---

renderQueue

Get Signature

get renderQueue(): RenderQueue

Defined in: libs/scene/src/render/cull_visitor.ts:69

The result of culling

Returns

RenderQueue

Set Signature

set renderQueue(renderQueue): void

Defined in: libs/scene/src/render/cull_visitor.ts:72

Parameters

renderQueue

RenderQueue

Returns

void

---

frustum

Get Signature

get frustum(): Readonly<{ planes: readonly Readonly<{[key: number]: number; a: number; b: number; c: number; d: number; assign: this; setEquation: this; initWithOriginNormal: this; initWithPoints: this; distanceToPoint: number; nearestPointToPoint: Vector3; getNormal: Vector3; inplaceFlip: Plane; inplaceNormalize: Plane; equalsTo: boolean; toString: string; isNaN: boolean; setRandom: void; }>[]; corners: readonly Readonly<{[key: number]: number; equalsTo: boolean; toString: string; isNaN: boolean; setRandom: void; clone: Vector3; x: number; y: number; z: number; magnitude: number; magnitudeSq: number; xy: Vector2; setXYZ: this; setAndNormalize: this; subBy: this; addBy: this; combineBy: this; mulBy: this; divBy: this; scaleBy: this; inplaceNormalize: this; inplaceInverse: this; inplaceMin: this; inplaceMax: this; }>[]; getCorner: Readonly<{[x: number]: number; clone: () => Vector3; x: number; y: number; z: number; magnitude: number; magnitudeSq: number; xy: () => Vector2; setXYZ: (x, y, z) => Vector3; setAndNormalize: (x, y, z) => Vector3; subBy: (other) => Vector3; addBy: (other) => Vector3; combineBy: (other, t0, t1) => Vector3; mulBy: (other) => Vector3; divBy: (other) => Vector3; scaleBy: (f) => Vector3; inplaceNormalize: () => Vector3; inplaceInverse: () => Vector3; inplaceMin: (other) => Vector3; inplaceMax: (other) => Vector3; equalsTo: (other, epsl?) => boolean; toString: () => string; isNaN: () => boolean; setRandom: (minValue, maxValue) => void; BYTES_PER_ELEMENT: number; buffer: Readonly<{ byteLength: number; slice: (begin?, end?) => ArrayBuffer; [toStringTag]: "ArrayBuffer"; }>; byteLength: number; byteOffset: number; copyWithin: (target, start, end?) => Vector3; every: (predicate, thisArg?) => boolean; fill: (value, start?, end?) => Vector3; filter: (predicate, thisArg?) => Float32Array<ArrayBuffer>; find: (predicate, thisArg?) => number | undefined; findIndex: (predicate, thisArg?) => number; forEach: (callbackfn, thisArg?) => void; indexOf: (searchElement, fromIndex?) => number; join: (separator?) => string; lastIndexOf: (searchElement, fromIndex?) => number; length: number; map: (callbackfn, thisArg?) => Float32Array<ArrayBuffer>; reduce: {(callbackfn): number; (callbackfn, initialValue): number; <U>(callbackfn, initialValue): U; }; reduceRight: {(callbackfn): number; (callbackfn, initialValue): number; <U>(callbackfn, initialValue): U; }; reverse: () => Vector3; set: (array, offset?) => void; slice: (start?, end?) => Float32Array<ArrayBuffer>; some: (predicate, thisArg?) => boolean; sort: (compareFn?) => Vector3; subarray: (begin?, end?) => Float32Array<ArrayBuffer>; toLocaleString: {(): string; (locales, options?): string; }; valueOf: () => Vector3; entries: () => ArrayIterator<[number, number]>; keys: () => ArrayIterator<number>; values: () => ArrayIterator<number>; includes: (searchElement, fromIndex?) => boolean; [iterator]: () => ArrayIterator<number>; [toStringTag]: "Float32Array"; }>; containsPoint: boolean; initWithMatrix: this; }>

Defined in: libs/scene/src/render/cull_visitor.ts:76

Frustum for culling

Returns

Readonly<{ planes: readonly Readonly<{[key: number]: number; a: number; b: number; c: number; d: number; assign: this; setEquation: this; initWithOriginNormal: this; initWithPoints: this; distanceToPoint: number; nearestPointToPoint: Vector3; getNormal: Vector3; inplaceFlip: Plane; inplaceNormalize: Plane; equalsTo: boolean; toString: string; isNaN: boolean; setRandom: void; }>[]; corners: readonly Readonly<{[key: number]: number; equalsTo: boolean; toString: string; isNaN: boolean; setRandom: void; clone: Vector3; x: number; y: number; z: number; magnitude: number; magnitudeSq: number; xy: Vector2; setXYZ: this; setAndNormalize: this; subBy: this; addBy: this; combineBy: this; mulBy: this; divBy: this; scaleBy: this; inplaceNormalize: this; inplaceInverse: this; inplaceMin: this; inplaceMax: this; }>[]; getCorner: Readonly<{[x: number]: number; clone: () => Vector3; x: number; y: number; z: number; magnitude: number; magnitudeSq: number; xy: () => Vector2; setXYZ: (x, y, z) => Vector3; setAndNormalize: (x, y, z) => Vector3; subBy: (other) => Vector3; addBy: (other) => Vector3; combineBy: (other, t0, t1) => Vector3; mulBy: (other) => Vector3; divBy: (other) => Vector3; scaleBy: (f) => Vector3; inplaceNormalize: () => Vector3; inplaceInverse: () => Vector3; inplaceMin: (other) => Vector3; inplaceMax: (other) => Vector3; equalsTo: (other, epsl?) => boolean; toString: () => string; isNaN: () => boolean; setRandom: (minValue, maxValue) => void; BYTES_PER_ELEMENT: number; buffer: Readonly<{ byteLength: number; slice: (begin?, end?) => ArrayBuffer; [toStringTag]: "ArrayBuffer"; }>; byteLength: number; byteOffset: number; copyWithin: (target, start, end?) => Vector3; every: (predicate, thisArg?) => boolean; fill: (value, start?, end?) => Vector3; filter: (predicate, thisArg?) => Float32Array<ArrayBuffer>; find: (predicate, thisArg?) => number | undefined; findIndex: (predicate, thisArg?) => number; forEach: (callbackfn, thisArg?) => void; indexOf: (searchElement, fromIndex?) => number; join: (separator?) => string; lastIndexOf: (searchElement, fromIndex?) => number; length: number; map: (callbackfn, thisArg?) => Float32Array<ArrayBuffer>; reduce: {(callbackfn): number; (callbackfn, initialValue): number; <U>(callbackfn, initialValue): U; }; reduceRight: {(callbackfn): number; (callbackfn, initialValue): number; <U>(callbackfn, initialValue): U; }; reverse: () => Vector3; set: (array, offset?) => void; slice: (start?, end?) => Float32Array<ArrayBuffer>; some: (predicate, thisArg?) => boolean; sort: (compareFn?) => Vector3; subarray: (begin?, end?) => Float32Array<ArrayBuffer>; toLocaleString: {(): string; (locales, options?): string; }; valueOf: () => Vector3; entries: () => ArrayIterator<[number, number]>; keys: () => ArrayIterator<number>; values: () => ArrayIterator<number>; includes: (searchElement, fromIndex?) => boolean; [iterator]: () => ArrayIterator<number>; [toStringTag]: "Float32Array"; }>; containsPoint: boolean; initWithMatrix: this; }>

Methods

visit()

visit(target): boolean

Defined in: libs/scene/src/render/cull_visitor.ts:91

Visits a node

Parameters

target

SceneNode | OctreeNode

The node to be visit

Returns

boolean

Implementation of

Visitor.visit

---

visitSprite()

visitSprite(node): boolean

Defined in: libs/scene/src/render/cull_visitor.ts:164

Parameters

node

Sprite

Returns

boolean

---

visitMSDFText()

visitMSDFText(node): boolean

Defined in: libs/scene/src/render/cull_visitor.ts:174

Parameters

node

MSDFText

Returns

boolean

---

visitMSDFTextSprite()

visitMSDFTextSprite(node): boolean

Defined in: libs/scene/src/render/cull_visitor.ts:190

Parameters

node

MSDFTextSprite

Returns

boolean