editor › Globals › OnScreenAreaFilterCriterion

Class: OnScreenAreaFilterCriterion

This criterion scores hints by their on-screen area. I.e. they should not be off-screen.

Hierarchy

• HintFilterCriterion

↳ OnScreenAreaFilterCriterion

Index

Constructors

• constructor

Properties

• camera
• canvasAABB
• canvasDimensions
• modelSubnode
• sharedData

Methods

• _getHintCanvasAABB
• score

Constructors

constructor

+ new OnScreenAreaFilterCriterion(camera: any, canvasDimensions: any, sharedData: any, modelSubnode: any): OnScreenAreaFilterCriterion

Overrides HintFilterCriterion.constructor

Defined in src/renderContext/hints/HintFilterStrategies/HintCriteria/OnScreenAreaFilterCriterion.ts:9

Parameters:

Name	Type
camera	any
canvasDimensions	any
sharedData	any
modelSubnode	any

Returns: OnScreenAreaFilterCriterion

Properties

Protected camera

• camera: PerspectiveCamera

Inherited from HintFilterCriterion.camera

Defined in src/renderContext/hints/HintFilterStrategies/HintCriteria/HintFilterCriterion.ts:5

---

Private Readonly canvasAABB

• canvasAABB: AABB

Defined in src/renderContext/hints/HintFilterStrategies/HintCriteria/OnScreenAreaFilterCriterion.ts:9

---

Protected canvasDimensions

• canvasDimensions: object

Inherited from HintFilterCriterion.canvasDimensions

Defined in src/renderContext/hints/HintFilterStrategies/HintCriteria/HintFilterCriterion.ts:7

Type declaration:

• height: number

• width: number

---

Protected modelSubnode

• modelSubnode: Object3D

Inherited from HintFilterCriterion.modelSubnode

Defined in src/renderContext/hints/HintFilterStrategies/HintCriteria/HintFilterCriterion.ts:8

---

Protected sharedData

• sharedData: any

Inherited from HintFilterCriterion.sharedData

Defined in src/renderContext/hints/HintFilterStrategies/HintCriteria/HintFilterCriterion.ts:6

Methods

Protected _getHintCanvasAABB

▸ _getHintCanvasAABB(hint: FilterableHint): any

Inherited from HintFilterCriterion._getHintCanvasAABB

Defined in src/renderContext/hints/HintFilterStrategies/HintCriteria/HintFilterCriterion.ts:29

Parameters:

Name	Type
hint	FilterableHint

Returns: any

---

score

▸ score(hint: any): number

Overrides HintFilterCriterion.score

Defined in src/renderContext/hints/HintFilterStrategies/HintCriteria/OnScreenAreaFilterCriterion.ts:20

Parameters:

Name	Type
hint	any

Returns: number