Skip to content

Commit

Permalink
docs: add proper documentation for outline thickness
Browse files Browse the repository at this point in the history
  • Loading branch information
sedghi committed Dec 21, 2023
1 parent abb96c6 commit 490d740
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
22 changes: 22 additions & 0 deletions Sources/Rendering/Core/ImageProperty/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ export interface IImagePropertyInitialValues {
opacity?: number;
componentData?: IComponentData[];
useLookupTableScalarRange?: boolean;
useLabelOutline?: boolean;
labelOutlineThickness?: number | number[];
}

export interface vtkImageProperty extends vtkObject {
Expand Down Expand Up @@ -92,6 +94,26 @@ export interface vtkImageProperty extends vtkObject {
*/
getScalarOpacity(idx?: number): vtkPiecewiseFunction;

/**
* gets the label outline thickness
*/
getLabelOutlineThickness(): number;

/**
* It will set the label outline thickness for the labelmaps. It can accept
* a single number or an array of numbers. If a single number is provided,
* it will be used for all the segments. If an array is provided, it indicates
* the thickness for each segment index. For instance if you have a labelmap
* with 3 segments (0: background 1: liver 2: tumor), you can set the thickness
* to [2,4] to have a thicker outline for the tumor (thickness 4). It should be
* noted that the thickness is in pixel and also the first array value will
* control the default thickness for all labels when 0 or not specified.
*
* @param {Number | Number[]} labelOutlineThickness
*/
setLabelOutlineThickness(labelOutlineThickness: number | number[]): boolean;


/**
* Set the ambient lighting coefficient.
* @param {Number} ambient The ambient lighting coefficient.
Expand Down
4 changes: 2 additions & 2 deletions Sources/Rendering/Core/VolumeProperty/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export interface IVolumePropertyInitialValues {
specular?: number;
specularPower?: number;
useLabelOutline?: boolean;
labelOutlineThickness?: number;
labelOutlineThickness?: number | number[];
}

export interface vtkVolumeProperty extends vtkObject {
Expand Down Expand Up @@ -92,7 +92,7 @@ export interface vtkVolumeProperty extends vtkObject {
getOpacityMode(index: number): OpacityMode;

/**
*
* gets the label outline thickness
*/
getLabelOutlineThickness(): number;

Expand Down

0 comments on commit 490d740

Please sign in to comment.