ViewNode

Source (.js)Source (.d.ts)

Introduction

a node within a VTK scene graph

This is the superclass for all nodes within a VTK scene graph. It contains the API for a node. It supports the essential operations such as graph creation, state storage and traversal. Child classes adapt this to VTK's major rendering classes. Grandchild classes adapt those to for APIs of different rendering libraries.

Methods

addMissingNode

Add a child view node to this node, created from the renderable given as argument If the node creation fails or the argument is falsy, returns undefined Otherwise, returns the newly created node or the existing node

Argument	Type	Required	Description
dobj		Yes

addMissingNodes

Add missing child view nodes for the renderables given as argument. Call it between prepareNodes and removeUnusedNodes.

Argument	Type	Required	Description
dataObjs		Yes
enforceOrder	boolean	No	Keep the view nodes of dataObjs next to each other and in the order of dataObjs, defaults to false

apply

Argument	Type	Required	Description
renderPass	vtkRenderPass	Yes
prepass		Yes

build

Builds myself.

Argument	Type	Required	Description
prepass		Yes

createViewNode

Argument	Type	Required	Description
dataObj		Yes

extend

Method used to decorate a given object (publicAPI+model) with vtkViewNode characteristics.

Argument	Type	Required	Description
publicAPI		Yes	object on which methods will be bounds (public)
model		Yes	object on which data structure will be bounds (protected)
initialValues	IViewNodeInitialValues	No	(default: {})

getChildren

getChildrenByReference

getFirstAncestorOfType

Find the first parent/grandparent of the desired type

Argument	Type	Required	Description
type		Yes

getLastAncestorOfType

Find the last parent/grandparent of the desired type

Argument	Type	Required	Description
type		Yes

getMyFactory

getParent

getRenderable

Get The data object (thing to be rendered).

getViewNodeFor

Returns the view node that corresponding to the provided object Will return NULL if a match is not found in self or descendents

Argument	Type	Required	Description
dataObject		Yes
hint		No	the previously found node (for optimization)

getVisited

newInstance

Method used to create a new instance of vtkViewNode.

Argument	Type	Required	Description
initialValues	IViewNodeInitialValues	No	for pre-setting some of its content

prepareNodes

removeNode

Removes a child view node If the node is not found, returns false Otherwise, removes the node from the children list and returns true

Argument	Type	Required	Description
dobj		Yes

removeUnusedNodes

render

Makes calls to make self visible.

Argument	Type	Required	Description
prepass		Yes

setMyFactory

Argument	Type	Required	Description
myFactory		Yes

setParent

Argument	Type	Required	Description
parent		Yes

setRenderable

Argument	Type	Required	Description
renderable		Yes

setVisited

Argument	Type	Required	Description
val		Yes

traverse

Traverse this node with the specified pass. If you want to traverse your children in a specific order or way override this method

Argument	Type	Required	Description
renderPass	vtkRenderPass	Yes