Class FeatureAtPixelInteraction

Hierarchy (view full)

AbstractInteraction
- FeatureAtPixelInteraction

Index

Accessors

excludedPickPositionEvents pickPosition

Constructors

Methods

destroy modifierChanged pipe setActive setModification setPointer

Properties

active hitTolerance id modificationKey pickTranslucent pointerKey pullPickedPosition

Accessors

excludedPickPositionEvents

get excludedPickPositionEvents(): number
Bitmask of for which to never pick positions.

Returns number
- Defined in src/interaction/featureAtPixelInteraction.ts:77
set excludedPickPositionEvents(position): void
Parameters
- position: number
Returns void
- Defined in src/interaction/featureAtPixelInteraction.ts:81

pickPosition

get pickPosition(): EventType
Bitmask of EventType for which events to pick the position

Returns EventType
- Defined in src/interaction/featureAtPixelInteraction.ts:66
set pickPosition(position): void
Parameters
- position: EventType
Returns void
- Defined in src/interaction/featureAtPixelInteraction.ts:70

Constructors

constructor

new FeatureAtPixelInteraction(): FeatureAtPixelInteraction
Returns FeatureAtPixelInteraction
Overrides AbstractInteraction.constructor
- Defined in src/interaction/featureAtPixelInteraction.ts:54

Methods

destroy

destroy(): void
destroys the implementation, removing any created resources

Returns void
Inherited from AbstractInteraction.destroy
- Defined in src/interaction/abstractInteraction.ts:194

modifierChanged

modifierChanged(_modifier): void
Called when the modifier keys have changed.
Parameters
- _modifier: ModificationKeyType
Returns void
Inherited from AbstractInteraction.modifierChanged
- Defined in src/interaction/abstractInteraction.ts:147

pipe

pipe(event): Promise<InteractionEvent>
Main function, called when an event is raised for this interaction
Parameters
- event: InteractionEvent
Returns Promise<InteractionEvent>
Overrides AbstractInteraction.pipe
- Defined in src/interaction/featureAtPixelInteraction.ts:85

setActive

setActive(active?): void
Sets the interaction active. Use boolean (true|false) to toggle default behavior. Pass it a bitmask of EventType to change the active state. Call without arguments to reset the default active, modification key and pointer Key behavior
Parameters
- Optionalactive: number | boolean
Returns void
Overrides AbstractInteraction.setActive
- Defined in src/interaction/featureAtPixelInteraction.ts:114

setModification

setModification(mod?): void
Sets the modification key to listen to or the default modification key if none is provided.
Parameters
- Optionalmod: ModificationKeyType
Returns void
Inherited from AbstractInteraction.setModification
- Defined in src/interaction/abstractInteraction.ts:171

setPointer

setPointer(pointer?): void
Sets the pointer key for this interaction or the default pointer if none is provided.
Parameters
- Optionalpointer: PointerKeyType
Returns void
Inherited from AbstractInteraction.setPointer
- Defined in src/interaction/abstractInteraction.ts:182

Properties

active

active: number

The current active bitmask for EventType

hitTolerance

hitTolerance: number = 10

The number of pixels to take into account for picking features

id

id: string

A unique identifier for this interaction

modificationKey

modificationKey: ModificationKeyType

The current active ModificationKeyType

pickTranslucent

pickTranslucent: boolean = true

whether to pick translucent depth or not, defaults to true

pointerKey

pointerKey: PointerKeyType

The currently active PointerKeyType

pullPickedPosition

pullPickedPosition: number = 0

Pulls the picked position towards the camera position by this number