editor › Globals › SuggestionVisualizer
Class: SuggestionVisualizer
Class which renders suggestions and provides methods for interaction with them.
Hierarchy
- SuggestionVisualizer
Index
Constructors
Properties
Methods
Constructors
constructor
+ new SuggestionVisualizer(suggestionNode: Object3D): SuggestionVisualizer
Defined in src/renderContext/SuggestionVisualizer.ts:40
Parameters:
| Name | Type |
|---|---|
suggestionNode |
Object3D |
Returns: SuggestionVisualizer
Properties
Private suggestionNode
• suggestionNode: Object3D
Defined in src/renderContext/SuggestionVisualizer.ts:34
A three node which serves as parent for all suggestion visualizations.
Private suggestions
• suggestions: NestingSuggestion[] = []
Defined in src/renderContext/SuggestionVisualizer.ts:40
A list of suggestions to be visualized.
Methods
Private _drawPolygon
▸ _drawPolygon(polygon: Polygon, color: any, zPlane: number): void
Defined in src/renderContext/SuggestionVisualizer.ts:98
Parameters:
| Name | Type | Default |
|---|---|---|
polygon |
Polygon | - |
color |
any | - |
zPlane |
number | 0 |
Returns: void
clearSuggestions
▸ clearSuggestions(): void
Defined in src/renderContext/SuggestionVisualizer.ts:57
Removes every visualized suggestion.
Returns: void
drawSuggestions
▸ drawSuggestions(): void
Defined in src/renderContext/SuggestionVisualizer.ts:65
Draws the visualized suggestions by creating a mesh for every suggestion and appending it to the three node.
Returns: void
getSuggestionInteraction
▸ getSuggestionInteraction(interactionData: IInteractionData): NestingSuggestion | undefined
Defined in src/renderContext/SuggestionVisualizer.ts:83
Retrieves the suggestion users interacted with.
Parameters:
| Name | Type | Description |
|---|---|---|
interactionData |
IInteractionData | The interaction data encoding the user's interaction. |
Returns: NestingSuggestion | undefined
the suggestion the user interacted with or undefined if no interaction was detected.
setSuggestions
▸ setSuggestions(suggestions: NestingSuggestion[]): void
Defined in src/renderContext/SuggestionVisualizer.ts:50
Sets the visualized suggestions.
Parameters:
| Name | Type | Description |
|---|---|---|
suggestions |
NestingSuggestion[] | The suggestions to be visualized. |
Returns: void