Class TreeNode

Implements

ITreeNode

Constructors

constructor

new TreeNode(
    name?: string,
    parent?: ITreeNode,
    data?: ITreeNodeData[],
    transformations?: ITransformation[],
): TreeNode
Creation of a node that can be used in the node tree.
Parameters
- Optionalname: string
  the name of the node
- Optionalparent: ITreeNode
  the parent of this node
- Optionaldata: ITreeNodeData[]
  the array of data
- Optionaltransformations: ITransformation[]
  the array of transformations
Returns TreeNode

Accessors

boundingBox

get boundingBox(): IBox
The bounding box of this tree node.

Returns IBox
Implementation of ITreeNode.boundingBox

boundingBoxViewport

get boundingBoxViewport(): { [key: string]: IBox }
The bounding box of this tree node for each viewport. As there can be properties where tree nodes are excluded from the viewport, the bounding boxes may be different per viewport. The boundingBox property can be used as the general bounding box without any viewport specific exclusions.

Returns { [key: string]: IBox }
Implementation of ITreeNode.boundingBoxViewport

children

get children(): ITreeNode[]
The children of this tree node. Can be added and remove via addChild and removeChild.

Returns ITreeNode[]
Implementation of ITreeNode.children

convertedObject

get convertedObject(): { [key: string]: unknown }
The converted object of the tree node.

Returns { [key: string]: unknown }
Implementation of ITreeNode.convertedObject
set convertedObject(value: { [key: string]: unknown }): void
The converted object of the tree node.
Parameters
- value: { [key: string]: unknown }
Returns void
Implementation of ITreeNode.convertedObject

data

get data(): ITreeNodeData[]
The data of this tree node. The data can include Geometry, Materials, Lights, Cameras, but also informational or custom data.

Can be added and remove via addData and removeData.

Returns ITreeNodeData[]
Implementation of ITreeNode.data

displayName

get displayName(): string | undefined
An optional name that can be used for display purposes. If not specified, the name property will be used.

Returns string | undefined
Implementation of ITreeNode.displayName
set displayName(value: string | undefined): void
An optional name that can be used for display purposes. If not specified, the name property will be used.
Parameters
- value: string | undefined
Returns void
Implementation of ITreeNode.displayName

excludeViewports

get excludeViewports(): string[]
The viewports to exclude this tree node from.

Returns string[]
Implementation of ITreeNode.excludeViewports
set excludeViewports(value: string[]): void
The viewports to exclude this tree node from.
Parameters
- value: string[]
Returns void
Implementation of ITreeNode.excludeViewports

id

get id(): string
The ID of the tree node.

Returns string
Implementation of ITreeNode.id

intersectionTest

get intersectionTest(): boolean
If for this node, global intersection tests should be performed. (default: true)

Returns boolean
Implementation of ITreeNode.intersectionTest
set intersectionTest(value: boolean): void
If for this node, global intersection tests should be performed. (default: true)
Parameters
- value: boolean
Returns void
Implementation of ITreeNode.intersectionTest

name

get name(): string
The name of the tree node.

Returns string
Implementation of ITreeNode.name
set name(value: string): void
The name of the tree node.
Parameters
- value: string
Returns void
Implementation of ITreeNode.name

nodeMatrix

get nodeMatrix(): mat4
The matrix of the tree node. This is computed via all transformations in the transformations property.

Returns mat4
Implementation of ITreeNode.nodeMatrix

originalId

get originalId(): string
The original ID of the tree node, if it was copied.

Returns string
Implementation of ITreeNode.originalId
set originalId(value: string): void
The original ID of the tree node, if it was copied.
Parameters
- value: string
Returns void
Implementation of ITreeNode.originalId

originalName

get originalName(): string | undefined
The original name of the tree node, if one was supplied.

Returns string | undefined
Implementation of ITreeNode.originalName
set originalName(value: string | undefined): void
The original name of the tree node, if one was supplied.
Parameters
- value: string | undefined
Returns void
Implementation of ITreeNode.originalName

parent

get parent(): ITreeNode | undefined
The parent of the tree node. This property is automatically managed by addChild and removeChild.

Returns ITreeNode | undefined
Implementation of ITreeNode.parent
set parent(value: ITreeNode | undefined): void
The parent of the tree node. This property is automatically managed by addChild and removeChild.
Parameters
- value: ITreeNode | undefined
Returns void
Implementation of ITreeNode.parent

restrictViewports

get restrictViewports(): string[]
The viewports to restrict this tree node to.

Returns string[]
Implementation of ITreeNode.restrictViewports
set restrictViewports(value: string[]): void
The viewports to restrict this tree node to.
Parameters
- value: string[]
Returns void
Implementation of ITreeNode.restrictViewports

transformations

get transformations(): ITransformation[]
The transformation to be applied to this tree node.

Returns ITransformation[]
Implementation of ITreeNode.transformations
set transformations(value: ITransformation[]): void
The transformation to be applied to this tree node.
Parameters
- value: ITransformation[]
Returns void
Implementation of ITreeNode.transformations

updateCallback

get updateCallback(): ((newVersion: string, oldVersion: string) => void) | null
The update callback for the tree node. This callback is called when the node is updated, e.g. when the version changes.

Returns ((newVersion: string, oldVersion: string) => void) | null
Implementation of ITreeNode.updateCallback
set updateCallback(
value: ((newVersion: string, oldVersion: string) => void) | null,
): void
The update callback for the tree node. This callback is called when the node is updated, e.g. when the version changes.
Parameters
- value: ((newVersion: string, oldVersion: string) => void) | null
Returns void
Implementation of ITreeNode.updateCallback

updateCallbackConvertedObject

get updateCallbackConvertedObject(): | (
(newObj: unknown, oldObj: unknown, viewport: string) => void
)
| null
The update callback for the converted object of the tree node.

Returns ((newObj: unknown, oldObj: unknown, viewport: string) => void) | null
Implementation of ITreeNode.updateCallbackConvertedObject
set updateCallbackConvertedObject(
    value:
        | ((newObj: unknown, oldObj: unknown, viewport: string) => void)
        | null,
): void
The update callback for the converted object of the tree node.
Parameters
- value: ((newObj: unknown, oldObj: unknown, viewport: string) => void) | null
Returns void
Implementation of ITreeNode.updateCallbackConvertedObject

version

get version(): string
The version of the tree node. If the version changes, the node will be marked for an update. A version change can be triggered via updateVersion.

Returns string
Implementation of ITreeNode.version
set version(value: string): void
The version of the tree node. If the version changes, the node will be marked for an update. A version change can be triggered via updateVersion.
Parameters
- value: string
Returns void
Implementation of ITreeNode.version

visible

get visible(): boolean
Option to make this tree node visible. (default: true)

Returns boolean
Implementation of ITreeNode.visible
set visible(value: boolean): void
Option to make this tree node visible. (default: true)
Parameters
- value: boolean
Returns void
Implementation of ITreeNode.visible

worldMatrix

get worldMatrix(): mat4
The world matrix of the tree node. This includes also the transformations of all parents.

Returns mat4
Implementation of ITreeNode.worldMatrix

Methods

addChild

addChild(child: ITreeNode | ITreeNode[]): boolean
Add a child to the children of this node.
Parameters
- child: ITreeNode | ITreeNode[]
  the child to add
Returns boolean
Implementation of ITreeNode.addChild

addData

addData(data: ITreeNodeData | ITreeNodeData[]): boolean
Add a data item to node.
Parameters
- data: ITreeNodeData | ITreeNodeData[]
  the data to add
Returns boolean
Implementation of ITreeNode.addData

addTransformation

addTransformation(transformation: ITransformation): boolean
Add a transformation to this node.
Parameters
- transformation: ITransformation
  the transformation to add
Returns boolean
Implementation of ITreeNode.addTransformation

clone

clone(): ITreeNode
Clones this node and all its children. The data objects like GeometryData, MaterialData, etc. are cloned as well. Depending on the size of the node and the amount of children, this can therefore be relatively slow.

Returns ITreeNode
Implementation of ITreeNode.clone

cloneInstance

cloneInstance(): ITreeNode
Clones this node and all its children. The data objects like GeometryData, MaterialData, etc. are not copied in this case.

Returns ITreeNode
Implementation of ITreeNode.cloneInstance

getChild

getChild(id: string): ITreeNode | undefined
Returns the child with the specified id
Parameters
- id: string
Returns ITreeNode | undefined
Implementation of ITreeNode.getChild

getData

getData(id: string): ITreeNodeData | undefined
Returns the data item with the specified id
Parameters
- id: string
Returns ITreeNodeData | undefined
Implementation of ITreeNode.getData

getNodesByName

getNodesByName(name: string): ITreeNode[]
Test this node and all it's descendants for nodes with the specified name and return them in an array.
Parameters
- name: string
Returns ITreeNode[]
Implementation of ITreeNode.getNodesByName

getNodesByNameWithRegex

getNodesByNameWithRegex(regex: RegExp): ITreeNode[]
Test this nodes name and all it's descendants name for nodes for the specified regex and return them in an array.
Parameters
- regex: RegExp
Returns ITreeNode[]
Implementation of ITreeNode.getNodesByNameWithRegex

getOriginalNamePath

getOriginalNamePath(): string
Return the path to this node with the original names. If no original name is set, the entry is left empty.

Returns string
Implementation of ITreeNode.getOriginalNamePath

getPath

getPath(): string
Return the path to this node.

Returns string
Implementation of ITreeNode.getPath

getTransformation

getTransformation(id: string): ITransformation | undefined
Returns the transformation with the specified id
Parameters
- id: string
Returns ITransformation | undefined
Implementation of ITreeNode.getTransformation

hasChild

hasChild(child: ITreeNode): boolean
Check for existence of a child from the children of this node.
Parameters
- child: ITreeNode
  the child to check
Returns boolean
Implementation of ITreeNode.hasChild

hasData

hasData(data: ITreeNodeData): boolean
Check for existence of a data item of this node.
Parameters
- data: ITreeNodeData
  the data item to check
Returns boolean
Implementation of ITreeNode.hasData

hasTransformation

hasTransformation(transformation: ITransformation): boolean
Check for existence of a transformation of this node.
Parameters
- transformation: ITransformation
Returns boolean
Implementation of ITreeNode.hasTransformation

removeChild

removeChild(child: ITreeNode | ITreeNode[]): boolean
Remove a child from the children of this node.
Parameters
- child: ITreeNode | ITreeNode[]
  the child to remove
Returns boolean
Implementation of ITreeNode.removeChild

removeData

removeData(data: ITreeNodeData | ITreeNodeData[]): boolean
Remove a data item from this node.
Parameters
- data: ITreeNodeData | ITreeNodeData[]
  the data to remove
Returns boolean
Implementation of ITreeNode.removeData

removeTransformation

removeTransformation(transformation: ITransformation): boolean
Remove a transformation from this node.
Parameters
- transformation: ITransformation
  the transformation to remove
Returns boolean
Implementation of ITreeNode.removeTransformation

traverse

traverse(callback: (node: ITreeNode) => void): void
Traverse this node and all it's children and executes the callback for all of them
Parameters
- callback: (node: ITreeNode) => void
Returns void
Implementation of ITreeNode.traverse

traverseData

traverseData(callback: (node: ITreeNodeData) => void): void
Traverse this node and all it's children and executes the callback for all data items of them
Parameters
- callback: (node: ITreeNodeData) => void
Returns void
Implementation of ITreeNode.traverseData

updateVersion

updateVersion(parents?: boolean, children?: boolean): void
Update the version.
Parameters
- Optionalparents: boolean
  if true, the version of all parents will be updated as well (default: true)
- Optionalchildren: boolean
  if true, the version of all children will be updated as well (default: true)
Returns void
Implementation of ITreeNode.updateVersion

Class TreeNode

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns TreeNode

Accessors

boundingBox

Returns IBox

boundingBoxViewport

Returns { [key: string]: IBox }

children

Returns ITreeNode[]

convertedObject

Returns { [key: string]: unknown }

Parameters

Returns void

data

Returns ITreeNodeData[]

displayName

Returns string | undefined

Parameters

Returns void

excludeViewports

Returns string[]

Parameters

Returns void

id

Returns string

intersectionTest

Returns boolean

Parameters

Returns void

name

Returns string

Parameters

Returns void

nodeMatrix

Returns mat4

originalId

Returns string

Parameters

Returns void

originalName

Returns string | undefined

Parameters

Returns void

parent

Returns ITreeNode | undefined

Parameters

Returns void

restrictViewports

Returns string[]

Parameters

Returns void

transformations

Returns ITransformation[]

Parameters

Returns void

updateCallback

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

Parameters

Returns void

updateCallbackConvertedObject

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

Parameters

Returns void

version

Returns string

Parameters

Returns void

visible

Returns boolean

Parameters

Returns void

worldMatrix