Defines a visitor for scene graph elements.

The visitor follows a hierarchical visitor pattern, which makes it possible to track entering and leaving composite elements such as assemblies and instances.

Returning true from visitAssemblyEnter or visitInstanceEnter allows child elements to be visited. Returning false skips them. The matching leave method is still invoked afterwards.

Methods

visitAssemblyEnter()

‍optional visitAssemblyEnter(assembly): boolean

Defines the logic invoked when entering a visited Assembly.

Returning true allows child instances of assembly to be visited. Returning false skips them. If the method is not defined, child instances are visited.

Parameters

assembly

Assembly

Visited assembly.

Returns

boolean

visitAssemblyLeave()

‍optional visitAssemblyLeave(assembly): void

Defines the logic invoked when leaving a visited Assembly.

Parameters

assembly

Assembly

Visited assembly.

Returns

void

visitInstanceEnter()

‍optional visitInstanceEnter(instance): boolean

Defines the logic invoked when entering a visited Instance.

Returning true allows the referred model element of instance to be visited. Returning false skips it. If the method is not defined, the referred model element is visited.

Parameters

instance

Instance

Visited instance.

Returns

boolean

visitInstanceLeave()

‍optional visitInstanceLeave(instance): void

Defines the logic invoked when leaving a visited Instance.

Parameters

instance

Instance

Visited instance.

Returns

void

visitPart()

‍optional visitPart(part): void

Defines the logic invoked for a visited Part.

Parameters

part

Part

Visited part.

Returns

void