editor › Globals › PositionScoreFilterCriterion

Class: PositionScoreFilterCriterion

This criterion scores hints according to their y-position on the screen. Higher y will lead to better scores, which roughly translates to 'hints should be in the back of the scene'.

Hierarchy

• HintFilterCriterion

↳ PositionScoreFilterCriterion

Index

Constructors

• constructor

Properties

• camera
• canvasDimensions
• modelSubnode
• sharedData

Methods

• _getHintCanvasAABB
• score

Constructors

constructor

+ new PositionScoreFilterCriterion(camera: PerspectiveCamera, canvasDimensions: object, sharedData: any, modelSubnode: Object3D): PositionScoreFilterCriterion

Inherited from HintFilterCriterion.constructor

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

Parameters:

▪ camera: PerspectiveCamera

▪ canvasDimensions: object

Name	Type
height	number
width	number

▪ sharedData: any

▪ modelSubnode: Object3D

Returns: PositionScoreFilterCriterion

Properties

Protected camera

• camera: PerspectiveCamera

Inherited from HintFilterCriterion.camera

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

---

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/PositionScoreFilterCriterion.ts:8

Parameters:

Name	Type
hint	any

Returns: number