Skip to main content

Interface: VtkOffscreenMultiRenderWindow

Extends​

  • vtkObject

Properties​

addRenderer()​

addRenderer: (config) => void

Parameters​

• config: RendererConfig

Returns​

void

Defined in​

packages/core/src/types/VtkOffscreenMultiRenderWindow.ts:38

container​

container: HTMLDivElement

Defined in​

packages/core/src/types/VtkOffscreenMultiRenderWindow.ts:35

destroy()​

destroy: () => void

Returns​

void

Defined in​

packages/core/src/types/VtkOffscreenMultiRenderWindow.ts:44

getContainer()​

getContainer: () => HTMLDivElement

Returns​

HTMLDivElement

Defined in​

packages/core/src/types/VtkOffscreenMultiRenderWindow.ts:36

getInteractor()​

getInteractor: () => vtkRenderWindowInteractor

Returns​

vtkRenderWindowInteractor

Defined in​

packages/core/src/types/VtkOffscreenMultiRenderWindow.ts:33

getOpenGLRenderWindow()​

getOpenGLRenderWindow: () => any

Returns​

any

Defined in​

packages/core/src/types/VtkOffscreenMultiRenderWindow.ts:28

getRenderer()​

getRenderer: (id) => vtkRenderer

Parameters​

• id: string

Returns​

vtkRenderer

Defined in​

packages/core/src/types/VtkOffscreenMultiRenderWindow.ts:40

getRenderers()​

getRenderers: () => object[]

Returns​

object[]

Defined in​

packages/core/src/types/VtkOffscreenMultiRenderWindow.ts:41

getRenderWindow()​

getRenderWindow: () => vtkRenderWindow

Returns​

vtkRenderWindow

Defined in​

packages/core/src/types/VtkOffscreenMultiRenderWindow.ts:23

interactor​

interactor: vtkRenderWindowInteractor

Defined in​

packages/core/src/types/VtkOffscreenMultiRenderWindow.ts:32

openGLRenderWindow​

openGLRenderWindow: any

Defined in​

packages/core/src/types/VtkOffscreenMultiRenderWindow.ts:25

removeRenderer()​

removeRenderer: (id) => void

Parameters​

• id: string

Returns​

void

Defined in​

packages/core/src/types/VtkOffscreenMultiRenderWindow.ts:39

renderWindow​

renderWindow: vtkRenderWindow

Defined in​

packages/core/src/types/VtkOffscreenMultiRenderWindow.ts:22

resize()​

resize: () => void

Returns​

void

Defined in​

packages/core/src/types/VtkOffscreenMultiRenderWindow.ts:42

setContainer()​

setContainer: (el) => void

Parameters​

• el: HTMLDivElement

Returns​

void

Defined in​

packages/core/src/types/VtkOffscreenMultiRenderWindow.ts:43

Methods​

delete()​

delete(): void

Dereference any internal object and remove any subscription. It gives custom class to properly detach themselves from the DOM or any external dependency that could prevent their deletion when the GC runs.

Returns​

void

Inherited from​

vtkObject.delete

Defined in​

node_modules/@kitware/vtk.js/interfaces.d.ts:235

get()​

get(...listOfKeys): object

Extract a set of properties at once from a vtkObject.

This can be convenient to pass a partial state of one object to another.

cameraB.set(cameraA.get('position', 'viewUp', 'focalPoint'));

Parameters​

• ...listOfKeys: string[]

set of field names that you want to retrieve. If not provided, the full model get returned as a new object.

Returns​

object

a new object containing only the values of requested fields

Inherited from​

vtkObject.get

Defined in​

node_modules/@kitware/vtk.js/interfaces.d.ts:219

getClassName()​

getClassName(): string

Return the instance class name.

Returns​

string

Inherited from​

vtkObject.getClassName

Defined in​

node_modules/@kitware/vtk.js/interfaces.d.ts:173

getMTime()​

getMTime(): number

Return the Modified Time which is a monotonic increasing integer global for all vtkObjects.

This allow to solve a question such as:

  • Is that object created/modified after another one?
  • Do I need to re-execute this filter, or not? ...

Returns​

number

the global modified time.

Inherited from​

vtkObject.getMTime

Defined in​

node_modules/@kitware/vtk.js/interfaces.d.ts:161

getReferenceByName()​

getReferenceByName(name): any

Allow to get a direct reference of a model element

Parameters​

• name: string

of the field to extract from the instance model

Returns​

any

model[name]

Inherited from​

vtkObject.getReferenceByName

Defined in​

node_modules/@kitware/vtk.js/interfaces.d.ts:227

getState()​

getState(): object

Try to extract a serializable (JSON) object of the given instance tree.

Such state can then be reused to clone or rebuild a full vtkObject tree using the root vtk() function.

The following example will grab mapper and dataset that are beneath the vtkActor instance as well.

const actorStr = JSON.stringify(actor.getState());
const newActor = vtk(JSON.parse(actorStr));

Returns​

object

Inherited from​

vtkObject.getState

Defined in​

node_modules/@kitware/vtk.js/interfaces.d.ts:252

isA()​

isA(className): boolean

Method to check if an instance is of a given class name. For example such method for a vtkCellArray will return true for any of the following string: ['vtkObject', 'vtkDataArray', 'vtkCellArray']

Parameters​

• className: string

Returns​

boolean

Inherited from​

vtkObject.isA

Defined in​

node_modules/@kitware/vtk.js/interfaces.d.ts:168

isDeleted()​

isDeleted(): boolean

Allow to check if that object was deleted (.delete() was called before).

Returns​

boolean

true if delete() was previously called

Inherited from​

vtkObject.isDeleted

Defined in​

node_modules/@kitware/vtk.js/interfaces.d.ts:134

modified()​

modified(): void

Mark the object dirty by increasing its MTime. Such action also trigger the onModified() callbacks if any was registered. This naturally happens when you call any setXXX(value) with a different value.

Returns​

void

Inherited from​

vtkObject.modified

Defined in​

node_modules/@kitware/vtk.js/interfaces.d.ts:141

onModified()​

onModified(callback): vtkSubscription

Method to register callback when the object is modified().

Parameters​

• callback

function

Returns​

vtkSubscription

subscription object so you can easily unsubscribe later on

Inherited from​

vtkObject.onModified

Defined in​

node_modules/@kitware/vtk.js/interfaces.d.ts:149

set()​

set(map?, noWarning?, noFunction?): boolean

Generic method to set many fields at one.

For example calling the following function

changeDetected = sphereSourceInstance.set({
   phiResolution: 10,
   thetaResolution: 20,
});

will be equivalent of calling

changeDetected += sphereSourceInstance.setPhiResolution(10);
changeDetected += sphereSourceInstance.setThetaResolution(20);
changeDetected = !!changeDetected;

In case you provide other field names that do not belong to the instance, vtkWarningMacro will be used to warn you. To disable those warning, you can set noWarning to true.

If noFunction is set to true, the field will be set directly on the model without calling the set${FieldName}() method.

Parameters​

• map?: object

(default: ) Object capturing the set of fieldNames and associated values to set.

• noWarning?: boolean

(default: false) Boolean to disable any warning.

• noFunction?: boolean

Returns​

boolean

true if a change was actually performed. False otherwise when the value provided were equal to the ones already set inside the instance.

Inherited from​

vtkObject.set

Defined in​

node_modules/@kitware/vtk.js/interfaces.d.ts:204

shallowCopy()​

shallowCopy(other, debug?): void

Try to copy the state of the other to ourselves by just using references.

Parameters​

• other: vtkObject

instance to copy the reference from

• debug?: boolean

(default: false) if true feedback will be provided when mismatch happen

Returns​

void

Inherited from​

vtkObject.shallowCopy

Defined in​

node_modules/@kitware/vtk.js/interfaces.d.ts:271

toJSON()​

toJSON(): object

Used internally by JSON.stringify to get the content to serialize. Allow to call directly JSON.stringify on the vtkObject instead of using getState before doing so.

const actorStr = JSON.stringify(actor);
const newActor = vtk(JSON.parse(actorStr));

Returns​

object

Inherited from​

vtkObject.toJSON

Defined in​

node_modules/@kitware/vtk.js/interfaces.d.ts:263