@kitware/vtk.js 25.0.2 → 25.1.0

package/Rendering/Core/Prop/Constants.d.ts

@@ -0,0 +1,9 @@
+export declare enum CoordinateSystem {
+	WORLD = 0,
+	DISPLAY = 1,
+}
+
+declare const _default: {
+	CoordinateSystem: typeof CoordinateSystem;
+};
+export default _default;

package/Rendering/Core/Prop/Constants.js

@@ -0,0 +1,9 @@
+var CoordinateSystem = {
+  DISPLAY: 0,
+  WORLD: 1
+};
+var Constants = {
+  CoordinateSystem: CoordinateSystem
+};
+
+export { CoordinateSystem, Constants as default };

package/Rendering/Core/Prop.d.ts

@@ -3,6 +3,7 @@ import vtkActor from './Actor';
 import vtkActor2D from './Actor2D';
 import vtkTexture from './Texture';
 import vtkVolume from './Volume';
+import { CoordinateSystem } from './Prop/Constants';
 
 
 export interface IPropInitialValues {
@@ -20,8 +21,8 @@ export interface IPropInitialValues {
 export interface vtkProp extends vtkObject {
 
     /**
-     * 
-     * @param estimatedRenderTime 
+     *
+     * @param estimatedRenderTime
      */
     addEstimatedRenderTime(estimatedRenderTime: number): void;
 
@@ -37,6 +38,11 @@ export interface vtkProp extends vtkObject {
      */
     getActors2D(): vtkActor2D[];
 
+	/**
+	 * Get the coordinate system this prop is defined in.
+	 */
+    getCoordinateSystem(): CoordinateSystem;
+
     /**
      * Get the value of the dragable instance variable.
      * @see getNestedDragable
@@ -83,32 +89,32 @@ export interface vtkProp extends vtkObject {
     getNestedPickable(): boolean;
 
     /**
-     * Return the mtime of anything that would cause the rendered image to appear differently. 
-     * Usually this involves checking the mtime of the prop plus anything else it depends on such as properties, 
+     * Return the mtime of anything that would cause the rendered image to appear differently.
+     * Usually this involves checking the mtime of the prop plus anything else it depends on such as properties,
      * textures etc.
      */
     getRedrawMTime(): number
 
     /**
-     * 
+     *
      */
     getRendertimemultiplier(): number;
 
     /**
      * The value is returned in seconds. For simple geometry the accuracy may not be great
-     * due to buffering. For ray casting, which is already multi-resolution, 
-     * the current resolution of the image is factored into the time. We need the viewport 
+     * due to buffering. For ray casting, which is already multi-resolution,
+     * the current resolution of the image is factored into the time. We need the viewport
      * for viewing parameters that affect timing. The no-arguments version simply returns the value of the variable with no estimation.
      */
     getEstimatedRenderTime(): number;
 
     /**
-     * 
+     *
      */
     getAllocatedRenderTime(): number;
 
     /**
-     * 
+     *
      */
     getNestedProps(): any;
 
@@ -119,47 +125,47 @@ export interface vtkProp extends vtkObject {
     getParentProp(): vtkProp;
 
     /**
-     * 
+     *
      * Not implemented yet
      */
     getVolumes(): vtkVolume[];
 
     /**
-     * 
+     *
      */
     getUseBounds(): boolean;
 
     /**
-     * 
+     *
      */
     getSupportsSelection(): boolean;
 
     /**
-     * 
+     *
      */
     getTextures(): vtkTexture[];
 
     /**
-     * 
+     *
      * @param {vtkTexture} texture The vtkTexture instance.
      *
      */
     hasTexture(texture: vtkTexture): boolean;
 
     /**
-     * 
+     *
      * @param {vtkTexture} texture The vtkTexture instance.
      */
     addTexture(texture: vtkTexture): void;
 
     /**
-     * 
+     *
      * @param {vtkTexture} texture The vtkTexture instance.
      */
     removeTexture(texture: vtkTexture): void;
 
     /**
-     * 
+     *
      */
     removeAllTextures(): void;
 
@@ -169,15 +175,43 @@ export interface vtkProp extends vtkObject {
     restoreEstimatedRenderTime(): void;
 
     /**
-     * 
-     * @param allocatedRenderTime 
+     *
+     * @param allocatedRenderTime
      */
     setAllocatedRenderTime(allocatedRenderTime: number): void;
 
+	/**
+     * Set the coordinate system that this prop's data should be in.
+     * Once the prop has applied any modifiers such as position, orientation
+     * userMatrix the resulting values will be treated as in the specified
+     * coordinate system.
+     * Not all mappers support all coordinate systems.
+	 * @param {CoordinateSystem} coordinateSystem
+	 */
+    setCoordinateSystem(coordinateSystem: CoordinateSystem): void;
+
+    /**
+     * Indicate that this prop's data should be in world coordinates.
+     * Once the prop has applied any modifiers such as position, orientation
+     * userMatrix the resulting values will be treated as in world coordinates.
+     * Not all mappers support all coordinate systems.
+     */
+    setCoordinateSystemToWorld(): void;
+
+    /**
+     * Indicate that this prop's data should be in display coordinates.
+     * Once the prop has applied any modifiers such as position, orientation
+     * userMatrix the resulting values will be treated as in pixel coordinates.
+     * That is pixel coordinate with 0,0 in the lower left of the viewport
+     * and a z range of -1 at the near plane and 1 at the far.
+     * Not all mappers support all coordinate systems.
+     */
+    setCoordinateSystemToDisplay(): void;
+
     /**
      * Set whether prop is dragable.
      * Even if true, prop may not be dragable if an ancestor prop is not dragable.
-     * @param dragable 
+     * @param dragable
      * @default true
      * @see getDragable
      * @see combineDragable
@@ -185,8 +219,8 @@ export interface vtkProp extends vtkObject {
     setDragable(dragable: boolean): boolean;
 
     /**
-     * 
-     * @param estimatedRenderTime 
+     *
+     * @param estimatedRenderTime
      */
     setEstimatedRenderTime(estimatedRenderTime: number): void;
 
@@ -198,7 +232,7 @@ export interface vtkProp extends vtkObject {
      * @see combineDragable
      * @default null
      */
-     setParentProp(parentProp: vtkProp): void;
+    setParentProp(parentProp: vtkProp): void;
 
     /**
      * Set whether prop is pickable.
@@ -208,20 +242,20 @@ export interface vtkProp extends vtkObject {
      * @see getPickable
      * @see combinePickable
      */
-     setPickable(pickable: boolean): boolean;
+    setPickable(pickable: boolean): boolean;
 
-     /**
-      * Set whether prop is visible.
-      * Even if true, prop may not be visible if an ancestor prop is not visible.
-      * @param visibility
-      * @default true
-      * @see getVisibility
-      * @see combineVisibility
-      */
+    /**
+     * Set whether prop is visible.
+     * Even if true, prop may not be visible if an ancestor prop is not visible.
+     * @param visibility
+     * @default true
+     * @see getVisibility
+     * @see combineVisibility
+     */
     setVisibility(visibility: boolean): boolean;
 
     /**
-     * In case the Visibility flag is true, tell if the bounds of this prop should be taken into 
+     * In case the Visibility flag is true, tell if the bounds of this prop should be taken into
      * account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
      * @param useBounds
      * @default true
@@ -230,7 +264,7 @@ export interface vtkProp extends vtkObject {
 
     /**
      * This is used for culling and is a number between 0 and 1. It is used to create the allocated render time value.
-     * @param {Number} renderTimeMultiplier 
+     * @param {Number} renderTimeMultiplier
      */
     setRenderTimeMultiplier(renderTimeMultiplier: number): boolean;
 
@@ -263,7 +297,7 @@ export function extend(publicAPI: object, model: object, initialValues?: IPropIn
 export function newInstance(initialValues?: IPropInitialValues): vtkProp;
 
 
-/** 
+/**
  * vtkProp is an abstract superclass for any objects that can exist in a
  * rendered scene (either 2D or 3D). Instances of vtkProp may respond to
  * various render methods (e.g., RenderOpaqueGeometry()). vtkProp also

package/Rendering/Core/Prop.js

@@ -1,4 +1,11 @@
+import _defineProperty from '@babel/runtime/helpers/defineProperty';
 import macro from '../../macros.js';
+import Constants from './Prop/Constants.js';
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+var CoordinateSystem = Constants.CoordinateSystem;
 
 function notImplemented(method) {
   return function () {
@@ -116,6 +123,15 @@ function vtkProp(publicAPI, model) {
   publicAPI.removeAllTextures = function () {
     model.textures = [];
     publicAPI.modified();
+  }; // not all mappers support all coordinate systems
+
+
+  publicAPI.setCoordinateSystemToWorld = function () {
+    return publicAPI.setCoordinateSystem(CoordinateSystem.WORLD);
+  };
+
+  publicAPI.setCoordinateSystemToDisplay = function () {
+    return publicAPI.setCoordinateSystem(CoordinateSystem.DISPLAY);
   };
 } // ----------------------------------------------------------------------------
 // Object factory
@@ -124,16 +140,17 @@ function vtkProp(publicAPI, model) {
 
 var DEFAULT_VALUES = {
   // _parentProp: null,
-  visibility: true,
-  pickable: true,
-  dragable: true,
-  useBounds: true,
   allocatedRenderTime: 10,
+  coordinateSystem: CoordinateSystem.WORLD,
+  dragable: true,
   estimatedRenderTime: 0,
-  savedEstimatedRenderTime: 0,
-  renderTimeMultiplier: 1,
   paths: null,
-  textures: []
+  pickable: true,
+  renderTimeMultiplier: 1,
+  savedEstimatedRenderTime: 0,
+  textures: [],
+  useBounds: true,
+  visibility: true
 }; // ----------------------------------------------------------------------------
 
 function extend(publicAPI, model) {
@@ -142,7 +159,7 @@ function extend(publicAPI, model) {
 
   macro.obj(publicAPI, model);
   macro.get(publicAPI, model, ['estimatedRenderTime', 'allocatedRenderTime']);
-  macro.setGet(publicAPI, model, ['visibility', 'pickable', 'dragable', 'useBounds', 'renderTimeMultiplier', '_parentProp']);
+  macro.setGet(publicAPI, model, ['_parentProp', 'coordinateSystem', 'dragable', 'pickable', 'renderTimeMultiplier', 'useBounds', 'visibility']);
   macro.moveToProtected(publicAPI, model, ['parentProp']); // Object methods
 
   vtkProp(publicAPI, model);
@@ -150,9 +167,9 @@ function extend(publicAPI, model) {
 
 var newInstance = macro.newInstance(extend, 'vtkProp'); // ----------------------------------------------------------------------------
 
-var vtkProp$1 = {
+var vtkProp$1 = _objectSpread({
   newInstance: newInstance,
   extend: extend
-};
+}, Constants);
 
 export { vtkProp$1 as default, extend, newInstance };

package/Rendering/Core/Property2D.js

@@ -1,7 +1,11 @@
+import _defineProperty from '@babel/runtime/helpers/defineProperty';
 import macro from '../../macros.js';
 import Constants from './Property2D/Constants.js';
 import { Representation } from './Property/Constants.js';
 
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 var DisplayLocation = Constants.DisplayLocation; // ----------------------------------------------------------------------------
 // vtkProperty2D methods
 // ----------------------------------------------------------------------------
@@ -60,9 +64,9 @@ function extend(publicAPI, model) {
 
 var newInstance = macro.newInstance(extend, 'vtkProperty2D'); // ----------------------------------------------------------------------------
 
-var vtkProperty2D$1 = {
+var vtkProperty2D$1 = _objectSpread({
   newInstance: newInstance,
   extend: extend
-};
+}, Constants);
 
 export { vtkProperty2D$1 as default, extend, newInstance };