@kitware/vtk.js 21.1.5 → 21.3.0

package/Rendering/Core/Light.d.ts

@@ -1,248 +1,290 @@
+import { mat4 } from "gl-matrix";
 import { vtkObject } from '@kitware/vtk.js/interfaces';
-import { Color } from '@kitware/vtk.js/types';
+import { RGBColor, Vector3 } from '@kitware/vtk.js/types';
+
+export enum LIGHT_TYPES {
+	'HeadLight',
+	'CameraLight',
+	'SceneLight'
+}
 
 export interface ILightInitialValues {
-    switch?: boolean;
-    intensity?: number;
-    color?: Color;
-    position?: number[];
-    focalPoint?: number[];
-    positional?: boolean;
-    exponent?: number;
-    coneAngle?: number;
-    attenuationValues?: number[];
-    lightType?: string;
-    shadowAttenuation?: number;
-    direction?: number[];
-    directionMTime?: number;
+	switch?: boolean;
+	intensity?: number;
+	color?: RGBColor;
+	position?: Vector3;
+	focalPoint?: Vector3;
+	positional?: boolean;
+	exponent?: number;
+	coneAngle?: number;
+	attenuationValues?: number[];
+	lightType?: LIGHT_TYPES;
+	shadowAttenuation?: number;
+	direction?: Vector3;
+	directionMTime?: number;
 }
 
 export interface vtkLight extends vtkObject {
 
-    /**
-     * 
-     */
-    getAttenuationValues(): number[];
-
-    /**
-     * 
-     */
-    getAttenuationValuesByReference(): number[];
-    
-    /**
-     * 
-     */
-    getColor(): Color;
-    
-    /**
-     * 
-     */
-    getColorByReference(): Color;
-    
-    /**
-     * 
-     */
-    getConeAngle(): number;
-
-    /**
-     * 
-     */
-    getDirection(): number[];
-
-    /**
-     * Get the exponent of the cosine used in positional lighting.
-     */
-    getExponent(): number;
-    
-    /**
-     * Get the focal point.
-     */
-    getFocalPoint(): number[];
-    
-    /**
-     * Get the focal point.
-     */
-    getFocalPointByReference(): number[];
-
-    /**
-     * Get the brightness of the light
-     */
-    getIntensity(): number
-    
-    /**
-     * Get the type of the light.
-     */
-    getLightType(): string
-
-    /**
-     * 
-     */
-    getPosition(): number[];
-    
-    /**
-     * 
-     */
-    getPositionByReference(): number[];
-    
-    /**
-     * 
-     */
-    getPositional(): boolean
-    
-    /**
-     * Get the position of the light, modified by the transformation matrix (if it exists).
-     */
-    getTransformedPosition(): any;
-
-    /**
-     * Get the focal point of the light, modified by the transformation matrix (if it exists).
-     */
-    getTransformedFocalPoint(): number[];
-    
-    /**
-     * Set the quadratic attenuation constants.
-     * @param a 
-     * @param b 
-     * @param c 
-     */
-    setAttenuationValues(a: number, b: number, c: number): boolean;
-    
-    /**
-     * Set the quadratic attenuation constants from an array.
-     * @param attenuationValues 
-     */
-    setAttenuationValuesFrom(attenuationValues: number[]): boolean;
-
-    /**
-     * Set the color of the object
-     * @param {Number} r Defines the red component (between 0 and 1).
-     * @param {Number} g Defines the green component (between 0 and 1).
-     * @param {Number} b Defines the blue component (between 0 and 1).
-     */
-    setColor(r: number, g: number, b: number): boolean;
-
-    /**
-     * 
-     * @param {Number[]} color 
-     */
-    setColorFrom(color: number[]): boolean;
-
-    /**
-     * Set the lighting cone angle of a positional light in degrees.
-     * This is the angle between the axis of the cone and a ray along the edge of the cone. 
-     * A value of 90 (or more) indicates that you want no spot lighting effects just a positional light.
-     * @param coneAngle 
-     */
-    setConeAngle(coneAngle: number): boolean;
-
-    /**
-     * Set the position and focal point of a light based on elevation and azimuth.
-     * The light is moved so it is shining from the given angle.
-     * Angles are given in degrees. If the light is a positional light, it is made directional instead.
-     * @param elevation 
-     * @param azimuth 
-     */
-    setDirectionAngle(elevation: number, azimuth: number): boolean;
-
-    /**
-     * Set the exponent of the cosine used in positional lighting.
-     * @param exponent 
-     */
-    setExponent(exponent: number): boolean;
-
-    /**
-     * Set the focal point.
+	/**
+	 * 
+	 */
+	getAttenuationValues(): number[];
+
+	/**
+	 * 
+	 */
+	getAttenuationValuesByReference(): number[];
+
+	/**
+	 * Get the color of the light.
+	 */
+	getColor(): RGBColor;
+
+	/**
+	 * Get the color of the light.
+	 */
+	getColorByReference(): RGBColor;
+
+	/**
+	 * Get the lighting cone angle of a positional light in degrees.
+	 * This is the angle between the axis of the cone and a ray along the edge
+	 * of the cone. A value of 90 (or more) indicates that you want no spot
+	 * lighting effects just a positional light.
+	 */
+	getConeAngle(): number;
+
+	/**
+	 * Set the position and focal point of a light based on elevation and azimuth.
+	 * The light is moved so it is shining from the given angle. Angles are
+	 * given in degrees. If the light is a positional light, it is made
+	 * directional instead.
+	 */
+	getDirection(): Vector3;
+
+	/**
+	 * Get the exponent of the cosine used in positional lighting.
+	 */
+	getExponent(): number;
+	
+	/**
+	 * Get the focal point.
+	 */
+	getFocalPoint(): Vector3;
+
+	/**
+	 * Get the focal point.
+	 */
+	getFocalPointByReference(): Vector3;
+
+	/**
+	 * Get the brightness of the light
+	 */
+	getIntensity(): number
+	
+	/**
+	 * Get the type of the light.
+	 */
+	getLightType(): string
+
+	/**
+	 * Get the position of the light.
+	 */
+	getPosition(): Vector3;
+	
+	/**
+	 * Get the position of the light.
+	 */
+	getPositionByReference(): Vector3;
+	
+	/**
+	 * Get if positional lighting is on or off.
+	 */
+	getPositional(): boolean
+	
+	/**
+	 * Get the position of the light, modified by the transformation matrix (if
+	 * it exists).
+	 */
+	getTransformedPosition(): Vector3;
+
+	/**
+	 * Get the focal point of the light, modified by the transformation matrix
+	 * (if it exists).
+	 */
+	getTransformedFocalPoint(): Vector3;
+	
+	/**
+	 * Set the quadratic attenuation constants.
+	 * @param {Number} a 
+	 * @param {Number} b 
+	 * @param {Number} c 
+	 */
+	setAttenuationValues(a: number, b: number, c: number): boolean;
+
+	/**
+	 * Set the quadratic attenuation constants from an array.
+	 * @param {Number[]} attenuationValues The quadratic attenuation.
+	 */
+	setAttenuationValuesFrom(attenuationValues: number[]): boolean;
+
+	/**
+	 * Set the color of the object. Has the side effect of setting the
+	 * ambient diffuse and specular colors as well. This is basically
+	 * a quick overall color setting method.
+	 * @param {Number} r Defines the red component (between 0 and 1).
+	 * @param {Number} g Defines the green component (between 0 and 1).
+	 * @param {Number} b Defines the blue component (between 0 and 1).
+	 */
+	setColor(r: number, g: number, b: number): boolean;
+
+	/**
+	 * Set the color of the object. Has the side effect of setting the
+	 * ambient diffuse and specular colors as well. This is basically
+	 * a quick overall color setting method.
+	 * @param {RGBColor} color Defines the RGB color array..
+	 */
+	setColor(color: RGBColor): boolean;
+
+	/**
+	 * Set the color of the object. Has the side effect of setting the
+	 * ambient diffuse and specular colors as well. This is basically
+	 * a quick overall color setting method.
+	 * @param {Number} r Defines the red component (between 0 and 1).
+	 * @param {Number} g Defines the green component (between 0 and 1).
+	 * @param {Number} b Defines the blue component (between 0 and 1).
+	 */
+	setColorFrom(r: number, g: number, b: number): boolean;
+
+	/**
+	 * Set the color of the object. Has the side effect of setting the
+	 * ambient diffuse and specular colors as well. This is basically
+	 * a quick overall color setting method.
+	 * @param {RGBColor} color Defines the RGB color array..
+	 */
+	setColorFrom(color: RGBColor): boolean;
+
+	/**
+	 * Set the lighting cone angle of a positional light in degrees.
+	 * This is the angle between the axis of the cone and a ray along the edge
+	 * of the cone. 
+	 * A value of 90 (or more) indicates that you want no spot lighting effects
+	 * just a positional light.
+	 * @param {Number} coneAngle The cone angle.
+	 */
+	setConeAngle(coneAngle: number): boolean;
+
+	/**
+	 * Set the position and focal point of a light based on elevation and
+	 * azimuth. The light is moved so it is shining from the given angle. Angles
+	 * are given in degrees. If the light is a positional light, it is made
+	 * directional instead.
+	 * @param {Number} elevation 
+	 * @param {Number} azimuth 
+	 */
+	setDirectionAngle(elevation: number, azimuth: number): boolean;
+
+	/**
+	 * Set the exponent of the cosine used in positional lighting.
+	 * @param {Number} exponent The exponent of the cosine.
+	 */
+	setExponent(exponent: number): boolean;
+
+	/**
+	 * Set the focal point.
 	 * @param {Number} x The x coordinate.
 	 * @param {Number} y The y coordinate.
 	 * @param {Number} z The z coordinate.
-     */
-    setFocalPoint(x: number, y: number, z: number): boolean;
-
-    /**
-     * Set the focal point from an array
-     * @param focalPoint 
-     */
-    setFocalPointFrom(focalPoint: number[]): boolean;
-
-    /**
-     * Set the brightness of the light (from one to zero).
-     * @param intensity 
-     */
-    setIntensity(intensity: number): boolean;
-
-    /**
-     * Set the type of the light to lightType
-     * @param lightType 
-     */
-    setLightType(lightType: string): boolean;
-
-    /**
-     * Set the type of the light is CameraLight.
-     */
-    setLightTypeToCameraLight(): boolean;
-
-    /**
-     * Set the the type of the light is HeadLight.
-     */
-    setLightTypeToHeadLight(): boolean;
-
-    /**
-     * Set the the type of the light is SceneLight.
-     */
-    setLightTypeToSceneLight(): boolean;
-
-    /**
-     * Check if the type of the light is CameraLight.
-     */
-    lightTypeIsCameraLight(): boolean;
-
-    /**
-     * Check if the type of the light is HeadLight.
-     */
-    lightTypeIsHeadLight(): boolean;
-
-    /**
-     * Check if the type of the light is SceneLight.
-     */
-    lightTypeIsSceneLight(): boolean;
-
-    /**
-     * 
+	 */
+	setFocalPoint(x: number, y: number, z: number): boolean;
+
+	/**
+	 * Set the focal point from an array
+	 * @param {Vector3} focalPoint The focal point array.
+	 */
+	setFocalPointFrom(focalPoint: Vector3): boolean;
+
+	/**
+	 * Set the brightness of the light (from one to zero).
+	 * @param {Number} intensity 
+	 */
+	setIntensity(intensity: number): boolean;
+
+	/**
+	 * Set the type of the light to lightType
+	 * @param {LIGHT_TYPES} lightType The light type.
+	 */
+	setLightType(lightType: LIGHT_TYPES): boolean;
+
+	/**
+	 * Set the type of the light is CameraLight.
+	 */
+	setLightTypeToCameraLight(): boolean;
+
+	/**
+	 * Set the the type of the light is HeadLight.
+	 */
+	setLightTypeToHeadLight(): boolean;
+
+	/**
+	 * Set the the type of the light is SceneLight.
+	 */
+	setLightTypeToSceneLight(): boolean;
+
+	/**
+	 * Check if the type of the light is CameraLight.
+	 */
+	lightTypeIsCameraLight(): boolean;
+
+	/**
+	 * Check if the type of the light is HeadLight.
+	 */
+	lightTypeIsHeadLight(): boolean;
+
+	/**
+	 * Check if the type of the light is SceneLight.
+	 */
+	lightTypeIsSceneLight(): boolean;
+
+	/**
+	 * Set the position of the light.
 	 * @param {Number} x The x coordinate.
 	 * @param {Number} y The y coordinate.
 	 * @param {Number} z The z coordinate.
-     */
-    setPosition(x: number, y: number, z: number): boolean;
-
-    /**
-     * 
-     * @param position 
-     */
-    setPositionFrom(position: number[]): boolean;
-
-    /**
-     * 
-     * @param positional 
-     */
-    setPositional(positional: boolean): boolean;
-
-    /**
-     * 
-     * @param shadowAttenuation 
-     */
-    setShadowAttenuation(shadowAttenuation: number): boolean;
-
-    /**
-     * 
-     * @param switchValue 
-     */
-    setSwitch(switchValue: boolean): boolean;
-
-    /**
-     * 
-     * @param transformMatrix 
-     */
-    setTransformMatrix(transformMatrix: any): boolean;
+	 */
+	setPosition(x: number, y: number, z: number): boolean;
+
+	/**
+	 * Set the position of the light.
+	 * @param {Vector3} position The position coordinate of the light.
+	 */
+	setPositionFrom(position: Vector3): boolean;
+
+	/**
+	 * Turn positional lighting on or off.
+	 * @param {Boolean} positional The positional value.
+	 */
+	setPositional(positional: boolean): boolean;
+
+	/**
+	 * Set the shadow intensity By default a light will be completely blocked
+	 * when in shadow by setting this value to less than 1.0 you can control how
+	 * much light is attenuated when in shadow.
+	 * @param {Number} shadowAttenuation The shadow attenuation value.
+	 */
+	setShadowAttenuation(shadowAttenuation: number): boolean;
+
+	/**
+	 * Turn the light on or off.
+	 * @param {Boolean} switchValue The switch value.
+	 */
+	setSwitch(switchValue: boolean): boolean;
+
+	/**
+	 * Set the light's transformation matrix.
+	 * @param {mat4} transformMatrix The transform matrix.
+	 */
+	setTransformMatrix(transformMatrix: mat4): boolean;
 }
 
 /**
@@ -285,7 +327,8 @@ export function newInstance(initialValues?: ILightInitialValues): vtkLight;
  * their transformation matrix (if it exists).
  */
 export declare const vtkLight: {
-    newInstance: typeof newInstance,
-    extend: typeof extend,
+	newInstance: typeof newInstance,
+	extend: typeof extend,
+	LIGHT_TYPES: LIGHT_TYPES;
 };
 export default vtkLight;