Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InteractionData

Hierarchy

  • AbstractTreeNodeData
    • InteractionData

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

  • Creates an interaction data item.

    Parameters

    • interactionTypes: IInteractionTypes

      the data as key-value pairs

    • Optional groupId: string

      the group id to be able to interact with multiple nodes at once

    • Optional restrictedManagers: string[]
    • Optional id: string

      the id that is used internally (leave empty if in doubt)

    • Optional version: string

      the version that is used internally (leave empty if in doubt)

    Returns InteractionData

Accessors

convertedObject

  • get convertedObject(): {}
  • set convertedObject(value: {}): void

  • The converted object of the tree node.

    Returns {}

    • [key: string]: unknown

  • The converted object of the tree node.

    Parameters

    • value: {}
      • [key: string]: unknown

    Returns void

dragAnchors

  • get dragAnchors(): IDragAnchor[]
  • set dragAnchors(value: IDragAnchor[]): void

  • The drag anchors can be defined as various points in space that will be transformed according to the node matrix that this data item belongs to. These anchors are used when an object is being dragged instead of the dragOrigin or the default, the intersection with the node.

    The optional rotation in axis-angle representation is being applied to the node if the specified drag anchor has been used.

    Returns IDragAnchor[]

  • The drag anchors can be defined as various points in space that will be transformed according to the node matrix that this data item belongs to. These anchors are used when an object is being dragged instead of the dragOrigin or the default, the intersection with the node.

    The optional rotation in axis-angle representation is being applied to the node if the specified drag anchor has been used.

    Parameters

    • value: IDragAnchor[]

    Returns void

dragOrigin

  • get dragOrigin(): undefined | vec3
  • set dragOrigin(value: undefined | vec3): void

  • The drag origin can be defined instead of usind the default, the intersection with the node, as a dragging origin. If at least one dragAnchors is used, this property will be ignored.

    Returns undefined | vec3

  • The drag origin can be defined instead of usind the default, the intersection with the node, as a dragging origin. If at least one dragAnchors is used, this property will be ignored.

    Parameters

    • value: undefined | vec3

    Returns void

groupId

  • get groupId(): undefined | string
  • set groupId(value: undefined | string): void

  • The group id to be able to interact with multiple nodes at once. If the same group id is specified at the InteractionData of another node, these nodes are treated as being one.

    Returns undefined | string

  • The group id to be able to interact with multiple nodes at once. If the same group id is specified at the InteractionData of another node, these nodes are treated as being one.

    Parameters

    • value: undefined | string

    Returns void

id

  • get id(): string

  • The ID of the tree node data.

    Returns string

interactionStates

interactionTypes

restrictedManagers

  • get restrictedManagers(): string[]
  • set restrictedManagers(value: string[]): void

  • The restricted managers are the managers that are allowed to interact with this node. If the array is empty, all managers are allowed to interact with this node.

    Returns string[]

  • The restricted managers are the managers that are allowed to interact with this node. If the array is empty, all managers are allowed to interact with this node.

    Parameters

    • value: string[]

    Returns void

updateCallback

  • get updateCallback(): null | ((newVersion: string, oldVersion: string) => void)
  • set updateCallback(value: null | ((newVersion: string, oldVersion: string) => void)): void

  • The update callback for the tree node data. This callback is called when the node is updated, e.g. when the version changes.

    Returns null | ((newVersion: string, oldVersion: string) => void)

  • The update callback for the tree node data. This callback is called when the node is updated, e.g. when the version changes.

    Parameters

    • value: null | ((newVersion: string, oldVersion: string) => void)

    Returns void

updateCallbackConvertedObject

  • get updateCallbackConvertedObject(): null | ((newObj: unknown, oldObj: unknown, viewport: string) => void)
  • set updateCallbackConvertedObject(value: null | ((newObj: unknown, oldObj: unknown, viewport: string) => void)): void

  • The update callback for the converted object of the tree node.

    Returns null | ((newObj: unknown, oldObj: unknown, viewport: string) => void)

  • The update callback for the converted object of the tree node.

    Parameters

    • value: null | ((newObj: unknown, oldObj: unknown, viewport: string) => void)

    Returns void

version

  • get version(): string

  • The version of the tree node data. If the version changes, the node data will be marked for an update. A version change can be triggered via updateVersion.

    Returns string

Methods

clone

updateVersion

  • updateVersion(): void