Skip to content

Commit

Permalink
Merge pull request Kitware#1914 from daker/relative-ts-import
Browse files Browse the repository at this point in the history
docs(ts): use relative import of typescript definitions
  • Loading branch information
jourdain authored May 28, 2021
2 parents 7bff1c4 + a49bcec commit 94f9be2
Show file tree
Hide file tree
Showing 112 changed files with 2,930 additions and 2,455 deletions.
4 changes: 2 additions & 2 deletions Sources/Common/Core/CellArray/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/// <reference path='../../../types.ts' />
import vtkDataArray from "vtk.js/Sources/Common/Core/DataArray";
import { TypedArray } from "../../../types";
import vtkDataArray from "../../Core/DataArray";


/**
Expand Down
4 changes: 2 additions & 2 deletions Sources/Common/Core/DataArray/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/// <reference path='../../../types.ts' />
import { vtkObject, vtkRange } from "../../../interfaces";
import { TypedArray } from "../../../types";

import { vtkObject, vtkRange } from "vtk.js/Sources/interfaces";

/**
* Output of the rangeHelper instance
Expand Down
2 changes: 1 addition & 1 deletion Sources/Common/Core/ImageHelper/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import vtkImageData from "vtk.js/Sources/Common/DataModel/ImageData";
import vtkImageData from "../../../Common/DataModel/ImageData";

interface ITransform {
flipX: boolean;
Expand Down
2 changes: 0 additions & 2 deletions Sources/Common/Core/Math/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
/// <reference path='../../../types.ts' />

import { mat3, vec2, vec3 } from "gl-matrix";

/**
Expand Down
3 changes: 1 addition & 2 deletions Sources/Common/Core/MatrixBuilder/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
/// <reference path='../../../types.ts' />

import { mat4 } from 'gl-matrix';
import { TypedArray } from '../../../types';

declare interface Transform {

Expand Down
7 changes: 4 additions & 3 deletions Sources/Common/Core/Points/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import vtkDataArray from 'vtk.js/Sources/Common/Core/DataArray';
import vtkDataArray from '../../../Common/Core/DataArray';
import { Bounds } from '../../../types';

/**
*
Expand All @@ -18,9 +19,9 @@ export interface vtkPoints extends vtkDataArray {

/**
* Get the bounds for this mapper as [xmin, xmax, ymin, ymax,zmin, zmax].
* @return {Number[]} The bounds for the mapper.
* @return {Bounds} The bounds for the mapper.
*/
getBounds(): number[];
getBounds(): Bounds;

/**
* Get the coordinate of a point.
Expand Down
2 changes: 1 addition & 1 deletion Sources/Common/Core/PriorityQueue/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { vtkObject } from "vtk.js/Sources/interfaces";
import { vtkObject } from "../../../interfaces" ;

/**
*
Expand Down
3 changes: 1 addition & 2 deletions Sources/Common/Core/ProgressHandler/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import { vtkObject } from "vtk.js/Sources/interfaces";

import { vtkObject } from "../../../interfaces" ;

/**
*
Expand Down
43 changes: 0 additions & 43 deletions Sources/Common/Core/ScalarsToColors/api.md
Original file line number Diff line number Diff line change
@@ -1,43 +0,0 @@
## vtkScalarsToColors - Superclass for mapping scalar values to colors

### Description

vtkScalarsToColors is a general-purpose base class for objects that
convert scalars to colors. This include vtkLookupTable classes and
color transfer functions. By itself, this class will simply rescale
the scalars.

The scalar-to-color mapping can be augmented with an additional
uniform alpha blend. This is used, for example, to blend a vtkActor's
opacity with the lookup table values.

Specific scalar values may be annotated with text strings that will
be included in color legends using SetAnnotations, SetAnnotation,
GetNumberOfAnnotatedValues, GetAnnotatedValue, GetAnnotation,
RemoveAnnotation, and ResetAnnotations.

This class also has a method for indicating that the set of
annotated values form a categorical color map; by setting
IndexedLookup to true, you indicate that the annotated values are
the only valid values for which entries in the color table should
be returned. In this mode, subclasses should then assign colors to
annotated values by taking the modulus of an annotated value's
index in the list of annotations with the number of colors in the
table.

## See Also

[vtkLookupTable](./Common_Core_LookupTable.html)
[vtkColorTransferFunction](./Rendering_Core_ColorTransferFunction.html)

## VectorComponent

Select which component of a vector to map to colors.

## VectorSize

When mapping vectors, consider only the number of components selected
by VectorSize to be part of the vector, and ignore any other
components. Set to -1 to map all components. If this is not set
to -1, then you can use SetVectorComponent to set which scalar
component will be the first component in the vector to be mapped.
Loading

0 comments on commit 94f9be2

Please sign in to comment.