x_ite 10.1.0 → 10.3.0

package/dist/x_ite.d.ts

@@ -193,6 +193,30 @@ declare class X3DBrowser
     * Returns a reference to the corresponding X3DCanvasElement.
     */
    readonly element: X3DCanvasElement;
+   /**
+    * The `getSupportedProfile` service returns a ProfileInfo object of the named profile from the `supportedProfiles` array. The parameter is the name of a profile from which to fetch the declaration. The browser only returns a ProfileInfo object if it supports the named profile. If it does not support the named profile, an error is thrown.
+    */
+   getSupportedProfile (name: string): ProfileInfo;
+   /**
+    * The `getSupportedComponent` service returns a ComponentInfo object of the named component from the `supportedComponents` array. The parameter is the name of a component from which to fetch the declaration. The browser only returns a ComponentInfo object if it supports the named component. If it does not support the component, an error is thrown.
+    */
+   getSupportedComponent (name : string): ComponentInfo;
+   /**
+    * The `getProfile` service returns a ProfileInfo object of the named profile. The parameter is the name of a profile from which to fetch the declaration. The browser only returns a ProfileInfo object if it supports the named profile. If it does not support the named profile, an error is thrown.
+    */
+   getProfile (name: string): ProfileInfo;
+   /**
+    * The `getComponent` service returns a ComponentInfo object of the named component. The first parameter is the name of a component and the second the level from which to fetch the declaration. The browser only returns a ComponentInfo object if it supports the named component and the requested level. If it does not support the component at the level desired, an error is thrown. If level is omitted, it defaults to the highest supported level of this component.
+    */
+   getComponent (name : string, level : number?): ComponentInfo;
+   /**
+    * The `createScene` service creates a new empty scene that conforms to the given profile and component declarations.
+    */
+   createScene (profile: ProfileInfo, ... components: ComponentInfo []): X3DScene;
+   /**
+    * Loads all components, external and internal, specified by `args`. If the argument is a `String`, the name of a component must be given.
+    */
+   loadComponents (... args: Array <X3DScene | ProfileInfo | ComponentInfoArray | ComponentInfo | string>): Promise <void>;
    /**
     * Replace the current world with this new scene that has been loaded or constructed from somewhere. A Promise is returned that will be resolved when the scene is completely loaded.
     */
@@ -382,16 +406,18 @@ type BrowserProperty = "ABSTRACT_NODES"
    | "BINARY_ENCODING";
 
 type BrowserOption = {
-   Antialiased:                  boolean,
+   SplashScreen:                 boolean,
    Dashboard:                    boolean,
    Rubberband:                   boolean,
    EnableInlineViewpoints:       boolean,
-   MotionBlur:                   boolean,
-   PrimitiveQuality:             QualityLevels,
-   QualityWhenMoving:            QualityLevels | "SAME",
+   Antialiased:                  boolean,
+   TextureQuality:               QualityLevelTypes,
+   PrimitiveQuality:             QualityLevelTypes,
+   QualityWhenMoving:            QualityLevelTypes | "SAME",
    Shading:	                     ShadingTypes,
-   SplashScreen:                 boolean,
-   TextureQuality:               QualityLevels,
+   MotionBlur:                   boolean,
+   // Additional options:
+   AlwaysUpdateGeometries:       boolean,
    AutoUpdate:                   boolean,
    Cache:                        boolean,
    ColorSpace:                   ColorSpaceTypes,
@@ -400,19 +426,25 @@ type BrowserOption = {
    Debug:                        boolean,
    Exposure:                     number,
    Gravity:                      number,
+   LoadUrlObjects:               boolean,
    LogarithmicDepthBuffer:       boolean,
+   MetadataReference:            string,
    Multisampling:                number,
    Notifications:                boolean,
    OrderIndependentTransparency: boolean,
    StraightenHorizon:            boolean,
+   TextCompression:              "CHAR_SPACING" | "SCALING",
    Timings:                      boolean,
    ToneMapping:                  ToneMappingTypes,
-}
+   XRButton:                     boolean,
+   XRMovementControl:            "VIEWER_POSE" | "VIEWPOINT",
+   XRSessionMode:                "NONE" | "IMMERSIVE_VR",
+};
 
-type ColorSpaceTypes = "SRGB" | "LINEAR_WHEN_PHYSICAL_MATERIAL" | "LINEAR";
-type QualityLevels = "LOW" | "MEDIUM" | "HIGH";
-type ShadingTypes = "POINT" | "WIREFRAME" | "FLAT" | "GOURAUD" | "PHONG";
-type ToneMappingTypes = "NONE" | "ACES_NARKOWICZ" | "ACES_HILL" | "ACES_HILL_EXPOSURE_BOOST" | "KHR_PBR_NEUTRAL";
+type ColorSpaceTypes   = "SRGB" | "LINEAR_WHEN_PHYSICAL_MATERIAL" | "LINEAR";
+type QualityLevelTypes = "LOW" | "MEDIUM" | "HIGH";
+type ShadingTypes      = "POINT" | "WIREFRAME" | "FLAT" | "GOURAUD" | "PHONG";
+type ToneMappingTypes  = "NONE" | "ACES_NARKOWICZ" | "ACES_HILL" | "ACES_HILL_EXPOSURE_BOOST" | "KHR_PBR_NEUTRAL";
 
 type RenderingProperty = {
    Shading:	               ShadingTypes,
@@ -423,6 +455,7 @@ type RenderingProperty = {
    ColorDepth:             number,
    TextureMemory:          number,
    ContentScale:           number,
+   MaxAnisotropicDegree:   number,
    MaxSamples:             number,
    Multisampling:          number,
    LogarithmicDepthBuffer: boolean,
@@ -495,6 +528,30 @@ declare class X3DScene extends X3DExecutionContext
     */
    readonly exportedNodes: ExportedNodesArray;
 
+   /**
+    * Replaces the profile of this scene by the given profile. A profile of `null` is equivalent to a 'Full' profile.
+    */
+   setProfile (profile: ProfileInfo | null): void;
+   /**
+    * Adds the component to the list of components.
+    */
+   addComponent (component: ComponentInfo): void;
+   /**
+    * Updates the component.
+    */
+   updateComponent (component: ComponentInfo): void;
+   /**
+    * Removes the component with the given name.
+    */
+   removeComponent (name: string): void;
+   /**
+    * Updates the *name* and the *conversion factor* of the unit specified by *category*.
+    */
+   updateUnit (category: string, name: string, conversionFactor: number): void;
+   /**
+    * Returns the UnitInfo object with the given *category*.
+    */
+   getUnit (category: string): UnitInfo;
    /**
     * Returns the metadata values array associated with *name*.
     */
@@ -1158,6 +1215,7 @@ interface X3DConstants
    readonly CylinderSensor: number;
    readonly Delay: number;
    readonly DepthMode: number;
+   readonly DiffuseTransmissionMaterialExtension: number;
    readonly DirectionalLight: number;
    readonly DISEntityManager: number;
    readonly DISEntityTypeMapping: number;
@@ -2923,7 +2981,7 @@ interface AnchorProxy extends X3DGroupingNodeProxy, X3DUrlObjectProxy
    visible: boolean;
 }
 
-/** AnisotropyMaterialExtension is an extension for PhysicalMaterial node and SpecularGlossinessMaterial node. */
+/** AnisotropyMaterialExtension is an extension for the PhysicalMaterial and SpecularGlossinessMaterial nodes. For this node to have an effect, add an EnvironmentLight node. */
 interface AnisotropyMaterialExtensionProxy extends X3DMaterialExtensionNodeProxy
 {
    /**
@@ -4602,7 +4660,7 @@ interface Circle2DProxy extends X3DGeometryNodeProxy
    radius: number;
 }
 
-/** ClearcoatMaterialExtension is an extension for PhysicalMaterial node and SpecularGlossinessMaterial node. */
+/** ClearcoatMaterialExtension is an extension for the PhysicalMaterial and SpecularGlossinessMaterial nodes. For this node to have an effect, add an EnvironmentLight node. */
 interface ClearcoatMaterialExtensionProxy extends X3DMaterialExtensionNodeProxy
 {
    /**
@@ -6309,6 +6367,53 @@ interface DepthModeProxy extends X3DAppearanceChildNodeProxy
    polygonOffset: SFVec2f;
 }
 
+/** DiffuseTransmissionMaterialExtension is an extension for the PhysicalMaterial and SpecularGlossinessMaterial nodes. For this node to have an effect, add an EnvironmentLight node. */
+interface DiffuseTransmissionMaterialExtensionProxy extends X3DMaterialExtensionNodeProxy
+{
+   /**
+   * The percentage of reflected, non-specularly reflected light that is transmitted through the surface via the Lambertian diffuse transmission, i.e., the strength of the diffuse transmission effect.
+   *
+   * This field is of access type 'inputOutput' and type SFFloat.
+   */
+   diffuseTransmission: number;
+   /**
+   * The color of the transmitted light.
+   *
+   * This field is of access type 'inputOutput' and type SFColor.
+   */
+   diffuseTransmissionColor: SFColor;
+   /**
+   * A texture that defines the color of the transmitted light, stored in the RGB channels and encoded in sRGB. This texture will be multiplied by diffuseTransmissionColorFactor.
+   *
+   * This field is of access type 'inputOutput' and type SFNode.
+   */
+   diffuseTransmissionColorTexture: SFNode | null;
+   /**
+   * Input/Output field *diffuseTransmissionColorTextureMapping*.
+   *
+   * This field is of access type 'inputOutput' and type SFString.
+   */
+   diffuseTransmissionColorTextureMapping: string;
+   /**
+   * A texture that defines the strength of the diffuse transmission effect, stored in the alpha (A) channel. Will be multiplied by the diffuseTransmissionFactor.
+   *
+   * This field is of access type 'inputOutput' and type SFNode.
+   */
+   diffuseTransmissionTexture: SFNode | null;
+   /**
+   * Input/Output field *diffuseTransmissionTextureMapping*.
+   *
+   * This field is of access type 'inputOutput' and type SFString.
+   */
+   diffuseTransmissionTextureMapping: string;
+   /**
+   * Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
+   *
+   * This field is of access type 'inputOutput' and type SFNode.
+   */
+   metadata: SFNode | null;
+}
+
 /** DirectionalLight might not be scoped by parent Group or Transform at levels 1 or 2. */
 interface DirectionalLightProxy extends X3DLightNodeProxy
 {
@@ -6533,7 +6638,7 @@ interface Disk2DProxy extends X3DGeometryNodeProxy
    solid: boolean;
 }
 
-/** DispersionMaterialExtension is an extension for PhysicalMaterial node and SpecularGlossinessMaterial node. */
+/** DispersionMaterialExtension is an extension for the PhysicalMaterial and SpecularGlossinessMaterial nodes. For this node to have an effect, add an EnvironmentLight node. */
 interface DispersionMaterialExtensionProxy extends X3DMaterialExtensionNodeProxy
 {
    /**
@@ -7017,7 +7122,7 @@ interface ElevationGridProxy extends X3DGeometryNodeProxy
    zSpacing: number;
 }
 
-/** EmissiveStrengthMaterialExtension is an extension for PhysicalMaterial node and SpecularGlossinessMaterial node. */
+/** EmissiveStrengthMaterialExtension is an extension for the PhysicalMaterial and SpecularGlossinessMaterial nodes. */
 interface EmissiveStrengthMaterialExtensionProxy extends X3DMaterialExtensionNodeProxy
 {
    /**
@@ -7034,7 +7139,7 @@ interface EmissiveStrengthMaterialExtensionProxy extends X3DMaterialExtensionNod
    metadata: SFNode | null;
 }
 
-/** EnvironmentLight ... This node only affects PhysicalMaterial nodes and SpecularGlossinessMaterial nodes. */
+/** EnvironmentLight ... This node only affects the PhysicalMaterial and SpecularGlossinessMaterial nodes. */
 interface EnvironmentLightProxy extends X3DLightNodeProxy
 {
    /**
@@ -10736,7 +10841,7 @@ interface IntegerTriggerProxy extends X3DTriggerNodeProxy
    readonly triggerValue: number;
 }
 
-/** IORMaterialExtension is an extension for PhysicalMaterial node and SpecularGlossinessMaterial node. */
+/** IORMaterialExtension is an extension for the PhysicalMaterial and SpecularGlossinessMaterial nodes. For this node to have an effect, add an EnvironmentLight node. */
 interface IORMaterialExtensionProxy extends X3DMaterialExtensionNodeProxy
 {
    /**
@@ -10753,7 +10858,7 @@ interface IORMaterialExtensionProxy extends X3DMaterialExtensionNodeProxy
    metadata: SFNode | null;
 }
 
-/** IridescenceMaterialExtension is an extension for PhysicalMaterial node and SpecularGlossinessMaterial node. */
+/** IridescenceMaterialExtension is an extension for the PhysicalMaterial and SpecularGlossinessMaterial nodes. For this node to have an effect, add an EnvironmentLight node. */
 interface IridescenceMaterialExtensionProxy extends X3DMaterialExtensionNodeProxy
 {
    /**
@@ -16303,7 +16408,7 @@ interface ShapeProxy extends X3DShapeNodeProxy
    visible: boolean;
 }
 
-/** SheenMaterialExtension is an extension for PhysicalMaterial node and SpecularGlossinessMaterial node. */
+/** SheenMaterialExtension is an extension for the PhysicalMaterial and SpecularGlossinessMaterial nodes. For this node to have an effect, add an EnvironmentLight node. */
 interface SheenMaterialExtensionProxy extends X3DMaterialExtensionNodeProxy
 {
    /**
@@ -17083,7 +17188,7 @@ interface SpecularGlossinessMaterialProxy extends X3DOneSidedMaterialNodeProxy
    transparency: number;
 }
 
-/** SpecularMaterialExtension is an extension for PhysicalMaterial node and SpecularGlossinessMaterial node. */
+/** SpecularMaterialExtension is an extension for the PhysicalMaterial and SpecularGlossinessMaterial nodes. For this node to have an effect, add an EnvironmentLight node. */
 interface SpecularMaterialExtensionProxy extends X3DMaterialExtensionNodeProxy
 {
    /**
@@ -18990,7 +19095,7 @@ interface TransformSensorProxy extends X3DEnvironmentalSensorNodeProxy
    targetObject: X3DGroupingNodeProxy | X3DShapeNodeProxy | null;
 }
 
-/** TransmissionMaterialExtension is an extension for PhysicalMaterial node and SpecularGlossinessMaterial node. */
+/** TransmissionMaterialExtension is an extension for the PhysicalMaterial and SpecularGlossinessMaterial nodes. For this node to have an effect, add an EnvironmentLight node. */
 interface TransmissionMaterialExtensionProxy extends X3DMaterialExtensionNodeProxy
 {
    /**
@@ -20181,7 +20286,7 @@ interface VolumeEmitterProxy extends X3DParticleEmitterNodeProxy
    variation: number;
 }
 
-/** VolumeMaterialExtension is an extension for PhysicalMaterial node and SpecularGlossinessMaterial node. */
+/** VolumeMaterialExtension is an extension for the PhysicalMaterial and SpecularGlossinessMaterial nodes. For this node to have an effect, add an EnvironmentLight node. */
 interface VolumeMaterialExtensionProxy extends X3DMaterialExtensionNodeProxy
 {
    /**
@@ -22238,6 +22343,7 @@ type ConcreteNodeTypes = {
    CylinderSensor: CylinderSensorProxy,
    Delay: DelayProxy,
    DepthMode: DepthModeProxy,
+   DiffuseTransmissionMaterialExtension: DiffuseTransmissionMaterialExtensionProxy,
    DirectionalLight: DirectionalLightProxy,
    DISEntityManager: DISEntityManagerProxy,
    DISEntityTypeMapping: DISEntityTypeMappingProxy,