Interface IInteractionEffectUtils

interface IInteractionEffectUtils {
    applyInteractionEffect(
        node: ITreeNode,
        effect: IInteractionEffect,
    ): string;
    removeInteractionEffect(node: ITreeNode, token: string): void;
    viewport?: IViewportApi;
}

Index

Properties

Methods

applyInteractionEffect removeInteractionEffect

Properties

`Optional`viewport

viewport?: IViewportApi

Methods

applyInteractionEffect

applyInteractionEffect(node: ITreeNode, effect: IInteractionEffect): string
Apply an effect material all geometry in the current node. The material provided will be used for this effect. The returned token can be used to removed the effect.
Parameters
- node: ITreeNode
- effect: IInteractionEffect
Returns string

removeInteractionEffect

removeInteractionEffect(node: ITreeNode, token: string): void
Remove an effect material with the token provided wen adding it.
Parameters
- node: ITreeNode
- token: string
Returns void