Class Isolation

Manages the isolation mechanic in the vim component.

Hierarchy

Isolation

Index

Constructors

Accessors

Methods

any applySettings clear clearReferences current getMaterial getReference hide isolate setReference show toggleIsolation

Constructors

constructor

new Isolation(viewer: Viewer, camera: ComponentCamera, settings: Settings): Isolation
Parameters
- viewer: Viewer
- camera: ComponentCamera
- settings: Settings
Returns Isolation
- Defined in src/helpers/isolation.ts:31

Accessors

onChanged

get onChanged(): ISimpleEvent<string>
Signal dispatched when the isolation set changes.

Returns ISimpleEvent<string>
- Defined in src/helpers/isolation.ts:27

Methods

any

any(): boolean
Returns true if there are currently objects isolated.

Returns
True if there are currently objects isolated; otherwise, false.

Returns boolean
- Defined in src/helpers/isolation.ts:80

applySettings

applySettings(settings: Settings): void
Applies relevant settings to isolation.
Parameters
- settings: Settings
  
  The settings to be applied to isolation.
Returns void
- Defined in src/helpers/isolation.ts:41

clear

clear(source: string): void
Clears the current isolation.
Parameters
- source: string
  
  The source of the isolation clearing operation.
Returns void
- Defined in src/helpers/isolation.ts:193

clearReferences

clearReferences(): void
Clears all reference objects set for VIMs.

Returns void
- Defined in src/helpers/isolation.ts:72

current

current(): IObject[]
Returns the current array of isolated objects.

Returns
The array of objects currently isolated, or undefined if no objects are isolated.

Returns IObject[]
- Defined in src/helpers/isolation.ts:88

getMaterial

getMaterial(settings: Settings, isolate: boolean): Material
Parameters
- settings: Settings
- isolate: boolean
Returns Material
- Defined in src/helpers/isolation.ts:213

getReference

getReference(vim: Vim): "always" | Set<IObject>
Retrieves the reference objects set for a given VIM.

Returns
The reference objects set for the specified VIM.
Parameters
- vim: Vim
  
  The VIM for which reference objects are being retrieved.
Returns "always" | Set<IObject>
- Defined in src/helpers/isolation.ts:65

hide

hide(objects: IObject[], source: string): void
Removes the given objects from the isolation set.
Parameters
- objects: IObject[]
  
  An array of objects to be removed from isolation.
- source: string
  
  The source of the removal operation.
Returns void
- Defined in src/helpers/isolation.ts:160

isolate

isolate(objects: IObject[], source: string): boolean
Isolates the objects in the given array and shows the rest as ghost.

Returns
True if isolation occurs; otherwise, false.
Parameters
- objects: IObject[]
  
  An array of objects to isolate.
- source: string
  
  The source of isolation.
Returns boolean
- Defined in src/helpers/isolation.ts:98

setReference

setReference(vim: Vim, reference: "always" | Object[]): void
Sets the reference objects for a given VIM.
Parameters
- vim: Vim
  
  The VIM for which reference objects are being set.
- reference: "always" | Object[]
  
  An array of reference objects or the string 'always' to indicate permanent reference.
Returns void
- Defined in src/helpers/isolation.ts:55

show

show(objects: IObject[], source: string): void
Adds the given objects to the isolation set.
Parameters
- objects: IObject[]
  
  An array of objects to be added to isolation.
- source: string
  
  The source of the addition operation.
Returns void
- Defined in src/helpers/isolation.ts:179

toggleIsolation

toggleIsolation(source: string): void
Toggles current isolation based on selection.
Parameters
- source: string
  
  The source of isolation.
Returns void
- Defined in src/helpers/isolation.ts:116

Generated using TypeDoc