Class: SceneTools
Class: SceneTools
Functions for elements management in scene. See SceneManager.tools property in SceneManager class.
Methods
activateAllElements
▸ activateAllElements(): void
Activate all elements list in scene.
Returns
void
activateElements
▸ activateElements(elNums): void
Activate (send from underlay) elements list in scene.
Parameters
| Name | Type | Description |
|---|---|---|
elNums | number[] | Numbers for elements list. |
Returns
void
applyAllElementsStateAndColor
▸ applyAllElementsStateAndColor(): void
Apply all elements state and color from SceneManager.elementDatas.
Returns
void
applyAllElementsVisibility
▸ applyAllElementsVisibility(): void
Apply elements visibility from SceneManager.elementDatas.
Returns
void
applyElementsStateAndColor
▸ applyElementsStateAndColor(elNums): void
Apply elements state and color from SceneManager.elementDatas.
Parameters
| Name | Type | Description |
|---|---|---|
elNums | number[] | Numbers for elements list. |
Returns
void
applyInstancedLodsVisibility
▸ applyInstancedLodsVisibility(lod): void
Analyze instanced LODS items visibility by several passes like element state and crop planes. Used to increase performance and cut unnecessary elements from the rendering process.
Parameters
| Name | Type | Description |
|---|---|---|
lod | InstancedLods | InstancedLods object. |
Returns
void
applyInstancesVisibility
▸ applyInstancesVisibility(mesh): void
Analyze instance mesh items visibility by several passes like element state and crop planes. Used to increase performance and cut unnecessary elements from the rendering process.
Parameters
| Name | Type | Description |
|---|---|---|
mesh | InstancedMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], InstancedMeshEventMap> | Instance mesh object. |
Returns
void
applySharedVisibility
▸ applySharedVisibility(geometry, isLine): void
Analyze a nd optimize shared mesh buffer indices by several passes like element state and crop planes. Used to increase performance and cut unnecessary elements from the rendering process.
Parameters
| Name | Type | Description |
|---|---|---|
geometry | BufferGeometry<NormalBufferAttributes> | Buffer geometry object. |
isLine | boolean | Whether buffers are lines or meshes. |
Returns
void
hideElements
▸ hideElements(elNums): void
Hide elements list in scene.
Parameters
| Name | Type | Description |
|---|---|---|
elNums | number[] | Numbers for elements list. |
Returns
void
inactivateElements
▸ inactivateElements(elNums): void
Inactivate (send to underlay) elements list in scene.
Parameters
| Name | Type | Description |
|---|---|---|
elNums | number[] | Numbers for elements list. |
Returns
void
inactivateUnselectedElements
▸ inactivateUnselectedElements(elNums): void
Inactivate all elements in scene excluding elements in list.
Parameters
| Name | Type |
|---|---|
elNums | number[] |
Returns
void
isolateElements
▸ isolateElements(elNums): void
Isolate elements list in scene.
Parameters
| Name | Type | Description |
|---|---|---|
elNums | number[] | Numbers for elements list. |
Returns
void
setAllElementsColor
▸ setAllElementsColor(color?, forceApply?): void
Set new or default color for all elements.
Parameters
| Name | Type | Description |
|---|---|---|
color? | ColorRepresentation | New color for elements. |
forceApply? | boolean | Apply changes to render pipeline. |
Returns
void
setAllElementsState
▸ setAllElementsState(state?, forceApply?, ignoreHidden?): void
Set ElementState for all elements.
Parameters
| Name | Type | Description |
|---|---|---|
state? | ElementState | New or default state for elements. |
forceApply? | boolean | Apply changes to render pipeline. |
ignoreHidden? | boolean | Exclude elements with Hidden state. |
Returns
void
setAllElementsStateAndColor
▸ setAllElementsStateAndColor(state?, color?, forceApply?): void
Set all elements state and color to SceneManager.elementDatas.
Parameters
| Name | Type | Description |
|---|---|---|
state? | ElementState | New state for all elements. |
color? | ColorRepresentation | New color for all elements. |
forceApply? | boolean | Apply changes to render pipeline. |
Returns
void
setElementsColor
▸ setElementsColor(elNums, color?, forceApply?): void
Set new color for elements list.
Parameters
| Name | Type | Description |
|---|---|---|
elNums | number[] | Numbers for elements list. |
color? | ColorRepresentation | ColorRepresentation[] | New color for elements list. |
forceApply? | boolean | Apply changes to render pipeline. |
Returns
void
setElementsState
▸ setElementsState(elNums, state?, forceApply?): void
Set ElementState for elements list.
Parameters
| Name | Type | Description |
|---|---|---|
elNums | number[] | Numbers for elements list. |
state? | ElementState | ElementState[] | New state for elements list. |
forceApply? | boolean | Apply changes to render pipeline. |
Returns
void
setElementsStateAndColor
▸ setElementsStateAndColor(elNums, state?, color?, forceApply?): void
Set elements state and color to SceneManager.elementDatas.
Parameters
| Name | Type | Description |
|---|---|---|
elNums | number[] | Numbers for elements list. |
state? | ElementState | ElementState[] | New state for elements list. |
color? | ColorRepresentation | ColorRepresentation[] | New color for elements list. |
forceApply? | boolean | Apply changes to render pipeline. |
Returns
void
showAllElements
▸ showAllElements(): void
Show all elements in scene.
Returns
void
showElements
▸ showElements(elNums): void
Show (unhide) elements list in scene.
Parameters
| Name | Type | Description |
|---|---|---|
elNums | number[] | Numbers for elements list. |
Returns
void