Skip to content

Commit a85de03

Browse files
committed
docs(actor2d): add typescript definitions for [set/get]LayerNumber in vtkActor2D
1 parent c45a809 commit a85de03

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

Sources/Rendering/Core/Actor2D/index.d.ts

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,28 @@ export interface vtkActor2D extends vtkProp {
5454
*/
5555
getMapper(): vtkMapper2D;
5656

57+
/**
58+
* Set the layer number for this 2D actor.
59+
* The scenegraph uses this layer number to sort actor 2D overlays/underlays on top of each other.
60+
* The actor2D with the highest layer number is going to be rendered at the very front i.e. it is
61+
* the top-most layer.
62+
* If two actor2D instances share the same layer number, they are rendered in the order in which
63+
* they were added to the renderer via `addActor` or `addActor2D`.
64+
* By default, each actor2D has a layer number of 0.
65+
*/
66+
setLayerNumber(layer: number): void;
67+
68+
/**
69+
* Get the layer number for this 2D actor.
70+
* The scenegraph uses this layer number to sort actor 2D overlays/underlays on top of each other.
71+
* The actor2D with the highest layer number is going to be rendered at the very front i.e. it is
72+
* the top-most layer.
73+
* If two actor2D instances share the same layer number, they are rendered in the order in which
74+
* they were added to the renderer via `addActor` or `addActor2D`.
75+
* By default, each actor2D has a layer number of 0.
76+
*/
77+
getLayerNumber(): number;
78+
5779
/**
5880
*
5981
*/

0 commit comments

Comments
 (0)