Home Reference Source
import ActivePickFilter from 'potassium-es/src/input/ActivePickFilter.js'
public class | source

ActivePickFilter

Extends:

action-input/src/filter/Filter~Filter → ActivePickFilter

ActivePickFilter activates the action if the input is truthy. More usefully, it sets a targetComponent parameter to null or a Potassium.Component that is picked.

The filter parameter pickPath resolve to a THREE.RayCaster result like { distance, point, face, faceIndex, object }

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public get

Method Summary

Public Methods
public

filter(inputPath: string, inputActive: boolean, inputValue: *, filterPath: string, filterParameters: Object, results: Array): Array

Public Constructors

public constructor() source

Public Members

public get name: string: string source

Return:

string

a human readable name

Public Methods

public filter(inputPath: string, inputActive: boolean, inputValue: *, filterPath: string, filterParameters: Object, results: Array): Array source

Params:

NameTypeAttributeDescription
inputPath string
inputActive boolean
inputValue *
filterPath string
filterParameters Object

parameters for use while filtering

results Array

Return:

Array

[active, value]