diff --git a/build/404.html b/build/404.html index 284cdb00..af82e483 100644 --- a/build/404.html +++ b/build/404.html @@ -3,14 +3,14 @@ -Page Not Found | That Open Docs - - +Page Not Found | That Open Docs + + -
-
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

- - +
+
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

+ + \ No newline at end of file diff --git a/build/Tutorials/AngleMeasurement/index.html b/build/Tutorials/AngleMeasurement/index.html index e7b3018b..4e7222a0 100644 --- a/build/Tutorials/AngleMeasurement/index.html +++ b/build/Tutorials/AngleMeasurement/index.html @@ -3,20 +3,20 @@ -AngleMeasurement | That Open Docs - - +AngleMeasurement | That Open Docs + + -
-
Skip to main content

AngleMeasurement

📏 Dimensions Tool​

At times, you may need to compute the dimensions of an object or measure the distance between two elements. +

+

AngleMeasurement

📏 Dimensions Tool​

At times, you may need to compute the dimensions of an object or measure the distance between two elements. Elements must be precisely aligned when working on complex models. Dimension Tool allows you to perform measurements effortlessly.

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

This tutorial will show you how to add Dimension Tool to your projects, -which can be used to acquire accurate dimensions for any 3D Object.🔭

🎲 Creating a Cube Mesh​

For this tutorial we will use a Cube, you can add any geometry as per your preference. +which can be used to acquire accurate dimensions for any 3D Object.🔭

🎲 Creating a Cube Mesh​

For this tutorial we will use a Cube, you can add any geometry as per your preference. We will create a Cube with 3x3x3 dimensions and use red color for the material.

const cubeGeometry = new THREE.BoxGeometry(3, 3, 3);
const cubeMaterial = new THREE.MeshStandardMaterial({ color: '#6528D7' });
const cube = new THREE.Mesh(cubeGeometry, cubeMaterial);
cube.position.set(0, 1.5, 0);

Now, we will add the Cube to the Scene. We must also add the cube to components.meshes, which is simply an array of all the meshes in the Scene.🗄️

scene.add(cube);
components.meshes.add(cube);
Collection of Meshes

📦 Components.meshes keeps all your meshes including IFC Models, Fragments in -one place.

🛠️ Creating Dimension Tool​

A lot of logic is usually needed to compute dimensions for any item, beginning with ray casting, +one place.

🛠️ Creating Dimension Tool​

A lot of logic is usually needed to compute dimensions for any item, beginning with ray casting, finding the vertices to snap to, and rendering the UI for every line element.🙄 This may appear to be a lot of effort, but we are handling all the heavy lifting for you, and you only need to write a few lines for creating the Dimension Tool.💪

const dimensions = new OBC.AngleMeasurement(components);

We will build dimensions by supplying the components to OBC.SimpleDimensions.

DIMENSIONS AND UI

Read the Simple Dimensions API for more on this. @@ -24,17 +24,17 @@ One such property which you can use is dimensions.color which modifies the color of the Line Element. Now, let's enable dimensions and tell them to be snapped at a distance of one unit. snapDistance helps in attaching the tooltip temporarily at regular intervals, -making it easier to interact with items.📍

dimensions.enabled = true;
dimensions.snapDistance = 1;

🖱️ Managing Events​

You can use the Dimension Tool to construct several dimension lines. Let's see how you handle them.

✍️ Creating the Dimensions​

Now that we've generated the dimensions object, we need to attach the line tooltip to a vertex of the 3D object. +making it easier to interact with items.📍

dimensions.enabled = true;
dimensions.snapDistance = 1;

🖱️ Managing Events​

You can use the Dimension Tool to construct several dimension lines. Let's see how you handle them.

✍️ Creating the Dimensions​

Now that we've generated the dimensions object, we need to attach the line tooltip to a vertex of the 3D object. We'll use the double click event to invoke dimensions.create(). When this event occurs, a line element is generated, -and the distance is calculated in real-time inside the label associated with that line.🏷️

container.ondblclick = () => dimensions.create();

🧹 Deleting the Dimensions​

Now that we know how to make multiple dimension lines, we must also know how to delete them when necessary. +and the distance is calculated in real-time inside the label associated with that line.🏷️

container.ondblclick = () => dimensions.create();

🧹 Deleting the Dimensions​

Now that we know how to make multiple dimension lines, we must also know how to delete them when necessary. Dimensions can be removed using dimensions.delete(). dimensions.delete() deletes the dimension on which your mouse pointer is now located.

Deleting all the Dimensions

❎ If you want to safely delete all the dimensions that were created you can simply call -dimensions.deleteAll()

window.onkeydown = (event) => {
if (event.code === 'Delete' || event.code === 'Backspace') {
dimensions.delete();
}
};

⏏️ Creating a Toolbar for the Dimensions​

We'll make a Toolbar Component and set it at the bottom. -In addition, we will have a button that allows you to toggle the dimension tool.

const mainToolbar = new OBC.Toolbar(components, { name: 'Main Toolbar', position: 'bottom' });
mainToolbar.addChild(dimensions.uiElement.get('main'));
components.ui.addToolbar(mainToolbar);

🎛️ Check Toolbar and UIManager tutorial if you have any doubts!

🖌️ Adding Styles​

Few final things, we need to add styles for the labels which display the measurement information.

  • ifcjs-dimension-label - The label which is used to show the metric value after both the tooltips are attached.
  • ifcjs-dimension-label:hover - Changing the styling when someone hovers on the dimension label.
  • ifcjs-dimension-preview - The label which shows the measurement when the tooltip is not yet attached.
style
.ifcjs-dimension-label {
background-color: black;
font-family: sans-serif;
color: white;
padding: 8px;
border-radius: 8px;
pointer-events: all;
transition: background-color 200ms ease-in-out;
}
.ifcjs-dimension-label:hover {
background-color: grey;
}
.ifcjs-dimension-preview {
background-color: #ffffff;
width: 2rem;
height: 2rem;
opacity: 0.3;
padding: 8px;
border-radius: 100%;
}

Congratulations 🎉 on completing this tutorial! Now you can measure any BIM Model or any 3D Object easily using +dimensions.deleteAll()

window.onkeydown = (event) => {
if (event.code === 'Delete' || event.code === 'Backspace') {
dimensions.delete();
}
};

⏏️ Creating a Toolbar for the Dimensions​

We'll make a Toolbar Component and set it at the bottom. +In addition, we will have a button that allows you to toggle the dimension tool.

const mainToolbar = new OBC.Toolbar(components, { name: 'Main Toolbar', position: 'bottom' });
mainToolbar.addChild(dimensions.uiElement.get('main'));
components.ui.addToolbar(mainToolbar);

🎛️ Check Toolbar and UIManager tutorial if you have any doubts!

🖌️ Adding Styles​

Few final things, we need to add styles for the labels which display the measurement information.

  • ifcjs-dimension-label - The label which is used to show the metric value after both the tooltips are attached.
  • ifcjs-dimension-label:hover - Changing the styling when someone hovers on the dimension label.
  • ifcjs-dimension-preview - The label which shows the measurement when the tooltip is not yet attached.
style
.ifcjs-dimension-label {
background-color: black;
font-family: sans-serif;
color: white;
padding: 8px;
border-radius: 8px;
pointer-events: all;
transition: background-color 200ms ease-in-out;
}
.ifcjs-dimension-label:hover {
background-color: grey;
}
.ifcjs-dimension-preview {
background-color: #ffffff;
width: 2rem;
height: 2rem;
opacity: 0.3;
padding: 8px;
border-radius: 100%;
}

Congratulations 🎉 on completing this tutorial! Now you can measure any BIM Model or any 3D Object easily using Simple Dimension Component 📐 -Let's keep it up and check out another tutorial! 🎓

- - +Let's keep it up and check out another tutorial! 🎓

+ + \ No newline at end of file diff --git a/build/Tutorials/AreaMeasurement/index.html b/build/Tutorials/AreaMeasurement/index.html index 36a581b6..f2c4feab 100644 --- a/build/Tutorials/AreaMeasurement/index.html +++ b/build/Tutorials/AreaMeasurement/index.html @@ -3,20 +3,20 @@ -AreaMeasurement | That Open Docs - - +AreaMeasurement | That Open Docs + + -
-
Skip to main content

AreaMeasurement

📏 Dimensions Tool​

At times, you may need to compute the dimensions of an object or measure the distance between two elements. +

+

AreaMeasurement

📏 Dimensions Tool​

At times, you may need to compute the dimensions of an object or measure the distance between two elements. Elements must be precisely aligned when working on complex models. Dimension Tool allows you to perform measurements effortlessly.

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

This tutorial will show you how to add Dimension Tool to your projects, -which can be used to acquire accurate dimensions for any 3D Object.🔭

🎲 Creating a Cube Mesh​

For this tutorial we will use a Cube, you can add any geometry as per your preference. +which can be used to acquire accurate dimensions for any 3D Object.🔭

🎲 Creating a Cube Mesh​

For this tutorial we will use a Cube, you can add any geometry as per your preference. We will create a Cube with 3x3x3 dimensions and use red color for the material.

const cubeGeometry = new THREE.BoxGeometry(3, 3, 3);
const cubeMaterial = new THREE.MeshStandardMaterial({color: '#6528D7'});
const cube = new THREE.Mesh(cubeGeometry, cubeMaterial);
cube.position.set(0, 1.5, 0)

Now, we will add the Cube to the Scene. We must also add the cube to components.meshes, which is simply an array of all the meshes in the Scene.🗄️

scene.add(cube);
components.meshes.add(cube);
Collection of Meshes

📦 Components.meshes keeps all your meshes including IFC Models, Fragments in -one place.

🛠️ Creating Dimension Tool​

A lot of logic is usually needed to compute dimensions for any item, beginning with ray casting, +one place.

🛠️ Creating Dimension Tool​

A lot of logic is usually needed to compute dimensions for any item, beginning with ray casting, finding the vertices to snap to, and rendering the UI for every line element.🙄 This may appear to be a lot of effort, but we are handling all the heavy lifting for you, and you only need to write a few lines for creating the Dimension Tool.💪

const dimensions = new OBC.AreaMeasurement(components);

We will build dimensions by supplying the components to OBC.SimpleDimensions.

DIMENSIONS AND UI

Read the Simple Dimensions API for more on this. @@ -24,17 +24,17 @@ One such property which you can use is dimensions.color which modifies the color of the Line Element. Now, let's enable dimensions and tell them to be snapped at a distance of one unit. snapDistance helps in attaching the tooltip temporarily at regular intervals, -making it easier to interact with items.📍

dimensions.enabled = true;
dimensions.snapDistance = 1;

🖱️ Managing Events​

You can use the Dimension Tool to construct several dimension lines. Let's see how you handle them.

✍️ Creating the Dimensions​

Now that we've generated the dimensions object, we need to attach the line tooltip to a vertex of the 3D object. +making it easier to interact with items.📍

dimensions.enabled = true;
dimensions.snapDistance = 1;

🖱️ Managing Events​

You can use the Dimension Tool to construct several dimension lines. Let's see how you handle them.

✍️ Creating the Dimensions​

Now that we've generated the dimensions object, we need to attach the line tooltip to a vertex of the 3D object. We'll use the double click event to invoke dimensions.create(). When this event occurs, a line element is generated, -and the distance is calculated in real-time inside the label associated with that line.🏷️

container.ondblclick = () => dimensions.create();
container.oncontextmenu = () => dimensions.endCreation();

🧹 Deleting the Dimensions​

Now that we know how to make multiple dimension lines, we must also know how to delete them when necessary. +and the distance is calculated in real-time inside the label associated with that line.🏷️

container.ondblclick = () => dimensions.create();
container.oncontextmenu = () => dimensions.endCreation();

🧹 Deleting the Dimensions​

Now that we know how to make multiple dimension lines, we must also know how to delete them when necessary. Dimensions can be removed using dimensions.delete(). dimensions.delete() deletes the dimension on which your mouse pointer is now located.

Deleting all the Dimensions

❎ If you want to safely delete all the dimensions that were created you can simply call -dimensions.deleteAll()

window.onkeydown = (event) => {
if (event.code === 'Delete' || event.code === 'Backspace') {
// WORK IN PROGRESS
// dimensions.delete();
}
}

⏏️ Creating a Toolbar for the Dimensions​

We'll make a Toolbar Component and set it at the bottom. -In addition, we will have a button that allows you to toggle the dimension tool.

const mainToolbar = new OBC.Toolbar(components, { name: 'Main Toolbar', position: 'bottom' });
mainToolbar.addChild(dimensions.uiElement.get("main"));
components.ui.addToolbar(mainToolbar);

🎛️ Check Toolbar and UIManager tutorial if you have any doubts!

🖌️ Adding Styles​

Few final things, we need to add styles for the labels which display the measurement information.

  • ifcjs-dimension-label - The label which is used to show the metric value after both the tooltips are attached.
  • ifcjs-dimension-label:hover - Changing the styling when someone hovers on the dimension label.
  • ifcjs-dimension-preview - The label which shows the measurement when the tooltip is not yet attached.
style
.ifcjs-dimension-label {
background-color: black;
font-family: sans-serif;
color: white;
padding: 8px;
border-radius: 8px;
pointer-events: all;
transition: background-color 200ms ease-in-out;
}
.ifcjs-dimension-label:hover {
background-color: grey;
}
.ifcjs-dimension-preview {
background-color: #ffffff;
width: 2rem;
height: 2rem;
opacity: 0.3;
padding: 8px;
border-radius: 100%;
}

Congratulations 🎉 on completing this tutorial! Now you can measure any BIM Model or any 3D Object easily using +dimensions.deleteAll()

window.onkeydown = (event) => {
if (event.code === 'Delete' || event.code === 'Backspace') {
// WORK IN PROGRESS
// dimensions.delete();
}
}

⏏️ Creating a Toolbar for the Dimensions​

We'll make a Toolbar Component and set it at the bottom. +In addition, we will have a button that allows you to toggle the dimension tool.

const mainToolbar = new OBC.Toolbar(components, { name: 'Main Toolbar', position: 'bottom' });
mainToolbar.addChild(dimensions.uiElement.get("main"));
components.ui.addToolbar(mainToolbar);

🎛️ Check Toolbar and UIManager tutorial if you have any doubts!

🖌️ Adding Styles​

Few final things, we need to add styles for the labels which display the measurement information.

  • ifcjs-dimension-label - The label which is used to show the metric value after both the tooltips are attached.
  • ifcjs-dimension-label:hover - Changing the styling when someone hovers on the dimension label.
  • ifcjs-dimension-preview - The label which shows the measurement when the tooltip is not yet attached.
style
.ifcjs-dimension-label {
background-color: black;
font-family: sans-serif;
color: white;
padding: 8px;
border-radius: 8px;
pointer-events: all;
transition: background-color 200ms ease-in-out;
}
.ifcjs-dimension-label:hover {
background-color: grey;
}
.ifcjs-dimension-preview {
background-color: #ffffff;
width: 2rem;
height: 2rem;
opacity: 0.3;
padding: 8px;
border-radius: 100%;
}

Congratulations 🎉 on completing this tutorial! Now you can measure any BIM Model or any 3D Object easily using Simple Dimension Component 📐 -Let's keep it up and check out another tutorial! 🎓

- - +Let's keep it up and check out another tutorial! 🎓

+ + \ No newline at end of file diff --git a/build/Tutorials/EdgesClipper/index.html b/build/Tutorials/EdgesClipper/index.html index 51216a33..cebbb474 100644 --- a/build/Tutorials/EdgesClipper/index.html +++ b/build/Tutorials/EdgesClipper/index.html @@ -3,33 +3,33 @@ -EdgesClipper | That Open Docs - - +EdgesClipper | That Open Docs + + -
-
Skip to main content

EdgesClipper

⭕️ Aesthetic Clipping Edges​

You can build whole BIM application using Components.💪 +

+

EdgesClipper

⭕️ Aesthetic Clipping Edges​

You can build whole BIM application using Components.💪 One such essential component is Edges Clipper which helps you to add Clipping Planes along with beautiful yet functional edges.🖍️

Advanced but Simple to use

⚡️ Simple Clipper and Edges Clipper are similar, but Edges Clipper offers more advanced options. If you want to learn more about Simple Clipper, visit the tutorial.

In this tutorial, we'll use the EdgesClipper to slice two distinct Cubes that each have a unique set of edge effects. -With the help of this tutorial, you can quickly add Clipping Planes and Configurable Edges to your project.🚀

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

🧩 Adding Objects to Scene​

Let's start by adding two Cubes, we will create a Box Geometry and use it for both Meshes.

const cubeGeometry = new THREE.BoxGeometry(3, 3, 3);
const cubeMaterial = new THREE.MeshStandardMaterial({ color: '#6528D7' });
const cube = new THREE.Mesh(cubeGeometry, cubeMaterial);
cube.position.set(-2, 1.5, 0);
scene.add(cube);
components.meshes.add(cube);
const cube2 = new THREE.Mesh(cubeGeometry, cubeMaterial);
cube2.position.set(2, 1.5, 0);
scene.add(cube2);
components.meshes.add(cube2);
Storing Components

🧰 After adding cubes to the scene, we must also add them to components.meshes, -which is just an array of all the meshes in the scene.🗄️

⚔️ Slicing Some Cubes​

Now that the setup is complete. Let's get started with the interesting part! +With the help of this tutorial, you can quickly add Clipping Planes and Configurable Edges to your project.🚀

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

🧩 Adding Objects to Scene​

Let's start by adding two Cubes, we will create a Box Geometry and use it for both Meshes.

const cubeGeometry = new THREE.BoxGeometry(3, 3, 3);
const cubeMaterial = new THREE.MeshStandardMaterial({ color: '#6528D7' });
const cube = new THREE.Mesh(cubeGeometry, cubeMaterial);
cube.position.set(-2, 1.5, 0);
scene.add(cube);
components.meshes.add(cube);
const cube2 = new THREE.Mesh(cubeGeometry, cubeMaterial);
cube2.position.set(2, 1.5, 0);
scene.add(cube2);
components.meshes.add(cube2);
Storing Components

🧰 After adding cubes to the scene, we must also add them to components.meshes, +which is just an array of all the meshes in the scene.🗄️

⚔️ Slicing Some Cubes​

Now that the setup is complete. Let's get started with the interesting part! We will create Edges Clipper and pass the components and -Edges Plane to the constructor.

const clipper = new OBC.EdgesClipper(components);
PLANE WITH EDGES and TRANSFORMATION CONTROLS

🟦 Edges Plane helps us in adding Clipping Planes to the Clipper Component.

clipper.enabled = true;

When we set clipper.enabled = true, we will make the clipper functional; otherwise, clipping planes won't be formed.

🖌️ Creating Fine Edges​

Let's now prepare the materials that will be visible on the cube edges. -We will use LineMaterial for creating edges.

💫 Using Line Material​

After creating the Line Material we will add it to the clipper -using clipper.styles.create(styleName: string, mesh: Mesh[], material: LineMaterial)

const blueFill = new THREE.MeshBasicMaterial({color: 'lightblue', side: 2});
const blueLine = new THREE.LineBasicMaterial({ color: 'blue' });
const blueOutline = new THREE.MeshBasicMaterial({color: 'blue', opacity: 0.2, side: 2, transparent: true});
clipper.styles.create('Red lines', new Set([cube]), blueLine, blueFill, blueOutline);
const salmonFill = new THREE.MeshBasicMaterial({color: 'salmon', side: 2});
const redLine = new THREE.LineBasicMaterial({ color: 'red' });
const redOutline = new THREE.MeshBasicMaterial({color: 'red', opacity: 0.2, side: 2, transparent: true});
clipper.styles.create('Blue lines', new Set([cube2]), redLine, salmonFill, redOutline);

🤝 Performing Clipping Events​

We need a method for instantly producing a clipping plane; +Edges Plane to the constructor.

const clipper = new OBC.EdgesClipper(components);
PLANE WITH EDGES and TRANSFORMATION CONTROLS

🟦 Edges Plane helps us in adding Clipping Planes to the Clipper Component.

clipper.enabled = true;

When we set clipper.enabled = true, we will make the clipper functional; otherwise, clipping planes won't be formed.

🖌️ Creating Fine Edges​

Let's now prepare the materials that will be visible on the cube edges. +We will use LineMaterial for creating edges.

💫 Using Line Material​

After creating the Line Material we will add it to the clipper +using clipper.styles.create(styleName: string, mesh: Mesh[], material: LineMaterial)

const blueFill = new THREE.MeshBasicMaterial({color: 'lightblue', side: 2});
const blueLine = new THREE.LineBasicMaterial({ color: 'blue' });
const blueOutline = new THREE.MeshBasicMaterial({color: 'blue', opacity: 0.2, side: 2, transparent: true});
clipper.styles.create('Red lines', new Set([cube]), blueLine, blueFill, blueOutline);
const salmonFill = new THREE.MeshBasicMaterial({color: 'salmon', side: 2});
const redLine = new THREE.LineBasicMaterial({ color: 'red' });
const redOutline = new THREE.MeshBasicMaterial({color: 'red', opacity: 0.2, side: 2, transparent: true});
clipper.styles.create('Blue lines', new Set([cube2]), redLine, salmonFill, redOutline);

🤝 Performing Clipping Events​

We need a method for instantly producing a clipping plane; this can be accomplished with either a single click or a double click of the mouse. For this tutorial, we will use Double Click, to create a Clipper that will generate a plane on the 3D object's face.

container.ondblclick = () => clipper.create();
Raycaster below the hood 🎩

We use the Simple Raycaster to determine if the intersection has occurred. The clipper places a plane after detecting the face on which the mouse was clicked. -Here, the EdgesClipper handles everything for you 😎

🧹 Deleting the Clipping Planes​

Now that we know how to make multiple clippers, we must also know how to delete them when necessary. +Here, the EdgesClipper handles everything for you 😎

🧹 Deleting the Clipping Planes​

Now that we know how to make multiple clippers, we must also know how to delete them when necessary. Clipping Edges can be removed using clipper.delete() or clipper.delete(plane), which deletes a single plane. clipper.delete() deletes the plane on which your mouse pointer is now located.

window.onkeydown = (event) => {
if (event.code === 'Delete' || event.code === 'Backspace') {
clipper.delete();
}
if (event.code === 'KeyP') {
console.log(clipper);
}
};
Delete all Clipping Planes

❎ If you want to safely delete all the clipping edges that were created you can simply call clipper.deleteAll()

Great job! 🎉 Using the Clipper Component, you can now effortlessly check BIM models or any other 3D objects with stunning edges.🧐 -Let's keep it up and check out another tutorial! 🎓

- - +Let's keep it up and check out another tutorial! 🎓

+ + \ No newline at end of file diff --git a/build/Tutorials/FragmentBoundingBox/index.html b/build/Tutorials/FragmentBoundingBox/index.html index e49d7487..a788d5ef 100644 --- a/build/Tutorials/FragmentBoundingBox/index.html +++ b/build/Tutorials/FragmentBoundingBox/index.html @@ -3,26 +3,26 @@ -FragmentBoundingBox | That Open Docs - - +FragmentBoundingBox | That Open Docs + + -
-
Skip to main content

FragmentBoundingBox

🧳 Gathering BIM Data​

Fragment help you to render your BIM files faster than ever.🚅 Fragment is a group of FragmentMeshes +

+

FragmentBoundingBox

🧳 Gathering BIM Data​

Fragment help you to render your BIM files faster than ever.🚅 Fragment is a group of FragmentMeshes which are clubbed together to visualize the BIM model. When working with large BIM models, you may need to quit the navigation to see the whole model.📌 -To accomplish this, we must extract Mesh data from the Fragment and use control APIs to display the complete Fragment.

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

For this tutorial, we'll use the FragmentBoundingBox component, which will provide us with the mesh by using the Fragment Model.

🧩 Adding Fragments​

We'll start by adding a Fragment to our scene using FragmentManager. -We'll use a simple fragment for the purposes of this tutorial, but the code is capable of handling big files as well.🏗️

const fragments = new OBC.FragmentManager(components);
const file = await fetch("../../../resources/small.frag");
const data = await file.arrayBuffer();
const buffer = new Uint8Array(data);
const model = await fragments.load(buffer);

🎲 Creation of Bounding Boxes​

Now that our setup is done, lets see how you can use FragmentBoundingBox(). +To accomplish this, we must extract Mesh data from the Fragment and use control APIs to display the complete Fragment.

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

For this tutorial, we'll use the FragmentBoundingBox component, which will provide us with the mesh by using the Fragment Model.

🧩 Adding Fragments​

We'll start by adding a Fragment to our scene using FragmentManager. +We'll use a simple fragment for the purposes of this tutorial, but the code is capable of handling big files as well.🏗️

const fragments = new OBC.FragmentManager(components);
const file = await fetch("../../../resources/small.frag");
const data = await file.arrayBuffer();
const buffer = new Uint8Array(data);
const model = await fragments.load(buffer);

🎲 Creation of Bounding Boxes​

Now that our setup is done, lets see how you can use FragmentBoundingBox(). You will be amazed to see how easy it is to create bounding box using components.💪 -We will use OBC.FragmentBoundingBox() and add the Fragment model to it using add(model).

const fragmentBbox = new OBC.FragmentBoundingBox(components);
fragmentBbox.add(model);

👓 Reading the Mesh Data​

After adding the model, we can now read the mesh from bounding box using getMesh()

const bbox = fragmentBbox.getMesh();
fragmentBbox.reset();

⏏️ Creating a Toolbar for Navigating the Model​

We'll make a Toolbar Component and set it at the bottom. -In addition, we will add a zoom in button to this toolbar that will be used to zoom in at the BIM Model.

const toolbar = new OBC.Toolbar(components, {position: "bottom"});
components.ui.addToolbar(toolbar);
const button = new OBC.Button(components);
button.materialIcon = "zoom_in_map";
button.tooltip = "Zoom to building";
toolbar.addChild(button);
Simplistic and Powerful Toolbar!

🎛️ We have a dedicated tutorial on how to implement Toolbar, check Toolbar and UIManager tutorial if you have any doubts!

🎮 Managing Zoom Events​

Now that all the setup is done, we need to trigger the zoom event on a button click.🖱 +We will use OBC.FragmentBoundingBox() and add the Fragment model to it using add(model).

const fragmentBbox = new OBC.FragmentBoundingBox(components);
fragmentBbox.add(model);

👓 Reading the Mesh Data​

After adding the model, we can now read the mesh from bounding box using getMesh()

const bbox = fragmentBbox.getMesh();
fragmentBbox.reset();

⏏️ Creating a Toolbar for Navigating the Model​

We'll make a Toolbar Component and set it at the bottom. +In addition, we will add a zoom in button to this toolbar that will be used to zoom in at the BIM Model.

const toolbar = new OBC.Toolbar(components, {position: "bottom"});
components.ui.addToolbar(toolbar);
const button = new OBC.Button(components);
button.materialIcon = "zoom_in_map";
button.tooltip = "Zoom to building";
toolbar.addChild(button);
Simplistic and Powerful Toolbar!

🎛️ We have a dedicated tutorial on how to implement Toolbar, check Toolbar and UIManager tutorial if you have any doubts!

🎮 Managing Zoom Events​

Now that all the setup is done, we need to trigger the zoom event on a button click.🖱 We will use fitToSphere from camera.controls, which takes the mesh as a parameter and zooms to it. Also, we will enable a nice transition effect while zooming to the mesh by setting the last parameter as true

const controls = components.camera.controls;
button.onClick.add(() => {
controls.fitToSphere(bbox, true);
})

Congratulations 🎉 on completing this short yet useful tutorial! You can now easily zoom to Fragment Mesh using FragmentBoundingBox😎 -Let's keep it up and check out another tutorial! 🎓

- - +Let's keep it up and check out another tutorial! 🎓

+ + \ No newline at end of file diff --git a/build/Tutorials/FragmentClipStyler/index.html b/build/Tutorials/FragmentClipStyler/index.html index 343aaf4d..876de46f 100644 --- a/build/Tutorials/FragmentClipStyler/index.html +++ b/build/Tutorials/FragmentClipStyler/index.html @@ -3,13 +3,13 @@ -FragmentClipStyler | That Open Docs - - +FragmentClipStyler | That Open Docs + + -
-
Skip to main content

FragmentClipStyler

💄 Styling those fills and edges​

You might have noticed that the EdgesClipper has support for fills +

+

FragmentClipStyler

💄 Styling those fills and edges​

You might have noticed that the EdgesClipper has support for fills and edges of various colors and thicknesses. That's great, but how can we set it up for our BIM app? Luckily, the FragmentClipStyler comes to the rescue!

Your app, your look

We are used to seeing BIM software that looks exactly the same. Use @@ -18,11 +18,11 @@ you haven't checked out that tutorial yet, you should before going forward!

postproduction.customEffects.outlineEnabled = true;

Next, we will intialize the EdgesClipper, the FragmentClassifier and the FragmentClipStyler.

const clipper = new OBC.EdgesClipper(components);
clipper.enabled = true;
const classifier = new OBC.FragmentClassifier(components);
const styler = new OBC.FragmentClipStyler(components);
await styler.setup();

Great! Now, adding it to the scene is as easy as creating a -Toolbar and adding the built-in Button included in the styler:

const toolbar = new OBC.Toolbar(components);
toolbar.name = "Main toolbar";
components.ui.addToolbar(toolbar);
const stylerButton = styler.uiElement.get("mainButton");
toolbar.addChild(stylerButton);

Fantastic! Now your styler is ready to be used.

🏠 Loading a model​

Of course, we won't be able to see anything until we load a model. +Toolbar and adding the built-in Button included in the styler:

const toolbar = new OBC.Toolbar(components);
toolbar.name = "Main toolbar";
components.ui.addToolbar(toolbar);
const stylerButton = styler.uiElement.get("mainButton");
toolbar.addChild(stylerButton);

Fantastic! Now your styler is ready to be used.

🏠 Loading a model​

Of course, we won't be able to see anything until we load a model. We will load a simple fragment that you can find in the resources folder of the Components repository. Alternatively, you can use the FragmentIfcLoader to load an IFC file directly.

const file = await fetch('../../../resources/small.frag');
const data = await file.arrayBuffer();
const buffer = new Uint8Array(data);
const model = await fragments.load(buffer);
const properties = await fetch('../../../resources/small.json');
model.setLocalProperties(await properties.json());

Great, now we have something in our scene. Now, let's see the -styler in action.

🔥 Spinning up the styler​

To use the styler, we need to classify the model by entity using +styler in action.

🔥 Spinning up the styler​

To use the styler, we need to classify the model by entity using the FragmentClassifier. That will index all the geometry by IFC category for the styler. Then, we can simply call the update method to make it affect the model we just loaded:

classifier.byEntity(model);
await styler.update();

And one last thing: we need a way to create clipping planes! In @@ -31,8 +31,8 @@ will be created:

window.ondblclick = () => {
clipper.create();
}

And voilà! Now you can create a clipping plane, open the styler menu and see the section fill and edges update in real time. You can create styles and apply them per category. See you in another -tutorial. 🚀

- - +tutorial. 🚀

+ + \ No newline at end of file diff --git a/build/Tutorials/FragmentExploder/index.html b/build/Tutorials/FragmentExploder/index.html index 18e09b43..184ae291 100644 --- a/build/Tutorials/FragmentExploder/index.html +++ b/build/Tutorials/FragmentExploder/index.html @@ -3,24 +3,24 @@ -FragmentExploder | That Open Docs - - +FragmentExploder | That Open Docs + + -
-
Skip to main content

FragmentExploder

💣 Breaking down Model Dynamically​

You may have previously used the Simple Clipper component to dismantle a 3D models. +

+

FragmentExploder

💣 Breaking down Model Dynamically​

You may have previously used the Simple Clipper component to dismantle a 3D models. Although Simple Clipper is fantastic for dissecting, there may be instances when you need to inspect the model while keeping it intact.🔧 -At such times, Fragment Exploder is useful for giving you an exploded view of all the Elements inside the BIM Model.

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

This tutorial will show you how to use Fragment Exploder for exploring BIM Models in detail.👓

🧩 Adding Fragments​

We'll start by adding a Fragment to our scene using FragmentManager. -We'll use a simple fragment for the purposes of this tutorial, but the code is capable of handling big files as well.🏗️

const fragments = new OBC.FragmentManager(components);
const file = await fetch("../../../resources/small.frag");
const data = await file.arrayBuffer();
const buffer = new Uint8Array(data);
const model = await fragments.load(buffer);
Showing Fragments in the Scene

🏔️ There is a dedicated tutorial on how to use Fragment Manager to load IFC files, checkout that tutorial here!

🗂️ Strategically Classifying Fragments​

In this tutorial, we will deconstruct the model into floors. But before we explode them, we need to classify them by floor. -For breaking down the model in the required way, we'll utilize FragmentClassifier.

const classifier = new OBC.FragmentClassifier(components);

Getting Properties​

Fragment Classifier requires model properties that will help the classifier in identifying the floors included inside the Fragment.🧮 -We will fetch the properties from json file and store it in model.properties.

const properties = await fetch("../../../resources/small.json");
model.setLocalProperties(await properties.json());

Now that we have the properties, we will pass the model to classifier and use classifier.byStorey() which will group the Fragments according to Floors.

classifier.byStorey(model);

💥 Exploding the Fragment​

Now that we've completed the setup, we'll use the FragmentExploder and send the fragment and classifier data to it. -Our Fragment Exploder is now complete, and we can simply explode the model by calling exploder.explode().💪

const exploder = new OBC.FragmentExploder(components);

🌡️ Screen Culling for Better Performance​

We will also add Screen Culler which will enhance the performance of our +At such times, Fragment Exploder is useful for giving you an exploded view of all the Elements inside the BIM Model.

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

This tutorial will show you how to use Fragment Exploder for exploring BIM Models in detail.👓

🧩 Adding Fragments​

We'll start by adding a Fragment to our scene using FragmentManager. +We'll use a simple fragment for the purposes of this tutorial, but the code is capable of handling big files as well.🏗️

const fragments = new OBC.FragmentManager(components);
const file = await fetch("../../../resources/small.frag");
const data = await file.arrayBuffer();
const buffer = new Uint8Array(data);
const model = await fragments.load(buffer);
Showing Fragments in the Scene

🏔️ There is a dedicated tutorial on how to use Fragment Manager to load IFC files, checkout that tutorial here!

🗂️ Strategically Classifying Fragments​

In this tutorial, we will deconstruct the model into floors. But before we explode them, we need to classify them by floor. +For breaking down the model in the required way, we'll utilize FragmentClassifier.

const classifier = new OBC.FragmentClassifier(components);

Getting Properties​

Fragment Classifier requires model properties that will help the classifier in identifying the floors included inside the Fragment.🧮 +We will fetch the properties from json file and store it in model.properties.

const properties = await fetch("../../../resources/small.json");
model.setLocalProperties(await properties.json());

Now that we have the properties, we will pass the model to classifier and use classifier.byStorey() which will group the Fragments according to Floors.

classifier.byStorey(model);

💥 Exploding the Fragment​

Now that we've completed the setup, we'll use the FragmentExploder and send the fragment and classifier data to it. +Our Fragment Exploder is now complete, and we can simply explode the model by calling exploder.explode().💪

const exploder = new OBC.FragmentExploder(components);

🌡️ Screen Culling for Better Performance​

We will also add Screen Culler which will enhance the performance of our BIM App by removing Fragment elements that are not in our viewing area.

const culler = new OBC.ScreenCuller(components);
culler.setup();
container.addEventListener("mouseup", () => culler.elements.needsUpdate = true);
container.addEventListener("wheel", () => culler.elements.needsUpdate = true);
for(const fragment of model.items) {
culler.elements.add(fragment.mesh);
}
culler.elements.needsUpdate = true;
Culling unnecessary Fragments

🚅 If you're wondering how to add Screen Culler to your BIM app, we have a dedicated tutorial for it! Checkout that tutorial here!

Congratulations 🎉 on completing this tutorial! Your BIM App now has the power to deconstruct a model on a single click using Fragment Exploder😎 -Let's keep it up and check out another tutorial! 🎓

- - +Let's keep it up and check out another tutorial! 🎓

+ + \ No newline at end of file diff --git a/build/Tutorials/FragmentHider/index.html b/build/Tutorials/FragmentHider/index.html index 76e14a30..6bf805d4 100644 --- a/build/Tutorials/FragmentHider/index.html +++ b/build/Tutorials/FragmentHider/index.html @@ -3,13 +3,13 @@ -FragmentHider | That Open Docs - - +FragmentHider | That Open Docs + + -
-
Skip to main content

FragmentHider

🔎 Custom filters for your BIM models​

BIM models are complex, and finding what we are looking for is not +

+

FragmentHider

🔎 Custom filters for your BIM models​

BIM models are complex, and finding what we are looking for is not always easy. Luckily, the components library has tools to make it easier, and one of them is the 'FragmentHider'. Let's check it out!

Complex IFC, complex filters

Each IFC is a world. Data is always defined slightly differently, @@ -20,7 +20,7 @@ for that component yet, do it before going forward!

const fragments = new OBC.FragmentManager(components);
const file = await fetch("../../../resources/small.frag");
const dataBlob = await file.arrayBuffer();
const buffer = new Uint8Array(dataBlob);
const model = await fragments.load(buffer);
const properties = await fetch("../../../resources/small.json");
model.setLocalProperties(await properties.json());

Now that we have our model, let's start the FragmentHider. You can use the loadCached method if you had used it before: it will automatically load all the filters you created in previous sessions, -even after closing the browser and opening it again:

const hider = new OBC.FragmentHider(components);
await hider.loadCached();

📕📗📘 Setting up simple filters​

Next, we will classify data by category and by level using the +even after closing the browser and opening it again:

const hider = new OBC.FragmentHider(components);
await hider.loadCached();

📕📗📘 Setting up simple filters​

Next, we will classify data by category and by level using the FragmentClassifier. This will allow us to create a simple filter for both classifications. Don't worry: we'll get to the more complex filters later!

const classifier = new OBC.FragmentClassifier(components);
classifier.byStorey(model);
classifier.byEntity(model);
const classifications = classifier.get();

Next, we will create a simple object that we will use as the @@ -29,14 +29,14 @@ value:

const storeys = {};
const storeyNames = Object.keys(classifications.storeys);
for (const name of storeyNames) {
storeys[name] = true;
}

Now, let's do the same for categories:

const classes = {};
const classNames = Object.keys(classifications.entities);
for (const name of classNames) {
classes[name] = true;
}

Finally, we will set up a simple menu in dat.gui to control the visibility of storeys:

const gui = new dat.GUI();
const storeysGui = gui.addFolder("Storeys");
for (const name in storeys) {
storeysGui.add(storeys, name).onChange(async (visible) => {
const found = await classifier.find({storeys: [name]});
hider.set(visible, found);
});
}

Again, for categories it's very similar:

const entitiesGui = gui.addFolder("Classes");
for (const name in classes) {
entitiesGui.add(classes, name).onChange(async (visible) => {
const found = await classifier.find({entities: [name]});
hider.set(visible, found);
});
}

Congratulations! Now you know how to create filters for categories and levels. Easy, right? Well, believe it or not, creating -complex filters is even easier.

📚📚 Complex filter queries​

To create complex filters you can just use the built-in Button +complex filters is even easier.

📚📚 Complex filter queries​

To create complex filters you can just use the built-in Button that comes with the hider. Let's create a Toolbar and add it to it.

const toolbar = new OBC.Toolbar(components);
components.ui.addToolbar(toolbar);
const hiderButton = hider.uiElement.get("main");
toolbar.addChild(hiderButton);

That's it! That button will open a floating menu that will allow you to create custom multi-filters that work even for custom property sets and quantity sets, including logical operators. Try them out in the example below, and check out more tutorials -to bring your BIM apps to the next level!

- - +to bring your BIM apps to the next level!

+ + \ No newline at end of file diff --git a/build/Tutorials/FragmentHighlighter/index.html b/build/Tutorials/FragmentHighlighter/index.html index b47a5bd4..920032bc 100644 --- a/build/Tutorials/FragmentHighlighter/index.html +++ b/build/Tutorials/FragmentHighlighter/index.html @@ -3,31 +3,31 @@ -FragmentHighlighter | That Open Docs - - +FragmentHighlighter | That Open Docs + + -
-
Skip to main content

FragmentHighlighter

🤏 Nudging Fragments​

Until now, you could add IFC files to your BIM App and render Fragments in your scene. +

+

FragmentHighlighter

🤏 Nudging Fragments​

Until now, you could add IFC files to your BIM App and render Fragments in your scene. In this lesson, we will show you how to select Fragment elements. -This may appear to be an immense task but believe us when we say it will take less than 5 minutes to complete.🚀

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

Managing Fragments​

To deal with Fragments we will use FragmentManager, it will help us to render Fragments easily.💪

const fragments = new OBC.FragmentManager(components);
🏔️ Showing Fragments in the Scene

Fragment Manager has its own tutorial, check out that tutorial here!

📌 Selecting Fragments​

We will start by using Fragment Highlighter, +This may appear to be an immense task but believe us when we say it will take less than 5 minutes to complete.🚀

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

Managing Fragments​

To deal with Fragments we will use FragmentManager, it will help us to render Fragments easily.💪

const fragments = new OBC.FragmentManager(components);
🏔️ Showing Fragments in the Scene

Fragment Manager has its own tutorial, check out that tutorial here!

📌 Selecting Fragments​

We will start by using Fragment Highlighter, which needs reference of component and fragments to be provided to it.🧮 -Doing so, we will get an instance of Fragment Highlighter which will be used for our selection mechanism.

const highlighter = new OBC.FragmentHighlighter(components, fragments);
const file = await fetch("../../../resources/small.frag");
const dataBlob = await file.arrayBuffer();
const buffer = new Uint8Array(dataBlob);
fragments.load(buffer);
highlighter.updateHighlight();
components.renderer.postproduction.customEffects.outlineEnabled = true;
highlighter.outlinesEnabled = true;

🎨 Changing Highlight Appearance​

The beauty of components is it understands three.js, +Doing so, we will get an instance of Fragment Highlighter which will be used for our selection mechanism.

const highlighter = new OBC.FragmentHighlighter(components, fragments);
const file = await fetch("../../../resources/small.frag");
const dataBlob = await file.arrayBuffer();
const buffer = new Uint8Array(dataBlob);
fragments.load(buffer);
highlighter.updateHighlight();
components.renderer.postproduction.customEffects.outlineEnabled = true;
highlighter.outlinesEnabled = true;

🎨 Changing Highlight Appearance​

The beauty of components is it understands three.js, this will help us to instantly change the Highlight color for the Fragments selection. We will use red color and create a MeshBasicMaterial, which we will pass to the highlighter component using highlighter.add(). -To remember the highlighter material created, we will pass first variable as the Highlighter Name.😎

const highlightMaterial = new THREE.MeshBasicMaterial({
color: '#BCF124',
depthTest: false,
opacity: 0.8,
transparent: true
});
highlighter.add('default', highlightMaterial);
highlighter.outlineMaterial.color.set(0xf0ff7a);

🛎️ Getting Selection Events​

Now that we have our base setup ready, we will now implement the logic needed for selection of Fragment. +To remember the highlighter material created, we will pass first variable as the Highlighter Name.😎

const highlightMaterial = new THREE.MeshBasicMaterial({
color: '#BCF124',
depthTest: false,
opacity: 0.8,
transparent: true
});
highlighter.add('default', highlightMaterial);
highlighter.outlineMaterial.color.set(0xf0ff7a);

🛎️ Getting Selection Events​

Now that we have our base setup ready, we will now implement the logic needed for selection of Fragment. Let's start by declaring a variable - lastSelection which will hold the fragment.id of the Fragment that was selected. -Also, we define a variable which will convey Highlighter to only perform single selection and not multiple selection.🎯

let lastSelection;
let singleSelection = {
value: true,
};

Performing Highlighting On Click​

Now comes the exciting part: we will add an event listener to the container that will detect click events.🖱️ +Also, we define a variable which will convey Highlighter to only perform single selection and not multiple selection.🎯

let lastSelection;
let singleSelection = {
value: true,
};

Performing Highlighting On Click​

Now comes the exciting part: we will add an event listener to the container that will detect click events.🖱️ When a click is detected, the function highlightOnClick() is called, which checks internally to see if the Fragment was present and returns the ID of the Fragment that was clicked on.📭 To highlight the selection based upon the material you had created, you must pass the Highlighter Name.

async function highlightOnClick(event) {
const result = await highlighter.highlight('default', singleSelection.value);
if (result) {
lastSelection = {};
for (const fragment of result.fragments) {
const fragmentID = fragment.id;
lastSelection[fragmentID] = [result.id];
}
}
}
container.addEventListener('click', (event) => highlightOnClick(event));

What if you need to highlight the item using Fragment ID? The same instance of Highlighter can be used to choose elements based on Fragment ID.🧩 You can use highlighter.highlightByID() and provide an array of Fragment IDs to have the work done for you!

function highlightOnID() {
if (lastSelection !== undefined) {
highlighter.highlightByID('default', lastSelection);
}
}

Congratulations 🎉 on completing this tutorial! Now you can Highlight and perform Selection on any Fragment Model using Fragment Highlighter Component 🎨🖌️ -Let's keep it up and check out another tutorial! 🎓

- - +Let's keep it up and check out another tutorial! 🎓

+ + \ No newline at end of file diff --git a/build/Tutorials/FragmentIfcLoader/index.html b/build/Tutorials/FragmentIfcLoader/index.html index 791369cd..4c95ad4c 100644 --- a/build/Tutorials/FragmentIfcLoader/index.html +++ b/build/Tutorials/FragmentIfcLoader/index.html @@ -3,13 +3,13 @@ -FragmentIfcLoader | That Open Docs - - +FragmentIfcLoader | That Open Docs + + -
-
Skip to main content

FragmentIfcLoader

🏠👉🤖 From IFC to fragment in 1 minute​

Fragments are great: they are lightweight, they are fast and we +

+

FragmentIfcLoader

🏠👉🤖 From IFC to fragment in 1 minute​

Fragments are great: they are lightweight, they are fast and we have tons of tools to work with them. But fragments are not used outside our libraries. So how can we convert an IFC file to fragments? Easy: with the FragmentIfcLoader! Let's start by creating it.

let fragments = new OBC.FragmentManager(components);
let fragmentIfcLoader = new OBC.FragmentIfcLoader(components);
Why not just IFC?

IFC is nice because it lets us exchange data with many tools in the @@ -22,35 +22,35 @@ load 10 times faster!

Now, we will start using the built-in Button the ifc loader has. To do that, we will create a Toolbar and add it to our app. This button will give you all the features you need to load IFC files! -Don't worry, we'll also do this programmatically in a moment.

const mainToolbar = new OBC.Toolbar(components, {name: 'Main Toolbar', position: 'bottom'});
components.ui.addToolbar(mainToolbar);
const ifcButton = fragmentIfcLoader.uiElement.get("main");
mainToolbar.addChild(ifcButton);

🔭🔧 Calibrating the converter​

Now, we need to configure the path of the WASM files. What's WASM? +Don't worry, we'll also do this programmatically in a moment.

const mainToolbar = new OBC.Toolbar(components, {name: 'Main Toolbar', position: 'bottom'});
components.ui.addToolbar(mainToolbar);
const ifcButton = fragmentIfcLoader.uiElement.get("main");
mainToolbar.addChild(ifcButton);

🔭🔧 Calibrating the converter​

Now, we need to configure the path of the WASM files. What's WASM? It's a technology that lets us run C++ on the browser, which means that we can load IFCs super fast! These files are the compilation of our web-ifc library. You can find them in the github repo and in NPM. These files need to be available to our app, so you have 2 options:

  • Download them and serve them statically.
  • Get them from a remote server. The easiest way is getting them from unpkg, and the cool thing is that you don't need to do it manually! It can be done directly by the tool -just by writing the following:
await fragmentIfcLoader.setup()
/* If you want to the path to unpkg manually, then you can skip the line 
above and set them manually as below:
fragmentIfcLoader.settings.wasm = {
path: "https://unpkg.com/web-ifc@0.0.50/",
absolute: true
} */

Awesome! Optionally, we can exclude categories that we don't want +just by writing the following:

await fragmentIfcLoader.setup()
/* If you want to the path to unpkg manually, then you can skip the line
above and set them manually as below:
fragmentIfcLoader.settings.wasm = {
path: "https://unpkg.com/web-ifc@0.0.53/",
absolute: true
} */

Awesome! Optionally, we can exclude categories that we don't want to convert to fragments like very easily:

const excludedCats = [
WEBIFC.IFCTENDONANCHOR,
WEBIFC.IFCREINFORCINGBAR,
WEBIFC.IFCREINFORCINGELEMENT,
];
for (const cat of excludedCats) {
fragmentIfcLoader.settings.excludedCategories.add(cat);
}

We can further configure the conversion using the webIfc object. In this example, we will make the IFC model go to the origin of the scene (don't worry, this supports model federation) and optimize the profiles geometry so that it generates very -efficient geometry for certain geometries (e.g. HVAC):

fragmentIfcLoader.settings.webIfc.COORDINATE_TO_ORIGIN = true;
fragmentIfcLoader.settings.webIfc.OPTIMIZE_PROFILES = true;

🚗🔥 Loading the IFC​

Next, let's define a function to load the IFC programmatically. +efficient geometry for certain geometries (e.g. HVAC):

fragmentIfcLoader.settings.webIfc.COORDINATE_TO_ORIGIN = true;
fragmentIfcLoader.settings.webIfc.OPTIMIZE_PROFILES = true;

🚗🔥 Loading the IFC​

Next, let's define a function to load the IFC programmatically. We have hardcoded the path to one of our IFC files, but feel free to do this with any of your own files!

Opening local IFCs

Keep in mind that the browser can't access the file of your computer directly, so you will need to use the Open File API to -open local files.

async function loadIfcAsFragments() {
const file = await fetch('../../../resources/small.ifc');
const data = await file.arrayBuffer();
const buffer = new Uint8Array(data);
const model = await fragmentIfcLoader.load(buffer, "example");
scene.add(model);
}

🎁 Exporting the result​

Once you have your precious fragments, you might want to save them +open local files.

async function loadIfcAsFragments() {
const file = await fetch('../../../resources/small.ifc');
const data = await file.arrayBuffer();
const buffer = new Uint8Array(data);
const model = await fragmentIfcLoader.load(buffer, "example");
scene.add(model);
}

🎁 Exporting the result​

Once you have your precious fragments, you might want to save them so that you don't need to open this IFC file each time your user gets into your app. Instead, the next time you can load the fragments directly. Defining a function to export fragments -is as easy as this:

async function exportFragments() {
if (!fragments.groups.length) return;
const group = fragments.groups[0];
const data = fragments.export(group);
const blob = new Blob([data]);
const fragmentFile = new File([blob], 'small.frag');
const files = [];
files.push(fragmentFile);
const properties = group.getLocalProperties();
if (properties) {
files.push(new File([JSON.stringify(properties)], 'small.json'));
}
const result = await downloadZip(files).blob();
result.name = 'example';
download(result);
}

Now, this is how the download function looks like:

function download(file) {
const link = document.createElement('a');
link.href = URL.createObjectURL(file);
link.download = file.name;
document.body.appendChild(link);
link.click();
link.remove();
}

🧠🧼 Cleaning memory​

Now, just like in the FragmentManager tutorial, you will need +is as easy as this:

async function exportFragments() {
if (!fragments.groups.length) return;
const group = fragments.groups[0];
const data = fragments.export(group);
const blob = new Blob([data]);
const fragmentFile = new File([blob], 'small.frag');
const files = [];
files.push(fragmentFile);
const properties = group.getLocalProperties();
if (properties) {
files.push(new File([JSON.stringify(properties)], 'small.json'));
}
const result = await downloadZip(files).blob();
result.name = 'example';
download(result);
}

Now, this is how the download function looks like:

function download(file) {
const link = document.createElement('a');
link.href = URL.createObjectURL(file);
link.download = file.name;
document.body.appendChild(link);
link.click();
link.remove();
}

🧠🧼 Cleaning memory​

Now, just like in the FragmentManager tutorial, you will need to dispose the memory if your user wants to reset the state of the scene, especially if you are using Single Page Application technologies like React, Angular, Vue, etc. To do that, you can simply call the dispose method:

function disposeFragments() {
fragments.dispose();
}

That's it! Congrats, now you can load IFC files into your app, generate the 3D geometry and property data for them and navigate them in 3D. In other tutorials, you'll find tons of tools to -work with them and create amazing BIM apps! See you there 💪

- - +work with them and create amazing BIM apps! See you there 💪

+ + \ No newline at end of file diff --git a/build/Tutorials/FragmentIfcStreamer/index.html b/build/Tutorials/FragmentIfcStreamer/index.html index 93ff9977..ca188738 100644 --- a/build/Tutorials/FragmentIfcStreamer/index.html +++ b/build/Tutorials/FragmentIfcStreamer/index.html @@ -3,36 +3,36 @@ -FragmentIfcStreamer | That Open Docs - - +FragmentIfcStreamer | That Open Docs + + -
-
Skip to main content

FragmentIfcStreamer

💪 Let's go BIG​

Do you need to open huge big IFC files fast, even on more modest devices? +

+

FragmentIfcStreamer

💪 Let's go BIG​

Do you need to open huge big IFC files fast, even on more modest devices? If so, you are in luck! We can open virtually any model on any device in seconds thanks to BIM TILES!

BIM tiles?

The idea behind BIM tiles is pretty simple! Instead of loading the whole BIM model at once, we just load the explicit geometries that are seen by the user. It's way faster than opening the IFC directly, but for this you'll need a backend (or to rely on the file system of the user if you are building a -desktop or mobile app).

Let's see how to do this step by step!

🧩 Converting the IFC model to tiles​

The first step is to transform the IFC model into BIM tiles. The reason why we +desktop or mobile app).

Let's see how to do this step by step!

🧩 Converting the IFC model to tiles​

The first step is to transform the IFC model into BIM tiles. The reason why we have to do this is pretty simple: geometry in IFC is implicit (e.g. a wall is defined as an extrusion). This means that it needs to be computed and converted to explicit geometry (triangles) so that it can be displayed in 3D. Let's start -converting the IFC geometry:

const streamer = new OBC.FragmentIfcStreamConverter(components);
streamer.settings.wasm = {
path: "https://unpkg.com/web-ifc@0.0.51/",
absolute: true
}

The FragmentIfcStreamConverter class takes IFC files and transform them into +converting the IFC geometry:

const streamer = new OBC.FragmentIfcStreamConverter(components);
streamer.settings.wasm = {
path: "https://unpkg.com/web-ifc@0.0.53/",
absolute: true
}

The FragmentIfcStreamConverter class takes IFC files and transform them into tiles. You can use events to get the data. The onGeometryStreamed event will give you the geometries bundled in a binary file, as well as an object with information about the geometries contained within this file.

streamer.onGeometryStreamed.add((geometry) => {
console.log(geometry);
});

You can control the amount of geometries inside a file using the settings. The way the streaming works can't guarantee a precise number of geometries within a file, but in most cases it will be quite close to the given number.

streamer.settings.minGeometrySize = 20;

Similarly, you can get the assets data and control the number of assets per chunk like this:

streamer.onAssetStreamed.add((assets) => {
console.log(assets);
});
streamer.settings.minAssetsSize = 1000;

Just like when using the normal FragmentIfcLoader, when you stream an IFC file you are -creating a FragmentsGroup. Using this event, you can get it:

streamer.onIfcLoaded.add(async (groupBuffer) => {
console.log(groupBuffer);
})

Finally, you can use this to get notified as the streaming process progresses:

streamer.onProgress.add((progress) => {
console.log(progress);
})

With everything in place, it's time to stream the IFC file and get all the tiles!

const fetchedIfc = await fetch("../../../resources/small.ifc");
const ifcBuffer = await fetchedIfc.arrayBuffer();
streamer.streamFromBuffer(new Uint8Array(ifcBuffer));

📋 Streaming the properties​

You can also stream the properties of an IFC file. Why? Because some files can have +creating a FragmentsGroup. Using this event, you can get it:

streamer.onIfcLoaded.add(async (groupBuffer) => {
console.log(groupBuffer);
})

Finally, you can use this to get notified as the streaming process progresses:

streamer.onProgress.add((progress) => {
console.log(progress);
})

With everything in place, it's time to stream the IFC file and get all the tiles!

const fetchedIfc = await fetch("../../../resources/small.ifc");
const ifcBuffer = await fetchedIfc.arrayBuffer();
streamer.streamFromBuffer(new Uint8Array(ifcBuffer));

📋 Streaming the properties​

You can also stream the properties of an IFC file. Why? Because some files can have millions of properties, and trying to save them naively in a normal DB is not very scalable/affordable. Using this system, you'll be able to store and retrieve the data of models of any size without big cloud costs. We can do this conversion -using the FragmentPropsStreamConverter:

const propsStreamer = new OBC.FragmentPropsStreamConverter(components);
propsStreamer.settings.wasm = {
path: "https://unpkg.com/web-ifc@0.0.51/",
absolute: true
}

Similarly to geometries, here you will also get data and progress notification +using the FragmentPropsStreamConverter:

const propsStreamer = new OBC.FragmentPropsStreamConverter(components);
propsStreamer.settings.wasm = {
path: "https://unpkg.com/web-ifc@0.0.53/",
absolute: true
}

Similarly to geometries, here you will also get data and progress notification using events. In addition to properties, you will get indices, which is an indexation data of the properties to be able to use them effectively when -streamed.

propsStreamer.onPropertiesStreamed.add(async (props) => {
console.log(props);
})
propsStreamer.onProgress.add(async (progress) => {
console.log(progress);
})
propsStreamer.onIndicesStreamed.add(async (props) => {
console.log(props);
})

Just call the streamFromBuffer method and you are ready to go!

propsStreamer.streamFromBuffer(new Uint8Array(ifcBuffer));

🧱 Assembling the data​

Now you are ready to start streaming your data. The first step is to create 2 JSON +streamed.

propsStreamer.onPropertiesStreamed.add(async (props) => {
console.log(props);
})
propsStreamer.onProgress.add(async (progress) => {
console.log(progress);
})
propsStreamer.onIndicesStreamed.add(async (props) => {
console.log(props);
})

Just call the streamFromBuffer method and you are ready to go!

propsStreamer.streamFromBuffer(new Uint8Array(ifcBuffer));

🧱 Assembling the data​

Now you are ready to start streaming your data. The first step is to create 2 JSON files so that the library can access your backend: one for the geometries and other for the properties. You have examples of both JSONs here and here. @@ -45,9 +45,9 @@ etc. In other words: types: {1837: [1, 2], ...}, ids: {8: 1, ...} means that all the items of type 1837 are in the files small.ifc-properties-1 and small.ifc-properties-2, and that the properties of the item with id 8 is in the -file small.ifc-properties-1.

interface StreamedProperties {
types: {
[typeID: number]: number[]
};
ids: {
[id: number]: {
boundingBox: {[id: number]: number};
hasHoles: boolean;
geometryFile: "url-to-geometry-file-in-your-backend";
};
};
indexesFile: "url-to-indexes-file-in-your-backend";
}

Once you get both files, you are ready to start streaming!

🧱 Streaming the data​

Now, streaming the data is quite easy once you have the JSON files. +file small.ifc-properties-1.

interface StreamedProperties {
types: {
[typeID: number]: number[]
};
ids: {
[id: number]: {
boundingBox: {[id: number]: number};
hasHoles: boolean;
geometryFile: "url-to-geometry-file-in-your-backend";
};
};
indexesFile: "url-to-indexes-file-in-your-backend";
}

Once you get both files, you are ready to start streaming!

🧱 Streaming the data​

Now, streaming the data is quite easy once you have the JSON files. You can just instantiate the loader, give it the base URL to your -backend and just load the models like this:

let loader = new OBC.FragmentStreamLoader(components);
loader.url = "http://YOUR_BACKEND_URL";
let fragments = new OBC.FragmentManager(components);
async function loadModel(geometryURL, propertiesURL) {
const rawGeometryData = await fetch(geometryURL);
const geometryData = await rawGeometryData.json();
let propertiesData;
if (propertiesURL) {
const rawPropertiesData = await fetch(propertiesURL);
propertiesData = await rawPropertiesData.json();
}
await loader.load(geometryData, true, propertiesData);
}
await loadModel(
"../../../resources/small.ifc-processed.json",
"../../../resources/small.ifc-processed-properties.json"
);

Now, streaming works by updating the scene depending on the user's perspective +backend and just load the models like this:

let loader = new OBC.FragmentStreamLoader(components);
loader.url = "http://YOUR_BACKEND_URL";
let fragments = components.tools.get(OBC.FragmentManager);
async function loadModel(geometryURL, propertiesURL) {
const rawGeometryData = await fetch(geometryURL);
const geometryData = await rawGeometryData.json();
let propertiesData;
if (propertiesURL) {
const rawPropertiesData = await fetch(propertiesURL);
propertiesData = await rawPropertiesData.json();
}
await loader.load(geometryData, true, propertiesData);
}
await loadModel(
"../../../resources/small.ifc-processed.json",
"../../../resources/small.ifc-processed-properties.json"
);

Now, streaming works by updating the scene depending on the user's perspective and getting the necessary geometries from the backend. A simple way to achieve this is by updating the scene each time the user stops the camera:

components.camera.controls.addEventListener("controlend", () => {
loader.culler.needsUpdate = true;
});

As you can imagine, downloading the geometries from the server each time can take time, especially for heavier geometries. This is why the stream loader @@ -56,8 +56,8 @@ it will be much better. You can control this using the useCache property and clear the cache using the clearCache() method:

loader.useCache = true;
await loader.clearCache();

You can also customize the loader through the culler property:

  • Threshold determines how bit an object must be in the screen to stream it.
  • maxHiddenTime determines how long an object must be lost to remove it from the scene.
  • maxLostTime determines how long an object must be lost to remove it from memory.
loader.culler.threshold = 20;
loader.culler.maxHiddenTime = 1000;
loader.culler.maxLostTime = 40000;

This is it! Now you should be able to stream your own IFC models and open them anywhere, no matter how big they are! 💪 We will keep improving and making this API more powerful -to handle any model on any device smoothly.

- - +to handle any model on any device smoothly.

+ + \ No newline at end of file diff --git a/build/Tutorials/FragmentManager/index.html b/build/Tutorials/FragmentManager/index.html index 310dc884..9dc1f3bc 100644 --- a/build/Tutorials/FragmentManager/index.html +++ b/build/Tutorials/FragmentManager/index.html @@ -3,30 +3,30 @@ -FragmentManager | That Open Docs - - +FragmentManager | That Open Docs + + -
-
Skip to main content

FragmentManager

🧶 Managing Fragment Efficiently​

Until recently, we had been adding 3D objects to the Scene with the traditional scene.add API. +

+

FragmentManager

🧶 Managing Fragment Efficiently​

Until recently, we had been adding 3D objects to the Scene with the traditional scene.add API. We will now use Fragment to work with large BIM models.🏗️ Fragment are faster and easier to use Geometric API, which reduces draw calls and speeds up the processing of 3D objects. -In this tutorial, we will load and render .frag files using Fragment Manager.

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

🧭 Fragment Powerhouse​

Let's begin by including Fragment Manager, +In this tutorial, we will load and render .frag files using Fragment Manager.

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

🧭 Fragment Powerhouse​

Let's begin by including Fragment Manager, which requires the parameter component to be provided to it. -In terms of capabilities, Fragment Manager is a true powerhouse.🏭

let fragments = new OBC.FragmentManager(components);

Let's also create a toolbar to create a simple GUI for the functions we'll create:

const toolbar = new OBC.Toolbar(components);
components.ui.addToolbar(toolbar);

🧩 Add Fragment To Scene​

Using a single API, a Fragment can be quickly added to the scene. +In terms of capabilities, Fragment Manager is a true powerhouse.🏭

let fragments = new OBC.FragmentManager(components);

Let's also create a toolbar to create a simple GUI for the functions we'll create:

const toolbar = new OBC.Toolbar(components);
components.ui.addToolbar(toolbar);

🧩 Add Fragment To Scene​

Using a single API, a Fragment can be quickly added to the scene. Everything else is taken care of by fragment.load, which makes it easier to render a Fragment file.💪💪

async function loadFragments() {
if(fragments.groups.length) return;
const file = await fetch("../../../resources/small.frag");
const data = await file.arrayBuffer();
const buffer = new Uint8Array(data);
const group = await fragments.load(buffer);
console.log(group)
// const scene = components.scene.get();
// scene.add(model);
}
const loadButton = new OBC.Button(components);
loadButton.materialIcon = "download";
loadButton.tooltip = "Load model";
toolbar.addChild(loadButton);
loadButton.onClick.add(() => loadFragments());
Loading IFC files as Fragment

You're probably wondering how IFC files can be loaded as Fragment. The same approach can be used to load an IFC file with a fragment; -view its own tutorial for further information.

📤 Storing Fragment​

Fragment Manager provides us with option to export the Fragment we have used in our Scene. +view its own tutorial for further information.

📤 Storing Fragment​

Fragment Manager provides us with option to export the Fragment we have used in our Scene. Fragment are exported to Blob, which can be used to generate a File and then download it.↗️ -Let's see how you can use fragment.export in your code.

function exportFragments() {
if(!fragments.groups.length) return;
const group = fragments.groups[0];
const data = fragments.export(group);
const blob = new Blob([data]);
const file = new File([blob], "small.frag");
download(file);
}
const exportButton = new OBC.Button(components);
exportButton.materialIcon = "exit_to_app";
exportButton.tooltip = "Export model";
toolbar.addChild(exportButton);
exportButton.onClick.add(() => exportFragments());

🗃️ Downloading Files​

We have created a small utility function which we will use to download the exported Fragment by passing the relevant file to it.

function download(file) {
const link = document.createElement("a");
link.href = URL.createObjectURL(file);
link.download = file.name;
document.body.appendChild(link);
link.click();
link.remove();
}
Creating Dynamic URLs

URL.createObjectURL() comes handy when you want to generate a URL for files that were generated programmatically. -You can read more about it here.

🧹 Discard Fragment and Clean the Scene​

At some point, you will require to render numerous Fragment and discard them when not needed. +Let's see how you can use fragment.export in your code.

function exportFragments() {
if(!fragments.groups.length) return;
const group = fragments.groups[0];
const data = fragments.export(group);
const blob = new Blob([data]);
const file = new File([blob], "small.frag");
download(file);
}
const exportButton = new OBC.Button(components);
exportButton.materialIcon = "exit_to_app";
exportButton.tooltip = "Export model";
toolbar.addChild(exportButton);
exportButton.onClick.add(() => exportFragments());

🗃️ Downloading Files​

We have created a small utility function which we will use to download the exported Fragment by passing the relevant file to it.

function download(file) {
const link = document.createElement("a");
link.href = URL.createObjectURL(file);
link.download = file.name;
document.body.appendChild(link);
link.click();
link.remove();
}
Creating Dynamic URLs

URL.createObjectURL() comes handy when you want to generate a URL for files that were generated programmatically. +You can read more about it here.

🧹 Discard Fragment and Clean the Scene​

At some point, you will require to render numerous Fragment and discard them when not needed. You can use dispose() method which will remove the Fragment Meshes from the Scene.✂️ After using fragments.dispose(), you should reinitialize Fragment Manager to maintain it's original state for further uses.

function disposeFragments() {
fragments.dispose();
}
const disposeButton = new OBC.Button(components);
disposeButton.materialIcon = "delete";
disposeButton.tooltip = "Delete model";
toolbar.addChild(disposeButton);
disposeButton.onClick.add(() => disposeFragments());

Loading a .zip fragment that you have locally is also quite easy:

function importExternalFragment() {
if(fragments.groups.length) return;
const input = document.createElement("input");
input.type = "file";
input.onchange = async () => {
const file = input.files[0];
if(file.name.includes(".frag")) {
const url = URL.createObjectURL(file);
const result = await fetch(url);
const data = await result.arrayBuffer();
const buffer = new Uint8Array(data);
fragments.load(buffer);
}
input.remove();
}
input.click();
}
const openButton = new OBC.Button(components);
openButton.materialIcon = "folder_open";
openButton.tooltip = "Import model";
toolbar.addChild(openButton);
openButton.onClick.add(() => importExternalFragment());

Congratulations 🎉 on completing this short yet powerful tutorial! Now you can render or export Fragment files in your BIM Apps using Fragment Manager 🎯 -Let's keep it up and check out another tutorial! 🎓

- - +Let's keep it up and check out another tutorial! 🎓

+ + \ No newline at end of file diff --git a/build/Tutorials/FragmentPlans/index.html b/build/Tutorials/FragmentPlans/index.html index 41d73649..87e632ba 100644 --- a/build/Tutorials/FragmentPlans/index.html +++ b/build/Tutorials/FragmentPlans/index.html @@ -3,28 +3,28 @@ -FragmentPlans | That Open Docs - - +FragmentPlans | That Open Docs + + -
-
Skip to main content

FragmentPlans

📃📜📄 Navigating our 3D world in 2D​

Before 3D existed, architects and engineers had to represent the +

+

FragmentPlans

📃📜📄 Navigating our 3D world in 2D​

Before 3D existed, architects and engineers had to represent the built reality in 2D drawings. We still use those 2D representations, and floor plans are the king of this 2D realm. Creating and navigating floor plans is really easy! First, let's start an instance of the culler (check out its tutorial if you haven't already):

const culler = new OBC.ScreenCuller(components);
culler.setup();
container.addEventListener('mouseup', () => culler.elements.needsUpdate = true);
container.addEventListener('wheel', () => culler.elements.needsUpdate = true);

Next, let's load our classic fragment model and add it to the -scene and to the culler:

const fragments = new OBC.FragmentManager(components);
const file = await fetch('../../../resources/small.frag');
const data = await file.arrayBuffer();
const buffer = new Uint8Array(data);
const model = await fragments.load(buffer);
const properties = await fetch('../../../resources/small.json');
const props = await properties.json();
model.setLocalProperties(props);
for(const fragment of model.items) {
culler.elements.add(fragment.mesh);
}
culler.elements.needsUpdate = true;

✨ Styling our floorplans​

Now we will decide how we want our floorplans to look like. To do +scene and to the culler:

const fragments = new OBC.FragmentManager(components);
const file = await fetch('../../../resources/small.frag');
const data = await file.arrayBuffer();
const buffer = new Uint8Array(data);
const model = await fragments.load(buffer);
const properties = await fetch('../../../resources/small.json');
const props = await properties.json();
model.setLocalProperties(props);
for(const fragment of model.items) {
culler.elements.add(fragment.mesh);
}
culler.elements.needsUpdate = true;

✨ Styling our floorplans​

Now we will decide how we want our floorplans to look like. To do that, we will instantiate the EdgesClipper and define two styles: one for thick lines, and another one for thin lines:

Edges?

If you haven't seen the tutorial of the edges clipper yet, check it out before continuing!

const clipper = new OBC.EdgesClipper(components);
const sectionMaterial = new THREE.LineBasicMaterial({color: 'black'});
const fillMaterial = new THREE.MeshBasicMaterial({color: 'gray', side: 2});
const fillOutline = new THREE.MeshBasicMaterial({color: 'black', side: 1, opacity: 0.5, transparent: true});
clipper.styles.create("filled", new Set(), sectionMaterial, fillMaterial, fillOutline);
clipper.styles.create("projected", new Set(), sectionMaterial);
const styles = clipper.styles.get();

Don't forget to enable the outline effect or you won't see the clipping outline!

postproduction.customEffects.outlineEnabled = true;

We want to apply the styles depending on the category of each element. Luckily for us, the FragmentClassifier makes this task a piece of cake:

const classifier = new OBC.FragmentClassifier(components);
classifier.byEntity(model);
classifier.byStorey(model);
const found = classifier.find({entities: ["IFCWALLSTANDARDCASE", "IFCWALL"]});

Now we can assign each geometry to its corresponding style -by using 2 simple loops:

for (const fragID in found) {
const {mesh} = fragments.list[fragID];
styles.filled.fragments[fragID] = new Set(found[fragID]);
styles.filled.meshes.add(mesh);
}
const meshes = [];
for (const fragment of model.items) {
const {mesh} = fragment;
meshes.push(mesh);
styles.projected.meshes.add(mesh);
}

⛄ Global white material​

As you might now, floorplans are usually white (as they were +by using 2 simple loops:

for (const fragID in found) {
const {mesh} = fragments.list[fragID];
styles.filled.fragments[fragID] = new Set(found[fragID]);
styles.filled.meshes.add(mesh);
}
const meshes = [];
for (const fragment of model.items) {
const {mesh} = fragment;
meshes.push(mesh);
styles.projected.meshes.add(mesh);
}

⛄ Global white material​

As you might now, floorplans are usually white (as they were printed on paper). We can achieve this same effect by using -the MaterialManager:

const whiteColor = new THREE.Color("white");
const whiteMaterial = new THREE.MeshBasicMaterial({color: whiteColor});
const materialManager = new OBC.MaterialManager(components);
materialManager.addMaterial("white", whiteMaterial);
materialManager.addMeshes("white", meshes);

🤖 Generating the plans​

Creating the plans is super easy using the FragmentPlans +the MaterialManager:

const whiteColor = new THREE.Color("white");
const whiteMaterial = new THREE.MeshBasicMaterial({color: whiteColor});
const materialManager = new OBC.MaterialManager(components);
materialManager.addMaterial("white", whiteMaterial);
materialManager.addMeshes("white", meshes);

🤖 Generating the plans​

Creating the plans is super easy using the FragmentPlans tool. We can just use the computeAllPlanViews and it will process everything automatically!

const plans = new OBC.FragmentPlans(components);
await plans.computeAllPlanViews(model);

Let's also add some functionality to our floorplans. We will allow the user to highlight and hide / show elements depending on their @@ -37,8 +37,8 @@ into a floorplan, we the scene display is set up correctly:

plans.onNavigated.add(() => {
postproduction.customEffects.glossEnabled = false;
materialManager.setBackgroundColor(whiteColor);
materialManager.set(true, ["white"]);
grid.visible = false;
});
plans.onExited.add(() => {
postproduction.customEffects.glossEnabled = true;
materialManager.resetBackgroundColor();
materialManager.set(false, ["white"]);
grid.visible = true;
});

Fantastic job! You have created a 3D app that can create and navigate 2D floorplans of fragments and IFC models. This will bring your BIM apps to the next level. See you in other tutorials -of these docs!

- - +of these docs!

+ + \ No newline at end of file diff --git a/build/Tutorials/FragmentTree/index.html b/build/Tutorials/FragmentTree/index.html index c3af1218..858c4747 100644 --- a/build/Tutorials/FragmentTree/index.html +++ b/build/Tutorials/FragmentTree/index.html @@ -3,30 +3,30 @@ -FragmentTree | That Open Docs - - +FragmentTree | That Open Docs + + -
-
Skip to main content

FragmentTree

🌲 Gathering Structured Insights​

Building Information Modeling comprises nesting elements in multiple hierarchies. +

+

FragmentTree

🌲 Gathering Structured Insights​

Building Information Modeling comprises nesting elements in multiple hierarchies. Working with this information might become complicated and irritating.🤯 Tree-View is extremely effective in managing this volume of data. -Using Fragment Tree, we have made it simple to generate a Tree-View for a fragment.🦾

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

In this lesson, we'll create a Tree-View for the items in the IFC file and zoom in on them when a node is clicked.

🧩 Adding Fragments​

We'll start by adding a Fragment to our scene using FragmentManager. -We'll use a simple fragment for the purposes of this tutorial, but the code is capable of handling big files as well.🏗️

const fragments = new OBC.FragmentManager(components);
const file = await fetch("../../../resources/small.frag");
const data = await file.arrayBuffer();
const buffer = new Uint8Array(data);
const model = await fragments.load(buffer);
const file2 = await fetch("../../../resources/small2.frag");
const data2 = await file2.arrayBuffer();
const buffer2 = new Uint8Array(data2);
const model2 = await fragments.load(buffer2);

🕹 Selection of Fragments​

Whenever you click on a node in Tree-View, that particular element would be highlighted. +Using Fragment Tree, we have made it simple to generate a Tree-View for a fragment.🦾

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

In this lesson, we'll create a Tree-View for the items in the IFC file and zoom in on them when a node is clicked.

🧩 Adding Fragments​

We'll start by adding a Fragment to our scene using FragmentManager. +We'll use a simple fragment for the purposes of this tutorial, but the code is capable of handling big files as well.🏗️

const fragments = new OBC.FragmentManager(components);
const file = await fetch("../../../resources/small.frag");
const data = await file.arrayBuffer();
const buffer = new Uint8Array(data);
const model = await fragments.load(buffer);

🕹 Selection of Fragments​

Whenever you click on a node in Tree-View, that particular element would be highlighted. To create the highlight mechanism, we will use Fragment Highlighter -that manages the material and selection intuitively.

const highlighter = new OBC.FragmentHighlighter(components, fragments);
highlighter.setup();
Highlighting Fragments

🖱Check out FragmentHighlighter.mdx for a detailed tutorial on how to utilize Fragment Highlighter to conduct selection on IFC files!

Adding Aesthetic Outlines​

Now that highlighter setup is done, we will add a nice outline effect when the elements are selected.

components.renderer.postproduction.customEffects.outlineEnabled = true;
highlighter.outlinesEnabled = true;
highlighter.updateHighlight();

🗂️ Strategically Classifying Fragments​

In this tutorial, we will deconstruct the model in order to obtain a hierarchical view.💣 +that manages the material and selection intuitively.

const highlighter = new OBC.FragmentHighlighter(components, fragments);
highlighter.setup();
Highlighting Fragments

🖱Check out FragmentHighlighter.mdx for a detailed tutorial on how to utilize Fragment Highlighter to conduct selection on IFC files!

Adding Aesthetic Outlines​

Now that highlighter setup is done, we will add a nice outline effect when the elements are selected.

components.renderer.postproduction.customEffects.outlineEnabled = true;
highlighter.outlinesEnabled = true;
highlighter.updateHighlight();

🗂️ Strategically Classifying Fragments​

In this tutorial, we will deconstruct the model in order to obtain a hierarchical view.💣 To obtain a nested view, we must first classify them by floors and then by type entities. -For breaking down the model in the required way, we'll utilize Fragment Classifier.

const classifier = new OBC.FragmentClassifier(components);

Getting Properties​

Fragment Classifier requires model properties that will help the classifier in identifying the floors and entities included inside the Fragment.🧮 -We will fetch the properties from json file and store it in model.properties.

const properties = await fetch("../../../resources/small.json");
model.setLocalProperties(await properties.json());
const properties2 = await fetch("../../../resources/small2.json");
model2.setLocalProperties(await properties2.json());

Now that we have the properties, we will pass the model to classifier and use classifier.byStorey() which will group the Fragments according to Floors. -The model then needs to be classified according to entities using classifier.byEntity().🗂

// classifier.byStorey(model);
// classifier.byEntity(model);
classifier.byStorey(model2);
classifier.byEntity(model2);

🌱 Building Insightful Tree Views​

Now comes the interesting part, we will create FragmentTree using components and classifier. -In addition, we will update the Fragment Tree to produce the Tree-View based on storeys and entities.

const modelTree = new OBC.FragmentTree(components);
await modelTree.init();
modelTree.update(['storeys', 'entities']);

🛎️ Managing Tree-View Events​

We will zoom in on the element that is selected in the Tree-View and add a nice highlight effect when the user hovers over a tree node.🖱 -Let's use modelTree.onSelected to get the active selection from Fragment Tree, and we will use highlighter.highlightByID() to zoom in.🔍

modelTree.onSelected.add(({ items, visible }) => {
if(visible) {
highlighter.highlightByID('select', items, true, true);
}
});
modelTree.onHovered.add(({ items, visible }) => {
if(visible) {
highlighter.highlightByID('hover', items);
}
});

🎨 Rendering the Fragment Tree​

Now, that all the setup is done we will add the Fragment Tree to the Toolbar. +For breaking down the model in the required way, we'll utilize Fragment Classifier.

const classifier = new OBC.FragmentClassifier(components);

Getting Properties​

Fragment Classifier requires model properties that will help the classifier in identifying the floors and entities included inside the Fragment.🧮 +We will fetch the properties from json file and store it in model.properties.

const properties = await fetch("../../../resources/small.json");
model.setLocalProperties(await properties.json());

Now that we have the properties, we will pass the model to classifier and use classifier.byStorey() which will group the Fragments according to Floors. +The model then needs to be classified according to entities using classifier.byEntity().🗂

classifier.byStorey(model);
classifier.byEntity(model);

🌱 Building Insightful Tree Views​

Now comes the interesting part, we will create FragmentTree using components and classifier. +In addition, we will update the Fragment Tree to produce the Tree-View based on storeys and entities.

const modelTree = new OBC.FragmentTree(components);
await modelTree.init();
modelTree.update(['storeys', 'entities']);

🛎️ Managing Tree-View Events​

We will zoom in on the element that is selected in the Tree-View and add a nice highlight effect when the user hovers over a tree node.🖱 +Let's use modelTree.onSelected to get the active selection from Fragment Tree, and we will use highlighter.highlightByID() to zoom in.🔍

modelTree.onSelected.add(({ items, visible }) => {
if(visible) {
highlighter.highlightByID('select', items, true, true);
}
});
modelTree.onHovered.add(({ items, visible }) => {
if(visible) {
highlighter.highlightByID('hover', items);
}
});

🎨 Rendering the Fragment Tree​

Now, that all the setup is done we will add the Fragment Tree to the Toolbar. We will use the addChild() method to pass the Fragment Tree data to the Toolbar 🎛️ Check Toolbar and UIManager tutorial if you have any doubts!

const toolbar = new OBC.Toolbar(components);
toolbar.addChild(modelTree.uiElement.get("main"));
components.ui.addToolbar(toolbar);

Cheers and Congratulations 🎉 on completing this short yet powerful tutorial! Now, you can provide a structured, navigable, and user-friendly interface to manage, explore, and interact with your BIM models.🥁 -Let's keep it up and check out another tutorial! 🎓

- - +Let's keep it up and check out another tutorial! 🎓

+ + \ No newline at end of file diff --git a/build/Tutorials/IfcPropertiesFinder/index.html b/build/Tutorials/IfcPropertiesFinder/index.html index 03906908..88820d16 100644 --- a/build/Tutorials/IfcPropertiesFinder/index.html +++ b/build/Tutorials/IfcPropertiesFinder/index.html @@ -3,13 +3,13 @@ -IfcPropertiesFinder | That Open Docs - - +IfcPropertiesFinder | That Open Docs + + -
-
Skip to main content

IfcPropertiesFinder

🔎 Find just what you need​

Sometimes data is buried inside our BIM models, and the +

+

IfcPropertiesFinder

🔎 Find just what you need​

Sometimes data is buried inside our BIM models, and the heterogeneity of BIM models doesn't make it easier. Luckily, we have created a component that can go past this barrier: the IfcPropertiesFinder.

How can it find buried data?

Best way to describe the component is to find "Relations of entities meeting a set of attributes criteria". @@ -19,15 +19,15 @@ calling the init method. It's asynchronous, so don't forget to add an await before it! Then, you can make it queryWindow visible to start working with it:

const propsFinder = new OBC.IfcPropertiesFinder(components);
await propsFinder.init();
propsFinder.uiElement.get("queryWindow").visible = true;

We will also add a Toolbar so that you can see how to hide and -show it using the main built-in Button that it has:

const mainToolbar = new OBC.Toolbar(components)
components.ui.addToolbar(mainToolbar)
mainToolbar.addChild(propsFinder.uiElement.get("main"))

✨ Highlighting the results​

Right now our app is super boring, so let's make this a bit more +show it using the main built-in Button that it has:

const mainToolbar = new OBC.Toolbar(components)
components.ui.addToolbar(mainToolbar)
mainToolbar.addChild(propsFinder.uiElement.get("main"))

✨ Highlighting the results​

Right now our app is super boring, so let's make this a bit more interesting. We will highlight the items found by the finder. Doing this is super easy with the FragmentHighlighter and the finder onFound event:

const highlighter = new OBC.FragmentHighlighter(components);
highlighter.setup();
components.renderer.postproduction.customEffects.outlineEnabled = true;
highlighter.outlinesEnabled = true;
highlighter.zoomToSelection = true;
propsFinder.onFound.add(result => {
highlighter.highlightByID("select", result);
})

This is it! Now you know how to find data using complex queries in your BIM models. You can use the finder in combination with your own tools, like we did with the FragmentHider. Let us make the data heavy lifting for you and just focus on the results! -We'll see you in another tutorial of these docs.

- - +We'll see you in another tutorial of these docs.

+ + \ No newline at end of file diff --git a/build/Tutorials/IfcPropertiesManager/index.html b/build/Tutorials/IfcPropertiesManager/index.html index ef26e90e..668b0382 100644 --- a/build/Tutorials/IfcPropertiesManager/index.html +++ b/build/Tutorials/IfcPropertiesManager/index.html @@ -3,13 +3,13 @@ -IfcPropertiesManager | That Open Docs - - +IfcPropertiesManager | That Open Docs + + -
-
Skip to main content

IfcPropertiesManager

✍ Edit properties at will!​

Viewing IFC files fast is great, but often the data inside +

+

IfcPropertiesManager

✍ Edit properties at will!​

Viewing IFC files fast is great, but often the data inside them is not correct or complete. Luckily, we can now directly edit and add data super easily! First, let's start by adding our classic fragment model:

const fragments = new OBC.FragmentManager(components);
const file = await fetch("../../../resources/small.frag");
const dataBlob = await file.arrayBuffer();
const buffer = new Uint8Array(dataBlob);
const model = await fragments.load(buffer);
const properties = await fetch("../../../resources/small.json");
const props = await properties.json();
model.setLocalProperties(props);

Then, we'll instance the tool that we need for editing properties: @@ -19,16 +19,16 @@ Despite you can do it using the methods in the tool instance, let's process the model using the IfcPropertiesProcessor to use the built-in UI, because is easier! -:

propsProcessor.process(model);
propsManager.onRequestFile.add(async () => {
const fetched = await fetch("../../../resources/small.ifc");
const buffer = await fetched.arrayBuffer()
const ifc = await propsManager.saveToIfc(model, new Uint8Array(buffer));
const a = document.createElement("a");
const url = URL.createObjectURL(new Blob([ifc]));
a.href = url;
a.download = model.name;
a.click();
URL.revokeObjectURL(url);
})

✨ Setting up highlighting and selecting​

Now, we will set up highlighting logic to make our app more +:

propsProcessor.process(model);
propsManager.onRequestFile.add(async () => {
const fetched = await fetch("../../../resources/small.ifc");
const buffer = await fetched.arrayBuffer()
const ifc = await propsManager.saveToIfc(model, new Uint8Array(buffer));
const a = document.createElement("a");
const url = URL.createObjectURL(new Blob([ifc]));
a.href = url;
a.download = model.name;
a.click();
URL.revokeObjectURL(url);
})

✨ Setting up highlighting and selecting​

Now, we will set up highlighting logic to make our app more interesting. It's done in a similar way to other tutorials, so wander around the docs if you haven't already!

const highlighter = new OBC.FragmentHighlighter(components, fragments);
highlighter.setup();
components.renderer.postproduction.customEffects.outlineEnabled = true;
highlighter.outlinesEnabled = true;
const highlighterEvents = highlighter.events;
highlighterEvents.select.onClear.add(() => {
propsProcessor.cleanPropertiesList();
});

Now, we will configure the highlighter so that each time that we cick on the model, the properties menu is updated to display its properties, just like we did in the IfcPropertiesProcessor -tutorial:

highlighterEvents.select.onHighlight.add(
(selection) => {
const fragmentID = Object.keys(selection)[0];
const expressID = [...selection[fragmentID]][0];
let model
for (const group of fragments.groups) {
for(const [_key, value] of group.keyFragments) {
if(value === fragmentID) {
model = group;
break;
}
}
}
if(model) {
propsProcessor.renderProperties(model, expressID);
}
}
);

Finally, we will add the UI to the app by creating a simple +tutorial:

highlighterEvents.select.onHighlight.add(
(selection) => {
const fragmentID = Object.keys(selection)[0];
const expressID = [...selection[fragmentID]][0];
const fragment = fragments.list[fragmentID];
if(fragment.group) {
propsProcessor.renderProperties(fragment.group, expressID);
}
}
);

Finally, we will add the UI to the app by creating a simple toolbar:

const mainToolbar = new OBC.Toolbar(components);
components.ui.addToolbar(mainToolbar);
mainToolbar.addChild(propsProcessor.uiElement.get("main"));

Great job! Now you know how to support IFC property editing and export in your apps. Check out the rest of the tutorials of -these docs for other cool BIM features.

- - +these docs for other cool BIM features.

+ + \ No newline at end of file diff --git a/build/Tutorials/IfcPropertiesProcessor/index.html b/build/Tutorials/IfcPropertiesProcessor/index.html index 697b9c64..bd2ab590 100644 --- a/build/Tutorials/IfcPropertiesProcessor/index.html +++ b/build/Tutorials/IfcPropertiesProcessor/index.html @@ -3,13 +3,13 @@ -IfcPropertiesProcessor | That Open Docs - - +IfcPropertiesProcessor | That Open Docs + + -
-
Skip to main content

IfcPropertiesProcessor

🧶 View all IFC properties FAST​

IFC elements have tons of data, and it's often indirectly +

+

IfcPropertiesProcessor

🧶 View all IFC properties FAST​

IFC elements have tons of data, and it's often indirectly bound to the elements. Luckily, getting all the data for any IFC element is trivial with these libraries. Let´s see how! First, as usually, we'll load our classic fragment model and set up @@ -17,11 +17,11 @@ IFC properties: the IfcPropertiesProcessor. We will also make its built-in floating window visible by default.

const propsProcessor = new OBC.IfcPropertiesProcessor(components)
propsProcessor.uiElement.get("propertiesWindow").visible = true

Now, to view the properties of a model we need to process it:

propsProcessor.process(model);

And now, we will bind the highlihgter logic to the properties processor, so that each time that we click on an element, its -properties will be shown:

const highlighterEvents = highlighter.events;
highlighterEvents.select.onClear.add(() => {
propsProcessor.cleanPropertiesList();
});
highlighterEvents.select.onHighlight.add(
(selection) => {
const fragmentID = Object.keys(selection)[0];
const expressID = [...selection[fragmentID]][0];
let model
for (const group of fragments.groups) {
for(const [_key, value] of group.keyFragments) {
if(value === fragmentID) {
model = group;
break;
}
}
}
if(model) {
propsProcessor.renderProperties(model, expressID);
}
}
);
// console.log(propsProcessor._indexMap);
//
// setTimeout(
//     () => {
//         const toExport = {};
//         for(const fragID in propsProcessor._indexMap) {
//             const ids = propsProcessor._indexMap[fragID];
//             for(const expressID in ids) {
//                 const associatedIDs = ids[expressID];
//                 toExport[expressID] = [...associatedIDs];
//             }
//         }
//
//         console.log(JSON.stringify(toExport));
//     },
//     1000
// )

Finally, we will add the main built-in button of the properties +properties will be shown:

const highlighterEvents = highlighter.events;
highlighterEvents.select.onClear.add(() => {
propsProcessor.cleanPropertiesList();
});
highlighterEvents.select.onHighlight.add(
(selection) => {
const fragmentID = Object.keys(selection)[0];
const expressID = [...selection[fragmentID]][0];
const fragment = fragments.list[fragmentID];
if(fragment.group) {
propsProcessor.renderProperties(fragment.group, expressID);
}
}
);
// console.log(propsProcessor._indexMap);
//
// setTimeout(
//     () => {
//         const toExport = {};
//         for(const fragID in propsProcessor._indexMap) {
//             const ids = propsProcessor._indexMap[fragID];
//             for(const expressID in ids) {
//                 const associatedIDs = ids[expressID];
//                 toExport[expressID] = [...associatedIDs];
//             }
//         }
//
//         console.log(JSON.stringify(toExport));
//     },
//     1000
// )

Finally, we will add the main built-in button of the properties processor to a simple toolbar at the bottom of our app:

const mainToolbar = new OBC.Toolbar(components);
components.ui.addToolbar(mainToolbar);
mainToolbar.addChild(propsProcessor.uiElement.get("main"));

This is it! Congratulations, now you can see and navigate the properties of any IFC model you load in your apps. Now, -let's continue navigating these docs for more cool open BIM tools!

- - +let's continue navigating these docs for more cool open BIM tools!

+ + \ No newline at end of file diff --git a/build/Tutorials/LengthMeasurement/index.html b/build/Tutorials/LengthMeasurement/index.html index a664b0c4..fefe7531 100644 --- a/build/Tutorials/LengthMeasurement/index.html +++ b/build/Tutorials/LengthMeasurement/index.html @@ -3,20 +3,20 @@ -LengthMeasurement | That Open Docs - - +LengthMeasurement | That Open Docs + + -
-
Skip to main content

LengthMeasurement

📏 Dimensions Tool​

At times, you may need to compute the dimensions of an object or measure the distance between two elements. +

+

LengthMeasurement

📏 Dimensions Tool​

At times, you may need to compute the dimensions of an object or measure the distance between two elements. Elements must be precisely aligned when working on complex models. Dimension Tool allows you to perform measurements effortlessly.

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

This tutorial will show you how to add Dimension Tool to your projects, -which can be used to acquire accurate dimensions for any 3D Object.🔭

🎲 Creating a Cube Mesh​

For this tutorial we will use a Cube, you can add any geometry as per your preference. +which can be used to acquire accurate dimensions for any 3D Object.🔭

🎲 Creating a Cube Mesh​

For this tutorial we will use a Cube, you can add any geometry as per your preference. We will create a Cube with 3x3x3 dimensions and use red color for the material.

const cubeGeometry = new THREE.BoxGeometry(3, 3, 3);
const cubeMaterial = new THREE.MeshStandardMaterial({color: '#6528D7'});
const cube = new THREE.Mesh(cubeGeometry, cubeMaterial);
cube.position.set(0, 1.5, 0)

Now, we will add the Cube to the Scene. We must also add the cube to components.meshes, which is simply an array of all the meshes in the Scene.🗄️

scene.add(cube);
components.meshes.add(cube);
Collection of Meshes

📦 Components.meshes keeps all your meshes including IFC Models, Fragments in -one place.

🛠️ Creating Dimension Tool​

A lot of logic is usually needed to compute dimensions for any item, beginning with ray casting, +one place.

🛠️ Creating Dimension Tool​

A lot of logic is usually needed to compute dimensions for any item, beginning with ray casting, finding the vertices to snap to, and rendering the UI for every line element.🙄 This may appear to be a lot of effort, but we are handling all the heavy lifting for you, and you only need to write a few lines for creating the Dimension Tool.💪

const dimensions = new OBC.LengthMeasurement(components);

We will build dimensions by supplying the components to OBC.SimpleDimensions.

DIMENSIONS AND UI

Read the Simple Dimensions API for more on this. @@ -24,17 +24,17 @@ One such property which you can use is dimensions.color which modifies the color of the Line Element. Now, let's enable dimensions and tell them to be snapped at a distance of one unit. snapDistance helps in attaching the tooltip temporarily at regular intervals, -making it easier to interact with items.📍

dimensions.enabled = true;
dimensions.snapDistance = 1;

🖱️ Managing Events​

You can use the Dimension Tool to construct several dimension lines. Let's see how you handle them.

✍️ Creating the Dimensions​

Now that we've generated the dimensions object, we need to attach the line tooltip to a vertex of the 3D object. +making it easier to interact with items.📍

dimensions.enabled = true;
dimensions.snapDistance = 1;

🖱️ Managing Events​

You can use the Dimension Tool to construct several dimension lines. Let's see how you handle them.

✍️ Creating the Dimensions​

Now that we've generated the dimensions object, we need to attach the line tooltip to a vertex of the 3D object. We'll use the double click event to invoke dimensions.create(). When this event occurs, a line element is generated, -and the distance is calculated in real-time inside the label associated with that line.🏷️

container.ondblclick = () => dimensions.create();

🧹 Deleting the Dimensions​

Now that we know how to make multiple dimension lines, we must also know how to delete them when necessary. +and the distance is calculated in real-time inside the label associated with that line.🏷️

container.ondblclick = () => dimensions.create();

🧹 Deleting the Dimensions​

Now that we know how to make multiple dimension lines, we must also know how to delete them when necessary. Dimensions can be removed using dimensions.delete(). dimensions.delete() deletes the dimension on which your mouse pointer is now located.

Deleting all the Dimensions

❎ If you want to safely delete all the dimensions that were created you can simply call -dimensions.deleteAll()

window.onkeydown = (event) => {
if (event.code === 'Delete' || event.code === 'Backspace') {
dimensions.delete();
}
}

⏏️ Creating a Toolbar for the Dimensions​

We'll make a Toolbar Component and set it at the bottom. -In addition, we will have a button that allows you to toggle the dimension tool.

const mainToolbar = new OBC.Toolbar(components, { name: 'Main Toolbar', position: 'bottom' });
mainToolbar.addChild(dimensions.uiElement.get("main"));
components.ui.addToolbar(mainToolbar);

🎛️ Check Toolbar and UIManager tutorial if you have any doubts!

🖌️ Adding Styles​

Few final things, we need to add styles for the labels which display the measurement information.

  • ifcjs-dimension-label - The label which is used to show the metric value after both the tooltips are attached.
  • ifcjs-dimension-label:hover - Changing the styling when someone hovers on the dimension label.
  • ifcjs-dimension-preview - The label which shows the measurement when the tooltip is not yet attached.
style
.ifcjs-dimension-label {
background-color: black;
font-family: sans-serif;
color: white;
padding: 8px;
border-radius: 8px;
pointer-events: all;
transition: background-color 200ms ease-in-out;
}
.ifcjs-dimension-label:hover {
background-color: grey;
}
.ifcjs-dimension-preview {
background-color: #ffffff;
width: 2rem;
height: 2rem;
opacity: 0.3;
padding: 8px;
border-radius: 100%;
}

Congratulations 🎉 on completing this tutorial! Now you can measure any BIM Model or any 3D Object easily using +dimensions.deleteAll()

window.onkeydown = (event) => {
if (event.code === 'Delete' || event.code === 'Backspace') {
dimensions.delete();
}
}

⏏️ Creating a Toolbar for the Dimensions​

We'll make a Toolbar Component and set it at the bottom. +In addition, we will have a button that allows you to toggle the dimension tool.

const mainToolbar = new OBC.Toolbar(components, { name: 'Main Toolbar', position: 'bottom' });
mainToolbar.addChild(dimensions.uiElement.get("main"));
components.ui.addToolbar(mainToolbar);

🎛️ Check Toolbar and UIManager tutorial if you have any doubts!

🖌️ Adding Styles​

Few final things, we need to add styles for the labels which display the measurement information.

  • ifcjs-dimension-label - The label which is used to show the metric value after both the tooltips are attached.
  • ifcjs-dimension-label:hover - Changing the styling when someone hovers on the dimension label.
  • ifcjs-dimension-preview - The label which shows the measurement when the tooltip is not yet attached.
style
.ifcjs-dimension-label {
background-color: black;
font-family: sans-serif;
color: white;
padding: 8px;
border-radius: 8px;
pointer-events: all;
transition: background-color 200ms ease-in-out;
}
.ifcjs-dimension-label:hover {
background-color: grey;
}
.ifcjs-dimension-preview {
background-color: #ffffff;
width: 2rem;
height: 2rem;
opacity: 0.3;
padding: 8px;
border-radius: 100%;
}

Congratulations 🎉 on completing this tutorial! Now you can measure any BIM Model or any 3D Object easily using Simple Dimension Component 📐 -Let's keep it up and check out another tutorial! 🎓

- - +Let's keep it up and check out another tutorial! 🎓

+ + \ No newline at end of file diff --git a/build/Tutorials/MaterialManager/index.html b/build/Tutorials/MaterialManager/index.html index fd7f8a88..7631cb43 100644 --- a/build/Tutorials/MaterialManager/index.html +++ b/build/Tutorials/MaterialManager/index.html @@ -3,30 +3,30 @@ -MaterialManager | That Open Docs - - +MaterialManager | That Open Docs + + -
-
Skip to main content

MaterialManager

👨‍🎨 Seamless Material Control​

Have you ever had trouble handling multiple Materials for your BIM project? +

+

MaterialManager

👨‍🎨 Seamless Material Control​

Have you ever had trouble handling multiple Materials for your BIM project? You may be asking why different Materials are required. Sometimes you need to highlight a mesh or group the meshes, and render them with different materials; the possibilities are limitless.💫

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

In this tutorial, we use MaterialManager to control materials for various meshes. -We will also show you how to adjust the background of your scene.🌗

🧱 Creating Multiple Meshes​

Now that our scene setup is done, let's add 3D elements to our scene as well. +We will also show you how to adjust the background of your scene.🌗

🧱 Creating Multiple Meshes​

Now that our scene setup is done, let's add 3D elements to our scene as well. We will add Box Geometry -and Sphere Geometry along with a material.🖌️

Grouping the Meshes​

🗃️ To make things easier to understand and use, we will categorize and store meshes into cubes[] and spheres[].

const cubes = [];
const spheres = [];
const boxGeometry = new THREE.BoxGeometry(2, 2, 2);
const sphereGeometry = new THREE.SphereGeometry(2, 8, 8);
const material = new THREE.MeshLambertMaterial({ color: '#6528D7' });

Changing Positions​

We have made preparations for adding mesh to our scene; but, if we do not alter their placements, +and Sphere Geometry along with a material.🖌️

Grouping the Meshes​

🗃️ To make things easier to understand and use, we will categorize and store meshes into cubes[] and spheres[].

const cubes = [];
const spheres = [];
const boxGeometry = new THREE.BoxGeometry(2, 2, 2);
const sphereGeometry = new THREE.SphereGeometry(2, 8, 8);
const material = new THREE.MeshLambertMaterial({ color: '#6528D7' });

Changing Positions​

We have made preparations for adding mesh to our scene; but, if we do not alter their placements, all the meshes will be rendered in the same location, which is (0,0,0).📍

Randomising the Cube Placement

We'll write a quick utility function that returns a random number between 0 and the specified upper limit. You can use this for a variety of purposes, but for this tutorial -it will be used to generate random positions for cube and sphere placement.📌

function getRandomNumber(limit) {
return Math.random() * limit;
}

🧪 Generating Cubes and Spheres​

Now, we will write a simple for loop which will generate 3 Cubes and 3 Sphere meshes. -In addition, we will use the getRandomNumber function that we defined before and add the meshes to the scene with updated positions.🔮

function generateCubes() {
for (let i = 0; i < 3; i++) {
const cube = new THREE.Mesh(boxGeometry, material);
cube.position.x = getRandomNumber(10);
cube.position.y = getRandomNumber(10);
cube.position.z = getRandomNumber(10);
cube.updateMatrix();
scene.add(cube);
cubes.push(cube);
}
}
function generateSpheres() {
for (let i = 0; i < 3; i++) {
const sphere = new THREE.Mesh(sphereGeometry, material);
sphere.position.x = getRandomNumber(10);
sphere.position.y = getRandomNumber(10);
sphere.position.z = getRandomNumber(10);
sphere.updateMatrix();
scene.add(sphere);
spheres.push(sphere);
}
}
generateCubes();
generateSpheres();

🎨 Materials Made Easy​

Here comes the interesting part! We will now use Material Manager +it will be used to generate random positions for cube and sphere placement.📌

function getRandomNumber(limit) {
return Math.random() * limit;
}

🧪 Generating Cubes and Spheres​

Now, we will write a simple for loop which will generate 3 Cubes and 3 Sphere meshes. +In addition, we will use the getRandomNumber function that we defined before and add the meshes to the scene with updated positions.🔮

function generateCubes() {
for (let i = 0; i < 3; i++) {
const cube = new THREE.Mesh(boxGeometry, material);
cube.position.x = getRandomNumber(10);
cube.position.y = getRandomNumber(10);
cube.position.z = getRandomNumber(10);
cube.updateMatrix();
scene.add(cube);
cubes.push(cube);
}
}
function generateSpheres() {
for (let i = 0; i < 3; i++) {
const sphere = new THREE.Mesh(sphereGeometry, material);
sphere.position.x = getRandomNumber(10);
sphere.position.y = getRandomNumber(10);
sphere.position.z = getRandomNumber(10);
sphere.updateMatrix();
scene.add(sphere);
spheres.push(sphere);
}
}
generateCubes();
generateSpheres();

🎨 Materials Made Easy​

Here comes the interesting part! We will now use Material Manager for manipulating the materials and background. Let's create different materials for Cubes and Spheres.🎭

const materialManager = new OBC.MaterialManager(components);
const backgroundColor = new THREE.Color("white");
const cubeColor = new THREE.Color(0x71d728);
const cubeMaterial = new THREE.MeshBasicMaterial({color: cubeColor});
const sphereColor = new THREE.Color(0xd7286b);
const sphereMaterial = new THREE.MeshBasicMaterial({color: sphereColor});
Syncing Components with your own theme!

🔥 You may have noticed that we are also implementing backgroundColor, which will allow you to modify the background of your scene with a single call! -With components, you can now modify the background of your BIM app to match the theme you're using.

Storing the Material with Manager​

Now that the materials have been created, we will name them and use addMaterial to store them in materialManager. -Next, we'll add the necessary meshes to help materialManager to choose which mesh to use when applying materials.🧮

materialManager.addMaterial("cubeMaterial", cubeMaterial);
materialManager.addMeshes("cubeMaterial", cubes);
materialManager.addMaterial("sphereMaterial", sphereMaterial);
materialManager.addMeshes("sphereMaterial", spheres);

🚦 Controlling the Manager Events​

With all the things in place, we will use dat.GUI for controlling the materials!

  • materialManager.set(boolean, ["materialName", ..]) - You can use this API to change the active material for a mesh group.
  • `materialManager.setBackgroundColor(Color) - This API will help you to change the background of your scene.
const gui = new dat.GUI();
const actions = {
changeSphereMaterial: () => {
materialManager.set(true, ["sphereMaterial"]);
},
changeCubeMaterial: () => {
materialManager.set(true, ["cubeMaterial"]);
},
changeBackground: () => {
materialManager.setBackgroundColor(backgroundColor);
},
reset: () => {
materialManager.set(false, ["cubeMaterial" , "sphereMaterial"]);
materialManager.resetBackgroundColor();
}
};

Great job! 🎉 Now you know how to manage multiple materials in your app using +With components, you can now modify the background of your BIM app to match the theme you're using.

Storing the Material with Manager​

Now that the materials have been created, we will name them and use addMaterial to store them in materialManager. +Next, we'll add the necessary meshes to help materialManager to choose which mesh to use when applying materials.🧮

materialManager.addMaterial("cubeMaterial", cubeMaterial);
materialManager.addMeshes("cubeMaterial", cubes);
materialManager.addMaterial("sphereMaterial", sphereMaterial);
materialManager.addMeshes("sphereMaterial", spheres);

🚦 Controlling the Manager Events​

With all the things in place, we will use dat.GUI for controlling the materials!

  • materialManager.set(boolean, ["materialName", ..]) - You can use this API to change the active material for a mesh group.
  • `materialManager.setBackgroundColor(Color) - This API will help you to change the background of your scene.
const gui = new dat.GUI();
const actions = {
changeSphereMaterial: () => {
materialManager.set(true, ["sphereMaterial"]);
},
changeCubeMaterial: () => {
materialManager.set(true, ["cubeMaterial"]);
},
changeBackground: () => {
materialManager.setBackgroundColor(backgroundColor);
},
reset: () => {
materialManager.set(false, ["cubeMaterial" , "sphereMaterial"]);
materialManager.resetBackgroundColor();
}
};

Great job! 🎉 Now you know how to manage multiple materials in your app using Material Manager component! 💪 Your BIM software can be made more visually appealing and aesthetically pleasing. -Let's keep it up and check out another tutorials!

- - +Let's keep it up and check out another tutorials!

+ + \ No newline at end of file diff --git a/build/Tutorials/MiniMap/index.html b/build/Tutorials/MiniMap/index.html index c6f4e437..3706d924 100644 --- a/build/Tutorials/MiniMap/index.html +++ b/build/Tutorials/MiniMap/index.html @@ -3,26 +3,26 @@ -MiniMap | That Open Docs - - +MiniMap | That Open Docs + + -
-
Skip to main content

MiniMap

🏂 Navigate through BIM like Pro!​

BIM Models are large and contain a lot of attributes. +

+

MiniMap

🏂 Navigate through BIM like Pro!​

BIM Models are large and contain a lot of attributes. It can become complicated to manage the elements and painfully difficult to navigate around.🌪 Understanding spatial relationships is crucial during the design and evaluation processes. By having a MiniMap functionality for navigation it makes easier to collaborate and enhance the productivity, let's see how you can integrate MiniMap in your BIM App! 💥

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

For this tutorial, we'll use the MiniMap component to create -a navigation functionality!

🧩 Adding Fragments​

We'll start by adding a Fragment to our scene using FragmentManager. -We'll use a simple fragment for the purposes of this tutorial, but the code is capable of handling big files as well.🏗️

const fragments = new OBC.FragmentManager(components);
const file = await fetch("../../../resources/small.frag");
const dataBlob = await file.arrayBuffer();
const buffer = new Uint8Array(dataBlob);
fragments.load(buffer);
Showing Fragments in the Scene

🏔️ There is a dedicated tutorial on how to use Fragment Manager to load IFC files, checkout that tutorial here!

🗺 Integrating Spatial Wonders​

Now, that we have our setup ready. Let's start with the exciting stuff. +a navigation functionality!

🧩 Adding Fragments​

We'll start by adding a Fragment to our scene using FragmentManager. +We'll use a simple fragment for the purposes of this tutorial, but the code is capable of handling big files as well.🏗️

const fragments = new OBC.FragmentManager(components);
const file = await fetch("../../../resources/small.frag");
const dataBlob = await file.arrayBuffer();
const buffer = new Uint8Array(dataBlob);
fragments.load(buffer);
Showing Fragments in the Scene

🏔️ There is a dedicated tutorial on how to use Fragment Manager to load IFC files, checkout that tutorial here!

🗺 Integrating Spatial Wonders​

Now, that we have our setup ready. Let's start with the exciting stuff. We will use Mini Map component which does all the work for us.🔮 -When we create a Mini Map, a Map element is created at the bottom-right of your browser window.

const map = new OBC.MiniMap(components);
components.ui.add(map.uiElement.get("canvas"));

🎩 Controlling Maps like a wizard!​

MiniMap Component makes it easy to add map to your app, and it also provides much easier way to manage the map. +When we create a Mini Map, a Map element is created at the bottom-right of your browser window.

const map = new OBC.MiniMap(components);
components.ui.add(map.uiElement.get("canvas"));

🎩 Controlling Maps like a wizard!​

MiniMap Component makes it easy to add map to your app, and it also provides much easier way to manage the map. You can set the scale for map using map.zoom or modify the size of UI element using map.getSize(), you can find out about more controls here 🎛

map.lockRotation = false;
map.zoom = 0.2;

Congratulations 🎉 on completing this short yet important tutorial! Now you can easily add navigation Map to your BIM Apps 🎯 -Let's keep it up and check out another tutorial! 🎓

- - +Let's keep it up and check out another tutorial! 🎓

+ + \ No newline at end of file diff --git a/build/Tutorials/OrthoPerspectiveCamera/index.html b/build/Tutorials/OrthoPerspectiveCamera/index.html index 21dafd4e..4bb572dc 100644 --- a/build/Tutorials/OrthoPerspectiveCamera/index.html +++ b/build/Tutorials/OrthoPerspectiveCamera/index.html @@ -3,32 +3,32 @@ -OrthoPerspectiveCamera | That Open Docs - - +OrthoPerspectiveCamera | That Open Docs + + -
-
Skip to main content

OrthoPerspectiveCamera

📽️ Managing Multiple Views​

Perspective view adds depth and realism, which helps in creating visually compelling representations in 3D scenes.🛤️ +

+

OrthoPerspectiveCamera

📽️ Managing Multiple Views​

Perspective view adds depth and realism, which helps in creating visually compelling representations in 3D scenes.🛤️ While, Orthographic view is important for precise measurements and proportions.📐

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

We'll be using an advanced camera component for this tutorial. -OrthoPerspectiveCamera makes it simple to use Orthographic and Perspective projections.

🎲 Creating a Cube Mesh​

First, let's create a simple Cube, which will render differently depending on the projection you choose.🧊 +OrthoPerspectiveCamera makes it simple to use Orthographic and Perspective projections.

🎲 Creating a Cube Mesh​

First, let's create a simple Cube, which will render differently depending on the projection you choose.🧊 We will create a Cube with 3x3x3 dimensions and use red color for the material.🖍️

const cubeGeometry = new THREE.BoxGeometry(3, 3, 3);
const cubeMaterial = new THREE.MeshStandardMaterial({ color: '#6528D7' });
const cube = new THREE.Mesh(cubeGeometry, cubeMaterial);
cube.position.set(0, 1.5, 0);

Now, we will add the Cube to the Scene. We must also add the cube to components.meshes, which is simply an array of all the meshes in the Scene 🗄️. -components.meshes acts as a store to help you manage your elements centrally.

scene.add(cube);
components.meshes.add(cube);

🎞️ Developing an OrthoPerspective Camera​

We will create OrthoPerspectiveCamera by passing components as an argument to it.🗃️ +components.meshes acts as a store to help you manage your elements centrally.

scene.add(cube);
components.meshes.add(cube);

🎞️ Developing an OrthoPerspective Camera​

We will create OrthoPerspectiveCamera by passing components as an argument to it.🗃️ The OrthoPerspective Camera extends the SimpleCamera by providing you with extra controls. We will then configure the camera location and update the look at target using setLookAt() API.👀

const camera = new OBC.OrthoPerspectiveCamera(components);
components.camera = camera;
camera.controls.setLookAt(10, 10, 10, 0, 0, 0);
components.init();
Igniting Components!

🔥 Whenever the components like scene, camera are created, you need to initialize the component library. -Check out components.init() for more info!🔖

🕹️ Changing Views and Navigation​

Now, that our camera setup is done, we need to manage the camera projection on demand.

Toggling Orthographic View and Perspective View​

Let's create a simple method toggleProjection() which toggles the Camera View using camera.toggleProjection. +Check out components.init() for more info!🔖

🕹️ Changing Views and Navigation​

Now, that our camera setup is done, we need to manage the camera projection on demand.

Toggling Orthographic View and Perspective View​

Let's create a simple method toggleProjection() which toggles the Camera View using camera.toggleProjection. Alternatively, you can also use camera.setProjection() and pass 'Orthographic' or 'Perspective' to manage the views.💡

function toggleProjection() {
camera.toggleProjection();
}

You can also subscribe to an event for when the projection changes. For instance, let's change the grid fading mode -when the projection changes. This will make the grid look good in orthographic mode:

camera.projectionChanged.add(() => {
const projection = camera.getProjection();
grid.fade = projection === 'Perspective';
});

Managing Navigation Modes​

Along with projection, we can also manage Navigation modes using OrthoPerspective camera. +when the projection changes. This will make the grid look good in orthographic mode:

camera.projectionChanged.add(() => {
const projection = camera.getProjection();
grid.fade = projection === 'Perspective';
});

Managing Navigation Modes​

Along with projection, we can also manage Navigation modes using OrthoPerspective camera. To update navigation modes, we will use camera.setNavigationMode('Orbit' | 'FirstPerson' | 'Plan')

  • Orbit - Orbit Mode helps us to easily navigate around the 3D Elements.
  • FirstPerson - It helps you to visualize scene from your own perspective. First Person mode is only available for Perspective Projection.
  • Plan - This mode helps you to easily navigate in 2D Projections.
function setNavigationMode(navMode) {
camera.setNavigationMode(navMode);
}
MORE CONTROLS, MORE POWER

🧮 OrthoPerspective Camera also provides you an option to adjust your camera to fit the 3D elements. You can simply use fitModelToFrame(mesh) and provide the mesh which you want to fit to your window frame

Congratulations 🎉 on completing this tutorial! Now you can add Advance Camera System to your web-app in minutes using OrthoPerspectiveCamera ⌚📽️ -Let's keep it up and check out another tutorial! 🎓

- - +Let's keep it up and check out another tutorial! 🎓

+ + \ No newline at end of file diff --git a/build/Tutorials/PostproductionRenderer/index.html b/build/Tutorials/PostproductionRenderer/index.html index 5082007b..2df3ecf0 100644 --- a/build/Tutorials/PostproductionRenderer/index.html +++ b/build/Tutorials/PostproductionRenderer/index.html @@ -3,20 +3,20 @@ -PostproductionRenderer | That Open Docs - - +PostproductionRenderer | That Open Docs + + -
-
Skip to main content

PostproductionRenderer

🧪 Cool Post-Production Effects​

Post-production effects enrich your 3D scenes. There are several post-production effects, such as +

+

PostproductionRenderer

🧪 Cool Post-Production Effects​

Post-production effects enrich your 3D scenes. There are several post-production effects, such as adding shadows, rendering outlines, adding ambient occlusion and applying bloom, that can enhance -and make your scene look cool.🍹

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

In this tutorial we will use Post-Production Renderer to add neat Outlines and Ambient Occlusion to the 3D Model.🦾

🏢 Adding Fragments​

We'll start by adding a Fragment to our scene using Fragment Manager. -We'll use a simple fragment for the purposes of this tutorial, but the code is capable of handling big files as well.🏗️

Using Fragment Manager!

🏋️ There is a dedicated tutorial on how to use Fragment Manager to load IFC files!

const fragments = new OBC.FragmentManager(components);
const file = await fetch('../../../resources/small.frag');
const data = await file.arrayBuffer();
const buffer = new Uint8Array(data);
const model = await fragments.load(buffer);
const meshes = [];
const culler = new OBC.ScreenCuller(components);
culler.setup();
for (const fragment of model.items) {
meshes.push(fragment.mesh);
culler.elements.add(fragment.mesh);
}
culler.elements.needsUpdate = true;
const controls = components.camera.controls;
controls.addEventListener('controlend', () => {
culler.elements.needsUpdate = true;
});

🎬 Activating the Post-Production​

We will activate the post-production effect. +and make your scene look cool.🍹

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

In this tutorial we will use Post-Production Renderer to add neat Outlines and Ambient Occlusion to the 3D Model.🦾

🏢 Adding Fragments​

We'll start by adding a Fragment to our scene using Fragment Manager. +We'll use a simple fragment for the purposes of this tutorial, but the code is capable of handling big files as well.🏗️

Using Fragment Manager!

🏋️ There is a dedicated tutorial on how to use Fragment Manager to load IFC files!

const fragments = new OBC.FragmentManager(components);
const file = await fetch('../../../resources/small.frag');
const data = await file.arrayBuffer();
const buffer = new Uint8Array(data);
const model = await fragments.load(buffer);
const meshes = [];
const culler = new OBC.ScreenCuller(components);
culler.setup();
for (const fragment of model.items) {
meshes.push(fragment.mesh);
culler.elements.add(fragment.mesh);
}
culler.elements.needsUpdate = true;
const controls = components.camera.controls;
controls.addEventListener('controlend', () => {
culler.elements.needsUpdate = true;
});

🎬 Activating the Post-Production​

We will activate the post-production effect. Also, we will enable the visibility for post-production layer.

  • postproduction.active - Enable or Disable the active status of the post-processing effect
  • postproduction.visible - Toggle the visibility of post-processing layer that is created to display the effect.
components.renderer.postproduction.enabled = true;
const postproduction = components.renderer.postproduction;
postproduction.customEffects.excludedMeshes.push(grid.get());
const gui = new dat.GUI();
gui.add(postproduction, 'enabled');
const guiGamma = gui.addFolder('Gamma');
guiGamma.add(postproduction.settings, 'gamma').name("Gamma correction").onChange((value) => {
postproduction.setPasses({gamma: value});
});
const guiCustomEffects = gui.addFolder('Custom effects');
guiCustomEffects.add(postproduction.settings, 'custom').name("Custom effects").onChange((value) => {
postproduction.setPasses({custom: value});
});
guiCustomEffects.add(postproduction.customEffects, 'opacity').name('Line opacity').min(0).max(1).step(0.1);
guiCustomEffects.add(postproduction.customEffects, 'tolerance').name('Line tolerance').min(0).max(6).step(1);
guiCustomEffects.addColor(postproduction.customEffects, 'lineColor').name('Line color');
guiCustomEffects.add(postproduction.customEffects, 'glossEnabled').name('Gloss enabled').min(0).max(2).step(0.1);
guiCustomEffects.add(postproduction.customEffects, 'glossExponent').name('Gloss exponent').min(0).max(5).step(0.1);
guiCustomEffects.add(postproduction.customEffects, 'maxGloss').name('Max gloss').min(-2).max(2).step(0.05);
guiCustomEffects.add(postproduction.customEffects, 'minGloss').name('Min gloss').min(-2).max(2).step(0.05);
const guiAO = gui.addFolder('SAO');
const configuration = postproduction._n8ao.configuration;
guiAO.add(postproduction.settings, 'ao').name("Ambient occlusion").onChange((value) => {
postproduction.setPasses({ao: value});
});
guiAO.add(configuration, 'aoSamples').step(1).min(1).max(16);
guiAO.add(configuration, 'denoiseSamples').step(1).min(0).max(16);
guiAO.add(configuration, 'denoiseRadius').step(1).min(0).max(100);
guiAO.add(configuration, 'aoRadius').step(1).min(0).max(16);
guiAO.add(configuration, 'distanceFalloff').step(1).min(0).max(16);
guiAO.add(configuration, 'intensity').step(1).min(0).max(16);
guiAO.add(configuration, 'halfRes');
guiAO.add(configuration, 'screenSpaceRadius');
guiAO.addColor(configuration, 'color');

Congratulations 🎉 on completing this tutorial! Now you know how to add cool effects easily using Post Production 🖼️ -Let's keep it up and check out another tutorial! 🎓

- - +Let's keep it up and check out another tutorial! 🎓

+ + \ No newline at end of file diff --git a/build/Tutorials/ScreenCuller/index.html b/build/Tutorials/ScreenCuller/index.html index bbcd2d66..8aa18546 100644 --- a/build/Tutorials/ScreenCuller/index.html +++ b/build/Tutorials/ScreenCuller/index.html @@ -3,36 +3,36 @@ -ScreenCuller | That Open Docs - - +ScreenCuller | That Open Docs + + -
-
Skip to main content

ScreenCuller

🚅 Managing Performance​

There are occasions when your scene has too many components. +

+

ScreenCuller

🚅 Managing Performance​

There are occasions when your scene has too many components. Multiple components being rendered simultaneously lengthens computation time⌛️ and degrades performance.🌡️

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

In this tutorial, we will use ScreenCuller to improve performance by reducing unnecessary computations.🚀 -This tutorial will show you how to manage a complex scenario with a lot of elements in an effective way.🦾

🧰 Creating Screen Culler​

Although adding Screen Culler to your project can appear difficult, it is actually rather easy. +This tutorial will show you how to manage a complex scenario with a lot of elements in an effective way.🦾

🧰 Creating Screen Culler​

Although adding Screen Culler to your project can appear difficult, it is actually rather easy. Now, we will add Screen Culler Component. This will create a Screen Culler which is now ready to be used.

const culler = new OBC.ScreenCuller(components);
await culler.setup()

You can also use the threshold property to control the minimum size of an element in screen in order for it to be revealed by the culler. Higher numbers result in less objects visible, but more performance:

culler.elements.threshold = 200;

Additionally, we will activate the culler.elements.renderDebugFrame so that we can see the 2D screen of the elements that are not occluded.💻 Also, we will get the domElement and attach it to the body so that we can see this frame in real-time.📊

culler.elements.renderDebugFrame = true;
const debugFrame = culler.elements.get().domElement;
document.body.appendChild(debugFrame);
debugFrame.style.position = 'fixed';
debugFrame.style.left = '0';
debugFrame.style.bottom = '0';
debugFrame.style.visibility = 'collapse';
Randomising the Cube Placement

We'll write a quick utility function that returns a random number between 0 and the specified upper limit. You can use this for a variety of purposes, but for this tutorial -it will be used to generate random positions for cube placement.📌

function getRandomNumber(limit) {
return Math.random() * limit;
}

🧱 Adding a lot of 3D Objects​

We'll add the Simple 3D Cube and do it 300 times!🤯 +it will be used to generate random positions for cube placement.📌

function getRandomNumber(limit) {
return Math.random() * limit;
}

🧱 Adding a lot of 3D Objects​

We'll add the Simple 3D Cube and do it 300 times!🤯 Components are built using Three.js, making it simple to use any three.js code. -For our cube, we'll generate box geometry and use basic material.

const cubes = [];
const geometry = new THREE.BoxGeometry(2, 2, 2);
const material = new THREE.MeshLambertMaterial({ color: '#6528D7' });

🧪 Generate Multiple Cubes​

Now, using the getRandomNumber() method we previously created, we will add the 300 cube meshes to our scene +For our cube, we'll generate box geometry and use basic material.

const cubes = [];
const geometry = new THREE.BoxGeometry(2, 2, 2);
const material = new THREE.MeshLambertMaterial({ color: '#6528D7' });

🧪 Generate Multiple Cubes​

Now, using the getRandomNumber() method we previously created, we will add the 300 cube meshes to our scene and randomly position them. We'll add the cube to the scene and adjust its position between 0 and 10. Additionally, we will add meshes to the culler object, which will help SimpleCuller to recognize and -draw the elements that are visible to the camera. To do this, culler.elements.add(cube) will be used.

function regenerateCubes() {
resetCubes();
for (let i = 0; i < 300; i++) {
const cube = new THREE.Mesh(geometry, material);
cube.position.x = getRandomNumber(10);
cube.position.y = getRandomNumber(10);
cube.position.z = getRandomNumber(10);
cube.updateMatrix();
scene.add(cube);
culler.elements.add(cube);
cubes.push(cube);
}
}

🧹 Cleaning the Scene​

Now that we know how to create multiple cubes, we will write a function to remove the cubes from scene on demand. -resetCubes() iteratively removes the cubes using cube.removeFromParent.

function resetCubes() {
for (const cube of cubes) {
cube.removeFromParent();
}
cubes.length = 0;
}

📢 Rendering Cubes​

With everything ready, we will call regenerateCubes() which will generate cubes and add them to scene.

regenerateCubes();

Here comes the most crucial part! The core aim of ScreenCuller is to output just those components that are +draw the elements that are visible to the camera. To do this, culler.elements.add(cube) will be used.

function regenerateCubes() {
resetCubes();
for (let i = 0; i < 300; i++) {
const cube = new THREE.Mesh(geometry, material);
cube.position.x = getRandomNumber(10);
cube.position.y = getRandomNumber(10);
cube.position.z = getRandomNumber(10);
cube.updateMatrix();
scene.add(cube);
culler.elements.add(cube);
cubes.push(cube);
}
}

🧹 Cleaning the Scene​

Now that we know how to create multiple cubes, we will write a function to remove the cubes from scene on demand. +resetCubes() iteratively removes the cubes using cube.removeFromParent.

function resetCubes() {
for (const cube of cubes) {
cube.removeFromParent();
}
cubes.length = 0;
}

📢 Rendering Cubes​

With everything ready, we will call regenerateCubes() which will generate cubes and add them to scene.

regenerateCubes();

Here comes the most crucial part! The core aim of ScreenCuller is to output just those components that are visible to the camera. culler.elements.needsUpdate = true instructs the ScreenCuller to render the updated view. Remember to update culler every time the camera is updated ❕ In this tutorial we are updating it each time the camera stops moving.

culler.elements.needsUpdate = true;
components.camera.controls.addEventListener("controlend", () => {
culler.elements.needsUpdate = true;
});

Great job! 🎉 Now you know how to optimise your 3D scene using a Screen Culler component! 💪 Your BIM app will now have unmatched performance and can render huge scenes easily. 🚀 -Let's keep it up and check out another tutorials!

- - +Let's keep it up and check out another tutorials!

+ + \ No newline at end of file diff --git a/build/Tutorials/ShadowDropper/index.html b/build/Tutorials/ShadowDropper/index.html index 415d61eb..07d02981 100644 --- a/build/Tutorials/ShadowDropper/index.html +++ b/build/Tutorials/ShadowDropper/index.html @@ -3,30 +3,30 @@ -ShadowDropper | That Open Docs - - +ShadowDropper | That Open Docs + + -
-
Skip to main content

ShadowDropper

🌒 Adding Realism​

Have you ever wondered what makes a scene look realistic? +

+

ShadowDropper

🌒 Adding Realism​

Have you ever wondered what makes a scene look realistic? Adding Shadow to 3D objects may quickly add depth to your creations.😎 In this tutorial, we'll show you how to use Shadow Dropper to quickly apply shadows. -In less than 5 minutes, you can create realistic shadows for all the meshes inside your scene.⏱️

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

🎲 Creating a Cube Mesh​

Let's start by adding a Cube, which we can dissect. +In less than 5 minutes, you can create realistic shadows for all the meshes inside your scene.⏱️

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

🎲 Creating a Cube Mesh​

Let's start by adding a Cube, which we can dissect. We will create a Cube with 3x3x3 dimensions and use red color for the material.

const cubeGeometry = new THREE.BoxGeometry(3, 3, 3);
const cubeMaterial = new THREE.MeshStandardMaterial({color: '#6528D7'});
const cube = new THREE.Mesh(cubeGeometry, cubeMaterial);
cube.position.set(0, 1.5, 0);

Now, we will add the Cube to the Scene. We must also add the cube to components.meshes, which is simply an array of all the meshes in the Scene 🗄️. -components.meshes acts as a store to help you manage your elements centrally.

scene.background = new THREE.Color("gray");
scene.add(cube);
components.meshes.add(cube);

🌚 Adding Beautiful Shadow​

This completes our scene setup. Let's now include Shadows, +components.meshes acts as a store to help you manage your elements centrally.

scene.background = new THREE.Color("gray");
scene.add(cube);
components.meshes.add(cube);

🌚 Adding Beautiful Shadow​

This completes our scene setup. Let's now include Shadows, we'll use ShadowDropper and pass components as an argument to it.🔗

const shadows = new OBC.ShadowDropper(components);

Shadow Dropper Component not only adds shadows to the scene, but it also helps you manage the Shadows. To obtain the required results, you can alter the ShadowDropper parameters.🔧

shadows.shadowExtraScaleFactor = 15;
shadows.darkness = 2;
shadows.shadowOffset = 0.1;
  • shadowExtraScalarFactor - With this, the shadow's area of impact can be adjusted.
  • darkness - This is used to increase or decrease the intensity of Shadow.
    SHADOW and realism ✨

    Read the Shadow Dropper API for more on this. -The Shadow Dropper API offers more configuration options to render realistic shadows.

🎨 Rendering Shadow​

Now, we will use Shadow Dropper to create shadows for the element. +The Shadow Dropper API offers more configuration options to render realistic shadows.

🎨 Rendering Shadow​

Now, we will use Shadow Dropper to create shadows for the element. We will use renderShadow() to generate shadow for the cube we created.

shadows.renderShadow([cube], "example");

renderShadow requires two parameter, the element and a shadowID. shadowID needs to be unique for the entire scene.

Deleting Shadows

❎ If you want to safely delete the shadow using shadowID you can call shadows.deleteShadow(shadowId);

Congratulations 🎉 on completing this tutorial! Now you can add shadows to BIM Models or any 3D Object in minutes using Shadow Dropper 🌗 -Let's keep it up and check out another tutorial! 🎓

- - +Let's keep it up and check out another tutorial! 🎓

+ + \ No newline at end of file diff --git a/build/Tutorials/Simple2DScene/index.html b/build/Tutorials/Simple2DScene/index.html index 3b0152be..3015f5cc 100644 --- a/build/Tutorials/Simple2DScene/index.html +++ b/build/Tutorials/Simple2DScene/index.html @@ -3,21 +3,21 @@ -Simple2DScene | That Open Docs - - +Simple2DScene | That Open Docs + + -
-
Skip to main content

Simple2DScene

🎨 Draw in 2D on top of 3D!​

The Simple2DScene component is an easy way to represent 2D data +

+

Simple2DScene

🎨 Draw in 2D on top of 3D!​

The Simple2DScene component is an easy way to represent 2D data using the same tools and API that you use for 3D. Using it is super simple: just create a new instance and you can start adding things to it!

Drawing 2D with THREE.js?

Yes! 2D is just a specific case of 3D. So we can use exactly the same libraries and tools to display 2D data easily.

The first step is to create a instance of the Simple2DScene component:

const simple2dScene = new OBC.Simple2DScene(components);

Great! Now we can start adding things to it, just like we would with the -3D scene. We will create a cube some lights and a grid: 💡🧊

const cube2 = new THREE.Mesh(boxGeometry, boxMaterial);
const scene2d = simple2dScene.get();
scene2d.add(cube2);
const directionalLight2 = new THREE.DirectionalLight();
directionalLight2.position.set(5, 10, 3);
directionalLight2.intensity = 0.5;
scene2d.add(directionalLight2);
const ambientLight2 = new THREE.AmbientLight();
ambientLight2.intensity = 0.5;
scene2d.add(ambientLight2);
const frustum = new THREE.Frustum();
const canvasUI = simple2dScene.uiElement.get('container');
const canvas = canvasUI.domElement;
// window.ondblclick = () => {
//  simple2dScene.scaleY += 0.1;
// }

💅 Creating the UI​

The Simple2DScene comes with a button to easily turn it on and off. +3D scene. We will create a cube some lights and a grid: 💡🧊

const cube2 = new THREE.Mesh(boxGeometry, boxMaterial);
const scene2d = simple2dScene.get();
scene2d.add(cube2);
const directionalLight2 = new THREE.DirectionalLight();
directionalLight2.position.set(5, 10, 3);
directionalLight2.intensity = 0.5;
scene2d.add(directionalLight2);
const ambientLight2 = new THREE.AmbientLight();
ambientLight2.intensity = 0.5;
scene2d.add(ambientLight2);
const frustum = new THREE.Frustum();
const canvasUI = simple2dScene.uiElement.get('container');
const canvas = canvasUI.domElement;
// window.ondblclick = () => {
//  simple2dScene.scaleY += 0.1;
// }

💅 Creating the UI​

The Simple2DScene comes with a button to easily turn it on and off. Let's create a simple toolbar and add it to the scene:

const mainWindow = new OBC.FloatingWindow(components);
components.ui.add(mainWindow);
mainWindow.visible = false;
mainWindow.domElement.style.height = '20rem';
mainWindow.addChild(simple2dScene.uiElement.get('container'));
mainWindow.onResized.add(() => simple2dScene.grid.regenerate());
components.renderer.onAfterUpdate.add(() => {
if (mainWindow.visible) {
simple2dScene.update();
}
});
mainWindow.slots.content.domElement.style.padding = '0';
mainWindow.slots.content.domElement.style.overflow = 'hidden';
mainWindow.onResized.add(() => {
const { width, height } = mainWindow.containerSize;
simple2dScene.setSize(height, width);
});
mainWindow.domElement.style.width = '20rem';
mainWindow.domElement.style.height = '20rem';
mainWindow.onVisible.add(() => {
if(mainWindow.visible) {
const { width, height } = mainWindow.containerSize;
simple2dScene.setSize(height, width);
simple2dScene.grid.regenerate()
}
})
const mainButton = new OBC.Button(components);
mainButton.materialIcon = 'fact_check';
mainButton.tooltip = '2D scene';
mainButton.onClick.add(() => {
mainWindow.visible = !mainWindow.visible;
});
const mainToolbar = new OBC.Toolbar(components);
components.ui.addToolbar(mainToolbar);
mainToolbar.addChild(mainButton);

That's it! Great work. Now you can easily draw 2D graphics with the same -API and expose them to your end users. 🥳

- - +API and expose them to your end users. 🥳

+ + \ No newline at end of file diff --git a/build/Tutorials/SimpleClipper/index.html b/build/Tutorials/SimpleClipper/index.html index a4363316..734fece1 100644 --- a/build/Tutorials/SimpleClipper/index.html +++ b/build/Tutorials/SimpleClipper/index.html @@ -3,36 +3,36 @@ -SimpleClipper | That Open Docs - - +SimpleClipper | That Open Docs + + -
-
Skip to main content

SimpleClipper

✂️ Clipping Tool​

The Clipping Tool is a powerful feature in 3D modelling that helps you dissect 3D objects. +

+

SimpleClipper

✂️ Clipping Tool​

The Clipping Tool is a powerful feature in 3D modelling that helps you dissect 3D objects. Clipping Tool is useful for inspecting and analyzing objects in detail.💪 In this tutorial, we will use the Clipping Tool to dissect a Cube using planes and transformation controls. -This tutorial will help you add Clipping functionality to your project easily.🚀

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

🎲 Creating a Cube Mesh​

Let's start by adding a Cube, which we can dissect. +This tutorial will help you add Clipping functionality to your project easily.🚀

First, let's set up a simple scene!

👀 If you haven't started there, check out that tutorial first!

🎲 Creating a Cube Mesh​

Let's start by adding a Cube, which we can dissect. We will create a Cube with 3x3x3 dimensions and use red color for the material.

const cubeGeometry = new THREE.BoxGeometry(3, 3, 3);
const cubeMaterial = new THREE.MeshStandardMaterial({color: '#6528D7'});
const cube = new THREE.Mesh(cubeGeometry, cubeMaterial);
cube.position.set(0, 1.5, 0);

Now, we will add the Cube to the Scene. We must also add the cube to components.meshes, -which is simply an array of all the meshes in the Scene 🗄️.

scene.add(cube);
components.meshes.add(cube);

⚙️ Adding Simple Clipper​

Here comes the interesting part, we will add a Simple Clipper to our scene 🥁 +which is simply an array of all the meshes in the Scene 🗄️.

scene.add(cube);
components.meshes.add(cube);

⚙️ Adding Simple Clipper​

Here comes the interesting part, we will add a Simple Clipper to our scene 🥁 A Simple Clipper requires two things: components and Simple Plane

const clipper = new OBC.SimpleClipper(components);
PLANE WITH TRANSFORMATION CONTROLS AND MORE

Simple Plane is useful in generating planes along with customizations.

SimpleClipper includes everything needed to provide clipping capabilities, including the ability to build numerous clipping planes. SimpleClipper also controls the SimplePlane internally, -allowing you to execute clipping on any 3D object by just dragging the planes.

clipper.enabled = true;

⏏️ Creating a Toolbar for the Clipper​

We'll make a Toolbar Component and set it at the bottom. -In addition, we will add a clipper button to this toolbar that will be used to toggle the clipping state.

const mainButton = clipper.uiElement.get("main");
const mainToolbar = new OBC.Toolbar(components, { name: 'Main Toolbar', position: 'bottom' });
mainToolbar.addChild(mainButton);
components.ui.addToolbar(mainToolbar);

🎛️ Check Toolbar and UIManager tutorial if you have any doubts!

🤝 Performing Clipping Events​

Now, we need a way to create a Clipping Plane on demand, you can do it with a Single Click or +allowing you to execute clipping on any 3D object by just dragging the planes.

clipper.enabled = true;

⏏️ Creating a Toolbar for the Clipper​

We'll make a Toolbar Component and set it at the bottom. +In addition, we will add a clipper button to this toolbar that will be used to toggle the clipping state.

const mainButton = clipper.uiElement.get("main");
const mainToolbar = new OBC.Toolbar(components, { name: 'Main Toolbar', position: 'bottom' });
mainToolbar.addChild(mainButton);
components.ui.addToolbar(mainToolbar);

🎛️ Check Toolbar and UIManager tutorial if you have any doubts!

🤝 Performing Clipping Events​

Now, we need a way to create a Clipping Plane on demand, you can do it with a Single Click or Double Click of a mouse. For this tutorial, we will use Double Click, to create a Clipper that will generate a plane on the 3D object's face.

container.ondblclick = () => clipper.create();
Raycaster below the hood 🎩

We use the Simple Raycaster to determine if the intersection has occurred. The clipper places a plane after detecting the face on which the mouse was clicked. -Here, the SimpleClipper handles everything for you 😎

🧹 Deleting the Clipping Planes​

Now that we know how to make multiple clippers, we must also know how to delete them when necessary. +Here, the SimpleClipper handles everything for you 😎

🧹 Deleting the Clipping Planes​

Now that we know how to make multiple clippers, we must also know how to delete them when necessary. Clipping planes can be removed using clipper.delete() or clipper.delete(plane), which deletes a single plane. clipper.delete() deletes the plane on which your mouse pointer is now located.

window.onkeydown = (event) => {
if (event.code === 'Delete' || event.code === 'Backspace') {
clipper.delete();
}
}
Delete all the Clipping Planes

❎ If you want to safely delete all the clipping planes that were created you can simply call clipper.deleteAll()

Congratulations 🎉 on completing this tutorial! Now you can inspect BIM Models or any 3D Object easily using Clipper Component 🧐 -Let's keep it up and check out another tutorial! 🎓

- - +Let's keep it up and check out another tutorial! 🎓

+ + \ No newline at end of file diff --git a/build/Tutorials/SimpleRaycaster/index.html b/build/Tutorials/SimpleRaycaster/index.html index 4ad0c17e..24d62ea8 100644 --- a/build/Tutorials/SimpleRaycaster/index.html +++ b/build/Tutorials/SimpleRaycaster/index.html @@ -3,26 +3,26 @@ -SimpleRaycaster | That Open Docs - - +SimpleRaycaster | That Open Docs + + -
-
Skip to main content

SimpleRaycaster

🤏 Touching things​

In this tutorial, we'll learn to interact with our scene. This will work both for a mouse 🐀 and for the touch +

+

SimpleRaycaster

🤏 Touching things​

In this tutorial, we'll learn to interact with our scene. This will work both for a mouse 🐀 and for the touch screen of a phone 📱 or tablet 🍎. This might sound daunting, but it's actually very easy! Let's see how to do that in 5 minutes.

First, let's set up a simple scene!

If you haven't started there, check out that tutorial first!

Next, we will add some objects to pick. We need 5 meshes that can share the same cube geometry -(as all the geometry of the cubes is the same).

const cubeMaterial = new THREE.MeshStandardMaterial({color: '#6528D7'});
const greenMaterial = new THREE.MeshStandardMaterial({color: '#BCF124'});
const boxGeometry = new THREE.BoxGeometry(3, 3, 3);
const cube1 = new THREE.Mesh(boxGeometry, cubeMaterial);
const cube2 = new THREE.Mesh(boxGeometry, cubeMaterial);
const cube3 = new THREE.Mesh(boxGeometry, cubeMaterial);
scene.add(cube1, cube2, cube3);
const cubes = [cube1, cube2, cube3];

Let's give the cubes a different position so that we can see all of them in the scene:

cube2.position.x = 5;
cube3.position.x = -5;

🔄 Spinning up the cubes​

To spice things up a little, let's create an animation loop that rotates the cubes each frame. You can do this super +(as all the geometry of the cubes is the same).

const cubeMaterial = new THREE.MeshStandardMaterial({color: '#6528D7'});
const greenMaterial = new THREE.MeshStandardMaterial({color: '#BCF124'});
const boxGeometry = new THREE.BoxGeometry(3, 3, 3);
const cube1 = new THREE.Mesh(boxGeometry, cubeMaterial);
const cube2 = new THREE.Mesh(boxGeometry, cubeMaterial);
const cube3 = new THREE.Mesh(boxGeometry, cubeMaterial);
scene.add(cube1, cube2, cube3);
const cubes = [cube1, cube2, cube3];

Let's give the cubes a different position so that we can see all of them in the scene:

cube2.position.x = 5;
cube3.position.x = -5;

🔄 Spinning up the cubes​

To spice things up a little, let's create an animation loop that rotates the cubes each frame. You can do this super easily by creating a function and adding it to the beforeUpdate event of the RendererComponent inside Components using the on() method:

const oneDegree = Math.PI / 180;
function rotateCubes() {
cube1.rotation.x += oneDegree;
cube1.rotation.y += oneDegree;
cube2.rotation.x += oneDegree;
cube2.rotation.z += oneDegree;
cube3.rotation.y += oneDegree;
cube3.rotation.z += oneDegree;
}
components.renderer.onBeforeUpdate.add(rotateCubes);
Turning off animations

You can turn off animations simply by using the off() method. This works for any event -in the library! ⌚

⚡ Casting rays around​

Finally, we will use the raycaster. This is very easy using the +in the library! ⌚

⚡ Casting rays around​

Finally, we will use the raycaster. This is very easy using the raycaster component, which solves this for all screen sizes. We will create an event that fires every time that the user moves the mouse. 👇

How does it really work?

We will simply reset the material of the previous selection (if it exists), and then apply the green material to the found object (if any). This might sound like a lot, but it's actually very little code. 😉

let previousSelection;
window.onmousemove = () => {
const result = components.raycaster.castRay(cubes);
if (previousSelection) {
previousSelection.material = cubeMaterial;
}
if (!result) {
return;
}
result.object.material = greenMaterial;
previousSelection = result.object;
}

Great job! 🎉 Now you know how to pick geometry in your 3D scene using a raycaster component component! 💪 You are now one step closer -to build your own BIM software. Let's keep it up and check out another tutorials!

- - +to build your own BIM software. Let's keep it up and check out another tutorials!

+ + \ No newline at end of file diff --git a/build/Tutorials/SimpleScene/index.html b/build/Tutorials/SimpleScene/index.html index f7c92692..d52e34e2 100644 --- a/build/Tutorials/SimpleScene/index.html +++ b/build/Tutorials/SimpleScene/index.html @@ -3,19 +3,19 @@ -SimpleScene | That Open Docs - - +SimpleScene | That Open Docs + + -
-
Skip to main content

SimpleScene

🌍 Let's create a 3D world!​

The SimpleScene component is the easiest way to create a 3D space to start working. +

+

SimpleScene

🌍 Let's create a 3D world!​

The SimpleScene component is the easiest way to create a 3D space to start working. Let's start by importing Components and Three.js:

import * as THREE from 'three';
import * as OBC from 'openbim-components';

Now, the first step is getting a container for our viewer. 📦 This is just a place where the 3D scene will be rendered. In this example we have just added an HTML div element with the ID "container".

const container = document.getElementById('container');

Now, let's create an awesome 3D scene inside that HTML element! 🔥

Are you using a library/framework like React, Angular or vue?

Then probably you have other mechanisms for getting a reference to the HTML div element. However you do it, as long as you get a reference -in your code, you are good to go!

🧰 Setting up a components project​

Next, we will instantiate the main object of the library: Components. 🤖 +in your code, you are good to go!

🧰 Setting up a components project​

Next, we will instantiate the main object of the library: Components. 🤖 This object will keep track of all the components that you create, making them easily accessible in all your application and making sure to update them in each frame, so you don't have to worry about that. 💪

The minimum components application

Any components app needs 4 things to work:

  • 🌍 A scene component where our objects will live in 3D.
  • ⌚ A renderer component that allows us to see things moving around.
  • 🎥 A camera component that defines where we are and in that 3D world.
  • ⚡ A raycaster component that makes it possible to interact with @@ -24,15 +24,15 @@ animation loop: 🚗💨💨💨

    components.init();

    And that's it! You already have set up 3D scene that can run on any device. Easy, right? 🥳 But right now or scene is not very interesting, as it's only a infinite white void. Let's add some things to it! First, we need a reference to the scene, which you can get with the get() method. This method is present in all the components and is used to -get the core of the component. We can do it like this:

    const scene = components.scene.get();

    🎥 Adjusting scene and camera​

    Great! Now we will locate the camera in a nice starting position. We can control the SimpleCamera component through its +get the core of the component. We can do it like this:

    const scene = components.scene.get();

    🎥 Adjusting scene and camera​

    Great! Now we will locate the camera in a nice starting position. We can control the SimpleCamera component through its controls attribute. This object is an instance of the camera-controls library, which makes it super easy to control the camera in our 3D scene. We will set the position of the camera -to [10, 10, 10] and make it look at the origin ([0, 0, 0]).

    components.camera.controls.setLookAt(10, 10, 10, 0, 0, 0);

    🏀 Adding some 3D objects​

    Awesome! We are now ready to start adding some objects. First, we will add a +to [10, 10, 10] and make it look at the origin ([0, 0, 0]).

    components.camera.controls.setLookAt(10, 10, 10, 0, 0, 0);

    🏀 Adding some 3D objects​

    Awesome! We are now ready to start adding some objects. First, we will add a simple grid component. As the name implies, this component adds a simple 2D grid to the scene that we can use as a reference.

    const grid = new OBC.SimpleGrid(components);

    🚀 Also, let's add some real geometry to our small 3D app. All the components are built on top of Three.js, which means that Three.js code will work natively with them. This is great, because you can easily integrate components with any 3D app that you create. -Let's try it by adding a simple cube:

    const boxMaterial = new THREE.MeshStandardMaterial({ color: '#6528D7' });
    const boxGeometry = new THREE.BoxGeometry(3, 3, 3);
    const cube = new THREE.Mesh(boxGeometry, boxMaterial);
    cube.position.set(0, 1.5, 0);
    scene.add(cube);

    🔦 Lighting things up​

    Of course, everything is black because we have no lights! Let's fix it by adding some basic illumination:

    components.scene.setup();

    🧹 Cleaning up​

    As you might now, JavaScript has an automatic garbage collector that gets rid of the variables that you are no longer +Let's try it by adding a simple cube:

    const boxMaterial = new THREE.MeshStandardMaterial({ color: '#6528D7' });
    const boxGeometry = new THREE.BoxGeometry(3, 3, 3);
    const cube = new THREE.Mesh(boxGeometry, boxMaterial);
    cube.position.set(0, 1.5, 0);
    scene.add(cube);

    🔦 Lighting things up​

    Of course, everything is black because we have no lights! Let's fix it by adding some basic illumination:

    components.scene.setup();
    const label = new OBC.Simple2DMarker(components);
    label.get().position.set(0, 4, 0);
    label.get().element.textContent = 'Hello, Components!';
    label.get().element.addEventListener('pointerdown', () => {
    console.log('Hello, Components!');
    });

    🧹 Cleaning up​

    As you might now, JavaScript has an automatic garbage collector that gets rid of the variables that you are no longer using. Unfortunately, that's not the case for Three.js. But don't worry: components takes care of this for you. When you are finished working with a Components instance, simply call @@ -40,8 +40,8 @@ Components instance or this won't work, because JavaScript will detect that you are still using it!

Using React, Angular, Vue...?

This topic is especially relevant in Single Page Application technologies because they never reload the page (which would release all the memory automatically). If you are using some of these, make sure that you set up the disposing logic to fire when you re-render the component that has the 3D app.

And voilà! You have made your first 3D application using components. Easy, right? Of course, this is still far from a -full-fledged BIM app, but don't worry! Keep following our tutorials and your app will go from zero to hero in no time! 🚀

- - +full-fledged BIM app, but don't worry! Keep following our tutorials and your app will go from zero to hero in no time! 🚀

+ + \ No newline at end of file diff --git a/build/Tutorials/ToolsComponent/index.html b/build/Tutorials/ToolsComponent/index.html index c82127c6..00758f27 100644 --- a/build/Tutorials/ToolsComponent/index.html +++ b/build/Tutorials/ToolsComponent/index.html @@ -3,18 +3,18 @@ -ToolsComponent | That Open Docs - - +ToolsComponent | That Open Docs + + -
-
Skip to main content

ToolsComponent

🍱 Keeping things tidy​

BIM applications are complex and can have a lot of different functionalities. We distinguish between 2 types of +

+

ToolsComponent

🍱 Keeping things tidy​

BIM applications are complex and can have a lot of different functionalities. We distinguish between 2 types of functionalities:

  • Components: self-contained pieces of logic that can be used to create tools.
  • Tools: Features for the end user. They are unique and accessible from anywhere. For example: the EdgesClipper of this library is a tool, and it can create, edit and destroy clipping planes. Each clipping plane is a component.
    Why unique? 🤔

    Tools are unique because you generally want one object to handle a specific feature. That way, we foster the single responsibility principle. That means that each tool has an UUID (Universal Unique ID).

    Luckily, there's an easy way to handle this: the Tools Component! -This component has two purposes:
  • Making your components available anywhere in your application.
  • Getting your tools from That Open Platform.

✨ Components anywhere​

First, we will create a very simple tool: a simple grid component. It's not +This component has two purposes:

  • Making your components available anywhere in your application.
  • Getting your tools from That Open Platform.

    • ✨ Components anywhere​

    First, we will create a very simple tool: a simple grid component. It's not very exciting, but we don't want to distract you with the fanciness of more complex tools! This same workflow will work for any other component that you use. First, let's instantiate it:

    const grid = new OBC.SimpleGrid(components);

    Now, it is likely that your application will have many menus. What if you need access to this component in many @@ -24,14 +24,14 @@ component as an argument. That's it! 👇

    const simpleGrid = await components.tools.get(OBC.SimpleGrid);
    Psst... it get's even easier! 🧠

    You don't even need to instantiate the tool yourself. You can simply call components.tools.get and if the component was not instantiated, the library will instantiate it for you! keep in mind that tools are designed to be singletons, so you should never create more than one instance of a tool.

    The components library will also take care of releasing the memory of all the tools you create as soon as you call -components.dispose().

    ⛅ Tools from the cloud​

    Maybe you have uploaded some tools to That Open Platform and want to easily share them with someone. Or maybe you +components.dispose().

    ⛅ Tools from the cloud​

    Maybe you have uploaded some tools to That Open Platform and want to easily share them with someone. Or maybe you have got some nice tools in That Open Store and want to use them in your app. Either way, using these components is a piece of cake with ToolComponent!

    What's That Open Platform?

    That Open Platform is a place where people can share and make money from their tools. You can learn more about how to get started right here.

    For example, let's fetch an example tool from the platform and add it to a simple toolbar. This is a simple tool that just logs a message to the console:

    components.tools.init(OBC);
    components.tools.token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1IjoiNjUwNmYyZjk0NWM4YmM2YTk0Mzg0NjM4IiwiYSI6IjY1MDhhN2VjZGZjYTQ5Mjc2MmE0YjFlZiJ9.Rr7bq9qJdm4pRUnXF0pUt9QhrtJLOS6koVyZMcf5XoU";
    const toolID = "50301542-4c0b-42ca-b2b4-066d45ca6735";
    const tool = await components.tools.getPlatformComponent(toolID);
    const button = tool.uiElement.get("Measure");
    button.materialIcon = "straighten";
    const toolbar = new OBC.Toolbar(components);
    components.ui.addToolbar(toolbar);
    toolbar.addChild(button);

    Fantastic work! 🎉🎉🎉 Now you know how to keep your Tools tidy and how to get them from the cloud. Another step forward in your journey to build your own BIM software. 🥳 Don't forget to check out That Open Platform if -you haven't already!

    - - +you haven't already!

    + + \ No newline at end of file diff --git a/build/Tutorials/UIManager/index.html b/build/Tutorials/UIManager/index.html index 9aa4f31b..95a87e89 100644 --- a/build/Tutorials/UIManager/index.html +++ b/build/Tutorials/UIManager/index.html @@ -3,42 +3,42 @@ -UIManager | That Open Docs - - +UIManager | That Open Docs + + -
    -
    Skip to main content

    UIManager

    🎛️ Making your user interactive​

    One of the most important things about making a BIM app is to give the user the ability to interact with the +

    +

    UIManager

    🎛️ Making your user interactive​

    One of the most important things about making a BIM app is to give the user the ability to interact with the functionalities you are creating 🚀. The catch is you need to create a decent user interface so your end-user is able to interact in an easy and intuitive way. While creating a simple set of buttons is not particularly difficult, we all agree is time-consuming ⏱️. This is where UI Components come to the rescue!

    Components, but for UI

    The UI Components are similar to the rest of the components of the library. The only difference is that their mission is to display an UI in HTML structures, including buttons, toolbars, menus, -windows, etc.

    🎨 Adding styles​

    The first step is to get the CSS file with the default styles. You can get it from ..................

    🧰 Creating a toolbar​

    We need buttons to allow the user to interact with our viewer. But even before that, we need a place to put them: this +windows, etc.

    🎨 Adding styles​

    The first step is to get the CSS file with the default styles. You can get it from ..................

    🧰 Creating a toolbar​

    We need buttons to allow the user to interact with our viewer. But even before that, we need a place to put them: this place is called a Toolbar. Creating and adding a Toolbar to the viewer is as simple as this:

    const mainToolbar = new OBC.Toolbar(components);
    mainToolbar.name = "Main toolbar";
    components.ui.addToolbar(mainToolbar);

    By default, the toolbar is added to the bottom 👇 of the viewer container, so you technically don't need to type position: "bootom" in the options argument of your toolbar, but we just did it so that you know you can change the toolbar position to either top, right, bottom or left.

    What about more complex layouts?

    You can create multiple toolbars in the same position, and the component just takes care about -stacking all toolbars nice and neat 🤯.

    🎢 Using existing UIs​

    If you are using components from this library or from the marketplace, you won't need to create any UI: components +stacking all toolbars nice and neat 🤯.

    🎢 Using existing UIs​

    If you are using components from this library or from the marketplace, you won't need to create any UI: components usually include ready-to-use menus so that you can add them to your app in seconds. These components implement the -UI Interface. Let's see them in action! 👇


    👨‍🎨 Creating your own UIs​

    Of course, UI Components can also be used stand-alone, either to build your own components or to add menus to your +UI Interface. Let's see them in action! 👇


    👨‍🎨 Creating your own UIs​

    Of course, UI Components can also be used stand-alone, either to build your own components or to add menus to your app very fast! Let's start with a simple one: a Button Component that sends an alert message. 🍼 To do so, we can simply add the following code:

    const alertButton = new OBC.Button(components);
    alertButton.materialIcon = "info";
    alertButton.tooltip = "Information";
    mainToolbar.addChild(alertButton);
    alertButton.onClick.add(() => {
    alert('I\'ve been clicked!');
    });
    Where do these cool icons come from?

    We are fetching the icons from material icons, a very popular icon repository. You can simply pass the name of the icon in materialIconName and the button will -display it! 🧨

    🌍 Preparing the scene​

    Of course, this UI is not very exciting, because it only adds a single button that throws an alert. But we can +display it! 🧨

    🌍 Preparing the scene​

    Of course, this UI is not very exciting, because it only adds a single button that throws an alert. But we can do much more with UI components. Let's build a menu that creates and deletes geometry in our scene! We will make a simple tool that creates and delete boxes from the scene. First, we'll need to define basic information of the -boxes. We will also create a super simple function to get a random number within a given limit:

    const boxes = [];
    const boxGeometry = new THREE.BoxGeometry();
    const boxMaterial = new THREE.MeshLambertMaterial({ color: '#6528D7' });

    🔢 Next, let's define some simple functions. To create a random number:

    function getRandomNumber(limit) {
    return Math.random() * limit;
    }

    ✅📦 To delete a box from the scene:

    function createBox() {
    const mesh = new THREE.Mesh(boxGeometry, boxMaterial);
    scene.add(mesh);
    mesh.position.x = getRandomNumber(10);
    mesh.position.y = getRandomNumber(10);
    mesh.position.z = getRandomNumber(10);
    boxes.push(mesh);
    }

    ❎📦 To delete a box from the scene:

    function deleteBox() {
    if(!boxes.length) return;
    const box = boxes.pop();
    box.removeFromParent();
    }

    ❎📦📦📦 To delete all existing boxes:

    function deleteAllBoxes() {
    const count = boxes.length;
    for(let i = 0; i < count; i++) {
    deleteBox();
    }
    }

    🔄📦📦📦 And to animate all the boxes, so that our scene is more interesting:

    function animateBoxes() {
    const oneDegree = Math.PI / 180;
    for(const box of boxes) {
    box.rotation.x += oneDegree;
    box.rotation.y += oneDegree;
    box.rotation.z += oneDegree;
    }
    }
    components.renderer.onBeforeUpdate.add(animateBoxes);

    🌲 Composing menus​

    Buttons can be nested to build complex menus! For example, let's say that we want 3 buttons that add a box, delete a +boxes. We will also create a super simple function to get a random number within a given limit:

    const boxes = [];
    const boxGeometry = new THREE.BoxGeometry();
    const boxMaterial = new THREE.MeshLambertMaterial({ color: '#6528D7' });

    🔢 Next, let's define some simple functions. To create a random number:

    function getRandomNumber(limit) {
    return Math.random() * limit;
    }

    ✅📦 To delete a box from the scene:

    function createBox() {
    const mesh = new THREE.Mesh(boxGeometry, boxMaterial);
    scene.add(mesh);
    mesh.position.x = getRandomNumber(10);
    mesh.position.y = getRandomNumber(10);
    mesh.position.z = getRandomNumber(10);
    boxes.push(mesh);
    }

    ❎📦 To delete a box from the scene:

    function deleteBox() {
    if(!boxes.length) return;
    const box = boxes.pop();
    box.removeFromParent();
    }

    ❎📦📦📦 To delete all existing boxes:

    function deleteAllBoxes() {
    const count = boxes.length;
    for(let i = 0; i < count; i++) {
    deleteBox();
    }
    }

    🔄📦📦📦 And to animate all the boxes, so that our scene is more interesting:

    function animateBoxes() {
    const oneDegree = Math.PI / 180;
    for(const box of boxes) {
    box.rotation.x += oneDegree;
    box.rotation.y += oneDegree;
    box.rotation.z += oneDegree;
    }
    }
    components.renderer.onBeforeUpdate.add(animateBoxes);

    🌲 Composing menus​

    Buttons can be nested to build complex menus! For example, let's say that we want 3 buttons that add a box, delete a box and delete all boxes respectively. We want to organize these menus together, so let's start by creating a button that will contain the rest:

    const cubeTools = new OBC.Button(components);
    cubeTools.materialIcon = "widgets";
    cubeTools.tooltip = "Tools";
    mainToolbar.addChild(cubeTools);

    Let's start with the button to create boxes. This buttons needs a couple of extra things:

    • A label so that it displays the text.
    • An onClick event so that the function createBox is triggered after pressing the button.
    const createCubeButton = new OBC.Button(components);
    createCubeButton.materialIcon = "add_box";
    createCubeButton.label = "Create box";
    createCubeButton.onClick.add(() => createBox());
    cubeTools.addChild(createCubeButton);

    Now, let's go with the "delete single" and "delete all buttons" buttons. Both are related, so we will group them together (yes, multiple-level nesting is allowed!). So first, let's create the parent button:

    const deleteCubeButtons = new OBC.Button(components);
    deleteCubeButtons.materialIcon = "disabled_by_default";
    deleteCubeButtons.label = "Delete box";
    cubeTools.addChild(deleteCubeButtons);

    Next, the "delete single" button:

    const deleteSingleCubeButton = new OBC.Button(components, {
    materialIconName: 'disabled_by_default',
    name: 'Single',
    closeOnClick: false
    });
    deleteSingleCubeButton.onClick.add(() => deleteBox());
    deleteCubeButtons.addChild(deleteSingleCubeButton);

    And finally the "delete all" button:

    const deleteAllCubesButton = new OBC.Button(components);
    deleteAllCubesButton.materialIcon = "disabled_by_default";
    deleteAllCubesButton.label = "All";
    deleteAllCubesButton.onClick.add(() => deleteAllBoxes());
    deleteCubeButtons.addChild(deleteAllCubesButton);

    And this is it! Easy, right? You can now create add menus to your components and easily share them with other -BIM software developers!

    🐁 Context menu​

    There's a special menu that is used in menu BIM applications: the context menu! You know, that menu that shows up +BIM software developers!

    🐁 Context menu​

    There's a special menu that is used in menu BIM applications: the context menu! You know, that menu that shows up when you right-click somewhere. Don't worry, this is also supported by UI Components! The UI Manager has a default Toolbar that is already set up as a context menu. All the nesting logic mentioned before works here as well:

    const contextDeleteButtons = new OBC.Button(components);
    contextDeleteButtons.materialIcon = 'widgets';
    contextDeleteButtons.label = "Delete";
    const deleteAllCubesContextButton = new OBC.Button(components);
    deleteAllCubesContextButton.materialIcon = "widgets";
    deleteAllCubesContextButton.label = "All cubes";
    deleteAllCubesContextButton.onClick.add(() => deleteAllBoxes());
    contextDeleteButtons.addChild(deleteAllCubesContextButton);
    components.ui.contextMenu.addChild(contextDeleteButtons);

    And this is it! 🥳 Cool, right? Now you can easily use the UI elements in the components of this library and the marketplace, as well as create your own custom menus in minutes. 💪🎨 You are now one step closer to create your -BIM applications from scratch. 🔥

    - - +BIM applications from scratch. 🔥

    + + \ No newline at end of file diff --git a/build/api/classes/bim_fragment.Serializer/index.html b/build/api/classes/bim_fragment.Serializer/index.html deleted file mode 100644 index 9d84393d..00000000 --- a/build/api/classes/bim_fragment.Serializer/index.html +++ /dev/null @@ -1,17 +0,0 @@ - - - - - -Class: Serializer | That Open Docs - - - - -
    -
    Skip to main content

    Class: Serializer

    bim-fragment.Serializer

    Object to export and import sets of fragments efficiently using the library -flatbuffers.

    - - - - \ No newline at end of file diff --git a/build/api/classes/openbim_components.BaseRenderer/index.html b/build/api/classes/openbim_components.BaseRenderer/index.html index 72f0e08c..3ea852d2 100644 --- a/build/api/classes/openbim_components.BaseRenderer/index.html +++ b/build/api/classes/openbim_components.BaseRenderer/index.html @@ -3,24 +3,24 @@ -Class: BaseRenderer | That Open Docs - - +Class: BaseRenderer | That Open Docs + + -
    -
    Skip to main content

    Class: BaseRenderer

    openbim-components.BaseRenderer

    A base component for other components whose main mission is to render a -scene.

    No Inherit Doc

    Hierarchy​

    Implements​

    Properties​

    clippingPlanes​

    • clippingPlanes: Plane[] = []

    The list of clipping planes used by this -instance of the renderer.

    Defined in​

    temp/engine_components/src/base-types/base-renderer.ts:33

    enabled​

    • Abstract enabled: boolean

    Whether this component is active or not. The behaviour can vary depending +

    +

    Class: BaseRenderer

    openbim-components.BaseRenderer

    A base component for other components whose main mission is to render a +scene.

    No Inherit Doc

    Hierarchy​

    Implements​

    Properties​

    clippingPlanes​

    • clippingPlanes: Plane[] = []

    The list of clipping planes used by this +instance of the renderer.

    Defined in​

    src/base-types/base-renderer.ts:33

    enabled​

    • Abstract enabled: boolean

    Whether this component is active or not. The behaviour can vary depending on the type of component. E.g. a disabled dimension tool will stop creating dimensions, while a disabled camera will stop moving. A disabled component -will not be updated automatically each frame.

    Inherited from​

    Component.enabled

    Defined in​

    temp/engine_components/src/base-types/component.ts:24

    onClippingPlanesUpdated​

    • Readonly onClippingPlanesUpdated: Event<unknown>

    Event that fires when there has been a change to the list of clipping -planes used by the active renderer.

    Defined in​

    temp/engine_components/src/base-types/base-renderer.ts:27

    onResize​

    • Readonly onResize: Event<any>

    Resizeable.onResize

    Implementation of​

    Resizeable.onResize

    Defined in​

    temp/engine_components/src/base-types/base-renderer.ts:21

    Methods​

    get​

    ▸ get(...args): WebGLRenderer

    The core of the component. For instance, if it's a camera component, it -could be a THREE.Camera.

    Parameters​

    NameType
    ...argsany

    Returns​

    WebGLRenderer

    Inherited from​

    Component.get

    Defined in​

    temp/engine_components/src/base-types/component.ts:30

    getSize​

    ▸ getSize(): Vector2

    Resizeable.getSize.

    Returns​

    Vector2

    Implementation of​

    Resizeable.getSize

    Defined in​

    temp/engine_components/src/base-types/base-renderer.ts:15

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    resize​

    ▸ resize(): void

    Resizeable.resize.

    Returns​

    void

    Implementation of​

    Resizeable.resize

    Defined in​

    temp/engine_components/src/base-types/base-renderer.ts:18

    togglePlane​

    ▸ togglePlane(active, plane, isLocal?): void

    Adds or removes a +will not be updated automatically each frame.

    Inherited from​

    Component.enabled

    Defined in​

    src/base-types/component.ts:24

    onClippingPlanesUpdated​

    • Readonly onClippingPlanesUpdated: Event<unknown>

    Event that fires when there has been a change to the list of clipping +planes used by the active renderer.

    Defined in​

    src/base-types/base-renderer.ts:27

    onResize​

    • Readonly onResize: Event<any>

    Resizeable.onResize

    Implementation of​

    Resizeable.onResize

    Defined in​

    src/base-types/base-renderer.ts:21

    Methods​

    get​

    ▸ get(...args): WebGLRenderer

    The core of the component. For instance, if it's a camera component, it +could be a THREE.Camera.

    Parameters​

    NameType
    ...argsany

    Returns​

    WebGLRenderer

    Inherited from​

    Component.get

    Defined in​

    src/base-types/component.ts:30

    getSize​

    ▸ getSize(): Vector2

    Resizeable.getSize.

    Returns​

    Vector2

    Implementation of​

    Resizeable.getSize

    Defined in​

    src/base-types/base-renderer.ts:15

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    src/base-types/component.ts:45

    resize​

    ▸ resize(): void

    Resizeable.resize.

    Returns​

    void

    Implementation of​

    Resizeable.resize

    Defined in​

    src/base-types/base-renderer.ts:18

    togglePlane​

    ▸ togglePlane(active, plane, isLocal?): void

    Adds or removes a clipping plane -to the renderer.

    Parameters​

    NameType
    activeboolean
    planePlane
    isLocal?boolean

    Returns​

    void

    Defined in​

    temp/engine_components/src/base-types/base-renderer.ts:48

    updateClippingPlanes​

    ▸ updateClippingPlanes(): Promise<void>

    Forces the update of the clipping planes and all components that depend -on them that are subscribed to onClippingPlanesUpdated.

    Returns​

    Promise<void>

    Defined in​

    temp/engine_components/src/base-types/base-renderer.ts:39

    - - +to the renderer.

    Parameters​

    NameType
    activeboolean
    planePlane
    isLocal?boolean

    Returns​

    void

    Defined in​

    src/base-types/base-renderer.ts:48

    updateClippingPlanes​

    ▸ updateClippingPlanes(): Promise<void>

    Forces the update of the clipping planes and all components that depend +on them that are subscribed to onClippingPlanesUpdated.

    Returns​

    Promise<void>

    Defined in​

    src/base-types/base-renderer.ts:39

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.CloudStorage/index.html b/build/api/classes/openbim_components.CloudStorage/index.html index c3bce4f3..d9e222ac 100644 --- a/build/api/classes/openbim_components.CloudStorage/index.html +++ b/build/api/classes/openbim_components.CloudStorage/index.html @@ -3,16 +3,16 @@ -Class: CloudStorage | That Open Docs - - +Class: CloudStorage | That Open Docs + + -
    -
    Skip to main content

    Class: CloudStorage

    openbim-components.CloudStorage

    An object to easily use the services of That Open Platform.

    Hierarchy​

    Properties​

    enabled​

    • enabled: boolean = true

    Component.enabled

    Overrides​

    Component.enabled

    Defined in​

    temp/engine_components/src/services/CloudStorage/index.ts:18

    name​

    • name: string = "CloudProcessor"

    Component.name

    Defined in​

    temp/engine_components/src/services/CloudStorage/index.ts:15

    Accessors​

    token​

    • get token(): string

    The authentication token generated in -That Open Platform

    Returns​

    string

    Defined in​

    temp/engine_components/src/services/CloudStorage/index.ts:50

    • set token(value): void

    The authentication token generated in -That Open Platform

    Parameters​

    NameType
    valuestring

    Returns​

    void

    Defined in​

    temp/engine_components/src/services/CloudStorage/index.ts:61

    Methods​

    get​

    ▸ get(): any[]

    Retrieves a tool component by its name.

    Returns​

    any[]

    Overrides​

    Component.get

    Defined in​

    temp/engine_components/src/services/CloudStorage/index.ts:42

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    - - +
    +
    Skip to main content

    Class: CloudStorage

    openbim-components.CloudStorage

    An object to easily use the services of That Open Platform.

    Hierarchy​

    Properties​

    enabled​

    • enabled: boolean = true

    Component.enabled

    Overrides​

    Component.enabled

    Defined in​

    src/services/CloudStorage/index.ts:18

    name​

    • name: string = "CloudProcessor"

    Component.name

    Defined in​

    src/services/CloudStorage/index.ts:15

    Accessors​

    token​

    • get token(): string

    The authentication token generated in +That Open Platform

    Returns​

    string

    Defined in​

    src/services/CloudStorage/index.ts:50

    • set token(value): void

    The authentication token generated in +That Open Platform

    Parameters​

    NameType
    valuestring

    Returns​

    void

    Defined in​

    src/services/CloudStorage/index.ts:61

    Methods​

    get​

    ▸ get(): any[]

    Retrieves a tool component by its name.

    Returns​

    any[]

    Overrides​

    Component.get

    Defined in​

    src/services/CloudStorage/index.ts:42

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    src/base-types/component.ts:45

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.Component/index.html b/build/api/classes/openbim_components.Component/index.html index cb240fc7..53c96765 100644 --- a/build/api/classes/openbim_components.Component/index.html +++ b/build/api/classes/openbim_components.Component/index.html @@ -3,21 +3,21 @@ -Class: Component<Type> | That Open Docs - - +Class: Component<Type> | That Open Docs + + -
    -
    Skip to main content

    Class: Component<Type>

    openbim-components.Component

    Components are the building blocks of this library. Everything is a +

    +

    Class: Component<Type>

    openbim-components.Component

    Components are the building blocks of this library. Everything is a component: tools, scenes, objects, cameras, etc. All components must inherit from this class. The Type parameter defines -the type of the core of this component. For instance, a component containing a

    Type parameters​

    Name
    Type

    Hierarchy​

    Properties​

    enabled​

    • Abstract enabled: boolean

    Whether this component is active or not. The behaviour can vary depending +the type of the core of this component. For instance, a component containing a

    Type parameters​

    Name
    Type

    Hierarchy​

    Properties​

    enabled​

    • Abstract enabled: boolean

    Whether this component is active or not. The behaviour can vary depending on the type of component. E.g. a disabled dimension tool will stop creating dimensions, while a disabled camera will stop moving. A disabled component -will not be updated automatically each frame.

    Defined in​

    temp/engine_components/src/base-types/component.ts:24

    Methods​

    get​

    ▸ get(...args): Type

    The core of the component. For instance, if it's a camera component, it -could be a THREE.Camera.

    Parameters​

    NameType
    ...argsany

    Returns​

    Type

    Defined in​

    temp/engine_components/src/base-types/component.ts:30

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    - - +will not be updated automatically each frame.

    Defined in​

    src/base-types/component.ts:24

    Methods​

    get​

    ▸ get(...args): Type

    The core of the component. For instance, if it's a camera component, it +could be a THREE.Camera.

    Parameters​

    NameType
    ...argsany

    Returns​

    Type

    Defined in​

    src/base-types/component.ts:30

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Defined in​

    src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Defined in​

    src/base-types/component.ts:45

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.Components/index.html b/build/api/classes/openbim_components.Components/index.html index b74d60ff..fbfc1411 100644 --- a/build/api/classes/openbim_components.Components/index.html +++ b/build/api/classes/openbim_components.Components/index.html @@ -3,33 +3,33 @@ -Class: Components | That Open Docs - - +Class: Components | That Open Docs + + -
    -
    Skip to main content

    Class: Components

    openbim-components.Components

    The entry point of Open BIM Components. +

    +

    Class: Components

    openbim-components.Components

    The entry point of Open BIM Components. It contains the basic items to create a BIM 3D scene based on Three.js, as well as all the tools provided by this library. It also manages the update -loop of everything. Each instance has to be initialized with init.

    Implements​

    Properties​

    meshes​

    • Readonly meshes: Set<Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>>

    All the loaded meshes. -This includes fragments, 3D scans, etc.

    Defined in​

    temp/engine_components/src/core/Components/index.ts:29

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    temp/engine_components/src/core/Components/index.ts:38

    onInitialized​

    • Readonly onInitialized: Event<Components>

    Event that fires when this instance has been fully initialized and is -ready to work (scene, camera and renderer are ready).

    Defined in​

    temp/engine_components/src/core/Components/index.ts:35

    tools​

    • Readonly tools: ToolComponent

    ToolComponent

    Defined in​

    temp/engine_components/src/core/Components/index.ts:23

    uiEnabled​

    • uiEnabled: boolean = true

    Whether UI components should be created.

    Defined in​

    temp/engine_components/src/core/Components/index.ts:45

    Accessors​

    camera​

    • get camera(): Component<Camera>

    The Three.js camera -that determines the point of view of the renderer.

    Returns​

    Component<Camera>

    Defined in​

    temp/engine_components/src/core/Components/index.ts:103

    • set camera(camera): void

    This needs to be initialized before calling init().

    Parameters​

    NameType
    cameraComponent<Camera>

    Returns​

    void

    Defined in​

    temp/engine_components/src/core/Components/index.ts:113

    raycaster​

    • get raycaster(): BaseRaycaster

    A component using the Three.js raycaster -used primarily to pick 3D items with the mouse or a touch screen.

    Returns​

    BaseRaycaster

    Defined in​

    temp/engine_components/src/core/Components/index.ts:121

    • set raycaster(raycaster): void

    Although this is not necessary to make the library work, it's necessary -to initialize this if any component that needs a raycaster is used.

    Parameters​

    NameType
    raycasterBaseRaycaster

    Returns​

    void

    Defined in​

    temp/engine_components/src/core/Components/index.ts:132

    renderer​

    • get renderer(): BaseRenderer

    The Three.js renderer +loop of everything. Each instance has to be initialized with init.

    Implements​

    Properties​

    meshes​

    • Readonly meshes: Set<Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>>

    All the loaded meshes. +This includes fragments, 3D scans, etc.

    Defined in​

    src/core/Components/index.ts:29

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    src/core/Components/index.ts:38

    onInitialized​

    • Readonly onInitialized: Event<Components>

    Event that fires when this instance has been fully initialized and is +ready to work (scene, camera and renderer are ready).

    Defined in​

    src/core/Components/index.ts:35

    tools​

    • Readonly tools: ToolComponent

    ToolComponent

    Defined in​

    src/core/Components/index.ts:23

    uiEnabled​

    • uiEnabled: boolean = true

    Whether UI components should be created.

    Defined in​

    src/core/Components/index.ts:45

    Accessors​

    camera​

    • get camera(): Component<Camera>

    The Three.js camera +that determines the point of view of the renderer.

    Returns​

    Component<Camera>

    Defined in​

    src/core/Components/index.ts:103

    • set camera(camera): void

    This needs to be initialized before calling init().

    Parameters​

    NameType
    cameraComponent<Camera>

    Returns​

    void

    Defined in​

    src/core/Components/index.ts:113

    raycaster​

    • get raycaster(): BaseRaycaster

    A component using the Three.js raycaster +used primarily to pick 3D items with the mouse or a touch screen.

    Returns​

    BaseRaycaster

    Defined in​

    src/core/Components/index.ts:121

    • set raycaster(raycaster): void

    Although this is not necessary to make the library work, it's necessary +to initialize this if any component that needs a raycaster is used.

    Parameters​

    NameType
    raycasterBaseRaycaster

    Returns​

    void

    Defined in​

    src/core/Components/index.ts:132

    renderer​

    • get renderer(): BaseRenderer

    The Three.js renderer used to render the scene. This library provides multiple renderer -components with pre-made functionality (e.g. rendering of 2D CSS elements.

    Returns​

    BaseRenderer

    Defined in​

    temp/engine_components/src/core/Components/index.ts:67

    • set renderer(renderer): void

    This needs to be initialized before calling init().

    Parameters​

    NameType
    rendererBaseRenderer

    Returns​

    void

    Defined in​

    temp/engine_components/src/core/Components/index.ts:77

    scene​

    • get scene(): Component<Scene>

    The Three.js scene -where all the rendered items are placed.

    Returns​

    Component<Scene>

    Defined in​

    temp/engine_components/src/core/Components/index.ts:85

    • set scene(scene): void

    This needs to be initialized before calling init().

    Parameters​

    NameType
    sceneComponent<Scene>

    Returns​

    void

    Defined in​

    temp/engine_components/src/core/Components/index.ts:95

    ui​

    • get ui(): UIManager

    UIManager

    Returns​

    UIManager

    Defined in​

    temp/engine_components/src/core/Components/index.ts:55

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Disposes the memory of all the components and tools of this instance of +components with pre-made functionality (e.g. rendering of 2D CSS elements.

    Returns​

    BaseRenderer

    Defined in​

    src/core/Components/index.ts:67

    • set renderer(renderer): void

    This needs to be initialized before calling init().

    Parameters​

    NameType
    rendererBaseRenderer

    Returns​

    void

    Defined in​

    src/core/Components/index.ts:77

    scene​

    • get scene(): Component<Scene>

    The Three.js scene +where all the rendered items are placed.

    Returns​

    Component<Scene>

    Defined in​

    src/core/Components/index.ts:85

    • set scene(scene): void

    This needs to be initialized before calling init().

    Parameters​

    NameType
    sceneComponent<Scene>

    Returns​

    void

    Defined in​

    src/core/Components/index.ts:95

    ui​

    • get ui(): UIManager

    UIManager

    Returns​

    UIManager

    Defined in​

    src/core/Components/index.ts:55

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Disposes the memory of all the components and tools of this instance of the library. A memory leak will be created if:

    • An instance of the library ends up out of scope and this function isn't called. This is especially relevant in Single Page Applications (React, Angular, Vue, etc).

    • Any of the objects of this instance (meshes, geometries, etc) is referenced by a reference type (object or array).

    You can learn more about how Three.js handles memory leaks -here.

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    temp/engine_components/src/core/Components/index.ts:174

    init​

    ▸ init(): Promise<void>

    Initializes the library. It should be called at the start of the app after +here.

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    src/core/Components/index.ts:174

    init​

    ▸ init(): Promise<void>

    Initializes the library. It should be called at the start of the app after initializing the scene, the renderer and the camera. Additionally, if any component that need a raycaster is -used, the raycaster will need to be initialized.

    Returns​

    Promise<void>

    Defined in​

    temp/engine_components/src/core/Components/index.ts:148

    - - +used, the raycaster will need to be initialized.

    Returns​

    Promise<void>

    Defined in​

    src/core/Components/index.ts:148

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.CubeMap/index.html b/build/api/classes/openbim_components.CubeMap/index.html index 9a54bfd4..70144943 100644 --- a/build/api/classes/openbim_components.CubeMap/index.html +++ b/build/api/classes/openbim_components.CubeMap/index.html @@ -3,15 +3,15 @@ -Class: CubeMap | That Open Docs - - +Class: CubeMap | That Open Docs + + -
    -
    Skip to main content

    Class: CubeMap

    openbim-components.CubeMap

    A simple navigation cube to zoom the scene to its basic views (top, bottom, -left, right, back and front).

    Hierarchy​

    Implements​

    Properties​

    enabled​

    • enabled: boolean = true

    Component.enabled

    Overrides​

    Component.enabled

    Defined in​

    temp/engine_components/src/navigation/CubeMap/index.ts:40

    offset​

    • offset: number = 1

    The minimum zoom distance to the scene.

    Defined in​

    temp/engine_components/src/navigation/CubeMap/index.ts:49

    onAfterUpdate​

    • Readonly onAfterUpdate: Event<CubeMap>

    Updateable.onAfterUpdate

    Implementation of​

    Updateable.onAfterUpdate

    Defined in​

    temp/engine_components/src/navigation/CubeMap/index.ts:43

    onBeforeUpdate​

    • Readonly onBeforeUpdate: Event<CubeMap>

    Updateable.onBeforeUpdate

    Implementation of​

    Updateable.onBeforeUpdate

    Defined in​

    temp/engine_components/src/navigation/CubeMap/index.ts:46

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    temp/engine_components/src/navigation/CubeMap/index.ts:37

    Methods​

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    - - +
    +
    Skip to main content

    Class: CubeMap

    openbim-components.CubeMap

    A simple navigation cube to zoom the scene to its basic views (top, bottom, +left, right, back and front).

    Hierarchy​

    Implements​

    Properties​

    enabled​

    • enabled: boolean = true

    Component.enabled

    Overrides​

    Component.enabled

    Defined in​

    src/navigation/CubeMap/index.ts:40

    offset​

    • offset: number = 1

    The minimum zoom distance to the scene.

    Defined in​

    src/navigation/CubeMap/index.ts:49

    onAfterUpdate​

    • Readonly onAfterUpdate: Event<CubeMap>

    Updateable.onAfterUpdate

    Implementation of​

    Updateable.onAfterUpdate

    Defined in​

    src/navigation/CubeMap/index.ts:43

    onBeforeUpdate​

    • Readonly onBeforeUpdate: Event<CubeMap>

    Updateable.onBeforeUpdate

    Implementation of​

    Updateable.onBeforeUpdate

    Defined in​

    src/navigation/CubeMap/index.ts:46

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    src/navigation/CubeMap/index.ts:37

    Methods​

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    src/base-types/component.ts:45

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.Disposer/index.html b/build/api/classes/openbim_components.Disposer/index.html index c2104c9f..03fd5f2e 100644 --- a/build/api/classes/openbim_components.Disposer/index.html +++ b/build/api/classes/openbim_components.Disposer/index.html @@ -3,17 +3,17 @@ -Class: Disposer | That Open Docs - - +Class: Disposer | That Open Docs + + -
    -
    Skip to main content

    Class: Disposer

    openbim-components.Disposer

    A tool to safely remove meshes and geometries from memory to -prevent memory leaks.

    Hierarchy​

    Properties​

    enabled​

    • enabled: boolean = true

    Component.enabled

    Overrides​

    Component.enabled

    Defined in​

    temp/engine_components/src/core/Disposer/index.ts:14

    Methods​

    destroy​

    ▸ destroy(object, materials?, recursive?): void

    Removes a mesh, its geometry and its materials from memory. If you are +

    +

    Class: Disposer

    openbim-components.Disposer

    A tool to safely remove meshes and geometries from memory to +prevent memory leaks.

    Hierarchy​

    Properties​

    enabled​

    • enabled: boolean = true

    Component.enabled

    Overrides​

    Component.enabled

    Defined in​

    src/core/Disposer/index.ts:14

    Methods​

    destroy​

    ▸ destroy(object, materials?, recursive?): void

    Removes a mesh, its geometry and its materials from memory. If you are using any of these in other parts of the application, make sure that you -remove them from the mesh before disposing it.

    Parameters​

    NameTypeDefault valueDescription
    objectObject3D<Object3DEventMap>undefinedthe object to remove.
    materialsbooleantruewhether to dispose the materials of the mesh.
    recursivebooleantruewhether to recursively dispose the children of the mesh.

    Returns​

    void

    Defined in​

    temp/engine_components/src/core/Disposer/index.ts:43

    disposeGeometry​

    ▸ disposeGeometry(geometry): void

    Disposes a geometry from memory.

    Parameters​

    NameTypeDescription
    geometryBufferGeometry<NormalBufferAttributes>the geometry to remove.

    Returns​

    void

    Defined in​

    temp/engine_components/src/core/Disposer/index.ts:64

    get​

    ▸ get(): Set<string>

    Component.uuid.

    Returns​

    Set<string>

    the list of UUIDs of deleted components.

    Overrides​

    Component.get

    Defined in​

    temp/engine_components/src/core/Disposer/index.ts:27

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    - - +remove them from the mesh before disposing it.

    Parameters​

    NameTypeDefault valueDescription
    objectObject3D<Object3DEventMap>undefinedthe object to remove.
    materialsbooleantruewhether to dispose the materials of the mesh.
    recursivebooleantruewhether to recursively dispose the children of the mesh.

    Returns​

    void

    Defined in​

    src/core/Disposer/index.ts:43

    disposeGeometry​

    ▸ disposeGeometry(geometry): void

    Disposes a geometry from memory.

    Parameters​

    NameTypeDescription
    geometryBufferGeometry<NormalBufferAttributes>the geometry to remove.

    Returns​

    void

    Defined in​

    src/core/Disposer/index.ts:64

    get​

    ▸ get(): Set<string>

    Component.uuid.

    Returns​

    Set<string>

    the list of UUIDs of deleted components.

    Overrides​

    Component.get

    Defined in​

    src/core/Disposer/index.ts:27

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    src/base-types/component.ts:45

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.EdgesClipper/index.html b/build/api/classes/openbim_components.EdgesClipper/index.html index 9184a10f..b21b1dea 100644 --- a/build/api/classes/openbim_components.EdgesClipper/index.html +++ b/build/api/classes/openbim_components.EdgesClipper/index.html @@ -3,21 +3,21 @@ -Class: EdgesClipper | That Open Docs - - +Class: EdgesClipper | That Open Docs + + -
    -
    Skip to main content

    Class: EdgesClipper

    openbim-components.EdgesClipper

    A more advanced version of SimpleClipper that also supports -ClippingEdges with customizable lines.

    Hierarchy​

    Properties​

    onAfterCreate​

    • Readonly onAfterCreate: Event<EdgesPlane>

    Createable.onAfterCreate

    Inherited from​

    SimpleClipper.onAfterCreate

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:35

    onAfterDelete​

    • Readonly onAfterDelete: Event<EdgesPlane>

    Createable.onAfterDelete

    Inherited from​

    SimpleClipper.onAfterDelete

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:38

    onAfterDrag​

    • Readonly onAfterDrag: Event<void>

    Event that fires when the user stops dragging a clipping plane.

    Inherited from​

    SimpleClipper.onAfterDrag

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:44

    onBeforeDrag​

    • Readonly onBeforeDrag: Event<void>

    Event that fires when the user starts dragging a clipping plane.

    Inherited from​

    SimpleClipper.onBeforeDrag

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:41

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Inherited from​

    SimpleClipper.onDisposed

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:73

    orthogonalY​

    • orthogonalY: boolean = false

    Whether to force the clipping plane to be orthogonal in the Y direction +

    +

    Class: EdgesClipper

    openbim-components.EdgesClipper

    A more advanced version of SimpleClipper that also supports +ClippingEdges with customizable lines.

    Hierarchy​

    Properties​

    onAfterCreate​

    • Readonly onAfterCreate: Event<EdgesPlane>

    Createable.onAfterCreate

    Inherited from​

    SimpleClipper.onAfterCreate

    Defined in​

    src/core/SimpleClipper/index.ts:35

    onAfterDelete​

    • Readonly onAfterDelete: Event<EdgesPlane>

    Createable.onAfterDelete

    Inherited from​

    SimpleClipper.onAfterDelete

    Defined in​

    src/core/SimpleClipper/index.ts:38

    onAfterDrag​

    • Readonly onAfterDrag: Event<void>

    Event that fires when the user stops dragging a clipping plane.

    Inherited from​

    SimpleClipper.onAfterDrag

    Defined in​

    src/core/SimpleClipper/index.ts:44

    onBeforeDrag​

    • Readonly onBeforeDrag: Event<void>

    Event that fires when the user starts dragging a clipping plane.

    Inherited from​

    SimpleClipper.onBeforeDrag

    Defined in​

    src/core/SimpleClipper/index.ts:41

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Inherited from​

    SimpleClipper.onDisposed

    Defined in​

    src/core/SimpleClipper/index.ts:73

    orthogonalY​

    • orthogonalY: boolean = false

    Whether to force the clipping plane to be orthogonal in the Y direction (up). This is desirable when clipping a building horizontally and a clipping plane is created in it's roof, which might have a slight -slope for draining purposes.

    Inherited from​

    SimpleClipper.orthogonalY

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:60

    styles​

    • styles: EdgesStyles

    The list of defined LineStyle instances.

    Defined in​

    temp/engine_components/src/navigation/EdgesClipper/index.ts:14

    toleranceOrthogonalY​

    • toleranceOrthogonalY: number = 0.7

    The tolerance that determines whether a horizontallish clipping plane +slope for draining purposes.

    Inherited from​

    SimpleClipper.orthogonalY

    Defined in​

    src/core/SimpleClipper/index.ts:60

    styles​

    • styles: EdgesStyles

    The list of defined LineStyle instances.

    Defined in​

    src/navigation/EdgesClipper/index.ts:14

    toleranceOrthogonalY​

    • toleranceOrthogonalY: number = 0.7

    The tolerance that determines whether a horizontallish clipping plane will be forced to be orthogonal to the Y direction. orthogonalY -has to be true for this to apply.

    Inherited from​

    SimpleClipper.toleranceOrthogonalY

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:67

    uiElement​

    • uiElement: UIElement<{ main: Button }>

    UI.uiElement

    Inherited from​

    SimpleClipper.uiElement

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:52

    Accessors​

    enabled​

    • get enabled(): boolean

    Component.enabled

    Returns​

    boolean

    Inherited from​

    SimpleClipper.enabled

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:88

    • set enabled(state): void

    Component.enabled

    Parameters​

    NameType
    stateboolean

    Returns​

    void

    Inherited from​

    SimpleClipper.enabled

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:93

    material​

    • get material(): Material

    The material of the clipping plane representation.

    Returns​

    Material

    Inherited from​

    SimpleClipper.material

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:118

    • set material(material): void

    The material of the clipping plane representation.

    Parameters​

    NameType
    materialMaterial

    Returns​

    void

    Inherited from​

    SimpleClipper.material

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:123

    size​

    • get size(): number

    The size of the geometric representation of the clippings planes.

    Returns​

    number

    Inherited from​

    SimpleClipper.size

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:131

    • set size(size): void

    The size of the geometric representation of the clippings planes.

    Parameters​

    NameType
    sizenumber

    Returns​

    void

    Inherited from​

    SimpleClipper.size

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:136

    visible​

    • get visible(): boolean

    Hideable.visible

    Returns​

    boolean

    Inherited from​

    SimpleClipper.visible

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:105

    • set visible(state): void

    Hideable.visible

    Parameters​

    NameType
    stateboolean

    Returns​

    void

    Inherited from​

    SimpleClipper.visible

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:110

    Methods​

    create​

    ▸ create(): void

    Createable.create

    Returns​

    void

    Inherited from​

    SimpleClipper.create

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:184

    createFromNormalAndCoplanarPoint​

    ▸ createFromNormalAndCoplanarPoint(normal, point): EdgesPlane

    Creates a plane in a certain place and with a certain orientation, -without the need of the mouse.

    Parameters​

    NameTypeDescription
    normalVector3the orientation of the clipping plane.
    pointVector3the position of the clipping plane.

    Returns​

    EdgesPlane

    Inherited from​

    SimpleClipper.createFromNormalAndCoplanarPoint

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:200

    delete​

    ▸ delete(plane?): void

    Createable.delete

    Parameters​

    NameTypeDescription
    plane?EdgesPlanethe plane to delete. If undefined, the the first plane found under the cursor will be deleted.

    Returns​

    void

    Inherited from​

    SimpleClipper.delete

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:215

    deleteAll​

    ▸ deleteAll(): void

    Deletes all the existing clipping planes.

    Returns​

    void

    Inherited from​

    SimpleClipper.deleteAll

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:227

    dispose​

    ▸ dispose(): Promise<void>

    Component.get

    Returns​

    Promise<void>

    Overrides​

    SimpleClipper.dispose

    Defined in​

    temp/engine_components/src/navigation/EdgesClipper/index.ts:28

    get​

    ▸ get(): EdgesPlane[]

    Component.get

    Returns​

    EdgesPlane[]

    Inherited from​

    SimpleClipper.get

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:158

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    SimpleClipper.hasUI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    SimpleClipper.isConfigurable

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    SimpleClipper.isDisposeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    SimpleClipper.isHideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    SimpleClipper.isResizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    SimpleClipper.isUpdateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    updateEdges​

    ▸ updateEdges(updateFills?): Promise<void>

    Updates all the lines of the ClippingEdges.

    Parameters​

    NameTypeDefault value
    updateFillsbooleanfalse

    Returns​

    Promise<void>

    Defined in​

    temp/engine_components/src/navigation/EdgesClipper/index.ts:36

    - - +has to be true for this to apply.

    Inherited from​

    SimpleClipper.toleranceOrthogonalY

    Defined in​

    src/core/SimpleClipper/index.ts:67

    uiElement​

    • uiElement: UIElement<{ main: Button }>

    UI.uiElement

    Inherited from​

    SimpleClipper.uiElement

    Defined in​

    src/core/SimpleClipper/index.ts:52

    Accessors​

    enabled​

    • get enabled(): boolean

    Component.enabled

    Returns​

    boolean

    Inherited from​

    SimpleClipper.enabled

    Defined in​

    src/core/SimpleClipper/index.ts:88

    • set enabled(state): void

    Component.enabled

    Parameters​

    NameType
    stateboolean

    Returns​

    void

    Inherited from​

    SimpleClipper.enabled

    Defined in​

    src/core/SimpleClipper/index.ts:93

    material​

    • get material(): Material

    The material of the clipping plane representation.

    Returns​

    Material

    Inherited from​

    SimpleClipper.material

    Defined in​

    src/core/SimpleClipper/index.ts:118

    • set material(material): void

    The material of the clipping plane representation.

    Parameters​

    NameType
    materialMaterial

    Returns​

    void

    Inherited from​

    SimpleClipper.material

    Defined in​

    src/core/SimpleClipper/index.ts:123

    size​

    • get size(): number

    The size of the geometric representation of the clippings planes.

    Returns​

    number

    Inherited from​

    SimpleClipper.size

    Defined in​

    src/core/SimpleClipper/index.ts:131

    • set size(size): void

    The size of the geometric representation of the clippings planes.

    Parameters​

    NameType
    sizenumber

    Returns​

    void

    Inherited from​

    SimpleClipper.size

    Defined in​

    src/core/SimpleClipper/index.ts:136

    visible​

    • get visible(): boolean

    Hideable.visible

    Returns​

    boolean

    Inherited from​

    SimpleClipper.visible

    Defined in​

    src/core/SimpleClipper/index.ts:105

    • set visible(state): void

    Hideable.visible

    Parameters​

    NameType
    stateboolean

    Returns​

    void

    Inherited from​

    SimpleClipper.visible

    Defined in​

    src/core/SimpleClipper/index.ts:110

    Methods​

    create​

    ▸ create(): void

    Createable.create

    Returns​

    void

    Inherited from​

    SimpleClipper.create

    Defined in​

    src/core/SimpleClipper/index.ts:184

    createFromNormalAndCoplanarPoint​

    ▸ createFromNormalAndCoplanarPoint(normal, point): EdgesPlane

    Creates a plane in a certain place and with a certain orientation, +without the need of the mouse.

    Parameters​

    NameTypeDescription
    normalVector3the orientation of the clipping plane.
    pointVector3the position of the clipping plane.

    Returns​

    EdgesPlane

    Inherited from​

    SimpleClipper.createFromNormalAndCoplanarPoint

    Defined in​

    src/core/SimpleClipper/index.ts:200

    delete​

    ▸ delete(plane?): void

    Createable.delete

    Parameters​

    NameTypeDescription
    plane?EdgesPlanethe plane to delete. If undefined, the the first plane found under the cursor will be deleted.

    Returns​

    void

    Inherited from​

    SimpleClipper.delete

    Defined in​

    src/core/SimpleClipper/index.ts:215

    deleteAll​

    ▸ deleteAll(): void

    Deletes all the existing clipping planes.

    Returns​

    void

    Inherited from​

    SimpleClipper.deleteAll

    Defined in​

    src/core/SimpleClipper/index.ts:227

    dispose​

    ▸ dispose(): Promise<void>

    Component.get

    Returns​

    Promise<void>

    Overrides​

    SimpleClipper.dispose

    Defined in​

    src/navigation/EdgesClipper/index.ts:28

    get​

    ▸ get(): EdgesPlane[]

    Component.get

    Returns​

    EdgesPlane[]

    Inherited from​

    SimpleClipper.get

    Defined in​

    src/core/SimpleClipper/index.ts:158

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    SimpleClipper.hasUI

    Defined in​

    src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    SimpleClipper.isConfigurable

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    SimpleClipper.isDisposeable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    SimpleClipper.isHideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    SimpleClipper.isResizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    SimpleClipper.isUpdateable

    Defined in​

    src/base-types/component.ts:45

    updateEdges​

    ▸ updateEdges(updateFills?): Promise<void>

    Updates all the lines of the ClippingEdges.

    Parameters​

    NameTypeDefault value
    updateFillsbooleanfalse

    Returns​

    Promise<void>

    Defined in​

    src/navigation/EdgesClipper/index.ts:36

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.EdgesPlane/index.html b/build/api/classes/openbim_components.EdgesPlane/index.html index a89bc8b6..6e966222 100644 --- a/build/api/classes/openbim_components.EdgesPlane/index.html +++ b/build/api/classes/openbim_components.EdgesPlane/index.html @@ -3,16 +3,16 @@ -Class: EdgesPlane | That Open Docs - - +Class: EdgesPlane | That Open Docs + + -
    -
    Skip to main content

    Class: EdgesPlane

    openbim-components.EdgesPlane

    A more advanced version of SimpleClipper that also includes -ClippingEdges with customizable lines.

    Hierarchy​

    Properties​

    edgesMaxUpdateRate​

    • edgesMaxUpdateRate: number = 50

    The max rate in milliseconds at which edges can be regenerated. -To disable this behaviour set this to 0.

    Defined in​

    temp/engine_components/src/navigation/EdgesClipper/src/edges-plane.ts:17

    name​

    • name: string = "SimplePlane"

    Component.name

    Inherited from​

    SimplePlane.name

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:14

    onDisposed​

    • Readonly onDisposed: Event<undefined>

    Disposable.onDisposed

    Inherited from​

    SimplePlane.onDisposed

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:23

    onDraggingEnded​

    • Readonly onDraggingEnded: Event<void>

    Event that fires when the user stops dragging a clipping plane.

    Inherited from​

    SimplePlane.onDraggingEnded

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:20

    onDraggingStarted​

    • Readonly onDraggingStarted: Event<void>

    Event that fires when the user starts dragging a clipping plane.

    Inherited from​

    SimplePlane.onDraggingStarted

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:17

    Accessors​

    enabled​

    • get enabled(): boolean

    Component.enabled

    Returns​

    boolean

    Overrides​

    SimplePlane.enabled

    Defined in​

    temp/engine_components/src/navigation/EdgesClipper/src/edges-plane.ts:43

    • set enabled(state): void

    Component.enabled

    Parameters​

    NameType
    stateboolean

    Returns​

    void

    Overrides​

    SimplePlane.enabled

    Defined in​

    temp/engine_components/src/navigation/EdgesClipper/src/edges-plane.ts:37

    meshes​

    • get meshes(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>[]

    The meshes used for raycasting

    Returns​

    Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>[]

    Inherited from​

    SimplePlane.meshes

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:71

    planeMaterial​

    • get planeMaterial(): Material | Material[]

    The material of the clipping plane representation.

    Returns​

    Material | Material[]

    Inherited from​

    SimplePlane.planeMaterial

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:76

    • set planeMaterial(material): void

    The material of the clipping plane representation.

    Parameters​

    NameType
    materialMaterial | Material[]

    Returns​

    void

    Inherited from​

    SimplePlane.planeMaterial

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:81

    size​

    • get size(): number

    The size of the clipping plane representation.

    Returns​

    number

    Inherited from​

    SimplePlane.size

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:86

    • set size(size): void

    Sets the size of the clipping plane representation.

    Parameters​

    NameType
    sizenumber

    Returns​

    void

    Inherited from​

    SimplePlane.size

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:91

    visible​

    • get visible(): boolean

    Hideable.visible

    Returns​

    boolean

    Inherited from​

    SimplePlane.visible

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:58

    • set visible(state): void

    Hideable.visible

    Parameters​

    NameType
    stateboolean

    Returns​

    void

    Inherited from​

    SimplePlane.visible

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:63

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Overrides​

    SimplePlane.dispose

    Defined in​

    temp/engine_components/src/navigation/EdgesClipper/src/edges-plane.ts:48

    get​

    ▸ get(): Plane

    Component.get

    Returns​

    Plane

    Inherited from​

    SimplePlane.get

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:137

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    SimplePlane.hasUI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    SimplePlane.isConfigurable

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    SimplePlane.isDisposeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    SimplePlane.isHideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    SimplePlane.isResizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    SimplePlane.isUpdateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    setEnabled​

    ▸ setEnabled(state): Promise<void>

    Component.enabled

    Parameters​

    NameType
    stateboolean

    Returns​

    Promise<void>

    Defined in​

    temp/engine_components/src/navigation/EdgesClipper/src/edges-plane.ts:54

    update​

    ▸ update(): Promise<void>

    Updateable.update

    Returns​

    Promise<void>

    Overrides​

    SimplePlane.update

    Defined in​

    temp/engine_components/src/navigation/EdgesClipper/src/edges-plane.ts:76

    - - +
    +
    Skip to main content

    Class: EdgesPlane

    openbim-components.EdgesPlane

    A more advanced version of SimpleClipper that also includes +ClippingEdges with customizable lines.

    Hierarchy​

    Properties​

    edgesMaxUpdateRate​

    • edgesMaxUpdateRate: number = 50

    The max rate in milliseconds at which edges can be regenerated. +To disable this behaviour set this to 0.

    Defined in​

    src/navigation/EdgesClipper/src/edges-plane.ts:17

    name​

    • name: string = "SimplePlane"

    Component.name

    Inherited from​

    SimplePlane.name

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:14

    onDisposed​

    • Readonly onDisposed: Event<undefined>

    Disposable.onDisposed

    Inherited from​

    SimplePlane.onDisposed

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:23

    onDraggingEnded​

    • Readonly onDraggingEnded: Event<void>

    Event that fires when the user stops dragging a clipping plane.

    Inherited from​

    SimplePlane.onDraggingEnded

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:20

    onDraggingStarted​

    • Readonly onDraggingStarted: Event<void>

    Event that fires when the user starts dragging a clipping plane.

    Inherited from​

    SimplePlane.onDraggingStarted

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:17

    Accessors​

    enabled​

    • get enabled(): boolean

    Component.enabled

    Returns​

    boolean

    Overrides​

    SimplePlane.enabled

    Defined in​

    src/navigation/EdgesClipper/src/edges-plane.ts:43

    • set enabled(state): void

    Component.enabled

    Parameters​

    NameType
    stateboolean

    Returns​

    void

    Overrides​

    SimplePlane.enabled

    Defined in​

    src/navigation/EdgesClipper/src/edges-plane.ts:37

    meshes​

    • get meshes(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>[]

    The meshes used for raycasting

    Returns​

    Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>[]

    Inherited from​

    SimplePlane.meshes

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:71

    planeMaterial​

    • get planeMaterial(): Material | Material[]

    The material of the clipping plane representation.

    Returns​

    Material | Material[]

    Inherited from​

    SimplePlane.planeMaterial

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:76

    • set planeMaterial(material): void

    The material of the clipping plane representation.

    Parameters​

    NameType
    materialMaterial | Material[]

    Returns​

    void

    Inherited from​

    SimplePlane.planeMaterial

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:81

    size​

    • get size(): number

    The size of the clipping plane representation.

    Returns​

    number

    Inherited from​

    SimplePlane.size

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:86

    • set size(size): void

    Sets the size of the clipping plane representation.

    Parameters​

    NameType
    sizenumber

    Returns​

    void

    Inherited from​

    SimplePlane.size

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:91

    visible​

    • get visible(): boolean

    Hideable.visible

    Returns​

    boolean

    Inherited from​

    SimplePlane.visible

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:58

    • set visible(state): void

    Hideable.visible

    Parameters​

    NameType
    stateboolean

    Returns​

    void

    Inherited from​

    SimplePlane.visible

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:63

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Overrides​

    SimplePlane.dispose

    Defined in​

    src/navigation/EdgesClipper/src/edges-plane.ts:48

    get​

    ▸ get(): Plane

    Component.get

    Returns​

    Plane

    Inherited from​

    SimplePlane.get

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:147

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    SimplePlane.hasUI

    Defined in​

    src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    SimplePlane.isConfigurable

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    SimplePlane.isDisposeable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    SimplePlane.isHideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    SimplePlane.isResizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    SimplePlane.isUpdateable

    Defined in​

    src/base-types/component.ts:45

    setEnabled​

    ▸ setEnabled(state): Promise<void>

    Component.enabled

    Parameters​

    NameType
    stateboolean

    Returns​

    Promise<void>

    Defined in​

    src/navigation/EdgesClipper/src/edges-plane.ts:54

    update​

    ▸ update(): Promise<void>

    Updateable.update

    Returns​

    Promise<void>

    Overrides​

    SimplePlane.update

    Defined in​

    src/navigation/EdgesClipper/src/edges-plane.ts:76

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.Event/index.html b/build/api/classes/openbim_components.Event/index.html index 19aefb03..d0015afd 100644 --- a/build/api/classes/openbim_components.Event/index.html +++ b/build/api/classes/openbim_components.Event/index.html @@ -3,18 +3,18 @@ -Class: Event<T> | That Open Docs - - +Class: Event<T> | That Open Docs + + -
    -
    Skip to main content

    Class: Event<T>

    openbim-components.Event

    Simple event handler by +

    +

    Class: Event<T>

    openbim-components.Event

    Simple event handler by Jason Kleban. Keep in mind that:

    • If you want to remove it later, you might want to declare the callback as an object.
    • If you want to maintain the reference to this, you will need to declare -the callback as an arrow function.

    Type parameters​

    Name
    T

    Methods​

    add​

    ▸ add(handler): void

    Add a callback to this event instance.

    Parameters​

    NameTypeDescription
    handlerT extends void ? () => void : (data: T) => voidthe callback to be added to this event.

    Returns​

    void

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:19

    remove​

    ▸ remove(handler): void

    Removes a callback from this event instance.

    Parameters​

    NameTypeDescription
    handlerT extends void ? () => void : (data: T) => voidthe callback to be removed from this event.

    Returns​

    void

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:27

    reset​

    ▸ reset(): void

    Gets rid of all the suscribed events.

    Returns​

    void

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:40

    trigger​

    ▸ trigger(data?): Promise<void>

    Triggers all the callbacks assigned to this event.

    Parameters​

    NameType
    data?T

    Returns​

    Promise<void>

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:32

    - - +the callback as an arrow function.

    Type parameters​

    Name
    T

    Methods​

    add​

    ▸ add(handler): void

    Add a callback to this event instance.

    Parameters​

    NameTypeDescription
    handlerT extends void ? () => void : (data: T) => voidthe callback to be added to this event.

    Returns​

    void

    Defined in​

    src/base-types/base-types.ts:19

    remove​

    ▸ remove(handler): void

    Removes a callback from this event instance.

    Parameters​

    NameTypeDescription
    handlerT extends void ? () => void : (data: T) => voidthe callback to be removed from this event.

    Returns​

    void

    Defined in​

    src/base-types/base-types.ts:27

    reset​

    ▸ reset(): void

    Gets rid of all the suscribed events.

    Returns​

    void

    Defined in​

    src/base-types/base-types.ts:40

    trigger​

    ▸ trigger(data?): Promise<void>

    Triggers all the callbacks assigned to this event.

    Parameters​

    NameType
    data?T

    Returns​

    Promise<void>

    Defined in​

    src/base-types/base-types.ts:32

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.FragmentBoundingBox/index.html b/build/api/classes/openbim_components.FragmentBoundingBox/index.html index e00dc2a3..1d7baaf7 100644 --- a/build/api/classes/openbim_components.FragmentBoundingBox/index.html +++ b/build/api/classes/openbim_components.FragmentBoundingBox/index.html @@ -3,15 +3,15 @@ -Class: FragmentBoundingBox | That Open Docs - - +Class: FragmentBoundingBox | That Open Docs + + -
    -
    Skip to main content

    Class: FragmentBoundingBox

    openbim-components.FragmentBoundingBox

    A simple implementation of bounding box that works for fragments. The resulting bbox is not 100% precise, but -it's fast, and should suffice for general use cases such as camera zooming or general boundary determination.

    Hierarchy​

    Implements​

    Properties​

    enabled​

    • enabled: boolean = true

    Component.enabled

    Overrides​

    Component.enabled

    Defined in​

    temp/engine_components/src/fragments/FragmentBoundingBox/index.ts:16

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    temp/engine_components/src/fragments/FragmentBoundingBox/index.ts:19

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    temp/engine_components/src/fragments/FragmentBoundingBox/index.ts:72

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    - - +
    +
    Skip to main content

    Class: FragmentBoundingBox

    openbim-components.FragmentBoundingBox

    A simple implementation of bounding box that works for fragments. The resulting bbox is not 100% precise, but +it's fast, and should suffice for general use cases such as camera zooming or general boundary determination.

    Hierarchy​

    Implements​

    Properties​

    enabled​

    • enabled: boolean = true

    Component.enabled

    Overrides​

    Component.enabled

    Defined in​

    src/fragments/FragmentBoundingBox/index.ts:17

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    src/fragments/FragmentBoundingBox/index.ts:20

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    src/fragments/FragmentBoundingBox/index.ts:73

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    src/base-types/component.ts:45

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.FragmentManager/index.html b/build/api/classes/openbim_components.FragmentManager/index.html index cbf5d15b..d9900539 100644 --- a/build/api/classes/openbim_components.FragmentManager/index.html +++ b/build/api/classes/openbim_components.FragmentManager/index.html @@ -3,15 +3,15 @@ -Class: FragmentManager | That Open Docs - - +Class: FragmentManager | That Open Docs + + -
    -
    Skip to main content

    Class: FragmentManager

    openbim-components.FragmentManager

    Object that can efficiently load binary files that contain -fragment geometry.

    Hierarchy​

    Implements​

    Properties​

    enabled​

    • enabled: boolean = true

    Component.enabled

    Overrides​

    Component.enabled

    Defined in​

    temp/engine_components/src/fragments/FragmentManager/index.ts:29

    list​

    • list: Object = {}

    All the created fragments.

    Index signature​

    ▪ [guid: string]: Fragment

    Defined in​

    temp/engine_components/src/fragments/FragmentManager/index.ts:32

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    temp/engine_components/src/fragments/FragmentManager/index.ts:26

    Accessors​

    meshes​

    • get meshes(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>[]

    The list of meshes of the created fragments.

    Returns​

    Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>[]

    Defined in​

    temp/engine_components/src/fragments/FragmentManager/index.ts:55

    Methods​

    dispose​

    ▸ dispose(disposeUI?): Promise<void>

    Component.get

    Parameters​

    NameTypeDefault value
    disposeUIbooleanfalse

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    temp/engine_components/src/fragments/FragmentManager/index.ts:79

    export​

    ▸ export(group): Uint8Array

    Export the specified fragments.

    Parameters​

    NameTypeDescription
    groupFragmentsGroupthe fragments group to be exported.

    Returns​

    Uint8Array

    the exported data as binary buffer.

    Defined in​

    temp/engine_components/src/fragments/FragmentManager/index.ts:166

    get​

    ▸ get(): Fragment[]

    Component.get

    Returns​

    Fragment[]

    Overrides​

    Component.get

    Defined in​

    temp/engine_components/src/fragments/FragmentManager/index.ts:74

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    load​

    ▸ load(data, coordinate?): Promise<FragmentsGroup>

    Loads one or many fragments into the scene.

    Parameters​

    NameTypeDefault valueDescription
    dataUint8Arrayundefinedthe bytes containing the data for the fragments to load.
    coordinatebooleantruewhether this fragmentsgroup should be federated with the others.

    Returns​

    Promise<FragmentsGroup>

    the list of IDs of the loaded fragments.

    Defined in​

    temp/engine_components/src/fragments/FragmentManager/index.ts:137

    reset​

    ▸ reset(): void

    Disposes all existing fragments

    Returns​

    void

    Defined in​

    temp/engine_components/src/fragments/FragmentManager/index.ts:123

    - - +
    +
    Skip to main content

    Class: FragmentManager

    openbim-components.FragmentManager

    Object that can efficiently load binary files that contain +fragment geometry.

    Hierarchy​

    Implements​

    Properties​

    enabled​

    • enabled: boolean = true

    Component.enabled

    Overrides​

    Component.enabled

    Defined in​

    src/fragments/FragmentManager/index.ts:29

    list​

    • list: Object = {}

    All the created fragments.

    Index signature​

    ▪ [guid: string]: Fragment

    Defined in​

    src/fragments/FragmentManager/index.ts:32

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    src/fragments/FragmentManager/index.ts:26

    Accessors​

    meshes​

    • get meshes(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>[]

    The list of meshes of the created fragments.

    Returns​

    Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>[]

    Defined in​

    src/fragments/FragmentManager/index.ts:55

    Methods​

    dispose​

    ▸ dispose(disposeUI?): Promise<void>

    Component.get

    Parameters​

    NameTypeDefault value
    disposeUIbooleanfalse

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    src/fragments/FragmentManager/index.ts:79

    export​

    ▸ export(group): Uint8Array

    Export the specified fragments.

    Parameters​

    NameTypeDescription
    groupFragmentsGroupthe fragments group to be exported.

    Returns​

    Uint8Array

    the exported data as binary buffer.

    Defined in​

    src/fragments/FragmentManager/index.ts:161

    get​

    ▸ get(): Fragment[]

    Component.get

    Returns​

    Fragment[]

    Overrides​

    Component.get

    Defined in​

    src/fragments/FragmentManager/index.ts:74

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    src/base-types/component.ts:45

    load​

    ▸ load(data, coordinate?): Promise<FragmentsGroup>

    Loads one or many fragments into the scene.

    Parameters​

    NameTypeDefault valueDescription
    dataUint8Arrayundefinedthe bytes containing the data for the fragments to load.
    coordinatebooleantruewhether this fragmentsgroup should be federated with the others.

    Returns​

    Promise<FragmentsGroup>

    the list of IDs of the loaded fragments.

    Defined in​

    src/fragments/FragmentManager/index.ts:137

    reset​

    ▸ reset(): void

    Disposes all existing fragments

    Returns​

    void

    Defined in​

    src/fragments/FragmentManager/index.ts:123

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.FragmentPlans/index.html b/build/api/classes/openbim_components.FragmentPlans/index.html index d562a063..8bba5742 100644 --- a/build/api/classes/openbim_components.FragmentPlans/index.html +++ b/build/api/classes/openbim_components.FragmentPlans/index.html @@ -3,14 +3,14 @@ -Class: FragmentPlans | That Open Docs - - +Class: FragmentPlans | That Open Docs + + -
    -
    Skip to main content

    Class: FragmentPlans

    openbim-components.FragmentPlans

    Helper to control the camera and easily define and navigate 2D floor plans.

    Hierarchy​

    Implements​

    Properties​

    currentPlan​

    • currentPlan: null | PlanView = null

    The floorplan that is currently selected.

    Defined in​

    temp/engine_components/src/fragments/FragmentPlans/index.ts:44

    defaultCameraOffset​

    • defaultCameraOffset: number = 30

    The offset of the 2D camera to the floor plan elevation.

    Defined in​

    temp/engine_components/src/fragments/FragmentPlans/index.ts:50

    defaultSectionOffset​

    • defaultSectionOffset: number = 1.5

    The offset from the clipping planes to their respective floor plan elevation.

    Defined in​

    temp/engine_components/src/fragments/FragmentPlans/index.ts:47

    enabled​

    • enabled: boolean = false

    Component.enabled

    Overrides​

    Component.enabled

    Defined in​

    temp/engine_components/src/fragments/FragmentPlans/index.ts:41

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    temp/engine_components/src/fragments/FragmentPlans/index.ts:34

    storeys​

    • storeys: Object = []

    The created floor plans.

    Index signature​

    ▪ [modelID: number]: any[]

    Defined in​

    temp/engine_components/src/fragments/FragmentPlans/index.ts:53

    uiElement​

    • uiElement: UIElement<{ commandsMenu: CommandsMenu<PlanView> ; defaultText: SimpleUIComponent<HTMLParagraphElement> ; exitButton: Button ; floatingWindow: FloatingWindow ; main: Button ; planList: SimpleUIComponent<HTMLElement> }>

    UI.uiElement

    Implementation of​

    UI.uiElement

    Defined in​

    temp/engine_components/src/fragments/FragmentPlans/index.ts:58

    Methods​

    create​

    ▸ create(config): Promise<void>

    Creates a new floor plan in the navigator.

    Parameters​

    NameTypeDescription
    configPlanViewNecessary data to initialize the floor plan.

    Returns​

    Promise<void>

    Defined in​

    temp/engine_components/src/fragments/FragmentPlans/index.ts:154

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    temp/engine_components/src/fragments/FragmentPlans/index.ts:99

    exitPlanView​

    ▸ exitPlanView(animate?): Promise<void>

    Deactivate navigator and go back to the previous view.

    Parameters​

    NameTypeDefault valueDescription
    animatebooleanfalseWhether to animate the camera transition.

    Returns​

    Promise<void>

    Defined in​

    temp/engine_components/src/fragments/FragmentPlans/index.ts:198

    get​

    ▸ get(): PlanView[]

    Component.get

    Returns​

    PlanView[]

    Overrides​

    Component.get

    Defined in​

    temp/engine_components/src/fragments/FragmentPlans/index.ts:94

    goTo​

    ▸ goTo(id, animate?): Promise<void>

    Make the navigator go to the specified floor plan.

    Parameters​

    NameTypeDefault valueDescription
    idstringundefinedFloor plan to go to.
    animatebooleanfalseWhether to animate the camera transition.

    Returns​

    Promise<void>

    Defined in​

    temp/engine_components/src/fragments/FragmentPlans/index.ts:173

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    - - +
    +
    Skip to main content

    Class: FragmentPlans

    openbim-components.FragmentPlans

    Helper to control the camera and easily define and navigate 2D floor plans.

    Hierarchy​

    Implements​

    Properties​

    currentPlan​

    • currentPlan: null | PlanView = null

    The floorplan that is currently selected.

    Defined in​

    src/fragments/FragmentPlans/index.ts:44

    defaultCameraOffset​

    • defaultCameraOffset: number = 30

    The offset of the 2D camera to the floor plan elevation.

    Defined in​

    src/fragments/FragmentPlans/index.ts:50

    defaultSectionOffset​

    • defaultSectionOffset: number = 1.5

    The offset from the clipping planes to their respective floor plan elevation.

    Defined in​

    src/fragments/FragmentPlans/index.ts:47

    enabled​

    • enabled: boolean = false

    Component.enabled

    Overrides​

    Component.enabled

    Defined in​

    src/fragments/FragmentPlans/index.ts:41

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    src/fragments/FragmentPlans/index.ts:34

    storeys​

    • storeys: Object = []

    The created floor plans.

    Index signature​

    ▪ [modelID: number]: any[]

    Defined in​

    src/fragments/FragmentPlans/index.ts:53

    uiElement​

    • uiElement: UIElement<{ commandsMenu: CommandsMenu<PlanView> ; defaultText: SimpleUIComponent<HTMLParagraphElement> ; exitButton: Button ; floatingWindow: FloatingWindow ; main: Button ; planList: SimpleUIComponent<HTMLElement> }>

    UI.uiElement

    Implementation of​

    UI.uiElement

    Defined in​

    src/fragments/FragmentPlans/index.ts:58

    Methods​

    create​

    ▸ create(config): Promise<void>

    Creates a new floor plan in the navigator.

    Parameters​

    NameTypeDescription
    configPlanViewNecessary data to initialize the floor plan.

    Returns​

    Promise<void>

    Defined in​

    src/fragments/FragmentPlans/index.ts:154

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    src/fragments/FragmentPlans/index.ts:99

    exitPlanView​

    ▸ exitPlanView(animate?): Promise<void>

    Deactivate navigator and go back to the previous view.

    Parameters​

    NameTypeDefault valueDescription
    animatebooleanfalseWhether to animate the camera transition.

    Returns​

    Promise<void>

    Defined in​

    src/fragments/FragmentPlans/index.ts:198

    get​

    ▸ get(): PlanView[]

    Component.get

    Returns​

    PlanView[]

    Overrides​

    Component.get

    Defined in​

    src/fragments/FragmentPlans/index.ts:94

    goTo​

    ▸ goTo(id, animate?): Promise<void>

    Make the navigator go to the specified floor plan.

    Parameters​

    NameTypeDefault valueDescription
    idstringundefinedFloor plan to go to.
    animatebooleanfalseWhether to animate the camera transition.

    Returns​

    Promise<void>

    Defined in​

    src/fragments/FragmentPlans/index.ts:173

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    src/base-types/component.ts:45

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.IfcJsonExporter/index.html b/build/api/classes/openbim_components.IfcJsonExporter/index.html index 6d973373..98a62803 100644 --- a/build/api/classes/openbim_components.IfcJsonExporter/index.html +++ b/build/api/classes/openbim_components.IfcJsonExporter/index.html @@ -3,14 +3,14 @@ -Class: IfcJsonExporter | That Open Docs - - +Class: IfcJsonExporter | That Open Docs + + -
    -
    Skip to main content

    Class: IfcJsonExporter

    openbim-components.IfcJsonExporter

    Object to export all the properties from an IFC to a JS object.

    Methods​

    export​

    ▸ export(webIfc, modelID, indirect?, recursiveSpatial?): Promise<IfcProperties>

    Exports all the properties of an IFC into an array of JS objects.

    Parameters​

    NameTypeDefault valueDescription
    webIfcIfcAPIundefinedThe instance of [web-ifc][https://github.com/ThatOpen/engine_web-ifc](https://github.com/ThatOpen/engine_web-ifc) to use.
    modelIDnumberundefinedID of the IFC model whose properties to extract.
    indirectbooleanfalsewhether to get the indirect relationships as well.
    recursiveSpatialbooleantruewhether to get the properties of spatial items recursively to make the location data available (e.g. absolute position of building).

    Returns​

    Promise<IfcProperties>

    Defined in​

    temp/engine_components/src/ifc/IfcJsonExporter/index.ts:17

    - - +
    +
    Skip to main content

    Class: IfcJsonExporter

    openbim-components.IfcJsonExporter

    Object to export all the properties from an IFC to a JS object.

    Methods​

    export​

    ▸ export(webIfc, modelID, indirect?, recursiveSpatial?): Promise<IfcProperties>

    Exports all the properties of an IFC into an array of JS objects.

    Parameters​

    NameTypeDefault valueDescription
    webIfcIfcAPIundefinedThe instance of [web-ifc][https://github.com/ThatOpen/engine_web-ifc](https://github.com/ThatOpen/engine_web-ifc) to use.
    modelIDnumberundefinedID of the IFC model whose properties to extract.
    indirectbooleanfalsewhether to get the indirect relationships as well.
    recursiveSpatialbooleantruewhether to get the properties of spatial items recursively to make the location data available (e.g. absolute position of building).

    Returns​

    Promise<IfcProperties>

    Defined in​

    src/ifc/IfcJsonExporter/index.ts:17

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.IfcStreamingSettings/index.html b/build/api/classes/openbim_components.IfcStreamingSettings/index.html index 3e213523..9448f3e0 100644 --- a/build/api/classes/openbim_components.IfcStreamingSettings/index.html +++ b/build/api/classes/openbim_components.IfcStreamingSettings/index.html @@ -3,15 +3,15 @@ -Class: IfcStreamingSettings | That Open Docs - - +Class: IfcStreamingSettings | That Open Docs + + -
    -
    Skip to main content

    Class: IfcStreamingSettings

    openbim-components.IfcStreamingSettings

    Configuration of the IFC-fragment streaming.

    Hierarchy​

    • IfcFragmentSettings

      ↳ IfcStreamingSettings

    Properties​

    coordinate​

    • coordinate: boolean = true

    Whether to use the coordination data coming from the IFC files.

    Inherited from​

    IfcFragmentSettings.coordinate

    Defined in​

    temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:15

    excludedCategories​

    • excludedCategories: Set<number>

    List of categories that won't be converted to fragments.

    Inherited from​

    IfcFragmentSettings.excludedCategories

    Defined in​

    temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:25

    includeProperties​

    • includeProperties: boolean = true

    Whether to extract the IFC properties into a JSON.

    Inherited from​

    IfcFragmentSettings.includeProperties

    Defined in​

    temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:6

    optionalCategories​

    • optionalCategories: number[]

    Generate the geometry for categories that are not included by default, -like IFCSPACE.

    Inherited from​

    IfcFragmentSettings.optionalCategories

    Defined in​

    temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:12

    saveLocations​

    • saveLocations: boolean = false

    Whether to save the absolute location of all IFC items.

    Inherited from​

    IfcFragmentSettings.saveLocations

    Defined in​

    temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:28

    wasm​

    • wasm: Object

    Path of the WASM for web-ifc.

    Type declaration​

    NameType
    absoluteboolean
    logLevelundefined | LogLevel
    pathstring

    Inherited from​

    IfcFragmentSettings.wasm

    Defined in​

    temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:18

    webIfc​

    • webIfc: LoaderSettings

    Loader settings for web-ifc.

    Inherited from​

    IfcFragmentSettings.webIfc

    Defined in​

    temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:31

    - - +
    +
    Skip to main content

    Class: IfcStreamingSettings

    openbim-components.IfcStreamingSettings

    Configuration of the IFC-fragment streaming.

    Hierarchy​

    • IfcFragmentSettings

      ↳ IfcStreamingSettings

    Properties​

    coordinate​

    • coordinate: boolean = true

    Whether to use the coordination data coming from the IFC files.

    Inherited from​

    IfcFragmentSettings.coordinate

    Defined in​

    src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:15

    excludedCategories​

    • excludedCategories: Set<number>

    List of categories that won't be converted to fragments.

    Inherited from​

    IfcFragmentSettings.excludedCategories

    Defined in​

    src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:29

    includeProperties​

    • includeProperties: boolean = true

    Whether to extract the IFC properties into a JSON.

    Inherited from​

    IfcFragmentSettings.includeProperties

    Defined in​

    src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:6

    optionalCategories​

    • optionalCategories: number[]

    Generate the geometry for categories that are not included by default, +like IFCSPACE.

    Inherited from​

    IfcFragmentSettings.optionalCategories

    Defined in​

    src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:12

    saveLocations​

    • saveLocations: boolean = false

    Whether to save the absolute location of all IFC items.

    Inherited from​

    IfcFragmentSettings.saveLocations

    Defined in​

    src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:32

    wasm​

    • wasm: Object

    Path of the WASM for web-ifc.

    Type declaration​

    NameType
    absoluteboolean
    logLevel?LogLevel
    pathstring

    Inherited from​

    IfcFragmentSettings.wasm

    Defined in​

    src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:18

    webIfc​

    • webIfc: LoaderSettings

    Loader settings for web-ifc.

    Inherited from​

    IfcFragmentSettings.webIfc

    Defined in​

    src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:35

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.LengthMeasurement/index.html b/build/api/classes/openbim_components.LengthMeasurement/index.html index 083d15a5..be9c930c 100644 --- a/build/api/classes/openbim_components.LengthMeasurement/index.html +++ b/build/api/classes/openbim_components.LengthMeasurement/index.html @@ -3,17 +3,17 @@ -Class: LengthMeasurement | That Open Docs - - +Class: LengthMeasurement | That Open Docs + + -
    -
    Skip to main content

    Class: LengthMeasurement

    openbim-components.LengthMeasurement

    A basic dimension tool to measure distances between 2 points in 3D and -display a 3D symbol displaying the numeric value.

    Hierarchy​

    • Component<SimpleDimensionLine[]>

      ↳ LengthMeasurement

    Implements​

    Properties​

    onAfterCancel​

    • Readonly onAfterCancel: Event<SimpleDimensionLine>

    Createable.onAfterCancel

    Implementation of​

    Createable.onAfterCancel

    Defined in​

    temp/engine_components/src/measurement/LengthMeasurement/index.ts:52

    onAfterCreate​

    • Readonly onAfterCreate: Event<SimpleDimensionLine>

    Createable.onAfterCreate

    Implementation of​

    Createable.onAfterCreate

    Defined in​

    temp/engine_components/src/measurement/LengthMeasurement/index.ts:37

    onAfterDelete​

    • Readonly onAfterDelete: Event<LengthMeasurement>

    Createable.onAfterDelete

    Implementation of​

    Createable.onAfterDelete

    Defined in​

    temp/engine_components/src/measurement/LengthMeasurement/index.ts:43

    onAfterUpdate​

    • Readonly onAfterUpdate: Event<LengthMeasurement>

    Updateable.onAfterUpdate

    Implementation of​

    Updateable.onAfterUpdate

    Defined in​

    temp/engine_components/src/measurement/LengthMeasurement/index.ts:34

    onBeforeCancel​

    • Readonly onBeforeCancel: Event<LengthMeasurement>

    Createable.onBeforeCancel

    Implementation of​

    Createable.onBeforeCancel

    Defined in​

    temp/engine_components/src/measurement/LengthMeasurement/index.ts:49

    onBeforeCreate​

    • Readonly onBeforeCreate: Event<LengthMeasurement>

    Createable.onBeforeCreate

    Implementation of​

    Createable.onBeforeCreate

    Defined in​

    temp/engine_components/src/measurement/LengthMeasurement/index.ts:40

    onBeforeDelete​

    • Readonly onBeforeDelete: Event<SimpleDimensionLine>

    Createable.onBeforeDelete

    Implementation of​

    Createable.onBeforeDelete

    Defined in​

    temp/engine_components/src/measurement/LengthMeasurement/index.ts:46

    onBeforeUpdate​

    • Readonly onBeforeUpdate: Event<LengthMeasurement>

    Updateable.onBeforeUpdate

    Implementation of​

    Updateable.onBeforeUpdate

    Defined in​

    temp/engine_components/src/measurement/LengthMeasurement/index.ts:31

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    temp/engine_components/src/measurement/LengthMeasurement/index.ts:28

    previewElement​

    • Optional previewElement: HTMLElement

    The symbol -that is displayed where the dimension will be drawn.

    Defined in​

    temp/engine_components/src/measurement/LengthMeasurement/index.ts:61

    snapDistance​

    • snapDistance: number = 0.25

    The minimum distance to force the dimension cursor to a vertex.

    Defined in​

    temp/engine_components/src/measurement/LengthMeasurement/index.ts:57

    Accessors​

    color​

    • set color(color): void

    The Color -of the geometry of the dimensions.

    Parameters​

    NameType
    colorColor

    Returns​

    void

    Defined in​

    temp/engine_components/src/measurement/LengthMeasurement/index.ts:117

    enabled​

    • get enabled(): boolean

    Component.enabled

    Returns​

    boolean

    Overrides​

    Component.enabled

    Defined in​

    temp/engine_components/src/measurement/LengthMeasurement/index.ts:85

    • set enabled(value): void

    Component.enabled

    Parameters​

    NameType
    valueboolean

    Returns​

    void

    Overrides​

    Component.enabled

    Defined in​

    temp/engine_components/src/measurement/LengthMeasurement/index.ts:90

    visible​

    • get visible(): boolean

    Hideable.visible

    Returns​

    boolean

    Implementation of​

    Hideable.visible

    Defined in​

    temp/engine_components/src/measurement/LengthMeasurement/index.ts:101

    • set visible(value): void

    Hideable.visible

    Parameters​

    NameType
    valueboolean

    Returns​

    void

    Implementation of​

    Hideable.visible

    Defined in​

    temp/engine_components/src/measurement/LengthMeasurement/index.ts:106

    Methods​

    cancelCreation​

    ▸ cancelCreation(): void

    Cancels the drawing of the current dimension.

    Returns​

    void

    Implementation of​

    Createable.cancelCreation

    Defined in​

    temp/engine_components/src/measurement/LengthMeasurement/index.ts:258

    create​

    ▸ create(data?): Promise<void>

    Starts or finishes drawing a new dimension line.

    Parameters​

    NameTypeDescription
    data?anyforces the dimension to be drawn on a plane. Use this if you are drawing dimensions in floor plan navigation.

    Returns​

    Promise<void>

    Implementation of​

    Createable.create

    Defined in​

    temp/engine_components/src/measurement/LengthMeasurement/index.ts:203

    delete​

    ▸ delete(): Promise<void>

    Deletes the dimension that the user is hovering over with the mouse or touch event.

    Returns​

    Promise<void>

    Implementation of​

    Createable.delete

    Defined in​

    temp/engine_components/src/measurement/LengthMeasurement/index.ts:223

    deleteAll​

    ▸ deleteAll(): Promise<void>

    Deletes all the dimensions that have been previously created.

    Returns​

    Promise<void>

    Defined in​

    temp/engine_components/src/measurement/LengthMeasurement/index.ts:249

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    temp/engine_components/src/measurement/LengthMeasurement/index.ts:160

    get​

    ▸ get(): SimpleDimensionLine[]

    Component.get

    Returns​

    SimpleDimensionLine[]

    Overrides​

    Component.get

    Defined in​

    temp/engine_components/src/measurement/LengthMeasurement/index.ts:155

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    update​

    ▸ update(_delta): Promise<void>

    Updateable.update

    Parameters​

    NameType
    _deltanumber

    Returns​

    Promise<void>

    Implementation of​

    Updateable.update

    Defined in​

    temp/engine_components/src/measurement/LengthMeasurement/index.ts:186

    - - +
    +
    Skip to main content

    Class: LengthMeasurement

    openbim-components.LengthMeasurement

    A basic dimension tool to measure distances between 2 points in 3D and +display a 3D symbol displaying the numeric value.

    Hierarchy​

    • Component<SimpleDimensionLine[]>

      ↳ LengthMeasurement

    Implements​

    Properties​

    onAfterCancel​

    • Readonly onAfterCancel: Event<SimpleDimensionLine>

    Createable.onAfterCancel

    Implementation of​

    Createable.onAfterCancel

    Defined in​

    src/measurement/LengthMeasurement/index.ts:52

    onAfterCreate​

    • Readonly onAfterCreate: Event<SimpleDimensionLine>

    Createable.onAfterCreate

    Implementation of​

    Createable.onAfterCreate

    Defined in​

    src/measurement/LengthMeasurement/index.ts:37

    onAfterDelete​

    • Readonly onAfterDelete: Event<LengthMeasurement>

    Createable.onAfterDelete

    Implementation of​

    Createable.onAfterDelete

    Defined in​

    src/measurement/LengthMeasurement/index.ts:43

    onAfterUpdate​

    • Readonly onAfterUpdate: Event<LengthMeasurement>

    Updateable.onAfterUpdate

    Implementation of​

    Updateable.onAfterUpdate

    Defined in​

    src/measurement/LengthMeasurement/index.ts:34

    onBeforeCancel​

    • Readonly onBeforeCancel: Event<LengthMeasurement>

    Createable.onBeforeCancel

    Implementation of​

    Createable.onBeforeCancel

    Defined in​

    src/measurement/LengthMeasurement/index.ts:49

    onBeforeCreate​

    • Readonly onBeforeCreate: Event<LengthMeasurement>

    Createable.onBeforeCreate

    Implementation of​

    Createable.onBeforeCreate

    Defined in​

    src/measurement/LengthMeasurement/index.ts:40

    onBeforeDelete​

    • Readonly onBeforeDelete: Event<SimpleDimensionLine>

    Createable.onBeforeDelete

    Implementation of​

    Createable.onBeforeDelete

    Defined in​

    src/measurement/LengthMeasurement/index.ts:46

    onBeforeUpdate​

    • Readonly onBeforeUpdate: Event<LengthMeasurement>

    Updateable.onBeforeUpdate

    Implementation of​

    Updateable.onBeforeUpdate

    Defined in​

    src/measurement/LengthMeasurement/index.ts:31

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    src/measurement/LengthMeasurement/index.ts:28

    previewElement​

    • Optional previewElement: HTMLElement

    The symbol +that is displayed where the dimension will be drawn.

    Defined in​

    src/measurement/LengthMeasurement/index.ts:61

    snapDistance​

    • snapDistance: number = 0.25

    The minimum distance to force the dimension cursor to a vertex.

    Defined in​

    src/measurement/LengthMeasurement/index.ts:57

    Accessors​

    color​

    • set color(color): void

    The Color +of the geometry of the dimensions.

    Parameters​

    NameType
    colorColor

    Returns​

    void

    Defined in​

    src/measurement/LengthMeasurement/index.ts:117

    enabled​

    • get enabled(): boolean

    Component.enabled

    Returns​

    boolean

    Overrides​

    Component.enabled

    Defined in​

    src/measurement/LengthMeasurement/index.ts:85

    • set enabled(value): void

    Component.enabled

    Parameters​

    NameType
    valueboolean

    Returns​

    void

    Overrides​

    Component.enabled

    Defined in​

    src/measurement/LengthMeasurement/index.ts:90

    visible​

    • get visible(): boolean

    Hideable.visible

    Returns​

    boolean

    Implementation of​

    Hideable.visible

    Defined in​

    src/measurement/LengthMeasurement/index.ts:101

    • set visible(value): void

    Hideable.visible

    Parameters​

    NameType
    valueboolean

    Returns​

    void

    Implementation of​

    Hideable.visible

    Defined in​

    src/measurement/LengthMeasurement/index.ts:106

    Methods​

    cancelCreation​

    ▸ cancelCreation(): void

    Cancels the drawing of the current dimension.

    Returns​

    void

    Implementation of​

    Createable.cancelCreation

    Defined in​

    src/measurement/LengthMeasurement/index.ts:258

    create​

    ▸ create(data?): Promise<void>

    Starts or finishes drawing a new dimension line.

    Parameters​

    NameTypeDescription
    data?anyforces the dimension to be drawn on a plane. Use this if you are drawing dimensions in floor plan navigation.

    Returns​

    Promise<void>

    Implementation of​

    Createable.create

    Defined in​

    src/measurement/LengthMeasurement/index.ts:203

    delete​

    ▸ delete(): Promise<void>

    Deletes the dimension that the user is hovering over with the mouse or touch event.

    Returns​

    Promise<void>

    Implementation of​

    Createable.delete

    Defined in​

    src/measurement/LengthMeasurement/index.ts:223

    deleteAll​

    ▸ deleteAll(): Promise<void>

    Deletes all the dimensions that have been previously created.

    Returns​

    Promise<void>

    Defined in​

    src/measurement/LengthMeasurement/index.ts:249

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    src/measurement/LengthMeasurement/index.ts:160

    get​

    ▸ get(): SimpleDimensionLine[]

    Component.get

    Returns​

    SimpleDimensionLine[]

    Overrides​

    Component.get

    Defined in​

    src/measurement/LengthMeasurement/index.ts:155

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    src/base-types/component.ts:45

    update​

    ▸ update(_delta): Promise<void>

    Updateable.update

    Parameters​

    NameType
    _deltanumber

    Returns​

    Promise<void>

    Implementation of​

    Updateable.update

    Defined in​

    src/measurement/LengthMeasurement/index.ts:186

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.MaterialManager/index.html b/build/api/classes/openbim_components.MaterialManager/index.html index 8b2340a1..c866fd77 100644 --- a/build/api/classes/openbim_components.MaterialManager/index.html +++ b/build/api/classes/openbim_components.MaterialManager/index.html @@ -3,16 +3,16 @@ -Class: MaterialManager | That Open Docs - - +Class: MaterialManager | That Open Docs + + -
    -
    Skip to main content

    Class: MaterialManager

    openbim-components.MaterialManager

    A tool to easily handle the materials of massive amounts of -objects and scene background easily.

    Hierarchy​

    Implements​

    Properties​

    enabled​

    • enabled: boolean = true

    Component.enabled

    Overrides​

    Component.enabled

    Defined in​

    temp/engine_components/src/core/MaterialManager/index.ts:17

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    temp/engine_components/src/core/MaterialManager/index.ts:22

    Methods​

    addMaterial​

    ▸ addMaterial(id, material): void

    Creates a new material style.

    Parameters​

    NameTypeDescription
    idstringthe identifier of the style to create.
    materialMaterialthe material of the style.

    Returns​

    void

    Defined in​

    temp/engine_components/src/core/MaterialManager/index.ts:125

    addMeshes​

    ▸ addMeshes(id, meshes): void

    Assign meshes to a certain style.

    Parameters​

    NameTypeDescription
    idstringthe identifier of the style.
    meshesMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>[]the meshes to assign to the style.

    Returns​

    void

    Defined in​

    temp/engine_components/src/core/MaterialManager/index.ts:137

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    temp/engine_components/src/core/MaterialManager/index.ts:83

    get​

    ▸ get(): string[]

    Component.get.

    Returns​

    string[]

    list of created materials.

    Overrides​

    Component.get

    Defined in​

    temp/engine_components/src/core/MaterialManager/index.ts:47

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    removeMeshes​

    ▸ removeMeshes(id, meshes): void

    Remove meshes from a certain style.

    Parameters​

    NameTypeDescription
    idstringthe identifier of the style.
    meshesMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>[]the meshes to assign to the style.

    Returns​

    void

    Defined in​

    temp/engine_components/src/core/MaterialManager/index.ts:151

    resetBackgroundColor​

    ▸ resetBackgroundColor(): void

    Resets the scene background to the color that was being used -before applying the material manager.

    Returns​

    void

    Defined in​

    temp/engine_components/src/core/MaterialManager/index.ts:113

    set​

    ▸ set(active, ids?): void

    Turns the specified material styles on or off.

    Parameters​

    NameTypeDescription
    activebooleanwhether to turn it on or off.
    idsstring[]the ids of the style to turn on or off.

    Returns​

    void

    Defined in​

    temp/engine_components/src/core/MaterialManager/index.ts:57

    setBackgroundColor​

    ▸ setBackgroundColor(color): void

    Sets the color of the background of the scene.

    Parameters​

    NameType
    colorColor

    Returns​

    void

    Defined in​

    temp/engine_components/src/core/MaterialManager/index.ts:99

    - - +
    +
    Skip to main content

    Class: MaterialManager

    openbim-components.MaterialManager

    A tool to easily handle the materials of massive amounts of +objects and scene background easily.

    Hierarchy​

    Implements​

    Properties​

    enabled​

    • enabled: boolean = true

    Component.enabled

    Overrides​

    Component.enabled

    Defined in​

    src/core/MaterialManager/index.ts:17

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    src/core/MaterialManager/index.ts:22

    Methods​

    addMaterial​

    ▸ addMaterial(id, material): void

    Creates a new material style.

    Parameters​

    NameTypeDescription
    idstringthe identifier of the style to create.
    materialMaterialthe material of the style.

    Returns​

    void

    Defined in​

    src/core/MaterialManager/index.ts:125

    addMeshes​

    ▸ addMeshes(id, meshes): void

    Assign meshes to a certain style.

    Parameters​

    NameTypeDescription
    idstringthe identifier of the style.
    meshesMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>[]the meshes to assign to the style.

    Returns​

    void

    Defined in​

    src/core/MaterialManager/index.ts:137

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    src/core/MaterialManager/index.ts:83

    get​

    ▸ get(): string[]

    Component.get.

    Returns​

    string[]

    list of created materials.

    Overrides​

    Component.get

    Defined in​

    src/core/MaterialManager/index.ts:47

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    src/base-types/component.ts:45

    removeMeshes​

    ▸ removeMeshes(id, meshes): void

    Remove meshes from a certain style.

    Parameters​

    NameTypeDescription
    idstringthe identifier of the style.
    meshesMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>[]the meshes to assign to the style.

    Returns​

    void

    Defined in​

    src/core/MaterialManager/index.ts:151

    resetBackgroundColor​

    ▸ resetBackgroundColor(): void

    Resets the scene background to the color that was being used +before applying the material manager.

    Returns​

    void

    Defined in​

    src/core/MaterialManager/index.ts:113

    set​

    ▸ set(active, ids?): void

    Turns the specified material styles on or off.

    Parameters​

    NameTypeDescription
    activebooleanwhether to turn it on or off.
    idsstring[]the ids of the style to turn on or off.

    Returns​

    void

    Defined in​

    src/core/MaterialManager/index.ts:57

    setBackgroundColor​

    ▸ setBackgroundColor(color): void

    Sets the color of the background of the scene.

    Parameters​

    NameType
    colorColor

    Returns​

    void

    Defined in​

    src/core/MaterialManager/index.ts:99

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.Mouse/index.html b/build/api/classes/openbim_components.Mouse/index.html index b55d737a..5f32cc3c 100644 --- a/build/api/classes/openbim_components.Mouse/index.html +++ b/build/api/classes/openbim_components.Mouse/index.html @@ -3,17 +3,17 @@ -Class: Mouse | That Open Docs - - +Class: Mouse | That Open Docs + + -
    -
    Skip to main content

    Class: Mouse

    openbim-components.Mouse

    A helper to easily get the real position of the mouse in the Three.js canvas +

    +

    Class: Mouse

    openbim-components.Mouse

    A helper to easily get the real position of the mouse in the Three.js canvas to work with tools like the raycaster, even if it has -been transformed through CSS or doesn't occupy the whole screen.

    Implements​

    Properties​

    onDisposed​

    • Readonly onDisposed: Event<undefined>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    temp/engine_components/src/base-types/mouse.ts:15

    Accessors​

    position​

    • get position(): Vector2

    The real position of the mouse of the Three.js canvas.

    Returns​

    Vector2

    Defined in​

    temp/engine_components/src/base-types/mouse.ts:24

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    temp/engine_components/src/base-types/mouse.ts:34

    - - +been transformed through CSS or doesn't occupy the whole screen.

    Implements​

    Properties​

    onDisposed​

    • Readonly onDisposed: Event<undefined>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    src/base-types/mouse.ts:15

    Accessors​

    position​

    • get position(): Vector2

    The real position of the mouse of the Three.js canvas.

    Returns​

    Vector2

    Defined in​

    src/base-types/mouse.ts:24

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    src/base-types/mouse.ts:34

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.OrthoPerspectiveCamera/index.html b/build/api/classes/openbim_components.OrthoPerspectiveCamera/index.html index 8543188d..8c1cdf3b 100644 --- a/build/api/classes/openbim_components.OrthoPerspectiveCamera/index.html +++ b/build/api/classes/openbim_components.OrthoPerspectiveCamera/index.html @@ -3,24 +3,24 @@ -Class: OrthoPerspectiveCamera | That Open Docs - - +Class: OrthoPerspectiveCamera | That Open Docs + + -
    -
    Skip to main content

    Class: OrthoPerspectiveCamera

    openbim-components.OrthoPerspectiveCamera

    A flexible camera that uses +

    +

    Class: OrthoPerspectiveCamera

    openbim-components.OrthoPerspectiveCamera

    A flexible camera that uses yomotsu's cameracontrols to easily control the camera in 2D and 3D. It supports multiple navigation -modes, such as 2D floor plan navigation, first person and 3D orbit.

    Hierarchy​

    Implements​

    Properties​

    activeCamera​

    • activeCamera: PerspectiveCamera | OrthographicCamera

    The camera that is being used now according to the current CameraProjection.

    Inherited from​

    SimpleCamera.activeCamera

    Defined in​

    temp/engine_components/src/core/SimpleCamera/index.ts:48

    controls​

    • Readonly controls: CameraControls

    The object that controls the camera. An instance of +modes, such as 2D floor plan navigation, first person and 3D orbit.

    Hierarchy​

    Implements​

    Properties​

    activeCamera​

    • activeCamera: PerspectiveCamera | OrthographicCamera

    The camera that is being used now according to the current CameraProjection.

    Inherited from​

    SimpleCamera.activeCamera

    Defined in​

    src/core/SimpleCamera/index.ts:48

    controls​

    • Readonly controls: CameraControls

    The object that controls the camera. An instance of yomotsu's cameracontrols. Transforming the camera directly will have no effect: you need to use this -object to move, rotate, look at objects, etc.

    Inherited from​

    SimpleCamera.controls

    Defined in​

    temp/engine_components/src/core/SimpleCamera/index.ts:33

    currentMode​

    • currentMode: NavigationMode

    The current NavigationMode.

    Defined in​

    temp/engine_components/src/navigation/OrthoPerspectiveCamera/index.ts:24

    onAfterUpdate​

    • Readonly onAfterUpdate: Event<SimpleCamera>

    Updateable.onAfterUpdate

    Inherited from​

    SimpleCamera.onAfterUpdate

    Defined in​

    temp/engine_components/src/core/SimpleCamera/index.ts:20

    onBeforeUpdate​

    • Readonly onBeforeUpdate: Event<SimpleCamera>

    Updateable.onBeforeUpdate

    Inherited from​

    SimpleCamera.onBeforeUpdate

    Defined in​

    temp/engine_components/src/core/SimpleCamera/index.ts:17

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Inherited from​

    SimpleCamera.onDisposed

    Defined in​

    temp/engine_components/src/core/SimpleCamera/index.ts:25

    projectionChanged​

    • Readonly projectionChanged: Event<Camera>

    Event that fires when the CameraProjection changes.

    Defined in​

    temp/engine_components/src/navigation/OrthoPerspectiveCamera/index.ts:29

    Accessors​

    enabled​

    • get enabled(): boolean

    Component.enabled

    Returns​

    boolean

    Inherited from​

    SimpleCamera.enabled

    Defined in​

    temp/engine_components/src/core/SimpleCamera/index.ts:36

    • set enabled(enabled): void

    Component.enabled

    Parameters​

    NameType
    enabledboolean

    Returns​

    void

    Inherited from​

    SimpleCamera.enabled

    Defined in​

    temp/engine_components/src/core/SimpleCamera/index.ts:41

    matchOrthoDistanceEnabled​

    • set matchOrthoDistanceEnabled(value): void

    Match Ortho zoom with Perspective distance when changing projection mode

    Parameters​

    NameType
    valueboolean

    Returns​

    void

    Defined in​

    temp/engine_components/src/navigation/OrthoPerspectiveCamera/index.ts:136

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Overrides​

    SimpleCamera.dispose

    Defined in​

    temp/engine_components/src/navigation/OrthoPerspectiveCamera/index.ts:107

    fit​

    ▸ fit(meshes?, offset?): Promise<void>

    Make the camera view fit all the specified meshes.

    Parameters​

    NameTypeDefault valueDescription
    meshesIterable<Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>>undefinedthe meshes to fit. If it is not defined, it will evaluate Components.meshes.
    offsetnumber1.5the distance to the fit object

    Returns​

    Promise<void>

    Defined in​

    temp/engine_components/src/navigation/OrthoPerspectiveCamera/index.ts:197

    get​

    ▸ get(projection?): PerspectiveCamera | OrthographicCamera

    Similar to Component.get, but with an optional argument -to specify which camera to get.

    Parameters​

    NameTypeDescription
    projection?CameraProjectionThe camera corresponding to the CameraProjection specified. If no projection is specified, the active camera will be returned.

    Returns​

    PerspectiveCamera | OrthographicCamera

    Overrides​

    SimpleCamera.get

    Defined in​

    temp/engine_components/src/navigation/OrthoPerspectiveCamera/index.ts:121

    getProjection​

    ▸ getProjection(): CameraProjection

    Returns the current CameraProjection.

    Returns​

    CameraProjection

    Defined in​

    temp/engine_components/src/navigation/OrthoPerspectiveCamera/index.ts:131

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    SimpleCamera.hasUI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    SimpleCamera.isConfigurable

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    SimpleCamera.isDisposeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    SimpleCamera.isHideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    SimpleCamera.isResizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    SimpleCamera.isUpdateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    setNavigationMode​

    ▸ setNavigationMode(mode): void

    Sets a new NavigationMode and disables the previous one.

    Parameters​

    NameTypeDescription
    modeNavModeIDThe NavigationMode to set.

    Returns​

    void

    Defined in​

    temp/engine_components/src/navigation/OrthoPerspectiveCamera/index.ts:180

    setProjection​

    ▸ setProjection(projection): Promise<void>

    Sets the current CameraProjection. This triggers the event -projectionChanged.

    Parameters​

    NameTypeDescription
    projectionCameraProjectionThe new CameraProjection to set.

    Returns​

    Promise<void>

    Defined in​

    temp/engine_components/src/navigation/OrthoPerspectiveCamera/index.ts:157

    toggleProjection​

    ▸ toggleProjection(): Promise<void>

    Changes the current CameraProjection from Ortographic to Perspective -and Viceversa.

    Returns​

    Promise<void>

    Defined in​

    temp/engine_components/src/navigation/OrthoPerspectiveCamera/index.ts:144

    toggleUserInput​

    ▸ toggleUserInput(active): void

    Allows or prevents all user input.

    Parameters​

    NameTypeDescription
    activebooleanwhether to enable or disable user inputs.

    Returns​

    void

    Defined in​

    temp/engine_components/src/navigation/OrthoPerspectiveCamera/index.ts:167

    update​

    ▸ update(_delta): Promise<void>

    Updateable.update

    Parameters​

    NameType
    _deltanumber

    Returns​

    Promise<void>

    Inherited from​

    SimpleCamera.update

    Defined in​

    temp/engine_components/src/core/SimpleCamera/index.ts:81

    updateAspect​

    ▸ updateAspect(): void

    Updates the aspect of the camera to match the size of the -Components.renderer.

    Returns​

    void

    Inherited from​

    SimpleCamera.updateAspect

    Defined in​

    temp/engine_components/src/core/SimpleCamera/index.ts:93

    - - +object to move, rotate, look at objects, etc.

    Inherited from​

    SimpleCamera.controls

    Defined in​

    src/core/SimpleCamera/index.ts:33

    currentMode​

    • currentMode: NavigationMode

    The current NavigationMode.

    Defined in​

    src/navigation/OrthoPerspectiveCamera/index.ts:24

    onAfterUpdate​

    • Readonly onAfterUpdate: Event<SimpleCamera>

    Updateable.onAfterUpdate

    Inherited from​

    SimpleCamera.onAfterUpdate

    Defined in​

    src/core/SimpleCamera/index.ts:20

    onBeforeUpdate​

    • Readonly onBeforeUpdate: Event<SimpleCamera>

    Updateable.onBeforeUpdate

    Inherited from​

    SimpleCamera.onBeforeUpdate

    Defined in​

    src/core/SimpleCamera/index.ts:17

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Inherited from​

    SimpleCamera.onDisposed

    Defined in​

    src/core/SimpleCamera/index.ts:25

    projectionChanged​

    • Readonly projectionChanged: Event<Camera>

    Event that fires when the CameraProjection changes.

    Defined in​

    src/navigation/OrthoPerspectiveCamera/index.ts:29

    Accessors​

    enabled​

    • get enabled(): boolean

    Component.enabled

    Returns​

    boolean

    Inherited from​

    SimpleCamera.enabled

    Defined in​

    src/core/SimpleCamera/index.ts:36

    • set enabled(enabled): void

    Component.enabled

    Parameters​

    NameType
    enabledboolean

    Returns​

    void

    Inherited from​

    SimpleCamera.enabled

    Defined in​

    src/core/SimpleCamera/index.ts:41

    matchOrthoDistanceEnabled​

    • set matchOrthoDistanceEnabled(value): void

    Match Ortho zoom with Perspective distance when changing projection mode

    Parameters​

    NameType
    valueboolean

    Returns​

    void

    Defined in​

    src/navigation/OrthoPerspectiveCamera/index.ts:136

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Overrides​

    SimpleCamera.dispose

    Defined in​

    src/navigation/OrthoPerspectiveCamera/index.ts:107

    fit​

    ▸ fit(meshes?, offset?): Promise<void>

    Make the camera view fit all the specified meshes.

    Parameters​

    NameTypeDefault valueDescription
    meshesIterable<Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>>undefinedthe meshes to fit. If it is not defined, it will evaluate Components.meshes.
    offsetnumber1.5the distance to the fit object

    Returns​

    Promise<void>

    Defined in​

    src/navigation/OrthoPerspectiveCamera/index.ts:197

    get​

    ▸ get(projection?): PerspectiveCamera | OrthographicCamera

    Similar to Component.get, but with an optional argument +to specify which camera to get.

    Parameters​

    NameTypeDescription
    projection?CameraProjectionThe camera corresponding to the CameraProjection specified. If no projection is specified, the active camera will be returned.

    Returns​

    PerspectiveCamera | OrthographicCamera

    Overrides​

    SimpleCamera.get

    Defined in​

    src/navigation/OrthoPerspectiveCamera/index.ts:121

    getProjection​

    ▸ getProjection(): CameraProjection

    Returns the current CameraProjection.

    Returns​

    CameraProjection

    Defined in​

    src/navigation/OrthoPerspectiveCamera/index.ts:131

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    SimpleCamera.hasUI

    Defined in​

    src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    SimpleCamera.isConfigurable

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    SimpleCamera.isDisposeable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    SimpleCamera.isHideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    SimpleCamera.isResizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    SimpleCamera.isUpdateable

    Defined in​

    src/base-types/component.ts:45

    setNavigationMode​

    ▸ setNavigationMode(mode): void

    Sets a new NavigationMode and disables the previous one.

    Parameters​

    NameTypeDescription
    modeNavModeIDThe NavigationMode to set.

    Returns​

    void

    Defined in​

    src/navigation/OrthoPerspectiveCamera/index.ts:180

    setProjection​

    ▸ setProjection(projection): Promise<void>

    Sets the current CameraProjection. This triggers the event +projectionChanged.

    Parameters​

    NameTypeDescription
    projectionCameraProjectionThe new CameraProjection to set.

    Returns​

    Promise<void>

    Defined in​

    src/navigation/OrthoPerspectiveCamera/index.ts:157

    toggleProjection​

    ▸ toggleProjection(): Promise<void>

    Changes the current CameraProjection from Ortographic to Perspective +and Viceversa.

    Returns​

    Promise<void>

    Defined in​

    src/navigation/OrthoPerspectiveCamera/index.ts:144

    toggleUserInput​

    ▸ toggleUserInput(active): void

    Allows or prevents all user input.

    Parameters​

    NameTypeDescription
    activebooleanwhether to enable or disable user inputs.

    Returns​

    void

    Defined in​

    src/navigation/OrthoPerspectiveCamera/index.ts:167

    update​

    ▸ update(_delta): Promise<void>

    Updateable.update

    Parameters​

    NameType
    _deltanumber

    Returns​

    Promise<void>

    Inherited from​

    SimpleCamera.update

    Defined in​

    src/core/SimpleCamera/index.ts:81

    updateAspect​

    ▸ updateAspect(): void

    Updates the aspect of the camera to match the size of the +Components.renderer.

    Returns​

    void

    Inherited from​

    SimpleCamera.updateAspect

    Defined in​

    src/core/SimpleCamera/index.ts:93

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.PostproductionRenderer/index.html b/build/api/classes/openbim_components.PostproductionRenderer/index.html index eaf22f72..9ca64f67 100644 --- a/build/api/classes/openbim_components.PostproductionRenderer/index.html +++ b/build/api/classes/openbim_components.PostproductionRenderer/index.html @@ -3,19 +3,19 @@ -Class: PostproductionRenderer | That Open Docs - - +Class: PostproductionRenderer | That Open Docs + + -
    -
    Skip to main content

    Class: PostproductionRenderer

    openbim-components.PostproductionRenderer

    Renderer that uses efficient postproduction effects (e.g. Ambient Occlusion).

    Hierarchy​

    Properties​

    clippingPlanes​

    • clippingPlanes: Plane[] = []

    The list of clipping planes used by this -instance of the renderer.

    Inherited from​

    SimpleRenderer.clippingPlanes

    Defined in​

    temp/engine_components/src/base-types/base-renderer.ts:33

    container​

    • container: null | HTMLElement

    The HTML container of the THREE.js canvas where the scene is rendered.

    Inherited from​

    SimpleRenderer.container

    Defined in​

    temp/engine_components/src/core/SimpleRenderer/index.ts:26

    enabled​

    • enabled: boolean = true

    Component.enabled

    Inherited from​

    SimpleRenderer.enabled

    Defined in​

    temp/engine_components/src/core/SimpleRenderer/index.ts:23

    onAfterUpdate​

    • Readonly onAfterUpdate: Event<SimpleRenderer>

    Updateable.onAfterUpdate

    Inherited from​

    SimpleRenderer.onAfterUpdate

    Defined in​

    temp/engine_components/src/core/SimpleRenderer/index.ts:35

    onBeforeUpdate​

    • Readonly onBeforeUpdate: Event<SimpleRenderer>

    Updateable.onBeforeUpdate

    Inherited from​

    SimpleRenderer.onBeforeUpdate

    Defined in​

    temp/engine_components/src/core/SimpleRenderer/index.ts:32

    onClippingPlanesUpdated​

    • Readonly onClippingPlanesUpdated: Event<unknown>

    Event that fires when there has been a change to the list of clipping -planes used by the active renderer.

    Inherited from​

    SimpleRenderer.onClippingPlanesUpdated

    Defined in​

    temp/engine_components/src/base-types/base-renderer.ts:27

    onDisposed​

    • Readonly onDisposed: Event<undefined>

    Disposable.onDisposed

    Inherited from​

    SimpleRenderer.onDisposed

    Defined in​

    temp/engine_components/src/core/SimpleRenderer/index.ts:29

    onResize​

    • Readonly onResize: Event<any>

    Resizeable.onResize

    Inherited from​

    SimpleRenderer.onResize

    Defined in​

    temp/engine_components/src/base-types/base-renderer.ts:21

    postproduction​

    • postproduction: Postproduction

    Helper object to handle the postproduction effects applied.

    Defined in​

    temp/engine_components/src/navigation/PostproductionRenderer/index.ts:11

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose.

    Returns​

    Promise<void>

    Overrides​

    SimpleRenderer.dispose

    Defined in​

    temp/engine_components/src/navigation/PostproductionRenderer/index.ts:41

    get​

    ▸ get(): WebGLRenderer

    Component.get

    Returns​

    WebGLRenderer

    Inherited from​

    SimpleRenderer.get

    Defined in​

    temp/engine_components/src/core/SimpleRenderer/index.ts:75

    getSize​

    ▸ getSize(): Vector2

    Resizeable.getSize.

    Returns​

    Vector2

    Inherited from​

    SimpleRenderer.getSize

    Defined in​

    temp/engine_components/src/core/SimpleRenderer/index.ts:106

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    SimpleRenderer.hasUI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    SimpleRenderer.isConfigurable

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    SimpleRenderer.isDisposeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    SimpleRenderer.isHideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    SimpleRenderer.isResizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    SimpleRenderer.isUpdateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    resize​

    ▸ resize(size?): void

    Resizeable.resize.

    Parameters​

    NameType
    size?Vector2

    Returns​

    void

    Inherited from​

    SimpleRenderer.resize

    Defined in​

    temp/engine_components/src/core/SimpleRenderer/index.ts:114

    togglePlane​

    ▸ togglePlane(active, plane, isLocal?): void

    Adds or removes a +

    +

    Class: PostproductionRenderer

    openbim-components.PostproductionRenderer

    Renderer that uses efficient postproduction effects (e.g. Ambient Occlusion).

    Hierarchy​

    Properties​

    clippingPlanes​

    • clippingPlanes: Plane[] = []

    The list of clipping planes used by this +instance of the renderer.

    Inherited from​

    SimpleRenderer.clippingPlanes

    Defined in​

    src/base-types/base-renderer.ts:33

    container​

    • container: null | HTMLElement

    The HTML container of the THREE.js canvas where the scene is rendered.

    Inherited from​

    SimpleRenderer.container

    Defined in​

    src/core/SimpleRenderer/index.ts:26

    enabled​

    • enabled: boolean = true

    Component.enabled

    Inherited from​

    SimpleRenderer.enabled

    Defined in​

    src/core/SimpleRenderer/index.ts:23

    onAfterUpdate​

    • Readonly onAfterUpdate: Event<SimpleRenderer>

    Updateable.onAfterUpdate

    Inherited from​

    SimpleRenderer.onAfterUpdate

    Defined in​

    src/core/SimpleRenderer/index.ts:35

    onBeforeUpdate​

    • Readonly onBeforeUpdate: Event<SimpleRenderer>

    Updateable.onBeforeUpdate

    Inherited from​

    SimpleRenderer.onBeforeUpdate

    Defined in​

    src/core/SimpleRenderer/index.ts:32

    onClippingPlanesUpdated​

    • Readonly onClippingPlanesUpdated: Event<unknown>

    Event that fires when there has been a change to the list of clipping +planes used by the active renderer.

    Inherited from​

    SimpleRenderer.onClippingPlanesUpdated

    Defined in​

    src/base-types/base-renderer.ts:27

    onDisposed​

    • Readonly onDisposed: Event<undefined>

    Disposable.onDisposed

    Inherited from​

    SimpleRenderer.onDisposed

    Defined in​

    src/core/SimpleRenderer/index.ts:29

    onResize​

    • Readonly onResize: Event<any>

    Resizeable.onResize

    Inherited from​

    SimpleRenderer.onResize

    Defined in​

    src/base-types/base-renderer.ts:21

    postproduction​

    • postproduction: Postproduction

    Helper object to handle the postproduction effects applied.

    Defined in​

    src/navigation/PostproductionRenderer/index.ts:11

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose.

    Returns​

    Promise<void>

    Overrides​

    SimpleRenderer.dispose

    Defined in​

    src/navigation/PostproductionRenderer/index.ts:41

    get​

    ▸ get(): WebGLRenderer

    Component.get

    Returns​

    WebGLRenderer

    Inherited from​

    SimpleRenderer.get

    Defined in​

    src/core/SimpleRenderer/index.ts:75

    getSize​

    ▸ getSize(): Vector2

    Resizeable.getSize.

    Returns​

    Vector2

    Inherited from​

    SimpleRenderer.getSize

    Defined in​

    src/core/SimpleRenderer/index.ts:106

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    SimpleRenderer.hasUI

    Defined in​

    src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    SimpleRenderer.isConfigurable

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    SimpleRenderer.isDisposeable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    SimpleRenderer.isHideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    SimpleRenderer.isResizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    SimpleRenderer.isUpdateable

    Defined in​

    src/base-types/component.ts:45

    resize​

    ▸ resize(size?): void

    Resizeable.resize.

    Parameters​

    NameType
    size?Vector2

    Returns​

    void

    Inherited from​

    SimpleRenderer.resize

    Defined in​

    src/core/SimpleRenderer/index.ts:114

    togglePlane​

    ▸ togglePlane(active, plane, isLocal?): void

    Adds or removes a clipping plane -to the renderer.

    Parameters​

    NameType
    activeboolean
    planePlane
    isLocal?boolean

    Returns​

    void

    Inherited from​

    SimpleRenderer.togglePlane

    Defined in​

    temp/engine_components/src/base-types/base-renderer.ts:48

    update​

    ▸ update(): Promise<void>

    Updateable.update

    Returns​

    Promise<void>

    Overrides​

    SimpleRenderer.update

    Defined in​

    temp/engine_components/src/navigation/PostproductionRenderer/index.ts:25

    updateClippingPlanes​

    ▸ updateClippingPlanes(): Promise<void>

    Forces the update of the clipping planes and all components that depend -on them that are subscribed to onClippingPlanesUpdated.

    Returns​

    Promise<void>

    Inherited from​

    SimpleRenderer.updateClippingPlanes

    Defined in​

    temp/engine_components/src/base-types/base-renderer.ts:39

    - - +to the renderer.

    Parameters​

    NameType
    activeboolean
    planePlane
    isLocal?boolean

    Returns​

    void

    Inherited from​

    SimpleRenderer.togglePlane

    Defined in​

    src/base-types/base-renderer.ts:48

    update​

    ▸ update(): Promise<void>

    Updateable.update

    Returns​

    Promise<void>

    Overrides​

    SimpleRenderer.update

    Defined in​

    src/navigation/PostproductionRenderer/index.ts:25

    updateClippingPlanes​

    ▸ updateClippingPlanes(): Promise<void>

    Forces the update of the clipping planes and all components that depend +on them that are subscribed to onClippingPlanesUpdated.

    Returns​

    Promise<void>

    Inherited from​

    SimpleRenderer.updateClippingPlanes

    Defined in​

    src/base-types/base-renderer.ts:39

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.PropertiesStreamingSettings/index.html b/build/api/classes/openbim_components.PropertiesStreamingSettings/index.html index fb1ee196..e27c3509 100644 --- a/build/api/classes/openbim_components.PropertiesStreamingSettings/index.html +++ b/build/api/classes/openbim_components.PropertiesStreamingSettings/index.html @@ -3,15 +3,15 @@ -Class: PropertiesStreamingSettings | That Open Docs - - +Class: PropertiesStreamingSettings | That Open Docs + + -
    -
    Skip to main content

    Class: PropertiesStreamingSettings

    openbim-components.PropertiesStreamingSettings

    Configuration of the IFC-fragment streaming.

    Hierarchy​

    • IfcFragmentSettings

      ↳ PropertiesStreamingSettings

    Properties​

    coordinate​

    • coordinate: boolean = true

    Whether to use the coordination data coming from the IFC files.

    Inherited from​

    IfcFragmentSettings.coordinate

    Defined in​

    temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:15

    excludedCategories​

    • excludedCategories: Set<number>

    List of categories that won't be converted to fragments.

    Inherited from​

    IfcFragmentSettings.excludedCategories

    Defined in​

    temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:25

    includeProperties​

    • includeProperties: boolean = true

    Whether to extract the IFC properties into a JSON.

    Inherited from​

    IfcFragmentSettings.includeProperties

    Defined in​

    temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:6

    optionalCategories​

    • optionalCategories: number[]

    Generate the geometry for categories that are not included by default, -like IFCSPACE.

    Inherited from​

    IfcFragmentSettings.optionalCategories

    Defined in​

    temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:12

    saveLocations​

    • saveLocations: boolean = false

    Whether to save the absolute location of all IFC items.

    Inherited from​

    IfcFragmentSettings.saveLocations

    Defined in​

    temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:28

    wasm​

    • wasm: Object

    Path of the WASM for web-ifc.

    Type declaration​

    NameType
    absoluteboolean
    logLevelundefined | LogLevel
    pathstring

    Inherited from​

    IfcFragmentSettings.wasm

    Defined in​

    temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:18

    webIfc​

    • webIfc: LoaderSettings

    Loader settings for web-ifc.

    Inherited from​

    IfcFragmentSettings.webIfc

    Defined in​

    temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:31

    - - +
    +
    Skip to main content

    Class: PropertiesStreamingSettings

    openbim-components.PropertiesStreamingSettings

    Configuration of the IFC-fragment streaming.

    Hierarchy​

    • IfcFragmentSettings

      ↳ PropertiesStreamingSettings

    Properties​

    coordinate​

    • coordinate: boolean = true

    Whether to use the coordination data coming from the IFC files.

    Inherited from​

    IfcFragmentSettings.coordinate

    Defined in​

    src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:15

    excludedCategories​

    • excludedCategories: Set<number>

    List of categories that won't be converted to fragments.

    Inherited from​

    IfcFragmentSettings.excludedCategories

    Defined in​

    src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:29

    includeProperties​

    • includeProperties: boolean = true

    Whether to extract the IFC properties into a JSON.

    Inherited from​

    IfcFragmentSettings.includeProperties

    Defined in​

    src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:6

    optionalCategories​

    • optionalCategories: number[]

    Generate the geometry for categories that are not included by default, +like IFCSPACE.

    Inherited from​

    IfcFragmentSettings.optionalCategories

    Defined in​

    src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:12

    saveLocations​

    • saveLocations: boolean = false

    Whether to save the absolute location of all IFC items.

    Inherited from​

    IfcFragmentSettings.saveLocations

    Defined in​

    src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:32

    wasm​

    • wasm: Object

    Path of the WASM for web-ifc.

    Type declaration​

    NameType
    absoluteboolean
    logLevel?LogLevel
    pathstring

    Inherited from​

    IfcFragmentSettings.wasm

    Defined in​

    src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:18

    webIfc​

    • webIfc: LoaderSettings

    Loader settings for web-ifc.

    Inherited from​

    IfcFragmentSettings.webIfc

    Defined in​

    src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:35

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.ScreenCuller/index.html b/build/api/classes/openbim_components.ScreenCuller/index.html index 87507c06..d64881db 100644 --- a/build/api/classes/openbim_components.ScreenCuller/index.html +++ b/build/api/classes/openbim_components.ScreenCuller/index.html @@ -3,15 +3,15 @@ -Class: ScreenCuller | That Open Docs - - +Class: ScreenCuller | That Open Docs + + -
    -
    Skip to main content

    Class: ScreenCuller

    openbim-components.ScreenCuller

    A tool to handle big scenes efficiently by automatically hiding the objects -that are not visible to the camera.

    Hierarchy​

    • Component<Map<string, THREE.InstancedMesh>>

      ↳ ScreenCuller

    Implements​

    Properties​

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    temp/engine_components/src/core/ScreenCuller/index.ts:27

    Accessors​

    enabled​

    • get enabled(): boolean

    Component.enabled

    Returns​

    boolean

    Overrides​

    Component.enabled

    Defined in​

    temp/engine_components/src/core/ScreenCuller/index.ts:30

    needsUpdate​

    • get needsUpdate(): boolean

    Returns​

    boolean

    Deprecated

    use ScreenCuller.elements.needsUpdate instead.

    Defined in​

    temp/engine_components/src/core/ScreenCuller/index.ts:50

    • set needsUpdate(value): void

    Parameters​

    NameType
    valueboolean

    Returns​

    void

    Deprecated

    use ScreenCuller.elements.needsUpdate instead.

    Defined in​

    temp/engine_components/src/core/ScreenCuller/index.ts:55

    onViewUpdated​

    • get onViewUpdated(): Event<{ seen: Set<Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>> ; unseen: Set<Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>> }>

    Returns​

    Event<{ seen: Set<Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>> ; unseen: Set<Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>> }>

    Deprecated

    use ScreenCuller.elements.onViewUpdated instead.

    Defined in​

    temp/engine_components/src/core/ScreenCuller/index.ts:45

    renderDebugFrame​

    • get renderDebugFrame(): boolean

    Returns​

    boolean

    Deprecated

    use ScreenCuller.elements.renderDebugFrame instead.

    Defined in​

    temp/engine_components/src/core/ScreenCuller/index.ts:60

    • set renderDebugFrame(value): void

    Parameters​

    NameType
    valueboolean

    Returns​

    void

    Deprecated

    use ScreenCuller.elements.renderDebugFrame instead.

    Defined in​

    temp/engine_components/src/core/ScreenCuller/index.ts:65

    renderer​

    • get renderer(): WebGLRenderer

    Returns​

    WebGLRenderer

    Deprecated

    use ScreenCuller.elements.get instead.

    Defined in​

    temp/engine_components/src/core/ScreenCuller/index.ts:81

    Methods​

    add​

    ▸ add(mesh): void

    Parameters​

    NameType
    meshMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap> | InstancedMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>

    Returns​

    void

    Deprecated

    use ScreenCuller.elements.add instead.

    Defined in​

    temp/engine_components/src/core/ScreenCuller/index.ts:125

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    temp/engine_components/src/core/ScreenCuller/index.ts:115

    get​

    ▸ get(): Map<string, InstancedMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>>

    Component.get.

    Returns​

    Map<string, InstancedMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>>

    the map of internal meshes used to determine visibility.

    Overrides​

    Component.get

    Defined in​

    temp/engine_components/src/core/ScreenCuller/index.ts:110

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    updateVisibility​

    ▸ updateVisibility(force?): Promise<void>

    Parameters​

    NameType
    force?boolean

    Returns​

    Promise<void>

    Deprecated

    use ScreenCuller.elements.updateVisibility instead.

    Defined in​

    temp/engine_components/src/core/ScreenCuller/index.ts:132

    - - +
    +
    Skip to main content

    Class: ScreenCuller

    openbim-components.ScreenCuller

    A tool to handle big scenes efficiently by automatically hiding the objects +that are not visible to the camera.

    Hierarchy​

    • Component<Map<string, THREE.InstancedMesh>>

      ↳ ScreenCuller

    Implements​

    Properties​

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    src/core/ScreenCuller/index.ts:27

    Accessors​

    enabled​

    • get enabled(): boolean

    Component.enabled

    Returns​

    boolean

    Overrides​

    Component.enabled

    Defined in​

    src/core/ScreenCuller/index.ts:30

    needsUpdate​

    • get needsUpdate(): boolean

    Returns​

    boolean

    Deprecated

    use ScreenCuller.elements.needsUpdate instead.

    Defined in​

    src/core/ScreenCuller/index.ts:50

    • set needsUpdate(value): void

    Parameters​

    NameType
    valueboolean

    Returns​

    void

    Deprecated

    use ScreenCuller.elements.needsUpdate instead.

    Defined in​

    src/core/ScreenCuller/index.ts:55

    onViewUpdated​

    • get onViewUpdated(): Event<{ seen: Set<Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>> ; unseen: Set<Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>> }>

    Returns​

    Event<{ seen: Set<Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>> ; unseen: Set<Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>> }>

    Deprecated

    use ScreenCuller.elements.onViewUpdated instead.

    Defined in​

    src/core/ScreenCuller/index.ts:45

    renderDebugFrame​

    • get renderDebugFrame(): boolean

    Returns​

    boolean

    Deprecated

    use ScreenCuller.elements.renderDebugFrame instead.

    Defined in​

    src/core/ScreenCuller/index.ts:60

    • set renderDebugFrame(value): void

    Parameters​

    NameType
    valueboolean

    Returns​

    void

    Deprecated

    use ScreenCuller.elements.renderDebugFrame instead.

    Defined in​

    src/core/ScreenCuller/index.ts:65

    renderer​

    • get renderer(): WebGLRenderer

    Returns​

    WebGLRenderer

    Deprecated

    use ScreenCuller.elements.get instead.

    Defined in​

    src/core/ScreenCuller/index.ts:81

    Methods​

    add​

    ▸ add(mesh): void

    Parameters​

    NameType
    meshMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap> | InstancedMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>

    Returns​

    void

    Deprecated

    use ScreenCuller.elements.add instead.

    Defined in​

    src/core/ScreenCuller/index.ts:125

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    src/core/ScreenCuller/index.ts:115

    get​

    ▸ get(): Map<string, InstancedMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>>

    Component.get.

    Returns​

    Map<string, InstancedMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>>

    the map of internal meshes used to determine visibility.

    Overrides​

    Component.get

    Defined in​

    src/core/ScreenCuller/index.ts:110

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    src/base-types/component.ts:45

    updateVisibility​

    ▸ updateVisibility(force?): Promise<void>

    Parameters​

    NameType
    force?boolean

    Returns​

    Promise<void>

    Deprecated

    use ScreenCuller.elements.updateVisibility instead.

    Defined in​

    src/core/ScreenCuller/index.ts:132

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.Simple2DScene/index.html b/build/api/classes/openbim_components.Simple2DScene/index.html index 27a5b78b..5acbd1fc 100644 --- a/build/api/classes/openbim_components.Simple2DScene/index.html +++ b/build/api/classes/openbim_components.Simple2DScene/index.html @@ -3,15 +3,15 @@ -Class: Simple2DScene | That Open Docs - - +Class: Simple2DScene | That Open Docs + + -
    -
    Skip to main content

    Class: Simple2DScene

    openbim-components.Simple2DScene

    A simple floating 2D scene that you can use to easily draw 2D graphics -with all the power of Three.js.

    Hierarchy​

    Implements​

    Properties​

    camera​

    • Readonly camera: OrthographicCamera

    The camera that renders the scene.

    Defined in​

    temp/engine_components/src/core/Simple2DScene/index.ts:55

    controls​

    • controls: OrbitControls

    The camera controls that move around in the scene.

    Defined in​

    temp/engine_components/src/core/Simple2DScene/index.ts:52

    enabled​

    • enabled: boolean = true

    Component.enabled

    Overrides​

    Component.enabled

    Defined in​

    temp/engine_components/src/core/Simple2DScene/index.ts:41

    onAfterUpdate​

    • Readonly onAfterUpdate: Event<unknown>

    Updateable.onAfterUpdate

    Implementation of​

    Updateable.onAfterUpdate

    Defined in​

    temp/engine_components/src/core/Simple2DScene/index.ts:32

    onBeforeUpdate​

    • Readonly onBeforeUpdate: Event<unknown>

    Updateable.onBeforeUpdate

    Implementation of​

    Updateable.onBeforeUpdate

    Defined in​

    temp/engine_components/src/core/Simple2DScene/index.ts:35

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    temp/engine_components/src/core/Simple2DScene/index.ts:44

    onResize​

    • onResize: Event<Vector2>

    Resizeable.onResize

    Implementation of​

    Resizeable.onResize

    Defined in​

    temp/engine_components/src/core/Simple2DScene/index.ts:38

    uiElement​

    • uiElement: UIElement<{ container: SimpleUIComponent<HTMLElement> }>

    UI.uiElement

    Implementation of​

    UI.uiElement

    Defined in​

    temp/engine_components/src/core/Simple2DScene/index.ts:47

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    temp/engine_components/src/core/Simple2DScene/index.ts:150

    get​

    ▸ get(): Group<Object3DEventMap>

    Component.get

    Returns​

    Group<Object3DEventMap>

    the 2D scene.

    Overrides​

    Component.get

    Defined in​

    temp/engine_components/src/core/Simple2DScene/index.ts:145

    getSize​

    ▸ getSize(): Vector2

    Resizeable.getSize

    Returns​

    Vector2

    Implementation of​

    Resizeable.getSize

    Defined in​

    temp/engine_components/src/core/Simple2DScene/index.ts:173

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    resize​

    ▸ resize(): void

    Resizeable.resize

    Returns​

    void

    Implementation of​

    Resizeable.resize

    Defined in​

    temp/engine_components/src/core/Simple2DScene/index.ts:184

    update​

    ▸ update(): Promise<void>

    Updateable.update

    Returns​

    Promise<void>

    Implementation of​

    Updateable.update

    Defined in​

    temp/engine_components/src/core/Simple2DScene/index.ts:165

    - - +
    +
    Skip to main content

    Class: Simple2DScene

    openbim-components.Simple2DScene

    A simple floating 2D scene that you can use to easily draw 2D graphics +with all the power of Three.js.

    Hierarchy​

    Implements​

    Properties​

    camera​

    • Readonly camera: OrthographicCamera

    The camera that renders the scene.

    Defined in​

    src/core/Simple2DScene/index.ts:55

    controls​

    • Readonly controls: CameraControls

    The camera controls that move around in the scene.

    Defined in​

    src/core/Simple2DScene/index.ts:52

    enabled​

    • enabled: boolean = true

    Component.enabled

    Overrides​

    Component.enabled

    Defined in​

    src/core/Simple2DScene/index.ts:41

    onAfterUpdate​

    • Readonly onAfterUpdate: Event<unknown>

    Updateable.onAfterUpdate

    Implementation of​

    Updateable.onAfterUpdate

    Defined in​

    src/core/Simple2DScene/index.ts:32

    onBeforeUpdate​

    • Readonly onBeforeUpdate: Event<unknown>

    Updateable.onBeforeUpdate

    Implementation of​

    Updateable.onBeforeUpdate

    Defined in​

    src/core/Simple2DScene/index.ts:35

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    src/core/Simple2DScene/index.ts:44

    onResize​

    • onResize: Event<Vector2>

    Resizeable.onResize

    Implementation of​

    Resizeable.onResize

    Defined in​

    src/core/Simple2DScene/index.ts:38

    uiElement​

    • uiElement: UIElement<{ container: SimpleUIComponent<HTMLElement> }>

    UI.uiElement

    Implementation of​

    UI.uiElement

    Defined in​

    src/core/Simple2DScene/index.ts:47

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    src/core/Simple2DScene/index.ts:168

    get​

    ▸ get(): Group<Object3DEventMap>

    Component.get

    Returns​

    Group<Object3DEventMap>

    the 2D scene.

    Overrides​

    Component.get

    Defined in​

    src/core/Simple2DScene/index.ts:163

    getSize​

    ▸ getSize(): Vector2

    Resizeable.getSize

    Returns​

    Vector2

    Implementation of​

    Resizeable.getSize

    Defined in​

    src/core/Simple2DScene/index.ts:191

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    src/base-types/component.ts:45

    resize​

    ▸ resize(): void

    Resizeable.resize

    Returns​

    void

    Implementation of​

    Resizeable.resize

    Defined in​

    src/core/Simple2DScene/index.ts:202

    update​

    ▸ update(): Promise<void>

    Updateable.update

    Returns​

    Promise<void>

    Implementation of​

    Updateable.update

    Defined in​

    src/core/Simple2DScene/index.ts:183

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.SimpleCamera/index.html b/build/api/classes/openbim_components.SimpleCamera/index.html index c501cdf7..fd2f1d78 100644 --- a/build/api/classes/openbim_components.SimpleCamera/index.html +++ b/build/api/classes/openbim_components.SimpleCamera/index.html @@ -3,21 +3,21 @@ -Class: SimpleCamera | That Open Docs - - +Class: SimpleCamera | That Open Docs + + -
    -
    Skip to main content

    Class: SimpleCamera

    openbim-components.SimpleCamera

    A basic camera that uses +

    +

    Class: SimpleCamera

    openbim-components.SimpleCamera

    A basic camera that uses yomotsu's cameracontrols to easily control the camera in 2D and 3D. Check out it's API to find out -what features it offers.

    Hierarchy​

    Implements​

    Properties​

    activeCamera​

    • activeCamera: PerspectiveCamera | OrthographicCamera

    The camera that is being used now according to the current CameraProjection.

    Defined in​

    temp/engine_components/src/core/SimpleCamera/index.ts:48

    controls​

    • Readonly controls: CameraControls

    The object that controls the camera. An instance of +what features it offers.

    Hierarchy​

    Implements​

    Properties​

    activeCamera​

    • activeCamera: PerspectiveCamera | OrthographicCamera

    The camera that is being used now according to the current CameraProjection.

    Defined in​

    src/core/SimpleCamera/index.ts:48

    controls​

    • Readonly controls: CameraControls

    The object that controls the camera. An instance of yomotsu's cameracontrols. Transforming the camera directly will have no effect: you need to use this -object to move, rotate, look at objects, etc.

    Defined in​

    temp/engine_components/src/core/SimpleCamera/index.ts:33

    onAfterUpdate​

    • Readonly onAfterUpdate: Event<SimpleCamera>

    Updateable.onAfterUpdate

    Implementation of​

    Updateable.onAfterUpdate

    Defined in​

    temp/engine_components/src/core/SimpleCamera/index.ts:20

    onBeforeUpdate​

    • Readonly onBeforeUpdate: Event<SimpleCamera>

    Updateable.onBeforeUpdate

    Implementation of​

    Updateable.onBeforeUpdate

    Defined in​

    temp/engine_components/src/core/SimpleCamera/index.ts:17

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    temp/engine_components/src/core/SimpleCamera/index.ts:25

    Accessors​

    enabled​

    • get enabled(): boolean

    Component.enabled

    Returns​

    boolean

    Overrides​

    Component.enabled

    Defined in​

    temp/engine_components/src/core/SimpleCamera/index.ts:36

    • set enabled(enabled): void

    Component.enabled

    Parameters​

    NameType
    enabledboolean

    Returns​

    void

    Overrides​

    Component.enabled

    Defined in​

    temp/engine_components/src/core/SimpleCamera/index.ts:41

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    temp/engine_components/src/core/SimpleCamera/index.ts:68

    get​

    ▸ get(): PerspectiveCamera | OrthographicCamera

    Component.get

    Returns​

    PerspectiveCamera | OrthographicCamera

    Overrides​

    Component.get

    Defined in​

    temp/engine_components/src/core/SimpleCamera/index.ts:63

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    update​

    ▸ update(_delta): Promise<void>

    Updateable.update

    Parameters​

    NameType
    _deltanumber

    Returns​

    Promise<void>

    Implementation of​

    Updateable.update

    Defined in​

    temp/engine_components/src/core/SimpleCamera/index.ts:81

    updateAspect​

    ▸ updateAspect(): void

    Updates the aspect of the camera to match the size of the -Components.renderer.

    Returns​

    void

    Defined in​

    temp/engine_components/src/core/SimpleCamera/index.ts:93

    - - +object to move, rotate, look at objects, etc.

    Defined in​

    src/core/SimpleCamera/index.ts:33

    onAfterUpdate​

    • Readonly onAfterUpdate: Event<SimpleCamera>

    Updateable.onAfterUpdate

    Implementation of​

    Updateable.onAfterUpdate

    Defined in​

    src/core/SimpleCamera/index.ts:20

    onBeforeUpdate​

    • Readonly onBeforeUpdate: Event<SimpleCamera>

    Updateable.onBeforeUpdate

    Implementation of​

    Updateable.onBeforeUpdate

    Defined in​

    src/core/SimpleCamera/index.ts:17

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    src/core/SimpleCamera/index.ts:25

    Accessors​

    enabled​

    • get enabled(): boolean

    Component.enabled

    Returns​

    boolean

    Overrides​

    Component.enabled

    Defined in​

    src/core/SimpleCamera/index.ts:36

    • set enabled(enabled): void

    Component.enabled

    Parameters​

    NameType
    enabledboolean

    Returns​

    void

    Overrides​

    Component.enabled

    Defined in​

    src/core/SimpleCamera/index.ts:41

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    src/core/SimpleCamera/index.ts:68

    get​

    ▸ get(): PerspectiveCamera | OrthographicCamera

    Component.get

    Returns​

    PerspectiveCamera | OrthographicCamera

    Overrides​

    Component.get

    Defined in​

    src/core/SimpleCamera/index.ts:63

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    src/base-types/component.ts:45

    update​

    ▸ update(_delta): Promise<void>

    Updateable.update

    Parameters​

    NameType
    _deltanumber

    Returns​

    Promise<void>

    Implementation of​

    Updateable.update

    Defined in​

    src/core/SimpleCamera/index.ts:81

    updateAspect​

    ▸ updateAspect(): void

    Updates the aspect of the camera to match the size of the +Components.renderer.

    Returns​

    void

    Defined in​

    src/core/SimpleCamera/index.ts:93

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.SimpleClipper/index.html b/build/api/classes/openbim_components.SimpleClipper/index.html index 378b908f..e363e23a 100644 --- a/build/api/classes/openbim_components.SimpleClipper/index.html +++ b/build/api/classes/openbim_components.SimpleClipper/index.html @@ -3,22 +3,22 @@ -Class: SimpleClipper<T> | That Open Docs - - +Class: SimpleClipper<T> | That Open Docs + + -
    -
    Skip to main content

    Class: SimpleClipper<T>

    openbim-components.SimpleClipper

    A lightweight component to easily create and handle +

    +

    Class: SimpleClipper<T>

    openbim-components.SimpleClipper

    A lightweight component to easily create and handle clipping planes.

    Param

    the instance of Components used.

    Param

    the type of plane to be used by the clipper. -E.g. SimplePlane.

    Type parameters​

    NameType
    Textends SimplePlane

    Hierarchy​

    Implements​

    Properties​

    onAfterCreate​

    • Readonly onAfterCreate: Event<T>

    Createable.onAfterCreate

    Implementation of​

    Createable.onAfterCreate

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:35

    onAfterDelete​

    • Readonly onAfterDelete: Event<T>

    Createable.onAfterDelete

    Implementation of​

    Createable.onAfterDelete

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:38

    onAfterDrag​

    • Readonly onAfterDrag: Event<void>

    Event that fires when the user stops dragging a clipping plane.

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:44

    onBeforeDrag​

    • Readonly onBeforeDrag: Event<void>

    Event that fires when the user starts dragging a clipping plane.

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:41

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:73

    orthogonalY​

    • orthogonalY: boolean = false

    Whether to force the clipping plane to be orthogonal in the Y direction +E.g. SimplePlane.

    Type parameters​

    NameType
    Textends SimplePlane

    Hierarchy​

    Implements​

    Properties​

    onAfterCreate​

    • Readonly onAfterCreate: Event<T>

    Createable.onAfterCreate

    Implementation of​

    Createable.onAfterCreate

    Defined in​

    src/core/SimpleClipper/index.ts:35

    onAfterDelete​

    • Readonly onAfterDelete: Event<T>

    Createable.onAfterDelete

    Implementation of​

    Createable.onAfterDelete

    Defined in​

    src/core/SimpleClipper/index.ts:38

    onAfterDrag​

    • Readonly onAfterDrag: Event<void>

    Event that fires when the user stops dragging a clipping plane.

    Defined in​

    src/core/SimpleClipper/index.ts:44

    onBeforeDrag​

    • Readonly onBeforeDrag: Event<void>

    Event that fires when the user starts dragging a clipping plane.

    Defined in​

    src/core/SimpleClipper/index.ts:41

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    src/core/SimpleClipper/index.ts:73

    orthogonalY​

    • orthogonalY: boolean = false

    Whether to force the clipping plane to be orthogonal in the Y direction (up). This is desirable when clipping a building horizontally and a clipping plane is created in it's roof, which might have a slight -slope for draining purposes.

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:60

    toleranceOrthogonalY​

    • toleranceOrthogonalY: number = 0.7

    The tolerance that determines whether a horizontallish clipping plane +slope for draining purposes.

    Defined in​

    src/core/SimpleClipper/index.ts:60

    toleranceOrthogonalY​

    • toleranceOrthogonalY: number = 0.7

    The tolerance that determines whether a horizontallish clipping plane will be forced to be orthogonal to the Y direction. orthogonalY -has to be true for this to apply.

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:67

    uiElement​

    • uiElement: UIElement<{ main: Button }>

    UI.uiElement

    Implementation of​

    UI.uiElement

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:52

    Accessors​

    enabled​

    • get enabled(): boolean

    Component.enabled

    Returns​

    boolean

    Overrides​

    Component.enabled

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:88

    • set enabled(state): void

    Component.enabled

    Parameters​

    NameType
    stateboolean

    Returns​

    void

    Overrides​

    Component.enabled

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:93

    material​

    • get material(): Material

    The material of the clipping plane representation.

    Returns​

    Material

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:118

    • set material(material): void

    The material of the clipping plane representation.

    Parameters​

    NameType
    materialMaterial

    Returns​

    void

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:123

    size​

    • get size(): number

    The size of the geometric representation of the clippings planes.

    Returns​

    number

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:131

    • set size(size): void

    The size of the geometric representation of the clippings planes.

    Parameters​

    NameType
    sizenumber

    Returns​

    void

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:136

    visible​

    • get visible(): boolean

    Hideable.visible

    Returns​

    boolean

    Implementation of​

    Hideable.visible

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:105

    • set visible(state): void

    Hideable.visible

    Parameters​

    NameType
    stateboolean

    Returns​

    void

    Implementation of​

    Hideable.visible

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:110

    Methods​

    create​

    ▸ create(): void

    Createable.create

    Returns​

    void

    Implementation of​

    Createable.create

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:184

    createFromNormalAndCoplanarPoint​

    ▸ createFromNormalAndCoplanarPoint(normal, point): T

    Creates a plane in a certain place and with a certain orientation, -without the need of the mouse.

    Parameters​

    NameTypeDescription
    normalVector3the orientation of the clipping plane.
    pointVector3the position of the clipping plane.

    Returns​

    T

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:200

    delete​

    ▸ delete(plane?): void

    Createable.delete

    Parameters​

    NameTypeDescription
    plane?Tthe plane to delete. If undefined, the the first plane found under the cursor will be deleted.

    Returns​

    void

    Implementation of​

    Createable.delete

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:215

    deleteAll​

    ▸ deleteAll(): void

    Deletes all the existing clipping planes.

    Returns​

    void

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:227

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:163

    get​

    ▸ get(): T[]

    Component.get

    Returns​

    T[]

    Overrides​

    Component.get

    Defined in​

    temp/engine_components/src/core/SimpleClipper/index.ts:158

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    - - +has to be true for this to apply.

    Defined in​

    src/core/SimpleClipper/index.ts:67

    uiElement​

    • uiElement: UIElement<{ main: Button }>

    UI.uiElement

    Implementation of​

    UI.uiElement

    Defined in​

    src/core/SimpleClipper/index.ts:52

    Accessors​

    enabled​

    • get enabled(): boolean

    Component.enabled

    Returns​

    boolean

    Overrides​

    Component.enabled

    Defined in​

    src/core/SimpleClipper/index.ts:88

    • set enabled(state): void

    Component.enabled

    Parameters​

    NameType
    stateboolean

    Returns​

    void

    Overrides​

    Component.enabled

    Defined in​

    src/core/SimpleClipper/index.ts:93

    material​

    • get material(): Material

    The material of the clipping plane representation.

    Returns​

    Material

    Defined in​

    src/core/SimpleClipper/index.ts:118

    • set material(material): void

    The material of the clipping plane representation.

    Parameters​

    NameType
    materialMaterial

    Returns​

    void

    Defined in​

    src/core/SimpleClipper/index.ts:123

    size​

    • get size(): number

    The size of the geometric representation of the clippings planes.

    Returns​

    number

    Defined in​

    src/core/SimpleClipper/index.ts:131

    • set size(size): void

    The size of the geometric representation of the clippings planes.

    Parameters​

    NameType
    sizenumber

    Returns​

    void

    Defined in​

    src/core/SimpleClipper/index.ts:136

    visible​

    • get visible(): boolean

    Hideable.visible

    Returns​

    boolean

    Implementation of​

    Hideable.visible

    Defined in​

    src/core/SimpleClipper/index.ts:105

    • set visible(state): void

    Hideable.visible

    Parameters​

    NameType
    stateboolean

    Returns​

    void

    Implementation of​

    Hideable.visible

    Defined in​

    src/core/SimpleClipper/index.ts:110

    Methods​

    create​

    ▸ create(): void

    Createable.create

    Returns​

    void

    Implementation of​

    Createable.create

    Defined in​

    src/core/SimpleClipper/index.ts:184

    createFromNormalAndCoplanarPoint​

    ▸ createFromNormalAndCoplanarPoint(normal, point): T

    Creates a plane in a certain place and with a certain orientation, +without the need of the mouse.

    Parameters​

    NameTypeDescription
    normalVector3the orientation of the clipping plane.
    pointVector3the position of the clipping plane.

    Returns​

    T

    Defined in​

    src/core/SimpleClipper/index.ts:200

    delete​

    ▸ delete(plane?): void

    Createable.delete

    Parameters​

    NameTypeDescription
    plane?Tthe plane to delete. If undefined, the the first plane found under the cursor will be deleted.

    Returns​

    void

    Implementation of​

    Createable.delete

    Defined in​

    src/core/SimpleClipper/index.ts:215

    deleteAll​

    ▸ deleteAll(): void

    Deletes all the existing clipping planes.

    Returns​

    void

    Defined in​

    src/core/SimpleClipper/index.ts:227

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    src/core/SimpleClipper/index.ts:163

    get​

    ▸ get(): T[]

    Component.get

    Returns​

    T[]

    Overrides​

    Component.get

    Defined in​

    src/core/SimpleClipper/index.ts:158

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    src/base-types/component.ts:45

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.SimpleGrid/index.html b/build/api/classes/openbim_components.SimpleGrid/index.html index 5a8224e7..a46ebb29 100644 --- a/build/api/classes/openbim_components.SimpleGrid/index.html +++ b/build/api/classes/openbim_components.SimpleGrid/index.html @@ -3,19 +3,19 @@ -Class: SimpleGrid | That Open Docs - - +Class: SimpleGrid | That Open Docs + + -
    -
    Skip to main content

    Class: SimpleGrid

    openbim-components.SimpleGrid

    An infinite grid. Created by +

    +

    Class: SimpleGrid

    openbim-components.SimpleGrid

    An infinite grid. Created by fyrestar and translated to typescript by -dkaraush.

    Hierarchy​

    Implements​

    Properties​

    enabled​

    • enabled: boolean = true

    Component.enabled

    Overrides​

    Component.enabled

    Defined in​

    temp/engine_components/src/core/SimpleGrid/index.ts:24

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    temp/engine_components/src/core/SimpleGrid/index.ts:21

    Accessors​

    fade​

    • get fade(): boolean

    Whether the grid should fade away with distance. Recommended to be true for -perspective cameras and false for orthographic cameras.

    Returns​

    boolean

    Defined in​

    temp/engine_components/src/core/SimpleGrid/index.ts:50

    • set fade(active): void

    Whether the grid should fade away with distance. Recommended to be true for -perspective cameras and false for orthographic cameras.

    Parameters​

    NameType
    activeboolean

    Returns​

    void

    Defined in​

    temp/engine_components/src/core/SimpleGrid/index.ts:58

    material​

    • get material(): ShaderMaterial

    The material of the grid.

    Returns​

    ShaderMaterial

    Defined in​

    temp/engine_components/src/core/SimpleGrid/index.ts:42

    visible​

    • get visible(): boolean

    Hideable.visible

    Returns​

    boolean

    Implementation of​

    Hideable.visible

    Defined in​

    temp/engine_components/src/core/SimpleGrid/index.ts:27

    • set visible(visible): void

    Hideable.visible

    Parameters​

    NameType
    visibleboolean

    Returns​

    void

    Implementation of​

    Hideable.visible

    Defined in​

    temp/engine_components/src/core/SimpleGrid/index.ts:32

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    temp/engine_components/src/core/SimpleGrid/index.ts:189

    get​

    ▸ get(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

    Component.get

    Returns​

    Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

    Overrides​

    Component.get

    Defined in​

    temp/engine_components/src/core/SimpleGrid/index.ts:184

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    - - +dkaraush.

    Hierarchy​

    Implements​

    Properties​

    enabled​

    • enabled: boolean = true

    Component.enabled

    Overrides​

    Component.enabled

    Defined in​

    src/core/SimpleGrid/index.ts:24

    onDisposed​

    • Readonly onDisposed: Event<string>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    src/core/SimpleGrid/index.ts:21

    Accessors​

    fade​

    • get fade(): boolean

    Whether the grid should fade away with distance. Recommended to be true for +perspective cameras and false for orthographic cameras.

    Returns​

    boolean

    Defined in​

    src/core/SimpleGrid/index.ts:50

    • set fade(active): void

    Whether the grid should fade away with distance. Recommended to be true for +perspective cameras and false for orthographic cameras.

    Parameters​

    NameType
    activeboolean

    Returns​

    void

    Defined in​

    src/core/SimpleGrid/index.ts:58

    material​

    • get material(): ShaderMaterial

    The material of the grid.

    Returns​

    ShaderMaterial

    Defined in​

    src/core/SimpleGrid/index.ts:42

    visible​

    • get visible(): boolean

    Hideable.visible

    Returns​

    boolean

    Implementation of​

    Hideable.visible

    Defined in​

    src/core/SimpleGrid/index.ts:27

    • set visible(visible): void

    Hideable.visible

    Parameters​

    NameType
    visibleboolean

    Returns​

    void

    Implementation of​

    Hideable.visible

    Defined in​

    src/core/SimpleGrid/index.ts:32

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    src/core/SimpleGrid/index.ts:189

    get​

    ▸ get(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

    Component.get

    Returns​

    Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

    Overrides​

    Component.get

    Defined in​

    src/core/SimpleGrid/index.ts:184

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    src/base-types/component.ts:45

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.SimplePlane/index.html b/build/api/classes/openbim_components.SimplePlane/index.html index fffff293..2fc071af 100644 --- a/build/api/classes/openbim_components.SimplePlane/index.html +++ b/build/api/classes/openbim_components.SimplePlane/index.html @@ -3,14 +3,14 @@ -Class: SimplePlane | That Open Docs - - +Class: SimplePlane | That Open Docs + + -
    -
    Skip to main content

    Class: SimplePlane

    openbim-components.SimplePlane

    Each of the planes created by SimpleClipper.

    Hierarchy​

    Implements​

    Properties​

    name​

    • name: string = "SimplePlane"

    Component.name

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:14

    onDisposed​

    • Readonly onDisposed: Event<undefined>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:23

    onDraggingEnded​

    • Readonly onDraggingEnded: Event<void>

    Event that fires when the user stops dragging a clipping plane.

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:20

    onDraggingStarted​

    • Readonly onDraggingStarted: Event<void>

    Event that fires when the user starts dragging a clipping plane.

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:17

    Accessors​

    enabled​

    • get enabled(): boolean

    Component.enabled

    Returns​

    boolean

    Overrides​

    Component.enabled

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:47

    • set enabled(state): void

    Component.enabled

    Parameters​

    NameType
    stateboolean

    Returns​

    void

    Overrides​

    Component.enabled

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:52

    meshes​

    • get meshes(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>[]

    The meshes used for raycasting

    Returns​

    Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>[]

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:71

    planeMaterial​

    • get planeMaterial(): Material | Material[]

    The material of the clipping plane representation.

    Returns​

    Material | Material[]

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:76

    • set planeMaterial(material): void

    The material of the clipping plane representation.

    Parameters​

    NameType
    materialMaterial | Material[]

    Returns​

    void

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:81

    size​

    • get size(): number

    The size of the clipping plane representation.

    Returns​

    number

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:86

    • set size(size): void

    Sets the size of the clipping plane representation.

    Parameters​

    NameType
    sizenumber

    Returns​

    void

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:91

    visible​

    • get visible(): boolean

    Hideable.visible

    Returns​

    boolean

    Implementation of​

    Hideable.visible

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:58

    • set visible(state): void

    Hideable.visible

    Parameters​

    NameType
    stateboolean

    Returns​

    void

    Implementation of​

    Hideable.visible

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:63

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:142

    get​

    ▸ get(): Plane

    Component.get

    Returns​

    Plane

    Overrides​

    Component.get

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:137

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    update​

    ▸ update(): void

    Updateable.update

    Returns​

    void

    Defined in​

    temp/engine_components/src/core/SimpleClipper/simple-plane.ts:128

    - - +
    +
    Skip to main content

    Class: SimplePlane

    openbim-components.SimplePlane

    Each of the planes created by SimpleClipper.

    Hierarchy​

    Implements​

    Properties​

    name​

    • name: string = "SimplePlane"

    Component.name

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:14

    onDisposed​

    • Readonly onDisposed: Event<undefined>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:23

    onDraggingEnded​

    • Readonly onDraggingEnded: Event<void>

    Event that fires when the user stops dragging a clipping plane.

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:20

    onDraggingStarted​

    • Readonly onDraggingStarted: Event<void>

    Event that fires when the user starts dragging a clipping plane.

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:17

    Accessors​

    enabled​

    • get enabled(): boolean

    Component.enabled

    Returns​

    boolean

    Overrides​

    Component.enabled

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:47

    • set enabled(state): void

    Component.enabled

    Parameters​

    NameType
    stateboolean

    Returns​

    void

    Overrides​

    Component.enabled

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:52

    meshes​

    • get meshes(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>[]

    The meshes used for raycasting

    Returns​

    Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>[]

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:71

    planeMaterial​

    • get planeMaterial(): Material | Material[]

    The material of the clipping plane representation.

    Returns​

    Material | Material[]

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:76

    • set planeMaterial(material): void

    The material of the clipping plane representation.

    Parameters​

    NameType
    materialMaterial | Material[]

    Returns​

    void

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:81

    size​

    • get size(): number

    The size of the clipping plane representation.

    Returns​

    number

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:86

    • set size(size): void

    Sets the size of the clipping plane representation.

    Parameters​

    NameType
    sizenumber

    Returns​

    void

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:91

    visible​

    • get visible(): boolean

    Hideable.visible

    Returns​

    boolean

    Implementation of​

    Hideable.visible

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:58

    • set visible(state): void

    Hideable.visible

    Parameters​

    NameType
    stateboolean

    Returns​

    void

    Implementation of​

    Hideable.visible

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:63

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:152

    get​

    ▸ get(): Plane

    Component.get

    Returns​

    Plane

    Overrides​

    Component.get

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:147

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    src/base-types/component.ts:45

    update​

    ▸ update(): Promise<void>

    Updateable.update

    Returns​

    Promise<void>

    Defined in​

    src/core/SimpleClipper/simple-plane.ts:138

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.SimpleRaycaster/index.html b/build/api/classes/openbim_components.SimpleRaycaster/index.html index 081c59ed..06511fc2 100644 --- a/build/api/classes/openbim_components.SimpleRaycaster/index.html +++ b/build/api/classes/openbim_components.SimpleRaycaster/index.html @@ -3,18 +3,18 @@ -Class: SimpleRaycaster | That Open Docs - - +Class: SimpleRaycaster | That Open Docs + + -
    -
    Skip to main content

    Class: SimpleRaycaster

    openbim-components.SimpleRaycaster

    A simple raycaster +

    +

    Class: SimpleRaycaster

    openbim-components.SimpleRaycaster

    A simple raycaster that allows to easily get items from the scene using the mouse and touch -events.

    Hierarchy​

    • BaseRaycaster

      ↳ SimpleRaycaster

    Implements​

    Properties​

    enabled​

    • enabled: boolean = true

    Component.enabled

    Overrides​

    BaseRaycaster.enabled

    Defined in​

    temp/engine_components/src/core/SimpleRaycaster/index.ts:13

    mouse​

    • Readonly mouse: Mouse

    The position of the mouse in the screen.

    Defined in​

    temp/engine_components/src/core/SimpleRaycaster/index.ts:19

    onDisposed​

    • Readonly onDisposed: Event<undefined>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Overrides​

    BaseRaycaster.onDisposed

    Defined in​

    temp/engine_components/src/core/SimpleRaycaster/index.ts:16

    Methods​

    castRay​

    ▸ castRay(items?): null | Intersection<Object3D<Object3DEventMap>>

    Throws a ray from the camera to the mouse or touch event point and returns +events.

    Hierarchy​

    • BaseRaycaster

      ↳ SimpleRaycaster

    Implements​

    Properties​

    enabled​

    • enabled: boolean = true

    Component.enabled

    Overrides​

    BaseRaycaster.enabled

    Defined in​

    src/core/SimpleRaycaster/index.ts:13

    mouse​

    • Readonly mouse: Mouse

    The position of the mouse in the screen.

    Defined in​

    src/core/SimpleRaycaster/index.ts:19

    onDisposed​

    • Readonly onDisposed: Event<undefined>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Overrides​

    BaseRaycaster.onDisposed

    Defined in​

    src/core/SimpleRaycaster/index.ts:16

    Methods​

    castRay​

    ▸ castRay(items?): null | Intersection<Object3D<Object3DEventMap>>

    Throws a ray from the camera to the mouse or touch event point and returns the first item found. This also takes into account the clipping planes -used by the renderer.

    Parameters​

    NameTypeDescription
    itemsMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>[]the meshes to query. If not provided, it will query all the meshes stored in Components.meshes.

    Returns​

    null | Intersection<Object3D<Object3DEventMap>>

    Overrides​

    BaseRaycaster.castRay

    Defined in​

    temp/engine_components/src/core/SimpleRaycaster/index.ts:51

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Overrides​

    BaseRaycaster.dispose

    Defined in​

    temp/engine_components/src/core/SimpleRaycaster/index.ts:36

    get​

    ▸ get(): Raycaster

    Component.get

    Returns​

    Raycaster

    Overrides​

    BaseRaycaster.get

    Defined in​

    temp/engine_components/src/core/SimpleRaycaster/index.ts:31

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    BaseRaycaster.hasUI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    BaseRaycaster.isConfigurable

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    BaseRaycaster.isDisposeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    BaseRaycaster.isHideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    BaseRaycaster.isResizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    BaseRaycaster.isUpdateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    - - +used by the renderer.

    Parameters​

    NameTypeDescription
    itemsMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>[]the meshes to query. If not provided, it will query all the meshes stored in Components.meshes.

    Returns​

    null | Intersection<Object3D<Object3DEventMap>>

    Overrides​

    BaseRaycaster.castRay

    Defined in​

    src/core/SimpleRaycaster/index.ts:51

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Overrides​

    BaseRaycaster.dispose

    Defined in​

    src/core/SimpleRaycaster/index.ts:36

    get​

    ▸ get(): Raycaster

    Component.get

    Returns​

    Raycaster

    Overrides​

    BaseRaycaster.get

    Defined in​

    src/core/SimpleRaycaster/index.ts:31

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    BaseRaycaster.hasUI

    Defined in​

    src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    BaseRaycaster.isConfigurable

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    BaseRaycaster.isDisposeable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    BaseRaycaster.isHideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    BaseRaycaster.isResizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    BaseRaycaster.isUpdateable

    Defined in​

    src/base-types/component.ts:45

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.SimpleRenderer/index.html b/build/api/classes/openbim_components.SimpleRenderer/index.html index 44fae336..38834c3a 100644 --- a/build/api/classes/openbim_components.SimpleRenderer/index.html +++ b/build/api/classes/openbim_components.SimpleRenderer/index.html @@ -3,22 +3,22 @@ -Class: SimpleRenderer | That Open Docs - - +Class: SimpleRenderer | That Open Docs + + -
    -
    Skip to main content

    Class: SimpleRenderer

    openbim-components.SimpleRenderer

    A basic renderer capable of rendering 3D and 2D objects +

    +

    Class: SimpleRenderer

    openbim-components.SimpleRenderer

    A basic renderer capable of rendering 3D and 2D objects (Objec3Ds and CSS2DObjects -respectively).

    Hierarchy​

    Implements​

    Properties​

    clippingPlanes​

    • clippingPlanes: Plane[] = []

    The list of clipping planes used by this -instance of the renderer.

    Inherited from​

    BaseRenderer.clippingPlanes

    Defined in​

    temp/engine_components/src/base-types/base-renderer.ts:33

    container​

    • container: null | HTMLElement

    The HTML container of the THREE.js canvas where the scene is rendered.

    Defined in​

    temp/engine_components/src/core/SimpleRenderer/index.ts:26

    enabled​

    • enabled: boolean = true

    Component.enabled

    Overrides​

    BaseRenderer.enabled

    Defined in​

    temp/engine_components/src/core/SimpleRenderer/index.ts:23

    onAfterUpdate​

    • Readonly onAfterUpdate: Event<SimpleRenderer>

    Updateable.onAfterUpdate

    Implementation of​

    Updateable.onAfterUpdate

    Defined in​

    temp/engine_components/src/core/SimpleRenderer/index.ts:35

    onBeforeUpdate​

    • Readonly onBeforeUpdate: Event<SimpleRenderer>

    Updateable.onBeforeUpdate

    Implementation of​

    Updateable.onBeforeUpdate

    Defined in​

    temp/engine_components/src/core/SimpleRenderer/index.ts:32

    onClippingPlanesUpdated​

    • Readonly onClippingPlanesUpdated: Event<unknown>

    Event that fires when there has been a change to the list of clipping -planes used by the active renderer.

    Inherited from​

    BaseRenderer.onClippingPlanesUpdated

    Defined in​

    temp/engine_components/src/base-types/base-renderer.ts:27

    onDisposed​

    • Readonly onDisposed: Event<undefined>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    temp/engine_components/src/core/SimpleRenderer/index.ts:29

    onResize​

    • Readonly onResize: Event<any>

    Resizeable.onResize

    Implementation of​

    Resizeable.onResize

    Inherited from​

    BaseRenderer.onResize

    Defined in​

    temp/engine_components/src/base-types/base-renderer.ts:21

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    temp/engine_components/src/core/SimpleRenderer/index.ts:92

    get​

    ▸ get(): WebGLRenderer

    Component.get

    Returns​

    WebGLRenderer

    Overrides​

    BaseRenderer.get

    Defined in​

    temp/engine_components/src/core/SimpleRenderer/index.ts:75

    getSize​

    ▸ getSize(): Vector2

    Resizeable.getSize.

    Returns​

    Vector2

    Implementation of​

    Resizeable.getSize

    Overrides​

    BaseRenderer.getSize

    Defined in​

    temp/engine_components/src/core/SimpleRenderer/index.ts:106

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    BaseRenderer.hasUI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    BaseRenderer.isConfigurable

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    BaseRenderer.isDisposeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    BaseRenderer.isHideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    BaseRenderer.isResizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    BaseRenderer.isUpdateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    resize​

    ▸ resize(size?): void

    Resizeable.resize.

    Parameters​

    NameType
    size?Vector2

    Returns​

    void

    Implementation of​

    Resizeable.resize

    Overrides​

    BaseRenderer.resize

    Defined in​

    temp/engine_components/src/core/SimpleRenderer/index.ts:114

    togglePlane​

    ▸ togglePlane(active, plane, isLocal?): void

    Adds or removes a +respectively).

    Hierarchy​

    Implements​

    Properties​

    clippingPlanes​

    • clippingPlanes: Plane[] = []

    The list of clipping planes used by this +instance of the renderer.

    Inherited from​

    BaseRenderer.clippingPlanes

    Defined in​

    src/base-types/base-renderer.ts:33

    container​

    • container: null | HTMLElement

    The HTML container of the THREE.js canvas where the scene is rendered.

    Defined in​

    src/core/SimpleRenderer/index.ts:26

    enabled​

    • enabled: boolean = true

    Component.enabled

    Overrides​

    BaseRenderer.enabled

    Defined in​

    src/core/SimpleRenderer/index.ts:23

    onAfterUpdate​

    • Readonly onAfterUpdate: Event<SimpleRenderer>

    Updateable.onAfterUpdate

    Implementation of​

    Updateable.onAfterUpdate

    Defined in​

    src/core/SimpleRenderer/index.ts:35

    onBeforeUpdate​

    • Readonly onBeforeUpdate: Event<SimpleRenderer>

    Updateable.onBeforeUpdate

    Implementation of​

    Updateable.onBeforeUpdate

    Defined in​

    src/core/SimpleRenderer/index.ts:32

    onClippingPlanesUpdated​

    • Readonly onClippingPlanesUpdated: Event<unknown>

    Event that fires when there has been a change to the list of clipping +planes used by the active renderer.

    Inherited from​

    BaseRenderer.onClippingPlanesUpdated

    Defined in​

    src/base-types/base-renderer.ts:27

    onDisposed​

    • Readonly onDisposed: Event<undefined>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    src/core/SimpleRenderer/index.ts:29

    onResize​

    • Readonly onResize: Event<any>

    Resizeable.onResize

    Implementation of​

    Resizeable.onResize

    Inherited from​

    BaseRenderer.onResize

    Defined in​

    src/base-types/base-renderer.ts:21

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    src/core/SimpleRenderer/index.ts:92

    get​

    ▸ get(): WebGLRenderer

    Component.get

    Returns​

    WebGLRenderer

    Overrides​

    BaseRenderer.get

    Defined in​

    src/core/SimpleRenderer/index.ts:75

    getSize​

    ▸ getSize(): Vector2

    Resizeable.getSize.

    Returns​

    Vector2

    Implementation of​

    Resizeable.getSize

    Overrides​

    BaseRenderer.getSize

    Defined in​

    src/core/SimpleRenderer/index.ts:106

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    BaseRenderer.hasUI

    Defined in​

    src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    BaseRenderer.isConfigurable

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    BaseRenderer.isDisposeable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    BaseRenderer.isHideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    BaseRenderer.isResizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    BaseRenderer.isUpdateable

    Defined in​

    src/base-types/component.ts:45

    resize​

    ▸ resize(size?): void

    Resizeable.resize.

    Parameters​

    NameType
    size?Vector2

    Returns​

    void

    Implementation of​

    Resizeable.resize

    Overrides​

    BaseRenderer.resize

    Defined in​

    src/core/SimpleRenderer/index.ts:114

    togglePlane​

    ▸ togglePlane(active, plane, isLocal?): void

    Adds or removes a clipping plane -to the renderer.

    Parameters​

    NameType
    activeboolean
    planePlane
    isLocal?boolean

    Returns​

    void

    Inherited from​

    BaseRenderer.togglePlane

    Defined in​

    temp/engine_components/src/base-types/base-renderer.ts:48

    update​

    ▸ update(): Promise<void>

    Updateable.update

    Returns​

    Promise<void>

    Implementation of​

    Updateable.update

    Defined in​

    temp/engine_components/src/core/SimpleRenderer/index.ts:80

    updateClippingPlanes​

    ▸ updateClippingPlanes(): Promise<void>

    Forces the update of the clipping planes and all components that depend -on them that are subscribed to onClippingPlanesUpdated.

    Returns​

    Promise<void>

    Inherited from​

    BaseRenderer.updateClippingPlanes

    Defined in​

    temp/engine_components/src/base-types/base-renderer.ts:39

    - - +to the renderer.

    Parameters​

    NameType
    activeboolean
    planePlane
    isLocal?boolean

    Returns​

    void

    Inherited from​

    BaseRenderer.togglePlane

    Defined in​

    src/base-types/base-renderer.ts:48

    update​

    ▸ update(): Promise<void>

    Updateable.update

    Returns​

    Promise<void>

    Implementation of​

    Updateable.update

    Defined in​

    src/core/SimpleRenderer/index.ts:80

    updateClippingPlanes​

    ▸ updateClippingPlanes(): Promise<void>

    Forces the update of the clipping planes and all components that depend +on them that are subscribed to onClippingPlanesUpdated.

    Returns​

    Promise<void>

    Inherited from​

    BaseRenderer.updateClippingPlanes

    Defined in​

    src/base-types/base-renderer.ts:39

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.SimpleScene/index.html b/build/api/classes/openbim_components.SimpleScene/index.html index 0af4868d..738f0771 100644 --- a/build/api/classes/openbim_components.SimpleScene/index.html +++ b/build/api/classes/openbim_components.SimpleScene/index.html @@ -3,15 +3,15 @@ -Class: SimpleScene | That Open Docs - - +Class: SimpleScene | That Open Docs + + -
    -
    Skip to main content

    Class: SimpleScene

    openbim-components.SimpleScene

    A basic 3D scene to add -objects hierarchically, and easily dispose them when you are finished with it.

    No Inherit Doc

    Hierarchy​

    Implements​

    Properties​

    enabled​

    • enabled: boolean = true

    Component.enabled

    Overrides​

    Component.enabled

    Defined in​

    temp/engine_components/src/core/SimpleScene/index.ts:28

    isSetup​

    • isSetup: boolean = false

    Configurable.isSetup

    Implementation of​

    Configurable.isSetup

    Defined in​

    temp/engine_components/src/core/SimpleScene/index.ts:31

    onDisposed​

    • Readonly onDisposed: Event<undefined>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    temp/engine_components/src/core/SimpleScene/index.ts:34

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    temp/engine_components/src/core/SimpleScene/index.ts:50

    get​

    ▸ get(): Scene

    Component.get

    Returns​

    Scene

    Overrides​

    Component.get

    Defined in​

    temp/engine_components/src/core/SimpleScene/index.ts:45

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    setup​

    ▸ setup(config?): Promise<void>

    Creates a simple and nice default set up for the scene (e.g. lighting).

    Parameters​

    NameType
    config?Partial<SimpleSceneConfig>

    Returns​

    Promise<void>

    Implementation of​

    Configurable.setup

    Defined in​

    temp/engine_components/src/core/SimpleScene/index.ts:77

    - - +
    +
    Skip to main content

    Class: SimpleScene

    openbim-components.SimpleScene

    A basic 3D scene to add +objects hierarchically, and easily dispose them when you are finished with it.

    No Inherit Doc

    Hierarchy​

    Implements​

    Properties​

    enabled​

    • enabled: boolean = true

    Component.enabled

    Overrides​

    Component.enabled

    Defined in​

    src/core/SimpleScene/index.ts:28

    isSetup​

    • isSetup: boolean = false

    Configurable.isSetup

    Implementation of​

    Configurable.isSetup

    Defined in​

    src/core/SimpleScene/index.ts:31

    onDisposed​

    • Readonly onDisposed: Event<undefined>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    src/core/SimpleScene/index.ts:34

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Disposable.dispose

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    src/core/SimpleScene/index.ts:50

    get​

    ▸ get(): Scene

    Component.get

    Returns​

    Scene

    Overrides​

    Component.get

    Defined in​

    src/core/SimpleScene/index.ts:45

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    src/base-types/component.ts:45

    setup​

    ▸ setup(config?): Promise<void>

    Creates a simple and nice default set up for the scene (e.g. lighting).

    Parameters​

    NameType
    config?Partial<SimpleSceneConfig>

    Returns​

    Promise<void>

    Implementation of​

    Configurable.setup

    Defined in​

    src/core/SimpleScene/index.ts:77

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.ToolComponent/index.html b/build/api/classes/openbim_components.ToolComponent/index.html index 95fe859d..361f6d71 100644 --- a/build/api/classes/openbim_components.ToolComponent/index.html +++ b/build/api/classes/openbim_components.ToolComponent/index.html @@ -3,18 +3,18 @@ -Class: ToolComponent | That Open Docs - - +Class: ToolComponent | That Open Docs + + -
    -
    Skip to main content

    Class: ToolComponent

    openbim-components.ToolComponent

    An object to easily handle all the tools used (e.g. updating them, retrieving +

    +

    Class: ToolComponent

    openbim-components.ToolComponent

    An object to easily handle all the tools used (e.g. updating them, retrieving them, performing batch operations, etc). A tool is a feature that achieves -something through user interaction (e.g. clipping planes, dimensions, etc).

    Hierarchy​

    Implements​

    Properties​

    enabled​

    • enabled: boolean = true

    Component.enabled

    Overrides​

    Component.enabled

    Defined in​

    temp/engine_components/src/core/ToolsComponent/index.ts:31

    list​

    • list: Record<string, Component<any>> = {}

    The list of components created in this app.

    Defined in​

    temp/engine_components/src/core/ToolsComponent/index.ts:16

    onDisposed​

    • Readonly onDisposed: Event<undefined>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    temp/engine_components/src/core/ToolsComponent/index.ts:19

    token​

    • token: string = ""

    The auth token to get tools from That Open Platform.

    Defined in​

    temp/engine_components/src/core/ToolsComponent/index.ts:25

    uuid​

    • uuid: string = "ToolComponent"

    Component.uuid

    Defined in​

    temp/engine_components/src/core/ToolsComponent/index.ts:28

    libraryUUIDs​

    ▪ Static Readonly libraryUUIDs: Set<unknown>

    The list of UUIDs of all the components in this library.

    Defined in​

    temp/engine_components/src/core/ToolsComponent/index.ts:22

    Methods​

    add​

    ▸ add(uuid, instance): void

    Adds a new tool. Use this in the constructor of your tools.

    Parameters​

    NameTypeDescription
    uuidstringThe UUID of your tool.
    instanceComponent<any>The instance of your tool (this inside the constructor).

    Returns​

    void

    Defined in​

    temp/engine_components/src/core/ToolsComponent/index.ts:58

    dispose​

    ▸ dispose(): Promise<void>

    Disposes all the MEMORY used by all the tools.

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    temp/engine_components/src/core/ToolsComponent/index.ts:107

    get​

    ▸ get<T, U>(ToolClass): U

    Retrieves a tool component. If it already exists in this app, it returns the instance of the component. If it -doesn't exist, it will instance it automatically.

    Type parameters​

    NameType
    TT
    Uextends Component<T>

    Parameters​

    NameTypeDescription
    ToolClassObjectThe component to get or create.

    Returns​

    U

    Overrides​

    Component.get

    Defined in​

    temp/engine_components/src/core/ToolsComponent/index.ts:74

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    init​

    ▸ init(OBC): void

    Pass the whole library object as argument.

    Parameters​

    NameType
    OBCany

    Returns​

    void

    Defined in​

    temp/engine_components/src/core/ToolsComponent/index.ts:46

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    update​

    ▸ update(delta): Promise<void>

    Updates all the registered tool components. Only the components where the -property Component.enabled is true will be updated.

    Parameters​

    NameTypeDescription
    deltanumberThe delta time of the loop.

    Returns​

    Promise<void>

    Defined in​

    temp/engine_components/src/core/ToolsComponent/index.ts:95

    - - +something through user interaction (e.g. clipping planes, dimensions, etc).

    Hierarchy​

    Implements​

    Properties​

    enabled​

    • enabled: boolean = true

    Component.enabled

    Overrides​

    Component.enabled

    Defined in​

    src/core/ToolsComponent/index.ts:31

    list​

    • list: Record<string, Component<any>> = {}

    The list of components created in this app.

    Defined in​

    src/core/ToolsComponent/index.ts:16

    onDisposed​

    • Readonly onDisposed: Event<undefined>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    src/core/ToolsComponent/index.ts:19

    token​

    • token: string = ""

    The auth token to get tools from That Open Platform.

    Defined in​

    src/core/ToolsComponent/index.ts:25

    uuid​

    • uuid: string = "ToolComponent"

    Component.uuid

    Defined in​

    src/core/ToolsComponent/index.ts:28

    libraryUUIDs​

    ▪ Static Readonly libraryUUIDs: Set<unknown>

    The list of UUIDs of all the components in this library.

    Defined in​

    src/core/ToolsComponent/index.ts:22

    Methods​

    add​

    ▸ add(uuid, instance): void

    Adds a new tool. Use this in the constructor of your tools.

    Parameters​

    NameTypeDescription
    uuidstringThe UUID of your tool.
    instanceComponent<any>The instance of your tool (this inside the constructor).

    Returns​

    void

    Defined in​

    src/core/ToolsComponent/index.ts:58

    dispose​

    ▸ dispose(): Promise<void>

    Disposes all the MEMORY used by all the tools.

    Returns​

    Promise<void>

    Implementation of​

    Disposable.dispose

    Defined in​

    src/core/ToolsComponent/index.ts:107

    get​

    ▸ get<T, U>(ToolClass): U

    Retrieves a tool component. If it already exists in this app, it returns the instance of the component. If it +doesn't exist, it will instance it automatically.

    Type parameters​

    NameType
    TT
    Uextends Component<T>

    Parameters​

    NameTypeDescription
    ToolClassObjectThe component to get or create.

    Returns​

    U

    Overrides​

    Component.get

    Defined in​

    src/core/ToolsComponent/index.ts:74

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    src/base-types/component.ts:62

    init​

    ▸ init(OBC): void

    Pass the whole library object as argument.

    Parameters​

    NameType
    OBCany

    Returns​

    void

    Defined in​

    src/core/ToolsComponent/index.ts:46

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    src/base-types/component.ts:45

    update​

    ▸ update(delta): Promise<void>

    Updates all the registered tool components. Only the components where the +property Component.enabled is true will be updated.

    Parameters​

    NameTypeDescription
    deltanumberThe delta time of the loop.

    Returns​

    Promise<void>

    Defined in​

    src/core/ToolsComponent/index.ts:95

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.UIElement/index.html b/build/api/classes/openbim_components.UIElement/index.html index 23a51f2d..935f7996 100644 --- a/build/api/classes/openbim_components.UIElement/index.html +++ b/build/api/classes/openbim_components.UIElement/index.html @@ -3,17 +3,17 @@ -Class: UIElement<T> | That Open Docs - - +Class: UIElement<T> | That Open Docs + + -
    -
    Skip to main content

    Class: UIElement<T>

    openbim-components.UIElement

    A simple object to handle UI components. You can use the generic constructor -to specify the types of your UI components.

    Type parameters​

    NameType
    Textends Object

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Release all the memory used by this instance deleting all the UI components -inside.

    Returns​

    Promise<void>

    Defined in​

    temp/engine_components/src/base-types/ui-element.ts:37

    get​

    ▸ get<U>(name): U

    Gets the UI Component with the given name. If it doesn't exist, it will -throw an error.

    Type parameters​

    NameType
    USimpleUIComponent<HTMLElement>

    Parameters​

    NameTypeDescription
    namekeyof Tthe identifier of the UI component.

    Returns​

    U

    Defined in​

    temp/engine_components/src/base-types/ui-element.ts:17

    set​

    ▸ set(data): void

    Sets all the UI components of this instance.

    Parameters​

    NameTypeDescription
    dataTall the UI components sorted by name in an object.

    Returns​

    void

    Defined in​

    temp/engine_components/src/base-types/ui-element.ts:29

    - - +
    +
    Skip to main content

    Class: UIElement<T>

    openbim-components.UIElement

    A simple object to handle UI components. You can use the generic constructor +to specify the types of your UI components.

    Type parameters​

    NameType
    Textends Object

    Methods​

    dispose​

    ▸ dispose(): Promise<void>

    Release all the memory used by this instance deleting all the UI components +inside.

    Returns​

    Promise<void>

    Defined in​

    src/base-types/ui-element.ts:37

    get​

    ▸ get<U>(name): U

    Gets the UI Component with the given name. If it doesn't exist, it will +throw an error.

    Type parameters​

    NameType
    USimpleUIComponent<HTMLElement>

    Parameters​

    NameTypeDescription
    namekeyof Tthe identifier of the UI component.

    Returns​

    U

    Defined in​

    src/base-types/ui-element.ts:17

    set​

    ▸ set(data): void

    Sets all the UI components of this instance.

    Parameters​

    NameTypeDescription
    dataTall the UI components sorted by name in an object.

    Returns​

    void

    Defined in​

    src/base-types/ui-element.ts:29

    + + \ No newline at end of file diff --git a/build/api/classes/openbim_components.UIManager/index.html b/build/api/classes/openbim_components.UIManager/index.html index 1265f4ea..01d433bc 100644 --- a/build/api/classes/openbim_components.UIManager/index.html +++ b/build/api/classes/openbim_components.UIManager/index.html @@ -3,14 +3,14 @@ -Class: UIManager | That Open Docs - - +Class: UIManager | That Open Docs + + -
    -
    Skip to main content

    Class: UIManager

    openbim-components.UIManager

    A component that handles all UI components.

    Hierarchy​

    Implements​

    Properties​

    onDisposed​

    • Readonly onDisposed: Event<undefined>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    temp/engine_components/src/ui/UIManager/index.ts:30

    Methods​

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    temp/engine_components/src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    temp/engine_components/src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    temp/engine_components/src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    temp/engine_components/src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    temp/engine_components/src/base-types/component.ts:45

    - - +
    +
    Skip to main content

    Class: UIManager

    openbim-components.UIManager

    A component that handles all UI components.

    Hierarchy​

    Implements​

    Properties​

    onDisposed​

    • Readonly onDisposed: Event<undefined>

    Disposable.onDisposed

    Implementation of​

    Disposable.onDisposed

    Defined in​

    src/ui/UIManager/index.ts:30

    Methods​

    hasUI​

    ▸ hasUI(): this is UI

    Whether is component implements any kind of UI.

    Returns​

    this is UI

    Inherited from​

    Component.hasUI

    Defined in​

    src/base-types/component.ts:62

    isConfigurable​

    ▸ isConfigurable(): this is Configurable<any>

    Whether is component is Configurable.

    Returns​

    this is Configurable<any>

    Inherited from​

    Component.isConfigurable

    Defined in​

    src/base-types/component.ts:57

    isDisposeable​

    ▸ isDisposeable(): this is Disposable

    Whether is component is Disposable.

    Returns​

    this is Disposable

    Inherited from​

    Component.isDisposeable

    Defined in​

    src/base-types/component.ts:35

    isHideable​

    ▸ isHideable(): this is Hideable

    Whether is component is Hideable.

    Returns​

    this is Hideable

    Inherited from​

    Component.isHideable

    Defined in​

    src/base-types/component.ts:52

    isResizeable​

    ▸ isResizeable(): this is Resizeable

    Whether is component is Resizeable.

    Returns​

    this is Resizeable

    Inherited from​

    Component.isResizeable

    Defined in​

    src/base-types/component.ts:40

    isUpdateable​

    ▸ isUpdateable(): this is Updateable

    Whether is component is Updateable.

    Returns​

    this is Updateable

    Inherited from​

    Component.isUpdateable

    Defined in​

    src/base-types/component.ts:45

    + + \ No newline at end of file diff --git a/build/api/index.html b/build/api/index.html index c77a7733..67a79488 100644 --- a/build/api/index.html +++ b/build/api/index.html @@ -3,14 +3,14 @@ -Open BIM Docs | That Open Docs - - +Open BIM Docs | That Open Docs + + -
    -
    Skip to main content

    Open BIM Docs

    TOC|documentation|demo|community|npm package

    cover

    That Open Docs

    This library contains the official docs for all the libraries of That Open Company.

    • It uses docusaurus to build them.
    • It gathers code from our repos and build the API docs using TypeDoc.
    • It gathers the HTML examples from our repos and build the tutorials.

    If you see anything outdated in the docs page, feel free to open an issue. If the issue is specific to a specific repository, please open the issue in that repository!

    If you have any questions, you can also ask around in our community.

    - - +
    +
    Skip to main content

    Open BIM Docs

    TOC|documentation|demo|community|npm package

    cover

    That Open Docs

    This library contains the official docs for all the libraries of That Open Company.

    • It uses docusaurus to build them.
    • It gathers code from our repos and build the API docs using TypeDoc.
    • It gathers the HTML examples from our repos and build the tutorials.

    If you see anything outdated in the docs page, feel free to open an issue. If the issue is specific to a specific repository, please open the issue in that repository!

    If you have any questions, you can also ask around in our community.

    Local development​

    Requirements

    Install all dependencies

    yarn install

    Run docusaurus local devserver

    yarn start

    Generating tutorials and api docs

    This script clonse both openbim-components and bim-fragments repos into a temp/ folder and generates the api docs.

    yarn build:remote
    + + \ No newline at end of file diff --git a/build/api/interfaces/openbim_components.Configurable/index.html b/build/api/interfaces/openbim_components.Configurable/index.html index 36d14f6b..998ead75 100644 --- a/build/api/interfaces/openbim_components.Configurable/index.html +++ b/build/api/interfaces/openbim_components.Configurable/index.html @@ -3,15 +3,15 @@ -Interface: Configurable<T> | That Open Docs - - +Interface: Configurable<T> | That Open Docs + + -
    -
    Skip to main content

    Interface: Configurable<T>

    openbim-components.Configurable

    Whether this component supports to be configured.

    Type parameters​

    NameType
    Textends Record<string, any>

    Implemented by​

    Properties​

    config​

    • config: Required<T>

    Object holding the tool configuration. Is not meant to be edited directly, if you need -to make changes to this object, use () just after the tool is instantiated.

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:188

    isSetup​

    • isSetup: boolean

    Wether this components has been already configured.

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:177

    onSetup​

    • Readonly onSetup: Event<any>

    Fired after successfully calling ()

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:183

    setup​

    • setup: (config?: Partial<T>) => Promise<void>

    Type declaration​

    ▸ (config?): Promise<void>

    Use the provided configuration to setup the tool.

    Parameters​
    NameType
    config?Partial<T>
    Returns​

    Promise<void>

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:180

    - - +
    +
    Skip to main content

    Interface: Configurable<T>

    openbim-components.Configurable

    Whether this component supports to be configured.

    Type parameters​

    NameType
    Textends Record<string, any>

    Implemented by​

    Properties​

    config​

    • config: Required<T>

    Object holding the tool configuration. Is not meant to be edited directly, if you need +to make changes to this object, use () just after the tool is instantiated.

    Defined in​

    src/base-types/base-types.ts:188

    isSetup​

    • isSetup: boolean

    Wether this components has been already configured.

    Defined in​

    src/base-types/base-types.ts:177

    onSetup​

    • Readonly onSetup: Event<any>

    Fired after successfully calling ()

    Defined in​

    src/base-types/base-types.ts:183

    setup​

    • setup: (config?: Partial<T>) => Promise<void>

    Type declaration​

    ▸ (config?): Promise<void>

    Use the provided configuration to setup the tool.

    Parameters​
    NameType
    config?Partial<T>
    Returns​

    Promise<void>

    Defined in​

    src/base-types/base-types.ts:180

    + + \ No newline at end of file diff --git a/build/api/interfaces/openbim_components.Createable/index.html b/build/api/interfaces/openbim_components.Createable/index.html index 3eafacbe..bd83c015 100644 --- a/build/api/interfaces/openbim_components.Createable/index.html +++ b/build/api/interfaces/openbim_components.Createable/index.html @@ -3,18 +3,18 @@ -Interface: Createable | That Open Docs - - +Interface: Createable | That Open Docs + + -
    -
    Skip to main content

    Interface: Createable

    openbim-components.Createable

    Whether this component supports create and destroy operations. This generally +

    +

    Interface: Createable

    openbim-components.Createable

    Whether this component supports create and destroy operations. This generally applies for components that work with instances, such as clipping planes or -dimensions.

    Implemented by​

    Properties​

    cancelCreation​

    • cancelCreation: (data: any) => void

    Type declaration​

    ▸ (data): void

    Cancels the creation process of the component, going back to the state -before starting to create.

    Parameters​
    NameType
    dataany
    Returns​

    void

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:157

    create​

    • create: (data: any) => void

    Type declaration​

    ▸ (data): void

    Creates a new instance of an element (e.g. a new Dimension).

    Parameters​
    NameType
    dataany
    Returns​

    void

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:139

    delete​

    • delete: (data: any) => void

    Type declaration​

    ▸ (data): void

    Deletes an existing instance of an element (e.g. a Dimension).

    Parameters​
    NameType
    dataany
    Returns​

    void

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:166

    endCreation​

    • endCreation: (data: any) => void

    Type declaration​

    ▸ (data): void

    Finish the creation process of the component, successfully creating an -instance of whatever the component creates.

    Parameters​
    NameType
    dataany
    Returns​

    void

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:148

    onAfterCancel​

    • Readonly onAfterCancel: Event<any>

    Fired after calling Createable.cancelCreation.

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:160

    onAfterCreate​

    • Readonly onAfterCreate: Event<any>

    Fired after successfully calling Createable.create

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:142

    onAfterDelete​

    • Readonly onAfterDelete: Event<any>

    Fired after successfully calling ()

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:169

    onBeforeCancel​

    • Readonly onBeforeCancel: Event<any>

    Fired before calling Createable.cancelCreation.

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:151

    onBeforeDelete​

    • Readonly onBeforeDelete: Event<any>

    Fired before calling Createable.delete.

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:163

    - - +dimensions.

    Implemented by​

    Properties​

    cancelCreation​

    • cancelCreation: (data: any) => void

    Type declaration​

    ▸ (data): void

    Cancels the creation process of the component, going back to the state +before starting to create.

    Parameters​
    NameType
    dataany
    Returns​

    void

    Defined in​

    src/base-types/base-types.ts:157

    create​

    • create: (data: any) => void

    Type declaration​

    ▸ (data): void

    Creates a new instance of an element (e.g. a new Dimension).

    Parameters​
    NameType
    dataany
    Returns​

    void

    Defined in​

    src/base-types/base-types.ts:139

    delete​

    • delete: (data: any) => void

    Type declaration​

    ▸ (data): void

    Deletes an existing instance of an element (e.g. a Dimension).

    Parameters​
    NameType
    dataany
    Returns​

    void

    Defined in​

    src/base-types/base-types.ts:166

    endCreation​

    • endCreation: (data: any) => void

    Type declaration​

    ▸ (data): void

    Finish the creation process of the component, successfully creating an +instance of whatever the component creates.

    Parameters​
    NameType
    dataany
    Returns​

    void

    Defined in​

    src/base-types/base-types.ts:148

    onAfterCancel​

    • Readonly onAfterCancel: Event<any>

    Fired after calling Createable.cancelCreation.

    Defined in​

    src/base-types/base-types.ts:160

    onAfterCreate​

    • Readonly onAfterCreate: Event<any>

    Fired after successfully calling Createable.create

    Defined in​

    src/base-types/base-types.ts:142

    onAfterDelete​

    • Readonly onAfterDelete: Event<any>

    Fired after successfully calling ()

    Defined in​

    src/base-types/base-types.ts:169

    onBeforeCancel​

    • Readonly onBeforeCancel: Event<any>

    Fired before calling Createable.cancelCreation.

    Defined in​

    src/base-types/base-types.ts:151

    onBeforeDelete​

    • Readonly onBeforeDelete: Event<any>

    Fired before calling Createable.delete.

    Defined in​

    src/base-types/base-types.ts:163

    + + \ No newline at end of file diff --git a/build/api/interfaces/openbim_components.Disposable/index.html b/build/api/interfaces/openbim_components.Disposable/index.html index 12b24faf..47e8e475 100644 --- a/build/api/interfaces/openbim_components.Disposable/index.html +++ b/build/api/interfaces/openbim_components.Disposable/index.html @@ -3,19 +3,19 @@ -Interface: Disposable | That Open Docs - - +Interface: Disposable | That Open Docs + + -
    -
    Skip to main content

    Interface: Disposable

    openbim-components.Disposable

    Whether this component has to be manually destroyed once you are done with +

    +

    Interface: Disposable

    openbim-components.Disposable

    Whether this component has to be manually destroyed once you are done with it to prevent memory leaks. This also ensures that the DOM events created by that component will be -cleaned up.

    Implemented by​

    Properties​

    dispose​

    • dispose: () => Promise<void>

    Type declaration​

    ▸ (): Promise<void>

    Destroys the object from memory to prevent a -memory leak.

    Returns​

    Promise<void>

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:60

    onDisposed​

    • Readonly onDisposed: Event<any>

    Fired after the tool has been ()

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:63

    - - +cleaned up.

    Implemented by​

    Properties​

    dispose​

    • dispose: () => Promise<void>

    Type declaration​

    ▸ (): Promise<void>

    Destroys the object from memory to prevent a +memory leak.

    Returns​

    Promise<void>

    Defined in​

    src/base-types/base-types.ts:60

    onDisposed​

    • Readonly onDisposed: Event<any>

    Fired after the tool has been ()

    Defined in​

    src/base-types/base-types.ts:63

    + + \ No newline at end of file diff --git a/build/api/interfaces/openbim_components.FragmentIdMap/index.html b/build/api/interfaces/openbim_components.FragmentIdMap/index.html index 34915de5..f64d9d26 100644 --- a/build/api/interfaces/openbim_components.FragmentIdMap/index.html +++ b/build/api/interfaces/openbim_components.FragmentIdMap/index.html @@ -3,15 +3,15 @@ -Interface: FragmentIdMap | That Open Docs - - +Interface: FragmentIdMap | That Open Docs + + -
    -
    Skip to main content

    Interface: FragmentIdMap

    openbim-components.FragmentIdMap

    A list of IDs indexed by the fragments where they exist. As an item can be -made of multiple fragments, there might be repeated IDs across entries.

    - - +
    +
    Skip to main content

    Interface: FragmentIdMap

    openbim-components.FragmentIdMap

    A list of IDs indexed by the fragments where they exist. As an item can be +made of multiple fragments, there might be repeated IDs across entries.

    + + \ No newline at end of file diff --git a/build/api/interfaces/openbim_components.Hideable/index.html b/build/api/interfaces/openbim_components.Hideable/index.html index 7d9e62c8..e605f8ce 100644 --- a/build/api/interfaces/openbim_components.Hideable/index.html +++ b/build/api/interfaces/openbim_components.Hideable/index.html @@ -3,18 +3,18 @@ -Interface: Hideable | That Open Docs - - +Interface: Hideable | That Open Docs + + -
    -
    Skip to main content

    Interface: Hideable

    openbim-components.Hideable

    Whether the geometric representation of this component can be +

    +

    Interface: Hideable

    openbim-components.Hideable

    Whether the geometric representation of this component can be hidden or shown in the -Three.js scene.

    Implemented by​

    Properties​

    visible​

    • visible: boolean

    Whether the geometric representation of this component is +Three.js scene.

    Implemented by​

    Properties​

    visible​

    • visible: boolean

    Whether the geometric representation of this component is currently visible or not in the -Three.js scene.

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:77

    - - +Three.js scene.

    Defined in​

    src/base-types/base-types.ts:77

    + + \ No newline at end of file diff --git a/build/api/interfaces/openbim_components.NavigationMode/index.html b/build/api/interfaces/openbim_components.NavigationMode/index.html index f560666a..3edc76bb 100644 --- a/build/api/interfaces/openbim_components.NavigationMode/index.html +++ b/build/api/interfaces/openbim_components.NavigationMode/index.html @@ -3,17 +3,17 @@ -Interface: NavigationMode | That Open Docs - - +Interface: NavigationMode | That Open Docs + + -
    -
    Skip to main content

    Interface: NavigationMode

    openbim-components.NavigationMode

    An object that determines the behavior of the camera controls -and the user input (e.g. 2D floor plan mode, first person mode, etc).

    Properties​

    enabled​

    • enabled: boolean

    Whether this navigation mode is active or not.

    Defined in​

    temp/engine_components/src/navigation/OrthoPerspectiveCamera/src/types.ts:33

    id​

    • id: NavModeID

    The unique ID of this navigation mode.

    Defined in​

    temp/engine_components/src/navigation/OrthoPerspectiveCamera/src/types.ts:20

    projectionChanged​

    • projectionChanged: Event<Camera>

    Event that should fire when the camera CameraProjection changes.

    Defined in​

    temp/engine_components/src/navigation/OrthoPerspectiveCamera/src/types.ts:38

    toggle​

    • toggle: (active: boolean, options?: any) => void

    Type declaration​

    ▸ (active, options?): void

    Enable or disable this navigation mode. +

    +

    Interface: NavigationMode

    openbim-components.NavigationMode

    An object that determines the behavior of the camera controls +and the user input (e.g. 2D floor plan mode, first person mode, etc).

    Properties​

    enabled​

    • enabled: boolean

    Whether this navigation mode is active or not.

    Defined in​

    src/navigation/OrthoPerspectiveCamera/src/types.ts:33

    id​

    • id: NavModeID

    The unique ID of this navigation mode.

    Defined in​

    src/navigation/OrthoPerspectiveCamera/src/types.ts:20

    projectionChanged​

    • projectionChanged: Event<Camera>

    Event that should fire when the camera CameraProjection changes.

    Defined in​

    src/navigation/OrthoPerspectiveCamera/src/types.ts:38

    toggle​

    • toggle: (active: boolean, options?: any) => void

    Type declaration​

    ▸ (active, options?): void

    Enable or disable this navigation mode. When a new navigation mode is enabled, the previous navigation mode -must be disabled.

    Parameters​
    NameTypeDescription
    activebooleanwhether to enable or disable this mode.
    options?anyany additional data required to enable or disable it.
    Returns​

    void

    Defined in​

    temp/engine_components/src/navigation/OrthoPerspectiveCamera/src/types.ts:30

    - - +must be disabled.

    Parameters​
    NameTypeDescription
    activebooleanwhether to enable or disable this mode.
    options?anyany additional data required to enable or disable it.
    Returns​

    void

    Defined in​

    src/navigation/OrthoPerspectiveCamera/src/types.ts:30

    + + \ No newline at end of file diff --git a/build/api/interfaces/openbim_components.Progress/index.html b/build/api/interfaces/openbim_components.Progress/index.html index 92f192f5..42f27918 100644 --- a/build/api/interfaces/openbim_components.Progress/index.html +++ b/build/api/interfaces/openbim_components.Progress/index.html @@ -3,14 +3,14 @@ -Interface: Progress | That Open Docs - - +Interface: Progress | That Open Docs + + -
    -
    Skip to main content
    - - +
    +
    Skip to main content
    + + \ No newline at end of file diff --git a/build/api/interfaces/openbim_components.Resizeable/index.html b/build/api/interfaces/openbim_components.Resizeable/index.html index 9bd94449..d3b407f3 100644 --- a/build/api/interfaces/openbim_components.Resizeable/index.html +++ b/build/api/interfaces/openbim_components.Resizeable/index.html @@ -3,22 +3,22 @@ -Interface: Resizeable | That Open Docs - - +Interface: Resizeable | That Open Docs + + -
    -
    Skip to main content

    Interface: Resizeable

    openbim-components.Resizeable

    Whether this component can be resized. The meaning of this can vary depending +

    +

    Interface: Resizeable

    openbim-components.Resizeable

    Whether this component can be resized. The meaning of this can vary depending on the component: resizing a Renderer component could mean changing its resolution, whereas resizing a -Mesh would change its scale.

    Implemented by​

    Properties​

    getSize​

    • getSize: () => Vector2

    Type declaration​

    ▸ (): Vector2

    Gets the current size of this component (e.g. the resolution of a +Mesh would change its scale.

    Implemented by​

    Properties​

    getSize​

    • getSize: () => Vector2

    Type declaration​

    ▸ (): Vector2

    Gets the current size of this component (e.g. the resolution of a Renderer -component.

    Returns​

    Vector2

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:103

    onResize​

    • onResize: Event<Vector2>

    Event that fires when the component has been resized.

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:96

    resize​

    • resize: (size?: Vector2) => void

    Type declaration​

    ▸ (size?): void

    Sets size of this component (e.g. the resolution of a +component.

    Returns​

    Vector2

    Defined in​

    src/base-types/base-types.ts:103

    onResize​

    • onResize: Event<Vector2>

    Event that fires when the component has been resized.

    Defined in​

    src/base-types/base-types.ts:96

    resize​

    • resize: (size?: Vector2) => void

    Type declaration​

    ▸ (size?): void

    Sets size of this component (e.g. the resolution of a Renderer -component.

    Parameters​
    NameType
    size?Vector2
    Returns​

    void

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:93

    - - +component.

    Parameters​
    NameType
    size?Vector2
    Returns​

    void

    Defined in​

    src/base-types/base-types.ts:93

    + + \ No newline at end of file diff --git a/build/api/interfaces/openbim_components.UI/index.html b/build/api/interfaces/openbim_components.UI/index.html index c573ccea..78f14149 100644 --- a/build/api/interfaces/openbim_components.UI/index.html +++ b/build/api/interfaces/openbim_components.UI/index.html @@ -3,15 +3,15 @@ -Interface: UI | That Open Docs - - +Interface: UI | That Open Docs + + -
    -
    Skip to main content

    Interface: UI

    openbim-components.UI

    Whether this component has a representation in the user -interface, like a button or a window.

    Implemented by​

    Properties​

    uiElement​

    • Readonly uiElement: UIElement<{ [name: string]: SimpleUIComponent; }>

    The class containing all the buttons, windows, tables, etc., of this component.

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:197

    - - +
    +
    Skip to main content
    + + \ No newline at end of file diff --git a/build/api/interfaces/openbim_components.Updateable/index.html b/build/api/interfaces/openbim_components.Updateable/index.html index 239d4f79..2f0651b3 100644 --- a/build/api/interfaces/openbim_components.Updateable/index.html +++ b/build/api/interfaces/openbim_components.Updateable/index.html @@ -3,15 +3,15 @@ -Interface: Updateable | That Open Docs - - +Interface: Updateable | That Open Docs + + -
    -
    Skip to main content

    Interface: Updateable

    openbim-components.Updateable

    Whether this component should be updated each frame.

    Implemented by​

    Properties​

    onAfterUpdate​

    • onAfterUpdate: Event<any>

    Actions that should be executed after updating the component.

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:109

    onBeforeUpdate​

    • onBeforeUpdate: Event<any>

    Actions that should be executed before updating the component.

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:112

    Methods​

    update​

    ▸ update(delta?): void

    Function used to update the state of this component each frame. For -instance, a renderer component will make a render each frame.

    Parameters​

    NameType
    delta?number

    Returns​

    void

    Defined in​

    temp/engine_components/src/base-types/base-types.ts:118

    - - +
    +
    Skip to main content

    Interface: Updateable

    openbim-components.Updateable

    Whether this component should be updated each frame.

    Implemented by​

    Properties​

    onAfterUpdate​

    • onAfterUpdate: Event<any>

    Actions that should be executed after updating the component.

    Defined in​

    src/base-types/base-types.ts:109

    onBeforeUpdate​

    • onBeforeUpdate: Event<any>

    Actions that should be executed before updating the component.

    Defined in​

    src/base-types/base-types.ts:112

    Methods​

    update​

    ▸ update(delta?): void

    Function used to update the state of this component each frame. For +instance, a renderer component will make a render each frame.

    Parameters​

    NameType
    delta?number

    Returns​

    void

    Defined in​

    src/base-types/base-types.ts:118

    + + \ No newline at end of file diff --git a/build/api/modules/bim_fragment/index.html b/build/api/modules/bim_fragment/index.html index aa4d755e..455241ef 100644 --- a/build/api/modules/bim_fragment/index.html +++ b/build/api/modules/bim_fragment/index.html @@ -3,14 +3,14 @@ -Module: bim-fragment | That Open Docs - - +Module: bim-fragment | That Open Docs + + -
    -
    Skip to main content
    - - +
    +
    Skip to main content

    Module: bim-fragment

    + + \ No newline at end of file diff --git a/build/api/modules/index.html b/build/api/modules/index.html index 262d0136..5cb34712 100644 --- a/build/api/modules/index.html +++ b/build/api/modules/index.html @@ -3,14 +3,14 @@ -Open BIM Docs | That Open Docs - - +Open BIM Docs | That Open Docs + + -
    -
    Skip to main content

    Open BIM Docs

    - - +
    +
    Skip to main content

    Open BIM Docs

    + + \ No newline at end of file diff --git a/build/api/modules/openbim_components/index.html b/build/api/modules/openbim_components/index.html index 61a310c7..47e43c51 100644 --- a/build/api/modules/openbim_components/index.html +++ b/build/api/modules/openbim_components/index.html @@ -3,14 +3,14 @@ -Module: openbim-components | That Open Docs - - +Module: openbim-components | That Open Docs + + -
    -
    Skip to main content

    Module: openbim-components

    Classes​

    Interfaces​

    Type Aliases​

    CameraProjection​

    Ƭ CameraProjection: "Perspective" | "Orthographic"

    The projection system of the camera.

    Defined in​

    temp/engine_components/src/navigation/OrthoPerspectiveCamera/src/types.ts:7

    Ƭ NavModeID: "Orbit" | "FirstPerson" | "Plan"

    The extensible list of supported navigation modes.

    Defined in​

    temp/engine_components/src/navigation/OrthoPerspectiveCamera/src/types.ts:12

    Variables​

    DimensionLabelClassName​

    • Const DimensionLabelClassName: "text-white text-sm bg-ifcjs-100 rounded-md px-3 py-1"

    The name of the CSS class that styles the dimension label.

    Defined in​

    temp/engine_components/src/measurement/SimpleDimensionLine/types.ts:4

    DimensionPreviewClassName​

    • Const DimensionPreviewClassName: "bg-ifcjs-100 rounded-full w-[8px] h-[8px]"

    The name of the CSS class that styles the dimension label.

    Defined in​

    temp/engine_components/src/measurement/SimpleDimensionLine/types.ts:8

    - - +
    +
    Skip to main content

    Module: openbim-components

    Classes​

    Interfaces​

    Type Aliases​

    CameraProjection​

    Ƭ CameraProjection: "Perspective" | "Orthographic"

    The projection system of the camera.

    Defined in​

    src/navigation/OrthoPerspectiveCamera/src/types.ts:7

    Ƭ NavModeID: "Orbit" | "FirstPerson" | "Plan"

    The extensible list of supported navigation modes.

    Defined in​

    src/navigation/OrthoPerspectiveCamera/src/types.ts:12

    Variables​

    DimensionLabelClassName​

    • Const DimensionLabelClassName: "text-white text-sm bg-ifcjs-100 rounded-md px-3 py-1"

    The name of the CSS class that styles the dimension label.

    Defined in​

    src/measurement/SimpleDimensionLine/types.ts:4

    DimensionPreviewClassName​

    • Const DimensionPreviewClassName: "bg-ifcjs-100 rounded-full w-[8px] h-[8px]"

    The name of the CSS class that styles the dimension label.

    Defined in​

    src/measurement/SimpleDimensionLine/types.ts:8

    + + \ No newline at end of file diff --git a/build/assets/css/styles.76eba8b3.css b/build/assets/css/styles.76eba8b3.css deleted file mode 100644 index e3c2a717..00000000 --- a/build/assets/css/styles.76eba8b3.css +++ /dev/null @@ -1 +0,0 @@ -@import url(https://fonts.googleapis.com/css2?family=Plus+Jakarta+Sans:wght@300;400;500;600;700&family=Sora:wght@400;600&display=swap);.col,.container{padding:0 var(--ifm-spacing-horizontal);width:100%}.markdown>h2,.markdown>h3,.markdown>h4,.markdown>h5,.markdown>h6{margin-bottom:calc(var(--ifm-heading-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown li,body{word-wrap:break-word}body,ol ol,ol ul,ul ol,ul ul{margin:0}pre,table{overflow:auto}blockquote,pre{margin:0 0 var(--ifm-spacing-vertical)}.breadcrumbs__link,.button{transition-timing-function:var(--ifm-transition-timing-default)}.button,code{vertical-align:middle}.button--outline.button--active,.button--outline:active,.button--outline:hover,:root{--ifm-button-color:var(--ifm-font-color-base-inverse)}.menu__link:hover,a{transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.navbar--dark,:root{--ifm-navbar-link-hover-color:var(--ifm-color-primary)}.menu,.navbar-sidebar{overflow-x:hidden}:root,html[data-theme=dark]{--ifm-color-emphasis-500:var(--ifm-color-gray-500)}.toggleButton_gllP,html{-webkit-tap-highlight-color:transparent}.clean-list,.containsTaskList_mC6p,.details_lb9f>summary,.dropdown__menu,.menu__list{list-style:none}:root{--ifm-color-scheme:light;--ifm-dark-value:10%;--ifm-darker-value:15%;--ifm-darkest-value:30%;--ifm-light-value:15%;--ifm-lighter-value:30%;--ifm-lightest-value:50%;--ifm-contrast-background-value:90%;--ifm-contrast-foreground-value:70%;--ifm-contrast-background-dark-value:70%;--ifm-contrast-foreground-dark-value:90%;--ifm-color-primary:#3578e5;--ifm-color-secondary:#ebedf0;--ifm-color-success:#00a400;--ifm-color-info:#54c7ec;--ifm-color-warning:#ffba00;--ifm-color-danger:#fa383e;--ifm-color-primary-dark:#306cce;--ifm-color-primary-darker:#2d66c3;--ifm-color-primary-darkest:#2554a0;--ifm-color-primary-light:#538ce9;--ifm-color-primary-lighter:#72a1ed;--ifm-color-primary-lightest:#9abcf2;--ifm-color-primary-contrast-background:#ebf2fc;--ifm-color-primary-contrast-foreground:#102445;--ifm-color-secondary-dark:#d4d5d8;--ifm-color-secondary-darker:#c8c9cc;--ifm-color-secondary-darkest:#a4a6a8;--ifm-color-secondary-light:#eef0f2;--ifm-color-secondary-lighter:#f1f2f5;--ifm-color-secondary-lightest:#f5f6f8;--ifm-color-secondary-contrast-background:#fdfdfe;--ifm-color-secondary-contrast-foreground:#474748;--ifm-color-success-dark:#009400;--ifm-color-success-darker:#008b00;--ifm-color-success-darkest:#007300;--ifm-color-success-light:#26b226;--ifm-color-success-lighter:#4dbf4d;--ifm-color-success-lightest:#80d280;--ifm-color-success-contrast-background:#e6f6e6;--ifm-color-success-contrast-foreground:#003100;--ifm-color-info-dark:#4cb3d4;--ifm-color-info-darker:#47a9c9;--ifm-color-info-darkest:#3b8ba5;--ifm-color-info-light:#6ecfef;--ifm-color-info-lighter:#87d8f2;--ifm-color-info-lightest:#aae3f6;--ifm-color-info-contrast-background:#eef9fd;--ifm-color-info-contrast-foreground:#193c47;--ifm-color-warning-dark:#e6a700;--ifm-color-warning-darker:#d99e00;--ifm-color-warning-darkest:#b38200;--ifm-color-warning-light:#ffc426;--ifm-color-warning-lighter:#ffcf4d;--ifm-color-warning-lightest:#ffdd80;--ifm-color-warning-contrast-background:#fff8e6;--ifm-color-warning-contrast-foreground:#4d3800;--ifm-color-danger-dark:#e13238;--ifm-color-danger-darker:#d53035;--ifm-color-danger-darkest:#af272b;--ifm-color-danger-light:#fb565b;--ifm-color-danger-lighter:#fb7478;--ifm-color-danger-lightest:#fd9c9f;--ifm-color-danger-contrast-background:#ffebec;--ifm-color-danger-contrast-foreground:#4b1113;--ifm-color-white:#fff;--ifm-color-black:#000;--ifm-color-gray-0:var(--ifm-color-white);--ifm-color-gray-100:#f5f6f7;--ifm-color-gray-200:#ebedf0;--ifm-color-gray-300:#dadde1;--ifm-color-gray-400:#ccd0d5;--ifm-color-gray-500:#bec3c9;--ifm-color-gray-600:#8d949e;--ifm-color-gray-700:#606770;--ifm-color-gray-800:#444950;--ifm-color-gray-900:#1c1e21;--ifm-color-gray-1000:var(--ifm-color-black);--ifm-color-emphasis-0:var(--ifm-color-gray-0);--ifm-color-emphasis-100:var(--ifm-color-gray-100);--ifm-color-emphasis-200:var(--ifm-color-gray-200);--ifm-color-emphasis-300:var(--ifm-color-gray-300);--ifm-color-emphasis-400:var(--ifm-color-gray-400);--ifm-color-emphasis-600:var(--ifm-color-gray-600);--ifm-color-emphasis-700:var(--ifm-color-gray-700);--ifm-color-emphasis-800:var(--ifm-color-gray-800);--ifm-color-emphasis-900:var(--ifm-color-gray-900);--ifm-color-emphasis-1000:var(--ifm-color-gray-1000);--ifm-color-content:var(--ifm-color-emphasis-900);--ifm-color-content-inverse:var(--ifm-color-emphasis-0);--ifm-color-content-secondary:#525860;--ifm-background-color:transparent;--ifm-background-surface-color:var(--ifm-color-content-inverse);--ifm-global-border-width:1px;--ifm-global-radius:0.4rem;--ifm-hover-overlay:rgba(0,0,0,.05);--ifm-font-color-base:var(--ifm-color-content);--ifm-font-color-base-inverse:var(--ifm-color-content-inverse);--ifm-font-color-secondary:var(--ifm-color-content-secondary);--ifm-font-family-base:system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";--ifm-font-family-monospace:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;--ifm-font-size-base:100%;--ifm-font-weight-light:300;--ifm-font-weight-normal:400;--ifm-font-weight-semibold:500;--ifm-font-weight-bold:700;--ifm-font-weight-base:var(--ifm-font-weight-normal);--ifm-line-height-base:1.65;--ifm-global-spacing:1rem;--ifm-spacing-vertical:var(--ifm-global-spacing);--ifm-spacing-horizontal:var(--ifm-global-spacing);--ifm-transition-fast:200ms;--ifm-transition-slow:400ms;--ifm-transition-timing-default:cubic-bezier(0.08,0.52,0.52,1);--ifm-global-shadow-lw:0 1px 2px 0 rgba(0,0,0,.1);--ifm-global-shadow-md:0 5px 40px rgba(0,0,0,.2);--ifm-global-shadow-tl:0 12px 28px 0 rgba(0,0,0,.2),0 2px 4px 0 rgba(0,0,0,.1);--ifm-z-index-dropdown:100;--ifm-z-index-fixed:200;--ifm-z-index-overlay:400;--ifm-container-width:1140px;--ifm-container-width-xl:1320px;--ifm-code-background:#f6f7f8;--ifm-code-border-radius:var(--ifm-global-radius);--ifm-code-font-size:90%;--ifm-code-padding-horizontal:0.1rem;--ifm-code-padding-vertical:0.1rem;--ifm-pre-background:var(--ifm-code-background);--ifm-pre-border-radius:var(--ifm-code-border-radius);--ifm-pre-color:inherit;--ifm-pre-line-height:1.45;--ifm-pre-padding:1rem;--ifm-heading-color:inherit;--ifm-heading-margin-top:0;--ifm-heading-margin-bottom:var(--ifm-spacing-vertical);--ifm-heading-font-family:var(--ifm-font-family-base);--ifm-heading-font-weight:var(--ifm-font-weight-bold);--ifm-heading-line-height:1.25;--ifm-h1-font-size:2rem;--ifm-h2-font-size:1.5rem;--ifm-h3-font-size:1.25rem;--ifm-h4-font-size:1rem;--ifm-h5-font-size:0.875rem;--ifm-h6-font-size:0.85rem;--ifm-image-alignment-padding:1.25rem;--ifm-leading-desktop:1.25;--ifm-leading:calc(var(--ifm-leading-desktop)*1rem);--ifm-list-left-padding:2rem;--ifm-list-margin:1rem;--ifm-list-item-margin:0.25rem;--ifm-list-paragraph-margin:1rem;--ifm-table-cell-padding:0.75rem;--ifm-table-background:transparent;--ifm-table-stripe-background:rgba(0,0,0,.03);--ifm-table-border-width:1px;--ifm-table-border-color:var(--ifm-color-emphasis-300);--ifm-table-head-background:inherit;--ifm-table-head-color:inherit;--ifm-table-head-font-weight:var(--ifm-font-weight-bold);--ifm-table-cell-color:inherit;--ifm-link-color:var(--ifm-color-primary);--ifm-link-decoration:none;--ifm-link-hover-color:var(--ifm-link-color);--ifm-link-hover-decoration:underline;--ifm-paragraph-margin-bottom:var(--ifm-leading);--ifm-blockquote-font-size:var(--ifm-font-size-base);--ifm-blockquote-border-left-width:2px;--ifm-blockquote-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-blockquote-padding-vertical:0;--ifm-blockquote-shadow:none;--ifm-blockquote-color:var(--ifm-color-emphasis-800);--ifm-blockquote-border-color:var(--ifm-color-emphasis-300);--ifm-hr-background-color:var(--ifm-color-emphasis-500);--ifm-hr-height:1px;--ifm-hr-margin-vertical:1.5rem;--ifm-scrollbar-size:7px;--ifm-scrollbar-track-background-color:#f1f1f1;--ifm-scrollbar-thumb-background-color:silver;--ifm-scrollbar-thumb-hover-background-color:#a7a7a7;--ifm-alert-background-color:inherit;--ifm-alert-border-color:inherit;--ifm-alert-border-radius:var(--ifm-global-radius);--ifm-alert-border-width:0px;--ifm-alert-border-left-width:5px;--ifm-alert-color:var(--ifm-font-color-base);--ifm-alert-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-alert-padding-vertical:var(--ifm-spacing-vertical);--ifm-alert-shadow:var(--ifm-global-shadow-lw);--ifm-avatar-intro-margin:1rem;--ifm-avatar-intro-alignment:inherit;--ifm-avatar-photo-size:3rem;--ifm-badge-background-color:inherit;--ifm-badge-border-color:inherit;--ifm-badge-border-radius:var(--ifm-global-radius);--ifm-badge-border-width:var(--ifm-global-border-width);--ifm-badge-color:var(--ifm-color-white);--ifm-badge-padding-horizontal:calc(var(--ifm-spacing-horizontal)*0.5);--ifm-badge-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-breadcrumb-border-radius:1.5rem;--ifm-breadcrumb-spacing:0.5rem;--ifm-breadcrumb-color-active:var(--ifm-color-primary);--ifm-breadcrumb-item-background-active:var(--ifm-hover-overlay);--ifm-breadcrumb-padding-horizontal:0.8rem;--ifm-breadcrumb-padding-vertical:0.4rem;--ifm-breadcrumb-size-multiplier:1;--ifm-breadcrumb-separator:url('data:image/svg+xml;utf8,');--ifm-breadcrumb-separator-filter:none;--ifm-breadcrumb-separator-size:0.5rem;--ifm-breadcrumb-separator-size-multiplier:1.25;--ifm-button-background-color:inherit;--ifm-button-border-color:var(--ifm-button-background-color);--ifm-button-border-width:var(--ifm-global-border-width);--ifm-button-font-weight:var(--ifm-font-weight-bold);--ifm-button-padding-horizontal:1.5rem;--ifm-button-padding-vertical:0.375rem;--ifm-button-size-multiplier:1;--ifm-button-transition-duration:var(--ifm-transition-fast);--ifm-button-border-radius:calc(var(--ifm-global-radius)*var(--ifm-button-size-multiplier));--ifm-button-group-spacing:2px;--ifm-card-background-color:var(--ifm-background-surface-color);--ifm-card-border-radius:calc(var(--ifm-global-radius)*2);--ifm-card-horizontal-spacing:var(--ifm-global-spacing);--ifm-card-vertical-spacing:var(--ifm-global-spacing);--ifm-toc-border-color:var(--ifm-color-emphasis-300);--ifm-toc-link-color:var(--ifm-color-content-secondary);--ifm-toc-padding-vertical:0.5rem;--ifm-toc-padding-horizontal:0.5rem;--ifm-dropdown-background-color:var(--ifm-background-surface-color);--ifm-dropdown-font-weight:var(--ifm-font-weight-semibold);--ifm-dropdown-link-color:var(--ifm-font-color-base);--ifm-dropdown-hover-background-color:var(--ifm-hover-overlay);--ifm-footer-background-color:var(--ifm-color-emphasis-100);--ifm-footer-color:inherit;--ifm-footer-link-color:var(--ifm-color-emphasis-700);--ifm-footer-link-hover-color:var(--ifm-color-primary);--ifm-footer-link-horizontal-spacing:0.5rem;--ifm-footer-padding-horizontal:calc(var(--ifm-spacing-horizontal)*2);--ifm-footer-padding-vertical:calc(var(--ifm-spacing-vertical)*2);--ifm-footer-title-color:inherit;--ifm-footer-logo-max-width:min(30rem,90vw);--ifm-hero-background-color:var(--ifm-background-surface-color);--ifm-hero-text-color:var(--ifm-color-emphasis-800);--ifm-menu-color:var(--ifm-color-emphasis-700);--ifm-menu-color-active:var(--ifm-color-primary);--ifm-menu-color-background-active:var(--ifm-hover-overlay);--ifm-menu-color-background-hover:var(--ifm-hover-overlay);--ifm-menu-link-padding-horizontal:0.75rem;--ifm-menu-link-padding-vertical:0.375rem;--ifm-menu-link-sublist-icon:url('data:image/svg+xml;utf8,');--ifm-menu-link-sublist-icon-filter:none;--ifm-navbar-background-color:var(--ifm-background-surface-color);--ifm-navbar-height:3.75rem;--ifm-navbar-item-padding-horizontal:0.75rem;--ifm-navbar-item-padding-vertical:0.25rem;--ifm-navbar-link-color:var(--ifm-font-color-base);--ifm-navbar-link-active-color:var(--ifm-link-color);--ifm-navbar-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-navbar-padding-vertical:calc(var(--ifm-spacing-vertical)*0.5);--ifm-navbar-shadow:var(--ifm-global-shadow-lw);--ifm-navbar-search-input-background-color:var(--ifm-color-emphasis-200);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-800);--ifm-navbar-search-input-placeholder-color:var(--ifm-color-emphasis-500);--ifm-navbar-search-input-icon:url('data:image/svg+xml;utf8,');--ifm-navbar-sidebar-width:83vw;--ifm-pagination-border-radius:var(--ifm-global-radius);--ifm-pagination-color-active:var(--ifm-color-primary);--ifm-pagination-font-size:1rem;--ifm-pagination-item-active-background:var(--ifm-hover-overlay);--ifm-pagination-page-spacing:0.2em;--ifm-pagination-padding-horizontal:calc(var(--ifm-spacing-horizontal)*1);--ifm-pagination-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-pagination-nav-border-radius:var(--ifm-global-radius);--ifm-pagination-nav-color-hover:var(--ifm-color-primary);--ifm-pills-color-active:var(--ifm-color-primary);--ifm-pills-color-background-active:var(--ifm-hover-overlay);--ifm-pills-spacing:0.125rem;--ifm-tabs-color:var(--ifm-font-color-secondary);--ifm-tabs-color-active:var(--ifm-color-primary);--ifm-tabs-color-active-border:var(--ifm-tabs-color-active);--ifm-tabs-padding-horizontal:1rem;--ifm-tabs-padding-vertical:1rem}.badge--danger,.badge--info,.badge--primary,.badge--secondary,.badge--success,.badge--warning{--ifm-badge-border-color:var(--ifm-badge-background-color)}.button--link,.button--outline{--ifm-button-background-color:transparent}*{box-sizing:border-box}html{-webkit-font-smoothing:antialiased;-webkit-text-size-adjust:100%;-moz-text-size-adjust:100%;text-size-adjust:100%;background-color:var(--ifm-background-color);color:var(--ifm-font-color-base);color-scheme:var(--ifm-color-scheme);font:var(--ifm-font-size-base)/var(--ifm-line-height-base) var(--ifm-font-family-base);text-rendering:optimizelegibility}iframe{border:0;color-scheme:auto;height:25rem;margin:1rem;width:calc(100% - 2rem)}.container{margin:0 auto;max-width:var(--ifm-container-width)}.container--fluid{max-width:inherit}.row{display:flex;flex-wrap:wrap;margin:0 calc(var(--ifm-spacing-horizontal)*-1)}.margin-bottom--none,.margin-vert--none,.markdown>:last-child{margin-bottom:0!important}.margin-top--none,.margin-vert--none{margin-top:0!important}.row--no-gutters{margin-left:0;margin-right:0}.margin-horiz--none,.margin-right--none{margin-right:0!important}.row--no-gutters>.col{padding-left:0;padding-right:0}.row--align-top{align-items:flex-start}.row--align-bottom{align-items:flex-end}.menuExternalLink_NmtK,.row--align-center{align-items:center}.row--align-stretch{align-items:stretch}.row--align-baseline{align-items:baseline}.col{--ifm-col-width:100%;flex:1 0;margin-left:0;max-width:var(--ifm-col-width)}.padding-bottom--none,.padding-vert--none{padding-bottom:0!important}.padding-top--none,.padding-vert--none{padding-top:0!important}.padding-horiz--none,.padding-left--none{padding-left:0!important}.padding-horiz--none,.padding-right--none{padding-right:0!important}.col[class*=col--]{flex:0 0 var(--ifm-col-width)}.col--1{--ifm-col-width:8.33333%}.col--offset-1{margin-left:8.33333%}.col--2{--ifm-col-width:16.66667%}.col--offset-2{margin-left:16.66667%}.col--3{--ifm-col-width:25%}.col--offset-3{margin-left:25%}.col--4{--ifm-col-width:33.33333%}.col--offset-4{margin-left:33.33333%}.col--5{--ifm-col-width:41.66667%}.col--offset-5{margin-left:41.66667%}.col--6{--ifm-col-width:50%}.col--offset-6{margin-left:50%}.col--7{--ifm-col-width:58.33333%}.col--offset-7{margin-left:58.33333%}.col--8{--ifm-col-width:66.66667%}.col--offset-8{margin-left:66.66667%}.col--9{--ifm-col-width:75%}.col--offset-9{margin-left:75%}.col--10{--ifm-col-width:83.33333%}.col--offset-10{margin-left:83.33333%}.col--11{--ifm-col-width:91.66667%}.col--offset-11{margin-left:91.66667%}.col--12{--ifm-col-width:100%}.col--offset-12{margin-left:100%}.margin-horiz--none,.margin-left--none{margin-left:0!important}.margin--none{margin:0!important}.margin-bottom--xs,.margin-vert--xs{margin-bottom:.25rem!important}.margin-top--xs,.margin-vert--xs{margin-top:.25rem!important}.margin-horiz--xs,.margin-left--xs{margin-left:.25rem!important}.margin-horiz--xs,.margin-right--xs{margin-right:.25rem!important}.margin--xs{margin:.25rem!important}.margin-bottom--sm,.margin-vert--sm{margin-bottom:.5rem!important}.margin-top--sm,.margin-vert--sm{margin-top:.5rem!important}.margin-horiz--sm,.margin-left--sm{margin-left:.5rem!important}.margin-horiz--sm,.margin-right--sm{margin-right:.5rem!important}.margin--sm{margin:.5rem!important}.margin-bottom--md,.margin-vert--md{margin-bottom:1rem!important}.margin-top--md,.margin-vert--md{margin-top:1rem!important}.margin-horiz--md,.margin-left--md{margin-left:1rem!important}.margin-horiz--md,.margin-right--md{margin-right:1rem!important}.margin--md{margin:1rem!important}.margin-bottom--lg,.margin-vert--lg{margin-bottom:2rem!important}.margin-top--lg,.margin-vert--lg{margin-top:2rem!important}.margin-horiz--lg,.margin-left--lg{margin-left:2rem!important}.margin-horiz--lg,.margin-right--lg{margin-right:2rem!important}.margin--lg{margin:2rem!important}.margin-bottom--xl,.margin-vert--xl{margin-bottom:5rem!important}.margin-top--xl,.margin-vert--xl{margin-top:5rem!important}.margin-horiz--xl,.margin-left--xl{margin-left:5rem!important}.margin-horiz--xl,.margin-right--xl{margin-right:5rem!important}.margin--xl{margin:5rem!important}.padding--none{padding:0!important}.padding-bottom--xs,.padding-vert--xs{padding-bottom:.25rem!important}.padding-top--xs,.padding-vert--xs{padding-top:.25rem!important}.padding-horiz--xs,.padding-left--xs{padding-left:.25rem!important}.padding-horiz--xs,.padding-right--xs{padding-right:.25rem!important}.padding--xs{padding:.25rem!important}.padding-bottom--sm,.padding-vert--sm{padding-bottom:.5rem!important}.padding-top--sm,.padding-vert--sm{padding-top:.5rem!important}.padding-horiz--sm,.padding-left--sm{padding-left:.5rem!important}.padding-horiz--sm,.padding-right--sm{padding-right:.5rem!important}.padding--sm{padding:.5rem!important}.padding-bottom--md,.padding-vert--md{padding-bottom:1rem!important}.padding-top--md,.padding-vert--md{padding-top:1rem!important}.padding-horiz--md,.padding-left--md{padding-left:1rem!important}.padding-horiz--md,.padding-right--md{padding-right:1rem!important}.padding--md{padding:1rem!important}.padding-bottom--lg,.padding-vert--lg{padding-bottom:2rem!important}.padding-top--lg,.padding-vert--lg,[class="sidebar_node_modules-@docusaurus-theme-classic-lib-theme-DocSidebar-Desktop-styles-module"]{padding-top:2rem!important}.padding-horiz--lg,.padding-left--lg{padding-left:2rem!important}.padding-horiz--lg,.padding-right--lg{padding-right:2rem!important}.padding--lg{padding:2rem!important}.padding-bottom--xl,.padding-vert--xl{padding-bottom:5rem!important}.padding-top--xl,.padding-vert--xl{padding-top:5rem!important}.padding-horiz--xl,.padding-left--xl{padding-left:5rem!important}.padding-horiz--xl,.padding-right--xl{padding-right:5rem!important}.padding--xl{padding:5rem!important}code{background-color:var(--ifm-code-background);border:.1rem solid rgba(0,0,0,.1);border-radius:var(--ifm-code-border-radius);font-family:var(--ifm-font-family-monospace);font-size:var(--ifm-code-font-size);padding:var(--ifm-code-padding-vertical) var(--ifm-code-padding-horizontal)}a code{color:inherit}pre{background-color:var(--ifm-pre-background);border-radius:var(--ifm-pre-border-radius);color:var(--ifm-pre-color);font:var(--ifm-code-font-size)/var(--ifm-pre-line-height) var(--ifm-font-family-monospace);padding:var(--ifm-pre-padding)}pre code{background-color:transparent;border:none;font-size:100%;line-height:inherit;padding:0}kbd{background-color:var(--ifm-color-emphasis-0);border:1px solid var(--ifm-color-emphasis-400);border-radius:.2rem;box-shadow:inset 0 -1px 0 var(--ifm-color-emphasis-400);color:var(--ifm-color-emphasis-800);font:80% var(--ifm-font-family-monospace);padding:.15rem .3rem}h1,h2,h3,h4,h5,h6{color:var(--ifm-heading-color);font-family:var(--ifm-heading-font-family);font-weight:var(--ifm-heading-font-weight);line-height:var(--ifm-heading-line-height);margin:var(--ifm-heading-margin-top) 0 var(--ifm-heading-margin-bottom) 0}h1{font-size:var(--ifm-h1-font-size)}h2{font-size:var(--ifm-h2-font-size)}h3{font-size:var(--ifm-h3-font-size)}h4{font-size:var(--ifm-h4-font-size)}h5{font-size:var(--ifm-h5-font-size)}h6{font-size:var(--ifm-h6-font-size)}img{max-width:100%}img[align=right]{padding-left:var(--image-alignment-padding)}img[align=left]{padding-right:var(--image-alignment-padding)}.markdown{--ifm-h1-vertical-rhythm-top:3;--ifm-h2-vertical-rhythm-top:2;--ifm-h3-vertical-rhythm-top:1.5;--ifm-heading-vertical-rhythm-top:1.25;--ifm-h1-vertical-rhythm-bottom:1.25;--ifm-heading-vertical-rhythm-bottom:1}.markdown:after,.markdown:before{content:"";display:table}.markdown:after{clear:both}.markdown h1:first-child{--ifm-h1-font-size:3rem;margin-bottom:calc(var(--ifm-h1-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown>h2{--ifm-h2-font-size:2rem;margin-top:calc(var(--ifm-h2-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h3{--ifm-h3-font-size:1.5rem;margin-top:calc(var(--ifm-h3-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h4,.markdown>h5,.markdown>h6{margin-top:calc(var(--ifm-heading-vertical-rhythm-top)*var(--ifm-leading))}.markdown>p,.markdown>pre,.markdown>ul{margin-bottom:var(--ifm-leading)}.markdown li>p{margin-top:var(--ifm-list-paragraph-margin)}.markdown li+li{margin-top:var(--ifm-list-item-margin)}ol,ul{margin:0 0 var(--ifm-list-margin);padding-left:var(--ifm-list-left-padding)}ol ol,ul ol{list-style-type:lower-roman}ol ol ol,ol ul ol,ul ol ol,ul ul ol{list-style-type:lower-alpha}table{border-collapse:collapse;display:block;margin-bottom:var(--ifm-spacing-vertical)}table thead tr{border-bottom:2px solid var(--ifm-table-border-color)}table thead,table tr:nth-child(2n){background-color:var(--ifm-table-stripe-background)}table tr{background-color:var(--ifm-table-background);border-top:var(--ifm-table-border-width) solid var(--ifm-table-border-color)}table td,table th{border:var(--ifm-table-border-width) solid var(--ifm-table-border-color);padding:var(--ifm-table-cell-padding)}table th{background-color:var(--ifm-table-head-background);color:var(--ifm-table-head-color);font-weight:var(--ifm-table-head-font-weight)}table td{color:var(--ifm-table-cell-color)}strong{font-weight:var(--ifm-font-weight-bold);color:#fff}a{color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}a:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button:hover,.text--no-decoration,.text--no-decoration:hover,a:not([href]){text-decoration:none}p{margin:0 0 var(--ifm-paragraph-margin-bottom);color:var(--light-gray)}blockquote{border-left:var(--ifm-blockquote-border-left-width) solid var(--ifm-blockquote-border-color);box-shadow:var(--ifm-blockquote-shadow);color:var(--ifm-blockquote-color);font-size:var(--ifm-blockquote-font-size);padding:var(--ifm-blockquote-padding-vertical) var(--ifm-blockquote-padding-horizontal)}blockquote>:first-child{margin-top:0}blockquote>:last-child{margin-bottom:0}hr{background-color:var(--ifm-hr-background-color);border:0;height:var(--ifm-hr-height);margin:var(--ifm-hr-margin-vertical) 0}.shadow--lw{box-shadow:var(--ifm-global-shadow-lw)!important}.shadow--md{box-shadow:var(--ifm-global-shadow-md)!important}.shadow--tl{box-shadow:var(--ifm-global-shadow-tl)!important}.text--primary,.wordWrapButtonEnabled_EoeP .wordWrapButtonIcon_Bwma{color:var(--ifm-color-primary)}.text--secondary{color:var(--ifm-color-secondary)}.text--success{color:var(--ifm-color-success)}.text--info{color:var(--ifm-color-info)}.text--warning{color:var(--ifm-color-warning)}.text--danger{color:var(--ifm-color-danger)}.text--center{text-align:center}.text--left{text-align:left}.text--justify{text-align:justify}.text--right{text-align:right}.text--capitalize{text-transform:capitalize}.text--lowercase{text-transform:lowercase}.admonitionHeading_tbUL,.alert__heading,.text--uppercase{text-transform:uppercase}.text--light{font-weight:var(--ifm-font-weight-light)}.text--normal{font-weight:var(--ifm-font-weight-normal)}.text--semibold{font-weight:var(--ifm-font-weight-semibold)}.text--bold{font-weight:var(--ifm-font-weight-bold)}.text--italic{font-style:italic}.text--truncate{overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.text--break{word-wrap:break-word!important;word-break:break-word!important}.clean-btn{background:none;border:none;color:inherit;cursor:pointer;font-family:inherit;padding:0}.alert,.alert .close{color:var(--ifm-alert-foreground-color)}.clean-list{padding-left:0}.alert--primary{--ifm-alert-background-color:var(--ifm-color-primary-contrast-background);--ifm-alert-background-color-highlight:rgba(53,120,229,.15);--ifm-alert-foreground-color:var(--ifm-color-primary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-primary-dark)}.alert--secondary{--ifm-alert-background-color:var(--ifm-color-secondary-contrast-background);--ifm-alert-background-color-highlight:rgba(235,237,240,.15);--ifm-alert-foreground-color:var(--ifm-color-secondary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-secondary-dark)}.alert--success{--ifm-alert-background-color:var(--ifm-color-success-contrast-background);--ifm-alert-background-color-highlight:rgba(0,164,0,.15);--ifm-alert-foreground-color:var(--ifm-color-success-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-success-dark)}.alert--info{--ifm-alert-background-color:var(--ifm-color-info-contrast-background);--ifm-alert-background-color-highlight:rgba(84,199,236,.15);--ifm-alert-foreground-color:var(--ifm-color-info-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-info-dark)}.alert--warning{--ifm-alert-background-color:var(--ifm-color-warning-contrast-background);--ifm-alert-background-color-highlight:rgba(255,186,0,.15);--ifm-alert-foreground-color:var(--ifm-color-warning-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-warning-dark)}.alert--danger{--ifm-alert-background-color:var(--ifm-color-danger-contrast-background);--ifm-alert-background-color-highlight:rgba(250,56,62,.15);--ifm-alert-foreground-color:var(--ifm-color-danger-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-danger-dark)}.alert{--ifm-code-background:var(--ifm-alert-background-color-highlight);--ifm-link-color:var(--ifm-alert-foreground-color);--ifm-link-hover-color:var(--ifm-alert-foreground-color);--ifm-link-decoration:underline;--ifm-tabs-color:var(--ifm-alert-foreground-color);--ifm-tabs-color-active:var(--ifm-alert-foreground-color);--ifm-tabs-color-active-border:var(--ifm-alert-border-color);background-color:var(--ifm-alert-background-color);border:var(--ifm-alert-border-width) solid var(--ifm-alert-border-color);border-left-width:var(--ifm-alert-border-left-width);border-radius:var(--ifm-alert-border-radius);box-shadow:var(--ifm-alert-shadow);padding:var(--ifm-alert-padding-vertical) var(--ifm-alert-padding-horizontal)}.alert__heading{align-items:center;display:flex;font:700 var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family);margin-bottom:.5rem}.alert__icon{display:inline-flex;margin-right:.4em}.alert__icon svg{fill:var(--ifm-alert-foreground-color);stroke:var(--ifm-alert-foreground-color);stroke-width:0}.alert .close{margin:calc(var(--ifm-alert-padding-vertical)*-1) calc(var(--ifm-alert-padding-horizontal)*-1) 0 0;opacity:.75}.alert .close:focus,.alert .close:hover{opacity:1}.alert a{text-decoration-color:var(--ifm-alert-border-color)}.alert a:hover{text-decoration-thickness:2px}.avatar{-moz-column-gap:var(--ifm-avatar-intro-margin);column-gap:var(--ifm-avatar-intro-margin);display:flex}.avatar__photo{border-radius:50%;display:block;height:var(--ifm-avatar-photo-size);overflow:hidden;width:var(--ifm-avatar-photo-size)}.card--full-height,.navbar__logo img,body,html{height:100%}.avatar__photo--sm{--ifm-avatar-photo-size:2rem}.avatar__photo--lg{--ifm-avatar-photo-size:4rem}.avatar__photo--xl{--ifm-avatar-photo-size:6rem}.avatar__intro{display:flex;flex:1 1;flex-direction:column;justify-content:center;text-align:var(--ifm-avatar-intro-alignment)}.badge,.breadcrumbs__item,.breadcrumbs__link,.button,.dropdown>.navbar__link:after{display:inline-block}.avatar__name{font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base)}.avatar__subtitle{margin-top:.25rem}.avatar--vertical{--ifm-avatar-intro-alignment:center;--ifm-avatar-intro-margin:0.5rem;align-items:center;flex-direction:column}.badge{background-color:var(--ifm-badge-background-color);border:var(--ifm-badge-border-width) solid var(--ifm-badge-border-color);border-radius:var(--ifm-badge-border-radius);color:var(--ifm-badge-color);font-size:75%;font-weight:var(--ifm-font-weight-bold);line-height:1;padding:var(--ifm-badge-padding-vertical) var(--ifm-badge-padding-horizontal)}.badge--primary{--ifm-badge-background-color:var(--ifm-color-primary)}.badge--secondary{--ifm-badge-background-color:var(--ifm-color-secondary);color:var(--ifm-color-black)}.breadcrumbs__link,.button.button--secondary.button--outline:not(.button--active):not(:hover){color:var(--ifm-font-color-base)}.badge--success{--ifm-badge-background-color:var(--ifm-color-success)}.badge--info{--ifm-badge-background-color:var(--ifm-color-info)}.badge--warning{--ifm-badge-background-color:var(--ifm-color-warning)}.badge--danger{--ifm-badge-background-color:var(--ifm-color-danger)}.breadcrumbs{margin-bottom:0;padding-left:0}.breadcrumbs__item:not(:last-child):after{background:var(--ifm-breadcrumb-separator) center;content:" ";display:inline-block;filter:var(--ifm-breadcrumb-separator-filter);height:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier));margin:0 var(--ifm-breadcrumb-spacing);opacity:.5;width:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier))}.breadcrumbs__item--active .breadcrumbs__link{background:var(--ifm-breadcrumb-item-background-active);color:var(--ifm-breadcrumb-color-active)}.breadcrumbs__link{border-radius:var(--ifm-breadcrumb-border-radius);font-size:calc(1rem*var(--ifm-breadcrumb-size-multiplier));padding:calc(var(--ifm-breadcrumb-padding-vertical)*var(--ifm-breadcrumb-size-multiplier)) calc(var(--ifm-breadcrumb-padding-horizontal)*var(--ifm-breadcrumb-size-multiplier));transition-duration:var(--ifm-transition-fast);transition-property:background,color}.breadcrumbs__link:link:hover,.breadcrumbs__link:visited:hover,area[href].breadcrumbs__link:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs__link:-moz-any-link:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs__link:any-link:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs--sm{--ifm-breadcrumb-size-multiplier:0.8}.breadcrumbs--lg{--ifm-breadcrumb-size-multiplier:1.2}.button{background-color:var(--ifm-button-background-color);border:var(--ifm-button-border-width) solid var(--ifm-button-border-color);border-radius:var(--ifm-button-border-radius);cursor:pointer;font-size:calc(.875rem*var(--ifm-button-size-multiplier));font-weight:var(--ifm-button-font-weight);line-height:1.5;padding:calc(var(--ifm-button-padding-vertical)*var(--ifm-button-size-multiplier)) calc(var(--ifm-button-padding-horizontal)*var(--ifm-button-size-multiplier));text-align:center;transition-duration:var(--ifm-button-transition-duration);transition-property:color,background,border-color;-webkit-user-select:none;-moz-user-select:none;user-select:none;white-space:nowrap}.button,.button:hover{color:var(--ifm-button-color)}.button--outline{--ifm-button-color:var(--ifm-button-border-color)}.button--outline:hover{--ifm-button-background-color:var(--ifm-button-border-color)}.button--link{--ifm-button-border-color:transparent;color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}.button--link.button--active,.button--link:active,.button--link:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button.disabled,.button:disabled,.button[disabled]{opacity:.65;pointer-events:none}.button--sm{--ifm-button-size-multiplier:0.8}.button--lg{--ifm-button-size-multiplier:1.35}.button--block{display:block;width:100%}.button.button--secondary{color:var(--ifm-color-gray-900)}:where(.button--primary){--ifm-button-background-color:var(--ifm-color-primary);--ifm-button-border-color:var(--ifm-color-primary)}:where(.button--primary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-primary-dark);--ifm-button-border-color:var(--ifm-color-primary-dark)}.button--primary.button--active,.button--primary:active{--ifm-button-background-color:var(--ifm-color-primary-darker);--ifm-button-border-color:var(--ifm-color-primary-darker)}:where(.button--secondary){--ifm-button-background-color:var(--ifm-color-secondary);--ifm-button-border-color:var(--ifm-color-secondary)}:where(.button--secondary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-secondary-dark);--ifm-button-border-color:var(--ifm-color-secondary-dark)}.button--secondary.button--active,.button--secondary:active{--ifm-button-background-color:var(--ifm-color-secondary-darker);--ifm-button-border-color:var(--ifm-color-secondary-darker)}:where(.button--success){--ifm-button-background-color:var(--ifm-color-success);--ifm-button-border-color:var(--ifm-color-success)}:where(.button--success):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-success-dark);--ifm-button-border-color:var(--ifm-color-success-dark)}.button--success.button--active,.button--success:active{--ifm-button-background-color:var(--ifm-color-success-darker);--ifm-button-border-color:var(--ifm-color-success-darker)}:where(.button--info){--ifm-button-background-color:var(--ifm-color-info);--ifm-button-border-color:var(--ifm-color-info)}:where(.button--info):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-info-dark);--ifm-button-border-color:var(--ifm-color-info-dark)}.button--info.button--active,.button--info:active{--ifm-button-background-color:var(--ifm-color-info-darker);--ifm-button-border-color:var(--ifm-color-info-darker)}:where(.button--warning){--ifm-button-background-color:var(--ifm-color-warning);--ifm-button-border-color:var(--ifm-color-warning)}:where(.button--warning):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-warning-dark);--ifm-button-border-color:var(--ifm-color-warning-dark)}.button--warning.button--active,.button--warning:active{--ifm-button-background-color:var(--ifm-color-warning-darker);--ifm-button-border-color:var(--ifm-color-warning-darker)}:where(.button--danger){--ifm-button-background-color:var(--ifm-color-danger);--ifm-button-border-color:var(--ifm-color-danger)}:where(.button--danger):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-danger-dark);--ifm-button-border-color:var(--ifm-color-danger-dark)}.button--danger.button--active,.button--danger:active{--ifm-button-background-color:var(--ifm-color-danger-darker);--ifm-button-border-color:var(--ifm-color-danger-darker)}.button-group{display:inline-flex;gap:var(--ifm-button-group-spacing)}.button-group>.button:not(:first-child){border-bottom-left-radius:0;border-top-left-radius:0}.button-group>.button:not(:last-child){border-bottom-right-radius:0;border-top-right-radius:0}.button-group--block{display:flex;justify-content:stretch}.button-group--block>.button{flex-grow:1}.card{background-color:var(--ifm-card-background-color);border-radius:var(--ifm-card-border-radius);box-shadow:var(--ifm-global-shadow-lw);display:flex;flex-direction:column;overflow:hidden}.card__image{padding-top:var(--ifm-card-vertical-spacing)}.card__image:first-child{padding-top:0}.card__body,.card__footer,.card__header{padding:var(--ifm-card-vertical-spacing) var(--ifm-card-horizontal-spacing)}.card__body:not(:last-child),.card__footer:not(:last-child),.card__header:not(:last-child){padding-bottom:0}.card__body>:last-child,.card__footer>:last-child,.card__header>:last-child{margin-bottom:0}.card__footer{margin-top:auto}.table-of-contents{font-size:.8rem;margin-bottom:0;padding:var(--ifm-toc-padding-vertical) 0}.table-of-contents,.table-of-contents ul{list-style:none;padding-left:var(--ifm-toc-padding-horizontal)}.table-of-contents li{margin:var(--ifm-toc-padding-vertical) var(--ifm-toc-padding-horizontal)}.table-of-contents__left-border{border-left:1px solid var(--ifm-toc-border-color)}.table-of-contents__link{color:var(--ifm-toc-link-color);display:block}.table-of-contents__link--active,.table-of-contents__link--active code,.table-of-contents__link:hover,.table-of-contents__link:hover code{color:var(--ifm-color-primary);text-decoration:none}.close{color:var(--ifm-color-black);float:right;font-size:1.5rem;font-weight:var(--ifm-font-weight-bold);line-height:1;opacity:.5;padding:1rem;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.close:hover{opacity:.7}.close:focus,.theme-code-block-highlighted-line .codeLineNumber_Tfdd:before{opacity:.8}.dropdown{display:inline-flex;font-weight:var(--ifm-dropdown-font-weight);position:relative;vertical-align:top}.dropdown--hoverable:hover .dropdown__menu,.dropdown--show .dropdown__menu{opacity:1;pointer-events:all;transform:translateY(-1px);visibility:visible}#nprogress,.dropdown__menu,.navbar__item.dropdown .navbar__link:not([href]){pointer-events:none}.dropdown--right .dropdown__menu{left:inherit;right:0}.dropdown--nocaret .navbar__link:after{content:none!important}.dropdown__menu{background-color:var(--ifm-dropdown-background-color);border-radius:var(--ifm-global-radius);box-shadow:var(--ifm-global-shadow-md);left:0;max-height:80vh;min-width:10rem;opacity:0;overflow-y:auto;padding:.5rem;position:absolute;top:calc(100% - var(--ifm-navbar-item-padding-vertical) + .3rem);transform:translateY(-.625rem);transition-duration:var(--ifm-transition-fast);transition-property:opacity,transform,visibility;transition-timing-function:var(--ifm-transition-timing-default);visibility:hidden;z-index:var(--ifm-z-index-dropdown)}.menu__caret,.menu__link,.menu__list-item-collapsible{border-radius:.25rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.dropdown__link{border-radius:.25rem;color:var(--ifm-dropdown-link-color);display:block;font-size:.875rem;margin-top:.2rem;padding:.25rem .5rem;white-space:nowrap}.dropdown__link--active,.dropdown__link:hover{background-color:var(--ifm-dropdown-hover-background-color);color:var(--ifm-dropdown-link-color);text-decoration:none}.dropdown__link--active,.dropdown__link--active:hover{--ifm-dropdown-link-color:var(--ifm-link-color)}.dropdown>.navbar__link:after{border-color:currentcolor transparent;border-style:solid;border-width:.4em .4em 0;content:"";margin-left:.3em;position:relative;top:2px;transform:translateY(-50%)}.footer{background-color:var(--ifm-footer-background-color);color:var(--ifm-footer-color);padding:var(--ifm-footer-padding-vertical) var(--ifm-footer-padding-horizontal)}.footer--dark{--ifm-footer-background-color:#303846;--ifm-footer-color:var(--ifm-footer-link-color);--ifm-footer-link-color:var(--ifm-color-secondary);--ifm-footer-title-color:var(--ifm-color-white)}.footer__links{margin-bottom:1rem}.footer__link-item{color:var(--ifm-footer-link-color);line-height:2}.footer__link-item:hover{color:var(--ifm-footer-link-hover-color)}.footer__link-separator{margin:0 var(--ifm-footer-link-horizontal-spacing)}.footer__logo{margin-top:1rem;max-width:var(--ifm-footer-logo-max-width)}.footer__title{color:var(--ifm-footer-title-color);font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base);margin-bottom:var(--ifm-heading-margin-bottom)}.menu,.navbar__link{font-weight:var(--ifm-font-weight-semibold)}.docItemContainer_Djhp article>:first-child,.docItemContainer_Djhp header+*,.footer__item{margin-top:0}.admonitionContent_S0QG>:last-child,.collapsibleContent_i85q>:last-child,.footer__items{margin-bottom:0}.codeBlockStandalone_MEMb,.col,[type=checkbox]{padding:0}.hero{align-items:center;background-color:var(--ifm-hero-background-color);color:var(--ifm-hero-text-color);display:flex;padding:4rem 2rem}.hero--primary{--ifm-hero-background-color:var(--ifm-color-primary);--ifm-hero-text-color:var(--ifm-font-color-base-inverse)}.hero--dark{--ifm-hero-background-color:#303846;--ifm-hero-text-color:var(--ifm-color-white)}.hero__title{font-size:3rem}.hero__subtitle{font-size:1.5rem}.menu__list{margin:0;padding-left:0}.menu__caret,.menu__link{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu__list .menu__list{flex:0 0 100%;margin-top:.25rem;padding-left:var(--ifm-menu-link-padding-horizontal)}.menu__list-item:not(:first-child){margin-top:.25rem}.menu__list-item--collapsed .menu__list{height:0;overflow:hidden}.details_lb9f[data-collapsed=false].isBrowser_bmU9>summary:before,.details_lb9f[open]:not(.isBrowser_bmU9)>summary:before,.menu__list-item--collapsed .menu__caret:before,.menu__list-item--collapsed .menu__link--sublist:after{transform:rotate(90deg)}.menu__list-item-collapsible{display:flex;flex-wrap:wrap;position:relative}.menu__caret:hover,.menu__link:hover,.menu__list-item-collapsible--active,.menu__list-item-collapsible:hover{background:var(--ifm-menu-color-background-hover)}.menu__list-item-collapsible .menu__link--active,.menu__list-item-collapsible .menu__link:hover{background:none!important}.menu__caret,.menu__link{align-items:center;display:flex}.menu__link{color:var(--ifm-menu-color);flex:1;line-height:1.25}.menu__link:hover{color:var(--ifm-menu-color);text-decoration:none}.menu__caret:before,.menu__link--sublist-caret:after{height:1.25rem;transform:rotate(180deg);transition:transform var(--ifm-transition-fast) linear;width:1.25rem;filter:var(--ifm-menu-link-sublist-icon-filter);content:""}.menu__link--sublist-caret:after{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem;margin-left:auto;min-width:1.25rem}.menu__link--active,.menu__link--active:hover{color:var(--ifm-menu-color-active)}.navbar__brand,.navbar__link{color:var(--ifm-navbar-link-color)}.menu__link--active:not(.menu__link--sublist){background-color:var(--ifm-menu-color-background-active)}.menu__caret:before{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem}.navbar--dark,html[data-theme=dark]{--ifm-menu-link-sublist-icon-filter:invert(100%) sepia(94%) saturate(17%) hue-rotate(223deg) brightness(104%) contrast(98%)}.navbar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-navbar-shadow);height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar,.navbar>.container,.navbar>.container-fluid{display:flex}.navbar--fixed-top{position:sticky;top:0;z-index:var(--ifm-z-index-fixed)}.navbar-sidebar,.navbar-sidebar__backdrop{opacity:0;position:fixed;transition-duration:var(--ifm-transition-fast);transition-timing-function:ease-in-out;top:0;bottom:0;left:0;visibility:hidden}.navbar__inner{display:flex;flex-wrap:wrap;justify-content:space-between;width:100%}.navbar__brand{align-items:center;display:flex;margin-right:1rem;min-width:0}.navbar__brand:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.announcementBarContent_xLdY,.navbar__title{flex:1 1 auto}.navbar__toggle{display:none;margin-right:.5rem}.navbar__logo{flex:0 0 auto;height:2rem;margin-right:.5rem}.navbar__items{align-items:center;display:flex;flex:1;min-width:0}.navbar__items--center{flex:0 0 auto}.navbar__items--center .navbar__brand{margin:0}.navbar__items--center+.navbar__items--right{flex:1}.navbar__items--right{flex:0 0 auto;justify-content:flex-end}.navbar__items--right>:last-child{padding-right:0}.navbar__item{display:inline-block;padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.navbar__link--active,.navbar__link:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.navbar--dark,.navbar--primary{--ifm-menu-color:var(--ifm-color-gray-300);--ifm-navbar-link-color:var(--ifm-color-gray-100);--ifm-navbar-search-input-background-color:hsla(0,0%,100%,.1);--ifm-navbar-search-input-placeholder-color:hsla(0,0%,100%,.5);color:var(--ifm-color-white)}.navbar--dark{--ifm-navbar-background-color:#242526;--ifm-menu-color-background-active:hsla(0,0%,100%,.05);--ifm-navbar-search-input-color:var(--ifm-color-white)}.navbar--primary{--ifm-navbar-background-color:var(--ifm-color-primary);--ifm-navbar-link-hover-color:var(--ifm-color-white);--ifm-menu-color-active:var(--ifm-color-white);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-500)}.navbar__search-input{-webkit-appearance:none;-moz-appearance:none;appearance:none;background:var(--ifm-navbar-search-input-background-color) var(--ifm-navbar-search-input-icon) no-repeat .75rem center/1rem 1rem;border:none;border-radius:2rem;color:var(--ifm-navbar-search-input-color);cursor:text;display:inline-block;font-size:.9rem;height:2rem;padding:0 .5rem 0 2.25rem;width:12.5rem}.navbar__search-input::-moz-placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar__search-input::placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar-sidebar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-global-shadow-md);transform:translate3d(-100%,0,0);transition-property:opacity,visibility,transform;width:var(--ifm-navbar-sidebar-width)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar__items{transform:translateZ(0)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar--show .navbar-sidebar__backdrop{opacity:1;visibility:visible}.navbar-sidebar__backdrop{background-color:rgba(0,0,0,.6);right:0;transition-property:opacity,visibility}.navbar-sidebar__brand{align-items:center;box-shadow:var(--ifm-navbar-shadow);display:flex;flex:1;height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar-sidebar__items{display:flex;height:calc(100% - var(--ifm-navbar-height));transition:transform var(--ifm-transition-fast) ease-in-out}.navbar-sidebar__items--show-secondary{transform:translate3d(calc((var(--ifm-navbar-sidebar-width))*-1),0,0)}.navbar-sidebar__item{flex-shrink:0;padding:.5rem;width:calc(var(--ifm-navbar-sidebar-width))}.navbar-sidebar__back{background:var(--ifm-menu-color-background-active);font-size:15px;font-weight:var(--ifm-button-font-weight);margin:0 0 .2rem -.5rem;padding:.6rem 1.5rem;position:relative;text-align:left;top:-.5rem;width:calc(100% + 1rem)}.navbar-sidebar__close{display:flex;margin-left:auto}.pagination{-moz-column-gap:var(--ifm-pagination-page-spacing);column-gap:var(--ifm-pagination-page-spacing);display:flex;font-size:var(--ifm-pagination-font-size);padding-left:0}.pagination--sm{--ifm-pagination-font-size:0.8rem;--ifm-pagination-padding-horizontal:0.8rem;--ifm-pagination-padding-vertical:0.2rem}.pagination--lg{--ifm-pagination-font-size:1.2rem;--ifm-pagination-padding-horizontal:1.2rem;--ifm-pagination-padding-vertical:0.3rem}.pagination__item{display:inline-flex}.pagination__item>span{padding:var(--ifm-pagination-padding-vertical)}.pagination__item--active .pagination__link{color:var(--ifm-pagination-color-active)}.pagination__item--active .pagination__link,.pagination__item:not(.pagination__item--active):hover .pagination__link{background:var(--ifm-pagination-item-active-background)}.pagination__item--disabled,.pagination__item[disabled]{opacity:.25;pointer-events:none}.pagination__link{border-radius:var(--ifm-pagination-border-radius);color:var(--ifm-font-color-base);display:inline-block;padding:var(--ifm-pagination-padding-vertical) var(--ifm-pagination-padding-horizontal);transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination__link:hover{text-decoration:none}.pagination-nav{grid-gap:var(--ifm-spacing-horizontal);display:grid;gap:var(--ifm-spacing-horizontal);grid-template-columns:repeat(2,1fr)}.pagination-nav__link{border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-pagination-nav-border-radius);display:block;height:100%;line-height:var(--ifm-heading-line-height);padding:var(--ifm-global-spacing);transition:border-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination-nav__link:hover{border-color:var(--ifm-pagination-nav-color-hover);text-decoration:none}.pagination-nav__link--next{grid-column:2/3;text-align:right}.pagination-nav__label{font-size:var(--ifm-h4-font-size);font-weight:var(--ifm-heading-font-weight);word-break:break-word}.pagination-nav__link--prev .pagination-nav__label:before{content:"« "}.pagination-nav__link--next .pagination-nav__label:after{content:" »"}.pagination-nav__sublabel{color:var(--ifm-color-content-secondary);font-size:var(--ifm-h5-font-size);font-weight:var(--ifm-font-weight-semibold);margin-bottom:.25rem}.pills__item,.tabs{font-weight:var(--ifm-font-weight-bold)}.pills{display:flex;gap:var(--ifm-pills-spacing);padding-left:0}.pills__item{border-radius:.5rem;cursor:pointer;display:inline-block;padding:.25rem 1rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.tabs,:not(.containsTaskList_mC6p>li)>.containsTaskList_mC6p{padding-left:0}.pills__item--active{color:var(--ifm-pills-color-active)}.pills__item--active,.pills__item:not(.pills__item--active):hover{background:var(--ifm-pills-color-background-active)}.pills--block{justify-content:stretch}.pills--block .pills__item{flex-grow:1;text-align:center}.tabs{color:var(--ifm-tabs-color);display:flex;margin-bottom:0;overflow-x:auto}.tabs__item{border-bottom:3px solid transparent;border-radius:var(--ifm-global-radius);cursor:pointer;display:inline-flex;padding:var(--ifm-tabs-padding-vertical) var(--ifm-tabs-padding-horizontal);transition:background-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.tabs__item--active{border-bottom-color:var(--ifm-tabs-color-active-border);border-bottom-left-radius:0;border-bottom-right-radius:0;color:var(--ifm-tabs-color-active)}.tabs__item:hover{background-color:var(--ifm-hover-overlay)}.tabs--block{justify-content:stretch}.tabs--block .tabs__item{flex-grow:1;justify-content:center}html[data-theme=dark]{--ifm-color-scheme:dark;--ifm-color-emphasis-0:var(--ifm-color-gray-1000);--ifm-color-emphasis-100:var(--ifm-color-gray-900);--ifm-color-emphasis-200:var(--ifm-color-gray-800);--ifm-color-emphasis-300:var(--ifm-color-gray-700);--ifm-color-emphasis-400:var(--ifm-color-gray-600);--ifm-color-emphasis-600:var(--ifm-color-gray-400);--ifm-color-emphasis-700:var(--ifm-color-gray-300);--ifm-color-emphasis-800:var(--ifm-color-gray-200);--ifm-color-emphasis-900:var(--ifm-color-gray-100);--ifm-color-emphasis-1000:var(--ifm-color-gray-0);--ifm-background-color:#1b1b1d;--ifm-background-surface-color:#242526;--ifm-hover-overlay:hsla(0,0%,100%,.05);--ifm-color-content:#e3e3e3;--ifm-color-content-secondary:#fff;--ifm-breadcrumb-separator-filter:invert(64%) sepia(11%) saturate(0%) hue-rotate(149deg) brightness(99%) contrast(95%);--ifm-code-background:hsla(0,0%,100%,.1);--ifm-scrollbar-track-background-color:#444;--ifm-scrollbar-thumb-background-color:#686868;--ifm-scrollbar-thumb-hover-background-color:#7a7a7a;--ifm-table-stripe-background:hsla(0,0%,100%,.07);--ifm-toc-border-color:var(--ifm-color-emphasis-200);--ifm-color-primary-contrast-background:#102445;--ifm-color-primary-contrast-foreground:#ebf2fc;--ifm-color-secondary-contrast-background:#474748;--ifm-color-secondary-contrast-foreground:#fdfdfe;--ifm-color-success-contrast-background:#003100;--ifm-color-success-contrast-foreground:#e6f6e6;--ifm-color-info-contrast-background:#193c47;--ifm-color-info-contrast-foreground:#eef9fd;--ifm-color-warning-contrast-background:#4d3800;--ifm-color-warning-contrast-foreground:#fff8e6;--ifm-color-danger-contrast-background:#4b1113;--ifm-color-danger-contrast-foreground:#ffebec}:root{--docusaurus-progress-bar-color:var(--ifm-color-primary);--light-gray:#d3cbe1;--gray:#3a444e;--dark-gray:#202932;--black:#111718;--purple:#9d6bff;--dark-purple:#6528d7;--transparent-purple:rgba(157,107,255,.075);--ifm-color-primary:var(--purple);--ifm-color-content:#fff;--border-radius:1rem;--ifm-heading-font-family:"Sora";--ifm-font-family-base:"Plus Jakarta Sans";--ifm-color-content-secondary:var(--light-gray)!important;--ifm-hover-overlay:var(--transparent-purple)!important;--ifm-color-info-contrast-background:var(--transparent-purple)!important;--ifm-color-success-contrast-background:var(--transparent-purple)!important;--ifm-color-danger-contrast-background:var(--transparent-purple)!important;--ifm-color-warning-contrast-background:var(--transparent-purple)!important;--ifm-color-success-dark:var(--purple)!important;--ifm-color-info-dark:var(--purple)!important;--ifm-color-danger-dark:var(--purple)!important;--ifm-color-warning-dark:var(--purple)!important;--ifm-color-info-contrast-foreground:#fff!important;--ifm-color-success-contrast-foreground:#fff!important;--ifm-color-danger-contrast-foreground:#fff!important;--ifm-menu-link-sublist-icon-filter:invert();--ifm-code-background:#282a36;--ifm-scrollbar-thumb-background-color:var(--dark-purple)!important;--ifm-scrollbar-track-background-color:var(--dark-gray)!important;--ifm-background-color:#202932;--docusaurus-announcement-bar-height:auto;--docusaurus-tag-list-border:var(--ifm-color-emphasis-300);--docusaurus-collapse-button-bg:transparent;--docusaurus-collapse-button-bg-hover:rgba(0,0,0,.1);--doc-sidebar-width:300px;--doc-sidebar-hidden-width:30px}#nprogress .bar{background:var(--docusaurus-progress-bar-color);height:2px;left:0;position:fixed;top:0;width:100%;z-index:1031}#nprogress .peg,.layoutBackground_yBpP{height:100%;position:absolute;opacity:1}#nprogress .peg{box-shadow:0 0 10px var(--docusaurus-progress-bar-color),0 0 5px var(--docusaurus-progress-bar-color);right:0;transform:rotate(3deg) translateY(-4px);width:100px}h1{font-weight:300}#__docusaurus-base-url-issue-banner-container,.docSidebarContainer_b6E3,.footer,.navbar,.sidebarLogo_isFc,.themedImage_ToTc,[class="iconExternalLink_node_modules-@docusaurus-theme-classic-lib-theme-Icon-ExternalLink-styles-module"],[data-theme=dark] .lightToggleIcon_pyhR,[data-theme=light] .darkToggleIcon_wfgR,html[data-announcement-bar-initially-dismissed=true] .announcementBar_mb4j{display:none}.footer,.navbar,.navbar-sidebar__brand{background-color:var(--black)}.button{border-radius:var(--border-radius)}.button.button--secondary{fill:var(--ifm-color-primary);align-items:center;color:var(--ifm-color-primary);display:flex;font-weight:600;height:3.5rem;justify-content:center}.theme-doc-sidebar-container{border:none!important}.menu,.table-of-contents,article{background-color:var(--black);border-radius:var(--border-radius)}.menu{border-right:none;margin:0 1.3rem 0 0;padding-left:1rem!important}article{margin:1rem;min-height:90vh;padding:2rem}.table-of-contents__left-border{border-left:none}.table-of-contents{padding-left:1.3rem;top:2rem!important}.layoutBackgroundParent_KYvk{bottom:0;left:0;overflow:hidden;position:fixed;right:0;top:0;z-index:-1}.layoutBackground_yBpP{background-color:var(--dark-gray);width:100%;z-index:-1}.accentGradient_M8wD,.mainGradient_chAs{height:200%;overflow:hidden;width:200%;z-index:-1;position:absolute}@keyframes a{0%{bottom:-100%;right:-100%}40%{right:0}55%{bottom:0}85%{right:-100%}to{bottom:-100%}}.accentGradient_M8wD{animation:60s infinite a;background-color:var(--dark-gray);background:radial-gradient(circle,#6528d750 0,transparent 70%);bottom:-100%;right:-100%}@keyframes b{0%{left:-100%;top:-100%}40%{left:0}55%{top:0}85%{left:-100%}to{top:-100%}}.mainGradient_chAs{animation:60s infinite b;background-color:var(--dark-gray);background:radial-gradient(circle,#bcf12450 0,transparent 70%);left:-100%;top:-100%}.container_ZB_1{align-items:center;border-bottom:1px solid #848b93;display:flex;justify-content:space-between;padding:8px 24px;width:100%}.nav_vnZ4{display:flex;gap:48px}.nav_vnZ4 a{color:#fff;font-family:Plus Jakarta Sans;font-size:1rem;font-weight:600;line-height:1.57;text-decoration:none}.nav_vnZ4 a:hover{color:#bcf124}.nav_end_X4Ju{visibility:hidden}body:not(.navigation-with-keyboard) :not(input):focus{outline:0}.skipToContent_fXgn{background-color:var(--ifm-background-surface-color);color:var(--ifm-color-emphasis-900);left:100%;padding:calc(var(--ifm-global-spacing)/2) var(--ifm-global-spacing);position:fixed;top:1rem;z-index:calc(var(--ifm-z-index-fixed) + 1)}.skipToContent_fXgn:focus{box-shadow:var(--ifm-global-shadow-md);left:1rem}.closeButton_CVFx{line-height:0;padding:0}.content_knG7{font-size:85%;padding:5px 0;text-align:center}.content_knG7 a{color:inherit;text-decoration:underline}.announcementBar_mb4j{align-items:center;background-color:var(--ifm-color-white);border-bottom:1px solid var(--ifm-color-emphasis-100);color:var(--ifm-color-black);display:flex;height:var(--docusaurus-announcement-bar-height)}.announcementBarPlaceholder_vyr4{flex:0 0 10px}.announcementBarClose_gvF7{align-self:stretch;flex:0 0 30px}.toggle_vylO{height:2rem;width:2rem}.toggleButton_gllP{align-items:center;border-radius:50%;display:flex;height:100%;justify-content:center;transition:background var(--ifm-transition-fast);width:100%}.toggleButton_gllP:hover{background:var(--ifm-color-emphasis-200)}.toggleButtonDisabled_aARS{cursor:not-allowed}.darkNavbarColorModeToggle_X3D1:hover{background:var(--ifm-color-gray-800)}[data-theme=dark] .themedImage--dark_i4oU,[data-theme=light] .themedImage--light_HNdA,html:not([data-theme]) .themedComponent--light_NU7w{display:initial}.iconExternalLink_nPIU{margin-left:.3rem}.iconLanguage_nlXk{margin-right:5px;vertical-align:text-bottom}.navbarHideable_m1mJ{transition:transform var(--ifm-transition-fast) ease}.navbarHidden_jGov{transform:translate3d(0,calc(-100% - 2px),0)}.errorBoundaryError_a6uf{color:red;white-space:pre-wrap}.footerLogoLink_BH7S{opacity:.5;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.footerLogoLink_BH7S:hover,.hash-link:focus,:hover>.hash-link{opacity:1}.mainWrapper_z2l0{display:flex;flex:1 0 auto;flex-direction:column}.docusaurus-mt-lg{margin-top:3rem}#__docusaurus{display:flex;flex-direction:column;min-height:100%}.iconEdit_Z9Sw{margin-right:.3em;vertical-align:sub}.tag_zVej{border:1px solid var(--docusaurus-tag-list-border);transition:border var(--ifm-transition-fast)}.tag_zVej:hover{--docusaurus-tag-list-border:var(--ifm-link-color);text-decoration:none}.tagRegular_sFm0{border-radius:var(--ifm-global-radius);font-size:90%;padding:.2rem .5rem .3rem}.tagWithCount_h2kH{align-items:center;border-left:0;display:flex;padding:0 .5rem 0 1rem;position:relative}.tagWithCount_h2kH:after,.tagWithCount_h2kH:before{border:1px solid var(--docusaurus-tag-list-border);content:"";position:absolute;top:50%;transition:inherit}.tagWithCount_h2kH:before{border-bottom:0;border-right:0;height:1.18rem;right:100%;transform:translate(50%,-50%) rotate(-45deg);width:1.18rem}.tagWithCount_h2kH:after{border-radius:50%;height:.5rem;left:0;transform:translateY(-50%);width:.5rem}.tagWithCount_h2kH span{background:var(--ifm-color-secondary);border-radius:var(--ifm-global-radius);color:var(--ifm-color-black);font-size:.7rem;line-height:1.2;margin-left:.3rem;padding:.1rem .4rem}.tags_jXut{display:inline}.tag_QGVx{display:inline-block;margin:0 .4rem .5rem 0}.lastUpdated_vwxv{font-size:smaller;font-style:italic;margin-top:.2rem}.tocCollapsibleButton_TO0P{align-items:center;display:flex;font-size:inherit;justify-content:space-between;padding:.4rem .8rem;width:100%}.tocCollapsibleButton_TO0P:after{background:var(--ifm-menu-link-sublist-icon) 50% 50%/2rem 2rem no-repeat;content:"";filter:var(--ifm-menu-link-sublist-icon-filter);height:1.25rem;transform:rotate(180deg);transition:transform var(--ifm-transition-fast);width:1.25rem}.tocCollapsibleButtonExpanded_MG3E:after,.tocCollapsibleExpanded_sAul{transform:none}.tocCollapsible_ETCw{background-color:var(--ifm-menu-color-background-active);border-radius:var(--ifm-global-radius);margin:1rem 0}.tocCollapsibleContent_vkbj>ul{border-left:none;border-top:1px solid var(--ifm-color-emphasis-300);font-size:15px;padding:.2rem 0}.tocCollapsibleContent_vkbj ul li{margin:.4rem .8rem}.tocCollapsibleContent_vkbj a{display:block}.backToTopButton_sjWU{background-color:var(--ifm-color-emphasis-200);border-radius:50%;bottom:1.3rem;box-shadow:var(--ifm-global-shadow-lw);height:3rem;opacity:0;position:fixed;right:1.3rem;transform:scale(0);transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default);visibility:hidden;width:3rem;z-index:calc(var(--ifm-z-index-fixed) - 1)}.buttonGroup__atx button,.codeBlockContainer_Ckt0{background:var(--prism-background-color);color:var(--prism-color)}.backToTopButton_sjWU:after{background-color:var(--ifm-color-emphasis-1000);content:" ";display:inline-block;height:100%;-webkit-mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;width:100%}.backToTopButtonShow_xfvO{opacity:1;transform:scale(1);visibility:visible}[data-theme=dark]:root{--docusaurus-collapse-button-bg:hsla(0,0%,100%,.05);--docusaurus-collapse-button-bg-hover:hsla(0,0%,100%,.1)}.collapseSidebarButton_PEFL{display:none;margin:0}.docMainContainer_gTbr,.docPage__5DB{display:flex;width:100%}.docPage__5DB{flex:1 0}.docsWrapper_BCFX{display:flex;flex:1 0 auto}.codeBlockContainer_Ckt0{border-radius:var(--ifm-code-border-radius);box-shadow:var(--ifm-global-shadow-lw);margin-bottom:var(--ifm-leading)}.codeBlockContent_biex{border-radius:inherit;direction:ltr;position:relative}.codeBlockTitle_Ktv7{border-bottom:1px solid var(--ifm-color-emphasis-300);border-top-left-radius:inherit;border-top-right-radius:inherit;font-size:var(--ifm-code-font-size);font-weight:500;padding:.75rem var(--ifm-pre-padding)}.codeBlock_bY9V{--ifm-pre-background:var(--prism-background-color);margin:0;padding:0}.codeBlockTitle_Ktv7+.codeBlockContent_biex .codeBlock_bY9V{border-top-left-radius:0;border-top-right-radius:0}.codeBlockLines_e6Vv{float:left;font:inherit;min-width:100%;padding:var(--ifm-pre-padding)}.codeBlockLinesWithNumbering_o6Pm{display:table;padding:var(--ifm-pre-padding) 0}.buttonGroup__atx{-moz-column-gap:.2rem;column-gap:.2rem;display:flex;position:absolute;right:calc(var(--ifm-pre-padding)/2);top:calc(var(--ifm-pre-padding)/2)}.buttonGroup__atx button{align-items:center;border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-global-radius);display:flex;line-height:0;opacity:0;padding:.4rem;transition:opacity var(--ifm-transition-fast) ease-in-out}.buttonGroup__atx button:focus-visible,.buttonGroup__atx button:hover{opacity:1!important}.theme-code-block:hover .buttonGroup__atx button{opacity:.4}:where(:root){--docusaurus-highlighted-code-line-bg:#484d5b}:where([data-theme=dark]){--docusaurus-highlighted-code-line-bg:#646464}.theme-code-block-highlighted-line{background-color:var(--docusaurus-highlighted-code-line-bg);display:block;margin:0 calc(var(--ifm-pre-padding)*-1);padding:0 var(--ifm-pre-padding)}.codeLine_lJS_{counter-increment:a;display:table-row}.codeLineNumber_Tfdd{background:var(--ifm-pre-background);display:table-cell;left:0;overflow-wrap:normal;padding:0 var(--ifm-pre-padding);position:sticky;text-align:right;width:1%}.codeLineNumber_Tfdd:before{content:counter(a);opacity:.4}.codeLineContent_feaV{padding-right:var(--ifm-pre-padding)}.theme-code-block:hover .copyButtonCopied_obH4{opacity:1!important}.copyButtonIcons_eSgA{height:1.125rem;position:relative;width:1.125rem}.copyButtonIcon_y97N,.copyButtonSuccessIcon_LjdS{fill:currentColor;height:inherit;left:0;opacity:inherit;position:absolute;top:0;transition:all var(--ifm-transition-fast) ease;width:inherit}.copyButtonSuccessIcon_LjdS{color:#00d600;left:50%;opacity:0;top:50%;transform:translate(-50%,-50%) scale(.33)}.copyButtonCopied_obH4 .copyButtonIcon_y97N{opacity:0;transform:scale(.33)}.copyButtonCopied_obH4 .copyButtonSuccessIcon_LjdS{opacity:1;transform:translate(-50%,-50%) scale(1);transition-delay:75ms}.wordWrapButtonIcon_Bwma{height:1.2rem;width:1.2rem}.details_lb9f{--docusaurus-details-summary-arrow-size:0.38rem;--docusaurus-details-transition:transform 200ms ease;--docusaurus-details-decoration-color:grey}.details_lb9f>summary{cursor:pointer;padding-left:1rem;position:relative}.details_lb9f>summary::-webkit-details-marker{display:none}.details_lb9f>summary:before{border-color:transparent transparent transparent var(--docusaurus-details-decoration-color);border-style:solid;border-width:var(--docusaurus-details-summary-arrow-size);content:"";left:0;position:absolute;top:.45rem;transform:rotate(0);transform-origin:calc(var(--docusaurus-details-summary-arrow-size)/2) 50%;transition:var(--docusaurus-details-transition)}.collapsibleContent_i85q{border-top:1px solid var(--docusaurus-details-decoration-color);margin-top:1rem;padding-top:1rem}.details_b_Ee{--docusaurus-details-decoration-color:var(--ifm-alert-border-color);--docusaurus-details-transition:transform var(--ifm-transition-fast) ease;border:1px solid var(--ifm-alert-border-color);margin:0 0 var(--ifm-spacing-vertical)}.anchorWithStickyNavbar_LWe7{scroll-margin-top:calc(var(--ifm-navbar-height) + .5rem)}.anchorWithHideOnScrollNavbar_WYt5{scroll-margin-top:.5rem}.hash-link{opacity:0;padding-left:.5rem;transition:opacity var(--ifm-transition-fast);-webkit-user-select:none;-moz-user-select:none;user-select:none}.hash-link:before{content:"#"}.img_ev3q{height:auto}.tableOfContents_bqdL{max-height:calc(100vh - var(--ifm-navbar-height) - 2rem);overflow-y:auto;position:sticky;top:calc(var(--ifm-navbar-height) + 1rem)}.admonition_LlT9{margin-bottom:1em}.admonitionHeading_tbUL{font:var(--ifm-heading-font-weight) var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family);margin-bottom:.3rem}.admonitionHeading_tbUL code{text-transform:none}.admonitionIcon_kALy{display:inline-block;margin-right:.4em;vertical-align:middle}.admonitionIcon_kALy svg{fill:var(--ifm-alert-foreground-color);display:inline-block;height:1.6em;width:1.6em}.breadcrumbHomeIcon_YNFT{height:1.1rem;position:relative;top:1px;vertical-align:top;width:1.1rem}.breadcrumbsContainer_Z_bl{--ifm-breadcrumb-size-multiplier:0.8;margin-bottom:.8rem}.mdxPageWrapper_j9I6{justify-content:center}@media (min-width:997px){.collapseSidebarButton_PEFL,.expandButton_m80_{background-color:var(--docusaurus-collapse-button-bg)}:root{--docusaurus-announcement-bar-height:30px}.announcementBarClose_gvF7,.announcementBarPlaceholder_vyr4{flex-basis:50px}.searchBox_ZlJk{padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.lastUpdated_vwxv{text-align:right}.tocMobile_ITEo{display:none}.collapseSidebarButton_PEFL{border:1px solid var(--ifm-toc-border-color);border-radius:0;bottom:0;display:block!important;height:40px;position:sticky}.collapseSidebarButtonIcon_kv0_{margin-top:4px;transform:rotate(180deg)}.expandButtonIcon_BlDH,[dir=rtl] .collapseSidebarButtonIcon_kv0_{transform:rotate(0)}.collapseSidebarButton_PEFL:focus,.collapseSidebarButton_PEFL:hover,.expandButton_m80_:focus,.expandButton_m80_:hover{background-color:var(--docusaurus-collapse-button-bg-hover)}.menuHtmlItem_M9Kj{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu_SIkG{flex-grow:1;padding:.5rem}@supports (scrollbar-gutter:stable){.menu_SIkG{padding:.5rem 0 .5rem .5rem;scrollbar-gutter:stable}}.menuWithAnnouncementBar_GW3s{margin-bottom:var(--docusaurus-announcement-bar-height)}.sidebar_njMd{display:flex;flex-direction:column;height:100%;padding-top:var(--ifm-navbar-height);width:var(--doc-sidebar-width)}.sidebarWithHideableNavbar_wUlq{padding-top:0}.sidebarHidden_VK0M{opacity:0;visibility:hidden}.sidebarLogo_isFc{align-items:center;color:inherit!important;display:flex!important;margin:0 var(--ifm-navbar-padding-horizontal);max-height:var(--ifm-navbar-height);min-height:var(--ifm-navbar-height);text-decoration:none!important}.sidebarLogo_isFc img{height:2rem;margin-right:.5rem}.expandButton_m80_{align-items:center;display:flex;height:100%;justify-content:center;position:absolute;right:0;top:0;transition:background-color var(--ifm-transition-fast) ease;width:100%}[dir=rtl] .expandButtonIcon_BlDH{transform:rotate(180deg)}.docSidebarContainer_b6E3{border-right:1px solid var(--ifm-toc-border-color);-webkit-clip-path:inset(0);clip-path:inset(0);display:block;margin-top:calc(var(--ifm-navbar-height)*-1);transition:width var(--ifm-transition-fast) ease;width:var(--doc-sidebar-width);will-change:width}.docSidebarContainerHidden_b3ry{cursor:pointer;width:var(--doc-sidebar-hidden-width)}.sidebarViewport_Xe31{height:100%;max-height:100vh;position:sticky;top:0}.docMainContainer_gTbr{flex-grow:1;max-width:calc(100% - var(--doc-sidebar-width))}.docMainContainerEnhanced_Uz_u{max-width:calc(100% - var(--doc-sidebar-hidden-width))}.docItemWrapperEnhanced_czyv{max-width:calc(var(--ifm-container-width) + var(--doc-sidebar-width))!important}.docItemCol_VOVn{max-width:75%!important}}@media (min-width:1440px){.container{max-width:var(--ifm-container-width-xl)}}@media screen and (max-width:997px){.menu{border-radius:unset;box-shadow:none;margin:0}.footer--dark{padding-left:2rem}.table-of-contents__left-border{padding-left:1rem!important}.pagination-nav{margin:1rem}.navbar{display:unset}}@media (max-width:996px){.col{--ifm-col-width:100%;flex-basis:var(--ifm-col-width);margin-left:0}.footer{--ifm-footer-padding-horizontal:0}.colorModeToggle_DEke,.footer__link-separator,.navbar__item,.tableOfContents_bqdL{display:none}.footer__col{margin-bottom:calc(var(--ifm-spacing-vertical)*3)}.footer__link-item{display:block}.hero{padding-left:0;padding-right:0}.navbar>.container,.navbar>.container-fluid{padding:0}.navbar__toggle{display:inherit}.navbar__search-input{width:9rem}.pills--block,.tabs--block{flex-direction:column}.searchBox_ZlJk{position:absolute;right:var(--ifm-navbar-padding-horizontal)}.docItemContainer_F8PC{padding:0 .3rem}}@media only screen and (max-width:600px){.nav_end_X4Ju{display:none}.nav_vnZ4{display:flex;gap:24px}}@media (max-width:576px){.markdown h1:first-child{--ifm-h1-font-size:2rem}.markdown>h2{--ifm-h2-font-size:1.5rem}.markdown>h3{--ifm-h3-font-size:1.25rem}}@media (hover:hover){.backToTopButton_sjWU:hover{background-color:var(--ifm-color-emphasis-300)}}@media (pointer:fine){.thin-scrollbar{scrollbar-width:thin}.thin-scrollbar::-webkit-scrollbar{height:var(--ifm-scrollbar-size);width:var(--ifm-scrollbar-size)}.thin-scrollbar::-webkit-scrollbar-track{background:var(--ifm-scrollbar-track-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb{background:var(--ifm-scrollbar-thumb-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb:hover{background:var(--ifm-scrollbar-thumb-hover-background-color)}}@media (prefers-reduced-motion:reduce){:root{--ifm-transition-fast:0ms;--ifm-transition-slow:0ms}}@media print{.announcementBar_mb4j,.footer,.menu,.navbar,.pagination-nav,.table-of-contents,.tocMobile_ITEo{display:none}.tabs{page-break-inside:avoid}.codeBlockLines_e6Vv{white-space:pre-wrap}} \ No newline at end of file diff --git a/build/assets/css/styles.bab952e3.css b/build/assets/css/styles.bab952e3.css new file mode 100644 index 00000000..46794c73 --- /dev/null +++ b/build/assets/css/styles.bab952e3.css @@ -0,0 +1 @@ +@import url(https://fonts.googleapis.com/css2?family=Sora:wght@400;600&display=auto);.col,.container{padding:0 var(--ifm-spacing-horizontal);width:100%}.markdown>h2,.markdown>h3,.markdown>h4,.markdown>h5,.markdown>h6{margin-bottom:calc(var(--ifm-heading-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown li,body{word-wrap:break-word}body,ol ol,ol ul,ul ol,ul ul{margin:0}pre,table{overflow:auto}blockquote,pre{margin:0 0 var(--ifm-spacing-vertical)}.breadcrumbs__link,.button{transition-timing-function:var(--ifm-transition-timing-default)}.button,code{vertical-align:middle}.button--outline.button--active,.button--outline:active,.button--outline:hover,:root{--ifm-button-color:var(--ifm-font-color-base-inverse)}.menu__link:hover,a{transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.navbar--dark,:root{--ifm-navbar-link-hover-color:var(--ifm-color-primary)}.menu,.navbar-sidebar{overflow-x:hidden}:root,html[data-theme=dark]{--ifm-color-emphasis-500:var(--ifm-color-gray-500)}.toggleButton_gllP,html{-webkit-tap-highlight-color:transparent}.clean-list,.containsTaskList_mC6p,.details_lb9f>summary,.dropdown__menu,.menu__list{list-style:none}:root{--ifm-color-scheme:light;--ifm-dark-value:10%;--ifm-darker-value:15%;--ifm-darkest-value:30%;--ifm-light-value:15%;--ifm-lighter-value:30%;--ifm-lightest-value:50%;--ifm-contrast-background-value:90%;--ifm-contrast-foreground-value:70%;--ifm-contrast-background-dark-value:70%;--ifm-contrast-foreground-dark-value:90%;--ifm-color-primary:#3578e5;--ifm-color-secondary:#ebedf0;--ifm-color-success:#00a400;--ifm-color-info:#54c7ec;--ifm-color-warning:#ffba00;--ifm-color-danger:#fa383e;--ifm-color-primary-dark:#306cce;--ifm-color-primary-darker:#2d66c3;--ifm-color-primary-darkest:#2554a0;--ifm-color-primary-light:#538ce9;--ifm-color-primary-lighter:#72a1ed;--ifm-color-primary-lightest:#9abcf2;--ifm-color-primary-contrast-background:#ebf2fc;--ifm-color-primary-contrast-foreground:#102445;--ifm-color-secondary-dark:#d4d5d8;--ifm-color-secondary-darker:#c8c9cc;--ifm-color-secondary-darkest:#a4a6a8;--ifm-color-secondary-light:#eef0f2;--ifm-color-secondary-lighter:#f1f2f5;--ifm-color-secondary-lightest:#f5f6f8;--ifm-color-secondary-contrast-background:#fdfdfe;--ifm-color-secondary-contrast-foreground:#474748;--ifm-color-success-dark:#009400;--ifm-color-success-darker:#008b00;--ifm-color-success-darkest:#007300;--ifm-color-success-light:#26b226;--ifm-color-success-lighter:#4dbf4d;--ifm-color-success-lightest:#80d280;--ifm-color-success-contrast-background:#e6f6e6;--ifm-color-success-contrast-foreground:#003100;--ifm-color-info-dark:#4cb3d4;--ifm-color-info-darker:#47a9c9;--ifm-color-info-darkest:#3b8ba5;--ifm-color-info-light:#6ecfef;--ifm-color-info-lighter:#87d8f2;--ifm-color-info-lightest:#aae3f6;--ifm-color-info-contrast-background:#eef9fd;--ifm-color-info-contrast-foreground:#193c47;--ifm-color-warning-dark:#e6a700;--ifm-color-warning-darker:#d99e00;--ifm-color-warning-darkest:#b38200;--ifm-color-warning-light:#ffc426;--ifm-color-warning-lighter:#ffcf4d;--ifm-color-warning-lightest:#ffdd80;--ifm-color-warning-contrast-background:#fff8e6;--ifm-color-warning-contrast-foreground:#4d3800;--ifm-color-danger-dark:#e13238;--ifm-color-danger-darker:#d53035;--ifm-color-danger-darkest:#af272b;--ifm-color-danger-light:#fb565b;--ifm-color-danger-lighter:#fb7478;--ifm-color-danger-lightest:#fd9c9f;--ifm-color-danger-contrast-background:#ffebec;--ifm-color-danger-contrast-foreground:#4b1113;--ifm-color-white:#fff;--ifm-color-black:#000;--ifm-color-gray-0:var(--ifm-color-white);--ifm-color-gray-100:#f5f6f7;--ifm-color-gray-200:#ebedf0;--ifm-color-gray-300:#dadde1;--ifm-color-gray-400:#ccd0d5;--ifm-color-gray-500:#bec3c9;--ifm-color-gray-600:#8d949e;--ifm-color-gray-700:#606770;--ifm-color-gray-800:#444950;--ifm-color-gray-900:#1c1e21;--ifm-color-gray-1000:var(--ifm-color-black);--ifm-color-emphasis-0:var(--ifm-color-gray-0);--ifm-color-emphasis-100:var(--ifm-color-gray-100);--ifm-color-emphasis-200:var(--ifm-color-gray-200);--ifm-color-emphasis-300:var(--ifm-color-gray-300);--ifm-color-emphasis-400:var(--ifm-color-gray-400);--ifm-color-emphasis-600:var(--ifm-color-gray-600);--ifm-color-emphasis-700:var(--ifm-color-gray-700);--ifm-color-emphasis-800:var(--ifm-color-gray-800);--ifm-color-emphasis-900:var(--ifm-color-gray-900);--ifm-color-emphasis-1000:var(--ifm-color-gray-1000);--ifm-color-content:var(--ifm-color-emphasis-900);--ifm-color-content-inverse:var(--ifm-color-emphasis-0);--ifm-color-content-secondary:#525860;--ifm-background-color:transparent;--ifm-background-surface-color:var(--ifm-color-content-inverse);--ifm-global-border-width:1px;--ifm-global-radius:0.4rem;--ifm-hover-overlay:rgba(0,0,0,.05);--ifm-font-color-base:var(--ifm-color-content);--ifm-font-color-base-inverse:var(--ifm-color-content-inverse);--ifm-font-color-secondary:var(--ifm-color-content-secondary);--ifm-font-family-base:system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";--ifm-font-family-monospace:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;--ifm-font-size-base:100%;--ifm-font-weight-light:300;--ifm-font-weight-normal:400;--ifm-font-weight-semibold:500;--ifm-font-weight-bold:700;--ifm-font-weight-base:var(--ifm-font-weight-normal);--ifm-line-height-base:1.65;--ifm-global-spacing:1rem;--ifm-spacing-vertical:var(--ifm-global-spacing);--ifm-spacing-horizontal:var(--ifm-global-spacing);--ifm-transition-fast:200ms;--ifm-transition-slow:400ms;--ifm-transition-timing-default:cubic-bezier(0.08,0.52,0.52,1);--ifm-global-shadow-lw:0 1px 2px 0 rgba(0,0,0,.1);--ifm-global-shadow-md:0 5px 40px rgba(0,0,0,.2);--ifm-global-shadow-tl:0 12px 28px 0 rgba(0,0,0,.2),0 2px 4px 0 rgba(0,0,0,.1);--ifm-z-index-dropdown:100;--ifm-z-index-fixed:200;--ifm-z-index-overlay:400;--ifm-container-width:1140px;--ifm-container-width-xl:1320px;--ifm-code-background:#f6f7f8;--ifm-code-border-radius:var(--ifm-global-radius);--ifm-code-font-size:90%;--ifm-code-padding-horizontal:0.1rem;--ifm-code-padding-vertical:0.1rem;--ifm-pre-background:var(--ifm-code-background);--ifm-pre-border-radius:var(--ifm-code-border-radius);--ifm-pre-color:inherit;--ifm-pre-line-height:1.45;--ifm-pre-padding:1rem;--ifm-heading-color:inherit;--ifm-heading-margin-top:0;--ifm-heading-margin-bottom:var(--ifm-spacing-vertical);--ifm-heading-font-family:var(--ifm-font-family-base);--ifm-heading-font-weight:var(--ifm-font-weight-bold);--ifm-heading-line-height:1.25;--ifm-h1-font-size:2rem;--ifm-h2-font-size:1.5rem;--ifm-h3-font-size:1.25rem;--ifm-h4-font-size:1rem;--ifm-h5-font-size:0.875rem;--ifm-h6-font-size:0.85rem;--ifm-image-alignment-padding:1.25rem;--ifm-leading-desktop:1.25;--ifm-leading:calc(var(--ifm-leading-desktop)*1rem);--ifm-list-left-padding:2rem;--ifm-list-margin:1rem;--ifm-list-item-margin:0.25rem;--ifm-list-paragraph-margin:1rem;--ifm-table-cell-padding:0.75rem;--ifm-table-background:transparent;--ifm-table-stripe-background:rgba(0,0,0,.03);--ifm-table-border-width:1px;--ifm-table-border-color:var(--ifm-color-emphasis-300);--ifm-table-head-background:inherit;--ifm-table-head-color:inherit;--ifm-table-head-font-weight:var(--ifm-font-weight-bold);--ifm-table-cell-color:inherit;--ifm-link-color:var(--ifm-color-primary);--ifm-link-decoration:none;--ifm-link-hover-color:var(--ifm-link-color);--ifm-link-hover-decoration:underline;--ifm-paragraph-margin-bottom:var(--ifm-leading);--ifm-blockquote-font-size:var(--ifm-font-size-base);--ifm-blockquote-border-left-width:2px;--ifm-blockquote-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-blockquote-padding-vertical:0;--ifm-blockquote-shadow:none;--ifm-blockquote-color:var(--ifm-color-emphasis-800);--ifm-blockquote-border-color:var(--ifm-color-emphasis-300);--ifm-hr-background-color:var(--ifm-color-emphasis-500);--ifm-hr-height:1px;--ifm-hr-margin-vertical:1.5rem;--ifm-scrollbar-size:7px;--ifm-scrollbar-track-background-color:#f1f1f1;--ifm-scrollbar-thumb-background-color:silver;--ifm-scrollbar-thumb-hover-background-color:#a7a7a7;--ifm-alert-background-color:inherit;--ifm-alert-border-color:inherit;--ifm-alert-border-radius:var(--ifm-global-radius);--ifm-alert-border-width:0px;--ifm-alert-border-left-width:5px;--ifm-alert-color:var(--ifm-font-color-base);--ifm-alert-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-alert-padding-vertical:var(--ifm-spacing-vertical);--ifm-alert-shadow:var(--ifm-global-shadow-lw);--ifm-avatar-intro-margin:1rem;--ifm-avatar-intro-alignment:inherit;--ifm-avatar-photo-size:3rem;--ifm-badge-background-color:inherit;--ifm-badge-border-color:inherit;--ifm-badge-border-radius:var(--ifm-global-radius);--ifm-badge-border-width:var(--ifm-global-border-width);--ifm-badge-color:var(--ifm-color-white);--ifm-badge-padding-horizontal:calc(var(--ifm-spacing-horizontal)*0.5);--ifm-badge-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-breadcrumb-border-radius:1.5rem;--ifm-breadcrumb-spacing:0.5rem;--ifm-breadcrumb-color-active:var(--ifm-color-primary);--ifm-breadcrumb-item-background-active:var(--ifm-hover-overlay);--ifm-breadcrumb-padding-horizontal:0.8rem;--ifm-breadcrumb-padding-vertical:0.4rem;--ifm-breadcrumb-size-multiplier:1;--ifm-breadcrumb-separator:url('data:image/svg+xml;utf8,');--ifm-breadcrumb-separator-filter:none;--ifm-breadcrumb-separator-size:0.5rem;--ifm-breadcrumb-separator-size-multiplier:1.25;--ifm-button-background-color:inherit;--ifm-button-border-color:var(--ifm-button-background-color);--ifm-button-border-width:var(--ifm-global-border-width);--ifm-button-font-weight:var(--ifm-font-weight-bold);--ifm-button-padding-horizontal:1.5rem;--ifm-button-padding-vertical:0.375rem;--ifm-button-size-multiplier:1;--ifm-button-transition-duration:var(--ifm-transition-fast);--ifm-button-border-radius:calc(var(--ifm-global-radius)*var(--ifm-button-size-multiplier));--ifm-button-group-spacing:2px;--ifm-card-background-color:var(--ifm-background-surface-color);--ifm-card-border-radius:calc(var(--ifm-global-radius)*2);--ifm-card-horizontal-spacing:var(--ifm-global-spacing);--ifm-card-vertical-spacing:var(--ifm-global-spacing);--ifm-toc-border-color:var(--ifm-color-emphasis-300);--ifm-toc-link-color:var(--ifm-color-content-secondary);--ifm-toc-padding-vertical:0.5rem;--ifm-toc-padding-horizontal:0.5rem;--ifm-dropdown-background-color:var(--ifm-background-surface-color);--ifm-dropdown-font-weight:var(--ifm-font-weight-semibold);--ifm-dropdown-link-color:var(--ifm-font-color-base);--ifm-dropdown-hover-background-color:var(--ifm-hover-overlay);--ifm-footer-background-color:var(--ifm-color-emphasis-100);--ifm-footer-color:inherit;--ifm-footer-link-color:var(--ifm-color-emphasis-700);--ifm-footer-link-hover-color:var(--ifm-color-primary);--ifm-footer-link-horizontal-spacing:0.5rem;--ifm-footer-padding-horizontal:calc(var(--ifm-spacing-horizontal)*2);--ifm-footer-padding-vertical:calc(var(--ifm-spacing-vertical)*2);--ifm-footer-title-color:inherit;--ifm-footer-logo-max-width:min(30rem,90vw);--ifm-hero-background-color:var(--ifm-background-surface-color);--ifm-hero-text-color:var(--ifm-color-emphasis-800);--ifm-menu-color:var(--ifm-color-emphasis-700);--ifm-menu-color-active:var(--ifm-color-primary);--ifm-menu-color-background-active:var(--ifm-hover-overlay);--ifm-menu-color-background-hover:var(--ifm-hover-overlay);--ifm-menu-link-padding-horizontal:0.75rem;--ifm-menu-link-padding-vertical:0.375rem;--ifm-menu-link-sublist-icon:url('data:image/svg+xml;utf8,');--ifm-menu-link-sublist-icon-filter:none;--ifm-navbar-background-color:var(--ifm-background-surface-color);--ifm-navbar-height:3.75rem;--ifm-navbar-item-padding-horizontal:0.75rem;--ifm-navbar-item-padding-vertical:0.25rem;--ifm-navbar-link-color:var(--ifm-font-color-base);--ifm-navbar-link-active-color:var(--ifm-link-color);--ifm-navbar-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-navbar-padding-vertical:calc(var(--ifm-spacing-vertical)*0.5);--ifm-navbar-shadow:var(--ifm-global-shadow-lw);--ifm-navbar-search-input-background-color:var(--ifm-color-emphasis-200);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-800);--ifm-navbar-search-input-placeholder-color:var(--ifm-color-emphasis-500);--ifm-navbar-search-input-icon:url('data:image/svg+xml;utf8,');--ifm-navbar-sidebar-width:83vw;--ifm-pagination-border-radius:var(--ifm-global-radius);--ifm-pagination-color-active:var(--ifm-color-primary);--ifm-pagination-font-size:1rem;--ifm-pagination-item-active-background:var(--ifm-hover-overlay);--ifm-pagination-page-spacing:0.2em;--ifm-pagination-padding-horizontal:calc(var(--ifm-spacing-horizontal)*1);--ifm-pagination-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-pagination-nav-border-radius:var(--ifm-global-radius);--ifm-pagination-nav-color-hover:var(--ifm-color-primary);--ifm-pills-color-active:var(--ifm-color-primary);--ifm-pills-color-background-active:var(--ifm-hover-overlay);--ifm-pills-spacing:0.125rem;--ifm-tabs-color:var(--ifm-font-color-secondary);--ifm-tabs-color-active:var(--ifm-color-primary);--ifm-tabs-color-active-border:var(--ifm-tabs-color-active);--ifm-tabs-padding-horizontal:1rem;--ifm-tabs-padding-vertical:1rem;--docusaurus-progress-bar-color:var(--ifm-color-primary);--light-gray:#d3cbe1;--dark-gray:#202932;--ifm-color-primary:#bcf124;--ifm-color-content:#fff;--ifm-heading-font-family:"Sora";--docusaurus-announcement-bar-height:auto;--docusaurus-tag-list-border:var(--ifm-color-emphasis-300);--docusaurus-collapse-button-bg:transparent;--docusaurus-collapse-button-bg-hover:rgba(0,0,0,.1);--doc-sidebar-width:300px;--doc-sidebar-hidden-width:30px}.badge--danger,.badge--info,.badge--primary,.badge--secondary,.badge--success,.badge--warning{--ifm-badge-border-color:var(--ifm-badge-background-color)}.button--link,.button--outline{--ifm-button-background-color:transparent}*{box-sizing:border-box}html{-webkit-font-smoothing:antialiased;-webkit-text-size-adjust:100%;-moz-text-size-adjust:100%;text-size-adjust:100%;background-color:var(--ifm-background-color);color:var(--ifm-font-color-base);color-scheme:var(--ifm-color-scheme);font:var(--ifm-font-size-base)/var(--ifm-line-height-base) var(--ifm-font-family-base);text-rendering:optimizelegibility}iframe{border:0;color-scheme:auto;height:25rem;margin:1rem;width:calc(100% - 2rem)}.container{margin:0 auto;max-width:var(--ifm-container-width)}.container--fluid{max-width:inherit}.row{display:flex;flex-wrap:wrap;margin:0 calc(var(--ifm-spacing-horizontal)*-1)}.margin-bottom--none,.margin-vert--none,.markdown>:last-child{margin-bottom:0!important}.margin-top--none,.margin-vert--none{margin-top:0!important}.row--no-gutters{margin-left:0;margin-right:0}.margin-horiz--none,.margin-right--none{margin-right:0!important}.row--no-gutters>.col{padding-left:0;padding-right:0}.row--align-top{align-items:flex-start}.row--align-bottom{align-items:flex-end}.menuExternalLink_NmtK,.row--align-center{align-items:center}.row--align-stretch{align-items:stretch}.row--align-baseline{align-items:baseline}.col{--ifm-col-width:100%;flex:1 0;margin-left:0;max-width:var(--ifm-col-width)}.padding-bottom--none,.padding-vert--none{padding-bottom:0!important}.padding-top--none,.padding-vert--none{padding-top:0!important}.padding-horiz--none,.padding-left--none{padding-left:0!important}.padding-horiz--none,.padding-right--none{padding-right:0!important}.col[class*=col--]{flex:0 0 var(--ifm-col-width)}.col--1{--ifm-col-width:8.33333%}.col--offset-1{margin-left:8.33333%}.col--2{--ifm-col-width:16.66667%}.col--offset-2{margin-left:16.66667%}.col--3{--ifm-col-width:25%}.col--offset-3{margin-left:25%}.col--4{--ifm-col-width:33.33333%}.col--offset-4{margin-left:33.33333%}.col--5{--ifm-col-width:41.66667%}.col--offset-5{margin-left:41.66667%}.col--6{--ifm-col-width:50%}.col--offset-6{margin-left:50%}.col--7{--ifm-col-width:58.33333%}.col--offset-7{margin-left:58.33333%}.col--8{--ifm-col-width:66.66667%}.col--offset-8{margin-left:66.66667%}.col--9{--ifm-col-width:75%}.col--offset-9{margin-left:75%}.col--10{--ifm-col-width:83.33333%}.col--offset-10{margin-left:83.33333%}.col--11{--ifm-col-width:91.66667%}.col--offset-11{margin-left:91.66667%}.col--12{--ifm-col-width:100%}.col--offset-12{margin-left:100%}.margin-horiz--none,.margin-left--none{margin-left:0!important}.margin--none{margin:0!important}.margin-bottom--xs,.margin-vert--xs{margin-bottom:.25rem!important}.margin-top--xs,.margin-vert--xs{margin-top:.25rem!important}.margin-horiz--xs,.margin-left--xs{margin-left:.25rem!important}.margin-horiz--xs,.margin-right--xs{margin-right:.25rem!important}.margin--xs{margin:.25rem!important}.margin-bottom--sm,.margin-vert--sm{margin-bottom:.5rem!important}.margin-top--sm,.margin-vert--sm{margin-top:.5rem!important}.margin-horiz--sm,.margin-left--sm{margin-left:.5rem!important}.margin-horiz--sm,.margin-right--sm{margin-right:.5rem!important}.margin--sm{margin:.5rem!important}.margin-bottom--md,.margin-vert--md{margin-bottom:1rem!important}.margin-top--md,.margin-vert--md{margin-top:1rem!important}.margin-horiz--md,.margin-left--md{margin-left:1rem!important}.margin-horiz--md,.margin-right--md{margin-right:1rem!important}.margin--md{margin:1rem!important}.margin-bottom--lg,.margin-vert--lg{margin-bottom:2rem!important}.margin-top--lg,.margin-vert--lg{margin-top:2rem!important}.margin-horiz--lg,.margin-left--lg{margin-left:2rem!important}.margin-horiz--lg,.margin-right--lg{margin-right:2rem!important}.margin--lg{margin:2rem!important}.margin-bottom--xl,.margin-vert--xl{margin-bottom:5rem!important}.margin-top--xl,.margin-vert--xl{margin-top:5rem!important}.margin-horiz--xl,.margin-left--xl{margin-left:5rem!important}.margin-horiz--xl,.margin-right--xl{margin-right:5rem!important}.margin--xl{margin:5rem!important}.padding--none{padding:0!important}.padding-bottom--xs,.padding-vert--xs{padding-bottom:.25rem!important}.padding-top--xs,.padding-vert--xs{padding-top:.25rem!important}.padding-horiz--xs,.padding-left--xs{padding-left:.25rem!important}.padding-horiz--xs,.padding-right--xs{padding-right:.25rem!important}.padding--xs{padding:.25rem!important}.padding-bottom--sm,.padding-vert--sm{padding-bottom:.5rem!important}.padding-top--sm,.padding-vert--sm{padding-top:.5rem!important}.padding-horiz--sm,.padding-left--sm{padding-left:.5rem!important}.padding-horiz--sm,.padding-right--sm{padding-right:.5rem!important}.padding--sm{padding:.5rem!important}.padding-bottom--md,.padding-vert--md{padding-bottom:1rem!important}.padding-top--md,.padding-vert--md{padding-top:1rem!important}.padding-horiz--md,.padding-left--md{padding-left:1rem!important}.padding-horiz--md,.padding-right--md{padding-right:1rem!important}.padding--md{padding:1rem!important}.padding-bottom--lg,.padding-vert--lg{padding-bottom:2rem!important}.padding-top--lg,.padding-vert--lg{padding-top:2rem!important}.padding-horiz--lg,.padding-left--lg{padding-left:2rem!important}.padding-horiz--lg,.padding-right--lg{padding-right:2rem!important}.padding--lg{padding:2rem!important}.padding-bottom--xl,.padding-vert--xl{padding-bottom:5rem!important}.padding-top--xl,.padding-vert--xl{padding-top:5rem!important}.padding-horiz--xl,.padding-left--xl{padding-left:5rem!important}.padding-horiz--xl,.padding-right--xl{padding-right:5rem!important}.padding--xl{padding:5rem!important}code{background-color:var(--ifm-code-background);border:.1rem solid rgba(0,0,0,.1);border-radius:var(--ifm-code-border-radius);font-family:var(--ifm-font-family-monospace);font-size:var(--ifm-code-font-size);padding:var(--ifm-code-padding-vertical) var(--ifm-code-padding-horizontal)}a code{color:inherit}pre{background-color:var(--ifm-pre-background);border-radius:var(--ifm-pre-border-radius);color:var(--ifm-pre-color);font:var(--ifm-code-font-size)/var(--ifm-pre-line-height) var(--ifm-font-family-monospace);padding:var(--ifm-pre-padding)}pre code{background-color:transparent;border:none;font-size:100%;line-height:inherit;padding:0}kbd{background-color:var(--ifm-color-emphasis-0);border:1px solid var(--ifm-color-emphasis-400);border-radius:.2rem;box-shadow:inset 0 -1px 0 var(--ifm-color-emphasis-400);color:var(--ifm-color-emphasis-800);font:80% var(--ifm-font-family-monospace);padding:.15rem .3rem}h1,h2,h3,h4,h5,h6{color:var(--ifm-heading-color);font-family:var(--ifm-heading-font-family);font-weight:var(--ifm-heading-font-weight);line-height:var(--ifm-heading-line-height);margin:var(--ifm-heading-margin-top) 0 var(--ifm-heading-margin-bottom) 0}h1{font-size:var(--ifm-h1-font-size)}h2{font-size:var(--ifm-h2-font-size)}h3{font-size:var(--ifm-h3-font-size)}h4{font-size:var(--ifm-h4-font-size)}h5{font-size:var(--ifm-h5-font-size)}h6{font-size:var(--ifm-h6-font-size)}img{max-width:100%}img[align=right]{padding-left:var(--image-alignment-padding)}img[align=left]{padding-right:var(--image-alignment-padding)}.markdown{--ifm-h1-vertical-rhythm-top:3;--ifm-h2-vertical-rhythm-top:2;--ifm-h3-vertical-rhythm-top:1.5;--ifm-heading-vertical-rhythm-top:1.25;--ifm-h1-vertical-rhythm-bottom:1.25;--ifm-heading-vertical-rhythm-bottom:1}.markdown:after,.markdown:before{content:"";display:table}.markdown:after{clear:both}.markdown h1:first-child{--ifm-h1-font-size:3rem;margin-bottom:calc(var(--ifm-h1-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown>h2{--ifm-h2-font-size:2rem;margin-top:calc(var(--ifm-h2-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h3{--ifm-h3-font-size:1.5rem;margin-top:calc(var(--ifm-h3-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h4,.markdown>h5,.markdown>h6{margin-top:calc(var(--ifm-heading-vertical-rhythm-top)*var(--ifm-leading))}.markdown>p,.markdown>pre,.markdown>ul{margin-bottom:var(--ifm-leading)}.markdown li>p{margin-top:var(--ifm-list-paragraph-margin)}.markdown li+li{margin-top:var(--ifm-list-item-margin)}ol,ul{margin:0 0 var(--ifm-list-margin);padding-left:var(--ifm-list-left-padding)}ol ol,ul ol{list-style-type:lower-roman}ol ol ol,ol ul ol,ul ol ol,ul ul ol{list-style-type:lower-alpha}table{border-collapse:collapse;display:block;margin-bottom:var(--ifm-spacing-vertical)}table thead tr{border-bottom:2px solid var(--ifm-table-border-color)}table thead,table tr:nth-child(2n){background-color:var(--ifm-table-stripe-background)}table tr{background-color:var(--ifm-table-background);border-top:var(--ifm-table-border-width) solid var(--ifm-table-border-color)}table td,table th{border:var(--ifm-table-border-width) solid var(--ifm-table-border-color);padding:var(--ifm-table-cell-padding)}table th{background-color:var(--ifm-table-head-background);color:var(--ifm-table-head-color);font-weight:var(--ifm-table-head-font-weight)}table td{color:var(--ifm-table-cell-color)}strong{font-weight:var(--ifm-font-weight-bold);color:#fff}a{color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}a:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button:hover,.text--no-decoration,.text--no-decoration:hover,a:not([href]){text-decoration:none}p{margin:0 0 var(--ifm-paragraph-margin-bottom)}blockquote{border-left:var(--ifm-blockquote-border-left-width) solid var(--ifm-blockquote-border-color);box-shadow:var(--ifm-blockquote-shadow);color:var(--ifm-blockquote-color);font-size:var(--ifm-blockquote-font-size);padding:var(--ifm-blockquote-padding-vertical) var(--ifm-blockquote-padding-horizontal)}blockquote>:first-child{margin-top:0}blockquote>:last-child{margin-bottom:0}hr{background-color:var(--ifm-hr-background-color);border:0;height:var(--ifm-hr-height);margin:var(--ifm-hr-margin-vertical) 0}.shadow--lw{box-shadow:var(--ifm-global-shadow-lw)!important}.shadow--md{box-shadow:var(--ifm-global-shadow-md)!important}.shadow--tl{box-shadow:var(--ifm-global-shadow-tl)!important}.text--primary,.wordWrapButtonEnabled_EoeP .wordWrapButtonIcon_Bwma{color:var(--ifm-color-primary)}.text--secondary{color:var(--ifm-color-secondary)}.text--success{color:var(--ifm-color-success)}.text--info{color:var(--ifm-color-info)}.text--warning{color:var(--ifm-color-warning)}.text--danger{color:var(--ifm-color-danger)}.text--center{text-align:center}.text--left{text-align:left}.text--justify{text-align:justify}.text--right{text-align:right}.text--capitalize{text-transform:capitalize}.text--lowercase{text-transform:lowercase}.admonitionHeading_tbUL,.alert__heading,.text--uppercase{text-transform:uppercase}.text--light{font-weight:var(--ifm-font-weight-light)}.text--normal{font-weight:var(--ifm-font-weight-normal)}.text--semibold{font-weight:var(--ifm-font-weight-semibold)}.text--bold{font-weight:var(--ifm-font-weight-bold)}.text--italic{font-style:italic}.text--truncate{overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.text--break{word-wrap:break-word!important;word-break:break-word!important}.clean-btn{background:none;border:none;color:inherit;cursor:pointer;font-family:inherit;padding:0}.alert,.alert .close{color:var(--ifm-alert-foreground-color)}.clean-list{padding-left:0}.alert--primary{--ifm-alert-background-color:var(--ifm-color-primary-contrast-background);--ifm-alert-background-color-highlight:rgba(53,120,229,.15);--ifm-alert-foreground-color:var(--ifm-color-primary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-primary-dark)}.alert--secondary{--ifm-alert-background-color:var(--ifm-color-secondary-contrast-background);--ifm-alert-background-color-highlight:rgba(235,237,240,.15);--ifm-alert-foreground-color:var(--ifm-color-secondary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-secondary-dark)}.alert--success{--ifm-alert-background-color:var(--ifm-color-success-contrast-background);--ifm-alert-background-color-highlight:rgba(0,164,0,.15);--ifm-alert-foreground-color:var(--ifm-color-success-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-success-dark)}.alert--info{--ifm-alert-background-color:var(--ifm-color-info-contrast-background);--ifm-alert-background-color-highlight:rgba(84,199,236,.15);--ifm-alert-foreground-color:var(--ifm-color-info-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-info-dark)}.alert--warning{--ifm-alert-background-color:var(--ifm-color-warning-contrast-background);--ifm-alert-background-color-highlight:rgba(255,186,0,.15);--ifm-alert-foreground-color:var(--ifm-color-warning-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-warning-dark)}.alert--danger{--ifm-alert-background-color:var(--ifm-color-danger-contrast-background);--ifm-alert-background-color-highlight:rgba(250,56,62,.15);--ifm-alert-foreground-color:var(--ifm-color-danger-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-danger-dark)}.alert{--ifm-code-background:var(--ifm-alert-background-color-highlight);--ifm-link-color:var(--ifm-alert-foreground-color);--ifm-link-hover-color:var(--ifm-alert-foreground-color);--ifm-link-decoration:underline;--ifm-tabs-color:var(--ifm-alert-foreground-color);--ifm-tabs-color-active:var(--ifm-alert-foreground-color);--ifm-tabs-color-active-border:var(--ifm-alert-border-color);background-color:var(--ifm-alert-background-color);border:var(--ifm-alert-border-width) solid var(--ifm-alert-border-color);border-left-width:var(--ifm-alert-border-left-width);border-radius:var(--ifm-alert-border-radius);box-shadow:var(--ifm-alert-shadow);padding:var(--ifm-alert-padding-vertical) var(--ifm-alert-padding-horizontal)}.alert__heading{align-items:center;display:flex;font:700 var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family);margin-bottom:.5rem}.alert__icon{display:inline-flex;margin-right:.4em}.alert__icon svg{fill:var(--ifm-alert-foreground-color);stroke:var(--ifm-alert-foreground-color);stroke-width:0}.alert .close{margin:calc(var(--ifm-alert-padding-vertical)*-1) calc(var(--ifm-alert-padding-horizontal)*-1) 0 0;opacity:.75}.alert .close:focus,.alert .close:hover{opacity:1}.alert a{text-decoration-color:var(--ifm-alert-border-color)}.alert a:hover{text-decoration-thickness:2px}.avatar{-moz-column-gap:var(--ifm-avatar-intro-margin);column-gap:var(--ifm-avatar-intro-margin);display:flex}.avatar__photo{border-radius:50%;display:block;height:var(--ifm-avatar-photo-size);overflow:hidden;width:var(--ifm-avatar-photo-size)}.card--full-height,.navbar__logo img,body,html{height:100%}.avatar__photo--sm{--ifm-avatar-photo-size:2rem}.avatar__photo--lg{--ifm-avatar-photo-size:4rem}.avatar__photo--xl{--ifm-avatar-photo-size:6rem}.avatar__intro{display:flex;flex:1 1;flex-direction:column;justify-content:center;text-align:var(--ifm-avatar-intro-alignment)}.badge,.breadcrumbs__item,.breadcrumbs__link,.button,.dropdown>.navbar__link:after{display:inline-block}.avatar__name{font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base)}.avatar__subtitle{margin-top:.25rem}.avatar--vertical{--ifm-avatar-intro-alignment:center;--ifm-avatar-intro-margin:0.5rem;align-items:center;flex-direction:column}.badge{background-color:var(--ifm-badge-background-color);border:var(--ifm-badge-border-width) solid var(--ifm-badge-border-color);border-radius:var(--ifm-badge-border-radius);color:var(--ifm-badge-color);font-size:75%;font-weight:var(--ifm-font-weight-bold);line-height:1;padding:var(--ifm-badge-padding-vertical) var(--ifm-badge-padding-horizontal)}.badge--primary{--ifm-badge-background-color:var(--ifm-color-primary)}.badge--secondary{--ifm-badge-background-color:var(--ifm-color-secondary);color:var(--ifm-color-black)}.breadcrumbs__link,.button.button--secondary.button--outline:not(.button--active):not(:hover){color:var(--ifm-font-color-base)}.badge--success{--ifm-badge-background-color:var(--ifm-color-success)}.badge--info{--ifm-badge-background-color:var(--ifm-color-info)}.badge--warning{--ifm-badge-background-color:var(--ifm-color-warning)}.badge--danger{--ifm-badge-background-color:var(--ifm-color-danger)}.breadcrumbs{margin-bottom:0;padding-left:0}.breadcrumbs__item:not(:last-child):after{background:var(--ifm-breadcrumb-separator) center;content:" ";display:inline-block;filter:var(--ifm-breadcrumb-separator-filter);height:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier));margin:0 var(--ifm-breadcrumb-spacing);opacity:.5;width:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier))}.breadcrumbs__item--active .breadcrumbs__link{background:var(--ifm-breadcrumb-item-background-active);color:var(--ifm-breadcrumb-color-active)}.breadcrumbs__link{border-radius:var(--ifm-breadcrumb-border-radius);font-size:calc(1rem*var(--ifm-breadcrumb-size-multiplier));padding:calc(var(--ifm-breadcrumb-padding-vertical)*var(--ifm-breadcrumb-size-multiplier)) calc(var(--ifm-breadcrumb-padding-horizontal)*var(--ifm-breadcrumb-size-multiplier));transition-duration:var(--ifm-transition-fast);transition-property:background,color}.breadcrumbs__link:link:hover,.breadcrumbs__link:visited:hover,area[href].breadcrumbs__link:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs__link:-moz-any-link:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs__link:any-link:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs--sm{--ifm-breadcrumb-size-multiplier:0.8}.breadcrumbs--lg{--ifm-breadcrumb-size-multiplier:1.2}.button{background-color:var(--ifm-button-background-color);border:var(--ifm-button-border-width) solid var(--ifm-button-border-color);border-radius:var(--ifm-button-border-radius);cursor:pointer;font-size:calc(.875rem*var(--ifm-button-size-multiplier));font-weight:var(--ifm-button-font-weight);line-height:1.5;padding:calc(var(--ifm-button-padding-vertical)*var(--ifm-button-size-multiplier)) calc(var(--ifm-button-padding-horizontal)*var(--ifm-button-size-multiplier));text-align:center;transition-duration:var(--ifm-button-transition-duration);transition-property:color,background,border-color;-webkit-user-select:none;-moz-user-select:none;user-select:none;white-space:nowrap}.button,.button:hover{color:var(--ifm-button-color)}.button--outline{--ifm-button-color:var(--ifm-button-border-color)}.button--outline:hover{--ifm-button-background-color:var(--ifm-button-border-color)}.button--link{--ifm-button-border-color:transparent;color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}.button--link.button--active,.button--link:active,.button--link:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button.disabled,.button:disabled,.button[disabled]{opacity:.65;pointer-events:none}.button--sm{--ifm-button-size-multiplier:0.8}.button--lg{--ifm-button-size-multiplier:1.35}.button--block{display:block;width:100%}.button.button--secondary{color:var(--ifm-color-gray-900)}:where(.button--primary){--ifm-button-background-color:var(--ifm-color-primary);--ifm-button-border-color:var(--ifm-color-primary)}:where(.button--primary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-primary-dark);--ifm-button-border-color:var(--ifm-color-primary-dark)}.button--primary.button--active,.button--primary:active{--ifm-button-background-color:var(--ifm-color-primary-darker);--ifm-button-border-color:var(--ifm-color-primary-darker)}:where(.button--secondary){--ifm-button-background-color:var(--ifm-color-secondary);--ifm-button-border-color:var(--ifm-color-secondary)}:where(.button--secondary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-secondary-dark);--ifm-button-border-color:var(--ifm-color-secondary-dark)}.button--secondary.button--active,.button--secondary:active{--ifm-button-background-color:var(--ifm-color-secondary-darker);--ifm-button-border-color:var(--ifm-color-secondary-darker)}:where(.button--success){--ifm-button-background-color:var(--ifm-color-success);--ifm-button-border-color:var(--ifm-color-success)}:where(.button--success):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-success-dark);--ifm-button-border-color:var(--ifm-color-success-dark)}.button--success.button--active,.button--success:active{--ifm-button-background-color:var(--ifm-color-success-darker);--ifm-button-border-color:var(--ifm-color-success-darker)}:where(.button--info){--ifm-button-background-color:var(--ifm-color-info);--ifm-button-border-color:var(--ifm-color-info)}:where(.button--info):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-info-dark);--ifm-button-border-color:var(--ifm-color-info-dark)}.button--info.button--active,.button--info:active{--ifm-button-background-color:var(--ifm-color-info-darker);--ifm-button-border-color:var(--ifm-color-info-darker)}:where(.button--warning){--ifm-button-background-color:var(--ifm-color-warning);--ifm-button-border-color:var(--ifm-color-warning)}:where(.button--warning):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-warning-dark);--ifm-button-border-color:var(--ifm-color-warning-dark)}.button--warning.button--active,.button--warning:active{--ifm-button-background-color:var(--ifm-color-warning-darker);--ifm-button-border-color:var(--ifm-color-warning-darker)}:where(.button--danger){--ifm-button-background-color:var(--ifm-color-danger);--ifm-button-border-color:var(--ifm-color-danger)}:where(.button--danger):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-danger-dark);--ifm-button-border-color:var(--ifm-color-danger-dark)}.button--danger.button--active,.button--danger:active{--ifm-button-background-color:var(--ifm-color-danger-darker);--ifm-button-border-color:var(--ifm-color-danger-darker)}.button-group{display:inline-flex;gap:var(--ifm-button-group-spacing)}.button-group>.button:not(:first-child){border-bottom-left-radius:0;border-top-left-radius:0}.button-group>.button:not(:last-child){border-bottom-right-radius:0;border-top-right-radius:0}.button-group--block{display:flex;justify-content:stretch}.button-group--block>.button{flex-grow:1}.card{background-color:var(--ifm-card-background-color);border-radius:var(--ifm-card-border-radius);box-shadow:var(--ifm-global-shadow-lw);display:flex;flex-direction:column;overflow:hidden}.card__image{padding-top:var(--ifm-card-vertical-spacing)}.card__image:first-child{padding-top:0}.card__body,.card__footer,.card__header{padding:var(--ifm-card-vertical-spacing) var(--ifm-card-horizontal-spacing)}.card__body:not(:last-child),.card__footer:not(:last-child),.card__header:not(:last-child){padding-bottom:0}.card__body>:last-child,.card__footer>:last-child,.card__header>:last-child{margin-bottom:0}.card__footer{margin-top:auto}.table-of-contents{font-size:.8rem;margin-bottom:0;padding:var(--ifm-toc-padding-vertical) 0}.table-of-contents,.table-of-contents ul{list-style:none;padding-left:var(--ifm-toc-padding-horizontal)}.table-of-contents li{margin:var(--ifm-toc-padding-vertical) var(--ifm-toc-padding-horizontal)}.table-of-contents__left-border{border-left:1px solid var(--ifm-toc-border-color)}.table-of-contents__link{color:var(--ifm-toc-link-color);display:block}.table-of-contents__link--active,.table-of-contents__link--active code,.table-of-contents__link:hover,.table-of-contents__link:hover code{color:var(--ifm-color-primary);text-decoration:none}.close{color:var(--ifm-color-black);float:right;font-size:1.5rem;font-weight:var(--ifm-font-weight-bold);line-height:1;opacity:.5;padding:1rem;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.close:hover{opacity:.7}.close:focus,.theme-code-block-highlighted-line .codeLineNumber_Tfdd:before{opacity:.8}.dropdown{display:inline-flex;font-weight:var(--ifm-dropdown-font-weight);position:relative;vertical-align:top}.dropdown--hoverable:hover .dropdown__menu,.dropdown--show .dropdown__menu{opacity:1;pointer-events:all;transform:translateY(-1px);visibility:visible}#nprogress,.dropdown__menu,.navbar__item.dropdown .navbar__link:not([href]){pointer-events:none}.dropdown--right .dropdown__menu{left:inherit;right:0}.dropdown--nocaret .navbar__link:after{content:none!important}.dropdown__menu{background-color:var(--ifm-dropdown-background-color);border-radius:var(--ifm-global-radius);box-shadow:var(--ifm-global-shadow-md);left:0;max-height:80vh;min-width:10rem;opacity:0;overflow-y:auto;padding:.5rem;position:absolute;top:calc(100% - var(--ifm-navbar-item-padding-vertical) + .3rem);transform:translateY(-.625rem);transition-duration:var(--ifm-transition-fast);transition-property:opacity,transform,visibility;transition-timing-function:var(--ifm-transition-timing-default);visibility:hidden;z-index:var(--ifm-z-index-dropdown)}.menu__caret,.menu__link,.menu__list-item-collapsible{border-radius:.25rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.dropdown__link{border-radius:.25rem;color:var(--ifm-dropdown-link-color);display:block;font-size:.875rem;margin-top:.2rem;padding:.25rem .5rem;white-space:nowrap}.dropdown__link--active,.dropdown__link:hover{background-color:var(--ifm-dropdown-hover-background-color);color:var(--ifm-dropdown-link-color);text-decoration:none}.dropdown__link--active,.dropdown__link--active:hover{--ifm-dropdown-link-color:var(--ifm-link-color)}.dropdown>.navbar__link:after{border-color:currentcolor transparent;border-style:solid;border-width:.4em .4em 0;content:"";margin-left:.3em;position:relative;top:2px;transform:translateY(-50%)}.footer{background-color:var(--ifm-footer-background-color);color:var(--ifm-footer-color);padding:var(--ifm-footer-padding-vertical) var(--ifm-footer-padding-horizontal)}.footer--dark{--ifm-footer-background-color:#303846;--ifm-footer-color:var(--ifm-footer-link-color);--ifm-footer-link-color:var(--ifm-color-secondary);--ifm-footer-title-color:var(--ifm-color-white)}.footer__links{margin-bottom:1rem}.footer__link-item{color:var(--ifm-footer-link-color);line-height:2}.footer__link-item:hover{color:var(--ifm-footer-link-hover-color)}.footer__link-separator{margin:0 var(--ifm-footer-link-horizontal-spacing)}.footer__logo{margin-top:1rem;max-width:var(--ifm-footer-logo-max-width)}.footer__title{color:var(--ifm-footer-title-color);font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base);margin-bottom:var(--ifm-heading-margin-bottom)}.menu,.navbar__link{font-weight:var(--ifm-font-weight-semibold)}.docItemContainer_Djhp article>:first-child,.docItemContainer_Djhp header+*,.footer__item{margin-top:0}.admonitionContent_S0QG>:last-child,.collapsibleContent_i85q>:last-child,.footer__items{margin-bottom:0}.codeBlockStandalone_MEMb,[type=checkbox]{padding:0}.hero{align-items:center;background-color:var(--ifm-hero-background-color);color:var(--ifm-hero-text-color);display:flex;padding:4rem 2rem}.hero--primary{--ifm-hero-background-color:var(--ifm-color-primary);--ifm-hero-text-color:var(--ifm-font-color-base-inverse)}.hero--dark{--ifm-hero-background-color:#303846;--ifm-hero-text-color:var(--ifm-color-white)}.hero__title{font-size:3rem}.hero__subtitle{font-size:1.5rem}.menu__list{margin:0;padding-left:0}.menu__caret,.menu__link{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu__list .menu__list{flex:0 0 100%;margin-top:.25rem;padding-left:var(--ifm-menu-link-padding-horizontal)}.menu__list-item:not(:first-child){margin-top:.25rem}.menu__list-item--collapsed .menu__list{height:0;overflow:hidden}.details_lb9f[data-collapsed=false].isBrowser_bmU9>summary:before,.details_lb9f[open]:not(.isBrowser_bmU9)>summary:before,.menu__list-item--collapsed .menu__caret:before,.menu__list-item--collapsed .menu__link--sublist:after{transform:rotate(90deg)}.menu__list-item-collapsible{display:flex;flex-wrap:wrap;position:relative}.menu__caret:hover,.menu__link:hover,.menu__list-item-collapsible--active,.menu__list-item-collapsible:hover{background:var(--ifm-menu-color-background-hover)}.menu__list-item-collapsible .menu__link--active,.menu__list-item-collapsible .menu__link:hover{background:none!important}.menu__caret,.menu__link{align-items:center;display:flex}.menu__link{color:var(--ifm-menu-color);flex:1;line-height:1.25}.menu__link:hover{color:var(--ifm-menu-color);text-decoration:none}.menu__caret:before,.menu__link--sublist-caret:after{height:1.25rem;transform:rotate(180deg);transition:transform var(--ifm-transition-fast) linear;width:1.25rem;filter:var(--ifm-menu-link-sublist-icon-filter);content:""}.menu__link--sublist-caret:after{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem;margin-left:auto;min-width:1.25rem}.menu__link--active,.menu__link--active:hover{color:var(--ifm-menu-color-active)}.navbar__brand,.navbar__link{color:var(--ifm-navbar-link-color)}.menu__link--active:not(.menu__link--sublist){background-color:var(--ifm-menu-color-background-active)}.menu__caret:before{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem}.navbar--dark,html[data-theme=dark]{--ifm-menu-link-sublist-icon-filter:invert(100%) sepia(94%) saturate(17%) hue-rotate(223deg) brightness(104%) contrast(98%)}.navbar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-navbar-shadow);height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar,.navbar>.container,.navbar>.container-fluid{display:flex}.navbar--fixed-top{position:sticky;top:0;z-index:var(--ifm-z-index-fixed)}.navbar-sidebar,.navbar-sidebar__backdrop{bottom:0;opacity:0;position:fixed;transition-duration:var(--ifm-transition-fast);transition-timing-function:ease-in-out;left:0;top:0;visibility:hidden}.navbar__inner{display:flex;flex-wrap:wrap;justify-content:space-between;width:100%}.navbar__brand{align-items:center;display:flex;margin-right:1rem;min-width:0}.navbar__brand:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.announcementBarContent_xLdY,.navbar__title{flex:1 1 auto}.navbar__toggle{display:none;margin-right:.5rem}.navbar__logo{flex:0 0 auto;height:2rem;margin-right:.5rem}.navbar__items{align-items:center;display:flex;flex:1;min-width:0}.navbar__items--center{flex:0 0 auto}.navbar__items--center .navbar__brand{margin:0}.navbar__items--center+.navbar__items--right{flex:1}.navbar__items--right{flex:0 0 auto;justify-content:flex-end}.navbar__items--right>:last-child{padding-right:0}.navbar__item{display:inline-block;padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.navbar__link--active,.navbar__link:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.navbar--dark,.navbar--primary{--ifm-menu-color:var(--ifm-color-gray-300);--ifm-navbar-link-color:var(--ifm-color-gray-100);--ifm-navbar-search-input-background-color:hsla(0,0%,100%,.1);--ifm-navbar-search-input-placeholder-color:hsla(0,0%,100%,.5);color:var(--ifm-color-white)}.navbar--dark{--ifm-navbar-background-color:#242526;--ifm-menu-color-background-active:hsla(0,0%,100%,.05);--ifm-navbar-search-input-color:var(--ifm-color-white)}.navbar--primary{--ifm-navbar-background-color:var(--ifm-color-primary);--ifm-navbar-link-hover-color:var(--ifm-color-white);--ifm-menu-color-active:var(--ifm-color-white);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-500)}.navbar__search-input{-webkit-appearance:none;-moz-appearance:none;appearance:none;background:var(--ifm-navbar-search-input-background-color) var(--ifm-navbar-search-input-icon) no-repeat .75rem center/1rem 1rem;border:none;border-radius:2rem;color:var(--ifm-navbar-search-input-color);cursor:text;display:inline-block;font-size:.9rem;height:2rem;padding:0 .5rem 0 2.25rem;width:12.5rem}.navbar__search-input::-moz-placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar__search-input::placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar-sidebar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-global-shadow-md);transform:translate3d(-100%,0,0);transition-property:opacity,visibility,transform;width:var(--ifm-navbar-sidebar-width)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar__items{transform:translateZ(0)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar--show .navbar-sidebar__backdrop{opacity:1;visibility:visible}.navbar-sidebar__backdrop{background-color:rgba(0,0,0,.6);right:0;transition-property:opacity,visibility}.navbar-sidebar__brand{align-items:center;box-shadow:var(--ifm-navbar-shadow);display:flex;flex:1;height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar-sidebar__items{display:flex;height:calc(100% - var(--ifm-navbar-height));transition:transform var(--ifm-transition-fast) ease-in-out}.navbar-sidebar__items--show-secondary{transform:translate3d(calc((var(--ifm-navbar-sidebar-width))*-1),0,0)}.navbar-sidebar__item{flex-shrink:0;padding:.5rem;width:calc(var(--ifm-navbar-sidebar-width))}.navbar-sidebar__back{background:var(--ifm-menu-color-background-active);font-size:15px;font-weight:var(--ifm-button-font-weight);margin:0 0 .2rem -.5rem;padding:.6rem 1.5rem;position:relative;text-align:left;top:-.5rem;width:calc(100% + 1rem)}.accentGradient_xnKm,.mainGradient_BHIB{width:200%;height:200%;position:absolute}.navbar-sidebar__close{display:flex;margin-left:auto}.pagination{-moz-column-gap:var(--ifm-pagination-page-spacing);column-gap:var(--ifm-pagination-page-spacing);display:flex;font-size:var(--ifm-pagination-font-size);padding-left:0}.pagination--sm{--ifm-pagination-font-size:0.8rem;--ifm-pagination-padding-horizontal:0.8rem;--ifm-pagination-padding-vertical:0.2rem}.pagination--lg{--ifm-pagination-font-size:1.2rem;--ifm-pagination-padding-horizontal:1.2rem;--ifm-pagination-padding-vertical:0.3rem}.pagination__item{display:inline-flex}.pagination__item>span{padding:var(--ifm-pagination-padding-vertical)}.pagination__item--active .pagination__link{color:var(--ifm-pagination-color-active)}.pagination__item--active .pagination__link,.pagination__item:not(.pagination__item--active):hover .pagination__link{background:var(--ifm-pagination-item-active-background)}.pagination__item--disabled,.pagination__item[disabled]{opacity:.25;pointer-events:none}.pagination__link{border-radius:var(--ifm-pagination-border-radius);color:var(--ifm-font-color-base);display:inline-block;padding:var(--ifm-pagination-padding-vertical) var(--ifm-pagination-padding-horizontal);transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination__link:hover{text-decoration:none}.pagination-nav{grid-gap:var(--ifm-spacing-horizontal);display:grid;gap:var(--ifm-spacing-horizontal);grid-template-columns:repeat(2,1fr)}.pagination-nav__link{border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-pagination-nav-border-radius);display:block;height:100%;line-height:var(--ifm-heading-line-height);padding:var(--ifm-global-spacing);transition:border-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination-nav__link:hover{border-color:var(--ifm-pagination-nav-color-hover);text-decoration:none}.pagination-nav__link--next{grid-column:2/3;text-align:right}.pagination-nav__label{font-size:var(--ifm-h4-font-size);font-weight:var(--ifm-heading-font-weight);word-break:break-word}.pagination-nav__link--prev .pagination-nav__label:before{content:"« "}.pagination-nav__link--next .pagination-nav__label:after{content:" »"}.pagination-nav__sublabel{color:var(--ifm-color-content-secondary);font-size:var(--ifm-h5-font-size);font-weight:var(--ifm-font-weight-semibold);margin-bottom:.25rem}.pills__item,.tabs{font-weight:var(--ifm-font-weight-bold)}.pills{display:flex;gap:var(--ifm-pills-spacing);padding-left:0}.pills__item{border-radius:.5rem;cursor:pointer;display:inline-block;padding:.25rem 1rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.tabs,:not(.containsTaskList_mC6p>li)>.containsTaskList_mC6p{padding-left:0}.pills__item--active{color:var(--ifm-pills-color-active)}.pills__item--active,.pills__item:not(.pills__item--active):hover{background:var(--ifm-pills-color-background-active)}.pills--block{justify-content:stretch}.pills--block .pills__item{flex-grow:1;text-align:center}.tabs{color:var(--ifm-tabs-color);display:flex;margin-bottom:0;overflow-x:auto}.tabs__item{border-bottom:3px solid transparent;border-radius:var(--ifm-global-radius);cursor:pointer;display:inline-flex;padding:var(--ifm-tabs-padding-vertical) var(--ifm-tabs-padding-horizontal);transition:background-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.tabs__item--active{border-bottom-color:var(--ifm-tabs-color-active-border);border-bottom-left-radius:0;border-bottom-right-radius:0;color:var(--ifm-tabs-color-active)}.tabs__item:hover{background-color:var(--ifm-hover-overlay)}.tabs--block{justify-content:stretch}.tabs--block .tabs__item{flex-grow:1;justify-content:center}html[data-theme=dark]{--ifm-color-scheme:dark;--ifm-color-emphasis-0:var(--ifm-color-gray-1000);--ifm-color-emphasis-100:var(--ifm-color-gray-900);--ifm-color-emphasis-200:var(--ifm-color-gray-800);--ifm-color-emphasis-300:var(--ifm-color-gray-700);--ifm-color-emphasis-400:var(--ifm-color-gray-600);--ifm-color-emphasis-600:var(--ifm-color-gray-400);--ifm-color-emphasis-700:var(--ifm-color-gray-300);--ifm-color-emphasis-800:var(--ifm-color-gray-200);--ifm-color-emphasis-900:var(--ifm-color-gray-100);--ifm-color-emphasis-1000:var(--ifm-color-gray-0);--ifm-background-color:#1b1b1d;--ifm-background-surface-color:#242526;--ifm-hover-overlay:hsla(0,0%,100%,.05);--ifm-color-content:#e3e3e3;--ifm-color-content-secondary:#fff;--ifm-breadcrumb-separator-filter:invert(64%) sepia(11%) saturate(0%) hue-rotate(149deg) brightness(99%) contrast(95%);--ifm-code-background:hsla(0,0%,100%,.1);--ifm-scrollbar-track-background-color:#444;--ifm-scrollbar-thumb-background-color:#686868;--ifm-scrollbar-thumb-hover-background-color:#7a7a7a;--ifm-table-stripe-background:hsla(0,0%,100%,.07);--ifm-toc-border-color:var(--ifm-color-emphasis-200);--ifm-color-primary-contrast-background:#102445;--ifm-color-primary-contrast-foreground:#ebf2fc;--ifm-color-secondary-contrast-background:#474748;--ifm-color-secondary-contrast-foreground:#fdfdfe;--ifm-color-success-contrast-background:#003100;--ifm-color-success-contrast-foreground:#e6f6e6;--ifm-color-info-contrast-background:#193c47;--ifm-color-info-contrast-foreground:#eef9fd;--ifm-color-warning-contrast-background:#4d3800;--ifm-color-warning-contrast-foreground:#fff8e6;--ifm-color-danger-contrast-background:#4b1113;--ifm-color-danger-contrast-foreground:#ffebec}#nprogress .bar{background:var(--docusaurus-progress-bar-color);height:2px;left:0;position:fixed;top:0;width:100%;z-index:1031}#nprogress .peg{box-shadow:0 0 10px var(--docusaurus-progress-bar-color),0 0 5px var(--docusaurus-progress-bar-color);height:100%;opacity:1;position:absolute;right:0;transform:rotate(3deg) translateY(-4px);width:100px}h1{font-weight:300}}.prism-code{border:1px solid hsla(0,0%,100%,.1)}.gradientBackground_W6vG{background-color:var(--dark-gray);inset:0;opacity:.35;overflow:hidden;position:fixed;z-index:-1}@keyframes a{0%{bottom:-100%;right:-100%}40%{right:0}55%{bottom:0}85%{right:-100%}to{bottom:-100%}}.accentGradient_xnKm{animation:60s infinite a;background-color:var(--dark-gray);background:radial-gradient(circle,#6528d750 0,transparent 70%);bottom:-100%;right:-100%}@keyframes b{0%{left:-100%;top:-100%}40%{left:0}55%{top:0}85%{left:-100%}to{top:-100%}}.mainGradient_BHIB{animation:60s infinite b;background-color:var(--dark-gray);background:radial-gradient(circle,#bcf12450 0,transparent 70%);left:-100%;top:-100%}body:not(.navigation-with-keyboard) :not(input):focus{outline:0}#__docusaurus-base-url-issue-banner-container,.themedImage_ToTc,[data-theme=dark] .lightToggleIcon_pyhR,[data-theme=light] .darkToggleIcon_wfgR,html[data-announcement-bar-initially-dismissed=true] .announcementBar_mb4j{display:none}.skipToContent_fXgn{background-color:var(--ifm-background-surface-color);color:var(--ifm-color-emphasis-900);left:100%;padding:calc(var(--ifm-global-spacing)/2) var(--ifm-global-spacing);position:fixed;top:1rem;z-index:calc(var(--ifm-z-index-fixed) + 1)}.skipToContent_fXgn:focus{box-shadow:var(--ifm-global-shadow-md);left:1rem}.closeButton_CVFx{line-height:0;padding:0}.content_knG7{font-size:85%;padding:5px 0;text-align:center}.content_knG7 a{color:inherit;text-decoration:underline}.announcementBar_mb4j{align-items:center;background-color:var(--ifm-color-white);border-bottom:1px solid var(--ifm-color-emphasis-100);color:var(--ifm-color-black);display:flex;height:var(--docusaurus-announcement-bar-height)}.announcementBarPlaceholder_vyr4{flex:0 0 10px}.announcementBarClose_gvF7{align-self:stretch;flex:0 0 30px}.toggle_vylO{height:2rem;width:2rem}.toggleButton_gllP{align-items:center;border-radius:50%;display:flex;height:100%;justify-content:center;transition:background var(--ifm-transition-fast);width:100%}.toggleButton_gllP:hover{background:var(--ifm-color-emphasis-200)}.toggleButtonDisabled_aARS{cursor:not-allowed}.darkNavbarColorModeToggle_X3D1:hover{background:var(--ifm-color-gray-800)}[data-theme=dark] .themedImage--dark_i4oU,[data-theme=light] .themedImage--light_HNdA,html:not([data-theme]) .themedComponent--light_NU7w{display:initial}.iconExternalLink_nPIU{margin-left:.3rem}.iconLanguage_nlXk{margin-right:5px;vertical-align:text-bottom}.navbarHideable_m1mJ{transition:transform var(--ifm-transition-fast) ease}.navbarHidden_jGov{transform:translate3d(0,calc(-100% - 2px),0)}.errorBoundaryError_a6uf{color:red;white-space:pre-wrap}.footerLogoLink_BH7S{opacity:.5;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.footerLogoLink_BH7S:hover,.hash-link:focus,:hover>.hash-link{opacity:1}.mainWrapper_z2l0{display:flex;flex:1 0 auto;flex-direction:column}.docusaurus-mt-lg{margin-top:3rem}#__docusaurus{display:flex;flex-direction:column;min-height:100%}.iconEdit_Z9Sw{margin-right:.3em;vertical-align:sub}.tag_zVej{border:1px solid var(--docusaurus-tag-list-border);transition:border var(--ifm-transition-fast)}.tag_zVej:hover{--docusaurus-tag-list-border:var(--ifm-link-color);text-decoration:none}.tagRegular_sFm0{border-radius:var(--ifm-global-radius);font-size:90%;padding:.2rem .5rem .3rem}.tagWithCount_h2kH{align-items:center;border-left:0;display:flex;padding:0 .5rem 0 1rem;position:relative}.tagWithCount_h2kH:after,.tagWithCount_h2kH:before{border:1px solid var(--docusaurus-tag-list-border);content:"";position:absolute;top:50%;transition:inherit}.tagWithCount_h2kH:before{border-bottom:0;border-right:0;height:1.18rem;right:100%;transform:translate(50%,-50%) rotate(-45deg);width:1.18rem}.tagWithCount_h2kH:after{border-radius:50%;height:.5rem;left:0;transform:translateY(-50%);width:.5rem}.tagWithCount_h2kH span{background:var(--ifm-color-secondary);border-radius:var(--ifm-global-radius);color:var(--ifm-color-black);font-size:.7rem;line-height:1.2;margin-left:.3rem;padding:.1rem .4rem}.tags_jXut{display:inline}.tag_QGVx{display:inline-block;margin:0 .4rem .5rem 0}.lastUpdated_vwxv{font-size:smaller;font-style:italic;margin-top:.2rem}.tocCollapsibleButton_TO0P{align-items:center;display:flex;font-size:inherit;justify-content:space-between;padding:.4rem .8rem;width:100%}.tocCollapsibleButton_TO0P:after{background:var(--ifm-menu-link-sublist-icon) 50% 50%/2rem 2rem no-repeat;content:"";filter:var(--ifm-menu-link-sublist-icon-filter);height:1.25rem;transform:rotate(180deg);transition:transform var(--ifm-transition-fast);width:1.25rem}.tocCollapsibleButtonExpanded_MG3E:after,.tocCollapsibleExpanded_sAul{transform:none}.tocCollapsible_ETCw{background-color:var(--ifm-menu-color-background-active);border-radius:var(--ifm-global-radius);margin:1rem 0}.buttonGroup__atx button,.codeBlockContainer_Ckt0{background:var(--prism-background-color);color:var(--prism-color)}.tocCollapsibleContent_vkbj>ul{border-left:none;border-top:1px solid var(--ifm-color-emphasis-300);font-size:15px;padding:.2rem 0}.tocCollapsibleContent_vkbj ul li{margin:.4rem .8rem}.tocCollapsibleContent_vkbj a{display:block}.tableOfContents_bqdL{max-height:calc(100vh - var(--ifm-navbar-height) - 2rem);overflow-y:auto;position:sticky;top:calc(var(--ifm-navbar-height) + 1rem)}.anchorWithStickyNavbar_LWe7{scroll-margin-top:calc(var(--ifm-navbar-height) + .5rem)}.anchorWithHideOnScrollNavbar_WYt5{scroll-margin-top:.5rem}.hash-link{opacity:0;padding-left:.5rem;transition:opacity var(--ifm-transition-fast);-webkit-user-select:none;-moz-user-select:none;user-select:none}.hash-link:before{content:"#"}.codeBlockContainer_Ckt0{border-radius:var(--ifm-code-border-radius);box-shadow:var(--ifm-global-shadow-lw);margin-bottom:var(--ifm-leading)}.codeBlockContent_biex{border-radius:inherit;direction:ltr;position:relative}.codeBlockTitle_Ktv7{border-bottom:1px solid var(--ifm-color-emphasis-300);border-top-left-radius:inherit;border-top-right-radius:inherit;font-size:var(--ifm-code-font-size);font-weight:500;padding:.75rem var(--ifm-pre-padding)}.codeBlock_bY9V{--ifm-pre-background:var(--prism-background-color);margin:0;padding:0}.codeBlockTitle_Ktv7+.codeBlockContent_biex .codeBlock_bY9V{border-top-left-radius:0;border-top-right-radius:0}.codeBlockLines_e6Vv{float:left;font:inherit;min-width:100%;padding:var(--ifm-pre-padding)}.codeBlockLinesWithNumbering_o6Pm{display:table;padding:var(--ifm-pre-padding) 0}.buttonGroup__atx{-moz-column-gap:.2rem;column-gap:.2rem;display:flex;position:absolute;right:calc(var(--ifm-pre-padding)/2);top:calc(var(--ifm-pre-padding)/2)}.buttonGroup__atx button{align-items:center;border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-global-radius);display:flex;line-height:0;opacity:0;padding:.4rem;transition:opacity var(--ifm-transition-fast) ease-in-out}.buttonGroup__atx button:focus-visible,.buttonGroup__atx button:hover{opacity:1!important}.theme-code-block:hover .buttonGroup__atx button{opacity:.4}:where(:root){--docusaurus-highlighted-code-line-bg:#484d5b}:where([data-theme=dark]){--docusaurus-highlighted-code-line-bg:#646464}.theme-code-block-highlighted-line{background-color:var(--docusaurus-highlighted-code-line-bg);display:block;margin:0 calc(var(--ifm-pre-padding)*-1);padding:0 var(--ifm-pre-padding)}.codeLine_lJS_{counter-increment:a;display:table-row}.codeLineNumber_Tfdd{background:var(--ifm-pre-background);display:table-cell;left:0;overflow-wrap:normal;padding:0 var(--ifm-pre-padding);position:sticky;text-align:right;width:1%}.codeLineNumber_Tfdd:before{content:counter(a);opacity:.4}.codeLineContent_feaV{padding-right:var(--ifm-pre-padding)}.theme-code-block:hover .copyButtonCopied_obH4{opacity:1!important}.copyButtonIcons_eSgA{height:1.125rem;position:relative;width:1.125rem}.copyButtonIcon_y97N,.copyButtonSuccessIcon_LjdS{fill:currentColor;height:inherit;left:0;opacity:inherit;position:absolute;top:0;transition:all var(--ifm-transition-fast) ease;width:inherit}.copyButtonSuccessIcon_LjdS{color:#00d600;left:50%;opacity:0;top:50%;transform:translate(-50%,-50%) scale(.33)}.copyButtonCopied_obH4 .copyButtonIcon_y97N{opacity:0;transform:scale(.33)}.copyButtonCopied_obH4 .copyButtonSuccessIcon_LjdS{opacity:1;transform:translate(-50%,-50%) scale(1);transition-delay:75ms}.wordWrapButtonIcon_Bwma{height:1.2rem;width:1.2rem}.details_lb9f{--docusaurus-details-summary-arrow-size:0.38rem;--docusaurus-details-transition:transform 200ms ease;--docusaurus-details-decoration-color:grey}.details_lb9f>summary{cursor:pointer;padding-left:1rem;position:relative}.details_lb9f>summary::-webkit-details-marker{display:none}.details_lb9f>summary:before{border-color:transparent transparent transparent var(--docusaurus-details-decoration-color);border-style:solid;border-width:var(--docusaurus-details-summary-arrow-size);content:"";left:0;position:absolute;top:.45rem;transform:rotate(0);transform-origin:calc(var(--docusaurus-details-summary-arrow-size)/2) 50%;transition:var(--docusaurus-details-transition)}.collapsibleContent_i85q{border-top:1px solid var(--docusaurus-details-decoration-color);margin-top:1rem;padding-top:1rem}.details_b_Ee{--docusaurus-details-decoration-color:var(--ifm-alert-border-color);--docusaurus-details-transition:transform var(--ifm-transition-fast) ease;border:1px solid var(--ifm-alert-border-color);margin:0 0 var(--ifm-spacing-vertical)}.img_ev3q{height:auto}.admonition_LlT9{margin-bottom:1em}.admonitionHeading_tbUL{font:var(--ifm-heading-font-weight) var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family);margin-bottom:.3rem}.admonitionHeading_tbUL code{text-transform:none}.admonitionIcon_kALy{display:inline-block;margin-right:.4em;vertical-align:middle}.admonitionIcon_kALy svg{fill:var(--ifm-alert-foreground-color);display:inline-block;height:1.6em;width:1.6em}.breadcrumbHomeIcon_YNFT{height:1.1rem;position:relative;top:1px;vertical-align:top;width:1.1rem}.breadcrumbsContainer_Z_bl{--ifm-breadcrumb-size-multiplier:0.8;margin-bottom:.8rem}.backToTopButton_sjWU{background-color:var(--ifm-color-emphasis-200);border-radius:50%;bottom:1.3rem;box-shadow:var(--ifm-global-shadow-lw);height:3rem;opacity:0;position:fixed;right:1.3rem;transform:scale(0);transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default);visibility:hidden;width:3rem;z-index:calc(var(--ifm-z-index-fixed) - 1)}.backToTopButton_sjWU:after{background-color:var(--ifm-color-emphasis-1000);content:" ";display:inline-block;height:100%;-webkit-mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;width:100%}.backToTopButtonShow_xfvO{opacity:1;transform:scale(1);visibility:visible}[data-theme=dark]:root{--docusaurus-collapse-button-bg:hsla(0,0%,100%,.05);--docusaurus-collapse-button-bg-hover:hsla(0,0%,100%,.1)}.collapseSidebarButton_PEFL{display:none;margin:0}.docSidebarContainer_b6E3,.sidebarLogo_isFc{display:none}.docMainContainer_gTbr,.docPage__5DB{display:flex;width:100%}.docPage__5DB{flex:1 0}.docsWrapper_BCFX{display:flex;flex:1 0 auto}@media (min-width:997px){.collapseSidebarButton_PEFL,.expandButton_m80_{background-color:var(--docusaurus-collapse-button-bg)}:root{--docusaurus-announcement-bar-height:30px}.announcementBarClose_gvF7,.announcementBarPlaceholder_vyr4{flex-basis:50px}.searchBox_ZlJk{padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.lastUpdated_vwxv{text-align:right}.tocMobile_ITEo{display:none}.docItemCol_VOVn{max-width:75%!important}.collapseSidebarButton_PEFL{border:1px solid var(--ifm-toc-border-color);border-radius:0;bottom:0;display:block!important;height:40px;position:sticky}.collapseSidebarButtonIcon_kv0_{margin-top:4px;transform:rotate(180deg)}.expandButtonIcon_BlDH,[dir=rtl] .collapseSidebarButtonIcon_kv0_{transform:rotate(0)}.collapseSidebarButton_PEFL:focus,.collapseSidebarButton_PEFL:hover,.expandButton_m80_:focus,.expandButton_m80_:hover{background-color:var(--docusaurus-collapse-button-bg-hover)}.menuHtmlItem_M9Kj{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu_SIkG{flex-grow:1;padding:.5rem}@supports (scrollbar-gutter:stable){.menu_SIkG{padding:.5rem 0 .5rem .5rem;scrollbar-gutter:stable}}.menuWithAnnouncementBar_GW3s{margin-bottom:var(--docusaurus-announcement-bar-height)}.sidebar_njMd{display:flex;flex-direction:column;height:100%;padding-top:var(--ifm-navbar-height);width:var(--doc-sidebar-width)}.sidebarWithHideableNavbar_wUlq{padding-top:0}.sidebarHidden_VK0M{opacity:0;visibility:hidden}.sidebarLogo_isFc{align-items:center;color:inherit!important;display:flex!important;margin:0 var(--ifm-navbar-padding-horizontal);max-height:var(--ifm-navbar-height);min-height:var(--ifm-navbar-height);text-decoration:none!important}.sidebarLogo_isFc img{height:2rem;margin-right:.5rem}.expandButton_m80_{align-items:center;display:flex;height:100%;justify-content:center;position:absolute;right:0;top:0;transition:background-color var(--ifm-transition-fast) ease;width:100%}[dir=rtl] .expandButtonIcon_BlDH{transform:rotate(180deg)}.docSidebarContainer_b6E3{border-right:1px solid var(--ifm-toc-border-color);-webkit-clip-path:inset(0);clip-path:inset(0);display:block;margin-top:calc(var(--ifm-navbar-height)*-1);transition:width var(--ifm-transition-fast) ease;width:var(--doc-sidebar-width);will-change:width}.docSidebarContainerHidden_b3ry{cursor:pointer;width:var(--doc-sidebar-hidden-width)}.sidebarViewport_Xe31{height:100%;max-height:100vh;position:sticky;top:0}.docMainContainer_gTbr{flex-grow:1;max-width:calc(100% - var(--doc-sidebar-width))}.docMainContainerEnhanced_Uz_u{max-width:calc(100% - var(--doc-sidebar-hidden-width))}.docItemWrapperEnhanced_czyv{max-width:calc(var(--ifm-container-width) + var(--doc-sidebar-width))!important}}@media (min-width:1440px){.container{max-width:var(--ifm-container-width-xl)}}@media (max-width:996px){.col{--ifm-col-width:100%;flex-basis:var(--ifm-col-width);margin-left:0}.footer{--ifm-footer-padding-horizontal:0}.colorModeToggle_DEke,.footer__link-separator,.navbar__item,.tableOfContents_bqdL{display:none}.footer__col{margin-bottom:calc(var(--ifm-spacing-vertical)*3)}.footer__link-item{display:block}.hero{padding-left:0;padding-right:0}.navbar>.container,.navbar>.container-fluid{padding:0}.navbar__toggle{display:inherit}.navbar__search-input{width:9rem}.pills--block,.tabs--block{flex-direction:column}.searchBox_ZlJk{position:absolute;right:var(--ifm-navbar-padding-horizontal)}.docItemContainer_F8PC{padding:0 .3rem}}@media (max-width:576px){.markdown h1:first-child{--ifm-h1-font-size:2rem}.markdown>h2{--ifm-h2-font-size:1.5rem}.markdown>h3{--ifm-h3-font-size:1.25rem}}@media (hover:hover){.backToTopButton_sjWU:hover{background-color:var(--ifm-color-emphasis-300)}}@media (pointer:fine){.thin-scrollbar{scrollbar-width:thin}.thin-scrollbar::-webkit-scrollbar{height:var(--ifm-scrollbar-size);width:var(--ifm-scrollbar-size)}.thin-scrollbar::-webkit-scrollbar-track{background:var(--ifm-scrollbar-track-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb{background:var(--ifm-scrollbar-thumb-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb:hover{background:var(--ifm-scrollbar-thumb-hover-background-color)}}@media (prefers-reduced-motion:reduce){:root{--ifm-transition-fast:0ms;--ifm-transition-slow:0ms}}@media print{.announcementBar_mb4j,.footer,.menu,.navbar,.pagination-nav,.table-of-contents,.tocMobile_ITEo{display:none}.tabs{page-break-inside:avoid}.codeBlockLines_e6Vv{white-space:pre-wrap}} \ No newline at end of file diff --git a/build/assets/js/0123be5b.73a20162.js b/build/assets/js/0123be5b.73a20162.js new file mode 100644 index 00000000..2abacdaf --- /dev/null +++ b/build/assets/js/0123be5b.73a20162.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7524],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>u});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),g=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=g(e.components);return r.createElement(s.Provider,{value:t},e.children)},m="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),m=g(n),d=a,u=m["".concat(s,".").concat(d)]||m[d]||c[d]||i;return n?r.createElement(u,o(o({ref:t},p),{},{components:n})):r.createElement(u,o({ref:t},p))}));function u(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=d;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[m]="string"==typeof e?e:a,o[1]=l;for(var g=2;g{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>u,frontMatter:()=>l,metadata:()=>g,toc:()=>m});var r=n(7462),a=n(3366),i=(n(7294),n(3905)),o=["components"],l={},s=void 0,g={unversionedId:"Tutorials/FragmentTree",id:"Tutorials/FragmentTree",title:"FragmentTree",description:"\ud83c\udf32 Gathering Structured Insights",source:"@site/docs/Tutorials/FragmentTree.mdx",sourceDirName:"Tutorials",slug:"/Tutorials/FragmentTree",permalink:"/Tutorials/FragmentTree",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"FragmentPlans",permalink:"/Tutorials/FragmentPlans"},next:{title:"IfcPropertiesFinder",permalink:"/Tutorials/IfcPropertiesFinder"}},p={},m=[{value:"\ud83c\udf32 Gathering Structured Insights",id:"-gathering-structured-insights",level:3},{value:"\ud83e\udde9 Adding Fragments",id:"-adding-fragments",level:3},{value:"\ud83d\udd79 Selection of Fragments",id:"-selection-of-fragments",level:3},{value:"Adding Aesthetic Outlines",id:"adding-aesthetic-outlines",level:4},{value:"\ud83d\uddc2\ufe0f Strategically Classifying Fragments",id:"\ufe0f-strategically-classifying-fragments",level:3},{value:"Getting Properties",id:"getting-properties",level:4},{value:"\ud83c\udf31 Building Insightful Tree Views",id:"-building-insightful-tree-views",level:3},{value:"\ud83d\udece\ufe0f Managing Tree-View Events",id:"\ufe0f-managing-tree-view-events",level:4},{value:"\ud83c\udfa8 Rendering the Fragment Tree",id:"-rendering-the-fragment-tree",level:4}],c={toc:m},d="wrapper";function u(e){var t=e.components,n=(0,a.Z)(e,o);return(0,i.kt)(d,(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h3",{id:"-gathering-structured-insights"},"\ud83c\udf32 Gathering Structured Insights"),(0,i.kt)("hr",null),(0,i.kt)("p",null,"Building Information Modeling comprises nesting elements in multiple hierarchies.\nWorking with this information might become complicated and irritating.\ud83e\udd2f\n",(0,i.kt)("strong",{parentName:"p"},"Tree-View")," is extremely effective in managing this volume of data.\nUsing ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("a",{parentName:"strong",href:"../api/classes/components.FragmentTree"},"Fragment Tree")),", we have made it simple to generate a Tree-View for a fragment.\ud83e\uddbe"),(0,i.kt)("admonition",{title:"First, let's set up a simple scene!",type:"tip"},(0,i.kt)("p",{parentName:"admonition"},"\ud83d\udc40 If you haven't started there, check out ",(0,i.kt)("a",{parentName:"p",href:"/Tutorials/SimpleScene"},"that tutorial first"),"!")),(0,i.kt)("p",null,"In this lesson, we'll create a ",(0,i.kt)("strong",{parentName:"p"},"Tree-View")," for the items in the IFC file and zoom in on them when a node is clicked."),(0,i.kt)("h3",{id:"-adding-fragments"},"\ud83e\udde9 Adding Fragments"),(0,i.kt)("hr",null),(0,i.kt)("p",null,"We'll start by adding a ",(0,i.kt)("strong",{parentName:"p"},"Fragment")," to our scene using ",(0,i.kt)("a",{parentName:"p",href:"../api/classes/components.FragmentManager"},(0,i.kt)("strong",{parentName:"a"},"FragmentManager")),".\nWe'll use a simple fragment for the purposes of this tutorial, but the code is capable of handling big files as well.\ud83c\udfd7\ufe0f"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},'const fragments = new OBC.FragmentManager(components);\nconst file = await fetch("../../../resources/small.frag");\nconst data = await file.arrayBuffer();\nconst buffer = new Uint8Array(data);\nconst model = await fragments.load(buffer);\n')),(0,i.kt)("h3",{id:"-selection-of-fragments"},"\ud83d\udd79 Selection of Fragments"),(0,i.kt)("hr",null),(0,i.kt)("p",null,"Whenever you click on a ",(0,i.kt)("inlineCode",{parentName:"p"},"node")," in ",(0,i.kt)("strong",{parentName:"p"},"Tree-View"),", that particular element would be highlighted.\nTo create the highlight mechanism, we will use ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("a",{parentName:"strong",href:"../api/classes/components.FragmentHighlighter"},"Fragment Highlighter")),"\nthat manages the material and selection intuitively."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"const highlighter = new OBC.FragmentHighlighter(components, fragments);\nhighlighter.setup();\n")),(0,i.kt)("admonition",{title:"Highlighting Fragments",type:"info"},(0,i.kt)("p",{parentName:"admonition"},"\ud83d\uddb1Check out ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("a",{parentName:"strong",href:"/Tutorials/FragmentHighlighter"},"FragmentHighlighter.mdx"))," for a detailed tutorial on how to utilize Fragment Highlighter to conduct selection on ",(0,i.kt)("strong",{parentName:"p"},"IFC files"),"!")),(0,i.kt)("h4",{id:"adding-aesthetic-outlines"},"Adding Aesthetic Outlines"),(0,i.kt)("p",null,"Now that highlighter setup is done, we will add a nice outline effect when the elements are selected."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"components.renderer.postproduction.customEffects.outlineEnabled = true;\nhighlighter.outlinesEnabled = true;\nhighlighter.updateHighlight();\n")),(0,i.kt)("h3",{id:"\ufe0f-strategically-classifying-fragments"},"\ud83d\uddc2\ufe0f Strategically Classifying Fragments"),(0,i.kt)("p",null,"In this tutorial, we will deconstruct the model in order to obtain a hierarchical view.\ud83d\udca3\nTo obtain a nested view, we must first classify them by ",(0,i.kt)("strong",{parentName:"p"},"floors")," and then by ",(0,i.kt)("strong",{parentName:"p"},"type")," entities.\nFor breaking down the model in the required way, we'll utilize ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("a",{parentName:"strong",href:"../api/classes/components.FragmentClassifier"},"Fragment Classifier")),"."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"const classifier = new OBC.FragmentClassifier(components);\n")),(0,i.kt)("h4",{id:"getting-properties"},"Getting Properties"),(0,i.kt)("p",null,"Fragment Classifier requires model properties that will help the classifier in identifying the floors and entities included inside the Fragment.\ud83e\uddee\nWe will fetch the properties from ",(0,i.kt)("inlineCode",{parentName:"p"},"json")," file and store it in ",(0,i.kt)("inlineCode",{parentName:"p"},"model.properties"),"."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},'const properties = await fetch("../../../resources/small.json");\nmodel.setLocalProperties(await properties.json());\n')),(0,i.kt)("p",null,"Now that we have the properties, we will pass the model to classifier and use ",(0,i.kt)("inlineCode",{parentName:"p"},"classifier.byStorey()")," which will group the Fragments according to Floors.\nThe model then needs to be classified according to entities using ",(0,i.kt)("inlineCode",{parentName:"p"},"classifier.byEntity()"),".\ud83d\uddc2"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"classifier.byStorey(model);\nclassifier.byEntity(model);\n")),(0,i.kt)("h3",{id:"-building-insightful-tree-views"},"\ud83c\udf31 Building Insightful Tree Views"),(0,i.kt)("hr",null),(0,i.kt)("p",null,"Now comes the interesting part, we will create ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"FragmentTree"))," using ",(0,i.kt)("strong",{parentName:"p"},"components")," and ",(0,i.kt)("strong",{parentName:"p"},"classifier"),".\nIn addition, we will update the ",(0,i.kt)("strong",{parentName:"p"},"Fragment Tree")," to produce the Tree-View based on ",(0,i.kt)("inlineCode",{parentName:"p"},"storeys")," and ",(0,i.kt)("inlineCode",{parentName:"p"},"entities"),"."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"const modelTree = new OBC.FragmentTree(components);\nawait modelTree.init();\nmodelTree.update(['storeys', 'entities']);\n")),(0,i.kt)("h4",{id:"\ufe0f-managing-tree-view-events"},"\ud83d\udece\ufe0f Managing Tree-View Events"),(0,i.kt)("hr",null),(0,i.kt)("p",null,"We will zoom in on the element that is selected in the Tree-View and add a nice highlight effect when the user hovers over a tree node.\ud83d\uddb1\nLet's use ",(0,i.kt)("inlineCode",{parentName:"p"},"modelTree.onSelected")," to get the active selection from Fragment Tree, and we will use ",(0,i.kt)("inlineCode",{parentName:"p"},"highlighter.highlightByID()")," to zoom in.\ud83d\udd0d"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"modelTree.onSelected.add(({ items, visible }) => {\nif(visible) {\nhighlighter.highlightByID('select', items, true, true);\n}\n});\nmodelTree.onHovered.add(({ items, visible }) => {\nif(visible) {\nhighlighter.highlightByID('hover', items);\n}\n});\n")),(0,i.kt)("h4",{id:"-rendering-the-fragment-tree"},"\ud83c\udfa8 Rendering the Fragment Tree"),(0,i.kt)("hr",null),(0,i.kt)("p",null,"Now, that all the setup is done we will add the ",(0,i.kt)("strong",{parentName:"p"},"Fragment Tree")," to the ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("a",{parentName:"strong",href:"../api/classes/components.Toolbar"},"Toolbar")),".\nWe will use the ",(0,i.kt)("inlineCode",{parentName:"p"},"addChild()")," method to pass the Fragment Tree data to the ",(0,i.kt)("strong",{parentName:"p"},"Toolbar"),"\n\ud83c\udf9b\ufe0f Check ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("a",{parentName:"strong",href:"/Tutorials/UIManager"},"Toolbar and UIManager"))," tutorial if you have any doubts!"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},'const toolbar = new OBC.Toolbar(components);\ntoolbar.addChild(modelTree.uiElement.get("main"));\ncomponents.ui.addToolbar(toolbar);\n')),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},"Cheers and Congratulations")," \ud83c\udf89 on completing this short yet powerful tutorial!\nNow, you can provide a structured, navigable, and user-friendly interface to manage, explore, and interact with your BIM models.\ud83e\udd41\nLet's keep it up and check out another tutorial! \ud83c\udf93"),(0,i.kt)("iframe",{src:"https://thatopen.github.io/engine_components/src/fragments/FragmentTree/index.html"}))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/0123be5b.ca4dc1a9.js b/build/assets/js/0123be5b.ca4dc1a9.js deleted file mode 100644 index 2ede4668..00000000 --- a/build/assets/js/0123be5b.ca4dc1a9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7524],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>u});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),g=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=g(e.components);return r.createElement(s.Provider,{value:t},e.children)},m="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),m=g(n),d=a,u=m["".concat(s,".").concat(d)]||m[d]||c[d]||i;return n?r.createElement(u,o(o({ref:t},p),{},{components:n})):r.createElement(u,o({ref:t},p))}));function u(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=d;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[m]="string"==typeof e?e:a,o[1]=l;for(var g=2;g{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>u,frontMatter:()=>l,metadata:()=>g,toc:()=>m});var r=n(7462),a=n(3366),i=(n(7294),n(3905)),o=["components"],l={},s=void 0,g={unversionedId:"Tutorials/FragmentTree",id:"Tutorials/FragmentTree",title:"FragmentTree",description:"\ud83c\udf32 Gathering Structured Insights",source:"@site/docs/Tutorials/FragmentTree.mdx",sourceDirName:"Tutorials",slug:"/Tutorials/FragmentTree",permalink:"/Tutorials/FragmentTree",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"FragmentPlans",permalink:"/Tutorials/FragmentPlans"},next:{title:"IfcPropertiesFinder",permalink:"/Tutorials/IfcPropertiesFinder"}},p={},m=[{value:"\ud83c\udf32 Gathering Structured Insights",id:"-gathering-structured-insights",level:3},{value:"\ud83e\udde9 Adding Fragments",id:"-adding-fragments",level:3},{value:"\ud83d\udd79 Selection of Fragments",id:"-selection-of-fragments",level:3},{value:"Adding Aesthetic Outlines",id:"adding-aesthetic-outlines",level:4},{value:"\ud83d\uddc2\ufe0f Strategically Classifying Fragments",id:"\ufe0f-strategically-classifying-fragments",level:3},{value:"Getting Properties",id:"getting-properties",level:4},{value:"\ud83c\udf31 Building Insightful Tree Views",id:"-building-insightful-tree-views",level:3},{value:"\ud83d\udece\ufe0f Managing Tree-View Events",id:"\ufe0f-managing-tree-view-events",level:4},{value:"\ud83c\udfa8 Rendering the Fragment Tree",id:"-rendering-the-fragment-tree",level:4}],c={toc:m},d="wrapper";function u(e){var t=e.components,n=(0,a.Z)(e,o);return(0,i.kt)(d,(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h3",{id:"-gathering-structured-insights"},"\ud83c\udf32 Gathering Structured Insights"),(0,i.kt)("hr",null),(0,i.kt)("p",null,"Building Information Modeling comprises nesting elements in multiple hierarchies.\nWorking with this information might become complicated and irritating.\ud83e\udd2f\n",(0,i.kt)("strong",{parentName:"p"},"Tree-View")," is extremely effective in managing this volume of data.\nUsing ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("a",{parentName:"strong",href:"../api/classes/components.FragmentTree"},"Fragment Tree")),", we have made it simple to generate a Tree-View for a fragment.\ud83e\uddbe"),(0,i.kt)("admonition",{title:"First, let's set up a simple scene!",type:"tip"},(0,i.kt)("p",{parentName:"admonition"},"\ud83d\udc40 If you haven't started there, check out ",(0,i.kt)("a",{parentName:"p",href:"/Tutorials/SimpleScene"},"that tutorial first"),"!")),(0,i.kt)("p",null,"In this lesson, we'll create a ",(0,i.kt)("strong",{parentName:"p"},"Tree-View")," for the items in the IFC file and zoom in on them when a node is clicked."),(0,i.kt)("h3",{id:"-adding-fragments"},"\ud83e\udde9 Adding Fragments"),(0,i.kt)("hr",null),(0,i.kt)("p",null,"We'll start by adding a ",(0,i.kt)("strong",{parentName:"p"},"Fragment")," to our scene using ",(0,i.kt)("a",{parentName:"p",href:"../api/classes/components.FragmentManager"},(0,i.kt)("strong",{parentName:"a"},"FragmentManager")),".\nWe'll use a simple fragment for the purposes of this tutorial, but the code is capable of handling big files as well.\ud83c\udfd7\ufe0f"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},'const fragments = new OBC.FragmentManager(components);\nconst file = await fetch("../../../resources/small.frag");\nconst data = await file.arrayBuffer();\nconst buffer = new Uint8Array(data);\nconst model = await fragments.load(buffer);\nconst file2 = await fetch("../../../resources/small2.frag");\nconst data2 = await file2.arrayBuffer();\nconst buffer2 = new Uint8Array(data2);\nconst model2 = await fragments.load(buffer2);\n')),(0,i.kt)("h3",{id:"-selection-of-fragments"},"\ud83d\udd79 Selection of Fragments"),(0,i.kt)("hr",null),(0,i.kt)("p",null,"Whenever you click on a ",(0,i.kt)("inlineCode",{parentName:"p"},"node")," in ",(0,i.kt)("strong",{parentName:"p"},"Tree-View"),", that particular element would be highlighted.\nTo create the highlight mechanism, we will use ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("a",{parentName:"strong",href:"../api/classes/components.FragmentHighlighter"},"Fragment Highlighter")),"\nthat manages the material and selection intuitively."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"const highlighter = new OBC.FragmentHighlighter(components, fragments);\nhighlighter.setup();\n")),(0,i.kt)("admonition",{title:"Highlighting Fragments",type:"info"},(0,i.kt)("p",{parentName:"admonition"},"\ud83d\uddb1Check out ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("a",{parentName:"strong",href:"/Tutorials/FragmentHighlighter"},"FragmentHighlighter.mdx"))," for a detailed tutorial on how to utilize Fragment Highlighter to conduct selection on ",(0,i.kt)("strong",{parentName:"p"},"IFC files"),"!")),(0,i.kt)("h4",{id:"adding-aesthetic-outlines"},"Adding Aesthetic Outlines"),(0,i.kt)("p",null,"Now that highlighter setup is done, we will add a nice outline effect when the elements are selected."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"components.renderer.postproduction.customEffects.outlineEnabled = true;\nhighlighter.outlinesEnabled = true;\nhighlighter.updateHighlight();\n")),(0,i.kt)("h3",{id:"\ufe0f-strategically-classifying-fragments"},"\ud83d\uddc2\ufe0f Strategically Classifying Fragments"),(0,i.kt)("p",null,"In this tutorial, we will deconstruct the model in order to obtain a hierarchical view.\ud83d\udca3\nTo obtain a nested view, we must first classify them by ",(0,i.kt)("strong",{parentName:"p"},"floors")," and then by ",(0,i.kt)("strong",{parentName:"p"},"type")," entities.\nFor breaking down the model in the required way, we'll utilize ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("a",{parentName:"strong",href:"../api/classes/components.FragmentClassifier"},"Fragment Classifier")),"."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"const classifier = new OBC.FragmentClassifier(components);\n")),(0,i.kt)("h4",{id:"getting-properties"},"Getting Properties"),(0,i.kt)("p",null,"Fragment Classifier requires model properties that will help the classifier in identifying the floors and entities included inside the Fragment.\ud83e\uddee\nWe will fetch the properties from ",(0,i.kt)("inlineCode",{parentName:"p"},"json")," file and store it in ",(0,i.kt)("inlineCode",{parentName:"p"},"model.properties"),"."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},'const properties = await fetch("../../../resources/small.json");\nmodel.setLocalProperties(await properties.json());\nconst properties2 = await fetch("../../../resources/small2.json");\nmodel2.setLocalProperties(await properties2.json());\n')),(0,i.kt)("p",null,"Now that we have the properties, we will pass the model to classifier and use ",(0,i.kt)("inlineCode",{parentName:"p"},"classifier.byStorey()")," which will group the Fragments according to Floors.\nThe model then needs to be classified according to entities using ",(0,i.kt)("inlineCode",{parentName:"p"},"classifier.byEntity()"),".\ud83d\uddc2"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"// classifier.byStorey(model);\n// classifier.byEntity(model);\nclassifier.byStorey(model2);\nclassifier.byEntity(model2);\n")),(0,i.kt)("h3",{id:"-building-insightful-tree-views"},"\ud83c\udf31 Building Insightful Tree Views"),(0,i.kt)("hr",null),(0,i.kt)("p",null,"Now comes the interesting part, we will create ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"FragmentTree"))," using ",(0,i.kt)("strong",{parentName:"p"},"components")," and ",(0,i.kt)("strong",{parentName:"p"},"classifier"),".\nIn addition, we will update the ",(0,i.kt)("strong",{parentName:"p"},"Fragment Tree")," to produce the Tree-View based on ",(0,i.kt)("inlineCode",{parentName:"p"},"storeys")," and ",(0,i.kt)("inlineCode",{parentName:"p"},"entities"),"."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"const modelTree = new OBC.FragmentTree(components);\nawait modelTree.init();\nmodelTree.update(['storeys', 'entities']);\n")),(0,i.kt)("h4",{id:"\ufe0f-managing-tree-view-events"},"\ud83d\udece\ufe0f Managing Tree-View Events"),(0,i.kt)("hr",null),(0,i.kt)("p",null,"We will zoom in on the element that is selected in the Tree-View and add a nice highlight effect when the user hovers over a tree node.\ud83d\uddb1\nLet's use ",(0,i.kt)("inlineCode",{parentName:"p"},"modelTree.onSelected")," to get the active selection from Fragment Tree, and we will use ",(0,i.kt)("inlineCode",{parentName:"p"},"highlighter.highlightByID()")," to zoom in.\ud83d\udd0d"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"modelTree.onSelected.add(({ items, visible }) => {\nif(visible) {\nhighlighter.highlightByID('select', items, true, true);\n}\n});\nmodelTree.onHovered.add(({ items, visible }) => {\nif(visible) {\nhighlighter.highlightByID('hover', items);\n}\n});\n")),(0,i.kt)("h4",{id:"-rendering-the-fragment-tree"},"\ud83c\udfa8 Rendering the Fragment Tree"),(0,i.kt)("hr",null),(0,i.kt)("p",null,"Now, that all the setup is done we will add the ",(0,i.kt)("strong",{parentName:"p"},"Fragment Tree")," to the ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("a",{parentName:"strong",href:"../api/classes/components.Toolbar"},"Toolbar")),".\nWe will use the ",(0,i.kt)("inlineCode",{parentName:"p"},"addChild()")," method to pass the Fragment Tree data to the ",(0,i.kt)("strong",{parentName:"p"},"Toolbar"),"\n\ud83c\udf9b\ufe0f Check ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("a",{parentName:"strong",href:"/Tutorials/UIManager"},"Toolbar and UIManager"))," tutorial if you have any doubts!"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},'const toolbar = new OBC.Toolbar(components);\ntoolbar.addChild(modelTree.uiElement.get("main"));\ncomponents.ui.addToolbar(toolbar);\n')),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},"Cheers and Congratulations")," \ud83c\udf89 on completing this short yet powerful tutorial!\nNow, you can provide a structured, navigable, and user-friendly interface to manage, explore, and interact with your BIM models.\ud83e\udd41\nLet's keep it up and check out another tutorial! \ud83c\udf93"),(0,i.kt)("iframe",{src:"https://thatopen.github.io/engine_components/src/fragments/FragmentTree/index.html"}))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/0b4ea834.cd298e68.js b/build/assets/js/0b4ea834.ec53da3e.js similarity index 72% rename from build/assets/js/0b4ea834.cd298e68.js rename to build/assets/js/0b4ea834.ec53da3e.js index 1ff2f44c..d83e2298 100644 --- a/build/assets/js/0b4ea834.cd298e68.js +++ b/build/assets/js/0b4ea834.ec53da3e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3877],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>b});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function p(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=a.createContext({}),s=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},m=function(e){var t=s(e.components);return a.createElement(l.Provider,{value:t},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,p=e.originalType,l=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),d=s(n),u=r,b=d["".concat(l,".").concat(u)]||d[u]||c[u]||p;return n?a.createElement(b,i(i({ref:t},m),{},{components:n})):a.createElement(b,i({ref:t},m))}));function b(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var p=n.length,i=new Array(p);i[0]=u;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o[d]="string"==typeof e?e:r,i[1]=o;for(var s=2;s{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>l,default:()=>b,frontMatter:()=>o,metadata:()=>s,toc:()=>d});var a=n(7462),r=n(3366),p=(n(7294),n(3905)),i=["components"],o={id:"openbim_components.Updateable",title:"Interface: Updateable",sidebar_label:"Updateable",custom_edit_url:null},l=void 0,s={unversionedId:"api/interfaces/openbim_components.Updateable",id:"api/interfaces/openbim_components.Updateable",title:"Interface: Updateable",description:"openbim-components.Updateable",source:"@site/docs/api/interfaces/openbim_components.Updateable.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/openbim_components.Updateable",permalink:"/api/interfaces/openbim_components.Updateable",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Updateable",title:"Interface: Updateable",sidebar_label:"Updateable",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"UI",permalink:"/api/interfaces/openbim_components.UI"},next:{title:"AngleMeasurement",permalink:"/Tutorials/AngleMeasurement"}},m={},d=[{value:"Implemented by",id:"implemented-by",level:2},{value:"Properties",id:"properties",level:2},{value:"onAfterUpdate",id:"onafterupdate",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"onBeforeUpdate",id:"onbeforeupdate",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Methods",id:"methods",level:2},{value:"update",id:"update",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-2",level:4}],c={toc:d},u="wrapper";function b(e){var t=e.components,n=(0,r.Z)(e,i);return(0,p.kt)(u,(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Updateable"),(0,p.kt)("p",null,"Whether this component should be updated each frame."),(0,p.kt)("h2",{id:"implemented-by"},"Implemented by"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.CubeMap"},(0,p.kt)("inlineCode",{parentName:"a"},"CubeMap"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.LengthMeasurement"},(0,p.kt)("inlineCode",{parentName:"a"},"LengthMeasurement"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Simple2DScene"},(0,p.kt)("inlineCode",{parentName:"a"},"Simple2DScene"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleCamera"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleCamera"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleRenderer"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleRenderer")))),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,p.kt)("p",null,"Actions that should be executed after updating the component."),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L109"},"temp/engine_components/src/base-types/base-types.ts:109")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,p.kt)("p",null,"Actions that should be executed before updating the component."),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L112"},"temp/engine_components/src/base-types/base-types.ts:112")),(0,p.kt)("h2",{id:"methods"},"Methods"),(0,p.kt)("h3",{id:"update"},"update"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"update"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"delta?"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,"Function used to update the state of this component each frame. For\ninstance, a renderer component will make a render each frame."),(0,p.kt)("h4",{id:"parameters"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"delta?")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"number"))))),(0,p.kt)("h4",{id:"returns"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L118"},"temp/engine_components/src/base-types/base-types.ts:118")))}b.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3877],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>b});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function p(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=a.createContext({}),s=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},m=function(e){var t=s(e.components);return a.createElement(l.Provider,{value:t},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,p=e.originalType,l=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),d=s(n),u=r,b=d["".concat(l,".").concat(u)]||d[u]||c[u]||p;return n?a.createElement(b,i(i({ref:t},m),{},{components:n})):a.createElement(b,i({ref:t},m))}));function b(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var p=n.length,i=new Array(p);i[0]=u;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o[d]="string"==typeof e?e:r,i[1]=o;for(var s=2;s{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>l,default:()=>b,frontMatter:()=>o,metadata:()=>s,toc:()=>d});var a=n(7462),r=n(3366),p=(n(7294),n(3905)),i=["components"],o={id:"openbim_components.Updateable",title:"Interface: Updateable",sidebar_label:"Updateable",custom_edit_url:null},l=void 0,s={unversionedId:"api/interfaces/openbim_components.Updateable",id:"api/interfaces/openbim_components.Updateable",title:"Interface: Updateable",description:"openbim-components.Updateable",source:"@site/docs/api/interfaces/openbim_components.Updateable.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/openbim_components.Updateable",permalink:"/api/interfaces/openbim_components.Updateable",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Updateable",title:"Interface: Updateable",sidebar_label:"Updateable",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"UI",permalink:"/api/interfaces/openbim_components.UI"},next:{title:"AngleMeasurement",permalink:"/Tutorials/AngleMeasurement"}},m={},d=[{value:"Implemented by",id:"implemented-by",level:2},{value:"Properties",id:"properties",level:2},{value:"onAfterUpdate",id:"onafterupdate",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"onBeforeUpdate",id:"onbeforeupdate",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Methods",id:"methods",level:2},{value:"update",id:"update",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-2",level:4}],c={toc:d},u="wrapper";function b(e){var t=e.components,n=(0,r.Z)(e,i);return(0,p.kt)(u,(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Updateable"),(0,p.kt)("p",null,"Whether this component should be updated each frame."),(0,p.kt)("h2",{id:"implemented-by"},"Implemented by"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.CubeMap"},(0,p.kt)("inlineCode",{parentName:"a"},"CubeMap"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.LengthMeasurement"},(0,p.kt)("inlineCode",{parentName:"a"},"LengthMeasurement"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Simple2DScene"},(0,p.kt)("inlineCode",{parentName:"a"},"Simple2DScene"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleCamera"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleCamera"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleRenderer"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleRenderer")))),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,p.kt)("p",null,"Actions that should be executed after updating the component."),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L109"},"src/base-types/base-types.ts:109")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,p.kt)("p",null,"Actions that should be executed before updating the component."),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L112"},"src/base-types/base-types.ts:112")),(0,p.kt)("h2",{id:"methods"},"Methods"),(0,p.kt)("h3",{id:"update"},"update"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"update"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"delta?"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,"Function used to update the state of this component each frame. For\ninstance, a renderer component will make a render each frame."),(0,p.kt)("h4",{id:"parameters"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"delta?")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"number"))))),(0,p.kt)("h4",{id:"returns"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L118"},"src/base-types/base-types.ts:118")))}b.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/10f5d381.0babf9e7.js b/build/assets/js/10f5d381.0babf9e7.js deleted file mode 100644 index 40dd2cee..00000000 --- a/build/assets/js/10f5d381.0babf9e7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2981],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>b});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var o=a.createContext({}),s=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},d=function(e){var t=s(e.components);return a.createElement(o.Provider,{value:t},e.children)},m="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),m=s(n),k=r,b=m["".concat(o,".").concat(k)]||m[k]||c[k]||i;return n?a.createElement(b,l(l({ref:t},d),{},{components:n})):a.createElement(b,l({ref:t},d))}));function b(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=k;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[m]="string"==typeof e?e:r,l[1]=p;for(var s=2;s{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>b,frontMatter:()=>p,metadata:()=>s,toc:()=>m});var a=n(7462),r=n(3366),i=(n(7294),n(3905)),l=["components"],p={id:"openbim_components.Createable",title:"Interface: Createable",sidebar_label:"Createable",custom_edit_url:null},o=void 0,s={unversionedId:"api/interfaces/openbim_components.Createable",id:"api/interfaces/openbim_components.Createable",title:"Interface: Createable",description:"openbim-components.Createable",source:"@site/docs/api/interfaces/openbim_components.Createable.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/openbim_components.Createable",permalink:"/api/interfaces/openbim_components.Createable",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Createable",title:"Interface: Createable",sidebar_label:"Createable",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Configurable",permalink:"/api/interfaces/openbim_components.Configurable"},next:{title:"Disposable",permalink:"/api/interfaces/openbim_components.Disposable"}},d={},m=[{value:"Implemented by",id:"implemented-by",level:2},{value:"Properties",id:"properties",level:2},{value:"cancelCreation",id:"cancelcreation",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in",level:4},{value:"create",id:"create",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Defined in",id:"defined-in-1",level:4},{value:"delete",id:"delete",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Parameters",id:"parameters-2",level:5},{value:"Returns",id:"returns-2",level:5},{value:"Defined in",id:"defined-in-2",level:4},{value:"endCreation",id:"endcreation",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Parameters",id:"parameters-3",level:5},{value:"Returns",id:"returns-3",level:5},{value:"Defined in",id:"defined-in-3",level:4},{value:"onAfterCancel",id:"onaftercancel",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"onAfterCreate",id:"onaftercreate",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"onAfterDelete",id:"onafterdelete",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"onBeforeCancel",id:"onbeforecancel",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"onBeforeDelete",id:"onbeforedelete",level:3},{value:"Defined in",id:"defined-in-8",level:4}],c={toc:m},k="wrapper";function b(e){var t=e.components,n=(0,r.Z)(e,l);return(0,i.kt)(k,(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Createable"),(0,i.kt)("p",null,"Whether this component supports create and destroy operations. This generally\napplies for components that work with instances, such as clipping planes or\ndimensions."),(0,i.kt)("h2",{id:"implemented-by"},"Implemented by"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.LengthMeasurement"},(0,i.kt)("inlineCode",{parentName:"a"},"LengthMeasurement"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleClipper"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleClipper")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"cancelcreation"},"cancelCreation"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"cancelCreation"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"data"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),") => ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("p",null,"\u25b8 (",(0,i.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Cancels the creation process of the component, going back to the state\nbefore starting to create."),(0,i.kt)("h5",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"data")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))))),(0,i.kt)("h5",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L157"},"temp/engine_components/src/base-types/base-types.ts:157")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"create"},"create"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"create"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"data"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),") => ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,i.kt)("p",null,"\u25b8 (",(0,i.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Creates a new instance of an element (e.g. a new Dimension)."),(0,i.kt)("h5",{id:"parameters-1"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"data")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))))),(0,i.kt)("h5",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L139"},"temp/engine_components/src/base-types/base-types.ts:139")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"delete"},"delete"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"delete"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"data"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),") => ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,i.kt)("p",null,"\u25b8 (",(0,i.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Deletes an existing instance of an element (e.g. a Dimension)."),(0,i.kt)("h5",{id:"parameters-2"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"data")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))))),(0,i.kt)("h5",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L166"},"temp/engine_components/src/base-types/base-types.ts:166")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"endcreation"},"endCreation"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"endCreation"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"data"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),") => ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,i.kt)("p",null,"\u25b8 (",(0,i.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Finish the creation process of the component, successfully creating an\ninstance of whatever the component creates."),(0,i.kt)("h5",{id:"parameters-3"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"data")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))))),(0,i.kt)("h5",{id:"returns-3"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L148"},"temp/engine_components/src/base-types/base-types.ts:148")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onaftercancel"},"onAfterCancel"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onAfterCancel"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("p",null,"Fired after calling ",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#cancelcreation"},"Createable.cancelCreation"),"."),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L160"},"temp/engine_components/src/base-types/base-types.ts:160")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onaftercreate"},"onAfterCreate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onAfterCreate"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("p",null,"Fired after successfully calling ",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#create"},"Createable.create")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L142"},"temp/engine_components/src/base-types/base-types.ts:142")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onafterdelete"},"onAfterDelete"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onAfterDelete"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("p",null,"Fired after successfully calling ",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#delete"},"()")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L169"},"temp/engine_components/src/base-types/base-types.ts:169")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onbeforecancel"},"onBeforeCancel"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onBeforeCancel"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("p",null,"Fired before calling ",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#cancelcreation"},"Createable.cancelCreation"),"."),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L151"},"temp/engine_components/src/base-types/base-types.ts:151")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onbeforedelete"},"onBeforeDelete"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onBeforeDelete"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("p",null,"Fired before calling ",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#delete"},"Createable.delete"),"."),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L163"},"temp/engine_components/src/base-types/base-types.ts:163")))}b.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/10f5d381.130d3604.js b/build/assets/js/10f5d381.130d3604.js new file mode 100644 index 00000000..e53ededc --- /dev/null +++ b/build/assets/js/10f5d381.130d3604.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2981],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>u});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var o=a.createContext({}),s=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},d=function(e){var t=s(e.components);return a.createElement(o.Provider,{value:t},e.children)},m="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,l=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),m=s(n),k=r,u=m["".concat(o,".").concat(k)]||m[k]||c[k]||l;return n?a.createElement(u,i(i({ref:t},d),{},{components:n})):a.createElement(u,i({ref:t},d))}));function u(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=n.length,i=new Array(l);i[0]=k;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[m]="string"==typeof e?e:r,i[1]=p;for(var s=2;s{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>u,frontMatter:()=>p,metadata:()=>s,toc:()=>m});var a=n(7462),r=n(3366),l=(n(7294),n(3905)),i=["components"],p={id:"openbim_components.Createable",title:"Interface: Createable",sidebar_label:"Createable",custom_edit_url:null},o=void 0,s={unversionedId:"api/interfaces/openbim_components.Createable",id:"api/interfaces/openbim_components.Createable",title:"Interface: Createable",description:"openbim-components.Createable",source:"@site/docs/api/interfaces/openbim_components.Createable.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/openbim_components.Createable",permalink:"/api/interfaces/openbim_components.Createable",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Createable",title:"Interface: Createable",sidebar_label:"Createable",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Configurable",permalink:"/api/interfaces/openbim_components.Configurable"},next:{title:"Disposable",permalink:"/api/interfaces/openbim_components.Disposable"}},d={},m=[{value:"Implemented by",id:"implemented-by",level:2},{value:"Properties",id:"properties",level:2},{value:"cancelCreation",id:"cancelcreation",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in",level:4},{value:"create",id:"create",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Defined in",id:"defined-in-1",level:4},{value:"delete",id:"delete",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Parameters",id:"parameters-2",level:5},{value:"Returns",id:"returns-2",level:5},{value:"Defined in",id:"defined-in-2",level:4},{value:"endCreation",id:"endcreation",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Parameters",id:"parameters-3",level:5},{value:"Returns",id:"returns-3",level:5},{value:"Defined in",id:"defined-in-3",level:4},{value:"onAfterCancel",id:"onaftercancel",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"onAfterCreate",id:"onaftercreate",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"onAfterDelete",id:"onafterdelete",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"onBeforeCancel",id:"onbeforecancel",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"onBeforeDelete",id:"onbeforedelete",level:3},{value:"Defined in",id:"defined-in-8",level:4}],c={toc:m},k="wrapper";function u(e){var t=e.components,n=(0,r.Z)(e,i);return(0,l.kt)(k,(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Createable"),(0,l.kt)("p",null,"Whether this component supports create and destroy operations. This generally\napplies for components that work with instances, such as clipping planes or\ndimensions."),(0,l.kt)("h2",{id:"implemented-by"},"Implemented by"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.LengthMeasurement"},(0,l.kt)("inlineCode",{parentName:"a"},"LengthMeasurement"))),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleClipper"},(0,l.kt)("inlineCode",{parentName:"a"},"SimpleClipper")))),(0,l.kt)("h2",{id:"properties"},"Properties"),(0,l.kt)("h3",{id:"cancelcreation"},"cancelCreation"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"cancelCreation"),": (",(0,l.kt)("inlineCode",{parentName:"p"},"data"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"any"),") => ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,l.kt)("p",null,"\u25b8 (",(0,l.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("p",null,"Cancels the creation process of the component, going back to the state\nbefore starting to create."),(0,l.kt)("h5",{id:"parameters"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"data")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"any"))))),(0,l.kt)("h5",{id:"returns"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"defined-in"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L157"},"src/base-types/base-types.ts:157")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"create"},"create"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"create"),": (",(0,l.kt)("inlineCode",{parentName:"p"},"data"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"any"),") => ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,l.kt)("p",null,"\u25b8 (",(0,l.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("p",null,"Creates a new instance of an element (e.g. a new Dimension)."),(0,l.kt)("h5",{id:"parameters-1"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"data")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"any"))))),(0,l.kt)("h5",{id:"returns-1"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L139"},"src/base-types/base-types.ts:139")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"delete"},"delete"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"delete"),": (",(0,l.kt)("inlineCode",{parentName:"p"},"data"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"any"),") => ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,l.kt)("p",null,"\u25b8 (",(0,l.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("p",null,"Deletes an existing instance of an element (e.g. a Dimension)."),(0,l.kt)("h5",{id:"parameters-2"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"data")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"any"))))),(0,l.kt)("h5",{id:"returns-2"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L166"},"src/base-types/base-types.ts:166")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"endcreation"},"endCreation"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"endCreation"),": (",(0,l.kt)("inlineCode",{parentName:"p"},"data"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"any"),") => ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,l.kt)("p",null,"\u25b8 (",(0,l.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("p",null,"Finish the creation process of the component, successfully creating an\ninstance of whatever the component creates."),(0,l.kt)("h5",{id:"parameters-3"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"data")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"any"))))),(0,l.kt)("h5",{id:"returns-3"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L148"},"src/base-types/base-types.ts:148")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"onaftercancel"},"onAfterCancel"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"onAfterCancel"),": ",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,l.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,l.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,l.kt)("p",null,"Fired after calling ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#cancelcreation"},"Createable.cancelCreation"),"."),(0,l.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L160"},"src/base-types/base-types.ts:160")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"onaftercreate"},"onAfterCreate"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"onAfterCreate"),": ",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,l.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,l.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,l.kt)("p",null,"Fired after successfully calling ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#create"},"Createable.create")),(0,l.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L142"},"src/base-types/base-types.ts:142")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"onafterdelete"},"onAfterDelete"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"onAfterDelete"),": ",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,l.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,l.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,l.kt)("p",null,"Fired after successfully calling ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#delete"},"()")),(0,l.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L169"},"src/base-types/base-types.ts:169")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"onbeforecancel"},"onBeforeCancel"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"onBeforeCancel"),": ",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,l.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,l.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,l.kt)("p",null,"Fired before calling ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#cancelcreation"},"Createable.cancelCreation"),"."),(0,l.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L151"},"src/base-types/base-types.ts:151")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"onbeforedelete"},"onBeforeDelete"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"onBeforeDelete"),": ",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,l.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,l.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,l.kt)("p",null,"Fired before calling ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#delete"},"Createable.delete"),"."),(0,l.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L163"},"src/base-types/base-types.ts:163")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/1202d222.35168b8c.js b/build/assets/js/1202d222.35168b8c.js deleted file mode 100644 index 51cc9b13..00000000 --- a/build/assets/js/1202d222.35168b8c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1461],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>f});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function p(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=a.createContext({}),o=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},m=function(e){var t=o(e.components);return a.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),d=o(n),k=i,f=d["".concat(s,".").concat(k)]||d[k]||u[k]||r;return n?a.createElement(f,p(p({ref:t},m),{},{components:n})):a.createElement(f,p({ref:t},m))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,p=new Array(r);p[0]=k;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[d]="string"==typeof e?e:i,p[1]=l;for(var o=2;o{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>s,default:()=>f,frontMatter:()=>l,metadata:()=>o,toc:()=>d});var a=n(7462),i=n(3366),r=(n(7294),n(3905)),p=["components"],l={id:"openbim_components.FragmentManager",title:"Class: FragmentManager",sidebar_label:"FragmentManager",custom_edit_url:null},s=void 0,o={unversionedId:"api/classes/openbim_components.FragmentManager",id:"api/classes/openbim_components.FragmentManager",title:"Class: FragmentManager",description:"openbim-components.FragmentManager",source:"@site/docs/api/classes/openbim_components.FragmentManager.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.FragmentManager",permalink:"/api/classes/openbim_components.FragmentManager",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.FragmentManager",title:"Class: FragmentManager",sidebar_label:"FragmentManager",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"FragmentBoundingBox",permalink:"/api/classes/openbim_components.FragmentBoundingBox"},next:{title:"FragmentPlans",permalink:"/api/classes/openbim_components.FragmentPlans"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"list",id:"list",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Accessors",id:"accessors",level:2},{value:"meshes",id:"meshes",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"export",id:"export",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"load",id:"load",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"reset",id:"reset",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-14",level:4}],u={toc:d},k="wrapper";function f(e){var t=e.components,n=(0,i.Z)(e,p);return(0,r.kt)(k,(0,a.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".FragmentManager"),(0,r.kt)("p",null,"Object that can efficiently load binary files that contain\n",(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_fragment"},"fragment geometry"),"."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,r.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Fragment"),"[]",">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"FragmentManager"))))),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,r.kt)("inlineCode",{parentName:"a"},"Disposable"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},(0,r.kt)("inlineCode",{parentName:"a"},"UI")))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"enabled"},"enabled"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"enabled"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"true")),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentManager/index.ts#L29"},"temp/engine_components/src/fragments/FragmentManager/index.ts:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"list"},"list"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"list"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"{}")),(0,r.kt)("p",null,"All the created ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_fragment"},"fragments"),"."),(0,r.kt)("h4",{id:"index-signature"},"Index signature"),(0,r.kt)("p",null,"\u25aa ","[guid: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"Fragment")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentManager/index.ts#L32"},"temp/engine_components/src/fragments/FragmentManager/index.ts:32")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,r.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentManager/index.ts#L26"},"temp/engine_components/src/fragments/FragmentManager/index.ts:26")),(0,r.kt)("h2",{id:"accessors"},"Accessors"),(0,r.kt)("h3",{id:"meshes"},"meshes"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"meshes"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,r.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">","[]"),(0,r.kt)("p",null,"The list of meshes of the created fragments."),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,r.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">","[]"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentManager/index.ts#L55"},"temp/engine_components/src/fragments/FragmentManager/index.ts:55")),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"dispose"},"dispose"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"dispose"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"disposeUI?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"disposeUI")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false"))))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentManager/index.ts#L79"},"temp/engine_components/src/fragments/FragmentManager/index.ts:79")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"export"},"export"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"export"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"group"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,r.kt)("p",null,"Export the specified fragments."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"group")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FragmentsGroup")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the fragments group to be exported.")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,r.kt)("p",null,"the exported data as binary buffer."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentManager/index.ts#L166"},"temp/engine_components/src/fragments/FragmentManager/index.ts:166")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"get"},"get"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"get"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Fragment"),"[]"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Fragment"),"[]"),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentManager/index.ts#L74"},"temp/engine_components/src/fragments/FragmentManager/index.ts:74")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hasui"},"hasUI"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,r.kt)("p",null,"Whether is component implements any kind of ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,"this is UI"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,"this is Configurable"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,"this is Disposable"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ishideable"},"isHideable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,"this is Hideable"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,"this is Resizeable"),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,"this is Updateable"),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"load"},"load"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"load"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"coordinate?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"FragmentsGroup"),">"),(0,r.kt)("p",null,"Loads one or many fragments into the scene."),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Uint8Array")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the bytes containing the data for the fragments to load.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"coordinate")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"true")),(0,r.kt)("td",{parentName:"tr",align:"left"},"whether this fragmentsgroup should be federated with the others.")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"FragmentsGroup"),">"),(0,r.kt)("p",null,"the list of IDs of the loaded fragments."),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentManager/index.ts#L137"},"temp/engine_components/src/fragments/FragmentManager/index.ts:137")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"reset"},"reset"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"reset"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Disposes all existing fragments"),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentManager/index.ts#L123"},"temp/engine_components/src/fragments/FragmentManager/index.ts:123")))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/1202d222.4e24b134.js b/build/assets/js/1202d222.4e24b134.js new file mode 100644 index 00000000..b2e147c4 --- /dev/null +++ b/build/assets/js/1202d222.4e24b134.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1461],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>h});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function p(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=a.createContext({}),o=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},m=function(e){var t=o(e.components);return a.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),d=o(n),k=i,h=d["".concat(s,".").concat(k)]||d[k]||u[k]||r;return n?a.createElement(h,p(p({ref:t},m),{},{components:n})):a.createElement(h,p({ref:t},m))}));function h(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,p=new Array(r);p[0]=k;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[d]="string"==typeof e?e:i,p[1]=l;for(var o=2;o{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>s,default:()=>h,frontMatter:()=>l,metadata:()=>o,toc:()=>d});var a=n(7462),i=n(3366),r=(n(7294),n(3905)),p=["components"],l={id:"openbim_components.FragmentManager",title:"Class: FragmentManager",sidebar_label:"FragmentManager",custom_edit_url:null},s=void 0,o={unversionedId:"api/classes/openbim_components.FragmentManager",id:"api/classes/openbim_components.FragmentManager",title:"Class: FragmentManager",description:"openbim-components.FragmentManager",source:"@site/docs/api/classes/openbim_components.FragmentManager.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.FragmentManager",permalink:"/api/classes/openbim_components.FragmentManager",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.FragmentManager",title:"Class: FragmentManager",sidebar_label:"FragmentManager",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"FragmentBoundingBox",permalink:"/api/classes/openbim_components.FragmentBoundingBox"},next:{title:"FragmentPlans",permalink:"/api/classes/openbim_components.FragmentPlans"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"list",id:"list",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Accessors",id:"accessors",level:2},{value:"meshes",id:"meshes",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"export",id:"export",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"load",id:"load",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"reset",id:"reset",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-14",level:4}],u={toc:d},k="wrapper";function h(e){var t=e.components,n=(0,i.Z)(e,p);return(0,r.kt)(k,(0,a.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".FragmentManager"),(0,r.kt)("p",null,"Object that can efficiently load binary files that contain\n",(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_fragment"},"fragment geometry"),"."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,r.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Fragment"),"[]",">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"FragmentManager"))))),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,r.kt)("inlineCode",{parentName:"a"},"Disposable"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},(0,r.kt)("inlineCode",{parentName:"a"},"UI")))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"enabled"},"enabled"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"enabled"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"true")),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentManager/index.ts#L29"},"src/fragments/FragmentManager/index.ts:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"list"},"list"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"list"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"{}")),(0,r.kt)("p",null,"All the created ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_fragment"},"fragments"),"."),(0,r.kt)("h4",{id:"index-signature"},"Index signature"),(0,r.kt)("p",null,"\u25aa ","[guid: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"Fragment")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentManager/index.ts#L32"},"src/fragments/FragmentManager/index.ts:32")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,r.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentManager/index.ts#L26"},"src/fragments/FragmentManager/index.ts:26")),(0,r.kt)("h2",{id:"accessors"},"Accessors"),(0,r.kt)("h3",{id:"meshes"},"meshes"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"meshes"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,r.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">","[]"),(0,r.kt)("p",null,"The list of meshes of the created fragments."),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,r.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">","[]"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentManager/index.ts#L55"},"src/fragments/FragmentManager/index.ts:55")),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"dispose"},"dispose"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"dispose"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"disposeUI?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"disposeUI")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false"))))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentManager/index.ts#L79"},"src/fragments/FragmentManager/index.ts:79")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"export"},"export"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"export"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"group"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,r.kt)("p",null,"Export the specified fragments."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"group")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FragmentsGroup")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the fragments group to be exported.")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,r.kt)("p",null,"the exported data as binary buffer."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentManager/index.ts#L161"},"src/fragments/FragmentManager/index.ts:161")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"get"},"get"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"get"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Fragment"),"[]"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Fragment"),"[]"),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentManager/index.ts#L74"},"src/fragments/FragmentManager/index.ts:74")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hasui"},"hasUI"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,r.kt)("p",null,"Whether is component implements any kind of ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,"this is UI"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,"this is Configurable"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,"this is Disposable"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ishideable"},"isHideable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,"this is Hideable"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,"this is Resizeable"),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,"this is Updateable"),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"load"},"load"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"load"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"coordinate?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"FragmentsGroup"),">"),(0,r.kt)("p",null,"Loads one or many fragments into the scene."),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Uint8Array")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the bytes containing the data for the fragments to load.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"coordinate")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"true")),(0,r.kt)("td",{parentName:"tr",align:"left"},"whether this fragmentsgroup should be federated with the others.")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"FragmentsGroup"),">"),(0,r.kt)("p",null,"the list of IDs of the loaded fragments."),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentManager/index.ts#L137"},"src/fragments/FragmentManager/index.ts:137")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"reset"},"reset"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"reset"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Disposes all existing fragments"),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentManager/index.ts#L123"},"src/fragments/FragmentManager/index.ts:123")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/17896441.081be039.js b/build/assets/js/17896441.081be039.js deleted file mode 100644 index fec92fcb..00000000 --- a/build/assets/js/17896441.081be039.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7918],{903:(e,t,a)=>{a.r(t),a.d(t,{default:()=>he});var n=a(7294),l=a(1944),r=a(9688),o=n.createContext(null);function s(e){var t=e.children,a=function(e){return(0,n.useMemo)((function(){return{metadata:e.metadata,frontMatter:e.frontMatter,assets:e.assets,contentTitle:e.contentTitle,toc:e.toc}}),[e])}(e.content);return n.createElement(o.Provider,{value:a},t)}function i(){var e=(0,n.useContext)(o);if(null===e)throw new r.i6("DocProvider");return e}function c(){var e,t=i(),a=t.metadata,r=t.frontMatter,o=t.assets;return n.createElement(l.d,{title:a.title,description:a.description,keywords:r.keywords,image:null!=(e=o.image)?e:r.image})}var d=a(6010),m=a(7524),u=a(7462),v=a(5999),p=a(9960);function b(e){var t=e.permalink,a=e.title,l=e.subLabel,r=e.isNext;return n.createElement(p.Z,{className:(0,d.Z)("pagination-nav__link",r?"pagination-nav__link--next":"pagination-nav__link--prev"),to:t},l&&n.createElement("div",{className:"pagination-nav__sublabel"},l),n.createElement("div",{className:"pagination-nav__label"},a))}function E(e){var t=e.previous,a=e.next;return n.createElement("nav",{className:"pagination-nav docusaurus-mt-lg","aria-label":(0,v.I)({id:"theme.docs.paginator.navAriaLabel",message:"Docs pages",description:"The ARIA label for the docs pagination"})},t&&n.createElement(b,(0,u.Z)({},t,{subLabel:n.createElement(v.Z,{id:"theme.docs.paginator.previous",description:"The label used to navigate to the previous doc"},"Previous")})),a&&n.createElement(b,(0,u.Z)({},a,{subLabel:n.createElement(v.Z,{id:"theme.docs.paginator.next",description:"The label used to navigate to the next doc"},"Next"),isNext:!0})))}function h(){var e=i().metadata;return n.createElement(E,{previous:e.previous,next:e.next})}var g=a(2263),f=a(143),_=a(5281),N=a(373),Z=a(4477);var k={unreleased:function(e){var t=e.siteTitle,a=e.versionMetadata;return n.createElement(v.Z,{id:"theme.docs.versions.unreleasedVersionLabel",description:"The label used to tell the user that he's browsing an unreleased doc version",values:{siteTitle:t,versionLabel:n.createElement("b",null,a.label)}},"This is unreleased documentation for {siteTitle} {versionLabel} version.")},unmaintained:function(e){var t=e.siteTitle,a=e.versionMetadata;return n.createElement(v.Z,{id:"theme.docs.versions.unmaintainedVersionLabel",description:"The label used to tell the user that he's browsing an unmaintained doc version",values:{siteTitle:t,versionLabel:n.createElement("b",null,a.label)}},"This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained.")}};function C(e){var t=k[e.versionMetadata.banner];return n.createElement(t,e)}function L(e){var t=e.versionLabel,a=e.to,l=e.onClick;return n.createElement(v.Z,{id:"theme.docs.versions.latestVersionSuggestionLabel",description:"The label used to tell the user to check the latest version",values:{versionLabel:t,latestVersionLink:n.createElement("b",null,n.createElement(p.Z,{to:a,onClick:l},n.createElement(v.Z,{id:"theme.docs.versions.latestVersionLinkLabel",description:"The label used for the latest version suggestion link label"},"latest version")))}},"For up-to-date documentation, see the {latestVersionLink} ({versionLabel}).")}function T(e){var t,a=e.className,l=e.versionMetadata,r=(0,g.Z)().siteConfig.title,o=(0,f.gA)({failfast:!0}).pluginId,s=(0,N.J)(o).savePreferredVersionName,i=(0,f.Jo)(o),c=i.latestDocSuggestion,m=i.latestVersionSuggestion,u=null!=c?c:(t=m).docs.find((function(e){return e.id===t.mainDocId}));return n.createElement("div",{className:(0,d.Z)(a,_.k.docs.docVersionBanner,"alert alert--warning margin-bottom--md"),role:"alert"},n.createElement("div",null,n.createElement(C,{siteTitle:r,versionMetadata:l})),n.createElement("div",{className:"margin-top--md"},n.createElement(L,{versionLabel:m.label,to:u.path,onClick:function(){return s(m.name)}})))}function U(e){var t=e.className,a=(0,Z.E)();return a.banner?n.createElement(T,{className:t,versionMetadata:a}):null}function w(e){var t=e.className,a=(0,Z.E)();return a.badge?n.createElement("span",{className:(0,d.Z)(t,_.k.docs.docVersionBadge,"badge badge--secondary")},n.createElement(v.Z,{id:"theme.docs.versionBadge.label",values:{versionLabel:a.label}},"Version: {versionLabel}")):null}function x(e){var t=e.lastUpdatedAt,a=e.formattedLastUpdatedAt;return n.createElement(v.Z,{id:"theme.lastUpdated.atDate",description:"The words used to describe on which date a page has been last updated",values:{date:n.createElement("b",null,n.createElement("time",{dateTime:new Date(1e3*t).toISOString()},a))}}," on {date}")}function y(e){var t=e.lastUpdatedBy;return n.createElement(v.Z,{id:"theme.lastUpdated.byUser",description:"The words used to describe by who the page has been last updated",values:{user:n.createElement("b",null,t)}}," by {user}")}function A(e){var t=e.lastUpdatedAt,a=e.formattedLastUpdatedAt,l=e.lastUpdatedBy;return n.createElement("span",{className:_.k.common.lastUpdated},n.createElement(v.Z,{id:"theme.lastUpdated.lastUpdatedAtBy",description:"The sentence used to display when a page has been last updated, and by who",values:{atDate:t&&a?n.createElement(x,{lastUpdatedAt:t,formattedLastUpdatedAt:a}):"",byUser:l?n.createElement(y,{lastUpdatedBy:l}):""}},"Last updated{atDate}{byUser}"),!1)}var M=a(3366);const B={iconEdit:"iconEdit_Z9Sw"};var I=["className"];function V(e){var t=e.className,a=(0,M.Z)(e,I);return n.createElement("svg",(0,u.Z)({fill:"currentColor",height:"20",width:"20",viewBox:"0 0 40 40",className:(0,d.Z)(B.iconEdit,t),"aria-hidden":"true"},a),n.createElement("g",null,n.createElement("path",{d:"m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"})))}function H(e){var t=e.editUrl;return n.createElement("a",{href:t,target:"_blank",rel:"noreferrer noopener",className:_.k.common.editThisPage},n.createElement(V,null),n.createElement(v.Z,{id:"theme.common.editThisPage",description:"The link label to edit the current page"},"Edit this page"))}const P={tag:"tag_zVej",tagRegular:"tagRegular_sFm0",tagWithCount:"tagWithCount_h2kH"};function D(e){var t=e.permalink,a=e.label,l=e.count;return n.createElement(p.Z,{href:t,className:(0,d.Z)(P.tag,l?P.tagWithCount:P.tagRegular)},a,l&&n.createElement("span",null,l))}const S={tags:"tags_jXut",tag:"tag_QGVx"};function F(e){var t=e.tags;return n.createElement(n.Fragment,null,n.createElement("b",null,n.createElement(v.Z,{id:"theme.tags.tagsListLabel",description:"The label alongside a tag list"},"Tags:")),n.createElement("ul",{className:(0,d.Z)(S.tags,"padding--none","margin-left--sm")},t.map((function(e){var t=e.label,a=e.permalink;return n.createElement("li",{key:a,className:S.tag},n.createElement(D,{label:t,permalink:a}))}))))}const R={lastUpdated:"lastUpdated_vwxv"};function z(e){return n.createElement("div",{className:(0,d.Z)(_.k.docs.docFooterTagsRow,"row margin-bottom--sm")},n.createElement("div",{className:"col"},n.createElement(F,e)))}function O(e){var t=e.editUrl,a=e.lastUpdatedAt,l=e.lastUpdatedBy,r=e.formattedLastUpdatedAt;return n.createElement("div",{className:(0,d.Z)(_.k.docs.docFooterEditMetaRow,"row")},n.createElement("div",{className:"col"},t&&n.createElement(H,{editUrl:t})),n.createElement("div",{className:(0,d.Z)("col",R.lastUpdated)},(a||l)&&n.createElement(A,{lastUpdatedAt:a,formattedLastUpdatedAt:r,lastUpdatedBy:l})))}function j(){var e=i().metadata,t=e.editUrl,a=e.lastUpdatedAt,l=e.formattedLastUpdatedAt,r=e.lastUpdatedBy,o=e.tags,s=o.length>0,c=!!(t||a||r);return s||c?n.createElement("footer",{className:(0,d.Z)(_.k.docs.docFooter,"docusaurus-mt-lg")},s&&n.createElement(z,{tags:o}),c&&n.createElement(O,{editUrl:t,lastUpdatedAt:a,lastUpdatedBy:r,formattedLastUpdatedAt:l})):null}var q=a(6043),G=a(3743);const W={tocCollapsibleButton:"tocCollapsibleButton_TO0P",tocCollapsibleButtonExpanded:"tocCollapsibleButtonExpanded_MG3E"};var J=["collapsed"];function Q(e){var t=e.collapsed,a=(0,M.Z)(e,J);return n.createElement("button",(0,u.Z)({type:"button"},a,{className:(0,d.Z)("clean-btn",W.tocCollapsibleButton,!t&&W.tocCollapsibleButtonExpanded,a.className)}),n.createElement(v.Z,{id:"theme.TOCCollapsible.toggleButtonLabel",description:"The label used by the button on the collapsible TOC component"},"On this page"))}const X={tocCollapsible:"tocCollapsible_ETCw",tocCollapsibleContent:"tocCollapsibleContent_vkbj",tocCollapsibleExpanded:"tocCollapsibleExpanded_sAul"};function Y(e){var t=e.toc,a=e.className,l=e.minHeadingLevel,r=e.maxHeadingLevel,o=(0,q.u)({initialState:!0}),s=o.collapsed,i=o.toggleCollapsed;return n.createElement("div",{className:(0,d.Z)(X.tocCollapsible,!s&&X.tocCollapsibleExpanded,a)},n.createElement(Q,{collapsed:s,onClick:i}),n.createElement(q.z,{lazy:!0,className:X.tocCollapsibleContent,collapsed:s},n.createElement(G.Z,{toc:t,minHeadingLevel:l,maxHeadingLevel:r})))}const K={tocMobile:"tocMobile_ITEo"};function $(){var e=i(),t=e.toc,a=e.frontMatter;return n.createElement(Y,{toc:t,minHeadingLevel:a.toc_min_heading_level,maxHeadingLevel:a.toc_max_heading_level,className:(0,d.Z)(_.k.docs.docTocMobile,K.tocMobile)})}var ee=a(9407);function te(){var e=i(),t=e.toc,a=e.frontMatter;return n.createElement(ee.Z,{toc:t,minHeadingLevel:a.toc_min_heading_level,maxHeadingLevel:a.toc_max_heading_level,className:_.k.docs.docTocDesktop})}var ae=a(2503),ne=a(6905);function le(e){var t,a,l,r,o=e.children,s=(t=i(),a=t.metadata,l=t.frontMatter,r=t.contentTitle,l.hide_title||void 0!==r?null:a.title);return n.createElement("div",{className:(0,d.Z)(_.k.docs.docMarkdown,"markdown")},s&&n.createElement("header",null,n.createElement(ae.Z,{as:"h1"},s)),n.createElement(ne.Z,null,o))}var re=a(8425),oe=a(8596),se=a(4996);function ie(e){return n.createElement("svg",(0,u.Z)({viewBox:"0 0 24 24"},e),n.createElement("path",{d:"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z",fill:"currentColor"}))}const ce={breadcrumbHomeIcon:"breadcrumbHomeIcon_YNFT"};function de(){var e=(0,se.Z)("/");return n.createElement("li",{className:"breadcrumbs__item"},n.createElement(p.Z,{"aria-label":(0,v.I)({id:"theme.docs.breadcrumbs.home",message:"Home page",description:"The ARIA label for the home page in the breadcrumbs"}),className:"breadcrumbs__link",href:e},n.createElement(ie,{className:ce.breadcrumbHomeIcon})))}const me={breadcrumbsContainer:"breadcrumbsContainer_Z_bl"};function ue(e){var t=e.children,a=e.href,l="breadcrumbs__link";return e.isLast?n.createElement("span",{className:l,itemProp:"name"},t):a?n.createElement(p.Z,{className:l,href:a,itemProp:"item"},n.createElement("span",{itemProp:"name"},t)):n.createElement("span",{className:l},t)}function ve(e){var t=e.children,a=e.active,l=e.index,r=e.addMicrodata;return n.createElement("li",(0,u.Z)({},r&&{itemScope:!0,itemProp:"itemListElement",itemType:"https://schema.org/ListItem"},{className:(0,d.Z)("breadcrumbs__item",{"breadcrumbs__item--active":a})}),t,n.createElement("meta",{itemProp:"position",content:String(l+1)}))}function pe(){var e=(0,re.s1)(),t=(0,oe.Ns)();return e?n.createElement("nav",{className:(0,d.Z)(_.k.docs.docBreadcrumbs,me.breadcrumbsContainer),"aria-label":(0,v.I)({id:"theme.docs.breadcrumbs.navAriaLabel",message:"Breadcrumbs",description:"The ARIA label for the breadcrumbs"})},n.createElement("ul",{className:"breadcrumbs",itemScope:!0,itemType:"https://schema.org/BreadcrumbList"},t&&n.createElement(de,null),e.map((function(t,a){var l=a===e.length-1;return n.createElement(ve,{key:a,active:l,index:a,addMicrodata:!!t.href},n.createElement(ue,{href:t.href,isLast:l},t.label))})))):null}const be={docItemContainer:"docItemContainer_Djhp",docItemCol:"docItemCol_VOVn"};function Ee(e){var t,a,l,r,o,s,c=e.children,u=(t=i(),a=t.frontMatter,l=t.toc,r=(0,m.i)(),o=a.hide_table_of_contents,s=!o&&l.length>0,{hidden:o,mobile:s?n.createElement($,null):void 0,desktop:!s||"desktop"!==r&&"ssr"!==r?void 0:n.createElement(te,null)});return n.createElement("div",{className:"row"},n.createElement("div",{className:(0,d.Z)("col",!u.hidden&&be.docItemCol)},n.createElement(U,null),n.createElement("div",{className:be.docItemContainer},n.createElement("article",null,n.createElement(pe,null),n.createElement(w,null),u.mobile,n.createElement(le,null,c),n.createElement(j,null)),n.createElement(h,null))),u.desktop&&n.createElement("div",{className:"col col--3"},u.desktop))}function he(e){var t="docs-doc-id-"+e.content.metadata.unversionedId,a=e.content;return n.createElement(s,{content:e.content},n.createElement(l.FG,{className:t},n.createElement(c,null),n.createElement(Ee,null,n.createElement(a,null))))}},4477:(e,t,a)=>{a.d(t,{E:()=>s,q:()=>o});var n=a(7294),l=a(9688),r=n.createContext(null);function o(e){var t=e.children,a=e.version;return n.createElement(r.Provider,{value:a},t)}function s(){var e=(0,n.useContext)(r);if(null===e)throw new l.i6("DocsVersionProvider");return e}}}]); \ No newline at end of file diff --git a/build/assets/js/17896441.2a0ca96b.js b/build/assets/js/17896441.2a0ca96b.js new file mode 100644 index 00000000..e499db3a --- /dev/null +++ b/build/assets/js/17896441.2a0ca96b.js @@ -0,0 +1 @@ +(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7918],{3905:(e,t,n)=>{"use strict";n.d(t,{Zo:()=>u,kt:()=>f});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var c=a.createContext({}),s=function(e){var t=a.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},u=function(e){var t=s(e.components);return a.createElement(c.Provider,{value:t},e.children)},d="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},p=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,c=e.parentName,u=i(e,["components","mdxType","originalType","parentName"]),d=s(n),p=r,f=d["".concat(c,".").concat(p)]||d[p]||m[p]||o;return n?a.createElement(f,l(l({ref:t},u),{},{components:n})):a.createElement(f,l({ref:t},u))}));function f(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,l=new Array(o);l[0]=p;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[d]="string"==typeof e?e:r,l[1]=i;for(var s=2;s{"use strict";n.r(t),n.d(t,{default:()=>Rt});var a=n(7294),r=n(1944),o=n(9688),l=a.createContext(null);function i(e){var t=e.children,n=function(e){return(0,a.useMemo)((function(){return{metadata:e.metadata,frontMatter:e.frontMatter,assets:e.assets,contentTitle:e.contentTitle,toc:e.toc}}),[e])}(e.content);return a.createElement(l.Provider,{value:n},t)}function c(){var e=(0,a.useContext)(l);if(null===e)throw new o.i6("DocProvider");return e}function s(){var e,t=c(),n=t.metadata,o=t.frontMatter,l=t.assets;return a.createElement(r.d,{title:n.title,description:n.description,keywords:o.keywords,image:null!=(e=l.image)?e:o.image})}var u=n(6010),d=n(7524),m=n(7462),p=n(5999),f=n(9960);function v(e){var t=e.permalink,n=e.title,r=e.subLabel,o=e.isNext;return a.createElement(f.Z,{className:(0,u.Z)("pagination-nav__link",o?"pagination-nav__link--next":"pagination-nav__link--prev"),to:t},r&&a.createElement("div",{className:"pagination-nav__sublabel"},r),a.createElement("div",{className:"pagination-nav__label"},n))}function h(e){var t=e.previous,n=e.next;return a.createElement("nav",{className:"pagination-nav docusaurus-mt-lg","aria-label":(0,p.I)({id:"theme.docs.paginator.navAriaLabel",message:"Docs pages",description:"The ARIA label for the docs pagination"})},t&&a.createElement(v,(0,m.Z)({},t,{subLabel:a.createElement(p.Z,{id:"theme.docs.paginator.previous",description:"The label used to navigate to the previous doc"},"Previous")})),n&&a.createElement(v,(0,m.Z)({},n,{subLabel:a.createElement(p.Z,{id:"theme.docs.paginator.next",description:"The label used to navigate to the next doc"},"Next"),isNext:!0})))}function g(){var e=c().metadata;return a.createElement(h,{previous:e.previous,next:e.next})}var b=n(2263),E=n(143),y=n(5281),k=n(373),N=n(4477);var C={unreleased:function(e){var t=e.siteTitle,n=e.versionMetadata;return a.createElement(p.Z,{id:"theme.docs.versions.unreleasedVersionLabel",description:"The label used to tell the user that he's browsing an unreleased doc version",values:{siteTitle:t,versionLabel:a.createElement("b",null,n.label)}},"This is unreleased documentation for {siteTitle} {versionLabel} version.")},unmaintained:function(e){var t=e.siteTitle,n=e.versionMetadata;return a.createElement(p.Z,{id:"theme.docs.versions.unmaintainedVersionLabel",description:"The label used to tell the user that he's browsing an unmaintained doc version",values:{siteTitle:t,versionLabel:a.createElement("b",null,n.label)}},"This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained.")}};function L(e){var t=C[e.versionMetadata.banner];return a.createElement(t,e)}function Z(e){var t=e.versionLabel,n=e.to,r=e.onClick;return a.createElement(p.Z,{id:"theme.docs.versions.latestVersionSuggestionLabel",description:"The label used to tell the user to check the latest version",values:{versionLabel:t,latestVersionLink:a.createElement("b",null,a.createElement(f.Z,{to:n,onClick:r},a.createElement(p.Z,{id:"theme.docs.versions.latestVersionLinkLabel",description:"The label used for the latest version suggestion link label"},"latest version")))}},"For up-to-date documentation, see the {latestVersionLink} ({versionLabel}).")}function T(e){var t,n=e.className,r=e.versionMetadata,o=(0,b.Z)().siteConfig.title,l=(0,E.gA)({failfast:!0}).pluginId,i=(0,k.J)(l).savePreferredVersionName,c=(0,E.Jo)(l),s=c.latestDocSuggestion,d=c.latestVersionSuggestion,m=null!=s?s:(t=d).docs.find((function(e){return e.id===t.mainDocId}));return a.createElement("div",{className:(0,u.Z)(n,y.k.docs.docVersionBanner,"alert alert--warning margin-bottom--md"),role:"alert"},a.createElement("div",null,a.createElement(L,{siteTitle:o,versionMetadata:r})),a.createElement("div",{className:"margin-top--md"},a.createElement(Z,{versionLabel:d.label,to:m.path,onClick:function(){return i(d.name)}})))}function w(e){var t=e.className,n=(0,N.E)();return n.banner?a.createElement(T,{className:t,versionMetadata:n}):null}function _(e){var t=e.className,n=(0,N.E)();return n.badge?a.createElement("span",{className:(0,u.Z)(t,y.k.docs.docVersionBadge,"badge badge--secondary")},a.createElement(p.Z,{id:"theme.docs.versionBadge.label",values:{versionLabel:n.label}},"Version: {versionLabel}")):null}function x(e){var t=e.lastUpdatedAt,n=e.formattedLastUpdatedAt;return a.createElement(p.Z,{id:"theme.lastUpdated.atDate",description:"The words used to describe on which date a page has been last updated",values:{date:a.createElement("b",null,a.createElement("time",{dateTime:new Date(1e3*t).toISOString()},n))}}," on {date}")}function B(e){var t=e.lastUpdatedBy;return a.createElement(p.Z,{id:"theme.lastUpdated.byUser",description:"The words used to describe by who the page has been last updated",values:{user:a.createElement("b",null,t)}}," by {user}")}function O(e){var t=e.lastUpdatedAt,n=e.formattedLastUpdatedAt,r=e.lastUpdatedBy;return a.createElement("span",{className:y.k.common.lastUpdated},a.createElement(p.Z,{id:"theme.lastUpdated.lastUpdatedAtBy",description:"The sentence used to display when a page has been last updated, and by who",values:{atDate:t&&n?a.createElement(x,{lastUpdatedAt:t,formattedLastUpdatedAt:n}):"",byUser:r?a.createElement(B,{lastUpdatedBy:r}):""}},"Last updated{atDate}{byUser}"),!1)}var H=n(3366);const j={iconEdit:"iconEdit_Z9Sw"};var A=["className"];function I(e){var t=e.className,n=(0,H.Z)(e,A);return a.createElement("svg",(0,m.Z)({fill:"currentColor",height:"20",width:"20",viewBox:"0 0 40 40",className:(0,u.Z)(j.iconEdit,t),"aria-hidden":"true"},n),a.createElement("g",null,a.createElement("path",{d:"m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"})))}function S(e){var t=e.editUrl;return a.createElement("a",{href:t,target:"_blank",rel:"noreferrer noopener",className:y.k.common.editThisPage},a.createElement(I,null),a.createElement(p.Z,{id:"theme.common.editThisPage",description:"The link label to edit the current page"},"Edit this page"))}const M={tag:"tag_zVej",tagRegular:"tagRegular_sFm0",tagWithCount:"tagWithCount_h2kH"};function P(e){var t=e.permalink,n=e.label,r=e.count;return a.createElement(f.Z,{href:t,className:(0,u.Z)(M.tag,r?M.tagWithCount:M.tagRegular)},n,r&&a.createElement("span",null,r))}const U={tags:"tags_jXut",tag:"tag_QGVx"};function z(e){var t=e.tags;return a.createElement(a.Fragment,null,a.createElement("b",null,a.createElement(p.Z,{id:"theme.tags.tagsListLabel",description:"The label alongside a tag list"},"Tags:")),a.createElement("ul",{className:(0,u.Z)(U.tags,"padding--none","margin-left--sm")},t.map((function(e){var t=e.label,n=e.permalink;return a.createElement("li",{key:n,className:U.tag},a.createElement(P,{label:t,permalink:n}))}))))}const V={lastUpdated:"lastUpdated_vwxv"};function D(e){return a.createElement("div",{className:(0,u.Z)(y.k.docs.docFooterTagsRow,"row margin-bottom--sm")},a.createElement("div",{className:"col"},a.createElement(z,e)))}function R(e){var t=e.editUrl,n=e.lastUpdatedAt,r=e.lastUpdatedBy,o=e.formattedLastUpdatedAt;return a.createElement("div",{className:(0,u.Z)(y.k.docs.docFooterEditMetaRow,"row")},a.createElement("div",{className:"col"},t&&a.createElement(S,{editUrl:t})),a.createElement("div",{className:(0,u.Z)("col",V.lastUpdated)},(n||r)&&a.createElement(O,{lastUpdatedAt:n,formattedLastUpdatedAt:o,lastUpdatedBy:r})))}function W(){var e=c().metadata,t=e.editUrl,n=e.lastUpdatedAt,r=e.formattedLastUpdatedAt,o=e.lastUpdatedBy,l=e.tags,i=l.length>0,s=!!(t||n||o);return i||s?a.createElement("footer",{className:(0,u.Z)(y.k.docs.docFooter,"docusaurus-mt-lg")},i&&a.createElement(D,{tags:l}),s&&a.createElement(R,{editUrl:t,lastUpdatedAt:n,lastUpdatedBy:o,formattedLastUpdatedAt:r})):null}var F=n(6043),q=n(6668),G=["parentIndex"];function $(e){var t=e.map((function(e){return Object.assign({},e,{parentIndex:-1,children:[]})})),n=Array(7).fill(-1);t.forEach((function(e,t){var a=n.slice(2,e.level);e.parentIndex=Math.max.apply(Math,a),n[e.level]=t}));var a=[];return t.forEach((function(e){var n=e.parentIndex,r=(0,H.Z)(e,G);n>=0?t[n].children.push(r):a.push(r)})),a}function Y(e){var t=e.toc,n=e.minHeadingLevel,a=e.maxHeadingLevel;return t.flatMap((function(e){var t=Y({toc:e.children,minHeadingLevel:n,maxHeadingLevel:a});return function(e){return e.level>=n&&e.level<=a}(e)?[Object.assign({},e,{children:t})]:t}))}function J(e){var t=e.getBoundingClientRect();return t.top===t.bottom?J(e.parentNode):t}function Q(e,t){var n,a,r=t.anchorTopOffset,o=e.find((function(e){return J(e).top>=r}));return o?function(e){return e.top>0&&e.bottom0})).map((function(e){return[e-1,[i]]}));return{lineClassNames:Object.fromEntries(c),code:n}}if(void 0===a)return{lineClassNames:{},code:n};for(var s=function(e,t){switch(e){case"js":case"javascript":case"ts":case"typescript":return He(["js","jsBlock"],t);case"jsx":case"tsx":return He(["js","jsBlock","jsx"],t);case"html":return He(["js","jsBlock","html"],t);case"python":case"py":case"bash":return He(["bash"],t);case"markdown":case"md":return He(["html","jsx","bash"],t);default:return He(Object.keys(Oe),t)}}(a,r),u=n.split("\n"),d=Object.fromEntries(r.map((function(e){return[e.className,{start:0,range:""}]}))),m=Object.fromEntries(r.filter((function(e){return e.line})).map((function(e){var t=e.className;return[e.line,t]}))),p=Object.fromEntries(r.filter((function(e){return e.block})).map((function(e){var t=e.className;return[e.block.start,t]}))),f=Object.fromEntries(r.filter((function(e){return e.block})).map((function(e){var t=e.className;return[e.block.end,t]}))),v=0;v0&&e[n-1]===t?e:e.concat(t)};function $e(e,t){var n={};for(var a in e)Object.prototype.hasOwnProperty.call(e,a)&&-1===t.indexOf(a)&&(n[a]=e[a]);return n}var Ye=function(e){function t(){for(var t=this,n=[],a=arguments.length;a--;)n[a]=arguments[a];e.apply(this,n),Re(this,"getThemeDict",(function(e){if(void 0!==t.themeDict&&e.theme===t.prevTheme&&e.language===t.prevLanguage)return t.themeDict;t.prevTheme=e.theme,t.prevLanguage=e.language;var n=e.theme?function(e,t){var n=e.plain,a=Object.create(null),r=e.styles.reduce((function(e,n){var a=n.languages,r=n.style;return a&&!a.includes(t)||n.types.forEach((function(t){var n=We({},e[t],r);e[t]=n})),e}),a);return r.root=n,r.plain=We({},n,{backgroundColor:null}),r}(e.theme,e.language):void 0;return t.themeDict=n})),Re(this,"getLineProps",(function(e){var n=e.key,a=e.className,r=e.style,o=We({},$e(e,["key","className","style","line"]),{className:"token-line",style:void 0,key:void 0}),l=t.getThemeDict(t.props);return void 0!==l&&(o.style=l.plain),void 0!==r&&(o.style=void 0!==o.style?We({},o.style,r):r),void 0!==n&&(o.key=n),a&&(o.className+=" "+a),o})),Re(this,"getStyleForToken",(function(e){var n=e.types,a=e.empty,r=n.length,o=t.getThemeDict(t.props);if(void 0!==o){if(1===r&&"plain"===n[0])return a?{display:"inline-block"}:void 0;if(1===r&&!a)return o[n[0]];var l=a?{display:"inline-block"}:{},i=n.map((function(e){return o[e]}));return Object.assign.apply(Object,[l].concat(i))}})),Re(this,"getTokenProps",(function(e){var n=e.key,a=e.className,r=e.style,o=e.token,l=We({},$e(e,["key","className","style","token"]),{className:"token "+o.types.join(" "),children:o.content,style:t.getStyleForToken(o),key:void 0});return void 0!==r&&(l.style=void 0!==l.style?We({},l.style,r):r),void 0!==n&&(l.key=n),a&&(l.className+=" "+a),l})),Re(this,"tokenize",(function(e,t,n,a){var r={code:t,grammar:n,language:a,tokens:[]};e.hooks.run("before-tokenize",r);var o=r.tokens=e.tokenize(r.code,r.grammar,r.language);return e.hooks.run("after-tokenize",r),o}))}return e&&(t.__proto__=e),t.prototype=Object.create(e&&e.prototype),t.prototype.constructor=t,t.prototype.render=function(){var e=this.props,t=e.Prism,n=e.language,a=e.code,r=e.children,o=this.getThemeDict(this.props),l=t.languages[n];return r({tokens:function(e){for(var t=[[]],n=[e],a=[0],r=[e.length],o=0,l=0,i=[],c=[i];l>-1;){for(;(o=a[l]++)0?u:["plain"],s=d):(u=Ge(u,d.type),d.alias&&(u=Ge(u,d.alias)),s=d.content),"string"==typeof s){var m=s.split(Fe),p=m.length;i.push({types:u,content:m[0]});for(var f=1;f0&&r.getRangeAt(0);t.append(n),n.select(),n.selectionStart=0,n.selectionEnd=e.length;let l=!1;try{l=document.execCommand("copy")}catch{}n.remove(),o&&(r.removeAllRanges(),r.addRange(o)),a&&a.focus()}(t),l(!0),i.current=window.setTimeout((function(){l(!1)}),1e3)}),[t]);return(0,a.useEffect)((function(){return function(){return window.clearTimeout(i.current)}}),[]),a.createElement("button",{type:"button","aria-label":o?(0,p.I)({id:"theme.CodeBlock.copied",message:"Copied",description:"The copied button label on code blocks"}):(0,p.I)({id:"theme.CodeBlock.copyButtonAriaLabel",message:"Copy code to clipboard",description:"The ARIA label for copy code blocks button"}),title:(0,p.I)({id:"theme.CodeBlock.copy",message:"Copy",description:"The copy button label on code blocks"}),className:(0,u.Z)("clean-btn",n,tt.copyButton,o&&tt.copyButtonCopied),onClick:c},a.createElement("span",{className:tt.copyButtonIcons,"aria-hidden":"true"},a.createElement(Ke,{className:tt.copyButtonIcon}),a.createElement(et,{className:tt.copyButtonSuccessIcon})))}function at(e){return a.createElement("svg",(0,m.Z)({viewBox:"0 0 24 24"},e),a.createElement("path",{fill:"currentColor",d:"M4 19h6v-2H4v2zM20 5H4v2h16V5zm-3 6H4v2h13.25c1.1 0 2 .9 2 2s-.9 2-2 2H15v-2l-3 3l3 3v-2h2c2.21 0 4-1.79 4-4s-1.79-4-4-4z"}))}const rt={wordWrapButtonIcon:"wordWrapButtonIcon_Bwma",wordWrapButtonEnabled:"wordWrapButtonEnabled_EoeP"};function ot(e){var t=e.className,n=e.onClick,r=e.isEnabled,o=(0,p.I)({id:"theme.CodeBlock.wordWrapToggle",message:"Toggle word wrap",description:"The title attribute for toggle word wrapping button of code block lines"});return a.createElement("button",{type:"button",onClick:n,className:(0,u.Z)("clean-btn",t,r&&rt.wordWrapButtonEnabled),"aria-label":o,title:o},a.createElement(at,{className:rt.wordWrapButtonIcon,"aria-hidden":"true"}))}function lt(e){var t,n,r,o,l,i,c,s,d,p,f,v=e.children,h=e.className,g=void 0===h?"":h,b=e.metastring,E=e.title,y=e.showLineNumbers,k=e.language,N=(0,q.L)().prism,C=N.defaultLanguage,L=N.magicComments,Z=null!=(t=null!=k?k:null==(n=g.split(" ").find((function(e){return e.startsWith("language-")})))?void 0:n.replace(/language-/,""))?t:C,T=Ze(),w=(r=(0,a.useState)(!1),o=r[0],l=r[1],i=(0,a.useState)(!1),c=i[0],s=i[1],d=(0,a.useRef)(null),p=(0,a.useCallback)((function(){var e=d.current.querySelector("code");o?e.removeAttribute("style"):(e.style.whiteSpace="pre-wrap",e.style.overflowWrap="anywhere"),l((function(e){return!e}))}),[d,o]),f=(0,a.useCallback)((function(){var e=d.current,t=e.scrollWidth>e.clientWidth||d.current.querySelector("code").hasAttribute("style");s(t)}),[d]),ze(d,f),(0,a.useEffect)((function(){f()}),[o,f]),(0,a.useEffect)((function(){return window.addEventListener("resize",f,{passive:!0}),function(){window.removeEventListener("resize",f)}}),[f]),{codeBlockRef:d,isEnabled:o,isCodeScrollable:c,toggle:p}),_=function(e){var t,n;return null!=(t=null==e||null==(n=e.match(xe))?void 0:n.groups.title)?t:""}(b)||E,x=je(v,{metastring:b,language:Z,magicComments:L}),B=x.lineClassNames,O=x.code,H=null!=y?y:function(e){return Boolean(null==e?void 0:e.includes("showLineNumbers"))}(b);return a.createElement(Se,{as:"div",className:(0,u.Z)(g,Z&&!g.includes("language-"+Z)&&"language-"+Z)},_&&a.createElement("div",{className:Me.codeBlockTitle},_),a.createElement("div",{className:Me.codeBlockContent},a.createElement(Je,(0,m.Z)({},De,{theme:T,code:O,language:null!=Z?Z:"text"}),(function(e){var t=e.className,n=e.tokens,r=e.getLineProps,o=e.getTokenProps;return a.createElement("pre",{tabIndex:0,ref:w.codeBlockRef,className:(0,u.Z)(t,Me.codeBlock,"thin-scrollbar")},a.createElement("code",{className:(0,u.Z)(Me.codeBlockLines,H&&Me.codeBlockLinesWithNumbering)},n.map((function(e,t){return a.createElement(Xe,{key:t,line:e,getLineProps:r,getTokenProps:o,classNames:B[t],showLineNumbers:H})}))))})),a.createElement("div",{className:Me.buttonGroup},(w.isEnabled||w.isCodeScrollable)&&a.createElement(ot,{className:Me.codeButton,onClick:function(){return w.toggle()},isEnabled:w.isEnabled}),a.createElement(nt,{className:Me.codeButton,code:O}))))}var it=["children"];function ct(e){var t=e.children,n=(0,H.Z)(e,it),r=(0,Ce.Z)(),o=function(e){return a.Children.toArray(e).some((function(e){return(0,a.isValidElement)(e)}))?e:Array.isArray(e)?e.join(""):e}(t),l="string"==typeof o?lt:Pe;return a.createElement(l,(0,m.Z)({key:String(r)},n),o)}const st={details:"details_lb9f",isBrowser:"isBrowser_bmU9",collapsibleContent:"collapsibleContent_i85q"};var ut=["summary","children"];function dt(e){return!!e&&("SUMMARY"===e.tagName||dt(e.parentElement))}function mt(e,t){return!!e&&(e===t||mt(e.parentElement,t))}function pt(e){var t=e.summary,n=e.children,r=(0,H.Z)(e,ut),o=(0,Ce.Z)(),l=(0,a.useRef)(null),i=(0,F.u)({initialState:!r.open}),c=i.collapsed,s=i.setCollapsed,d=(0,a.useState)(r.open),p=d[0],f=d[1],v=a.isValidElement(t)?t:a.createElement("summary",null,null!=t?t:"Details");return a.createElement("details",(0,m.Z)({},r,{ref:l,open:p,"data-collapsed":c,className:(0,u.Z)(st.details,o&&st.isBrowser,r.className),onMouseDown:function(e){dt(e.target)&&e.detail>1&&e.preventDefault()},onClick:function(e){e.stopPropagation();var t=e.target;dt(t)&&mt(t,l.current)&&(e.preventDefault(),c?(s(!1),f(!0)):s(!0))}}),v,a.createElement(F.z,{lazy:!1,collapsed:c,disableSSRStyle:!0,onCollapseTransitionEnd:function(e){s(e),f(!e)}},a.createElement("div",{className:st.collapsibleContent},n)))}const ft={details:"details_b_Ee"};var vt="alert alert--info";function ht(e){var t=Object.assign({},(function(e){if(null==e)throw new TypeError("Cannot destructure "+e)}(e),e));return a.createElement(pt,(0,m.Z)({},t,{className:(0,u.Z)(vt,ft.details,t.className)}))}function gt(e){return a.createElement(Ee,e)}const bt={containsTaskList:"containsTaskList_mC6p"};function Et(e){if(void 0!==e)return(0,u.Z)(e,(null==e?void 0:e.includes("contains-task-list"))&&bt.containsTaskList)}const yt={img:"img_ev3q"};const kt="admonition_LlT9",Nt="admonitionHeading_tbUL",Ct="admonitionIcon_kALy",Lt="admonitionContent_S0QG";var Zt={note:{infimaClassName:"secondary",iconComponent:function(){return a.createElement("svg",{viewBox:"0 0 14 16"},a.createElement("path",{fillRule:"evenodd",d:"M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"}))},label:a.createElement(p.Z,{id:"theme.admonition.note",description:"The default label used for the Note admonition (:::note)"},"note")},tip:{infimaClassName:"success",iconComponent:function(){return a.createElement("svg",{viewBox:"0 0 12 16"},a.createElement("path",{fillRule:"evenodd",d:"M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"}))},label:a.createElement(p.Z,{id:"theme.admonition.tip",description:"The default label used for the Tip admonition (:::tip)"},"tip")},danger:{infimaClassName:"danger",iconComponent:function(){return a.createElement("svg",{viewBox:"0 0 12 16"},a.createElement("path",{fillRule:"evenodd",d:"M5.05.31c.81 2.17.41 3.38-.52 4.31C3.55 5.67 1.98 6.45.9 7.98c-1.45 2.05-1.7 6.53 3.53 7.7-2.2-1.16-2.67-4.52-.3-6.61-.61 2.03.53 3.33 1.94 2.86 1.39-.47 2.3.53 2.27 1.67-.02.78-.31 1.44-1.13 1.81 3.42-.59 4.78-3.42 4.78-5.56 0-2.84-2.53-3.22-1.25-5.61-1.52.13-2.03 1.13-1.89 2.75.09 1.08-1.02 1.8-1.86 1.33-.67-.41-.66-1.19-.06-1.78C8.18 5.31 8.68 2.45 5.05.32L5.03.3l.02.01z"}))},label:a.createElement(p.Z,{id:"theme.admonition.danger",description:"The default label used for the Danger admonition (:::danger)"},"danger")},info:{infimaClassName:"info",iconComponent:function(){return a.createElement("svg",{viewBox:"0 0 14 16"},a.createElement("path",{fillRule:"evenodd",d:"M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"}))},label:a.createElement(p.Z,{id:"theme.admonition.info",description:"The default label used for the Info admonition (:::info)"},"info")},caution:{infimaClassName:"warning",iconComponent:function(){return a.createElement("svg",{viewBox:"0 0 16 16"},a.createElement("path",{fillRule:"evenodd",d:"M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"}))},label:a.createElement(p.Z,{id:"theme.admonition.caution",description:"The default label used for the Caution admonition (:::caution)"},"caution")}},Tt={secondary:"note",important:"info",success:"tip",warning:"danger"};function wt(e){var t,n=function(e){var t=a.Children.toArray(e),n=t.find((function(e){var t;return a.isValidElement(e)&&"mdxAdmonitionTitle"===(null==(t=e.props)?void 0:t.mdxType)})),r=a.createElement(a.Fragment,null,t.filter((function(e){return e!==n})));return{mdxAdmonitionTitle:n,rest:r}}(e.children),r=n.mdxAdmonitionTitle,o=n.rest;return Object.assign({},e,{title:null!=(t=e.title)?t:r,children:o})}const _t={head:function(e){var t=a.Children.map(e.children,(function(e){return a.isValidElement(e)?function(e){var t;if(null!=(t=e.props)&&t.mdxType&&e.props.originalType){var n=e.props,r=(n.mdxType,n.originalType,(0,H.Z)(n,Ne));return a.createElement(e.props.originalType,r)}return e}(e):e}));return a.createElement(ke.Z,e,t)},code:function(e){var t=["a","abbr","b","br","button","cite","code","del","dfn","em","i","img","input","ins","kbd","label","object","output","q","ruby","s","small","span","strong","sub","sup","time","u","var","wbr"];return a.Children.toArray(e.children).every((function(e){var n;return"string"==typeof e&&!e.includes("\n")||(0,a.isValidElement)(e)&&t.includes(null==(n=e.props)?void 0:n.mdxType)}))?a.createElement("code",e):a.createElement(ct,e)},a:function(e){return a.createElement(f.Z,e)},pre:function(e){var t;return a.createElement(ct,(0,a.isValidElement)(e.children)&&"code"===(null==(t=e.children.props)?void 0:t.originalType)?e.children.props:Object.assign({},e))},details:function(e){var t=a.Children.toArray(e.children),n=t.find((function(e){var t;return a.isValidElement(e)&&"summary"===(null==(t=e.props)?void 0:t.mdxType)})),r=a.createElement(a.Fragment,null,t.filter((function(e){return e!==n})));return a.createElement(ht,(0,m.Z)({},e,{summary:n}),r)},ul:function(e){return a.createElement("ul",(0,m.Z)({},e,{className:Et(e.className)}))},img:function(e){return a.createElement("img",(0,m.Z)({loading:"lazy"},e,{className:(t=e.className,(0,u.Z)(t,yt.img))}));var t},h1:function(e){return a.createElement(gt,(0,m.Z)({as:"h1"},e))},h2:function(e){return a.createElement(gt,(0,m.Z)({as:"h2"},e))},h3:function(e){return a.createElement(gt,(0,m.Z)({as:"h3"},e))},h4:function(e){return a.createElement(gt,(0,m.Z)({as:"h4"},e))},h5:function(e){return a.createElement(gt,(0,m.Z)({as:"h5"},e))},h6:function(e){return a.createElement(gt,(0,m.Z)({as:"h6"},e))},admonition:function(e){var t=wt(e),n=t.children,r=t.type,o=t.title,l=t.icon,i=function(e){var t,n=null!=(t=Tt[e])?t:e,a=Zt[n];return a||(console.warn('No admonition config found for admonition type "'+n+'". Using Info as fallback.'),Zt.info)}(r),c=null!=o?o:i.label,s=i.iconComponent,d=null!=l?l:a.createElement(s,null);return a.createElement("div",{className:(0,u.Z)(y.k.common.admonition,y.k.common.admonitionType(e.type),"alert","alert--"+i.infimaClassName,kt)},a.createElement("div",{className:Nt},a.createElement("span",{className:Ct},d),c),a.createElement("div",{className:Lt},n))},mermaid:n(1875).Z};function xt(e){var t=e.children;return a.createElement(ye.Zo,{components:_t},t)}function Bt(e){var t,n,r,o,l=e.children,i=(t=c(),n=t.metadata,r=t.frontMatter,o=t.contentTitle,r.hide_title||void 0!==o?null:n.title);return a.createElement("div",{className:(0,u.Z)(y.k.docs.docMarkdown,"markdown")},i&&a.createElement("header",null,a.createElement(Ee,{as:"h1"},i)),a.createElement(xt,null,l))}var Ot=n(8425),Ht=n(8596),jt=n(4996);function At(e){return a.createElement("svg",(0,m.Z)({viewBox:"0 0 24 24"},e),a.createElement("path",{d:"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z",fill:"currentColor"}))}const It={breadcrumbHomeIcon:"breadcrumbHomeIcon_YNFT"};function St(){var e=(0,jt.Z)("/");return a.createElement("li",{className:"breadcrumbs__item"},a.createElement(f.Z,{"aria-label":(0,p.I)({id:"theme.docs.breadcrumbs.home",message:"Home page",description:"The ARIA label for the home page in the breadcrumbs"}),className:"breadcrumbs__link",href:e},a.createElement(At,{className:It.breadcrumbHomeIcon})))}const Mt={breadcrumbsContainer:"breadcrumbsContainer_Z_bl"};function Pt(e){var t=e.children,n=e.href,r="breadcrumbs__link";return e.isLast?a.createElement("span",{className:r,itemProp:"name"},t):n?a.createElement(f.Z,{className:r,href:n,itemProp:"item"},a.createElement("span",{itemProp:"name"},t)):a.createElement("span",{className:r},t)}function Ut(e){var t=e.children,n=e.active,r=e.index,o=e.addMicrodata;return a.createElement("li",(0,m.Z)({},o&&{itemScope:!0,itemProp:"itemListElement",itemType:"https://schema.org/ListItem"},{className:(0,u.Z)("breadcrumbs__item",{"breadcrumbs__item--active":n})}),t,a.createElement("meta",{itemProp:"position",content:String(r+1)}))}function zt(){var e=(0,Ot.s1)(),t=(0,Ht.Ns)();return e?a.createElement("nav",{className:(0,u.Z)(y.k.docs.docBreadcrumbs,Mt.breadcrumbsContainer),"aria-label":(0,p.I)({id:"theme.docs.breadcrumbs.navAriaLabel",message:"Breadcrumbs",description:"The ARIA label for the breadcrumbs"})},a.createElement("ul",{className:"breadcrumbs",itemScope:!0,itemType:"https://schema.org/BreadcrumbList"},t&&a.createElement(St,null),e.map((function(t,n){var r=n===e.length-1;return a.createElement(Ut,{key:n,active:r,index:n,addMicrodata:!!t.href},a.createElement(Pt,{href:t.href,isLast:r},t.label))})))):null}const Vt={docItemContainer:"docItemContainer_Djhp",docItemCol:"docItemCol_VOVn"};function Dt(e){var t,n,r,o,l,i,s=e.children,m=(t=c(),n=t.frontMatter,r=t.toc,o=(0,d.i)(),l=n.hide_table_of_contents,i=!l&&r.length>0,{hidden:l,mobile:i?a.createElement(ue,null):void 0,desktop:!i||"desktop"!==o&&"ssr"!==o?void 0:a.createElement(he,null)});return a.createElement("div",{className:"row"},a.createElement("div",{className:(0,u.Z)("col",!m.hidden&&Vt.docItemCol)},a.createElement(w,null),a.createElement("div",{className:Vt.docItemContainer},a.createElement("article",null,a.createElement(zt,null),a.createElement(_,null),m.mobile,a.createElement(Bt,null,s),a.createElement(W,null)),a.createElement(g,null))),m.desktop&&a.createElement("div",{className:"col col--3"},m.desktop))}function Rt(e){var t="docs-doc-id-"+e.content.metadata.unversionedId,n=e.content;return a.createElement(i,{content:e.content},a.createElement(r.FG,{className:t},a.createElement(s,null),a.createElement(Dt,null,a.createElement(n,null))))}},4477:(e,t,n)=>{"use strict";n.d(t,{E:()=>i,q:()=>l});var a=n(7294),r=n(9688),o=a.createContext(null);function l(e){var t=e.children,n=e.version;return a.createElement(o.Provider,{value:n},t)}function i(){var e=(0,a.useContext)(o);if(null===e)throw new r.i6("DocsVersionProvider");return e}},7594:(e,t)=>{function n(e){let t,n=[];for(let a of e.split(",").map((e=>e.trim())))if(/^-?\d+$/.test(a))n.push(parseInt(a,10));else if(t=a.match(/^(-?\d+)(-|\.\.\.?|\u2025|\u2026|\u22EF)(-?\d+)$/)){let[e,a,r,o]=t;if(a&&o){a=parseInt(a),o=parseInt(o);const e=a{t.d(n,{Zo:()=>m,kt:()=>c});var i=t(7294);function p(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function l(e){for(var n=1;n=0||(p[t]=e[t]);return p}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(p[t]=e[t])}return p}var s=i.createContext({}),o=function(e){var n=i.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},m=function(e){var n=o(e.components);return i.createElement(s.Provider,{value:n},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},u=i.forwardRef((function(e,n){var t=e.components,p=e.mdxType,a=e.originalType,s=e.parentName,m=r(e,["components","mdxType","originalType","parentName"]),d=o(t),u=p,c=d["".concat(s,".").concat(u)]||d[u]||k[u]||a;return t?i.createElement(c,l(l({ref:n},m),{},{components:t})):i.createElement(c,l({ref:n},m))}));function c(e,n){var t=arguments,p=n&&n.mdxType;if("string"==typeof e||p){var a=t.length,l=new Array(a);l[0]=u;var r={};for(var s in n)hasOwnProperty.call(n,s)&&(r[s]=n[s]);r.originalType=e,r[d]="string"==typeof e?e:p,l[1]=r;for(var o=2;o{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>s,default:()=>c,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=t(7462),p=t(3366),a=(t(7294),t(3905)),l=["components"],r={id:"openbim_components.SimplePlane",title:"Class: SimplePlane",sidebar_label:"SimplePlane",custom_edit_url:null},s=void 0,o={unversionedId:"api/classes/openbim_components.SimplePlane",id:"api/classes/openbim_components.SimplePlane",title:"Class: SimplePlane",description:"openbim-components.SimplePlane",source:"@site/docs/api/classes/openbim_components.SimplePlane.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.SimplePlane",permalink:"/api/classes/openbim_components.SimplePlane",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.SimplePlane",title:"Class: SimplePlane",sidebar_label:"SimplePlane",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"SimpleGrid",permalink:"/api/classes/openbim_components.SimpleGrid"},next:{title:"SimpleRaycaster",permalink:"/api/classes/openbim_components.SimpleRaycaster"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"onDraggingEnded",id:"ondraggingended",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"onDraggingStarted",id:"ondraggingstarted",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Accessors",id:"accessors",level:2},{value:"enabled",id:"enabled",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"meshes",id:"meshes",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"planeMaterial",id:"planematerial",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"visible",id:"visible",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"update",id:"update",level:3},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-21",level:4}],k={toc:d},u="wrapper";function c(e){var n=e.components,t=(0,p.Z)(e,l);return(0,a.kt)(u,(0,i.Z)({},k,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".SimplePlane"),(0,a.kt)("p",null,"Each of the planes created by ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),"."),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,a.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"THREE.Plane"),">"),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"SimplePlane"))),(0,a.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.EdgesPlane"},(0,a.kt)("inlineCode",{parentName:"a"},"EdgesPlane"))))),(0,a.kt)("h2",{id:"implements"},"Implements"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,a.kt)("inlineCode",{parentName:"a"},"Disposable"))),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Hideable"},(0,a.kt)("inlineCode",{parentName:"a"},"Hideable")))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"SimplePlane"')),(0,a.kt)("p",null,"Component.name"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L14"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:14")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,a.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"undefined"),">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,a.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L23"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:23")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ondraggingended"},"onDraggingEnded"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"onDraggingEnded"),": ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,a.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("p",null,"Event that fires when the user stops dragging a clipping plane."),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L20"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:20")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ondraggingstarted"},"onDraggingStarted"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"onDraggingStarted"),": ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,a.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("p",null,"Event that fires when the user starts dragging a clipping plane."),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L17"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:17")),(0,a.kt)("h2",{id:"accessors"},"Accessors"),(0,a.kt)("h3",{id:"enabled"},"enabled"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"enabled"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"Component.enabled"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L47"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:47")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"enabled"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"state"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"state")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"overrides-1"},"Overrides"),(0,a.kt)("p",null,"Component.enabled"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L52"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:52")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"meshes"},"meshes"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"meshes"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,a.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,a.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">","[]"),(0,a.kt)("p",null,"The meshes used for raycasting"),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,a.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,a.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">","[]"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L71"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:71")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"planematerial"},"planeMaterial"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"planeMaterial"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"Material"),"[]"),(0,a.kt)("p",null,"The material of the clipping plane representation."),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"Material"),"[]"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L76"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:76")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"planeMaterial"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"material"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"The material of the clipping plane representation."),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"material")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"Material"),"[]")))),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L81"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:81")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"size"},"size"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"size"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The size of the clipping plane representation."),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L86"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:86")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"size"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"size"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"Sets the size of the clipping plane representation."),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"size")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L91"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:91")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"visible"},"visible"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"visible"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,a.kt)("h4",{id:"returns-7"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),".",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"visible")),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L58"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:58")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"visible"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"state"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,a.kt)("h4",{id:"parameters-3"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"state")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,a.kt)("h4",{id:"returns-8"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),".",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"visible")),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L63"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:63")),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"dispose"},"dispose"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,a.kt)("h4",{id:"returns-9"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L142"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:142")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"get"},"get"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"get"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Plane")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,a.kt)("h4",{id:"returns-10"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Plane")),(0,a.kt)("h4",{id:"overrides-2"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,a.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L137"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:137")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"hasui"},"hasUI"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,a.kt)("p",null,"Whether is component implements any kind of ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,a.kt)("h4",{id:"returns-11"},"Returns"),(0,a.kt)("p",null,"this is UI"),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,a.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,a.kt)("h4",{id:"returns-12"},"Returns"),(0,a.kt)("p",null,"this is Configurable"),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,a.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,a.kt)("h4",{id:"returns-13"},"Returns"),(0,a.kt)("p",null,"this is Disposable"),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,a.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ishideable"},"isHideable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,a.kt)("h4",{id:"returns-14"},"Returns"),(0,a.kt)("p",null,"this is Hideable"),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,a.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,a.kt)("h4",{id:"returns-15"},"Returns"),(0,a.kt)("p",null,"this is Resizeable"),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,a.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,a.kt)("h4",{id:"returns-16"},"Returns"),(0,a.kt)("p",null,"this is Updateable"),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,a.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"update"},"update"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"update"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"Updateable.update")),(0,a.kt)("h4",{id:"returns-17"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L128"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:128")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/18ed70ed.eb9ba53d.js b/build/assets/js/18ed70ed.eb9ba53d.js new file mode 100644 index 00000000..5c622c01 --- /dev/null +++ b/build/assets/js/18ed70ed.eb9ba53d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5229],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>c});var i=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function p(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function l(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=i.createContext({}),o=function(e){var n=i.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},m=function(e){var n=o(e.components);return i.createElement(s.Provider,{value:n},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},u=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,p=e.originalType,s=e.parentName,m=r(e,["components","mdxType","originalType","parentName"]),d=o(t),u=a,c=d["".concat(s,".").concat(u)]||d[u]||k[u]||p;return t?i.createElement(c,l(l({ref:n},m),{},{components:t})):i.createElement(c,l({ref:n},m))}));function c(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var p=t.length,l=new Array(p);l[0]=u;var r={};for(var s in n)hasOwnProperty.call(n,s)&&(r[s]=n[s]);r.originalType=e,r[d]="string"==typeof e?e:a,l[1]=r;for(var o=2;o{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>s,default:()=>c,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=t(7462),a=t(3366),p=(t(7294),t(3905)),l=["components"],r={id:"openbim_components.SimplePlane",title:"Class: SimplePlane",sidebar_label:"SimplePlane",custom_edit_url:null},s=void 0,o={unversionedId:"api/classes/openbim_components.SimplePlane",id:"api/classes/openbim_components.SimplePlane",title:"Class: SimplePlane",description:"openbim-components.SimplePlane",source:"@site/docs/api/classes/openbim_components.SimplePlane.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.SimplePlane",permalink:"/api/classes/openbim_components.SimplePlane",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.SimplePlane",title:"Class: SimplePlane",sidebar_label:"SimplePlane",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"SimpleGrid",permalink:"/api/classes/openbim_components.SimpleGrid"},next:{title:"SimpleRaycaster",permalink:"/api/classes/openbim_components.SimpleRaycaster"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"onDraggingEnded",id:"ondraggingended",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"onDraggingStarted",id:"ondraggingstarted",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Accessors",id:"accessors",level:2},{value:"enabled",id:"enabled",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"meshes",id:"meshes",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"planeMaterial",id:"planematerial",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"visible",id:"visible",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"update",id:"update",level:3},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-21",level:4}],k={toc:d},u="wrapper";function c(e){var n=e.components,t=(0,a.Z)(e,l);return(0,p.kt)(u,(0,i.Z)({},k,t,{components:n,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".SimplePlane"),(0,p.kt)("p",null,"Each of the planes created by ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),"."),(0,p.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("p",{parentName:"li"},(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,p.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"THREE.Plane"),">"),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"SimplePlane"))),(0,p.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.EdgesPlane"},(0,p.kt)("inlineCode",{parentName:"a"},"EdgesPlane"))))),(0,p.kt)("h2",{id:"implements"},"Implements"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,p.kt)("inlineCode",{parentName:"a"},"Disposable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Hideable"},(0,p.kt)("inlineCode",{parentName:"a"},"Hideable")))),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"name"},"name"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"name"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,p.kt)("inlineCode",{parentName:"p"},'"SimplePlane"')),(0,p.kt)("p",null,"Component.name"),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L14"},"src/core/SimpleClipper/simple-plane.ts:14")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"undefined"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,p.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L23"},"src/core/SimpleClipper/simple-plane.ts:23")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ondraggingended"},"onDraggingEnded"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onDraggingEnded"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,"Event that fires when the user stops dragging a clipping plane."),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L20"},"src/core/SimpleClipper/simple-plane.ts:20")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ondraggingstarted"},"onDraggingStarted"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onDraggingStarted"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,"Event that fires when the user starts dragging a clipping plane."),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L17"},"src/core/SimpleClipper/simple-plane.ts:17")),(0,p.kt)("h2",{id:"accessors"},"Accessors"),(0,p.kt)("h3",{id:"enabled"},"enabled"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"enabled"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,p.kt)("h4",{id:"returns"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("h4",{id:"overrides"},"Overrides"),(0,p.kt)("p",null,"Component.enabled"),(0,p.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L47"},"src/core/SimpleClipper/simple-plane.ts:47")),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"enabled"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"state"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,p.kt)("h4",{id:"parameters"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"state")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,p.kt)("h4",{id:"returns-1"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"overrides-1"},"Overrides"),(0,p.kt)("p",null,"Component.enabled"),(0,p.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L52"},"src/core/SimpleClipper/simple-plane.ts:52")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"meshes"},"meshes"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"meshes"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,p.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,p.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">","[]"),(0,p.kt)("p",null,"The meshes used for raycasting"),(0,p.kt)("h4",{id:"returns-2"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,p.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,p.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">","[]"),(0,p.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L71"},"src/core/SimpleClipper/simple-plane.ts:71")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"planematerial"},"planeMaterial"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"planeMaterial"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"Material"),"[]"),(0,p.kt)("p",null,"The material of the clipping plane representation."),(0,p.kt)("h4",{id:"returns-3"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"Material"),"[]"),(0,p.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L76"},"src/core/SimpleClipper/simple-plane.ts:76")),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"planeMaterial"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"material"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,"The material of the clipping plane representation."),(0,p.kt)("h4",{id:"parameters-1"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"material")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"td"},"Material"),"[]")))),(0,p.kt)("h4",{id:"returns-4"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L81"},"src/core/SimpleClipper/simple-plane.ts:81")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"size"},"size"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"size"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"number")),(0,p.kt)("p",null,"The size of the clipping plane representation."),(0,p.kt)("h4",{id:"returns-5"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"number")),(0,p.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L86"},"src/core/SimpleClipper/simple-plane.ts:86")),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"size"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"size"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,"Sets the size of the clipping plane representation."),(0,p.kt)("h4",{id:"parameters-2"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"size")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"number"))))),(0,p.kt)("h4",{id:"returns-6"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L91"},"src/core/SimpleClipper/simple-plane.ts:91")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"visible"},"visible"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"visible"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,p.kt)("h4",{id:"returns-7"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"visible")),(0,p.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L58"},"src/core/SimpleClipper/simple-plane.ts:58")),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"visible"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"state"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,p.kt)("h4",{id:"parameters-3"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"state")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,p.kt)("h4",{id:"returns-8"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"visible")),(0,p.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L63"},"src/core/SimpleClipper/simple-plane.ts:63")),(0,p.kt)("h2",{id:"methods"},"Methods"),(0,p.kt)("h3",{id:"dispose"},"dispose"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,p.kt)("h4",{id:"returns-9"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,p.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L152"},"src/core/SimpleClipper/simple-plane.ts:152")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"get"},"get"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"get"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Plane")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,p.kt)("h4",{id:"returns-10"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Plane")),(0,p.kt)("h4",{id:"overrides-2"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,p.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L147"},"src/core/SimpleClipper/simple-plane.ts:147")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"hasui"},"hasUI"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,p.kt)("p",null,"Whether is component implements any kind of ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,p.kt)("h4",{id:"returns-11"},"Returns"),(0,p.kt)("p",null,"this is UI"),(0,p.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,p.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,p.kt)("h4",{id:"returns-12"},"Returns"),(0,p.kt)("p",null,"this is Configurable"),(0,p.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,p.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,p.kt)("h4",{id:"returns-13"},"Returns"),(0,p.kt)("p",null,"this is Disposable"),(0,p.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,p.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ishideable"},"isHideable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,p.kt)("h4",{id:"returns-14"},"Returns"),(0,p.kt)("p",null,"this is Hideable"),(0,p.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,p.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,p.kt)("h4",{id:"returns-15"},"Returns"),(0,p.kt)("p",null,"this is Resizeable"),(0,p.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,p.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,p.kt)("h4",{id:"returns-16"},"Returns"),(0,p.kt)("p",null,"this is Updateable"),(0,p.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,p.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"update"},"update"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"update"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"Updateable.update")),(0,p.kt)("h4",{id:"returns-17"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L138"},"src/core/SimpleClipper/simple-plane.ts:138")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/18f6f55e.c4ce0417.js b/build/assets/js/18f6f55e.c4ce0417.js new file mode 100644 index 00000000..2ef9ca49 --- /dev/null +++ b/build/assets/js/18f6f55e.c4ce0417.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3116],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>h});var i=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function l(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function p(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=i.createContext({}),o=function(e){var n=i.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):p(p({},n),e)),t},d=function(e){var n=o(e.components);return i.createElement(s.Provider,{value:n},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},u=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,l=e.originalType,s=e.parentName,d=r(e,["components","mdxType","originalType","parentName"]),m=o(t),u=a,h=m["".concat(s,".").concat(u)]||m[u]||k[u]||l;return t?i.createElement(h,p(p({ref:n},d),{},{components:t})):i.createElement(h,p({ref:n},d))}));function h(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var l=t.length,p=new Array(l);p[0]=u;var r={};for(var s in n)hasOwnProperty.call(n,s)&&(r[s]=n[s]);r.originalType=e,r[m]="string"==typeof e?e:a,p[1]=r;for(var o=2;o{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>m});var i=t(7462),a=t(3366),l=(t(7294),t(3905)),p=["components"],r={id:"openbim_components.EdgesPlane",title:"Class: EdgesPlane",sidebar_label:"EdgesPlane",custom_edit_url:null},s=void 0,o={unversionedId:"api/classes/openbim_components.EdgesPlane",id:"api/classes/openbim_components.EdgesPlane",title:"Class: EdgesPlane",description:"openbim-components.EdgesPlane",source:"@site/docs/api/classes/openbim_components.EdgesPlane.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.EdgesPlane",permalink:"/api/classes/openbim_components.EdgesPlane",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.EdgesPlane",title:"Class: EdgesPlane",sidebar_label:"EdgesPlane",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"EdgesClipper",permalink:"/api/classes/openbim_components.EdgesClipper"},next:{title:"Event",permalink:"/api/classes/openbim_components.Event"}},d={},m=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"edgesMaxUpdateRate",id:"edgesmaxupdaterate",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onDraggingEnded",id:"ondraggingended",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"onDraggingStarted",id:"ondraggingstarted",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Accessors",id:"accessors",level:2},{value:"enabled",id:"enabled",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"meshes",id:"meshes",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"planeMaterial",id:"planematerial",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"visible",id:"visible",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"setEnabled",id:"setenabled",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"update",id:"update",level:3},{value:"Returns",id:"returns-18",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-23",level:4}],k={toc:m},u="wrapper";function h(e){var n=e.components,t=(0,a.Z)(e,p);return(0,l.kt)(u,(0,i.Z)({},k,t,{components:n,mdxType:"MDXLayout"}),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".EdgesPlane"),(0,l.kt)("p",null,"A more advanced version of ",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper")," that also includes\nClippingEdges with customizable lines."),(0,l.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},(0,l.kt)("inlineCode",{parentName:"a"},"SimplePlane"))),(0,l.kt)("p",{parentName:"li"},"\u21b3 ",(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"EdgesPlane"))))),(0,l.kt)("h2",{id:"properties"},"Properties"),(0,l.kt)("h3",{id:"edgesmaxupdaterate"},"edgesMaxUpdateRate"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"edgesMaxUpdateRate"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,l.kt)("inlineCode",{parentName:"p"},"50")),(0,l.kt)("p",null,"The max rate in milliseconds at which edges can be regenerated.\nTo disable this behaviour set this to 0."),(0,l.kt)("h4",{id:"defined-in"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/EdgesClipper/src/edges-plane.ts#L17"},"src/navigation/EdgesClipper/src/edges-plane.ts:17")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"name"},"name"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"name"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,l.kt)("inlineCode",{parentName:"p"},'"SimplePlane"')),(0,l.kt)("p",null,"Component.name"),(0,l.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#name"},"name")),(0,l.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L14"},"src/core/SimpleClipper/simple-plane.ts:14")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,l.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,l.kt)("inlineCode",{parentName:"p"},"undefined"),">"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,l.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#ondisposed"},"onDisposed")),(0,l.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L23"},"src/core/SimpleClipper/simple-plane.ts:23")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"ondraggingended"},"onDraggingEnded"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"onDraggingEnded"),": ",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,l.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("p",null,"Event that fires when the user stops dragging a clipping plane."),(0,l.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#ondraggingended"},"onDraggingEnded")),(0,l.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L20"},"src/core/SimpleClipper/simple-plane.ts:20")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"ondraggingstarted"},"onDraggingStarted"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"onDraggingStarted"),": ",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,l.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("p",null,"Event that fires when the user starts dragging a clipping plane."),(0,l.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#ondraggingstarted"},"onDraggingStarted")),(0,l.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L17"},"src/core/SimpleClipper/simple-plane.ts:17")),(0,l.kt)("h2",{id:"accessors"},"Accessors"),(0,l.kt)("h3",{id:"enabled"},"enabled"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"enabled"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,l.kt)("h4",{id:"returns"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"overrides"},"Overrides"),(0,l.kt)("p",null,"SimplePlane.enabled"),(0,l.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/EdgesClipper/src/edges-plane.ts#L43"},"src/navigation/EdgesClipper/src/edges-plane.ts:43")),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"set")," ",(0,l.kt)("strong",{parentName:"p"},"enabled"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"state"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,l.kt)("h4",{id:"parameters"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"state")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,l.kt)("h4",{id:"returns-1"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"overrides-1"},"Overrides"),(0,l.kt)("p",null,"SimplePlane.enabled"),(0,l.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/EdgesClipper/src/edges-plane.ts#L37"},"src/navigation/EdgesClipper/src/edges-plane.ts:37")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"meshes"},"meshes"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"meshes"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,l.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,l.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">","[]"),(0,l.kt)("p",null,"The meshes used for raycasting"),(0,l.kt)("h4",{id:"returns-2"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,l.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,l.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">","[]"),(0,l.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,l.kt)("p",null,"SimplePlane.meshes"),(0,l.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L71"},"src/core/SimpleClipper/simple-plane.ts:71")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"planematerial"},"planeMaterial"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"planeMaterial"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Material"),"[]"),(0,l.kt)("p",null,"The material of the clipping plane representation."),(0,l.kt)("h4",{id:"returns-3"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Material"),"[]"),(0,l.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,l.kt)("p",null,"SimplePlane.planeMaterial"),(0,l.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L76"},"src/core/SimpleClipper/simple-plane.ts:76")),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"set")," ",(0,l.kt)("strong",{parentName:"p"},"planeMaterial"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"material"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("p",null,"The material of the clipping plane representation."),(0,l.kt)("h4",{id:"parameters-1"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"material")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"Material"),"[]")))),(0,l.kt)("h4",{id:"returns-4"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,l.kt)("p",null,"SimplePlane.planeMaterial"),(0,l.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L81"},"src/core/SimpleClipper/simple-plane.ts:81")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"size"},"size"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"size"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"The size of the clipping plane representation."),(0,l.kt)("h4",{id:"returns-5"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,l.kt)("p",null,"SimplePlane.size"),(0,l.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L86"},"src/core/SimpleClipper/simple-plane.ts:86")),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"set")," ",(0,l.kt)("strong",{parentName:"p"},"size"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"size"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("p",null,"Sets the size of the clipping plane representation."),(0,l.kt)("h4",{id:"parameters-2"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"size")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"number"))))),(0,l.kt)("h4",{id:"returns-6"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,l.kt)("p",null,"SimplePlane.size"),(0,l.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L91"},"src/core/SimpleClipper/simple-plane.ts:91")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"visible"},"visible"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"visible"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,l.kt)("h4",{id:"returns-7"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,l.kt)("p",null,"SimplePlane.visible"),(0,l.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L58"},"src/core/SimpleClipper/simple-plane.ts:58")),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"set")," ",(0,l.kt)("strong",{parentName:"p"},"visible"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"state"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,l.kt)("h4",{id:"parameters-3"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"state")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,l.kt)("h4",{id:"returns-8"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,l.kt)("p",null,"SimplePlane.visible"),(0,l.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L63"},"src/core/SimpleClipper/simple-plane.ts:63")),(0,l.kt)("h2",{id:"methods"},"Methods"),(0,l.kt)("h3",{id:"dispose"},"dispose"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,l.kt)("h4",{id:"returns-9"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("h4",{id:"overrides-2"},"Overrides"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#dispose"},"dispose")),(0,l.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/EdgesClipper/src/edges-plane.ts#L48"},"src/navigation/EdgesClipper/src/edges-plane.ts:48")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"get"},"get"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"get"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Plane")),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,l.kt)("h4",{id:"returns-10"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Plane")),(0,l.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#get"},"get")),(0,l.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/simple-plane.ts#L147"},"src/core/SimpleClipper/simple-plane.ts:147")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"hasui"},"hasUI"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,l.kt)("p",null,"Whether is component implements any kind of ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,l.kt)("h4",{id:"returns-11"},"Returns"),(0,l.kt)("p",null,"this is UI"),(0,l.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#hasui"},"hasUI")),(0,l.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,l.kt)("p",null,"Whether is component is ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,l.kt)("h4",{id:"returns-12"},"Returns"),(0,l.kt)("p",null,"this is Configurable"),(0,l.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#isconfigurable"},"isConfigurable")),(0,l.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,l.kt)("p",null,"Whether is component is ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,l.kt)("h4",{id:"returns-13"},"Returns"),(0,l.kt)("p",null,"this is Disposable"),(0,l.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#isdisposeable"},"isDisposeable")),(0,l.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"ishideable"},"isHideable"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,l.kt)("p",null,"Whether is component is ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,l.kt)("h4",{id:"returns-14"},"Returns"),(0,l.kt)("p",null,"this is Hideable"),(0,l.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#ishideable"},"isHideable")),(0,l.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,l.kt)("p",null,"Whether is component is ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,l.kt)("h4",{id:"returns-15"},"Returns"),(0,l.kt)("p",null,"this is Resizeable"),(0,l.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#isresizeable"},"isResizeable")),(0,l.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,l.kt)("p",null,"Whether is component is ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,l.kt)("h4",{id:"returns-16"},"Returns"),(0,l.kt)("p",null,"this is Updateable"),(0,l.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#isupdateable"},"isUpdateable")),(0,l.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"setenabled"},"setEnabled"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"setEnabled"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"state"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,l.kt)("h4",{id:"parameters-4"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"state")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,l.kt)("h4",{id:"returns-17"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/EdgesClipper/src/edges-plane.ts#L54"},"src/navigation/EdgesClipper/src/edges-plane.ts:54")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"update"},"update"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"update"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"Updateable.update")),(0,l.kt)("h4",{id:"returns-18"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("h4",{id:"overrides-3"},"Overrides"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#update"},"update")),(0,l.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/EdgesClipper/src/edges-plane.ts#L76"},"src/navigation/EdgesClipper/src/edges-plane.ts:76")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/18f6f55e.fbb4ca61.js b/build/assets/js/18f6f55e.fbb4ca61.js deleted file mode 100644 index 659b4ed1..00000000 --- a/build/assets/js/18f6f55e.fbb4ca61.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3116],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>h});var i=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function l(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function p(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=i.createContext({}),o=function(e){var n=i.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):p(p({},n),e)),t},d=function(e){var n=o(e.components);return i.createElement(s.Provider,{value:n},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},u=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,l=e.originalType,s=e.parentName,d=r(e,["components","mdxType","originalType","parentName"]),m=o(t),u=a,h=m["".concat(s,".").concat(u)]||m[u]||k[u]||l;return t?i.createElement(h,p(p({ref:n},d),{},{components:t})):i.createElement(h,p({ref:n},d))}));function h(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var l=t.length,p=new Array(l);p[0]=u;var r={};for(var s in n)hasOwnProperty.call(n,s)&&(r[s]=n[s]);r.originalType=e,r[m]="string"==typeof e?e:a,p[1]=r;for(var o=2;o{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>m});var i=t(7462),a=t(3366),l=(t(7294),t(3905)),p=["components"],r={id:"openbim_components.EdgesPlane",title:"Class: EdgesPlane",sidebar_label:"EdgesPlane",custom_edit_url:null},s=void 0,o={unversionedId:"api/classes/openbim_components.EdgesPlane",id:"api/classes/openbim_components.EdgesPlane",title:"Class: EdgesPlane",description:"openbim-components.EdgesPlane",source:"@site/docs/api/classes/openbim_components.EdgesPlane.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.EdgesPlane",permalink:"/api/classes/openbim_components.EdgesPlane",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.EdgesPlane",title:"Class: EdgesPlane",sidebar_label:"EdgesPlane",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"EdgesClipper",permalink:"/api/classes/openbim_components.EdgesClipper"},next:{title:"Event",permalink:"/api/classes/openbim_components.Event"}},d={},m=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"edgesMaxUpdateRate",id:"edgesmaxupdaterate",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onDraggingEnded",id:"ondraggingended",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"onDraggingStarted",id:"ondraggingstarted",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Accessors",id:"accessors",level:2},{value:"enabled",id:"enabled",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"meshes",id:"meshes",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"planeMaterial",id:"planematerial",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"visible",id:"visible",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"setEnabled",id:"setenabled",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"update",id:"update",level:3},{value:"Returns",id:"returns-18",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-23",level:4}],k={toc:m},u="wrapper";function h(e){var n=e.components,t=(0,a.Z)(e,p);return(0,l.kt)(u,(0,i.Z)({},k,t,{components:n,mdxType:"MDXLayout"}),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".EdgesPlane"),(0,l.kt)("p",null,"A more advanced version of ",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper")," that also includes\nClippingEdges with customizable lines."),(0,l.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},(0,l.kt)("inlineCode",{parentName:"a"},"SimplePlane"))),(0,l.kt)("p",{parentName:"li"},"\u21b3 ",(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"EdgesPlane"))))),(0,l.kt)("h2",{id:"properties"},"Properties"),(0,l.kt)("h3",{id:"edgesmaxupdaterate"},"edgesMaxUpdateRate"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"edgesMaxUpdateRate"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,l.kt)("inlineCode",{parentName:"p"},"50")),(0,l.kt)("p",null,"The max rate in milliseconds at which edges can be regenerated.\nTo disable this behaviour set this to 0."),(0,l.kt)("h4",{id:"defined-in"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/EdgesClipper/src/edges-plane.ts#L17"},"temp/engine_components/src/navigation/EdgesClipper/src/edges-plane.ts:17")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"name"},"name"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"name"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,l.kt)("inlineCode",{parentName:"p"},'"SimplePlane"')),(0,l.kt)("p",null,"Component.name"),(0,l.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#name"},"name")),(0,l.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L14"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:14")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,l.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,l.kt)("inlineCode",{parentName:"p"},"undefined"),">"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,l.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#ondisposed"},"onDisposed")),(0,l.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L23"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:23")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"ondraggingended"},"onDraggingEnded"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"onDraggingEnded"),": ",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,l.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("p",null,"Event that fires when the user stops dragging a clipping plane."),(0,l.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#ondraggingended"},"onDraggingEnded")),(0,l.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L20"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:20")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"ondraggingstarted"},"onDraggingStarted"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"onDraggingStarted"),": ",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,l.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("p",null,"Event that fires when the user starts dragging a clipping plane."),(0,l.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#ondraggingstarted"},"onDraggingStarted")),(0,l.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L17"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:17")),(0,l.kt)("h2",{id:"accessors"},"Accessors"),(0,l.kt)("h3",{id:"enabled"},"enabled"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"enabled"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,l.kt)("h4",{id:"returns"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"overrides"},"Overrides"),(0,l.kt)("p",null,"SimplePlane.enabled"),(0,l.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/EdgesClipper/src/edges-plane.ts#L43"},"temp/engine_components/src/navigation/EdgesClipper/src/edges-plane.ts:43")),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"set")," ",(0,l.kt)("strong",{parentName:"p"},"enabled"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"state"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,l.kt)("h4",{id:"parameters"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"state")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,l.kt)("h4",{id:"returns-1"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"overrides-1"},"Overrides"),(0,l.kt)("p",null,"SimplePlane.enabled"),(0,l.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/EdgesClipper/src/edges-plane.ts#L37"},"temp/engine_components/src/navigation/EdgesClipper/src/edges-plane.ts:37")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"meshes"},"meshes"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"meshes"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,l.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,l.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">","[]"),(0,l.kt)("p",null,"The meshes used for raycasting"),(0,l.kt)("h4",{id:"returns-2"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,l.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,l.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">","[]"),(0,l.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,l.kt)("p",null,"SimplePlane.meshes"),(0,l.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L71"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:71")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"planematerial"},"planeMaterial"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"planeMaterial"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Material"),"[]"),(0,l.kt)("p",null,"The material of the clipping plane representation."),(0,l.kt)("h4",{id:"returns-3"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Material"),"[]"),(0,l.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,l.kt)("p",null,"SimplePlane.planeMaterial"),(0,l.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L76"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:76")),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"set")," ",(0,l.kt)("strong",{parentName:"p"},"planeMaterial"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"material"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("p",null,"The material of the clipping plane representation."),(0,l.kt)("h4",{id:"parameters-1"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"material")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"Material"),"[]")))),(0,l.kt)("h4",{id:"returns-4"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,l.kt)("p",null,"SimplePlane.planeMaterial"),(0,l.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L81"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:81")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"size"},"size"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"size"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("p",null,"The size of the clipping plane representation."),(0,l.kt)("h4",{id:"returns-5"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,l.kt)("p",null,"SimplePlane.size"),(0,l.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L86"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:86")),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"set")," ",(0,l.kt)("strong",{parentName:"p"},"size"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"size"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("p",null,"Sets the size of the clipping plane representation."),(0,l.kt)("h4",{id:"parameters-2"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"size")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"number"))))),(0,l.kt)("h4",{id:"returns-6"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,l.kt)("p",null,"SimplePlane.size"),(0,l.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L91"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:91")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"visible"},"visible"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"visible"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,l.kt)("h4",{id:"returns-7"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,l.kt)("p",null,"SimplePlane.visible"),(0,l.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L58"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:58")),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"set")," ",(0,l.kt)("strong",{parentName:"p"},"visible"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"state"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,l.kt)("h4",{id:"parameters-3"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"state")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,l.kt)("h4",{id:"returns-8"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,l.kt)("p",null,"SimplePlane.visible"),(0,l.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L63"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:63")),(0,l.kt)("h2",{id:"methods"},"Methods"),(0,l.kt)("h3",{id:"dispose"},"dispose"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,l.kt)("h4",{id:"returns-9"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("h4",{id:"overrides-2"},"Overrides"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#dispose"},"dispose")),(0,l.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/EdgesClipper/src/edges-plane.ts#L48"},"temp/engine_components/src/navigation/EdgesClipper/src/edges-plane.ts:48")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"get"},"get"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"get"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Plane")),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,l.kt)("h4",{id:"returns-10"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Plane")),(0,l.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#get"},"get")),(0,l.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/simple-plane.ts#L137"},"temp/engine_components/src/core/SimpleClipper/simple-plane.ts:137")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"hasui"},"hasUI"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,l.kt)("p",null,"Whether is component implements any kind of ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,l.kt)("h4",{id:"returns-11"},"Returns"),(0,l.kt)("p",null,"this is UI"),(0,l.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#hasui"},"hasUI")),(0,l.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,l.kt)("p",null,"Whether is component is ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,l.kt)("h4",{id:"returns-12"},"Returns"),(0,l.kt)("p",null,"this is Configurable"),(0,l.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#isconfigurable"},"isConfigurable")),(0,l.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,l.kt)("p",null,"Whether is component is ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,l.kt)("h4",{id:"returns-13"},"Returns"),(0,l.kt)("p",null,"this is Disposable"),(0,l.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#isdisposeable"},"isDisposeable")),(0,l.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"ishideable"},"isHideable"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,l.kt)("p",null,"Whether is component is ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,l.kt)("h4",{id:"returns-14"},"Returns"),(0,l.kt)("p",null,"this is Hideable"),(0,l.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#ishideable"},"isHideable")),(0,l.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,l.kt)("p",null,"Whether is component is ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,l.kt)("h4",{id:"returns-15"},"Returns"),(0,l.kt)("p",null,"this is Resizeable"),(0,l.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#isresizeable"},"isResizeable")),(0,l.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,l.kt)("p",null,"Whether is component is ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,l.kt)("h4",{id:"returns-16"},"Returns"),(0,l.kt)("p",null,"this is Updateable"),(0,l.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#isupdateable"},"isUpdateable")),(0,l.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"setenabled"},"setEnabled"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"setEnabled"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"state"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,l.kt)("h4",{id:"parameters-4"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"state")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,l.kt)("h4",{id:"returns-17"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/EdgesClipper/src/edges-plane.ts#L54"},"temp/engine_components/src/navigation/EdgesClipper/src/edges-plane.ts:54")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"update"},"update"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"update"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"Updateable.update")),(0,l.kt)("h4",{id:"returns-18"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("h4",{id:"overrides-3"},"Overrides"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#update"},"update")),(0,l.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/EdgesClipper/src/edges-plane.ts#L76"},"temp/engine_components/src/navigation/EdgesClipper/src/edges-plane.ts:76")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/1f391b9e.f19b76f1.js b/build/assets/js/1f391b9e.f19b76f1.js deleted file mode 100644 index 38c286af..00000000 --- a/build/assets/js/1f391b9e.f19b76f1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3085],{4247:(e,a,t)=>{t.r(a),t.d(a,{default:()=>o});var l=t(7294),n=t(6010),c=t(1944),r=t(5281),m=t(7961),i=t(6905),s=t(9407);const d={mdxPageWrapper:"mdxPageWrapper_j9I6"};function o(e){var a=e.content,t=a.metadata,o=t.title,p=t.description,g=t.frontMatter,u=g.wrapperClassName,E=g.hide_table_of_contents;return l.createElement(c.FG,{className:(0,n.Z)(null!=u?u:r.k.wrapper.mdxPages,r.k.page.mdxPage)},l.createElement(c.d,{title:o,description:p}),l.createElement(m.Z,null,l.createElement("main",{className:"container container--fluid margin-vert--lg"},l.createElement("div",{className:(0,n.Z)("row",d.mdxPageWrapper)},l.createElement("div",{className:(0,n.Z)("col",!E&&"col--8")},l.createElement("article",null,l.createElement(i.Z,null,l.createElement(a,null)))),!E&&a.toc.length>0&&l.createElement("div",{className:"col col--2"},l.createElement(s.Z,{toc:a.toc,minHeadingLevel:g.toc_min_heading_level,maxHeadingLevel:g.toc_max_heading_level}))))))}}}]); \ No newline at end of file diff --git a/build/assets/js/23f030fe.1ac5f286.js b/build/assets/js/23f030fe.1ac5f286.js new file mode 100644 index 00000000..fe898248 --- /dev/null +++ b/build/assets/js/23f030fe.1ac5f286.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1569],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>h});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function p(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var r=a.createContext({}),s=function(e){var t=a.useContext(r),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},d=function(e){var t=s(e.components);return a.createElement(r.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,o=e.originalType,r=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),m=s(n),u=i,h=m["".concat(r,".").concat(u)]||m[u]||k[u]||o;return n?a.createElement(h,p(p({ref:t},d),{},{components:n})):a.createElement(h,p({ref:t},d))}));function h(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var o=n.length,p=new Array(o);p[0]=u;var l={};for(var r in t)hasOwnProperty.call(t,r)&&(l[r]=t[r]);l.originalType=e,l[m]="string"==typeof e?e:i,p[1]=l;for(var s=2;s{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>l,metadata:()=>s,toc:()=>m});var a=n(7462),i=n(3366),o=(n(7294),n(3905)),p=["components"],l={id:"openbim_components.ToolComponent",title:"Class: ToolComponent",sidebar_label:"ToolComponent",custom_edit_url:null},r=void 0,s={unversionedId:"api/classes/openbim_components.ToolComponent",id:"api/classes/openbim_components.ToolComponent",title:"Class: ToolComponent",description:"openbim-components.ToolComponent",source:"@site/docs/api/classes/openbim_components.ToolComponent.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.ToolComponent",permalink:"/api/classes/openbim_components.ToolComponent",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.ToolComponent",title:"Class: ToolComponent",sidebar_label:"ToolComponent",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"SimpleScene",permalink:"/api/classes/openbim_components.SimpleScene"},next:{title:"UIElement",permalink:"/api/classes/openbim_components.UIElement"}},d={},m=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"list",id:"list",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"token",id:"token",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"uuid",id:"uuid",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"libraryUUIDs",id:"libraryuuids",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"Methods",id:"methods",level:2},{value:"add",id:"add",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"get",id:"get",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"init",id:"init",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"update",id:"update",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-16",level:4}],k={toc:m},u="wrapper";function h(e){var t=e.components,n=(0,i.Z)(e,p);return(0,o.kt)(u,(0,a.Z)({},k,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".ToolComponent"),(0,o.kt)("p",null,"An object to easily handle all the tools used (e.g. updating them, retrieving\nthem, performing batch operations, etc). A tool is a feature that achieves\nsomething through user interaction (e.g. clipping planes, dimensions, etc)."),(0,o.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("p",{parentName:"li"},(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,o.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,o.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,o.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,o.kt)("p",{parentName:"li"},"\u21b3 ",(0,o.kt)("strong",{parentName:"p"},(0,o.kt)("inlineCode",{parentName:"strong"},"ToolComponent"))))),(0,o.kt)("h2",{id:"implements"},"Implements"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,o.kt)("inlineCode",{parentName:"a"},"Disposable")))),(0,o.kt)("h2",{id:"properties"},"Properties"),(0,o.kt)("h3",{id:"enabled"},"enabled"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"enabled"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,o.kt)("inlineCode",{parentName:"p"},"true")),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,o.kt)("h4",{id:"overrides"},"Overrides"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/ToolsComponent/index.ts#L31"},"src/core/ToolsComponent/index.ts:31")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"list"},"list"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"list"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,o.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,o.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,o.kt)("inlineCode",{parentName:"p"},"any"),">",">"," = ",(0,o.kt)("inlineCode",{parentName:"p"},"{}")),(0,o.kt)("p",null,"The list of components created in this app."),(0,o.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/ToolsComponent/index.ts#L16"},"src/core/ToolsComponent/index.ts:16")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,o.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,o.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,o.kt)("inlineCode",{parentName:"p"},"undefined"),">"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,o.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,o.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/ToolsComponent/index.ts#L19"},"src/core/ToolsComponent/index.ts:19")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"token"},"token"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"token"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,o.kt)("inlineCode",{parentName:"p"},'""')),(0,o.kt)("p",null,"The auth token to get tools from That Open Platform."),(0,o.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/ToolsComponent/index.ts#L25"},"src/core/ToolsComponent/index.ts:25")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"uuid"},"uuid"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"uuid"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,o.kt)("inlineCode",{parentName:"p"},'"ToolComponent"')),(0,o.kt)("p",null,"Component.uuid"),(0,o.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/ToolsComponent/index.ts#L28"},"src/core/ToolsComponent/index.ts:28")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"libraryuuids"},"libraryUUIDs"),(0,o.kt)("p",null,"\u25aa ",(0,o.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,o.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,o.kt)("strong",{parentName:"p"},"libraryUUIDs"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"Set"),"<",(0,o.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,o.kt)("p",null,"The list of UUIDs of all the components in this library."),(0,o.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/ToolsComponent/index.ts#L22"},"src/core/ToolsComponent/index.ts:22")),(0,o.kt)("h2",{id:"methods"},"Methods"),(0,o.kt)("h3",{id:"add"},"add"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"add"),"(",(0,o.kt)("inlineCode",{parentName:"p"},"uuid"),", ",(0,o.kt)("inlineCode",{parentName:"p"},"instance"),"): ",(0,o.kt)("inlineCode",{parentName:"p"},"void")),(0,o.kt)("p",null,"Adds a new tool. Use this in the constructor of your tools."),(0,o.kt)("h4",{id:"parameters"},"Parameters"),(0,o.kt)("table",null,(0,o.kt)("thead",{parentName:"table"},(0,o.kt)("tr",{parentName:"thead"},(0,o.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,o.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,o.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,o.kt)("tbody",{parentName:"table"},(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"uuid")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"string")),(0,o.kt)("td",{parentName:"tr",align:"left"},"The UUID of your tool.")),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"instance")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.Component"},(0,o.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,o.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,o.kt)("td",{parentName:"tr",align:"left"},"The instance of your tool (",(0,o.kt)("inlineCode",{parentName:"td"},"this")," inside the constructor).")))),(0,o.kt)("h4",{id:"returns"},"Returns"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"void")),(0,o.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/ToolsComponent/index.ts#L58"},"src/core/ToolsComponent/index.ts:58")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"dispose"},"dispose"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,o.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,o.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,o.kt)("p",null,"Disposes all the MEMORY used by all the tools."),(0,o.kt)("h4",{id:"returns-1"},"Returns"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,o.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,o.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,o.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/ToolsComponent/index.ts#L107"},"src/core/ToolsComponent/index.ts:107")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"get"},"get"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"get"),"<",(0,o.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,o.kt)("inlineCode",{parentName:"p"},"U"),">","(",(0,o.kt)("inlineCode",{parentName:"p"},"ToolClass"),"): ",(0,o.kt)("inlineCode",{parentName:"p"},"U")),(0,o.kt)("p",null,"Retrieves a tool component. If it already exists in this app, it returns the instance of the component. If it\ndoesn't exist, it will instance it automatically."),(0,o.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,o.kt)("table",null,(0,o.kt)("thead",{parentName:"table"},(0,o.kt)("tr",{parentName:"thead"},(0,o.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,o.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,o.kt)("tbody",{parentName:"table"},(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"T")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"T"))),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"U")),(0,o.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,o.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.Component"},(0,o.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,o.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,o.kt)("h4",{id:"parameters-1"},"Parameters"),(0,o.kt)("table",null,(0,o.kt)("thead",{parentName:"table"},(0,o.kt)("tr",{parentName:"thead"},(0,o.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,o.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,o.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,o.kt)("tbody",{parentName:"table"},(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"ToolClass")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"Object")),(0,o.kt)("td",{parentName:"tr",align:"left"},"The component to get or create.")))),(0,o.kt)("h4",{id:"returns-2"},"Returns"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"U")),(0,o.kt)("h4",{id:"overrides-1"},"Overrides"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,o.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/ToolsComponent/index.ts#L74"},"src/core/ToolsComponent/index.ts:74")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"hasui"},"hasUI"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,o.kt)("p",null,"Whether is component implements any kind of ",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,o.kt)("h4",{id:"returns-3"},"Returns"),(0,o.kt)("p",null,"this is UI"),(0,o.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,o.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"init"},"init"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"init"),"(",(0,o.kt)("inlineCode",{parentName:"p"},"OBC"),"): ",(0,o.kt)("inlineCode",{parentName:"p"},"void")),(0,o.kt)("p",null,"Pass the whole library object as argument."),(0,o.kt)("h4",{id:"parameters-2"},"Parameters"),(0,o.kt)("table",null,(0,o.kt)("thead",{parentName:"table"},(0,o.kt)("tr",{parentName:"thead"},(0,o.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,o.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,o.kt)("tbody",{parentName:"table"},(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"OBC")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"any"))))),(0,o.kt)("h4",{id:"returns-4"},"Returns"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"void")),(0,o.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/ToolsComponent/index.ts#L46"},"src/core/ToolsComponent/index.ts:46")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,o.kt)("p",null,"Whether is component is ",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,o.kt)("h4",{id:"returns-5"},"Returns"),(0,o.kt)("p",null,"this is Configurable"),(0,o.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,o.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,o.kt)("p",null,"Whether is component is ",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,o.kt)("h4",{id:"returns-6"},"Returns"),(0,o.kt)("p",null,"this is Disposable"),(0,o.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,o.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"ishideable"},"isHideable"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,o.kt)("p",null,"Whether is component is ",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,o.kt)("h4",{id:"returns-7"},"Returns"),(0,o.kt)("p",null,"this is Hideable"),(0,o.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,o.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,o.kt)("p",null,"Whether is component is ",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,o.kt)("h4",{id:"returns-8"},"Returns"),(0,o.kt)("p",null,"this is Resizeable"),(0,o.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,o.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,o.kt)("p",null,"Whether is component is ",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,o.kt)("h4",{id:"returns-9"},"Returns"),(0,o.kt)("p",null,"this is Updateable"),(0,o.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,o.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"update"},"update"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"update"),"(",(0,o.kt)("inlineCode",{parentName:"p"},"delta"),"): ",(0,o.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,o.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,o.kt)("p",null,"Updates all the registered tool components. Only the components where the\nproperty ",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")," is true will be updated."),(0,o.kt)("h4",{id:"parameters-3"},"Parameters"),(0,o.kt)("table",null,(0,o.kt)("thead",{parentName:"table"},(0,o.kt)("tr",{parentName:"thead"},(0,o.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,o.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,o.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,o.kt)("tbody",{parentName:"table"},(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"delta")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"number")),(0,o.kt)("td",{parentName:"tr",align:"left"},"The ",(0,o.kt)("a",{parentName:"td",href:"https://threejs.org/docs/#api/en/core/Clock"},"delta time")," of the loop.")))),(0,o.kt)("h4",{id:"returns-10"},"Returns"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,o.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,o.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/ToolsComponent/index.ts#L95"},"src/core/ToolsComponent/index.ts:95")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/23f030fe.f7dbf151.js b/build/assets/js/23f030fe.f7dbf151.js deleted file mode 100644 index 522f40a1..00000000 --- a/build/assets/js/23f030fe.f7dbf151.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1569],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>c});var i=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function p(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var r=i.createContext({}),s=function(e){var t=i.useContext(r),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},m=function(e){var t=s(e.components);return i.createElement(r.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},u=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,r=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),d=s(n),u=a,c=d["".concat(r,".").concat(u)]||d[u]||k[u]||o;return n?i.createElement(c,p(p({ref:t},m),{},{components:n})):i.createElement(c,p({ref:t},m))}));function c(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,p=new Array(o);p[0]=u;var l={};for(var r in t)hasOwnProperty.call(t,r)&&(l[r]=t[r]);l.originalType=e,l[d]="string"==typeof e?e:a,p[1]=l;for(var s=2;s{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>r,default:()=>c,frontMatter:()=>l,metadata:()=>s,toc:()=>d});var i=n(7462),a=n(3366),o=(n(7294),n(3905)),p=["components"],l={id:"openbim_components.ToolComponent",title:"Class: ToolComponent",sidebar_label:"ToolComponent",custom_edit_url:null},r=void 0,s={unversionedId:"api/classes/openbim_components.ToolComponent",id:"api/classes/openbim_components.ToolComponent",title:"Class: ToolComponent",description:"openbim-components.ToolComponent",source:"@site/docs/api/classes/openbim_components.ToolComponent.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.ToolComponent",permalink:"/api/classes/openbim_components.ToolComponent",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.ToolComponent",title:"Class: ToolComponent",sidebar_label:"ToolComponent",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"SimpleScene",permalink:"/api/classes/openbim_components.SimpleScene"},next:{title:"UIElement",permalink:"/api/classes/openbim_components.UIElement"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"list",id:"list",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"token",id:"token",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"uuid",id:"uuid",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"libraryUUIDs",id:"libraryuuids",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"Methods",id:"methods",level:2},{value:"add",id:"add",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"get",id:"get",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"init",id:"init",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"update",id:"update",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-16",level:4}],k={toc:d},u="wrapper";function c(e){var t=e.components,n=(0,a.Z)(e,p);return(0,o.kt)(u,(0,i.Z)({},k,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".ToolComponent"),(0,o.kt)("p",null,"An object to easily handle all the tools used (e.g. updating them, retrieving\nthem, performing batch operations, etc). A tool is a feature that achieves\nsomething through user interaction (e.g. clipping planes, dimensions, etc)."),(0,o.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("p",{parentName:"li"},(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,o.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,o.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,o.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,o.kt)("p",{parentName:"li"},"\u21b3 ",(0,o.kt)("strong",{parentName:"p"},(0,o.kt)("inlineCode",{parentName:"strong"},"ToolComponent"))))),(0,o.kt)("h2",{id:"implements"},"Implements"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,o.kt)("inlineCode",{parentName:"a"},"Disposable")))),(0,o.kt)("h2",{id:"properties"},"Properties"),(0,o.kt)("h3",{id:"enabled"},"enabled"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"enabled"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,o.kt)("inlineCode",{parentName:"p"},"true")),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,o.kt)("h4",{id:"overrides"},"Overrides"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/ToolsComponent/index.ts#L31"},"temp/engine_components/src/core/ToolsComponent/index.ts:31")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"list"},"list"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"list"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,o.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,o.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,o.kt)("inlineCode",{parentName:"p"},"any"),">",">"," = ",(0,o.kt)("inlineCode",{parentName:"p"},"{}")),(0,o.kt)("p",null,"The list of components created in this app."),(0,o.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/ToolsComponent/index.ts#L16"},"temp/engine_components/src/core/ToolsComponent/index.ts:16")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,o.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,o.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,o.kt)("inlineCode",{parentName:"p"},"undefined"),">"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,o.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,o.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/ToolsComponent/index.ts#L19"},"temp/engine_components/src/core/ToolsComponent/index.ts:19")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"token"},"token"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"token"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,o.kt)("inlineCode",{parentName:"p"},'""')),(0,o.kt)("p",null,"The auth token to get tools from That Open Platform."),(0,o.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/ToolsComponent/index.ts#L25"},"temp/engine_components/src/core/ToolsComponent/index.ts:25")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"uuid"},"uuid"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"uuid"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,o.kt)("inlineCode",{parentName:"p"},'"ToolComponent"')),(0,o.kt)("p",null,"Component.uuid"),(0,o.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/ToolsComponent/index.ts#L28"},"temp/engine_components/src/core/ToolsComponent/index.ts:28")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"libraryuuids"},"libraryUUIDs"),(0,o.kt)("p",null,"\u25aa ",(0,o.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,o.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,o.kt)("strong",{parentName:"p"},"libraryUUIDs"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"Set"),"<",(0,o.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,o.kt)("p",null,"The list of UUIDs of all the components in this library."),(0,o.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/ToolsComponent/index.ts#L22"},"temp/engine_components/src/core/ToolsComponent/index.ts:22")),(0,o.kt)("h2",{id:"methods"},"Methods"),(0,o.kt)("h3",{id:"add"},"add"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"add"),"(",(0,o.kt)("inlineCode",{parentName:"p"},"uuid"),", ",(0,o.kt)("inlineCode",{parentName:"p"},"instance"),"): ",(0,o.kt)("inlineCode",{parentName:"p"},"void")),(0,o.kt)("p",null,"Adds a new tool. Use this in the constructor of your tools."),(0,o.kt)("h4",{id:"parameters"},"Parameters"),(0,o.kt)("table",null,(0,o.kt)("thead",{parentName:"table"},(0,o.kt)("tr",{parentName:"thead"},(0,o.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,o.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,o.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,o.kt)("tbody",{parentName:"table"},(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"uuid")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"string")),(0,o.kt)("td",{parentName:"tr",align:"left"},"The UUID of your tool.")),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"instance")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.Component"},(0,o.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,o.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,o.kt)("td",{parentName:"tr",align:"left"},"The instance of your tool (",(0,o.kt)("inlineCode",{parentName:"td"},"this")," inside the constructor).")))),(0,o.kt)("h4",{id:"returns"},"Returns"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"void")),(0,o.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/ToolsComponent/index.ts#L58"},"temp/engine_components/src/core/ToolsComponent/index.ts:58")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"dispose"},"dispose"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,o.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,o.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,o.kt)("p",null,"Disposes all the MEMORY used by all the tools."),(0,o.kt)("h4",{id:"returns-1"},"Returns"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,o.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,o.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,o.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/ToolsComponent/index.ts#L107"},"temp/engine_components/src/core/ToolsComponent/index.ts:107")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"get"},"get"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"get"),"<",(0,o.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,o.kt)("inlineCode",{parentName:"p"},"U"),">","(",(0,o.kt)("inlineCode",{parentName:"p"},"ToolClass"),"): ",(0,o.kt)("inlineCode",{parentName:"p"},"U")),(0,o.kt)("p",null,"Retrieves a tool component. If it already exists in this app, it returns the instance of the component. If it\ndoesn't exist, it will instance it automatically."),(0,o.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,o.kt)("table",null,(0,o.kt)("thead",{parentName:"table"},(0,o.kt)("tr",{parentName:"thead"},(0,o.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,o.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,o.kt)("tbody",{parentName:"table"},(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"T")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"T"))),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"U")),(0,o.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,o.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.Component"},(0,o.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,o.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,o.kt)("h4",{id:"parameters-1"},"Parameters"),(0,o.kt)("table",null,(0,o.kt)("thead",{parentName:"table"},(0,o.kt)("tr",{parentName:"thead"},(0,o.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,o.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,o.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,o.kt)("tbody",{parentName:"table"},(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"ToolClass")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"Object")),(0,o.kt)("td",{parentName:"tr",align:"left"},"The component to get or create.")))),(0,o.kt)("h4",{id:"returns-2"},"Returns"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"U")),(0,o.kt)("h4",{id:"overrides-1"},"Overrides"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,o.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/ToolsComponent/index.ts#L74"},"temp/engine_components/src/core/ToolsComponent/index.ts:74")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"hasui"},"hasUI"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,o.kt)("p",null,"Whether is component implements any kind of ",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,o.kt)("h4",{id:"returns-3"},"Returns"),(0,o.kt)("p",null,"this is UI"),(0,o.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,o.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"init"},"init"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"init"),"(",(0,o.kt)("inlineCode",{parentName:"p"},"OBC"),"): ",(0,o.kt)("inlineCode",{parentName:"p"},"void")),(0,o.kt)("p",null,"Pass the whole library object as argument."),(0,o.kt)("h4",{id:"parameters-2"},"Parameters"),(0,o.kt)("table",null,(0,o.kt)("thead",{parentName:"table"},(0,o.kt)("tr",{parentName:"thead"},(0,o.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,o.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,o.kt)("tbody",{parentName:"table"},(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"OBC")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"any"))))),(0,o.kt)("h4",{id:"returns-4"},"Returns"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"void")),(0,o.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/ToolsComponent/index.ts#L46"},"temp/engine_components/src/core/ToolsComponent/index.ts:46")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,o.kt)("p",null,"Whether is component is ",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,o.kt)("h4",{id:"returns-5"},"Returns"),(0,o.kt)("p",null,"this is Configurable"),(0,o.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,o.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,o.kt)("p",null,"Whether is component is ",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,o.kt)("h4",{id:"returns-6"},"Returns"),(0,o.kt)("p",null,"this is Disposable"),(0,o.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,o.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"ishideable"},"isHideable"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,o.kt)("p",null,"Whether is component is ",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,o.kt)("h4",{id:"returns-7"},"Returns"),(0,o.kt)("p",null,"this is Hideable"),(0,o.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,o.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,o.kt)("p",null,"Whether is component is ",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,o.kt)("h4",{id:"returns-8"},"Returns"),(0,o.kt)("p",null,"this is Resizeable"),(0,o.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,o.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,o.kt)("p",null,"Whether is component is ",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,o.kt)("h4",{id:"returns-9"},"Returns"),(0,o.kt)("p",null,"this is Updateable"),(0,o.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,o.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"update"},"update"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"update"),"(",(0,o.kt)("inlineCode",{parentName:"p"},"delta"),"): ",(0,o.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,o.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,o.kt)("p",null,"Updates all the registered tool components. Only the components where the\nproperty ",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")," is true will be updated."),(0,o.kt)("h4",{id:"parameters-3"},"Parameters"),(0,o.kt)("table",null,(0,o.kt)("thead",{parentName:"table"},(0,o.kt)("tr",{parentName:"thead"},(0,o.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,o.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,o.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,o.kt)("tbody",{parentName:"table"},(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"delta")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"number")),(0,o.kt)("td",{parentName:"tr",align:"left"},"The ",(0,o.kt)("a",{parentName:"td",href:"https://threejs.org/docs/#api/en/core/Clock"},"delta time")," of the loop.")))),(0,o.kt)("h4",{id:"returns-10"},"Returns"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,o.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,o.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/ToolsComponent/index.ts#L95"},"temp/engine_components/src/core/ToolsComponent/index.ts:95")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/31eca0ce.dcd3ee86.js b/build/assets/js/31eca0ce.5b162fcf.js similarity index 59% rename from build/assets/js/31eca0ce.dcd3ee86.js rename to build/assets/js/31eca0ce.5b162fcf.js index 40dfc3bb..e894e2c0 100644 --- a/build/assets/js/31eca0ce.dcd3ee86.js +++ b/build/assets/js/31eca0ce.5b162fcf.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6827],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>f});var a=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var s=a.createContext({}),c=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},u=function(e){var t=c(e.components);return a.createElement(s.Provider,{value:t},e.children)},m="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var n=e.components,o=e.mdxType,r=e.originalType,s=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),m=c(n),d=o,f=m["".concat(s,".").concat(d)]||m[d]||p[d]||r;return n?a.createElement(f,i(i({ref:t},u),{},{components:n})):a.createElement(f,i({ref:t},u))}));function f(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var r=n.length,i=new Array(r);i[0]=d;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[m]="string"==typeof e?e:o,i[1]=l;for(var c=2;c{n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>s,default:()=>f,frontMatter:()=>l,metadata:()=>c,toc:()=>m});var a=n(7462),o=n(3366),r=(n(7294),n(3905)),i=["components"],l={},s=void 0,c={unversionedId:"Tutorials/FragmentIfcLoader",id:"Tutorials/FragmentIfcLoader",title:"FragmentIfcLoader",description:"\ud83c\udfe0\ud83d\udc49\ud83e\udd16 From IFC to fragment in 1 minute",source:"@site/docs/Tutorials/FragmentIfcLoader.mdx",sourceDirName:"Tutorials",slug:"/Tutorials/FragmentIfcLoader",permalink:"/Tutorials/FragmentIfcLoader",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"FragmentHighlighter",permalink:"/Tutorials/FragmentHighlighter"},next:{title:"FragmentIfcStreamer",permalink:"/Tutorials/FragmentIfcStreamer"}},u={},m=[{value:"\ud83c\udfe0\ud83d\udc49\ud83e\udd16 From IFC to fragment in 1 minute",id:"-from-ifc-to-fragment-in-1-minute",level:3},{value:"\ud83d\udd2d\ud83d\udd27 Calibrating the converter",id:"-calibrating-the-converter",level:3},{value:"\ud83d\ude97\ud83d\udd25 Loading the IFC",id:"-loading-the-ifc",level:3},{value:"\ud83c\udf81 Exporting the result",id:"-exporting-the-result",level:3},{value:"\ud83e\udde0\ud83e\uddfc Cleaning memory",id:"-cleaning-memory",level:3}],p={toc:m},d="wrapper";function f(e){var t=e.components,n=(0,o.Z)(e,i);return(0,r.kt)(d,(0,a.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h3",{id:"-from-ifc-to-fragment-in-1-minute"},"\ud83c\udfe0\ud83d\udc49\ud83e\udd16 From IFC to fragment in 1 minute"),(0,r.kt)("hr",null),(0,r.kt)("p",null,"Fragments are great: they are lightweight, they are fast and we\nhave tons of tools to work with them. But fragments are not used\noutside our libraries. So how can we convert an IFC file to fragments?\nEasy: with the ",(0,r.kt)("inlineCode",{parentName:"p"},"FragmentIfcLoader"),"! Let's start by creating it."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"let fragments = new OBC.FragmentManager(components);\nlet fragmentIfcLoader = new OBC.FragmentIfcLoader(components);\n")),(0,r.kt)("admonition",{title:"Why not just IFC?",type:"info"},(0,r.kt)("p",{parentName:"admonition"},"IFC is nice because it lets us exchange data with many tools in the\nAECO industry. But it also has some limitations. In a nutshell,\ndata coming from IFC needs to be processed and converted to triangles\nto be able to draw it in 3D, and that requires processing power\nand time! That's why we convert it to fragments to display it.\nOnce you have the fragments, you can store them and load them\ndirectly the next time your user tries to load that IFC: it will\nload 10 times faster!")),(0,r.kt)("p",null,"Now, we will start using the built-in ",(0,r.kt)("inlineCode",{parentName:"p"},"Button")," the ifc loader has.\nTo do that, we will create a ",(0,r.kt)("inlineCode",{parentName:"p"},"Toolbar")," and add it to our app. This\nbutton will give you all the features you need to load IFC files!\nDon't worry, we'll also do this programmatically in a moment."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const mainToolbar = new OBC.Toolbar(components, {name: 'Main Toolbar', position: 'bottom'});\ncomponents.ui.addToolbar(mainToolbar);\nconst ifcButton = fragmentIfcLoader.uiElement.get(\"main\");\nmainToolbar.addChild(ifcButton);\n")),(0,r.kt)("h3",{id:"-calibrating-the-converter"},"\ud83d\udd2d\ud83d\udd27 Calibrating the converter"),(0,r.kt)("hr",null),(0,r.kt)("p",null,"Now, we need to configure the path of the WASM files. What's WASM?\nIt's a technology that lets us run C++ on the browser, which means\nthat we can load IFCs super fast! These files are the compilation of\nour ",(0,r.kt)("inlineCode",{parentName:"p"},"web-ifc")," library. You can find them in the github repo and in NPM.\nThese files need to be available to our app, so you have 2 options:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Download them and serve them statically."),(0,r.kt)("li",{parentName:"ul"},"Get them from a remote server.\nThe easiest way is getting them from unpkg, and the cool thing is that\nyou don't need to do it manually! It can be done directly by the tool\njust by writing the following:")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},'await fragmentIfcLoader.setup()\n/* If you want to the path to unpkg manually, then you can skip the line \nabove and set them manually as below:\nfragmentIfcLoader.settings.wasm = {\npath: "https://unpkg.com/web-ifc@0.0.50/",\nabsolute: true\n} */\n')),(0,r.kt)("p",null,"Awesome! Optionally, we can exclude categories that we don't want\nto convert to fragments like very easily:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const excludedCats = [\nWEBIFC.IFCTENDONANCHOR,\nWEBIFC.IFCREINFORCINGBAR,\nWEBIFC.IFCREINFORCINGELEMENT,\n];\nfor (const cat of excludedCats) {\nfragmentIfcLoader.settings.excludedCategories.add(cat);\n}\n")),(0,r.kt)("p",null,"We can further configure the conversion using the ",(0,r.kt)("inlineCode",{parentName:"p"},"webIfc")," object.\nIn this example, we will make the IFC model go to the origin of\nthe scene (don't worry, this supports model federation) and\noptimize the profiles geometry so that it generates very\nefficient geometry for certain geometries (e.g. HVAC):"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"fragmentIfcLoader.settings.webIfc.COORDINATE_TO_ORIGIN = true;\nfragmentIfcLoader.settings.webIfc.OPTIMIZE_PROFILES = true;\n")),(0,r.kt)("h3",{id:"-loading-the-ifc"},"\ud83d\ude97\ud83d\udd25 Loading the IFC"),(0,r.kt)("hr",null),(0,r.kt)("p",null,"Next, let's define a function to load the IFC programmatically.\nWe have hardcoded the path to one of our IFC files, but feel free\nto do this with any of your own files!"),(0,r.kt)("admonition",{title:"Opening local IFCs",type:"info"},(0,r.kt)("p",{parentName:"admonition"},"Keep in mind that the browser can't access the file of your\ncomputer directly, so you will need to use the Open File API to\nopen local files.")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"async function loadIfcAsFragments() {\nconst file = await fetch('../../../resources/small.ifc');\nconst data = await file.arrayBuffer();\nconst buffer = new Uint8Array(data);\nconst model = await fragmentIfcLoader.load(buffer, \"example\");\nscene.add(model);\n}\n")),(0,r.kt)("h3",{id:"-exporting-the-result"},"\ud83c\udf81 Exporting the result"),(0,r.kt)("hr",null),(0,r.kt)("p",null,"Once you have your precious fragments, you might want to save them\nso that you don't need to open this IFC file each time your user\ngets into your app. Instead, the next time you can load the\nfragments directly. Defining a function to export fragments\nis as easy as this:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"async function exportFragments() {\nif (!fragments.groups.length) return;\nconst group = fragments.groups[0];\nconst data = fragments.export(group);\nconst blob = new Blob([data]);\nconst fragmentFile = new File([blob], 'small.frag');\nconst files = [];\nfiles.push(fragmentFile);\nconst properties = group.getLocalProperties();\nif (properties) {\nfiles.push(new File([JSON.stringify(properties)], 'small.json'));\n}\nconst result = await downloadZip(files).blob();\nresult.name = 'example';\ndownload(result);\n}\n")),(0,r.kt)("p",null,"Now, this is how the download function looks like:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"function download(file) {\nconst link = document.createElement('a');\nlink.href = URL.createObjectURL(file);\nlink.download = file.name;\ndocument.body.appendChild(link);\nlink.click();\nlink.remove();\n}\n")),(0,r.kt)("h3",{id:"-cleaning-memory"},"\ud83e\udde0\ud83e\uddfc Cleaning memory"),(0,r.kt)("hr",null),(0,r.kt)("p",null,"Now, just like in the ",(0,r.kt)("inlineCode",{parentName:"p"},"FragmentManager")," tutorial, you will need\nto dispose the memory if your user wants to reset the state of the\nscene, especially if you are using Single Page Application\ntechnologies like React, Angular, Vue, etc. To do that, you\ncan simply call the ",(0,r.kt)("inlineCode",{parentName:"p"},"dispose")," method:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"function disposeFragments() {\nfragments.dispose();\n}\n")),(0,r.kt)("p",null,"That's it! Congrats, now you can load IFC files into your app,\ngenerate the 3D geometry and property data for them and navigate\nthem in 3D. In other tutorials, you'll find tons of tools to\nwork with them and create amazing BIM apps! See you there \ud83d\udcaa"),(0,r.kt)("iframe",{src:"https://thatopen.github.io/engine_components/src/fragments/FragmentIfcLoader/index.html"}))}f.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6827],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>f});var a=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var s=a.createContext({}),c=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},u=function(e){var t=c(e.components);return a.createElement(s.Provider,{value:t},e.children)},m="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var n=e.components,o=e.mdxType,r=e.originalType,s=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),m=c(n),d=o,f=m["".concat(s,".").concat(d)]||m[d]||p[d]||r;return n?a.createElement(f,i(i({ref:t},u),{},{components:n})):a.createElement(f,i({ref:t},u))}));function f(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var r=n.length,i=new Array(r);i[0]=d;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[m]="string"==typeof e?e:o,i[1]=l;for(var c=2;c{n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>s,default:()=>f,frontMatter:()=>l,metadata:()=>c,toc:()=>m});var a=n(7462),o=n(3366),r=(n(7294),n(3905)),i=["components"],l={},s=void 0,c={unversionedId:"Tutorials/FragmentIfcLoader",id:"Tutorials/FragmentIfcLoader",title:"FragmentIfcLoader",description:"\ud83c\udfe0\ud83d\udc49\ud83e\udd16 From IFC to fragment in 1 minute",source:"@site/docs/Tutorials/FragmentIfcLoader.mdx",sourceDirName:"Tutorials",slug:"/Tutorials/FragmentIfcLoader",permalink:"/Tutorials/FragmentIfcLoader",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"FragmentHighlighter",permalink:"/Tutorials/FragmentHighlighter"},next:{title:"FragmentIfcStreamer",permalink:"/Tutorials/FragmentIfcStreamer"}},u={},m=[{value:"\ud83c\udfe0\ud83d\udc49\ud83e\udd16 From IFC to fragment in 1 minute",id:"-from-ifc-to-fragment-in-1-minute",level:3},{value:"\ud83d\udd2d\ud83d\udd27 Calibrating the converter",id:"-calibrating-the-converter",level:3},{value:"\ud83d\ude97\ud83d\udd25 Loading the IFC",id:"-loading-the-ifc",level:3},{value:"\ud83c\udf81 Exporting the result",id:"-exporting-the-result",level:3},{value:"\ud83e\udde0\ud83e\uddfc Cleaning memory",id:"-cleaning-memory",level:3}],p={toc:m},d="wrapper";function f(e){var t=e.components,n=(0,o.Z)(e,i);return(0,r.kt)(d,(0,a.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h3",{id:"-from-ifc-to-fragment-in-1-minute"},"\ud83c\udfe0\ud83d\udc49\ud83e\udd16 From IFC to fragment in 1 minute"),(0,r.kt)("hr",null),(0,r.kt)("p",null,"Fragments are great: they are lightweight, they are fast and we\nhave tons of tools to work with them. But fragments are not used\noutside our libraries. So how can we convert an IFC file to fragments?\nEasy: with the ",(0,r.kt)("inlineCode",{parentName:"p"},"FragmentIfcLoader"),"! Let's start by creating it."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"let fragments = new OBC.FragmentManager(components);\nlet fragmentIfcLoader = new OBC.FragmentIfcLoader(components);\n")),(0,r.kt)("admonition",{title:"Why not just IFC?",type:"info"},(0,r.kt)("p",{parentName:"admonition"},"IFC is nice because it lets us exchange data with many tools in the\nAECO industry. But it also has some limitations. In a nutshell,\ndata coming from IFC needs to be processed and converted to triangles\nto be able to draw it in 3D, and that requires processing power\nand time! That's why we convert it to fragments to display it.\nOnce you have the fragments, you can store them and load them\ndirectly the next time your user tries to load that IFC: it will\nload 10 times faster!")),(0,r.kt)("p",null,"Now, we will start using the built-in ",(0,r.kt)("inlineCode",{parentName:"p"},"Button")," the ifc loader has.\nTo do that, we will create a ",(0,r.kt)("inlineCode",{parentName:"p"},"Toolbar")," and add it to our app. This\nbutton will give you all the features you need to load IFC files!\nDon't worry, we'll also do this programmatically in a moment."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const mainToolbar = new OBC.Toolbar(components, {name: 'Main Toolbar', position: 'bottom'});\ncomponents.ui.addToolbar(mainToolbar);\nconst ifcButton = fragmentIfcLoader.uiElement.get(\"main\");\nmainToolbar.addChild(ifcButton);\n")),(0,r.kt)("h3",{id:"-calibrating-the-converter"},"\ud83d\udd2d\ud83d\udd27 Calibrating the converter"),(0,r.kt)("hr",null),(0,r.kt)("p",null,"Now, we need to configure the path of the WASM files. What's WASM?\nIt's a technology that lets us run C++ on the browser, which means\nthat we can load IFCs super fast! These files are the compilation of\nour ",(0,r.kt)("inlineCode",{parentName:"p"},"web-ifc")," library. You can find them in the github repo and in NPM.\nThese files need to be available to our app, so you have 2 options:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Download them and serve them statically."),(0,r.kt)("li",{parentName:"ul"},"Get them from a remote server.\nThe easiest way is getting them from unpkg, and the cool thing is that\nyou don't need to do it manually! It can be done directly by the tool\njust by writing the following:")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},'await fragmentIfcLoader.setup()\n/* If you want to the path to unpkg manually, then you can skip the line\nabove and set them manually as below:\nfragmentIfcLoader.settings.wasm = {\npath: "https://unpkg.com/web-ifc@0.0.53/",\nabsolute: true\n} */\n')),(0,r.kt)("p",null,"Awesome! Optionally, we can exclude categories that we don't want\nto convert to fragments like very easily:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const excludedCats = [\nWEBIFC.IFCTENDONANCHOR,\nWEBIFC.IFCREINFORCINGBAR,\nWEBIFC.IFCREINFORCINGELEMENT,\n];\nfor (const cat of excludedCats) {\nfragmentIfcLoader.settings.excludedCategories.add(cat);\n}\n")),(0,r.kt)("p",null,"We can further configure the conversion using the ",(0,r.kt)("inlineCode",{parentName:"p"},"webIfc")," object.\nIn this example, we will make the IFC model go to the origin of\nthe scene (don't worry, this supports model federation) and\noptimize the profiles geometry so that it generates very\nefficient geometry for certain geometries (e.g. HVAC):"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"fragmentIfcLoader.settings.webIfc.COORDINATE_TO_ORIGIN = true;\nfragmentIfcLoader.settings.webIfc.OPTIMIZE_PROFILES = true;\n")),(0,r.kt)("h3",{id:"-loading-the-ifc"},"\ud83d\ude97\ud83d\udd25 Loading the IFC"),(0,r.kt)("hr",null),(0,r.kt)("p",null,"Next, let's define a function to load the IFC programmatically.\nWe have hardcoded the path to one of our IFC files, but feel free\nto do this with any of your own files!"),(0,r.kt)("admonition",{title:"Opening local IFCs",type:"info"},(0,r.kt)("p",{parentName:"admonition"},"Keep in mind that the browser can't access the file of your\ncomputer directly, so you will need to use the Open File API to\nopen local files.")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"async function loadIfcAsFragments() {\nconst file = await fetch('../../../resources/small.ifc');\nconst data = await file.arrayBuffer();\nconst buffer = new Uint8Array(data);\nconst model = await fragmentIfcLoader.load(buffer, \"example\");\nscene.add(model);\n}\n")),(0,r.kt)("h3",{id:"-exporting-the-result"},"\ud83c\udf81 Exporting the result"),(0,r.kt)("hr",null),(0,r.kt)("p",null,"Once you have your precious fragments, you might want to save them\nso that you don't need to open this IFC file each time your user\ngets into your app. Instead, the next time you can load the\nfragments directly. Defining a function to export fragments\nis as easy as this:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"async function exportFragments() {\nif (!fragments.groups.length) return;\nconst group = fragments.groups[0];\nconst data = fragments.export(group);\nconst blob = new Blob([data]);\nconst fragmentFile = new File([blob], 'small.frag');\nconst files = [];\nfiles.push(fragmentFile);\nconst properties = group.getLocalProperties();\nif (properties) {\nfiles.push(new File([JSON.stringify(properties)], 'small.json'));\n}\nconst result = await downloadZip(files).blob();\nresult.name = 'example';\ndownload(result);\n}\n")),(0,r.kt)("p",null,"Now, this is how the download function looks like:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"function download(file) {\nconst link = document.createElement('a');\nlink.href = URL.createObjectURL(file);\nlink.download = file.name;\ndocument.body.appendChild(link);\nlink.click();\nlink.remove();\n}\n")),(0,r.kt)("h3",{id:"-cleaning-memory"},"\ud83e\udde0\ud83e\uddfc Cleaning memory"),(0,r.kt)("hr",null),(0,r.kt)("p",null,"Now, just like in the ",(0,r.kt)("inlineCode",{parentName:"p"},"FragmentManager")," tutorial, you will need\nto dispose the memory if your user wants to reset the state of the\nscene, especially if you are using Single Page Application\ntechnologies like React, Angular, Vue, etc. To do that, you\ncan simply call the ",(0,r.kt)("inlineCode",{parentName:"p"},"dispose")," method:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"function disposeFragments() {\nfragments.dispose();\n}\n")),(0,r.kt)("p",null,"That's it! Congrats, now you can load IFC files into your app,\ngenerate the 3D geometry and property data for them and navigate\nthem in 3D. In other tutorials, you'll find tons of tools to\nwork with them and create amazing BIM apps! See you there \ud83d\udcaa"),(0,r.kt)("iframe",{src:"https://thatopen.github.io/engine_components/src/fragments/FragmentIfcLoader/index.html"}))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/32cf703e.8947f457.js b/build/assets/js/32cf703e.7eaf714a.js similarity index 87% rename from build/assets/js/32cf703e.8947f457.js rename to build/assets/js/32cf703e.7eaf714a.js index f8c98509..b810fd57 100644 --- a/build/assets/js/32cf703e.8947f457.js +++ b/build/assets/js/32cf703e.7eaf714a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3053],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>f});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=n.createContext({}),c=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},p=function(e){var t=c(e.components);return n.createElement(l.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},g=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=c(r),g=o,f=u["".concat(l,".").concat(g)]||u[g]||d[g]||a;return r?n.createElement(f,i(i({ref:t},p),{},{components:r})):n.createElement(f,i({ref:t},p))}));function f(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,i=new Array(a);i[0]=g;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[u]="string"==typeof e?e:o,i[1]=s;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>f,frontMatter:()=>s,metadata:()=>c,toc:()=>u});var n=r(7462),o=r(3366),a=(r(7294),r(3905)),i=["components"],s={},l=void 0,c={unversionedId:"Tutorials/IfcPropertiesManager",id:"Tutorials/IfcPropertiesManager",title:"IfcPropertiesManager",description:"\u270d Edit properties at will!",source:"@site/docs/Tutorials/IfcPropertiesManager.mdx",sourceDirName:"Tutorials",slug:"/Tutorials/IfcPropertiesManager",permalink:"/Tutorials/IfcPropertiesManager",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"IfcPropertiesFinder",permalink:"/Tutorials/IfcPropertiesFinder"},next:{title:"IfcPropertiesProcessor",permalink:"/Tutorials/IfcPropertiesProcessor"}},p={},u=[{value:"\u270d Edit properties at will!",id:"-edit-properties-at-will",level:3},{value:"\u2728 Setting up highlighting and selecting",id:"-setting-up-highlighting-and-selecting",level:3}],d={toc:u},g="wrapper";function f(e){var t=e.components,r=(0,o.Z)(e,i);return(0,a.kt)(g,(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h3",{id:"-edit-properties-at-will"},"\u270d Edit properties at will!"),(0,a.kt)("hr",null),(0,a.kt)("p",null,"Viewing IFC files fast is great, but often the data inside\nthem is not correct or complete. Luckily, we can now directly\nedit and add data super easily! First, let's start by adding\nour classic fragment model:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},'const fragments = new OBC.FragmentManager(components);\nconst file = await fetch("../../../resources/small.frag");\nconst dataBlob = await file.arrayBuffer();\nconst buffer = new Uint8Array(dataBlob);\nconst model = await fragments.load(buffer);\nconst properties = await fetch("../../../resources/small.json");\nconst props = await properties.json();\nmodel.setLocalProperties(props);\n')),(0,a.kt)("p",null,"Then, we'll instance the tool that we need for editing properties:\nthe ",(0,a.kt)("inlineCode",{parentName:"p"},"IfcPropertiesManager"),"! It's designed as an extension of the\n",(0,a.kt)("inlineCode",{parentName:"p"},"IfcPropertiesProcessor"),", so if you haven't seen that tutorial\nyet, check it out before reading further."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"const propsProcessor = new OBC.IfcPropertiesProcessor(components);\nconst propsManager = new OBC.IfcPropertiesManager(components);\npropsProcessor.propertiesManager = propsManager;\n")),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"IfcPropertiesManager")," can edit IFCs and export new IFC models.\nDespite you can do it using the methods in the tool instance,\nlet's process the model using the ",(0,a.kt)("inlineCode",{parentName:"p"},"IfcPropertiesProcessor")," to use\nthe built-in UI, because is easier!\n:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},'propsProcessor.process(model);\npropsManager.onRequestFile.add(async () => {\nconst fetched = await fetch("../../../resources/small.ifc");\nconst buffer = await fetched.arrayBuffer()\nconst ifc = await propsManager.saveToIfc(model, new Uint8Array(buffer));\nconst a = document.createElement("a");\nconst url = URL.createObjectURL(new Blob([ifc]));\na.href = url;\na.download = model.name;\na.click();\nURL.revokeObjectURL(url);\n})\n')),(0,a.kt)("h3",{id:"-setting-up-highlighting-and-selecting"},"\u2728 Setting up highlighting and selecting"),(0,a.kt)("hr",null),(0,a.kt)("p",null,"Now, we will set up highlighting logic to make our app more\ninteresting. It's done in a similar way to other tutorials,\nso wander around the docs if you haven't already!"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"const highlighter = new OBC.FragmentHighlighter(components, fragments);\nhighlighter.setup();\ncomponents.renderer.postproduction.customEffects.outlineEnabled = true;\nhighlighter.outlinesEnabled = true;\nconst highlighterEvents = highlighter.events;\nhighlighterEvents.select.onClear.add(() => {\npropsProcessor.cleanPropertiesList();\n});\n")),(0,a.kt)("p",null,"Now, we will configure the highlighter so that each time that\nwe cick on the model, the properties menu is updated to display\nits properties, just like we did in the ",(0,a.kt)("inlineCode",{parentName:"p"},"IfcPropertiesProcessor"),"\ntutorial:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"highlighterEvents.select.onHighlight.add(\n(selection) => {\nconst fragmentID = Object.keys(selection)[0];\nconst expressID = [...selection[fragmentID]][0];\nlet model\nfor (const group of fragments.groups) {\nfor(const [_key, value] of group.keyFragments) {\nif(value === fragmentID) {\nmodel = group;\nbreak;\n}\n}\n}\nif(model) {\npropsProcessor.renderProperties(model, expressID);\n}\n}\n);\n")),(0,a.kt)("p",null,"Finally, we will add the UI to the app by creating a simple\ntoolbar:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},'const mainToolbar = new OBC.Toolbar(components);\ncomponents.ui.addToolbar(mainToolbar);\nmainToolbar.addChild(propsProcessor.uiElement.get("main"));\n')),(0,a.kt)("p",null,"Great job! Now you know how to support IFC property editing and\nexport in your apps. Check out the rest of the tutorials of\nthese docs for other cool BIM features."),(0,a.kt)("iframe",{src:"https://thatopen.github.io/engine_components/src/ifc/IfcPropertiesManager/index.html"}))}f.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3053],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>f});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=n.createContext({}),c=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},p=function(e){var t=c(e.components);return n.createElement(l.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},g=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=c(r),g=o,f=u["".concat(l,".").concat(g)]||u[g]||d[g]||a;return r?n.createElement(f,i(i({ref:t},p),{},{components:r})):n.createElement(f,i({ref:t},p))}));function f(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,i=new Array(a);i[0]=g;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[u]="string"==typeof e?e:o,i[1]=s;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>f,frontMatter:()=>s,metadata:()=>c,toc:()=>u});var n=r(7462),o=r(3366),a=(r(7294),r(3905)),i=["components"],s={},l=void 0,c={unversionedId:"Tutorials/IfcPropertiesManager",id:"Tutorials/IfcPropertiesManager",title:"IfcPropertiesManager",description:"\u270d Edit properties at will!",source:"@site/docs/Tutorials/IfcPropertiesManager.mdx",sourceDirName:"Tutorials",slug:"/Tutorials/IfcPropertiesManager",permalink:"/Tutorials/IfcPropertiesManager",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"IfcPropertiesFinder",permalink:"/Tutorials/IfcPropertiesFinder"},next:{title:"IfcPropertiesProcessor",permalink:"/Tutorials/IfcPropertiesProcessor"}},p={},u=[{value:"\u270d Edit properties at will!",id:"-edit-properties-at-will",level:3},{value:"\u2728 Setting up highlighting and selecting",id:"-setting-up-highlighting-and-selecting",level:3}],d={toc:u},g="wrapper";function f(e){var t=e.components,r=(0,o.Z)(e,i);return(0,a.kt)(g,(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h3",{id:"-edit-properties-at-will"},"\u270d Edit properties at will!"),(0,a.kt)("hr",null),(0,a.kt)("p",null,"Viewing IFC files fast is great, but often the data inside\nthem is not correct or complete. Luckily, we can now directly\nedit and add data super easily! First, let's start by adding\nour classic fragment model:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},'const fragments = new OBC.FragmentManager(components);\nconst file = await fetch("../../../resources/small.frag");\nconst dataBlob = await file.arrayBuffer();\nconst buffer = new Uint8Array(dataBlob);\nconst model = await fragments.load(buffer);\nconst properties = await fetch("../../../resources/small.json");\nconst props = await properties.json();\nmodel.setLocalProperties(props);\n')),(0,a.kt)("p",null,"Then, we'll instance the tool that we need for editing properties:\nthe ",(0,a.kt)("inlineCode",{parentName:"p"},"IfcPropertiesManager"),"! It's designed as an extension of the\n",(0,a.kt)("inlineCode",{parentName:"p"},"IfcPropertiesProcessor"),", so if you haven't seen that tutorial\nyet, check it out before reading further."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"const propsProcessor = new OBC.IfcPropertiesProcessor(components);\nconst propsManager = new OBC.IfcPropertiesManager(components);\npropsProcessor.propertiesManager = propsManager;\n")),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"IfcPropertiesManager")," can edit IFCs and export new IFC models.\nDespite you can do it using the methods in the tool instance,\nlet's process the model using the ",(0,a.kt)("inlineCode",{parentName:"p"},"IfcPropertiesProcessor")," to use\nthe built-in UI, because is easier!\n:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},'propsProcessor.process(model);\npropsManager.onRequestFile.add(async () => {\nconst fetched = await fetch("../../../resources/small.ifc");\nconst buffer = await fetched.arrayBuffer()\nconst ifc = await propsManager.saveToIfc(model, new Uint8Array(buffer));\nconst a = document.createElement("a");\nconst url = URL.createObjectURL(new Blob([ifc]));\na.href = url;\na.download = model.name;\na.click();\nURL.revokeObjectURL(url);\n})\n')),(0,a.kt)("h3",{id:"-setting-up-highlighting-and-selecting"},"\u2728 Setting up highlighting and selecting"),(0,a.kt)("hr",null),(0,a.kt)("p",null,"Now, we will set up highlighting logic to make our app more\ninteresting. It's done in a similar way to other tutorials,\nso wander around the docs if you haven't already!"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"const highlighter = new OBC.FragmentHighlighter(components, fragments);\nhighlighter.setup();\ncomponents.renderer.postproduction.customEffects.outlineEnabled = true;\nhighlighter.outlinesEnabled = true;\nconst highlighterEvents = highlighter.events;\nhighlighterEvents.select.onClear.add(() => {\npropsProcessor.cleanPropertiesList();\n});\n")),(0,a.kt)("p",null,"Now, we will configure the highlighter so that each time that\nwe cick on the model, the properties menu is updated to display\nits properties, just like we did in the ",(0,a.kt)("inlineCode",{parentName:"p"},"IfcPropertiesProcessor"),"\ntutorial:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"highlighterEvents.select.onHighlight.add(\n(selection) => {\nconst fragmentID = Object.keys(selection)[0];\nconst expressID = [...selection[fragmentID]][0];\nconst fragment = fragments.list[fragmentID];\nif(fragment.group) {\npropsProcessor.renderProperties(fragment.group, expressID);\n}\n}\n);\n")),(0,a.kt)("p",null,"Finally, we will add the UI to the app by creating a simple\ntoolbar:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},'const mainToolbar = new OBC.Toolbar(components);\ncomponents.ui.addToolbar(mainToolbar);\nmainToolbar.addChild(propsProcessor.uiElement.get("main"));\n')),(0,a.kt)("p",null,"Great job! Now you know how to support IFC property editing and\nexport in your apps. Check out the rest of the tutorials of\nthese docs for other cool BIM features."),(0,a.kt)("iframe",{src:"https://thatopen.github.io/engine_components/src/ifc/IfcPropertiesManager/index.html"}))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/3303a5a5.78f32c66.js b/build/assets/js/3303a5a5.78f32c66.js new file mode 100644 index 00000000..88cf04dd --- /dev/null +++ b/build/assets/js/3303a5a5.78f32c66.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6692],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>h});var i=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function s(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=i.createContext({}),o=function(e){var t=i.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},d=function(e){var t=o(e.components);return i.createElement(p.Provider,{value:t},e.children)},m="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},u=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,r=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),m=o(n),u=a,h=m["".concat(p,".").concat(u)]||m[u]||c[u]||r;return n?i.createElement(h,s(s({ref:t},d),{},{components:n})):i.createElement(h,s({ref:t},d))}));function h(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,s=new Array(r);s[0]=u;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[m]="string"==typeof e?e:a,s[1]=l;for(var o=2;o{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>p,default:()=>h,frontMatter:()=>l,metadata:()=>o,toc:()=>m});var i=n(7462),a=n(3366),r=(n(7294),n(3905)),s=["components"],l={id:"openbim_components.SimpleRaycaster",title:"Class: SimpleRaycaster",sidebar_label:"SimpleRaycaster",custom_edit_url:null},p=void 0,o={unversionedId:"api/classes/openbim_components.SimpleRaycaster",id:"api/classes/openbim_components.SimpleRaycaster",title:"Class: SimpleRaycaster",description:"openbim-components.SimpleRaycaster",source:"@site/docs/api/classes/openbim_components.SimpleRaycaster.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.SimpleRaycaster",permalink:"/api/classes/openbim_components.SimpleRaycaster",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.SimpleRaycaster",title:"Class: SimpleRaycaster",sidebar_label:"SimpleRaycaster",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"SimplePlane",permalink:"/api/classes/openbim_components.SimplePlane"},next:{title:"SimpleRenderer",permalink:"/api/classes/openbim_components.SimpleRenderer"}},d={},m=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"mouse",id:"mouse",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Methods",id:"methods",level:2},{value:"castRay",id:"castray",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-11",level:4}],c={toc:m},u="wrapper";function h(e){var t=e.components,n=(0,a.Z)(e,s);return(0,r.kt)(u,(0,i.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".SimpleRaycaster"),(0,r.kt)("p",null,"A simple ",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/core/Raycaster"},"raycaster"),"\nthat allows to easily get items from the scene using the mouse and touch\nevents."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("inlineCode",{parentName:"p"},"BaseRaycaster")),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"SimpleRaycaster"))))),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,r.kt)("inlineCode",{parentName:"a"},"Disposable")))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"enabled"},"enabled"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"enabled"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"true")),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,"BaseRaycaster.enabled"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleRaycaster/index.ts#L13"},"src/core/SimpleRaycaster/index.ts:13")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"mouse"},"mouse"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"mouse"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Mouse"},(0,r.kt)("inlineCode",{parentName:"a"},"Mouse"))),(0,r.kt)("p",null,"The position of the mouse in the screen."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleRaycaster/index.ts#L19"},"src/core/SimpleRaycaster/index.ts:19")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"undefined"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,r.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,"BaseRaycaster.onDisposed"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleRaycaster/index.ts#L16"},"src/core/SimpleRaycaster/index.ts:16")),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"castray"},"castRay"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"castRay"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"items?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Intersection"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Object3D"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">",">"),(0,r.kt)("p",null,"Throws a ray from the camera to the mouse or touch event point and returns\nthe first item found. This also takes into account the clipping planes\nused by the renderer."),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"items")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Mesh"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Material"),"[], ",(0,r.kt)("inlineCode",{parentName:"td"},"Object3DEventMap"),">","[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"the ",(0,r.kt)("a",{parentName:"td",href:"https://threejs.org/docs/#api/en/objects/Mesh"},"meshes")," to query. If not provided, it will query all the meshes stored in ",(0,r.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.Components#meshes"},"Components.meshes"),".")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Intersection"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Object3D"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">",">"),(0,r.kt)("h4",{id:"overrides-2"},"Overrides"),(0,r.kt)("p",null,"BaseRaycaster.castRay"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleRaycaster/index.ts#L51"},"src/core/SimpleRaycaster/index.ts:51")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"dispose"},"dispose"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,r.kt)("h4",{id:"overrides-3"},"Overrides"),(0,r.kt)("p",null,"BaseRaycaster.dispose"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleRaycaster/index.ts#L36"},"src/core/SimpleRaycaster/index.ts:36")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"get"},"get"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"get"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Raycaster")),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Raycaster")),(0,r.kt)("h4",{id:"overrides-4"},"Overrides"),(0,r.kt)("p",null,"BaseRaycaster.get"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleRaycaster/index.ts#L31"},"src/core/SimpleRaycaster/index.ts:31")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hasui"},"hasUI"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,r.kt)("p",null,"Whether is component implements any kind of ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,"this is UI"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,"BaseRaycaster.hasUI"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,"this is Configurable"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,"BaseRaycaster.isConfigurable"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,"this is Disposable"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,"BaseRaycaster.isDisposeable"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ishideable"},"isHideable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,"this is Hideable"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,"BaseRaycaster.isHideable"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,"this is Resizeable"),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,"BaseRaycaster.isResizeable"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,"this is Updateable"),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,"BaseRaycaster.isUpdateable"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/3303a5a5.f54ad3ac.js b/build/assets/js/3303a5a5.f54ad3ac.js deleted file mode 100644 index 9663b4e2..00000000 --- a/build/assets/js/3303a5a5.f54ad3ac.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6692],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>h});var i=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function s(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=i.createContext({}),o=function(e){var t=i.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},d=function(e){var t=o(e.components);return i.createElement(p.Provider,{value:t},e.children)},m="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},u=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,r=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),m=o(n),u=a,h=m["".concat(p,".").concat(u)]||m[u]||c[u]||r;return n?i.createElement(h,s(s({ref:t},d),{},{components:n})):i.createElement(h,s({ref:t},d))}));function h(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,s=new Array(r);s[0]=u;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[m]="string"==typeof e?e:a,s[1]=l;for(var o=2;o{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>p,default:()=>h,frontMatter:()=>l,metadata:()=>o,toc:()=>m});var i=n(7462),a=n(3366),r=(n(7294),n(3905)),s=["components"],l={id:"openbim_components.SimpleRaycaster",title:"Class: SimpleRaycaster",sidebar_label:"SimpleRaycaster",custom_edit_url:null},p=void 0,o={unversionedId:"api/classes/openbim_components.SimpleRaycaster",id:"api/classes/openbim_components.SimpleRaycaster",title:"Class: SimpleRaycaster",description:"openbim-components.SimpleRaycaster",source:"@site/docs/api/classes/openbim_components.SimpleRaycaster.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.SimpleRaycaster",permalink:"/api/classes/openbim_components.SimpleRaycaster",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.SimpleRaycaster",title:"Class: SimpleRaycaster",sidebar_label:"SimpleRaycaster",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"SimplePlane",permalink:"/api/classes/openbim_components.SimplePlane"},next:{title:"SimpleRenderer",permalink:"/api/classes/openbim_components.SimpleRenderer"}},d={},m=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"mouse",id:"mouse",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Methods",id:"methods",level:2},{value:"castRay",id:"castray",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-11",level:4}],c={toc:m},u="wrapper";function h(e){var t=e.components,n=(0,a.Z)(e,s);return(0,r.kt)(u,(0,i.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".SimpleRaycaster"),(0,r.kt)("p",null,"A simple ",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/core/Raycaster"},"raycaster"),"\nthat allows to easily get items from the scene using the mouse and touch\nevents."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("inlineCode",{parentName:"p"},"BaseRaycaster")),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"SimpleRaycaster"))))),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,r.kt)("inlineCode",{parentName:"a"},"Disposable")))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"enabled"},"enabled"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"enabled"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"true")),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,"BaseRaycaster.enabled"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleRaycaster/index.ts#L13"},"temp/engine_components/src/core/SimpleRaycaster/index.ts:13")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"mouse"},"mouse"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"mouse"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Mouse"},(0,r.kt)("inlineCode",{parentName:"a"},"Mouse"))),(0,r.kt)("p",null,"The position of the mouse in the screen."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleRaycaster/index.ts#L19"},"temp/engine_components/src/core/SimpleRaycaster/index.ts:19")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"undefined"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,r.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,"BaseRaycaster.onDisposed"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleRaycaster/index.ts#L16"},"temp/engine_components/src/core/SimpleRaycaster/index.ts:16")),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"castray"},"castRay"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"castRay"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"items?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Intersection"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Object3D"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">",">"),(0,r.kt)("p",null,"Throws a ray from the camera to the mouse or touch event point and returns\nthe first item found. This also takes into account the clipping planes\nused by the renderer."),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"items")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Mesh"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Material"),"[], ",(0,r.kt)("inlineCode",{parentName:"td"},"Object3DEventMap"),">","[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"the ",(0,r.kt)("a",{parentName:"td",href:"https://threejs.org/docs/#api/en/objects/Mesh"},"meshes")," to query. If not provided, it will query all the meshes stored in ",(0,r.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.Components#meshes"},"Components.meshes"),".")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Intersection"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Object3D"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">",">"),(0,r.kt)("h4",{id:"overrides-2"},"Overrides"),(0,r.kt)("p",null,"BaseRaycaster.castRay"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleRaycaster/index.ts#L51"},"temp/engine_components/src/core/SimpleRaycaster/index.ts:51")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"dispose"},"dispose"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,r.kt)("h4",{id:"overrides-3"},"Overrides"),(0,r.kt)("p",null,"BaseRaycaster.dispose"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleRaycaster/index.ts#L36"},"temp/engine_components/src/core/SimpleRaycaster/index.ts:36")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"get"},"get"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"get"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Raycaster")),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Raycaster")),(0,r.kt)("h4",{id:"overrides-4"},"Overrides"),(0,r.kt)("p",null,"BaseRaycaster.get"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleRaycaster/index.ts#L31"},"temp/engine_components/src/core/SimpleRaycaster/index.ts:31")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hasui"},"hasUI"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,r.kt)("p",null,"Whether is component implements any kind of ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,"this is UI"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,"BaseRaycaster.hasUI"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,"this is Configurable"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,"BaseRaycaster.isConfigurable"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,"this is Disposable"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,"BaseRaycaster.isDisposeable"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ishideable"},"isHideable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,"this is Hideable"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,"BaseRaycaster.isHideable"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,"this is Resizeable"),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,"BaseRaycaster.isResizeable"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,"this is Updateable"),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,"BaseRaycaster.isUpdateable"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/393be207.de781a15.js b/build/assets/js/393be207.de781a15.js deleted file mode 100644 index 62d4f3df..00000000 --- a/build/assets/js/393be207.de781a15.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7414],{3905:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>d});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function p(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=n.createContext({}),i=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):p(p({},t),e)),r},u=function(e){var t=i(e.components);return n.createElement(l.Provider,{value:t},e.children)},f="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},s=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,u=c(e,["components","mdxType","originalType","parentName"]),f=i(r),s=o,d=f["".concat(l,".").concat(s)]||f[s]||m[s]||a;return r?n.createElement(d,p(p({ref:t},u),{},{components:r})):n.createElement(d,p({ref:t},u))}));function d(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,p=new Array(a);p[0]=s;var c={};for(var l in t)hasOwnProperty.call(t,l)&&(c[l]=t[l]);c.originalType=e,c[f]="string"==typeof e?e:o,p[1]=c;for(var i=2;i{r.r(t),r.d(t,{contentTitle:()=>l,default:()=>s,frontMatter:()=>c,metadata:()=>i,toc:()=>u});var n=r(7462),o=r(3366),a=(r(7294),r(3905)),p=["components"],c={title:"Markdown page example"},l="Markdown page example",i={type:"mdx",permalink:"/markdown-page",source:"@site/src/pages/markdown-page.md",title:"Markdown page example",description:"You don't need React to write simple standalone pages.",frontMatter:{title:"Markdown page example"}},u=[],f={toc:u},m="wrapper";function s(e){var t=e.components,r=(0,o.Z)(e,p);return(0,a.kt)(m,(0,n.Z)({},f,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"markdown-page-example"},"Markdown page example"),(0,a.kt)("p",null,"You don't need React to write simple standalone pages."))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/4f2f3afd.62b52e9a.js b/build/assets/js/4f2f3afd.62b52e9a.js deleted file mode 100644 index 09b80988..00000000 --- a/build/assets/js/4f2f3afd.62b52e9a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3554],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>b});var a=t(7294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function p(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,a)}return t}function r(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var l=a.createContext({}),s=function(e){var n=a.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):r(r({},n),e)),t},m=function(e){var n=s(e.components);return a.createElement(l.Provider,{value:n},e.children)},c="mdxType",d={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},u=a.forwardRef((function(e,n){var t=e.components,i=e.mdxType,p=e.originalType,l=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),c=s(t),u=i,b=c["".concat(l,".").concat(u)]||c[u]||d[u]||p;return t?a.createElement(b,r(r({ref:n},m),{},{components:t})):a.createElement(b,r({ref:n},m))}));function b(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var p=t.length,r=new Array(p);r[0]=u;var o={};for(var l in n)hasOwnProperty.call(n,l)&&(o[l]=n[l]);o.originalType=e,o[c]="string"==typeof e?e:i,r[1]=o;for(var s=2;s{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>l,default:()=>b,frontMatter:()=>o,metadata:()=>s,toc:()=>c});var a=t(7462),i=t(3366),p=(t(7294),t(3905)),r=["components"],o={id:"openbim_components.Disposable",title:"Interface: Disposable",sidebar_label:"Disposable",custom_edit_url:null},l=void 0,s={unversionedId:"api/interfaces/openbim_components.Disposable",id:"api/interfaces/openbim_components.Disposable",title:"Interface: Disposable",description:"openbim-components.Disposable",source:"@site/docs/api/interfaces/openbim_components.Disposable.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/openbim_components.Disposable",permalink:"/api/interfaces/openbim_components.Disposable",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Disposable",title:"Interface: Disposable",sidebar_label:"Disposable",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Createable",permalink:"/api/interfaces/openbim_components.Createable"},next:{title:"FragmentIdMap",permalink:"/api/interfaces/openbim_components.FragmentIdMap"}},m={},c=[{value:"Implemented by",id:"implemented-by",level:2},{value:"Properties",id:"properties",level:2},{value:"dispose",id:"dispose",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Defined in",id:"defined-in-1",level:4}],d={toc:c},u="wrapper";function b(e){var n=e.components,t=(0,i.Z)(e,r);return(0,p.kt)(u,(0,a.Z)({},d,t,{components:n,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Disposable"),(0,p.kt)("p",null,"Whether this component has to be manually destroyed once you are done with\nit to prevent\n",(0,p.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#manual/en/introduction/How-to-dispose-of-objects"},"memory leaks"),".\nThis also ensures that the DOM events created by that component will be\ncleaned up."),(0,p.kt)("h2",{id:"implemented-by"},"Implemented by"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Components"},(0,p.kt)("inlineCode",{parentName:"a"},"Components"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.CubeMap"},(0,p.kt)("inlineCode",{parentName:"a"},"CubeMap"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentBoundingBox"},(0,p.kt)("inlineCode",{parentName:"a"},"FragmentBoundingBox"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentManager"},(0,p.kt)("inlineCode",{parentName:"a"},"FragmentManager"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentPlans"},(0,p.kt)("inlineCode",{parentName:"a"},"FragmentPlans"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.LengthMeasurement"},(0,p.kt)("inlineCode",{parentName:"a"},"LengthMeasurement"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.MaterialManager"},(0,p.kt)("inlineCode",{parentName:"a"},"MaterialManager"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Mouse"},(0,p.kt)("inlineCode",{parentName:"a"},"Mouse"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.ScreenCuller"},(0,p.kt)("inlineCode",{parentName:"a"},"ScreenCuller"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Simple2DScene"},(0,p.kt)("inlineCode",{parentName:"a"},"Simple2DScene"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleCamera"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleCamera"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleClipper"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleClipper"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleGrid"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleGrid"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimplePlane"},(0,p.kt)("inlineCode",{parentName:"a"},"SimplePlane"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleRaycaster"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleRaycaster"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleRenderer"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleRenderer"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleScene"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleScene"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.ToolComponent"},(0,p.kt)("inlineCode",{parentName:"a"},"ToolComponent"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.UIManager"},(0,p.kt)("inlineCode",{parentName:"a"},"UIManager")))),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"dispose"},"dispose"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"dispose"),": () => ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,p.kt)("p",null,"\u25b8 (): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,"Destroys the object from memory to prevent a\n",(0,p.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#manual/en/introduction/How-to-dispose-of-objects"},"memory leak"),"."),(0,p.kt)("h5",{id:"returns"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L60"},"temp/engine_components/src/base-types/base-types.ts:60")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,p.kt)("p",null,"Fired after the tool has been ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"()")),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L63"},"temp/engine_components/src/base-types/base-types.ts:63")))}b.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/4f2f3afd.f37a27d5.js b/build/assets/js/4f2f3afd.f37a27d5.js new file mode 100644 index 00000000..a19ebcdd --- /dev/null +++ b/build/assets/js/4f2f3afd.f37a27d5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3554],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>b});var a=t(7294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,a)}return t}function p(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var l=a.createContext({}),s=function(e){var n=a.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):p(p({},n),e)),t},m=function(e){var n=s(e.components);return a.createElement(l.Provider,{value:n},e.children)},c="mdxType",d={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},u=a.forwardRef((function(e,n){var t=e.components,i=e.mdxType,r=e.originalType,l=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),c=s(t),u=i,b=c["".concat(l,".").concat(u)]||c[u]||d[u]||r;return t?a.createElement(b,p(p({ref:n},m),{},{components:t})):a.createElement(b,p({ref:n},m))}));function b(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var r=t.length,p=new Array(r);p[0]=u;var o={};for(var l in n)hasOwnProperty.call(n,l)&&(o[l]=n[l]);o.originalType=e,o[c]="string"==typeof e?e:i,p[1]=o;for(var s=2;s{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>l,default:()=>b,frontMatter:()=>o,metadata:()=>s,toc:()=>c});var a=t(7462),i=t(3366),r=(t(7294),t(3905)),p=["components"],o={id:"openbim_components.Disposable",title:"Interface: Disposable",sidebar_label:"Disposable",custom_edit_url:null},l=void 0,s={unversionedId:"api/interfaces/openbim_components.Disposable",id:"api/interfaces/openbim_components.Disposable",title:"Interface: Disposable",description:"openbim-components.Disposable",source:"@site/docs/api/interfaces/openbim_components.Disposable.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/openbim_components.Disposable",permalink:"/api/interfaces/openbim_components.Disposable",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Disposable",title:"Interface: Disposable",sidebar_label:"Disposable",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Createable",permalink:"/api/interfaces/openbim_components.Createable"},next:{title:"FragmentIdMap",permalink:"/api/interfaces/openbim_components.FragmentIdMap"}},m={},c=[{value:"Implemented by",id:"implemented-by",level:2},{value:"Properties",id:"properties",level:2},{value:"dispose",id:"dispose",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Defined in",id:"defined-in-1",level:4}],d={toc:c},u="wrapper";function b(e){var n=e.components,t=(0,i.Z)(e,p);return(0,r.kt)(u,(0,a.Z)({},d,t,{components:n,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Disposable"),(0,r.kt)("p",null,"Whether this component has to be manually destroyed once you are done with\nit to prevent\n",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#manual/en/introduction/How-to-dispose-of-objects"},"memory leaks"),".\nThis also ensures that the DOM events created by that component will be\ncleaned up."),(0,r.kt)("h2",{id:"implemented-by"},"Implemented by"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Components"},(0,r.kt)("inlineCode",{parentName:"a"},"Components"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.CubeMap"},(0,r.kt)("inlineCode",{parentName:"a"},"CubeMap"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentBoundingBox"},(0,r.kt)("inlineCode",{parentName:"a"},"FragmentBoundingBox"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentManager"},(0,r.kt)("inlineCode",{parentName:"a"},"FragmentManager"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentPlans"},(0,r.kt)("inlineCode",{parentName:"a"},"FragmentPlans"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.LengthMeasurement"},(0,r.kt)("inlineCode",{parentName:"a"},"LengthMeasurement"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.MaterialManager"},(0,r.kt)("inlineCode",{parentName:"a"},"MaterialManager"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Mouse"},(0,r.kt)("inlineCode",{parentName:"a"},"Mouse"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.ScreenCuller"},(0,r.kt)("inlineCode",{parentName:"a"},"ScreenCuller"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Simple2DScene"},(0,r.kt)("inlineCode",{parentName:"a"},"Simple2DScene"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleCamera"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleCamera"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleClipper"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleClipper"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleGrid"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleGrid"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimplePlane"},(0,r.kt)("inlineCode",{parentName:"a"},"SimplePlane"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleRaycaster"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleRaycaster"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleRenderer"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleRenderer"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleScene"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleScene"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.ToolComponent"},(0,r.kt)("inlineCode",{parentName:"a"},"ToolComponent"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.UIManager"},(0,r.kt)("inlineCode",{parentName:"a"},"UIManager")))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"dispose"},"dispose"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"dispose"),": () => ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Destroys the object from memory to prevent a\n",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#manual/en/introduction/How-to-dispose-of-objects"},"memory leak"),"."),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L60"},"src/base-types/base-types.ts:60")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Fired after the tool has been ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"()")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L63"},"src/base-types/base-types.ts:63")))}b.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/51e85c26.8b238bc5.js b/build/assets/js/51e85c26.8b238bc5.js new file mode 100644 index 00000000..35a2ca33 --- /dev/null +++ b/build/assets/js/51e85c26.8b238bc5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4345],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>u});var a=t(7294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,a)}return t}function o(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var l=a.createContext({}),s=function(e){var n=a.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},d=function(e){var n=s(e.components);return a.createElement(l.Provider,{value:n},e.children)},m="mdxType",c={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},k=a.forwardRef((function(e,n){var t=e.components,i=e.mdxType,r=e.originalType,l=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),m=s(t),k=i,u=m["".concat(l,".").concat(k)]||m[k]||c[k]||r;return t?a.createElement(u,o(o({ref:n},d),{},{components:t})):a.createElement(u,o({ref:n},d))}));function u(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var r=t.length,o=new Array(r);o[0]=k;var p={};for(var l in n)hasOwnProperty.call(n,l)&&(p[l]=n[l]);p.originalType=e,p[m]="string"==typeof e?e:i,o[1]=p;for(var s=2;s{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>l,default:()=>u,frontMatter:()=>p,metadata:()=>s,toc:()=>m});var a=t(7462),i=t(3366),r=(t(7294),t(3905)),o=["components"],p={id:"openbim_components.Components",title:"Class: Components",sidebar_label:"Components",custom_edit_url:null},l=void 0,s={unversionedId:"api/classes/openbim_components.Components",id:"api/classes/openbim_components.Components",title:"Class: Components",description:"openbim-components.Components",source:"@site/docs/api/classes/openbim_components.Components.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.Components",permalink:"/api/classes/openbim_components.Components",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Components",title:"Class: Components",sidebar_label:"Components",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Component",permalink:"/api/classes/openbim_components.Component"},next:{title:"CubeMap",permalink:"/api/classes/openbim_components.CubeMap"}},d={},m=[{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"meshes",id:"meshes",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"onInitialized",id:"oninitialized",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"tools",id:"tools",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"uiEnabled",id:"uienabled",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"Accessors",id:"accessors",level:2},{value:"camera",id:"camera",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"raycaster",id:"raycaster",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"renderer",id:"renderer",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"scene",id:"scene",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"ui",id:"ui",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"init",id:"init",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-15",level:4}],c={toc:m},k="wrapper";function u(e){var n=e.components,t=(0,i.Z)(e,o);return(0,r.kt)(k,(0,a.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Components"),(0,r.kt)("p",null,"The entry point of Open BIM Components.\nIt contains the basic items to create a BIM 3D scene based on Three.js, as\nwell as all the tools provided by this library. It also manages the update\nloop of everything. Each instance has to be initialized with ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Components#init"},"init"),"."),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,r.kt)("inlineCode",{parentName:"a"},"Disposable")))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"meshes"},"meshes"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"meshes"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Set"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,r.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">",">"),(0,r.kt)("p",null,"All the loaded ",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/objects/Mesh"},"meshes"),".\nThis includes fragments, 3D scans, etc."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Components/index.ts#L29"},"src/core/Components/index.ts:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,r.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Components/index.ts#L38"},"src/core/Components/index.ts:38")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"oninitialized"},"onInitialized"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onInitialized"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Components"},(0,r.kt)("inlineCode",{parentName:"a"},"Components")),">"),(0,r.kt)("p",null,"Event that fires when this instance has been fully initialized and is\nready to work (scene, camera and renderer are ready)."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Components/index.ts#L35"},"src/core/Components/index.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tools"},"tools"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"tools"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.ToolComponent"},(0,r.kt)("inlineCode",{parentName:"a"},"ToolComponent"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.ToolComponent"},"ToolComponent")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Components/index.ts#L23"},"src/core/Components/index.ts:23")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"uienabled"},"uiEnabled"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"uiEnabled"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"true")),(0,r.kt)("p",null,"Whether UI components should be created."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Components/index.ts#L45"},"src/core/Components/index.ts:45")),(0,r.kt)("h2",{id:"accessors"},"Accessors"),(0,r.kt)("h3",{id:"camera"},"camera"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"camera"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,r.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Camera"),">"),(0,r.kt)("p",null,"The ",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/cameras/Camera"},"Three.js camera"),"\nthat determines the point of view of the renderer."),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,r.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Camera"),">"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Components/index.ts#L103"},"src/core/Components/index.ts:103")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"camera"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"camera"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"This needs to be initialized before calling init()."),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"camera")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.Component"},(0,r.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Camera"),">")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Components/index.ts#L113"},"src/core/Components/index.ts:113")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"raycaster"},"raycaster"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"raycaster"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"BaseRaycaster")),(0,r.kt)("p",null,"A component using the ",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/core/Raycaster"},"Three.js raycaster"),"\nused primarily to pick 3D items with the mouse or a touch screen."),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"BaseRaycaster")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Components/index.ts#L121"},"src/core/Components/index.ts:121")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"raycaster"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"raycaster"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Although this is not necessary to make the library work, it's necessary\nto initialize this if any component that needs a raycaster is used."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"raycaster")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"BaseRaycaster"))))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Components/index.ts#L132"},"src/core/Components/index.ts:132")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"renderer"},"renderer"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"renderer"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},(0,r.kt)("inlineCode",{parentName:"a"},"BaseRenderer"))),(0,r.kt)("p",null,"The ",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer"},"Three.js renderer"),"\nused to render the scene. This library provides multiple renderer\ncomponents with pre-made functionality (e.g. rendering of 2D CSS elements."),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},(0,r.kt)("inlineCode",{parentName:"a"},"BaseRenderer"))),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Components/index.ts#L67"},"src/core/Components/index.ts:67")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"renderer"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"renderer"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"This needs to be initialized before calling init()."),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"renderer")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.BaseRenderer"},(0,r.kt)("inlineCode",{parentName:"a"},"BaseRenderer")))))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Components/index.ts#L77"},"src/core/Components/index.ts:77")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"scene"},"scene"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"scene"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,r.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Scene"),">"),(0,r.kt)("p",null,"The ",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/scenes/Scene"},"Three.js scene"),"\nwhere all the rendered items are placed."),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,r.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Scene"),">"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Components/index.ts#L85"},"src/core/Components/index.ts:85")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"scene"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"scene"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"This needs to be initialized before calling init()."),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"scene")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.Component"},(0,r.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Scene"),">")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Components/index.ts#L95"},"src/core/Components/index.ts:95")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ui"},"ui"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"ui"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.UIManager"},(0,r.kt)("inlineCode",{parentName:"a"},"UIManager"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.UIManager"},"UIManager")),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.UIManager"},(0,r.kt)("inlineCode",{parentName:"a"},"UIManager"))),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Components/index.ts#L55"},"src/core/Components/index.ts:55")),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"dispose"},"dispose"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Disposes the memory of all the components and tools of this instance of\nthe library. A memory leak will be created if:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},"An instance of the library ends up out of scope and this function isn't\ncalled. This is especially relevant in Single Page Applications (React,\nAngular, Vue, etc).")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},"Any of the objects of this instance (meshes, geometries, etc) is\nreferenced by a reference type (object or array)."))),(0,r.kt)("p",null,"You can learn more about how Three.js handles memory leaks\n",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#manual/en/introduction/How-to-dispose-of-objects"},"here"),"."),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Components/index.ts#L174"},"src/core/Components/index.ts:174")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"init"},"init"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"init"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Initializes the library. It should be called at the start of the app after\ninitializing the scene, the renderer and the\ncamera. Additionally, if any component that need a raycaster is\nused, the ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Components#raycaster"},"raycaster")," will need to be initialized."),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Components/index.ts#L148"},"src/core/Components/index.ts:148")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/51e85c26.ce497415.js b/build/assets/js/51e85c26.ce497415.js deleted file mode 100644 index 4d8ab169..00000000 --- a/build/assets/js/51e85c26.ce497415.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4345],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>u});var a=t(7294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,a)}return t}function o(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var s=a.createContext({}),l=function(e){var n=a.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},m=function(e){var n=l(e.components);return a.createElement(s.Provider,{value:n},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},k=a.forwardRef((function(e,n){var t=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),d=l(t),k=i,u=d["".concat(s,".").concat(k)]||d[k]||c[k]||r;return t?a.createElement(u,o(o({ref:n},m),{},{components:t})):a.createElement(u,o({ref:n},m))}));function u(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var r=t.length,o=new Array(r);o[0]=k;var p={};for(var s in n)hasOwnProperty.call(n,s)&&(p[s]=n[s]);p.originalType=e,p[d]="string"==typeof e?e:i,o[1]=p;for(var l=2;l{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>s,default:()=>u,frontMatter:()=>p,metadata:()=>l,toc:()=>d});var a=t(7462),i=t(3366),r=(t(7294),t(3905)),o=["components"],p={id:"openbim_components.Components",title:"Class: Components",sidebar_label:"Components",custom_edit_url:null},s=void 0,l={unversionedId:"api/classes/openbim_components.Components",id:"api/classes/openbim_components.Components",title:"Class: Components",description:"openbim-components.Components",source:"@site/docs/api/classes/openbim_components.Components.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.Components",permalink:"/api/classes/openbim_components.Components",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Components",title:"Class: Components",sidebar_label:"Components",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Component",permalink:"/api/classes/openbim_components.Component"},next:{title:"CubeMap",permalink:"/api/classes/openbim_components.CubeMap"}},m={},d=[{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"meshes",id:"meshes",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"onInitialized",id:"oninitialized",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"tools",id:"tools",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"uiEnabled",id:"uienabled",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"Accessors",id:"accessors",level:2},{value:"camera",id:"camera",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"raycaster",id:"raycaster",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"renderer",id:"renderer",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"scene",id:"scene",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"ui",id:"ui",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"init",id:"init",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-15",level:4}],c={toc:d},k="wrapper";function u(e){var n=e.components,t=(0,i.Z)(e,o);return(0,r.kt)(k,(0,a.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Components"),(0,r.kt)("p",null,"The entry point of Open BIM Components.\nIt contains the basic items to create a BIM 3D scene based on Three.js, as\nwell as all the tools provided by this library. It also manages the update\nloop of everything. Each instance has to be initialized with ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Components#init"},"init"),"."),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,r.kt)("inlineCode",{parentName:"a"},"Disposable")))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"meshes"},"meshes"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"meshes"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Set"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,r.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">",">"),(0,r.kt)("p",null,"All the loaded ",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/objects/Mesh"},"meshes"),".\nThis includes fragments, 3D scans, etc."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Components/index.ts#L29"},"temp/engine_components/src/core/Components/index.ts:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,r.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Components/index.ts#L38"},"temp/engine_components/src/core/Components/index.ts:38")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"oninitialized"},"onInitialized"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onInitialized"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Components"},(0,r.kt)("inlineCode",{parentName:"a"},"Components")),">"),(0,r.kt)("p",null,"Event that fires when this instance has been fully initialized and is\nready to work (scene, camera and renderer are ready)."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Components/index.ts#L35"},"temp/engine_components/src/core/Components/index.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tools"},"tools"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"tools"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.ToolComponent"},(0,r.kt)("inlineCode",{parentName:"a"},"ToolComponent"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.ToolComponent"},"ToolComponent")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Components/index.ts#L23"},"temp/engine_components/src/core/Components/index.ts:23")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"uienabled"},"uiEnabled"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"uiEnabled"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"true")),(0,r.kt)("p",null,"Whether UI components should be created."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Components/index.ts#L45"},"temp/engine_components/src/core/Components/index.ts:45")),(0,r.kt)("h2",{id:"accessors"},"Accessors"),(0,r.kt)("h3",{id:"camera"},"camera"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"camera"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,r.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Camera"),">"),(0,r.kt)("p",null,"The ",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/cameras/Camera"},"Three.js camera"),"\nthat determines the point of view of the renderer."),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,r.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Camera"),">"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Components/index.ts#L103"},"temp/engine_components/src/core/Components/index.ts:103")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"camera"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"camera"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"This needs to be initialized before calling init()."),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"camera")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.Component"},(0,r.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Camera"),">")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Components/index.ts#L113"},"temp/engine_components/src/core/Components/index.ts:113")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"raycaster"},"raycaster"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"raycaster"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"BaseRaycaster")),(0,r.kt)("p",null,"A component using the ",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/core/Raycaster"},"Three.js raycaster"),"\nused primarily to pick 3D items with the mouse or a touch screen."),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"BaseRaycaster")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Components/index.ts#L121"},"temp/engine_components/src/core/Components/index.ts:121")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"raycaster"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"raycaster"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Although this is not necessary to make the library work, it's necessary\nto initialize this if any component that needs a raycaster is used."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"raycaster")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"BaseRaycaster"))))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Components/index.ts#L132"},"temp/engine_components/src/core/Components/index.ts:132")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"renderer"},"renderer"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"renderer"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},(0,r.kt)("inlineCode",{parentName:"a"},"BaseRenderer"))),(0,r.kt)("p",null,"The ",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer"},"Three.js renderer"),"\nused to render the scene. This library provides multiple renderer\ncomponents with pre-made functionality (e.g. rendering of 2D CSS elements."),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},(0,r.kt)("inlineCode",{parentName:"a"},"BaseRenderer"))),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Components/index.ts#L67"},"temp/engine_components/src/core/Components/index.ts:67")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"renderer"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"renderer"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"This needs to be initialized before calling init()."),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"renderer")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.BaseRenderer"},(0,r.kt)("inlineCode",{parentName:"a"},"BaseRenderer")))))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Components/index.ts#L77"},"temp/engine_components/src/core/Components/index.ts:77")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"scene"},"scene"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"scene"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,r.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Scene"),">"),(0,r.kt)("p",null,"The ",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/scenes/Scene"},"Three.js scene"),"\nwhere all the rendered items are placed."),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,r.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Scene"),">"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Components/index.ts#L85"},"temp/engine_components/src/core/Components/index.ts:85")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"scene"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"scene"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"This needs to be initialized before calling init()."),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"scene")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.Component"},(0,r.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Scene"),">")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Components/index.ts#L95"},"temp/engine_components/src/core/Components/index.ts:95")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ui"},"ui"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"ui"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.UIManager"},(0,r.kt)("inlineCode",{parentName:"a"},"UIManager"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.UIManager"},"UIManager")),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.UIManager"},(0,r.kt)("inlineCode",{parentName:"a"},"UIManager"))),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Components/index.ts#L55"},"temp/engine_components/src/core/Components/index.ts:55")),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"dispose"},"dispose"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Disposes the memory of all the components and tools of this instance of\nthe library. A memory leak will be created if:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},"An instance of the library ends up out of scope and this function isn't\ncalled. This is especially relevant in Single Page Applications (React,\nAngular, Vue, etc).")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},"Any of the objects of this instance (meshes, geometries, etc) is\nreferenced by a reference type (object or array)."))),(0,r.kt)("p",null,"You can learn more about how Three.js handles memory leaks\n",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#manual/en/introduction/How-to-dispose-of-objects"},"here"),"."),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Components/index.ts#L174"},"temp/engine_components/src/core/Components/index.ts:174")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"init"},"init"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"init"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Initializes the library. It should be called at the start of the app after\ninitializing the scene, the renderer and the\ncamera. Additionally, if any component that need a raycaster is\nused, the ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Components#raycaster"},"raycaster")," will need to be initialized."),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Components/index.ts#L148"},"temp/engine_components/src/core/Components/index.ts:148")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/55483fbd.15062613.js b/build/assets/js/55483fbd.15062613.js new file mode 100644 index 00000000..e497311b --- /dev/null +++ b/build/assets/js/55483fbd.15062613.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5241],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>k});var i=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function p(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function l(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var r=i.createContext({}),s=function(e){var n=i.useContext(r),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},m=function(e){var n=s(e.components);return i.createElement(r.Provider,{value:n},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},u=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,p=e.originalType,r=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),d=s(t),u=a,k=d["".concat(r,".").concat(u)]||d[u]||c[u]||p;return t?i.createElement(k,l(l({ref:n},m),{},{components:t})):i.createElement(k,l({ref:n},m))}));function k(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var p=t.length,l=new Array(p);l[0]=u;var o={};for(var r in n)hasOwnProperty.call(n,r)&&(o[r]=n[r]);o.originalType=e,o[d]="string"==typeof e?e:a,l[1]=o;for(var s=2;s{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>r,default:()=>k,frontMatter:()=>o,metadata:()=>s,toc:()=>d});var i=t(7462),a=t(3366),p=(t(7294),t(3905)),l=["components"],o={id:"openbim_components.Simple2DScene",title:"Class: Simple2DScene",sidebar_label:"Simple2DScene",custom_edit_url:null},r=void 0,s={unversionedId:"api/classes/openbim_components.Simple2DScene",id:"api/classes/openbim_components.Simple2DScene",title:"Class: Simple2DScene",description:"openbim-components.Simple2DScene",source:"@site/docs/api/classes/openbim_components.Simple2DScene.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.Simple2DScene",permalink:"/api/classes/openbim_components.Simple2DScene",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Simple2DScene",title:"Class: Simple2DScene",sidebar_label:"Simple2DScene",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ScreenCuller",permalink:"/api/classes/openbim_components.ScreenCuller"},next:{title:"SimpleCamera",permalink:"/api/classes/openbim_components.SimpleCamera"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"camera",id:"camera",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"controls",id:"controls",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onAfterUpdate",id:"onafterupdate",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"onBeforeUpdate",id:"onbeforeupdate",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"onResize",id:"onresize",level:3},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"uiElement",id:"uielement",level:3},{value:"Implementation of",id:"implementation-of-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Implementation of",id:"implementation-of-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getSize",id:"getsize",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Implementation of",id:"implementation-of-6",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"resize",id:"resize",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Implementation of",id:"implementation-of-7",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"update",id:"update",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Implementation of",id:"implementation-of-8",level:4},{value:"Defined in",id:"defined-in-18",level:4}],c={toc:d},u="wrapper";function k(e){var n=e.components,t=(0,a.Z)(e,l);return(0,p.kt)(u,(0,i.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Simple2DScene"),(0,p.kt)("p",null,"A simple floating 2D scene that you can use to easily draw 2D graphics\nwith all the power of Three.js."),(0,p.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("p",{parentName:"li"},(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,p.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"THREE.Group"),">"),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"Simple2DScene"))))),(0,p.kt)("h2",{id:"implements"},"Implements"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},(0,p.kt)("inlineCode",{parentName:"a"},"UI"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Updateable"},(0,p.kt)("inlineCode",{parentName:"a"},"Updateable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,p.kt)("inlineCode",{parentName:"a"},"Disposable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Resizeable"},(0,p.kt)("inlineCode",{parentName:"a"},"Resizeable")))),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"camera"},"camera"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"camera"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,p.kt)("p",null,"The camera that renders the scene."),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Simple2DScene/index.ts#L55"},"src/core/Simple2DScene/index.ts:55")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"controls"},"controls"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"controls"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"CameraControls")),(0,p.kt)("p",null,"The camera controls that move around in the scene."),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Simple2DScene/index.ts#L52"},"src/core/Simple2DScene/index.ts:52")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"enabled"},"enabled"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"enabled"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,p.kt)("inlineCode",{parentName:"p"},"true")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,p.kt)("h4",{id:"overrides"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Simple2DScene/index.ts#L41"},"src/core/Simple2DScene/index.ts:41")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"Updateable.onAfterUpdate")),(0,p.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"onAfterUpdate")),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Simple2DScene/index.ts#L32"},"src/core/Simple2DScene/index.ts:32")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"Updateable.onBeforeUpdate")),(0,p.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"onBeforeUpdate")),(0,p.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Simple2DScene/index.ts#L35"},"src/core/Simple2DScene/index.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,p.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,p.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Simple2DScene/index.ts#L44"},"src/core/Simple2DScene/index.ts:44")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onresize"},"onResize"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"onResize"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"Vector2"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#onresize"},"Resizeable.onResize")),(0,p.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#onresize"},"onResize")),(0,p.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Simple2DScene/index.ts#L38"},"src/core/Simple2DScene/index.ts:38")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"uielement"},"uiElement"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"uiElement"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.UIElement"},(0,p.kt)("inlineCode",{parentName:"a"},"UIElement")),"<{ ",(0,p.kt)("inlineCode",{parentName:"p"},"container"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"SimpleUIComponent"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"HTMLElement"),">"," }",">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI#uielement"},"UI.uiElement")),(0,p.kt)("h4",{id:"implementation-of-4"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI#uielement"},"uiElement")),(0,p.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Simple2DScene/index.ts#L47"},"src/core/Simple2DScene/index.ts:47")),(0,p.kt)("h2",{id:"methods"},"Methods"),(0,p.kt)("h3",{id:"dispose"},"dispose"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,p.kt)("h4",{id:"returns"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"implementation-of-5"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,p.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Simple2DScene/index.ts#L168"},"src/core/Simple2DScene/index.ts:168")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"get"},"get"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"get"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Group"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,p.kt)("h4",{id:"returns-1"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Group"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">"),(0,p.kt)("p",null,"the 2D scene."),(0,p.kt)("h4",{id:"overrides-1"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,p.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Simple2DScene/index.ts#L163"},"src/core/Simple2DScene/index.ts:163")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"getsize"},"getSize"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"getSize"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#getsize"},"Resizeable.getSize")),(0,p.kt)("h4",{id:"returns-2"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,p.kt)("h4",{id:"implementation-of-6"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#getsize"},"getSize")),(0,p.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Simple2DScene/index.ts#L191"},"src/core/Simple2DScene/index.ts:191")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"hasui"},"hasUI"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,p.kt)("p",null,"Whether is component implements any kind of ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,p.kt)("h4",{id:"returns-3"},"Returns"),(0,p.kt)("p",null,"this is UI"),(0,p.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,p.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,p.kt)("h4",{id:"returns-4"},"Returns"),(0,p.kt)("p",null,"this is Configurable"),(0,p.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,p.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,p.kt)("h4",{id:"returns-5"},"Returns"),(0,p.kt)("p",null,"this is Disposable"),(0,p.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,p.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ishideable"},"isHideable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,p.kt)("h4",{id:"returns-6"},"Returns"),(0,p.kt)("p",null,"this is Hideable"),(0,p.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,p.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,p.kt)("h4",{id:"returns-7"},"Returns"),(0,p.kt)("p",null,"this is Resizeable"),(0,p.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,p.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,p.kt)("h4",{id:"returns-8"},"Returns"),(0,p.kt)("p",null,"this is Updateable"),(0,p.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,p.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"resize"},"resize"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"resize"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#resize"},"Resizeable.resize")),(0,p.kt)("h4",{id:"returns-9"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"implementation-of-7"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#resize"},"resize")),(0,p.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Simple2DScene/index.ts#L202"},"src/core/Simple2DScene/index.ts:202")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"update"},"update"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"update"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"Updateable.update")),(0,p.kt)("h4",{id:"returns-10"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"implementation-of-8"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"update")),(0,p.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Simple2DScene/index.ts#L183"},"src/core/Simple2DScene/index.ts:183")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/55483fbd.eb34175f.js b/build/assets/js/55483fbd.eb34175f.js deleted file mode 100644 index 57385040..00000000 --- a/build/assets/js/55483fbd.eb34175f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5241],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>f});var i=t(7294);function p(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function o(e){for(var n=1;n=0||(p[t]=e[t]);return p}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(p[t]=e[t])}return p}var r=i.createContext({}),s=function(e){var n=i.useContext(r),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},m=function(e){var n=s(e.components);return i.createElement(r.Provider,{value:n},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},u=i.forwardRef((function(e,n){var t=e.components,p=e.mdxType,a=e.originalType,r=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),d=s(t),u=p,f=d["".concat(r,".").concat(u)]||d[u]||c[u]||a;return t?i.createElement(f,o(o({ref:n},m),{},{components:t})):i.createElement(f,o({ref:n},m))}));function f(e,n){var t=arguments,p=n&&n.mdxType;if("string"==typeof e||p){var a=t.length,o=new Array(a);o[0]=u;var l={};for(var r in n)hasOwnProperty.call(n,r)&&(l[r]=n[r]);l.originalType=e,l[d]="string"==typeof e?e:p,o[1]=l;for(var s=2;s{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>r,default:()=>f,frontMatter:()=>l,metadata:()=>s,toc:()=>d});var i=t(7462),p=t(3366),a=(t(7294),t(3905)),o=["components"],l={id:"openbim_components.Simple2DScene",title:"Class: Simple2DScene",sidebar_label:"Simple2DScene",custom_edit_url:null},r=void 0,s={unversionedId:"api/classes/openbim_components.Simple2DScene",id:"api/classes/openbim_components.Simple2DScene",title:"Class: Simple2DScene",description:"openbim-components.Simple2DScene",source:"@site/docs/api/classes/openbim_components.Simple2DScene.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.Simple2DScene",permalink:"/api/classes/openbim_components.Simple2DScene",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Simple2DScene",title:"Class: Simple2DScene",sidebar_label:"Simple2DScene",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ScreenCuller",permalink:"/api/classes/openbim_components.ScreenCuller"},next:{title:"SimpleCamera",permalink:"/api/classes/openbim_components.SimpleCamera"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"camera",id:"camera",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"controls",id:"controls",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onAfterUpdate",id:"onafterupdate",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"onBeforeUpdate",id:"onbeforeupdate",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"onResize",id:"onresize",level:3},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"uiElement",id:"uielement",level:3},{value:"Implementation of",id:"implementation-of-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Implementation of",id:"implementation-of-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getSize",id:"getsize",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Implementation of",id:"implementation-of-6",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"resize",id:"resize",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Implementation of",id:"implementation-of-7",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"update",id:"update",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Implementation of",id:"implementation-of-8",level:4},{value:"Defined in",id:"defined-in-18",level:4}],c={toc:d},u="wrapper";function f(e){var n=e.components,t=(0,p.Z)(e,o);return(0,a.kt)(u,(0,i.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Simple2DScene"),(0,a.kt)("p",null,"A simple floating 2D scene that you can use to easily draw 2D graphics\nwith all the power of Three.js."),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,a.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"THREE.Group"),">"),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Simple2DScene"))))),(0,a.kt)("h2",{id:"implements"},"Implements"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},(0,a.kt)("inlineCode",{parentName:"a"},"UI"))),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Updateable"},(0,a.kt)("inlineCode",{parentName:"a"},"Updateable"))),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,a.kt)("inlineCode",{parentName:"a"},"Disposable"))),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Resizeable"},(0,a.kt)("inlineCode",{parentName:"a"},"Resizeable")))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"camera"},"camera"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"camera"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,a.kt)("p",null,"The camera that renders the scene."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Simple2DScene/index.ts#L55"},"temp/engine_components/src/core/Simple2DScene/index.ts:55")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"controls"},"controls"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"controls"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"OrbitControls")),(0,a.kt)("p",null,"The camera controls that move around in the scene."),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Simple2DScene/index.ts#L52"},"temp/engine_components/src/core/Simple2DScene/index.ts:52")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"enabled"},"enabled"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"enabled"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"true")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Simple2DScene/index.ts#L41"},"temp/engine_components/src/core/Simple2DScene/index.ts:41")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,a.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"Updateable.onAfterUpdate")),(0,a.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"onAfterUpdate")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Simple2DScene/index.ts#L32"},"temp/engine_components/src/core/Simple2DScene/index.ts:32")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,a.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"Updateable.onBeforeUpdate")),(0,a.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"onBeforeUpdate")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Simple2DScene/index.ts#L35"},"temp/engine_components/src/core/Simple2DScene/index.ts:35")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,a.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,a.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Simple2DScene/index.ts#L44"},"temp/engine_components/src/core/Simple2DScene/index.ts:44")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"onresize"},"onResize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"onResize"),": ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,a.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Vector2"),">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#onresize"},"Resizeable.onResize")),(0,a.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#onresize"},"onResize")),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Simple2DScene/index.ts#L38"},"temp/engine_components/src/core/Simple2DScene/index.ts:38")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"uielement"},"uiElement"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"uiElement"),": ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.UIElement"},(0,a.kt)("inlineCode",{parentName:"a"},"UIElement")),"<{ ",(0,a.kt)("inlineCode",{parentName:"p"},"container"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"SimpleUIComponent"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"HTMLElement"),">"," }",">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI#uielement"},"UI.uiElement")),(0,a.kt)("h4",{id:"implementation-of-4"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),".",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI#uielement"},"uiElement")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Simple2DScene/index.ts#L47"},"temp/engine_components/src/core/Simple2DScene/index.ts:47")),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"dispose"},"dispose"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("h4",{id:"implementation-of-5"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Simple2DScene/index.ts#L150"},"temp/engine_components/src/core/Simple2DScene/index.ts:150")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"get"},"get"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"get"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Group"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Group"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">"),(0,a.kt)("p",null,"the 2D scene."),(0,a.kt)("h4",{id:"overrides-1"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Simple2DScene/index.ts#L145"},"temp/engine_components/src/core/Simple2DScene/index.ts:145")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"getsize"},"getSize"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"getSize"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#getsize"},"Resizeable.getSize")),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,a.kt)("h4",{id:"implementation-of-6"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#getsize"},"getSize")),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Simple2DScene/index.ts#L173"},"temp/engine_components/src/core/Simple2DScene/index.ts:173")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"hasui"},"hasUI"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,a.kt)("p",null,"Whether is component implements any kind of ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,"this is UI"),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,"this is Configurable"),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,"this is Disposable"),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ishideable"},"isHideable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,"this is Hideable"),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,a.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,a.kt)("h4",{id:"returns-7"},"Returns"),(0,a.kt)("p",null,"this is Resizeable"),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,a.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,a.kt)("h4",{id:"returns-8"},"Returns"),(0,a.kt)("p",null,"this is Updateable"),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,a.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"resize"},"resize"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"resize"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#resize"},"Resizeable.resize")),(0,a.kt)("h4",{id:"returns-9"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"implementation-of-7"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#resize"},"resize")),(0,a.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Simple2DScene/index.ts#L184"},"temp/engine_components/src/core/Simple2DScene/index.ts:184")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"update"},"update"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"update"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"Updateable.update")),(0,a.kt)("h4",{id:"returns-10"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("h4",{id:"implementation-of-8"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"update")),(0,a.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Simple2DScene/index.ts#L165"},"temp/engine_components/src/core/Simple2DScene/index.ts:165")))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/59791038.4484d79c.js b/build/assets/js/59791038.4484d79c.js deleted file mode 100644 index 3bc85437..00000000 --- a/build/assets/js/59791038.4484d79c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2218],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>h});var i=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function o(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function r(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=i.createContext({}),l=function(e){var n=i.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):r(r({},n),e)),t},d=function(e){var n=l(e.components);return i.createElement(s.Provider,{value:n},e.children)},m="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},c=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,o=e.originalType,s=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),m=l(t),c=a,h=m["".concat(s,".").concat(c)]||m[c]||u[c]||o;return t?i.createElement(h,r(r({ref:n},d),{},{components:t})):i.createElement(h,r({ref:n},d))}));function h(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var o=t.length,r=new Array(o);r[0]=c;var p={};for(var s in n)hasOwnProperty.call(n,s)&&(p[s]=n[s]);p.originalType=e,p[m]="string"==typeof e?e:a,r[1]=p;for(var l=2;l{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>h,frontMatter:()=>p,metadata:()=>l,toc:()=>m});var i=t(7462),a=t(3366),o=(t(7294),t(3905)),r=["components"],p={id:"openbim_components.CloudStorage",title:"Class: CloudStorage",sidebar_label:"CloudStorage",custom_edit_url:null},s=void 0,l={unversionedId:"api/classes/openbim_components.CloudStorage",id:"api/classes/openbim_components.CloudStorage",title:"Class: CloudStorage",description:"openbim-components.CloudStorage",source:"@site/docs/api/classes/openbim_components.CloudStorage.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.CloudStorage",permalink:"/api/classes/openbim_components.CloudStorage",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.CloudStorage",title:"Class: CloudStorage",sidebar_label:"CloudStorage",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"BaseRenderer",permalink:"/api/classes/openbim_components.BaseRenderer"},next:{title:"Component",permalink:"/api/classes/openbim_components.Component"}},d={},m=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Accessors",id:"accessors",level:2},{value:"token",id:"token",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Methods",id:"methods",level:2},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-10",level:4}],u={toc:m},c="wrapper";function h(e){var n=e.components,t=(0,a.Z)(e,r);return(0,o.kt)(c,(0,i.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".CloudStorage"),(0,o.kt)("p",null,"An object to easily use the services of That Open Platform."),(0,o.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("p",{parentName:"li"},(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,o.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,o.kt)("inlineCode",{parentName:"p"},"any"),"[]",">"),(0,o.kt)("p",{parentName:"li"},"\u21b3 ",(0,o.kt)("strong",{parentName:"p"},(0,o.kt)("inlineCode",{parentName:"strong"},"CloudStorage"))))),(0,o.kt)("h2",{id:"properties"},"Properties"),(0,o.kt)("h3",{id:"enabled"},"enabled"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"enabled"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,o.kt)("inlineCode",{parentName:"p"},"true")),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,o.kt)("h4",{id:"overrides"},"Overrides"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/services/CloudStorage/index.ts#L18"},"temp/engine_components/src/services/CloudStorage/index.ts:18")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"name"},"name"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"name"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,o.kt)("inlineCode",{parentName:"p"},'"CloudProcessor"')),(0,o.kt)("p",null,"Component.name"),(0,o.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/services/CloudStorage/index.ts#L15"},"temp/engine_components/src/services/CloudStorage/index.ts:15")),(0,o.kt)("h2",{id:"accessors"},"Accessors"),(0,o.kt)("h3",{id:"token"},"token"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"get")," ",(0,o.kt)("strong",{parentName:"p"},"token"),"(): ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,"The authentication token generated in\n",(0,o.kt)("a",{parentName:"p",href:"https://platform.thatopen.com/app"},"That Open Platform")),(0,o.kt)("h4",{id:"returns"},"Returns"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/services/CloudStorage/index.ts#L50"},"temp/engine_components/src/services/CloudStorage/index.ts:50")),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"set")," ",(0,o.kt)("strong",{parentName:"p"},"token"),"(",(0,o.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,o.kt)("inlineCode",{parentName:"p"},"void")),(0,o.kt)("p",null,"The authentication token generated in\n",(0,o.kt)("a",{parentName:"p",href:"https://platform.thatopen.com/app"},"That Open Platform")),(0,o.kt)("h4",{id:"parameters"},"Parameters"),(0,o.kt)("table",null,(0,o.kt)("thead",{parentName:"table"},(0,o.kt)("tr",{parentName:"thead"},(0,o.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,o.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,o.kt)("tbody",{parentName:"table"},(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"value")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"string"))))),(0,o.kt)("h4",{id:"returns-1"},"Returns"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"void")),(0,o.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/services/CloudStorage/index.ts#L61"},"temp/engine_components/src/services/CloudStorage/index.ts:61")),(0,o.kt)("h2",{id:"methods"},"Methods"),(0,o.kt)("h3",{id:"get"},"get"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"get"),"(): ",(0,o.kt)("inlineCode",{parentName:"p"},"any"),"[]"),(0,o.kt)("p",null,"Retrieves a tool component by its name."),(0,o.kt)("h4",{id:"returns-2"},"Returns"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"any"),"[]"),(0,o.kt)("h4",{id:"overrides-1"},"Overrides"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,o.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/services/CloudStorage/index.ts#L42"},"temp/engine_components/src/services/CloudStorage/index.ts:42")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"hasui"},"hasUI"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,o.kt)("p",null,"Whether is component implements any kind of ",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,o.kt)("h4",{id:"returns-3"},"Returns"),(0,o.kt)("p",null,"this is UI"),(0,o.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,o.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,o.kt)("p",null,"Whether is component is ",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,o.kt)("h4",{id:"returns-4"},"Returns"),(0,o.kt)("p",null,"this is Configurable"),(0,o.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,o.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,o.kt)("p",null,"Whether is component is ",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,o.kt)("h4",{id:"returns-5"},"Returns"),(0,o.kt)("p",null,"this is Disposable"),(0,o.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,o.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"ishideable"},"isHideable"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,o.kt)("p",null,"Whether is component is ",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,o.kt)("h4",{id:"returns-6"},"Returns"),(0,o.kt)("p",null,"this is Hideable"),(0,o.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,o.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,o.kt)("p",null,"Whether is component is ",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,o.kt)("h4",{id:"returns-7"},"Returns"),(0,o.kt)("p",null,"this is Resizeable"),(0,o.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,o.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,o.kt)("p",null,"Whether is component is ",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,o.kt)("h4",{id:"returns-8"},"Returns"),(0,o.kt)("p",null,"this is Updateable"),(0,o.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,o.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/59791038.862a348d.js b/build/assets/js/59791038.862a348d.js new file mode 100644 index 00000000..d2034a1e --- /dev/null +++ b/build/assets/js/59791038.862a348d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2218],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>h});var i=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function o(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var l=i.createContext({}),s=function(e){var n=i.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},d=function(e){var n=s(e.components);return i.createElement(l.Provider,{value:n},e.children)},m="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},c=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,r=e.originalType,l=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),m=s(t),c=a,h=m["".concat(l,".").concat(c)]||m[c]||u[c]||r;return t?i.createElement(h,o(o({ref:n},d),{},{components:t})):i.createElement(h,o({ref:n},d))}));function h(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var r=t.length,o=new Array(r);o[0]=c;var p={};for(var l in n)hasOwnProperty.call(n,l)&&(p[l]=n[l]);p.originalType=e,p[m]="string"==typeof e?e:a,o[1]=p;for(var s=2;s{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>l,default:()=>h,frontMatter:()=>p,metadata:()=>s,toc:()=>m});var i=t(7462),a=t(3366),r=(t(7294),t(3905)),o=["components"],p={id:"openbim_components.CloudStorage",title:"Class: CloudStorage",sidebar_label:"CloudStorage",custom_edit_url:null},l=void 0,s={unversionedId:"api/classes/openbim_components.CloudStorage",id:"api/classes/openbim_components.CloudStorage",title:"Class: CloudStorage",description:"openbim-components.CloudStorage",source:"@site/docs/api/classes/openbim_components.CloudStorage.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.CloudStorage",permalink:"/api/classes/openbim_components.CloudStorage",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.CloudStorage",title:"Class: CloudStorage",sidebar_label:"CloudStorage",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"BaseRenderer",permalink:"/api/classes/openbim_components.BaseRenderer"},next:{title:"Component",permalink:"/api/classes/openbim_components.Component"}},d={},m=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Accessors",id:"accessors",level:2},{value:"token",id:"token",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Methods",id:"methods",level:2},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-10",level:4}],u={toc:m},c="wrapper";function h(e){var n=e.components,t=(0,a.Z)(e,o);return(0,r.kt)(c,(0,i.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".CloudStorage"),(0,r.kt)("p",null,"An object to easily use the services of That Open Platform."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,r.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"[]",">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"CloudStorage"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"enabled"},"enabled"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"enabled"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"true")),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/services/CloudStorage/index.ts#L18"},"src/services/CloudStorage/index.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,r.kt)("inlineCode",{parentName:"p"},'"CloudProcessor"')),(0,r.kt)("p",null,"Component.name"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/services/CloudStorage/index.ts#L15"},"src/services/CloudStorage/index.ts:15")),(0,r.kt)("h2",{id:"accessors"},"Accessors"),(0,r.kt)("h3",{id:"token"},"token"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"token"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The authentication token generated in\n",(0,r.kt)("a",{parentName:"p",href:"https://platform.thatopen.com/app"},"That Open Platform")),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/services/CloudStorage/index.ts#L50"},"src/services/CloudStorage/index.ts:50")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"token"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"The authentication token generated in\n",(0,r.kt)("a",{parentName:"p",href:"https://platform.thatopen.com/app"},"That Open Platform")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/services/CloudStorage/index.ts#L61"},"src/services/CloudStorage/index.ts:61")),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"get"},"get"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"get"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"[]"),(0,r.kt)("p",null,"Retrieves a tool component by its name."),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"any"),"[]"),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/services/CloudStorage/index.ts#L42"},"src/services/CloudStorage/index.ts:42")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hasui"},"hasUI"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,r.kt)("p",null,"Whether is component implements any kind of ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,"this is UI"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,"this is Configurable"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,"this is Disposable"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ishideable"},"isHideable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,"this is Hideable"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,"this is Resizeable"),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,"this is Updateable"),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/5c34dd2a.b112251e.js b/build/assets/js/5c34dd2a.b112251e.js deleted file mode 100644 index de357c2b..00000000 --- a/build/assets/js/5c34dd2a.b112251e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5531],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>h});var i=t(7294);function r(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function p(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function a(e){for(var n=1;n=0||(r[t]=e[t]);return r}(e,n);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var o=i.createContext({}),s=function(e){var n=i.useContext(o),t=n;return e&&(t="function"==typeof e?e(n):a(a({},n),e)),t},d=function(e){var n=s(e.components);return i.createElement(o.Provider,{value:n},e.children)},m="mdxType",c={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},u=i.forwardRef((function(e,n){var t=e.components,r=e.mdxType,p=e.originalType,o=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),m=s(t),u=r,h=m["".concat(o,".").concat(u)]||m[u]||c[u]||p;return t?i.createElement(h,a(a({ref:n},d),{},{components:t})):i.createElement(h,a({ref:n},d))}));function h(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var p=t.length,a=new Array(p);a[0]=u;var l={};for(var o in n)hasOwnProperty.call(n,o)&&(l[o]=n[o]);l.originalType=e,l[m]="string"==typeof e?e:r,a[1]=l;for(var s=2;s{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>l,metadata:()=>s,toc:()=>m});var i=t(7462),r=t(3366),p=(t(7294),t(3905)),a=["components"],l={id:"openbim_components.PostproductionRenderer",title:"Class: PostproductionRenderer",sidebar_label:"PostproductionRenderer",custom_edit_url:null},o=void 0,s={unversionedId:"api/classes/openbim_components.PostproductionRenderer",id:"api/classes/openbim_components.PostproductionRenderer",title:"Class: PostproductionRenderer",description:"openbim-components.PostproductionRenderer",source:"@site/docs/api/classes/openbim_components.PostproductionRenderer.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.PostproductionRenderer",permalink:"/api/classes/openbim_components.PostproductionRenderer",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.PostproductionRenderer",title:"Class: PostproductionRenderer",sidebar_label:"PostproductionRenderer",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"OrthoPerspectiveCamera",permalink:"/api/classes/openbim_components.OrthoPerspectiveCamera"},next:{title:"PropertiesStreamingSettings",permalink:"/api/classes/openbim_components.PropertiesStreamingSettings"}},d={},m=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"clippingPlanes",id:"clippingplanes",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"container",id:"container",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"enabled",id:"enabled",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onAfterUpdate",id:"onafterupdate",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"onBeforeUpdate",id:"onbeforeupdate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"onClippingPlanesUpdated",id:"onclippingplanesupdated",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"onResize",id:"onresize",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"postproduction",id:"postproduction",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getSize",id:"getsize",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"resize",id:"resize",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"togglePlane",id:"toggleplane",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"update",id:"update",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"updateClippingPlanes",id:"updateclippingplanes",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-21",level:4}],c={toc:m},u="wrapper";function h(e){var n=e.components,t=(0,r.Z)(e,a);return(0,p.kt)(u,(0,i.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".PostproductionRenderer"),(0,p.kt)("p",null,"Renderer that uses efficient postproduction effects (e.g. Ambient Occlusion)."),(0,p.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("p",{parentName:"li"},(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleRenderer"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"PostproductionRenderer"))))),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"clippingplanes"},"clippingPlanes"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"clippingPlanes"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"Plane"),"[] = ",(0,p.kt)("inlineCode",{parentName:"p"},"[]")),(0,p.kt)("p",null,"The list of ",(0,p.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer.clippingPlanes"},"clipping planes")," used by this\ninstance of the renderer."),(0,p.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#clippingplanes"},"clippingPlanes")),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-renderer.ts#L33"},"temp/engine_components/src/base-types/base-renderer.ts:33")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"container"},"container"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"container"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"HTMLElement")),(0,p.kt)("p",null,"The HTML container of the THREE.js canvas where the scene is rendered."),(0,p.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#container"},"container")),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleRenderer/index.ts#L26"},"temp/engine_components/src/core/SimpleRenderer/index.ts:26")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"enabled"},"enabled"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"enabled"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,p.kt)("inlineCode",{parentName:"p"},"true")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,p.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#enabled"},"enabled")),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleRenderer/index.ts#L23"},"temp/engine_components/src/core/SimpleRenderer/index.ts:23")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleRenderer")),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"Updateable.onAfterUpdate")),(0,p.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#onafterupdate"},"onAfterUpdate")),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleRenderer/index.ts#L35"},"temp/engine_components/src/core/SimpleRenderer/index.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleRenderer")),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"Updateable.onBeforeUpdate")),(0,p.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#onbeforeupdate"},"onBeforeUpdate")),(0,p.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleRenderer/index.ts#L32"},"temp/engine_components/src/core/SimpleRenderer/index.ts:32")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onclippingplanesupdated"},"onClippingPlanesUpdated"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onClippingPlanesUpdated"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,p.kt)("p",null,"Event that fires when there has been a change to the list of clipping\nplanes used by the active renderer."),(0,p.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#onclippingplanesupdated"},"onClippingPlanesUpdated")),(0,p.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-renderer.ts#L27"},"temp/engine_components/src/base-types/base-renderer.ts:27")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"undefined"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,p.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#ondisposed"},"onDisposed")),(0,p.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleRenderer/index.ts#L29"},"temp/engine_components/src/core/SimpleRenderer/index.ts:29")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onresize"},"onResize"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onResize"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#onresize"},"Resizeable.onResize")),(0,p.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#onresize"},"onResize")),(0,p.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-renderer.ts#L21"},"temp/engine_components/src/base-types/base-renderer.ts:21")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"postproduction"},"postproduction"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"postproduction"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"Postproduction")),(0,p.kt)("p",null,"Helper object to handle the postproduction effects applied."),(0,p.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/PostproductionRenderer/index.ts#L11"},"temp/engine_components/src/navigation/PostproductionRenderer/index.ts:11")),(0,p.kt)("h2",{id:"methods"},"Methods"),(0,p.kt)("h3",{id:"dispose"},"dispose"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose"),"."),(0,p.kt)("h4",{id:"returns"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"overrides"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#dispose"},"dispose")),(0,p.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/PostproductionRenderer/index.ts#L41"},"temp/engine_components/src/navigation/PostproductionRenderer/index.ts:41")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"get"},"get"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"get"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"WebGLRenderer")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,p.kt)("h4",{id:"returns-1"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"WebGLRenderer")),(0,p.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#get"},"get")),(0,p.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleRenderer/index.ts#L75"},"temp/engine_components/src/core/SimpleRenderer/index.ts:75")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"getsize"},"getSize"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"getSize"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#getsize"},"Resizeable.getSize"),"."),(0,p.kt)("h4",{id:"returns-2"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,p.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#getsize"},"getSize")),(0,p.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleRenderer/index.ts#L106"},"temp/engine_components/src/core/SimpleRenderer/index.ts:106")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"hasui"},"hasUI"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,p.kt)("p",null,"Whether is component implements any kind of ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,p.kt)("h4",{id:"returns-3"},"Returns"),(0,p.kt)("p",null,"this is UI"),(0,p.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#hasui"},"hasUI")),(0,p.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,p.kt)("h4",{id:"returns-4"},"Returns"),(0,p.kt)("p",null,"this is Configurable"),(0,p.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#isconfigurable"},"isConfigurable")),(0,p.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,p.kt)("h4",{id:"returns-5"},"Returns"),(0,p.kt)("p",null,"this is Disposable"),(0,p.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#isdisposeable"},"isDisposeable")),(0,p.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ishideable"},"isHideable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,p.kt)("h4",{id:"returns-6"},"Returns"),(0,p.kt)("p",null,"this is Hideable"),(0,p.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#ishideable"},"isHideable")),(0,p.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,p.kt)("h4",{id:"returns-7"},"Returns"),(0,p.kt)("p",null,"this is Resizeable"),(0,p.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#isresizeable"},"isResizeable")),(0,p.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,p.kt)("h4",{id:"returns-8"},"Returns"),(0,p.kt)("p",null,"this is Updateable"),(0,p.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#isupdateable"},"isUpdateable")),(0,p.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"resize"},"resize"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"resize"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"size?"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#resize"},"Resizeable.resize"),"."),(0,p.kt)("h4",{id:"parameters"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"size?")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"Vector2"))))),(0,p.kt)("h4",{id:"returns-9"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#resize"},"resize")),(0,p.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleRenderer/index.ts#L114"},"temp/engine_components/src/core/SimpleRenderer/index.ts:114")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"toggleplane"},"togglePlane"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"togglePlane"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"active"),", ",(0,p.kt)("inlineCode",{parentName:"p"},"plane"),", ",(0,p.kt)("inlineCode",{parentName:"p"},"isLocal?"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,"Adds or removes a\n",(0,p.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer.clippingPlanes"},"clipping plane"),"\nto the renderer."),(0,p.kt)("h4",{id:"parameters-1"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"active")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"plane")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"Plane"))),(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"isLocal?")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,p.kt)("h4",{id:"returns-10"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#toggleplane"},"togglePlane")),(0,p.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-renderer.ts#L48"},"temp/engine_components/src/base-types/base-renderer.ts:48")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"update"},"update"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"update"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"Updateable.update")),(0,p.kt)("h4",{id:"returns-11"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"overrides-1"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#update"},"update")),(0,p.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/PostproductionRenderer/index.ts#L25"},"temp/engine_components/src/navigation/PostproductionRenderer/index.ts:25")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"updateclippingplanes"},"updateClippingPlanes"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"updateClippingPlanes"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,"Forces the update of the clipping planes and all components that depend\non them that are subscribed to ",(0,p.kt)("inlineCode",{parentName:"p"},"onClippingPlanesUpdated"),"."),(0,p.kt)("h4",{id:"returns-12"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#updateclippingplanes"},"updateClippingPlanes")),(0,p.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-renderer.ts#L39"},"temp/engine_components/src/base-types/base-renderer.ts:39")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/5c34dd2a.dc3e1e4e.js b/build/assets/js/5c34dd2a.dc3e1e4e.js new file mode 100644 index 00000000..0ad4249f --- /dev/null +++ b/build/assets/js/5c34dd2a.dc3e1e4e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5531],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>h});var i=t(7294);function r(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function p(e){for(var n=1;n=0||(r[t]=e[t]);return r}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var o=i.createContext({}),s=function(e){var n=i.useContext(o),t=n;return e&&(t="function"==typeof e?e(n):p(p({},n),e)),t},d=function(e){var n=s(e.components);return i.createElement(o.Provider,{value:n},e.children)},m="mdxType",c={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},u=i.forwardRef((function(e,n){var t=e.components,r=e.mdxType,a=e.originalType,o=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),m=s(t),u=r,h=m["".concat(o,".").concat(u)]||m[u]||c[u]||a;return t?i.createElement(h,p(p({ref:n},d),{},{components:t})):i.createElement(h,p({ref:n},d))}));function h(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var a=t.length,p=new Array(a);p[0]=u;var l={};for(var o in n)hasOwnProperty.call(n,o)&&(l[o]=n[o]);l.originalType=e,l[m]="string"==typeof e?e:r,p[1]=l;for(var s=2;s{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>l,metadata:()=>s,toc:()=>m});var i=t(7462),r=t(3366),a=(t(7294),t(3905)),p=["components"],l={id:"openbim_components.PostproductionRenderer",title:"Class: PostproductionRenderer",sidebar_label:"PostproductionRenderer",custom_edit_url:null},o=void 0,s={unversionedId:"api/classes/openbim_components.PostproductionRenderer",id:"api/classes/openbim_components.PostproductionRenderer",title:"Class: PostproductionRenderer",description:"openbim-components.PostproductionRenderer",source:"@site/docs/api/classes/openbim_components.PostproductionRenderer.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.PostproductionRenderer",permalink:"/api/classes/openbim_components.PostproductionRenderer",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.PostproductionRenderer",title:"Class: PostproductionRenderer",sidebar_label:"PostproductionRenderer",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"OrthoPerspectiveCamera",permalink:"/api/classes/openbim_components.OrthoPerspectiveCamera"},next:{title:"PropertiesStreamingSettings",permalink:"/api/classes/openbim_components.PropertiesStreamingSettings"}},d={},m=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"clippingPlanes",id:"clippingplanes",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"container",id:"container",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"enabled",id:"enabled",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onAfterUpdate",id:"onafterupdate",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"onBeforeUpdate",id:"onbeforeupdate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"onClippingPlanesUpdated",id:"onclippingplanesupdated",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"onResize",id:"onresize",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"postproduction",id:"postproduction",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getSize",id:"getsize",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"resize",id:"resize",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"togglePlane",id:"toggleplane",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"update",id:"update",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"updateClippingPlanes",id:"updateclippingplanes",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-21",level:4}],c={toc:m},u="wrapper";function h(e){var n=e.components,t=(0,r.Z)(e,p);return(0,a.kt)(u,(0,i.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".PostproductionRenderer"),(0,a.kt)("p",null,"Renderer that uses efficient postproduction effects (e.g. Ambient Occlusion)."),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},(0,a.kt)("inlineCode",{parentName:"a"},"SimpleRenderer"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"PostproductionRenderer"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"clippingplanes"},"clippingPlanes"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"clippingPlanes"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Plane"),"[] = ",(0,a.kt)("inlineCode",{parentName:"p"},"[]")),(0,a.kt)("p",null,"The list of ",(0,a.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer.clippingPlanes"},"clipping planes")," used by this\ninstance of the renderer."),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#clippingplanes"},"clippingPlanes")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-renderer.ts#L33"},"src/base-types/base-renderer.ts:33")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"container"},"container"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"container"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"HTMLElement")),(0,a.kt)("p",null,"The HTML container of the THREE.js canvas where the scene is rendered."),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#container"},"container")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleRenderer/index.ts#L26"},"src/core/SimpleRenderer/index.ts:26")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"enabled"},"enabled"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"enabled"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"true")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#enabled"},"enabled")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleRenderer/index.ts#L23"},"src/core/SimpleRenderer/index.ts:23")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,a.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},(0,a.kt)("inlineCode",{parentName:"a"},"SimpleRenderer")),">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"Updateable.onAfterUpdate")),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#onafterupdate"},"onAfterUpdate")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleRenderer/index.ts#L35"},"src/core/SimpleRenderer/index.ts:35")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,a.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},(0,a.kt)("inlineCode",{parentName:"a"},"SimpleRenderer")),">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"Updateable.onBeforeUpdate")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#onbeforeupdate"},"onBeforeUpdate")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleRenderer/index.ts#L32"},"src/core/SimpleRenderer/index.ts:32")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"onclippingplanesupdated"},"onClippingPlanesUpdated"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"onClippingPlanesUpdated"),": ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,a.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,a.kt)("p",null,"Event that fires when there has been a change to the list of clipping\nplanes used by the active renderer."),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#onclippingplanesupdated"},"onClippingPlanesUpdated")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-renderer.ts#L27"},"src/base-types/base-renderer.ts:27")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,a.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"undefined"),">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#ondisposed"},"onDisposed")),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleRenderer/index.ts#L29"},"src/core/SimpleRenderer/index.ts:29")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"onresize"},"onResize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"onResize"),": ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,a.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#onresize"},"Resizeable.onResize")),(0,a.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#onresize"},"onResize")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-renderer.ts#L21"},"src/base-types/base-renderer.ts:21")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"postproduction"},"postproduction"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"postproduction"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Postproduction")),(0,a.kt)("p",null,"Helper object to handle the postproduction effects applied."),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/PostproductionRenderer/index.ts#L11"},"src/navigation/PostproductionRenderer/index.ts:11")),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"dispose"},"dispose"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose"),"."),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#dispose"},"dispose")),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/PostproductionRenderer/index.ts#L41"},"src/navigation/PostproductionRenderer/index.ts:41")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"get"},"get"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"get"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"WebGLRenderer")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"WebGLRenderer")),(0,a.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#get"},"get")),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleRenderer/index.ts#L75"},"src/core/SimpleRenderer/index.ts:75")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"getsize"},"getSize"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"getSize"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#getsize"},"Resizeable.getSize"),"."),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,a.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#getsize"},"getSize")),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleRenderer/index.ts#L106"},"src/core/SimpleRenderer/index.ts:106")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"hasui"},"hasUI"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,a.kt)("p",null,"Whether is component implements any kind of ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,"this is UI"),(0,a.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#hasui"},"hasUI")),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,"this is Configurable"),(0,a.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#isconfigurable"},"isConfigurable")),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,"this is Disposable"),(0,a.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#isdisposeable"},"isDisposeable")),(0,a.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ishideable"},"isHideable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,"this is Hideable"),(0,a.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#ishideable"},"isHideable")),(0,a.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,a.kt)("h4",{id:"returns-7"},"Returns"),(0,a.kt)("p",null,"this is Resizeable"),(0,a.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#isresizeable"},"isResizeable")),(0,a.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,a.kt)("h4",{id:"returns-8"},"Returns"),(0,a.kt)("p",null,"this is Updateable"),(0,a.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#isupdateable"},"isUpdateable")),(0,a.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"resize"},"resize"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"resize"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"size?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#resize"},"Resizeable.resize"),"."),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"size?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Vector2"))))),(0,a.kt)("h4",{id:"returns-9"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#resize"},"resize")),(0,a.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleRenderer/index.ts#L114"},"src/core/SimpleRenderer/index.ts:114")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"toggleplane"},"togglePlane"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"togglePlane"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"active"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"plane"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"isLocal?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"Adds or removes a\n",(0,a.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer.clippingPlanes"},"clipping plane"),"\nto the renderer."),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"active")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"plane")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Plane"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"isLocal?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,a.kt)("h4",{id:"returns-10"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#toggleplane"},"togglePlane")),(0,a.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-renderer.ts#L48"},"src/base-types/base-renderer.ts:48")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"update"},"update"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"update"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"Updateable.update")),(0,a.kt)("h4",{id:"returns-11"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("h4",{id:"overrides-1"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#update"},"update")),(0,a.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/PostproductionRenderer/index.ts#L25"},"src/navigation/PostproductionRenderer/index.ts:25")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"updateclippingplanes"},"updateClippingPlanes"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"updateClippingPlanes"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("p",null,"Forces the update of the clipping planes and all components that depend\non them that are subscribed to ",(0,a.kt)("inlineCode",{parentName:"p"},"onClippingPlanesUpdated"),"."),(0,a.kt)("h4",{id:"returns-12"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#updateclippingplanes"},"updateClippingPlanes")),(0,a.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-renderer.ts#L39"},"src/base-types/base-renderer.ts:39")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/5e8c322a.1ab4294c.js b/build/assets/js/5e8c322a.1ab4294c.js new file mode 100644 index 00000000..e24c1040 --- /dev/null +++ b/build/assets/js/5e8c322a.1ab4294c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7597],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>h});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=r.createContext({}),s=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},c=function(e){var t=s(e.components);return r.createElement(p.Provider,{value:t},e.children)},u="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,p=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),u=s(n),d=a,h=u["".concat(p,".").concat(d)]||u[d]||m[d]||o;return n?r.createElement(h,i(i({ref:t},c),{},{components:n})):r.createElement(h,i({ref:t},c))}));function h(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,i=new Array(o);i[0]=d;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[u]="string"==typeof e?e:a,i[1]=l;for(var s=2;s{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>p,default:()=>h,frontMatter:()=>l,metadata:()=>s,toc:()=>u});var r=n(7462),a=n(3366),o=(n(7294),n(3905)),i=["components"],l={id:"index",title:"Open BIM Docs",sidebar_label:"Readme",sidebar_position:0,custom_edit_url:null},p=void 0,s={unversionedId:"api/index",id:"api/index",title:"Open BIM Docs",description:"TOC",source:"@site/docs/api/index.md",sourceDirName:"api",slug:"/api/",permalink:"/api/",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"index",title:"Open BIM Docs",sidebar_label:"Readme",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Getting started",permalink:"/that-open-platform/getting-started"},next:{title:"Exports",permalink:"/api/modules"}},c={},u=[{value:"Local development",id:"local-development",level:2}],m={toc:u},d="wrapper";function h(e){var t=e.components,n=(0,a.Z)(e,i);return(0,o.kt)(d,(0,r.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",{align:"center"},(0,o.kt)("a",{href:"https://thatopen.com/"},"TOC"),"|",(0,o.kt)("a",{href:"https://docs.thatopen.com/intro"},"documentation"),"|",(0,o.kt)("a",{href:"https://platform.thatopen.com/app"},"demo"),"|",(0,o.kt)("a",{href:"https://people.thatopen.com/"},"community"),"|",(0,o.kt)("a",{href:"https://www.npmjs.com/package/bim-fragment"},"npm package")),(0,o.kt)("p",null,(0,o.kt)("img",{parentName:"p",src:"https://thatopen.github.io/engine_components/resources/cover.png",alt:"cover"})),(0,o.kt)("h1",{id:"that-open-docs-"},"That Open Docs ",(0,o.kt)("img",{src:"https://thatopen.github.io/engine_components/resources/favicon.ico",width:"32"})),(0,o.kt)("p",null,"This library contains the official docs for all the libraries of That Open Company."),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"It uses ",(0,o.kt)("a",{parentName:"li",href:"https://docusaurus.io/"},"docusaurus")," to build them."),(0,o.kt)("li",{parentName:"ul"},"It gathers code from our repos and build the API docs using ",(0,o.kt)("a",{parentName:"li",href:"https://typedoc.org/"},"TypeDoc"),"."),(0,o.kt)("li",{parentName:"ul"},"It gathers the HTML examples from our repos and build the tutorials.")),(0,o.kt)("p",null,"If you see anything outdated in the ",(0,o.kt)("a",{parentName:"p",href:"https://docs.thatopen.com/intro"},"docs page"),", feel free to open an issue. If the issue is specific to a specific repository, please open the issue in that repository!"),(0,o.kt)("p",null,"If you have any questions, you can also ask around in our ",(0,o.kt)("a",{parentName:"p",href:"https://people.thatopen.com/"},"community"),"."),(0,o.kt)("h2",{id:"local-development"},"Local development"),(0,o.kt)("p",null,"Requirements"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("inlineCode",{parentName:"li"},"yarn@4")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"https://github.com/cli/cli#installation"},(0,o.kt)("inlineCode",{parentName:"a"},"gh")," - github cli")," (make sure you've logged in with ",(0,o.kt)("inlineCode",{parentName:"li"},"gh auth login")," once)")),(0,o.kt)("p",null,"Install all dependencies"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-bash"},"yarn install\n")),(0,o.kt)("p",null,"Run docusaurus local devserver"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-bash"},"yarn start\n")),(0,o.kt)("p",null,(0,o.kt)("strong",{parentName:"p"},"Generating tutorials and api docs")),(0,o.kt)("p",null,"This script clonse both ",(0,o.kt)("inlineCode",{parentName:"p"},"openbim-components")," and ",(0,o.kt)("inlineCode",{parentName:"p"},"bim-fragments")," repos into a ",(0,o.kt)("inlineCode",{parentName:"p"},"temp/")," folder and generates the api docs."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-bash"},"yarn build:remote\n")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/5e8c322a.ff9d5be3.js b/build/assets/js/5e8c322a.ff9d5be3.js deleted file mode 100644 index f7000f48..00000000 --- a/build/assets/js/5e8c322a.ff9d5be3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7597],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var s=n.createContext({}),c=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},l=function(e){var t=c(e.components);return n.createElement(s.Provider,{value:t},e.children)},u="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,s=e.parentName,l=p(e,["components","mdxType","originalType","parentName"]),u=c(r),d=o,f=u["".concat(s,".").concat(d)]||u[d]||m[d]||a;return r?n.createElement(f,i(i({ref:t},l),{},{components:r})):n.createElement(f,i({ref:t},l))}));function f(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,i=new Array(a);i[0]=d;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[u]="string"==typeof e?e:o,i[1]=p;for(var c=2;c{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>f,frontMatter:()=>p,metadata:()=>c,toc:()=>u});var n=r(7462),o=r(3366),a=(r(7294),r(3905)),i=["components"],p={id:"index",title:"Open BIM Docs",sidebar_label:"Readme",sidebar_position:0,custom_edit_url:null},s=void 0,c={unversionedId:"api/index",id:"api/index",title:"Open BIM Docs",description:"TOC",source:"@site/docs/api/index.md",sourceDirName:"api",slug:"/api/",permalink:"/api/",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"index",title:"Open BIM Docs",sidebar_label:"Readme",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Getting started",permalink:"/that-open-platform/getting-started"},next:{title:"Exports",permalink:"/api/modules"}},l={},u=[],m={toc:u},d="wrapper";function f(e){var t=e.components,r=(0,o.Z)(e,i);return(0,a.kt)(d,(0,n.Z)({},m,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",{align:"center"},(0,a.kt)("a",{href:"https://thatopen.com/"},"TOC"),"|",(0,a.kt)("a",{href:"https://docs.thatopen.com/intro"},"documentation"),"|",(0,a.kt)("a",{href:"https://platform.thatopen.com/app"},"demo"),"|",(0,a.kt)("a",{href:"https://people.thatopen.com/"},"community"),"|",(0,a.kt)("a",{href:"https://www.npmjs.com/package/bim-fragment"},"npm package")),(0,a.kt)("p",null,(0,a.kt)("img",{parentName:"p",src:"https://thatopen.github.io/engine_components/resources/cover.png",alt:"cover"})),(0,a.kt)("h1",null,"That Open Docs ",(0,a.kt)("img",{src:"https://thatopen.github.io/engine_components/resources/favicon.ico",width:"32"})),(0,a.kt)("p",null,"This library contains the official docs for all the libraries of That Open Company."),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"It uses ",(0,a.kt)("a",{parentName:"li",href:"https://docusaurus.io/"},"docusaurus")," to build them."),(0,a.kt)("li",{parentName:"ul"},"It gathers code from our repos and build the API docs using ",(0,a.kt)("a",{parentName:"li",href:"https://typedoc.org/"},"TypeDoc"),"."),(0,a.kt)("li",{parentName:"ul"},"It gathers the HTML examples from our repos and build the tutorials.")),(0,a.kt)("p",null,"If you see anything outdated in the ",(0,a.kt)("a",{parentName:"p",href:"https://docs.thatopen.com/intro"},"docs page"),", feel free to open an issue. If the issue is specific to a specific repository, please open the issue in that repository!"),(0,a.kt)("p",null,"If you have any questions, you can also ask around in our ",(0,a.kt)("a",{parentName:"p",href:"https://people.thatopen.com/"},"community"),"."))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/5f173d68.872eb864.js b/build/assets/js/5f173d68.872eb864.js new file mode 100644 index 00000000..ede3f65c --- /dev/null +++ b/build/assets/js/5f173d68.872eb864.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8440],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>h});var i=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function p(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function o(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=i.createContext({}),r=function(e){var n=i.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},m=function(e){var n=r(e.components);return i.createElement(s.Provider,{value:n},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},u=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,p=e.originalType,s=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),d=r(t),u=a,h=d["".concat(s,".").concat(u)]||d[u]||c[u]||p;return t?i.createElement(h,o(o({ref:n},m),{},{components:t})):i.createElement(h,o({ref:n},m))}));function h(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var p=t.length,o=new Array(p);o[0]=u;var l={};for(var s in n)hasOwnProperty.call(n,s)&&(l[s]=n[s]);l.originalType=e,l[d]="string"==typeof e?e:a,o[1]=l;for(var r=2;r{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>s,default:()=>h,frontMatter:()=>l,metadata:()=>r,toc:()=>d});var i=t(7462),a=t(3366),p=(t(7294),t(3905)),o=["components"],l={id:"openbim_components.SimpleScene",title:"Class: SimpleScene",sidebar_label:"SimpleScene",custom_edit_url:null},s=void 0,r={unversionedId:"api/classes/openbim_components.SimpleScene",id:"api/classes/openbim_components.SimpleScene",title:"Class: SimpleScene",description:"openbim-components.SimpleScene",source:"@site/docs/api/classes/openbim_components.SimpleScene.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.SimpleScene",permalink:"/api/classes/openbim_components.SimpleScene",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.SimpleScene",title:"Class: SimpleScene",sidebar_label:"SimpleScene",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"SimpleRenderer",permalink:"/api/classes/openbim_components.SimpleRenderer"},next:{title:"ToolComponent",permalink:"/api/classes/openbim_components.ToolComponent"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"isSetup",id:"issetup",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"setup",id:"setup",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Defined in",id:"defined-in-11",level:4}],c={toc:d},u="wrapper";function h(e){var n=e.components,t=(0,a.Z)(e,o);return(0,p.kt)(u,(0,i.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".SimpleScene"),(0,p.kt)("p",null,"A basic 3D ",(0,p.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/scenes/Scene"},"scene")," to add\nobjects hierarchically, and easily dispose them when you are finished with it."),(0,p.kt)("p",null,(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"No Inherit Doc"))),(0,p.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("p",{parentName:"li"},(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,p.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"THREE.Scene"),">"),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"SimpleScene"))))),(0,p.kt)("h2",{id:"implements"},"Implements"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,p.kt)("inlineCode",{parentName:"a"},"Disposable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Configurable"},(0,p.kt)("inlineCode",{parentName:"a"},"Configurable")),"<{}",">")),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"enabled"},"enabled"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"enabled"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,p.kt)("inlineCode",{parentName:"p"},"true")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,p.kt)("h4",{id:"overrides"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleScene/index.ts#L28"},"src/core/SimpleScene/index.ts:28")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"issetup"},"isSetup"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"isSetup"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,p.kt)("inlineCode",{parentName:"p"},"false")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable#issetup"},"Configurable.isSetup")),(0,p.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable#issetup"},"isSetup")),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleScene/index.ts#L31"},"src/core/SimpleScene/index.ts:31")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"undefined"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,p.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleScene/index.ts#L34"},"src/core/SimpleScene/index.ts:34")),(0,p.kt)("h2",{id:"methods"},"Methods"),(0,p.kt)("h3",{id:"dispose"},"dispose"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,p.kt)("h4",{id:"returns"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleScene/index.ts#L50"},"src/core/SimpleScene/index.ts:50")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"get"},"get"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"get"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Scene")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,p.kt)("h4",{id:"returns-1"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Scene")),(0,p.kt)("h4",{id:"overrides-1"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,p.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleScene/index.ts#L45"},"src/core/SimpleScene/index.ts:45")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"hasui"},"hasUI"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,p.kt)("p",null,"Whether is component implements any kind of ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,p.kt)("h4",{id:"returns-2"},"Returns"),(0,p.kt)("p",null,"this is UI"),(0,p.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,p.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,p.kt)("h4",{id:"returns-3"},"Returns"),(0,p.kt)("p",null,"this is Configurable"),(0,p.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,p.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,p.kt)("h4",{id:"returns-4"},"Returns"),(0,p.kt)("p",null,"this is Disposable"),(0,p.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,p.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ishideable"},"isHideable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,p.kt)("h4",{id:"returns-5"},"Returns"),(0,p.kt)("p",null,"this is Hideable"),(0,p.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,p.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,p.kt)("h4",{id:"returns-6"},"Returns"),(0,p.kt)("p",null,"this is Resizeable"),(0,p.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,p.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,p.kt)("h4",{id:"returns-7"},"Returns"),(0,p.kt)("p",null,"this is Updateable"),(0,p.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,p.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"setup"},"setup"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"setup"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"config?"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,"Creates a simple and nice default set up for the scene (e.g. lighting)."),(0,p.kt)("h4",{id:"parameters"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"config?")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,p.kt)("inlineCode",{parentName:"td"},"SimpleSceneConfig"),">")))),(0,p.kt)("h4",{id:"returns-8"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable#setup"},"setup")),(0,p.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleScene/index.ts#L77"},"src/core/SimpleScene/index.ts:77")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/5f173d68.ed2385b4.js b/build/assets/js/5f173d68.ed2385b4.js deleted file mode 100644 index 2acb7161..00000000 --- a/build/assets/js/5f173d68.ed2385b4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8440],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>f});var i=t(7294);function p(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function o(e){for(var n=1;n=0||(p[t]=e[t]);return p}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(p[t]=e[t])}return p}var s=i.createContext({}),r=function(e){var n=i.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},m=function(e){var n=r(e.components);return i.createElement(s.Provider,{value:n},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},u=i.forwardRef((function(e,n){var t=e.components,p=e.mdxType,a=e.originalType,s=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),d=r(t),u=p,f=d["".concat(s,".").concat(u)]||d[u]||c[u]||a;return t?i.createElement(f,o(o({ref:n},m),{},{components:t})):i.createElement(f,o({ref:n},m))}));function f(e,n){var t=arguments,p=n&&n.mdxType;if("string"==typeof e||p){var a=t.length,o=new Array(a);o[0]=u;var l={};for(var s in n)hasOwnProperty.call(n,s)&&(l[s]=n[s]);l.originalType=e,l[d]="string"==typeof e?e:p,o[1]=l;for(var r=2;r{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>s,default:()=>f,frontMatter:()=>l,metadata:()=>r,toc:()=>d});var i=t(7462),p=t(3366),a=(t(7294),t(3905)),o=["components"],l={id:"openbim_components.SimpleScene",title:"Class: SimpleScene",sidebar_label:"SimpleScene",custom_edit_url:null},s=void 0,r={unversionedId:"api/classes/openbim_components.SimpleScene",id:"api/classes/openbim_components.SimpleScene",title:"Class: SimpleScene",description:"openbim-components.SimpleScene",source:"@site/docs/api/classes/openbim_components.SimpleScene.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.SimpleScene",permalink:"/api/classes/openbim_components.SimpleScene",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.SimpleScene",title:"Class: SimpleScene",sidebar_label:"SimpleScene",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"SimpleRenderer",permalink:"/api/classes/openbim_components.SimpleRenderer"},next:{title:"ToolComponent",permalink:"/api/classes/openbim_components.ToolComponent"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"isSetup",id:"issetup",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"setup",id:"setup",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Defined in",id:"defined-in-11",level:4}],c={toc:d},u="wrapper";function f(e){var n=e.components,t=(0,p.Z)(e,o);return(0,a.kt)(u,(0,i.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".SimpleScene"),(0,a.kt)("p",null,"A basic 3D ",(0,a.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/scenes/Scene"},"scene")," to add\nobjects hierarchically, and easily dispose them when you are finished with it."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"No Inherit Doc"))),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,a.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"THREE.Scene"),">"),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"SimpleScene"))))),(0,a.kt)("h2",{id:"implements"},"Implements"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,a.kt)("inlineCode",{parentName:"a"},"Disposable"))),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Configurable"},(0,a.kt)("inlineCode",{parentName:"a"},"Configurable")),"<{}",">")),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"enabled"},"enabled"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"enabled"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"true")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleScene/index.ts#L28"},"temp/engine_components/src/core/SimpleScene/index.ts:28")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"issetup"},"isSetup"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"isSetup"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"false")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable#issetup"},"Configurable.isSetup")),(0,a.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),".",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable#issetup"},"isSetup")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleScene/index.ts#L31"},"temp/engine_components/src/core/SimpleScene/index.ts:31")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,a.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"undefined"),">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,a.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleScene/index.ts#L34"},"temp/engine_components/src/core/SimpleScene/index.ts:34")),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"dispose"},"dispose"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleScene/index.ts#L50"},"temp/engine_components/src/core/SimpleScene/index.ts:50")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"get"},"get"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"get"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Scene")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Scene")),(0,a.kt)("h4",{id:"overrides-1"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleScene/index.ts#L45"},"temp/engine_components/src/core/SimpleScene/index.ts:45")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"hasui"},"hasUI"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,a.kt)("p",null,"Whether is component implements any kind of ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,"this is UI"),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,"this is Configurable"),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,"this is Disposable"),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ishideable"},"isHideable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,"this is Hideable"),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,"this is Resizeable"),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,a.kt)("h4",{id:"returns-7"},"Returns"),(0,a.kt)("p",null,"this is Updateable"),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"setup"},"setup"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"setup"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"config?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("p",null,"Creates a simple and nice default set up for the scene (e.g. lighting)."),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"config?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"SimpleSceneConfig"),">")))),(0,a.kt)("h4",{id:"returns-8"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),".",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable#setup"},"setup")),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleScene/index.ts#L77"},"temp/engine_components/src/core/SimpleScene/index.ts:77")))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/6713fb58.abfd44da.js b/build/assets/js/6713fb58.cf584aeb.js similarity index 50% rename from build/assets/js/6713fb58.abfd44da.js rename to build/assets/js/6713fb58.cf584aeb.js index 05f14466..89408f73 100644 --- a/build/assets/js/6713fb58.abfd44da.js +++ b/build/assets/js/6713fb58.cf584aeb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9280],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>f});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=a.createContext({}),d=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},s=function(e){var t=d(e.components);return a.createElement(l.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,l=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),c=d(n),u=i,f=c["".concat(l,".").concat(u)]||c[u]||m[u]||r;return n?a.createElement(f,o(o({ref:t},s),{},{components:n})):a.createElement(f,o({ref:t},s))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,o=new Array(r);o[0]=u;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p[c]="string"==typeof e?e:i,o[1]=p;for(var d=2;d{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>f,frontMatter:()=>p,metadata:()=>d,toc:()=>c});var a=n(7462),i=n(3366),r=(n(7294),n(3905)),o=["components"],p={id:"openbim_components.NavigationMode",title:"Interface: NavigationMode",sidebar_label:"NavigationMode",custom_edit_url:null},l=void 0,d={unversionedId:"api/interfaces/openbim_components.NavigationMode",id:"api/interfaces/openbim_components.NavigationMode",title:"Interface: NavigationMode",description:"openbim-components.NavigationMode",source:"@site/docs/api/interfaces/openbim_components.NavigationMode.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/openbim_components.NavigationMode",permalink:"/api/interfaces/openbim_components.NavigationMode",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.NavigationMode",title:"Interface: NavigationMode",sidebar_label:"NavigationMode",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Hideable",permalink:"/api/interfaces/openbim_components.Hideable"},next:{title:"Progress",permalink:"/api/interfaces/openbim_components.Progress"}},s={},c=[{value:"Properties",id:"properties",level:2},{value:"enabled",id:"enabled",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"projectionChanged",id:"projectionchanged",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"toggle",id:"toggle",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-3",level:4}],m={toc:c},u="wrapper";function f(e){var t=e.components,n=(0,i.Z)(e,o);return(0,r.kt)(u,(0,a.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".NavigationMode"),(0,r.kt)("p",null,"An object that determines the behavior of the camera controls\nand the user input (e.g. 2D floor plan mode, first person mode, etc)."),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"enabled"},"enabled"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"enabled"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Whether this navigation mode is active or not."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/OrthoPerspectiveCamera/src/types.ts#L33"},"temp/engine_components/src/navigation/OrthoPerspectiveCamera/src/types.ts:33")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"id"},"id"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"id"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#navmodeid"},(0,r.kt)("inlineCode",{parentName:"a"},"NavModeID"))),(0,r.kt)("p",null,"The unique ID of this navigation mode."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/OrthoPerspectiveCamera/src/types.ts#L20"},"temp/engine_components/src/navigation/OrthoPerspectiveCamera/src/types.ts:20")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"projectionchanged"},"projectionChanged"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"projectionChanged"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Camera"),">"),(0,r.kt)("p",null,"Event that should fire when the camera ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection")," changes."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/OrthoPerspectiveCamera/src/types.ts#L38"},"temp/engine_components/src/navigation/OrthoPerspectiveCamera/src/types.ts:38")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"toggle"},"toggle"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"toggle"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"active"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"active"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Enable or disable this navigation mode.\nWhen a new navigation mode is enabled, the previous navigation mode\nmust be disabled."),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"active")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"whether to enable or disable this mode.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"any additional data required to enable or disable it.")))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/OrthoPerspectiveCamera/src/types.ts#L30"},"temp/engine_components/src/navigation/OrthoPerspectiveCamera/src/types.ts:30")))}f.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9280],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>v});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=a.createContext({}),d=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},s=function(e){var t=d(e.components);return a.createElement(l.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,l=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),c=d(n),u=i,v=c["".concat(l,".").concat(u)]||c[u]||m[u]||r;return n?a.createElement(v,o(o({ref:t},s),{},{components:n})):a.createElement(v,o({ref:t},s))}));function v(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,o=new Array(r);o[0]=u;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p[c]="string"==typeof e?e:i,o[1]=p;for(var d=2;d{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>v,frontMatter:()=>p,metadata:()=>d,toc:()=>c});var a=n(7462),i=n(3366),r=(n(7294),n(3905)),o=["components"],p={id:"openbim_components.NavigationMode",title:"Interface: NavigationMode",sidebar_label:"NavigationMode",custom_edit_url:null},l=void 0,d={unversionedId:"api/interfaces/openbim_components.NavigationMode",id:"api/interfaces/openbim_components.NavigationMode",title:"Interface: NavigationMode",description:"openbim-components.NavigationMode",source:"@site/docs/api/interfaces/openbim_components.NavigationMode.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/openbim_components.NavigationMode",permalink:"/api/interfaces/openbim_components.NavigationMode",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.NavigationMode",title:"Interface: NavigationMode",sidebar_label:"NavigationMode",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Hideable",permalink:"/api/interfaces/openbim_components.Hideable"},next:{title:"Progress",permalink:"/api/interfaces/openbim_components.Progress"}},s={},c=[{value:"Properties",id:"properties",level:2},{value:"enabled",id:"enabled",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"projectionChanged",id:"projectionchanged",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"toggle",id:"toggle",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-3",level:4}],m={toc:c},u="wrapper";function v(e){var t=e.components,n=(0,i.Z)(e,o);return(0,r.kt)(u,(0,a.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".NavigationMode"),(0,r.kt)("p",null,"An object that determines the behavior of the camera controls\nand the user input (e.g. 2D floor plan mode, first person mode, etc)."),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"enabled"},"enabled"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"enabled"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Whether this navigation mode is active or not."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/OrthoPerspectiveCamera/src/types.ts#L33"},"src/navigation/OrthoPerspectiveCamera/src/types.ts:33")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"id"},"id"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"id"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#navmodeid"},(0,r.kt)("inlineCode",{parentName:"a"},"NavModeID"))),(0,r.kt)("p",null,"The unique ID of this navigation mode."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/OrthoPerspectiveCamera/src/types.ts#L20"},"src/navigation/OrthoPerspectiveCamera/src/types.ts:20")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"projectionchanged"},"projectionChanged"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"projectionChanged"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Camera"),">"),(0,r.kt)("p",null,"Event that should fire when the camera ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection")," changes."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/OrthoPerspectiveCamera/src/types.ts#L38"},"src/navigation/OrthoPerspectiveCamera/src/types.ts:38")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"toggle"},"toggle"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"toggle"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"active"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"active"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Enable or disable this navigation mode.\nWhen a new navigation mode is enabled, the previous navigation mode\nmust be disabled."),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"active")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"whether to enable or disable this mode.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"any additional data required to enable or disable it.")))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/OrthoPerspectiveCamera/src/types.ts#L30"},"src/navigation/OrthoPerspectiveCamera/src/types.ts:30")))}v.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/6809.5a0ae76e.js b/build/assets/js/6809.5a0ae76e.js deleted file mode 100644 index ffd6935f..00000000 --- a/build/assets/js/6809.5a0ae76e.js +++ /dev/null @@ -1 +0,0 @@ -(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6809],{3905:(e,t,n)=>{"use strict";n.d(t,{Zo:()=>u,kt:()=>p});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var c=r.createContext({}),s=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},u=function(e){var t=s(e.components);return r.createElement(c.Provider,{value:t},e.children)},d="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,c=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),d=s(n),f=a,p=d["".concat(c,".").concat(f)]||d[f]||m[f]||o;return n?r.createElement(p,i(i({ref:t},u),{},{components:n})):r.createElement(p,i({ref:t},u))}));function p(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,i=new Array(o);i[0]=f;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l[d]="string"==typeof e?e:a,i[1]=l;for(var s=2;s{"use strict";n.d(t,{Z:()=>m});var r=n(7462),a=n(3366),o=n(7294),i=n(6010),l=n(5999),c=n(6668),s=n(9960);const u={anchorWithStickyNavbar:"anchorWithStickyNavbar_LWe7",anchorWithHideOnScrollNavbar:"anchorWithHideOnScrollNavbar_WYt5"};var d=["as","id"];function m(e){var t=e.as,n=e.id,m=(0,a.Z)(e,d),f=(0,c.L)().navbar.hideOnScroll;if("h1"===t||!n)return o.createElement(t,(0,r.Z)({},m,{id:void 0}));var p=(0,l.I)({id:"theme.common.headingLinkTitle",message:"Direct link to {heading}",description:"Title for link to heading"},{heading:"string"==typeof m.children?m.children:n});return o.createElement(t,(0,r.Z)({},m,{className:(0,i.Z)("anchor",f?u.anchorWithHideOnScrollNavbar:u.anchorWithStickyNavbar,m.className),id:n}),m.children,o.createElement(s.Z,{className:"hash-link",to:"#"+n,"aria-label":p,title:p},"\u200b"))}},6905:(e,t,n)=>{"use strict";n.d(t,{Z:()=>Ce});var r=n(7294),a=n(3905),o=n(7462),i=n(3366),l=n(5742),c=["mdxType","originalType"];var s=n(2389),u=n(6010),d=n(2949),m=n(6668);function f(){var e=(0,m.L)().prism,t=(0,d.I)().colorMode,n=e.theme,r=e.darkTheme||n;return"dark"===t?r:n}var p=n(5281),v=n(6528),h=n(7594),g=n.n(h),y=(0,v.Z)(/title=(["'])(.*?)\1/,{quote:1,title:2}),b=(0,v.Z)(/\{([\d,-]+)\}/,{range:1}),E={js:{start:"\\/\\/",end:""},jsBlock:{start:"\\/\\*",end:"\\*\\/"},jsx:{start:"\\{\\s*\\/\\*",end:"\\*\\/\\s*\\}"},bash:{start:"#",end:""},html:{start:"\x3c!--",end:"--\x3e"}};function k(e,t){var n=e.map((function(e){var n=E[e],r=n.start,a=n.end;return"(?:"+r+"\\s*("+t.flatMap((function(e){var t,n;return[e.line,null==(t=e.block)?void 0:t.start,null==(n=e.block)?void 0:n.end].filter(Boolean)})).join("|")+")\\s*"+a+")"})).join("|");return new RegExp("^\\s*(?:"+n+")\\s*$")}function N(e,t){var n=e.replace(/\n$/,""),r=t.language,a=t.magicComments,o=t.metastring;if(o&&b.test(o)){var i=o.match(b).groups.range;if(0===a.length)throw new Error("A highlight range has been given in code block's metastring (``` "+o+"), but no magic comment config is available. Docusaurus applies the first magic comment entry's className for metastring ranges.");var l=a[0].className,c=g()(i).filter((function(e){return e>0})).map((function(e){return[e-1,[l]]}));return{lineClassNames:Object.fromEntries(c),code:n}}if(void 0===r)return{lineClassNames:{},code:n};for(var s=function(e,t){switch(e){case"js":case"javascript":case"ts":case"typescript":return k(["js","jsBlock"],t);case"jsx":case"tsx":return k(["js","jsBlock","jsx"],t);case"html":return k(["js","jsBlock","html"],t);case"python":case"py":case"bash":return k(["bash"],t);case"markdown":case"md":return k(["html","jsx","bash"],t);default:return k(Object.keys(E),t)}}(r,a),u=n.split("\n"),d=Object.fromEntries(a.map((function(e){return[e.className,{start:0,range:""}]}))),m=Object.fromEntries(a.filter((function(e){return e.line})).map((function(e){var t=e.className;return[e.line,t]}))),f=Object.fromEntries(a.filter((function(e){return e.block})).map((function(e){var t=e.className;return[e.block.start,t]}))),p=Object.fromEntries(a.filter((function(e){return e.block})).map((function(e){var t=e.className;return[e.block.end,t]}))),v=0;v0&&e[n-1]===t?e:e.concat(t)};function z(e,t){var n={};for(var r in e)Object.prototype.hasOwnProperty.call(e,r)&&-1===t.indexOf(r)&&(n[r]=e[r]);return n}var M=function(e){function t(){for(var t=this,n=[],r=arguments.length;r--;)n[r]=arguments[r];e.apply(this,n),_(this,"getThemeDict",(function(e){if(void 0!==t.themeDict&&e.theme===t.prevTheme&&e.language===t.prevLanguage)return t.themeDict;t.prevTheme=e.theme,t.prevLanguage=e.language;var n=e.theme?function(e,t){var n=e.plain,r=Object.create(null),a=e.styles.reduce((function(e,n){var r=n.languages,a=n.style;return r&&!r.includes(t)||n.types.forEach((function(t){var n=S({},e[t],a);e[t]=n})),e}),r);return a.root=n,a.plain=S({},n,{backgroundColor:null}),a}(e.theme,e.language):void 0;return t.themeDict=n})),_(this,"getLineProps",(function(e){var n=e.key,r=e.className,a=e.style,o=S({},z(e,["key","className","style","line"]),{className:"token-line",style:void 0,key:void 0}),i=t.getThemeDict(t.props);return void 0!==i&&(o.style=i.plain),void 0!==a&&(o.style=void 0!==o.style?S({},o.style,a):a),void 0!==n&&(o.key=n),r&&(o.className+=" "+r),o})),_(this,"getStyleForToken",(function(e){var n=e.types,r=e.empty,a=n.length,o=t.getThemeDict(t.props);if(void 0!==o){if(1===a&&"plain"===n[0])return r?{display:"inline-block"}:void 0;if(1===a&&!r)return o[n[0]];var i=r?{display:"inline-block"}:{},l=n.map((function(e){return o[e]}));return Object.assign.apply(Object,[i].concat(l))}})),_(this,"getTokenProps",(function(e){var n=e.key,r=e.className,a=e.style,o=e.token,i=S({},z(e,["key","className","style","token"]),{className:"token "+o.types.join(" "),children:o.content,style:t.getStyleForToken(o),key:void 0});return void 0!==a&&(i.style=void 0!==i.style?S({},i.style,a):a),void 0!==n&&(i.key=n),r&&(i.className+=" "+r),i})),_(this,"tokenize",(function(e,t,n,r){var a={code:t,grammar:n,language:r,tokens:[]};e.hooks.run("before-tokenize",a);var o=a.tokens=e.tokenize(a.code,a.grammar,a.language);return e.hooks.run("after-tokenize",a),o}))}return e&&(t.__proto__=e),t.prototype=Object.create(e&&e.prototype),t.prototype.constructor=t,t.prototype.render=function(){var e=this.props,t=e.Prism,n=e.language,r=e.code,a=e.children,o=this.getThemeDict(this.props),i=t.languages[n];return a({tokens:function(e){for(var t=[[]],n=[e],r=[0],a=[e.length],o=0,i=0,l=[],c=[l];i>-1;){for(;(o=r[i]++)0?u:["plain"],s=d):(u=P(u,d.type),d.alias&&(u=P(u,d.alias)),s=d.content),"string"==typeof s){var m=s.split(A),f=m.length;l.push({types:u,content:m[0]});for(var p=1;p0&&i.getRangeAt(0);r.append(a),a.select(),a.selectionStart=0,a.selectionEnd=e.length;var c=!1;try{c=document.execCommand("copy")}catch(s){}a.remove(),l&&(i.removeAllRanges(),i.addRange(l)),o&&o.focus()}(t),i(!0),l.current=window.setTimeout((function(){i(!1)}),1e3)}),[t]);return(0,r.useEffect)((function(){return function(){return window.clearTimeout(l.current)}}),[]),r.createElement("button",{type:"button","aria-label":o?(0,V.I)({id:"theme.CodeBlock.copied",message:"Copied",description:"The copied button label on code blocks"}):(0,V.I)({id:"theme.CodeBlock.copyButtonAriaLabel",message:"Copy code to clipboard",description:"The ARIA label for copy code blocks button"}),title:(0,V.I)({id:"theme.CodeBlock.copy",message:"Copy",description:"The copy button label on code blocks"}),className:(0,u.Z)("clean-btn",n,U.copyButton,o&&U.copyButtonCopied),onClick:c},r.createElement("span",{className:U.copyButtonIcons,"aria-hidden":"true"},r.createElement(q,{className:U.copyButtonIcon}),r.createElement(F,{className:U.copyButtonSuccessIcon})))}function $(e){return r.createElement("svg",(0,o.Z)({viewBox:"0 0 24 24"},e),r.createElement("path",{fill:"currentColor",d:"M4 19h6v-2H4v2zM20 5H4v2h16V5zm-3 6H4v2h13.25c1.1 0 2 .9 2 2s-.9 2-2 2H15v-2l-3 3l3 3v-2h2c2.21 0 4-1.79 4-4s-1.79-4-4-4z"}))}const Y={wordWrapButtonIcon:"wordWrapButtonIcon_Bwma",wordWrapButtonEnabled:"wordWrapButtonEnabled_EoeP"};function Q(e){var t=e.className,n=e.onClick,a=e.isEnabled,o=(0,V.I)({id:"theme.CodeBlock.wordWrapToggle",message:"Toggle word wrap",description:"The title attribute for toggle word wrapping button of code block lines"});return r.createElement("button",{type:"button",onClick:n,className:(0,u.Z)("clean-btn",t,a&&Y.wordWrapButtonEnabled),"aria-label":o,title:o},r.createElement($,{className:Y.wordWrapButtonIcon,"aria-hidden":"true"}))}function X(e){var t,n,a,i,l,c,s,d,p,v,h,g=e.children,b=e.className,E=void 0===b?"":b,k=e.metastring,C=e.title,L=e.showLineNumbers,Z=e.language,x=(0,m.L)().prism,T=x.defaultLanguage,j=x.magicComments,_=null!=(t=null!=Z?Z:null==(n=E.split(" ").find((function(e){return e.startsWith("language-")})))?void 0:n.replace(/language-/,""))?t:T,S=f(),A=(a=(0,r.useState)(!1),i=a[0],l=a[1],c=(0,r.useState)(!1),s=c[0],d=c[1],p=(0,r.useRef)(null),v=(0,r.useCallback)((function(){var e=p.current.querySelector("code");i?e.removeAttribute("style"):(e.style.whiteSpace="pre-wrap",e.style.overflowWrap="anywhere"),l((function(e){return!e}))}),[p,i]),h=(0,r.useCallback)((function(){var e=p.current,t=e.scrollWidth>e.clientWidth||p.current.querySelector("code").hasAttribute("style");d(t)}),[p]),O(p,h),(0,r.useEffect)((function(){h()}),[i,h]),(0,r.useEffect)((function(){return window.addEventListener("resize",h,{passive:!0}),function(){window.removeEventListener("resize",h)}}),[h]),{codeBlockRef:p,isEnabled:i,isCodeScrollable:s,toggle:v}),I=function(e){var t,n;return null!=(t=null==e||null==(n=e.match(y))?void 0:n.groups.title)?t:""}(k)||C,P=N(g,{metastring:k,language:_,magicComments:j}),z=P.lineClassNames,M=P.code,W=null!=L?L:function(e){return Boolean(null==e?void 0:e.includes("showLineNumbers"))}(k);return r.createElement(w,{as:"div",className:(0,u.Z)(E,_&&!E.includes("language-"+_)&&"language-"+_)},I&&r.createElement("div",{className:B.codeBlockTitle},I),r.createElement("div",{className:B.codeBlockContent},r.createElement(D,(0,o.Z)({},H,{theme:S,code:M,language:null!=_?_:"text"}),(function(e){var t=e.className,n=e.tokens,a=e.getLineProps,o=e.getTokenProps;return r.createElement("pre",{tabIndex:0,ref:A.codeBlockRef,className:(0,u.Z)(t,B.codeBlock,"thin-scrollbar")},r.createElement("code",{className:(0,u.Z)(B.codeBlockLines,W&&B.codeBlockLinesWithNumbering)},n.map((function(e,t){return r.createElement(R,{key:t,line:e,getLineProps:a,getTokenProps:o,classNames:z[t],showLineNumbers:W})}))))})),r.createElement("div",{className:B.buttonGroup},(A.isEnabled||A.isCodeScrollable)&&r.createElement(Q,{className:B.codeButton,onClick:function(){return A.toggle()},isEnabled:A.isEnabled}),r.createElement(G,{className:B.codeButton,code:M}))))}var J=["children"];function K(e){var t=e.children,n=(0,i.Z)(e,J),a=(0,s.Z)(),l=function(e){return r.Children.toArray(e).some((function(e){return(0,r.isValidElement)(e)}))?e:Array.isArray(e)?e.join(""):e}(t),c="string"==typeof l?X:Z;return r.createElement(c,(0,o.Z)({key:String(a)},n),l)}var ee=n(9960);var te=n(6043);const ne={details:"details_lb9f",isBrowser:"isBrowser_bmU9",collapsibleContent:"collapsibleContent_i85q"};var re=["summary","children"];function ae(e){return!!e&&("SUMMARY"===e.tagName||ae(e.parentElement))}function oe(e,t){return!!e&&(e===t||oe(e.parentElement,t))}function ie(e){var t=e.summary,n=e.children,a=(0,i.Z)(e,re),l=(0,s.Z)(),c=(0,r.useRef)(null),d=(0,te.u)({initialState:!a.open}),m=d.collapsed,f=d.setCollapsed,p=(0,r.useState)(a.open),v=p[0],h=p[1],g=r.isValidElement(t)?t:r.createElement("summary",null,null!=t?t:"Details");return r.createElement("details",(0,o.Z)({},a,{ref:c,open:v,"data-collapsed":m,className:(0,u.Z)(ne.details,l&&ne.isBrowser,a.className),onMouseDown:function(e){ae(e.target)&&e.detail>1&&e.preventDefault()},onClick:function(e){e.stopPropagation();var t=e.target;ae(t)&&oe(t,c.current)&&(e.preventDefault(),m?(f(!1),h(!0)):f(!0))}}),g,r.createElement(te.z,{lazy:!1,collapsed:m,disableSSRStyle:!0,onCollapseTransitionEnd:function(e){f(e),h(!e)}},r.createElement("div",{className:ne.collapsibleContent},n)))}const le={details:"details_b_Ee"};var ce="alert alert--info";function se(e){var t=Object.assign({},(function(e){if(null==e)throw new TypeError("Cannot destructure "+e)}(e),e));return r.createElement(ie,(0,o.Z)({},t,{className:(0,u.Z)(ce,le.details,t.className)}))}var ue=n(2503);function de(e){return r.createElement(ue.Z,e)}const me={containsTaskList:"containsTaskList_mC6p"};function fe(e){if(void 0!==e)return(0,u.Z)(e,(null==e?void 0:e.includes("contains-task-list"))&&me.containsTaskList)}const pe={img:"img_ev3q"};const ve="admonition_LlT9",he="admonitionHeading_tbUL",ge="admonitionIcon_kALy",ye="admonitionContent_S0QG";var be={note:{infimaClassName:"secondary",iconComponent:function(){return r.createElement("svg",{viewBox:"0 0 14 16"},r.createElement("path",{fillRule:"evenodd",d:"M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"}))},label:r.createElement(V.Z,{id:"theme.admonition.note",description:"The default label used for the Note admonition (:::note)"},"note")},tip:{infimaClassName:"success",iconComponent:function(){return r.createElement("svg",{viewBox:"0 0 12 16"},r.createElement("path",{fillRule:"evenodd",d:"M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"}))},label:r.createElement(V.Z,{id:"theme.admonition.tip",description:"The default label used for the Tip admonition (:::tip)"},"tip")},danger:{infimaClassName:"danger",iconComponent:function(){return r.createElement("svg",{viewBox:"0 0 12 16"},r.createElement("path",{fillRule:"evenodd",d:"M5.05.31c.81 2.17.41 3.38-.52 4.31C3.55 5.67 1.98 6.45.9 7.98c-1.45 2.05-1.7 6.53 3.53 7.7-2.2-1.16-2.67-4.52-.3-6.61-.61 2.03.53 3.33 1.94 2.86 1.39-.47 2.3.53 2.27 1.67-.02.78-.31 1.44-1.13 1.81 3.42-.59 4.78-3.42 4.78-5.56 0-2.84-2.53-3.22-1.25-5.61-1.52.13-2.03 1.13-1.89 2.75.09 1.08-1.02 1.8-1.86 1.33-.67-.41-.66-1.19-.06-1.78C8.18 5.31 8.68 2.45 5.05.32L5.03.3l.02.01z"}))},label:r.createElement(V.Z,{id:"theme.admonition.danger",description:"The default label used for the Danger admonition (:::danger)"},"danger")},info:{infimaClassName:"info",iconComponent:function(){return r.createElement("svg",{viewBox:"0 0 14 16"},r.createElement("path",{fillRule:"evenodd",d:"M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"}))},label:r.createElement(V.Z,{id:"theme.admonition.info",description:"The default label used for the Info admonition (:::info)"},"info")},caution:{infimaClassName:"warning",iconComponent:function(){return r.createElement("svg",{viewBox:"0 0 16 16"},r.createElement("path",{fillRule:"evenodd",d:"M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"}))},label:r.createElement(V.Z,{id:"theme.admonition.caution",description:"The default label used for the Caution admonition (:::caution)"},"caution")}},Ee={secondary:"note",important:"info",success:"tip",warning:"danger"};function ke(e){var t,n=function(e){var t=r.Children.toArray(e),n=t.find((function(e){var t;return r.isValidElement(e)&&"mdxAdmonitionTitle"===(null==(t=e.props)?void 0:t.mdxType)})),a=r.createElement(r.Fragment,null,t.filter((function(e){return e!==n})));return{mdxAdmonitionTitle:n,rest:a}}(e.children),a=n.mdxAdmonitionTitle,o=n.rest;return Object.assign({},e,{title:null!=(t=e.title)?t:a,children:o})}const Ne={head:function(e){var t=r.Children.map(e.children,(function(e){return r.isValidElement(e)?function(e){var t;if(null!=(t=e.props)&&t.mdxType&&e.props.originalType){var n=e.props,a=(n.mdxType,n.originalType,(0,i.Z)(n,c));return r.createElement(e.props.originalType,a)}return e}(e):e}));return r.createElement(l.Z,e,t)},code:function(e){var t=["a","abbr","b","br","button","cite","code","del","dfn","em","i","img","input","ins","kbd","label","object","output","q","ruby","s","small","span","strong","sub","sup","time","u","var","wbr"];return r.Children.toArray(e.children).every((function(e){var n;return"string"==typeof e&&!e.includes("\n")||(0,r.isValidElement)(e)&&t.includes(null==(n=e.props)?void 0:n.mdxType)}))?r.createElement("code",e):r.createElement(K,e)},a:function(e){return r.createElement(ee.Z,e)},pre:function(e){var t;return r.createElement(K,(0,r.isValidElement)(e.children)&&"code"===(null==(t=e.children.props)?void 0:t.originalType)?e.children.props:Object.assign({},e))},details:function(e){var t=r.Children.toArray(e.children),n=t.find((function(e){var t;return r.isValidElement(e)&&"summary"===(null==(t=e.props)?void 0:t.mdxType)})),a=r.createElement(r.Fragment,null,t.filter((function(e){return e!==n})));return r.createElement(se,(0,o.Z)({},e,{summary:n}),a)},ul:function(e){return r.createElement("ul",(0,o.Z)({},e,{className:fe(e.className)}))},img:function(e){return r.createElement("img",(0,o.Z)({loading:"lazy"},e,{className:(t=e.className,(0,u.Z)(t,pe.img))}));var t},h1:function(e){return r.createElement(de,(0,o.Z)({as:"h1"},e))},h2:function(e){return r.createElement(de,(0,o.Z)({as:"h2"},e))},h3:function(e){return r.createElement(de,(0,o.Z)({as:"h3"},e))},h4:function(e){return r.createElement(de,(0,o.Z)({as:"h4"},e))},h5:function(e){return r.createElement(de,(0,o.Z)({as:"h5"},e))},h6:function(e){return r.createElement(de,(0,o.Z)({as:"h6"},e))},admonition:function(e){var t=ke(e),n=t.children,a=t.type,o=t.title,i=t.icon,l=function(e){var t,n=null!=(t=Ee[e])?t:e,r=be[n];return r||(console.warn('No admonition config found for admonition type "'+n+'". Using Info as fallback.'),be.info)}(a),c=null!=o?o:l.label,s=l.iconComponent,d=null!=i?i:r.createElement(s,null);return r.createElement("div",{className:(0,u.Z)(p.k.common.admonition,p.k.common.admonitionType(e.type),"alert","alert--"+l.infimaClassName,ve)},r.createElement("div",{className:he},r.createElement("span",{className:ge},d),c),r.createElement("div",{className:ye},n))},mermaid:n(1875).Z};function Ce(e){var t=e.children;return r.createElement(a.Zo,{components:Ne},t)}},9407:(e,t,n)=>{"use strict";n.d(t,{Z:()=>m});var r=n(7462),a=n(3366),o=n(7294),i=n(6010),l=n(3743);const c={tableOfContents:"tableOfContents_bqdL",docItemContainer:"docItemContainer_F8PC"};var s=["className"],u="table-of-contents__link toc-highlight",d="table-of-contents__link--active";function m(e){var t=e.className,n=(0,a.Z)(e,s);return o.createElement("div",{className:(0,i.Z)(c.tableOfContents,"thin-scrollbar",t)},o.createElement(l.Z,(0,r.Z)({},n,{linkClassName:u,linkActiveClassName:d})))}},3743:(e,t,n)=>{"use strict";n.d(t,{Z:()=>g});var r=n(7462),a=n(3366),o=n(7294),i=n(6668),l=["parentIndex"];function c(e){var t=e.map((function(e){return Object.assign({},e,{parentIndex:-1,children:[]})})),n=Array(7).fill(-1);t.forEach((function(e,t){var r=n.slice(2,e.level);e.parentIndex=Math.max.apply(Math,r),n[e.level]=t}));var r=[];return t.forEach((function(e){var n=e.parentIndex,o=(0,a.Z)(e,l);n>=0?t[n].children.push(o):r.push(o)})),r}function s(e){var t=e.toc,n=e.minHeadingLevel,r=e.maxHeadingLevel;return t.flatMap((function(e){var t=s({toc:e.children,minHeadingLevel:n,maxHeadingLevel:r});return function(e){return e.level>=n&&e.level<=r}(e)?[Object.assign({},e,{children:t})]:t}))}function u(e){var t=e.getBoundingClientRect();return t.top===t.bottom?u(e.parentNode):t}function d(e,t){var n,r,a=t.anchorTopOffset,o=e.find((function(e){return u(e).top>=a}));return o?function(e){return e.top>0&&e.bottom{function n(e){let t,n=[];for(let r of e.split(",").map((e=>e.trim())))if(/^-?\d+$/.test(r))n.push(parseInt(r,10));else if(t=r.match(/^(-?\d+)(-|\.\.\.?|\u2025|\u2026|\u22EF)(-?\d+)$/)){let[e,r,a,o]=t;if(r&&o){r=parseInt(r),o=parseInt(o);const e=r{t.d(n,{Zo:()=>d,kt:()=>f});var i=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function p(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function r(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=i.createContext({}),o=function(e){var n=i.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):r(r({},n),e)),t},d=function(e){var n=o(e.components);return i.createElement(s.Provider,{value:n},e.children)},m="mdxType",c={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},k=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,p=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),m=o(t),k=a,f=m["".concat(s,".").concat(k)]||m[k]||c[k]||p;return t?i.createElement(f,r(r({ref:n},d),{},{components:t})):i.createElement(f,r({ref:n},d))}));function f(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var p=t.length,r=new Array(p);r[0]=k;var l={};for(var s in n)hasOwnProperty.call(n,s)&&(l[s]=n[s]);l.originalType=e,l[m]="string"==typeof e?e:a,r[1]=l;for(var o=2;o{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>f,frontMatter:()=>l,metadata:()=>o,toc:()=>m});var i=t(7462),a=t(3366),p=(t(7294),t(3905)),r=["components"],l={id:"openbim_components.SimpleRenderer",title:"Class: SimpleRenderer",sidebar_label:"SimpleRenderer",custom_edit_url:null},s=void 0,o={unversionedId:"api/classes/openbim_components.SimpleRenderer",id:"api/classes/openbim_components.SimpleRenderer",title:"Class: SimpleRenderer",description:"openbim-components.SimpleRenderer",source:"@site/docs/api/classes/openbim_components.SimpleRenderer.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.SimpleRenderer",permalink:"/api/classes/openbim_components.SimpleRenderer",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.SimpleRenderer",title:"Class: SimpleRenderer",sidebar_label:"SimpleRenderer",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"SimpleRaycaster",permalink:"/api/classes/openbim_components.SimpleRaycaster"},next:{title:"SimpleScene",permalink:"/api/classes/openbim_components.SimpleScene"}},d={},m=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"clippingPlanes",id:"clippingplanes",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"container",id:"container",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onAfterUpdate",id:"onafterupdate",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"onBeforeUpdate",id:"onbeforeupdate",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"onClippingPlanesUpdated",id:"onclippingplanesupdated",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"onResize",id:"onresize",level:3},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Implementation of",id:"implementation-of-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getSize",id:"getsize",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Implementation of",id:"implementation-of-5",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"resize",id:"resize",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Implementation of",id:"implementation-of-6",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"togglePlane",id:"toggleplane",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"update",id:"update",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Implementation of",id:"implementation-of-7",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"updateClippingPlanes",id:"updateclippingplanes",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-20",level:4}],c={toc:m},k="wrapper";function f(e){var n=e.components,t=(0,a.Z)(e,r);return(0,p.kt)(k,(0,i.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".SimpleRenderer"),(0,p.kt)("p",null,"A basic renderer capable of rendering 3D and 2D objects\n(",(0,p.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/core/Object3D"},"Objec3Ds")," and\n",(0,p.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#examples/en/renderers/CSS2DRenderer"},"CSS2DObjects"),"\nrespectively)."),(0,p.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("p",{parentName:"li"},(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},(0,p.kt)("inlineCode",{parentName:"a"},"BaseRenderer"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"SimpleRenderer"))),(0,p.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.PostproductionRenderer"},(0,p.kt)("inlineCode",{parentName:"a"},"PostproductionRenderer"))))),(0,p.kt)("h2",{id:"implements"},"Implements"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,p.kt)("inlineCode",{parentName:"a"},"Disposable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Updateable"},(0,p.kt)("inlineCode",{parentName:"a"},"Updateable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Resizeable"},(0,p.kt)("inlineCode",{parentName:"a"},"Resizeable")))),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"clippingplanes"},"clippingPlanes"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"clippingPlanes"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"Plane"),"[] = ",(0,p.kt)("inlineCode",{parentName:"p"},"[]")),(0,p.kt)("p",null,"The list of ",(0,p.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer.clippingPlanes"},"clipping planes")," used by this\ninstance of the renderer."),(0,p.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#clippingplanes"},"clippingPlanes")),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-renderer.ts#L33"},"temp/engine_components/src/base-types/base-renderer.ts:33")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"container"},"container"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"container"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"HTMLElement")),(0,p.kt)("p",null,"The HTML container of the THREE.js canvas where the scene is rendered."),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleRenderer/index.ts#L26"},"temp/engine_components/src/core/SimpleRenderer/index.ts:26")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"enabled"},"enabled"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"enabled"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,p.kt)("inlineCode",{parentName:"p"},"true")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,p.kt)("h4",{id:"overrides"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#enabled"},"enabled")),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleRenderer/index.ts#L23"},"temp/engine_components/src/core/SimpleRenderer/index.ts:23")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleRenderer")),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"Updateable.onAfterUpdate")),(0,p.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"onAfterUpdate")),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleRenderer/index.ts#L35"},"temp/engine_components/src/core/SimpleRenderer/index.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleRenderer")),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"Updateable.onBeforeUpdate")),(0,p.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"onBeforeUpdate")),(0,p.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleRenderer/index.ts#L32"},"temp/engine_components/src/core/SimpleRenderer/index.ts:32")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onclippingplanesupdated"},"onClippingPlanesUpdated"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onClippingPlanesUpdated"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,p.kt)("p",null,"Event that fires when there has been a change to the list of clipping\nplanes used by the active renderer."),(0,p.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#onclippingplanesupdated"},"onClippingPlanesUpdated")),(0,p.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-renderer.ts#L27"},"temp/engine_components/src/base-types/base-renderer.ts:27")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"undefined"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,p.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,p.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleRenderer/index.ts#L29"},"temp/engine_components/src/core/SimpleRenderer/index.ts:29")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onresize"},"onResize"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onResize"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#onresize"},"Resizeable.onResize")),(0,p.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#onresize"},"onResize")),(0,p.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#onresize"},"onResize")),(0,p.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-renderer.ts#L21"},"temp/engine_components/src/base-types/base-renderer.ts:21")),(0,p.kt)("h2",{id:"methods"},"Methods"),(0,p.kt)("h3",{id:"dispose"},"dispose"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,p.kt)("h4",{id:"returns"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"implementation-of-4"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,p.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleRenderer/index.ts#L92"},"temp/engine_components/src/core/SimpleRenderer/index.ts:92")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"get"},"get"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"get"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"WebGLRenderer")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,p.kt)("h4",{id:"returns-1"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"WebGLRenderer")),(0,p.kt)("h4",{id:"overrides-1"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#get"},"get")),(0,p.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleRenderer/index.ts#L75"},"temp/engine_components/src/core/SimpleRenderer/index.ts:75")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"getsize"},"getSize"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"getSize"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#getsize"},"Resizeable.getSize"),"."),(0,p.kt)("h4",{id:"returns-2"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,p.kt)("h4",{id:"implementation-of-5"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#getsize"},"getSize")),(0,p.kt)("h4",{id:"overrides-2"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#getsize"},"getSize")),(0,p.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleRenderer/index.ts#L106"},"temp/engine_components/src/core/SimpleRenderer/index.ts:106")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"hasui"},"hasUI"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,p.kt)("p",null,"Whether is component implements any kind of ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,p.kt)("h4",{id:"returns-3"},"Returns"),(0,p.kt)("p",null,"this is UI"),(0,p.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#hasui"},"hasUI")),(0,p.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,p.kt)("h4",{id:"returns-4"},"Returns"),(0,p.kt)("p",null,"this is Configurable"),(0,p.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#isconfigurable"},"isConfigurable")),(0,p.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,p.kt)("h4",{id:"returns-5"},"Returns"),(0,p.kt)("p",null,"this is Disposable"),(0,p.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#isdisposeable"},"isDisposeable")),(0,p.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ishideable"},"isHideable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,p.kt)("h4",{id:"returns-6"},"Returns"),(0,p.kt)("p",null,"this is Hideable"),(0,p.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#ishideable"},"isHideable")),(0,p.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,p.kt)("h4",{id:"returns-7"},"Returns"),(0,p.kt)("p",null,"this is Resizeable"),(0,p.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#isresizeable"},"isResizeable")),(0,p.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,p.kt)("h4",{id:"returns-8"},"Returns"),(0,p.kt)("p",null,"this is Updateable"),(0,p.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#isupdateable"},"isUpdateable")),(0,p.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"resize"},"resize"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"resize"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"size?"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#resize"},"Resizeable.resize"),"."),(0,p.kt)("h4",{id:"parameters"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"size?")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"Vector2"))))),(0,p.kt)("h4",{id:"returns-9"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"implementation-of-6"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#resize"},"resize")),(0,p.kt)("h4",{id:"overrides-3"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#resize"},"resize")),(0,p.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleRenderer/index.ts#L114"},"temp/engine_components/src/core/SimpleRenderer/index.ts:114")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"toggleplane"},"togglePlane"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"togglePlane"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"active"),", ",(0,p.kt)("inlineCode",{parentName:"p"},"plane"),", ",(0,p.kt)("inlineCode",{parentName:"p"},"isLocal?"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,"Adds or removes a\n",(0,p.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer.clippingPlanes"},"clipping plane"),"\nto the renderer."),(0,p.kt)("h4",{id:"parameters-1"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"active")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"plane")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"Plane"))),(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"isLocal?")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,p.kt)("h4",{id:"returns-10"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#toggleplane"},"togglePlane")),(0,p.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-renderer.ts#L48"},"temp/engine_components/src/base-types/base-renderer.ts:48")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"update"},"update"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"update"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"Updateable.update")),(0,p.kt)("h4",{id:"returns-11"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"implementation-of-7"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"update")),(0,p.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleRenderer/index.ts#L80"},"temp/engine_components/src/core/SimpleRenderer/index.ts:80")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"updateclippingplanes"},"updateClippingPlanes"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"updateClippingPlanes"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,"Forces the update of the clipping planes and all components that depend\non them that are subscribed to ",(0,p.kt)("inlineCode",{parentName:"p"},"onClippingPlanesUpdated"),"."),(0,p.kt)("h4",{id:"returns-12"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#updateclippingplanes"},"updateClippingPlanes")),(0,p.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-renderer.ts#L39"},"temp/engine_components/src/base-types/base-renderer.ts:39")))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/746f2b6a.a638442d.js b/build/assets/js/746f2b6a.a638442d.js new file mode 100644 index 00000000..95421d17 --- /dev/null +++ b/build/assets/js/746f2b6a.a638442d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[884],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>u});var a=t(7294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function p(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,a)}return t}function r(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var s=a.createContext({}),o=function(e){var n=a.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):r(r({},n),e)),t},d=function(e){var n=o(e.components);return a.createElement(s.Provider,{value:n},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},c=a.forwardRef((function(e,n){var t=e.components,i=e.mdxType,p=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),m=o(t),c=i,u=m["".concat(s,".").concat(c)]||m[c]||k[c]||p;return t?a.createElement(u,r(r({ref:n},d),{},{components:t})):a.createElement(u,r({ref:n},d))}));function u(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var p=t.length,r=new Array(p);r[0]=c;var l={};for(var s in n)hasOwnProperty.call(n,s)&&(l[s]=n[s]);l.originalType=e,l[m]="string"==typeof e?e:i,r[1]=l;for(var o=2;o{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>u,frontMatter:()=>l,metadata:()=>o,toc:()=>m});var a=t(7462),i=t(3366),p=(t(7294),t(3905)),r=["components"],l={id:"openbim_components.SimpleRenderer",title:"Class: SimpleRenderer",sidebar_label:"SimpleRenderer",custom_edit_url:null},s=void 0,o={unversionedId:"api/classes/openbim_components.SimpleRenderer",id:"api/classes/openbim_components.SimpleRenderer",title:"Class: SimpleRenderer",description:"openbim-components.SimpleRenderer",source:"@site/docs/api/classes/openbim_components.SimpleRenderer.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.SimpleRenderer",permalink:"/api/classes/openbim_components.SimpleRenderer",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.SimpleRenderer",title:"Class: SimpleRenderer",sidebar_label:"SimpleRenderer",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"SimpleRaycaster",permalink:"/api/classes/openbim_components.SimpleRaycaster"},next:{title:"SimpleScene",permalink:"/api/classes/openbim_components.SimpleScene"}},d={},m=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"clippingPlanes",id:"clippingplanes",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"container",id:"container",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onAfterUpdate",id:"onafterupdate",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"onBeforeUpdate",id:"onbeforeupdate",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"onClippingPlanesUpdated",id:"onclippingplanesupdated",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"onResize",id:"onresize",level:3},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Implementation of",id:"implementation-of-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getSize",id:"getsize",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Implementation of",id:"implementation-of-5",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"resize",id:"resize",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Implementation of",id:"implementation-of-6",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"togglePlane",id:"toggleplane",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"update",id:"update",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Implementation of",id:"implementation-of-7",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"updateClippingPlanes",id:"updateclippingplanes",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-20",level:4}],k={toc:m},c="wrapper";function u(e){var n=e.components,t=(0,i.Z)(e,r);return(0,p.kt)(c,(0,a.Z)({},k,t,{components:n,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".SimpleRenderer"),(0,p.kt)("p",null,"A basic renderer capable of rendering 3D and 2D objects\n(",(0,p.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/core/Object3D"},"Objec3Ds")," and\n",(0,p.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#examples/en/renderers/CSS2DRenderer"},"CSS2DObjects"),"\nrespectively)."),(0,p.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("p",{parentName:"li"},(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},(0,p.kt)("inlineCode",{parentName:"a"},"BaseRenderer"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"SimpleRenderer"))),(0,p.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.PostproductionRenderer"},(0,p.kt)("inlineCode",{parentName:"a"},"PostproductionRenderer"))))),(0,p.kt)("h2",{id:"implements"},"Implements"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,p.kt)("inlineCode",{parentName:"a"},"Disposable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Updateable"},(0,p.kt)("inlineCode",{parentName:"a"},"Updateable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Resizeable"},(0,p.kt)("inlineCode",{parentName:"a"},"Resizeable")))),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"clippingplanes"},"clippingPlanes"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"clippingPlanes"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"Plane"),"[] = ",(0,p.kt)("inlineCode",{parentName:"p"},"[]")),(0,p.kt)("p",null,"The list of ",(0,p.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer.clippingPlanes"},"clipping planes")," used by this\ninstance of the renderer."),(0,p.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#clippingplanes"},"clippingPlanes")),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-renderer.ts#L33"},"src/base-types/base-renderer.ts:33")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"container"},"container"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"container"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"HTMLElement")),(0,p.kt)("p",null,"The HTML container of the THREE.js canvas where the scene is rendered."),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleRenderer/index.ts#L26"},"src/core/SimpleRenderer/index.ts:26")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"enabled"},"enabled"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"enabled"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,p.kt)("inlineCode",{parentName:"p"},"true")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,p.kt)("h4",{id:"overrides"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#enabled"},"enabled")),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleRenderer/index.ts#L23"},"src/core/SimpleRenderer/index.ts:23")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleRenderer")),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"Updateable.onAfterUpdate")),(0,p.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"onAfterUpdate")),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleRenderer/index.ts#L35"},"src/core/SimpleRenderer/index.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleRenderer")),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"Updateable.onBeforeUpdate")),(0,p.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"onBeforeUpdate")),(0,p.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleRenderer/index.ts#L32"},"src/core/SimpleRenderer/index.ts:32")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onclippingplanesupdated"},"onClippingPlanesUpdated"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onClippingPlanesUpdated"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,p.kt)("p",null,"Event that fires when there has been a change to the list of clipping\nplanes used by the active renderer."),(0,p.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#onclippingplanesupdated"},"onClippingPlanesUpdated")),(0,p.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-renderer.ts#L27"},"src/base-types/base-renderer.ts:27")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"undefined"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,p.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,p.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleRenderer/index.ts#L29"},"src/core/SimpleRenderer/index.ts:29")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onresize"},"onResize"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onResize"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#onresize"},"Resizeable.onResize")),(0,p.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#onresize"},"onResize")),(0,p.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#onresize"},"onResize")),(0,p.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-renderer.ts#L21"},"src/base-types/base-renderer.ts:21")),(0,p.kt)("h2",{id:"methods"},"Methods"),(0,p.kt)("h3",{id:"dispose"},"dispose"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,p.kt)("h4",{id:"returns"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"implementation-of-4"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,p.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleRenderer/index.ts#L92"},"src/core/SimpleRenderer/index.ts:92")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"get"},"get"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"get"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"WebGLRenderer")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,p.kt)("h4",{id:"returns-1"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"WebGLRenderer")),(0,p.kt)("h4",{id:"overrides-1"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#get"},"get")),(0,p.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleRenderer/index.ts#L75"},"src/core/SimpleRenderer/index.ts:75")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"getsize"},"getSize"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"getSize"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#getsize"},"Resizeable.getSize"),"."),(0,p.kt)("h4",{id:"returns-2"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,p.kt)("h4",{id:"implementation-of-5"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#getsize"},"getSize")),(0,p.kt)("h4",{id:"overrides-2"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#getsize"},"getSize")),(0,p.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleRenderer/index.ts#L106"},"src/core/SimpleRenderer/index.ts:106")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"hasui"},"hasUI"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,p.kt)("p",null,"Whether is component implements any kind of ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,p.kt)("h4",{id:"returns-3"},"Returns"),(0,p.kt)("p",null,"this is UI"),(0,p.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#hasui"},"hasUI")),(0,p.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,p.kt)("h4",{id:"returns-4"},"Returns"),(0,p.kt)("p",null,"this is Configurable"),(0,p.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#isconfigurable"},"isConfigurable")),(0,p.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,p.kt)("h4",{id:"returns-5"},"Returns"),(0,p.kt)("p",null,"this is Disposable"),(0,p.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#isdisposeable"},"isDisposeable")),(0,p.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ishideable"},"isHideable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,p.kt)("h4",{id:"returns-6"},"Returns"),(0,p.kt)("p",null,"this is Hideable"),(0,p.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#ishideable"},"isHideable")),(0,p.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,p.kt)("h4",{id:"returns-7"},"Returns"),(0,p.kt)("p",null,"this is Resizeable"),(0,p.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#isresizeable"},"isResizeable")),(0,p.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,p.kt)("h4",{id:"returns-8"},"Returns"),(0,p.kt)("p",null,"this is Updateable"),(0,p.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#isupdateable"},"isUpdateable")),(0,p.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"resize"},"resize"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"resize"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"size?"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#resize"},"Resizeable.resize"),"."),(0,p.kt)("h4",{id:"parameters"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"size?")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"Vector2"))))),(0,p.kt)("h4",{id:"returns-9"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"implementation-of-6"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#resize"},"resize")),(0,p.kt)("h4",{id:"overrides-3"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#resize"},"resize")),(0,p.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleRenderer/index.ts#L114"},"src/core/SimpleRenderer/index.ts:114")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"toggleplane"},"togglePlane"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"togglePlane"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"active"),", ",(0,p.kt)("inlineCode",{parentName:"p"},"plane"),", ",(0,p.kt)("inlineCode",{parentName:"p"},"isLocal?"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,"Adds or removes a\n",(0,p.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer.clippingPlanes"},"clipping plane"),"\nto the renderer."),(0,p.kt)("h4",{id:"parameters-1"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"active")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"plane")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"Plane"))),(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"isLocal?")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,p.kt)("h4",{id:"returns-10"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#toggleplane"},"togglePlane")),(0,p.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-renderer.ts#L48"},"src/base-types/base-renderer.ts:48")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"update"},"update"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"update"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"Updateable.update")),(0,p.kt)("h4",{id:"returns-11"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"implementation-of-7"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"update")),(0,p.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleRenderer/index.ts#L80"},"src/core/SimpleRenderer/index.ts:80")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"updateclippingplanes"},"updateClippingPlanes"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"updateClippingPlanes"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,"Forces the update of the clipping planes and all components that depend\non them that are subscribed to ",(0,p.kt)("inlineCode",{parentName:"p"},"onClippingPlanesUpdated"),"."),(0,p.kt)("h4",{id:"returns-12"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#updateclippingplanes"},"updateClippingPlanes")),(0,p.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-renderer.ts#L39"},"src/base-types/base-renderer.ts:39")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/7cf9e350.01c4f65b.js b/build/assets/js/7cf9e350.01c4f65b.js deleted file mode 100644 index 19338a1b..00000000 --- a/build/assets/js/7cf9e350.01c4f65b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1510],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>k});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function p(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=a.createContext({}),m=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},s=function(e){var t=m(e.components);return a.createElement(l.Provider,{value:t},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,l=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),d=m(n),h=i,k=d["".concat(l,".").concat(h)]||d[h]||c[h]||r;return n?a.createElement(k,p(p({ref:t},s),{},{components:n})):a.createElement(k,p({ref:t},s))}));function k(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,p=new Array(r);p[0]=h;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o[d]="string"==typeof e?e:i,p[1]=o;for(var m=2;m{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>k,frontMatter:()=>o,metadata:()=>m,toc:()=>d});var a=n(7462),i=n(3366),r=(n(7294),n(3905)),p=["components"],o={id:"openbim_components.OrthoPerspectiveCamera",title:"Class: OrthoPerspectiveCamera",sidebar_label:"OrthoPerspectiveCamera",custom_edit_url:null},l=void 0,m={unversionedId:"api/classes/openbim_components.OrthoPerspectiveCamera",id:"api/classes/openbim_components.OrthoPerspectiveCamera",title:"Class: OrthoPerspectiveCamera",description:"openbim-components.OrthoPerspectiveCamera",source:"@site/docs/api/classes/openbim_components.OrthoPerspectiveCamera.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.OrthoPerspectiveCamera",permalink:"/api/classes/openbim_components.OrthoPerspectiveCamera",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.OrthoPerspectiveCamera",title:"Class: OrthoPerspectiveCamera",sidebar_label:"OrthoPerspectiveCamera",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Mouse",permalink:"/api/classes/openbim_components.Mouse"},next:{title:"PostproductionRenderer",permalink:"/api/classes/openbim_components.PostproductionRenderer"}},s={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"activeCamera",id:"activecamera",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"controls",id:"controls",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"currentMode",id:"currentmode",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"onAfterUpdate",id:"onafterupdate",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"onBeforeUpdate",id:"onbeforeupdate",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"projectionChanged",id:"projectionchanged",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"Accessors",id:"accessors",level:2},{value:"enabled",id:"enabled",level:3},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"matchOrthoDistanceEnabled",id:"matchorthodistanceenabled",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"fit",id:"fit",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"get",id:"get",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getProjection",id:"getprojection",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"setNavigationMode",id:"setnavigationmode",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"setProjection",id:"setprojection",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"toggleProjection",id:"toggleprojection",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"toggleUserInput",id:"toggleuserinput",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"update",id:"update",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"updateAspect",id:"updateaspect",level:3},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-25",level:4}],c={toc:d},h="wrapper";function k(e){var t=e.components,n=(0,i.Z)(e,p);return(0,r.kt)(h,(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".OrthoPerspectiveCamera"),(0,r.kt)("p",null,"A flexible camera that uses\n",(0,r.kt)("a",{parentName:"p",href:"https://github.com/yomotsu/camera-controls"},"yomotsu's cameracontrols")," to\neasily control the camera in 2D and 3D. It supports multiple navigation\nmodes, such as 2D floor plan navigation, first person and 3D orbit."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleCamera"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"OrthoPerspectiveCamera"))))),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},(0,r.kt)("inlineCode",{parentName:"a"},"UI")))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"activecamera"},"activeCamera"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"activeCamera"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"PerspectiveCamera")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,r.kt)("p",null,"The camera that is being used now according to the current ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection"),"."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#activecamera"},"activeCamera")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleCamera/index.ts#L48"},"temp/engine_components/src/core/SimpleCamera/index.ts:48")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"controls"},"controls"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"controls"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"CameraControls")),(0,r.kt)("p",null,"The object that controls the camera. An instance of\n",(0,r.kt)("a",{parentName:"p",href:"https://github.com/yomotsu/camera-controls"},"yomotsu's cameracontrols"),".\nTransforming the camera directly will have no effect: you need to use this\nobject to move, rotate, look at objects, etc."),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#controls"},"controls")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleCamera/index.ts#L33"},"temp/engine_components/src/core/SimpleCamera/index.ts:33")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"currentmode"},"currentMode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"currentMode"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.NavigationMode"},(0,r.kt)("inlineCode",{parentName:"a"},"NavigationMode"))),(0,r.kt)("p",null,"The current ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.NavigationMode"},"NavigationMode"),"."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/OrthoPerspectiveCamera/index.ts#L24"},"temp/engine_components/src/navigation/OrthoPerspectiveCamera/index.ts:24")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleCamera")),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"Updateable.onAfterUpdate")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#onafterupdate"},"onAfterUpdate")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleCamera/index.ts#L20"},"temp/engine_components/src/core/SimpleCamera/index.ts:20")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleCamera")),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"Updateable.onBeforeUpdate")),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#onbeforeupdate"},"onBeforeUpdate")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleCamera/index.ts#L17"},"temp/engine_components/src/core/SimpleCamera/index.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#ondisposed"},"onDisposed")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleCamera/index.ts#L25"},"temp/engine_components/src/core/SimpleCamera/index.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"projectionchanged"},"projectionChanged"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"projectionChanged"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Camera"),">"),(0,r.kt)("p",null,"Event that fires when the ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection")," changes."),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/OrthoPerspectiveCamera/index.ts#L29"},"temp/engine_components/src/navigation/OrthoPerspectiveCamera/index.ts:29")),(0,r.kt)("h2",{id:"accessors"},"Accessors"),(0,r.kt)("h3",{id:"enabled"},"enabled"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"enabled"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,"SimpleCamera.enabled"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleCamera/index.ts#L36"},"temp/engine_components/src/core/SimpleCamera/index.ts:36")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"enabled"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"enabled"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"enabled")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,"SimpleCamera.enabled"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleCamera/index.ts#L41"},"temp/engine_components/src/core/SimpleCamera/index.ts:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"matchorthodistanceenabled"},"matchOrthoDistanceEnabled"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"matchOrthoDistanceEnabled"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Match Ortho zoom with Perspective distance when changing projection mode"),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/OrthoPerspectiveCamera/index.ts#L136"},"temp/engine_components/src/navigation/OrthoPerspectiveCamera/index.ts:136")),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"dispose"},"dispose"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#dispose"},"dispose")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/OrthoPerspectiveCamera/index.ts#L107"},"temp/engine_components/src/navigation/OrthoPerspectiveCamera/index.ts:107")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fit"},"fit"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fit"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"meshes?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"offset?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Make the camera view fit all the specified meshes."),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"meshes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Iterable"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Mesh"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Material"),"[], ",(0,r.kt)("inlineCode",{parentName:"td"},"Object3DEventMap"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the meshes to fit. If it is not defined, it will evaluate ",(0,r.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.Components#meshes"},"Components.meshes"),".")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"offset")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"1.5")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the distance to the fit object")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/OrthoPerspectiveCamera/index.ts#L197"},"temp/engine_components/src/navigation/OrthoPerspectiveCamera/index.ts:197")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"get"},"get"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"get"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"projection?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"PerspectiveCamera")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,r.kt)("p",null,"Similar to ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get"),", but with an optional argument\nto specify which camera to get."),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"projection?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/api/modules/openbim_components#cameraprojection"},(0,r.kt)("inlineCode",{parentName:"a"},"CameraProjection"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The camera corresponding to the ",(0,r.kt)("a",{parentName:"td",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection")," specified. If no projection is specified, the active camera will be returned.")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"PerspectiveCamera")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#get"},"get")),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/OrthoPerspectiveCamera/index.ts#L121"},"temp/engine_components/src/navigation/OrthoPerspectiveCamera/index.ts:121")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getprojection"},"getProjection"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getProjection"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},(0,r.kt)("inlineCode",{parentName:"a"},"CameraProjection"))),(0,r.kt)("p",null,"Returns the current ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection"),"."),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},(0,r.kt)("inlineCode",{parentName:"a"},"CameraProjection"))),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/OrthoPerspectiveCamera/index.ts#L131"},"temp/engine_components/src/navigation/OrthoPerspectiveCamera/index.ts:131")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hasui"},"hasUI"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,r.kt)("p",null,"Whether is component implements any kind of ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,"this is UI"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#hasui"},"hasUI")),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,"this is Configurable"),(0,r.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#isconfigurable"},"isConfigurable")),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,"this is Disposable"),(0,r.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#isdisposeable"},"isDisposeable")),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ishideable"},"isHideable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,"this is Hideable"),(0,r.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#ishideable"},"isHideable")),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,"this is Resizeable"),(0,r.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#isresizeable"},"isResizeable")),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,"this is Updateable"),(0,r.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#isupdateable"},"isUpdateable")),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setnavigationmode"},"setNavigationMode"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setNavigationMode"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"mode"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Sets a new ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.NavigationMode"},"NavigationMode")," and disables the previous one."),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"mode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/api/modules/openbim_components#navmodeid"},(0,r.kt)("inlineCode",{parentName:"a"},"NavModeID"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The ",(0,r.kt)("a",{parentName:"td",href:"/api/interfaces/openbim_components.NavigationMode"},"NavigationMode")," to set.")))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/OrthoPerspectiveCamera/index.ts#L180"},"temp/engine_components/src/navigation/OrthoPerspectiveCamera/index.ts:180")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setprojection"},"setProjection"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setProjection"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"projection"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Sets the current ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection"),". This triggers the event\n",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.OrthoPerspectiveCamera#projectionchanged"},"projectionChanged"),"."),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"projection")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/api/modules/openbim_components#cameraprojection"},(0,r.kt)("inlineCode",{parentName:"a"},"CameraProjection"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The new ",(0,r.kt)("a",{parentName:"td",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection")," to set.")))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/OrthoPerspectiveCamera/index.ts#L157"},"temp/engine_components/src/navigation/OrthoPerspectiveCamera/index.ts:157")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"toggleprojection"},"toggleProjection"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"toggleProjection"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Changes the current ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection")," from Ortographic to Perspective\nand Viceversa."),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/OrthoPerspectiveCamera/index.ts#L144"},"temp/engine_components/src/navigation/OrthoPerspectiveCamera/index.ts:144")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"toggleuserinput"},"toggleUserInput"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"toggleUserInput"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"active"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Allows or prevents all user input."),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"active")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"whether to enable or disable user inputs.")))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/OrthoPerspectiveCamera/index.ts#L167"},"temp/engine_components/src/navigation/OrthoPerspectiveCamera/index.ts:167")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"update"},"update"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"update"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"_delta"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"Updateable.update")),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"_delta")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#update"},"update")),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleCamera/index.ts#L81"},"temp/engine_components/src/core/SimpleCamera/index.ts:81")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"updateaspect"},"updateAspect"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"updateAspect"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Updates the aspect of the camera to match the size of the\n",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Components#renderer"},"Components.renderer"),"."),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#updateaspect"},"updateAspect")),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleCamera/index.ts#L93"},"temp/engine_components/src/core/SimpleCamera/index.ts:93")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/7cf9e350.cf0284e6.js b/build/assets/js/7cf9e350.cf0284e6.js new file mode 100644 index 00000000..3e9aab2c --- /dev/null +++ b/build/assets/js/7cf9e350.cf0284e6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1510],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>k});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function p(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var o=a.createContext({}),s=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},m=function(e){var t=s(e.components);return a.createElement(o.Provider,{value:t},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,o=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),d=s(n),h=i,k=d["".concat(o,".").concat(h)]||d[h]||c[h]||r;return n?a.createElement(k,p(p({ref:t},m),{},{components:n})):a.createElement(k,p({ref:t},m))}));function k(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,p=new Array(r);p[0]=h;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l[d]="string"==typeof e?e:i,p[1]=l;for(var s=2;s{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>o,default:()=>k,frontMatter:()=>l,metadata:()=>s,toc:()=>d});var a=n(7462),i=n(3366),r=(n(7294),n(3905)),p=["components"],l={id:"openbim_components.OrthoPerspectiveCamera",title:"Class: OrthoPerspectiveCamera",sidebar_label:"OrthoPerspectiveCamera",custom_edit_url:null},o=void 0,s={unversionedId:"api/classes/openbim_components.OrthoPerspectiveCamera",id:"api/classes/openbim_components.OrthoPerspectiveCamera",title:"Class: OrthoPerspectiveCamera",description:"openbim-components.OrthoPerspectiveCamera",source:"@site/docs/api/classes/openbim_components.OrthoPerspectiveCamera.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.OrthoPerspectiveCamera",permalink:"/api/classes/openbim_components.OrthoPerspectiveCamera",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.OrthoPerspectiveCamera",title:"Class: OrthoPerspectiveCamera",sidebar_label:"OrthoPerspectiveCamera",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Mouse",permalink:"/api/classes/openbim_components.Mouse"},next:{title:"PostproductionRenderer",permalink:"/api/classes/openbim_components.PostproductionRenderer"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"activeCamera",id:"activecamera",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"controls",id:"controls",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"currentMode",id:"currentmode",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"onAfterUpdate",id:"onafterupdate",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"onBeforeUpdate",id:"onbeforeupdate",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"projectionChanged",id:"projectionchanged",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"Accessors",id:"accessors",level:2},{value:"enabled",id:"enabled",level:3},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"matchOrthoDistanceEnabled",id:"matchorthodistanceenabled",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"fit",id:"fit",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"get",id:"get",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getProjection",id:"getprojection",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"setNavigationMode",id:"setnavigationmode",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"setProjection",id:"setprojection",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"toggleProjection",id:"toggleprojection",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"toggleUserInput",id:"toggleuserinput",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"update",id:"update",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"updateAspect",id:"updateaspect",level:3},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-25",level:4}],c={toc:d},h="wrapper";function k(e){var t=e.components,n=(0,i.Z)(e,p);return(0,r.kt)(h,(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".OrthoPerspectiveCamera"),(0,r.kt)("p",null,"A flexible camera that uses\n",(0,r.kt)("a",{parentName:"p",href:"https://github.com/yomotsu/camera-controls"},"yomotsu's cameracontrols")," to\neasily control the camera in 2D and 3D. It supports multiple navigation\nmodes, such as 2D floor plan navigation, first person and 3D orbit."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleCamera"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"OrthoPerspectiveCamera"))))),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},(0,r.kt)("inlineCode",{parentName:"a"},"UI")))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"activecamera"},"activeCamera"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"activeCamera"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"PerspectiveCamera")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,r.kt)("p",null,"The camera that is being used now according to the current ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection"),"."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#activecamera"},"activeCamera")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleCamera/index.ts#L48"},"src/core/SimpleCamera/index.ts:48")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"controls"},"controls"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"controls"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"CameraControls")),(0,r.kt)("p",null,"The object that controls the camera. An instance of\n",(0,r.kt)("a",{parentName:"p",href:"https://github.com/yomotsu/camera-controls"},"yomotsu's cameracontrols"),".\nTransforming the camera directly will have no effect: you need to use this\nobject to move, rotate, look at objects, etc."),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#controls"},"controls")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleCamera/index.ts#L33"},"src/core/SimpleCamera/index.ts:33")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"currentmode"},"currentMode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"currentMode"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.NavigationMode"},(0,r.kt)("inlineCode",{parentName:"a"},"NavigationMode"))),(0,r.kt)("p",null,"The current ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.NavigationMode"},"NavigationMode"),"."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/OrthoPerspectiveCamera/index.ts#L24"},"src/navigation/OrthoPerspectiveCamera/index.ts:24")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleCamera")),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"Updateable.onAfterUpdate")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#onafterupdate"},"onAfterUpdate")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleCamera/index.ts#L20"},"src/core/SimpleCamera/index.ts:20")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleCamera")),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"Updateable.onBeforeUpdate")),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#onbeforeupdate"},"onBeforeUpdate")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleCamera/index.ts#L17"},"src/core/SimpleCamera/index.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#ondisposed"},"onDisposed")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleCamera/index.ts#L25"},"src/core/SimpleCamera/index.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"projectionchanged"},"projectionChanged"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"projectionChanged"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Camera"),">"),(0,r.kt)("p",null,"Event that fires when the ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection")," changes."),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/OrthoPerspectiveCamera/index.ts#L29"},"src/navigation/OrthoPerspectiveCamera/index.ts:29")),(0,r.kt)("h2",{id:"accessors"},"Accessors"),(0,r.kt)("h3",{id:"enabled"},"enabled"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"enabled"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,"SimpleCamera.enabled"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleCamera/index.ts#L36"},"src/core/SimpleCamera/index.ts:36")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"enabled"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"enabled"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"enabled")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,"SimpleCamera.enabled"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleCamera/index.ts#L41"},"src/core/SimpleCamera/index.ts:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"matchorthodistanceenabled"},"matchOrthoDistanceEnabled"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"matchOrthoDistanceEnabled"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Match Ortho zoom with Perspective distance when changing projection mode"),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/OrthoPerspectiveCamera/index.ts#L136"},"src/navigation/OrthoPerspectiveCamera/index.ts:136")),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"dispose"},"dispose"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#dispose"},"dispose")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/OrthoPerspectiveCamera/index.ts#L107"},"src/navigation/OrthoPerspectiveCamera/index.ts:107")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fit"},"fit"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fit"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"meshes?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"offset?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Make the camera view fit all the specified meshes."),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"meshes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Iterable"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Mesh"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Material"),"[], ",(0,r.kt)("inlineCode",{parentName:"td"},"Object3DEventMap"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the meshes to fit. If it is not defined, it will evaluate ",(0,r.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.Components#meshes"},"Components.meshes"),".")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"offset")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"1.5")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the distance to the fit object")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/OrthoPerspectiveCamera/index.ts#L197"},"src/navigation/OrthoPerspectiveCamera/index.ts:197")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"get"},"get"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"get"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"projection?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"PerspectiveCamera")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,r.kt)("p",null,"Similar to ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get"),", but with an optional argument\nto specify which camera to get."),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"projection?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/api/modules/openbim_components#cameraprojection"},(0,r.kt)("inlineCode",{parentName:"a"},"CameraProjection"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The camera corresponding to the ",(0,r.kt)("a",{parentName:"td",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection")," specified. If no projection is specified, the active camera will be returned.")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"PerspectiveCamera")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#get"},"get")),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/OrthoPerspectiveCamera/index.ts#L121"},"src/navigation/OrthoPerspectiveCamera/index.ts:121")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getprojection"},"getProjection"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getProjection"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},(0,r.kt)("inlineCode",{parentName:"a"},"CameraProjection"))),(0,r.kt)("p",null,"Returns the current ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection"),"."),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},(0,r.kt)("inlineCode",{parentName:"a"},"CameraProjection"))),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/OrthoPerspectiveCamera/index.ts#L131"},"src/navigation/OrthoPerspectiveCamera/index.ts:131")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hasui"},"hasUI"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,r.kt)("p",null,"Whether is component implements any kind of ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,"this is UI"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#hasui"},"hasUI")),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,"this is Configurable"),(0,r.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#isconfigurable"},"isConfigurable")),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,"this is Disposable"),(0,r.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#isdisposeable"},"isDisposeable")),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ishideable"},"isHideable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,"this is Hideable"),(0,r.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#ishideable"},"isHideable")),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,"this is Resizeable"),(0,r.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#isresizeable"},"isResizeable")),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,"this is Updateable"),(0,r.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#isupdateable"},"isUpdateable")),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setnavigationmode"},"setNavigationMode"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setNavigationMode"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"mode"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Sets a new ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.NavigationMode"},"NavigationMode")," and disables the previous one."),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"mode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/api/modules/openbim_components#navmodeid"},(0,r.kt)("inlineCode",{parentName:"a"},"NavModeID"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The ",(0,r.kt)("a",{parentName:"td",href:"/api/interfaces/openbim_components.NavigationMode"},"NavigationMode")," to set.")))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/OrthoPerspectiveCamera/index.ts#L180"},"src/navigation/OrthoPerspectiveCamera/index.ts:180")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setprojection"},"setProjection"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setProjection"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"projection"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Sets the current ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection"),". This triggers the event\n",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.OrthoPerspectiveCamera#projectionchanged"},"projectionChanged"),"."),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"projection")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/api/modules/openbim_components#cameraprojection"},(0,r.kt)("inlineCode",{parentName:"a"},"CameraProjection"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The new ",(0,r.kt)("a",{parentName:"td",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection")," to set.")))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/OrthoPerspectiveCamera/index.ts#L157"},"src/navigation/OrthoPerspectiveCamera/index.ts:157")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"toggleprojection"},"toggleProjection"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"toggleProjection"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Changes the current ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection")," from Ortographic to Perspective\nand Viceversa."),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/OrthoPerspectiveCamera/index.ts#L144"},"src/navigation/OrthoPerspectiveCamera/index.ts:144")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"toggleuserinput"},"toggleUserInput"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"toggleUserInput"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"active"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Allows or prevents all user input."),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"active")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"whether to enable or disable user inputs.")))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/OrthoPerspectiveCamera/index.ts#L167"},"src/navigation/OrthoPerspectiveCamera/index.ts:167")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"update"},"update"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"update"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"_delta"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"Updateable.update")),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"_delta")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#update"},"update")),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleCamera/index.ts#L81"},"src/core/SimpleCamera/index.ts:81")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"updateaspect"},"updateAspect"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"updateAspect"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Updates the aspect of the camera to match the size of the\n",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Components#renderer"},"Components.renderer"),"."),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#updateaspect"},"updateAspect")),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleCamera/index.ts#L93"},"src/core/SimpleCamera/index.ts:93")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/56d77841.0cc8b3b8.js b/build/assets/js/8004d10c.3082051c.js similarity index 62% rename from build/assets/js/56d77841.0cc8b3b8.js rename to build/assets/js/8004d10c.3082051c.js index 8826d70c..e4bc6ead 100644 --- a/build/assets/js/56d77841.0cc8b3b8.js +++ b/build/assets/js/8004d10c.3082051c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8034],{3769:s=>{s.exports=JSON.parse('{"name":"docusaurus-plugin-content-docs","id":"default"}')}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8892],{3769:s=>{s.exports=JSON.parse('{"name":"docusaurus-plugin-content-docs","id":"default"}')}}]); \ No newline at end of file diff --git a/build/assets/js/8d23124b.9f15e2fe.js b/build/assets/js/8d23124b.9f15e2fe.js deleted file mode 100644 index 35a5cdc7..00000000 --- a/build/assets/js/8d23124b.9f15e2fe.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5742],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>c});var i=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function l(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var o=i.createContext({}),s=function(e){var n=i.useContext(o),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},d=function(e){var n=s(e.components);return i.createElement(o.Provider,{value:n},e.children)},m="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},k=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,r=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),m=s(t),k=a,c=m["".concat(o,".").concat(k)]||m[k]||u[k]||r;return t?i.createElement(c,l(l({ref:n},d),{},{components:t})):i.createElement(c,l({ref:n},d))}));function c(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var r=t.length,l=new Array(r);l[0]=k;var p={};for(var o in n)hasOwnProperty.call(n,o)&&(p[o]=n[o]);p.originalType=e,p[m]="string"==typeof e?e:a,l[1]=p;for(var s=2;s{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>c,frontMatter:()=>p,metadata:()=>s,toc:()=>m});var i=t(7462),a=t(3366),r=(t(7294),t(3905)),l=["components"],p={id:"openbim_components.ScreenCuller",title:"Class: ScreenCuller",sidebar_label:"ScreenCuller",custom_edit_url:null},o=void 0,s={unversionedId:"api/classes/openbim_components.ScreenCuller",id:"api/classes/openbim_components.ScreenCuller",title:"Class: ScreenCuller",description:"openbim-components.ScreenCuller",source:"@site/docs/api/classes/openbim_components.ScreenCuller.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.ScreenCuller",permalink:"/api/classes/openbim_components.ScreenCuller",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.ScreenCuller",title:"Class: ScreenCuller",sidebar_label:"ScreenCuller",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"PropertiesStreamingSettings",permalink:"/api/classes/openbim_components.PropertiesStreamingSettings"},next:{title:"Simple2DScene",permalink:"/api/classes/openbim_components.Simple2DScene"}},d={},m=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Accessors",id:"accessors",level:2},{value:"enabled",id:"enabled",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"needsUpdate",id:"needsupdate",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"onViewUpdated",id:"onviewupdated",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"renderDebugFrame",id:"renderdebugframe",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"renderer",id:"renderer",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Methods",id:"methods",level:2},{value:"add",id:"add",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"updateVisibility",id:"updatevisibility",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-17",level:4}],u={toc:m},k="wrapper";function c(e){var n=e.components,t=(0,a.Z)(e,l);return(0,r.kt)(k,(0,i.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".ScreenCuller"),(0,r.kt)("p",null,"A tool to handle big scenes efficiently by automatically hiding the objects\nthat are not visible to the camera."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,r.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Map"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"THREE.InstancedMesh"),">",">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"ScreenCuller"))))),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,r.kt)("inlineCode",{parentName:"a"},"Disposable"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Configurable"},(0,r.kt)("inlineCode",{parentName:"a"},"Configurable")),"<",(0,r.kt)("inlineCode",{parentName:"li"},"CullerRendererSettings"),">")),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,r.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/ScreenCuller/index.ts#L27"},"temp/engine_components/src/core/ScreenCuller/index.ts:27")),(0,r.kt)("h2",{id:"accessors"},"Accessors"),(0,r.kt)("h3",{id:"enabled"},"enabled"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"enabled"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,"Component.enabled"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/ScreenCuller/index.ts#L30"},"temp/engine_components/src/core/ScreenCuller/index.ts:30")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"needsupdate"},"needsUpdate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"needsUpdate"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"use ScreenCuller.elements.needsUpdate instead."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/ScreenCuller/index.ts#L50"},"temp/engine_components/src/core/ScreenCuller/index.ts:50")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"needsUpdate"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"use ScreenCuller.elements.needsUpdate instead."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/ScreenCuller/index.ts#L55"},"temp/engine_components/src/core/ScreenCuller/index.ts:55")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onviewupdated"},"onViewUpdated"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"onViewUpdated"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"seen"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Set"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,r.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">",">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"unseen"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Set"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,r.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">",">"," }",">"),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"seen"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Set"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,r.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">",">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"unseen"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Set"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,r.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">",">"," }",">"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"use ScreenCuller.elements.onViewUpdated instead."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/ScreenCuller/index.ts#L45"},"temp/engine_components/src/core/ScreenCuller/index.ts:45")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"renderdebugframe"},"renderDebugFrame"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"renderDebugFrame"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"use ScreenCuller.elements.renderDebugFrame instead."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/ScreenCuller/index.ts#L60"},"temp/engine_components/src/core/ScreenCuller/index.ts:60")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"renderDebugFrame"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"use ScreenCuller.elements.renderDebugFrame instead."),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/ScreenCuller/index.ts#L65"},"temp/engine_components/src/core/ScreenCuller/index.ts:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"renderer"},"renderer"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"renderer"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"WebGLRenderer")),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"WebGLRenderer")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"use ScreenCuller.elements.get instead."),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/ScreenCuller/index.ts#L81"},"temp/engine_components/src/core/ScreenCuller/index.ts:81")),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"add"},"add"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"add"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"mesh"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"mesh")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Mesh"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Material"),"[], ",(0,r.kt)("inlineCode",{parentName:"td"},"Object3DEventMap"),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"InstancedMesh"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Material"),"[]",">")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"use ScreenCuller.elements.add instead."),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/ScreenCuller/index.ts#L125"},"temp/engine_components/src/core/ScreenCuller/index.ts:125")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"dispose"},"dispose"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/ScreenCuller/index.ts#L115"},"temp/engine_components/src/core/ScreenCuller/index.ts:115")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"get"},"get"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"get"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Map"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"InstancedMesh"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Material"),"[]",">",">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get"),"."),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Map"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"InstancedMesh"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Material"),"[]",">",">"),(0,r.kt)("p",null,"the map of internal meshes used to determine visibility."),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/ScreenCuller/index.ts#L110"},"temp/engine_components/src/core/ScreenCuller/index.ts:110")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hasui"},"hasUI"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,r.kt)("p",null,"Whether is component implements any kind of ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,"this is UI"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,"this is Configurable"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,"this is Disposable"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ishideable"},"isHideable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,"this is Hideable"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,"this is Resizeable"),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,"this is Updateable"),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"updatevisibility"},"updateVisibility"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"updateVisibility"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"force?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"force?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"use ScreenCuller.elements.updateVisibility instead."),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/ScreenCuller/index.ts#L132"},"temp/engine_components/src/core/ScreenCuller/index.ts:132")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/8d23124b.ca42a667.js b/build/assets/js/8d23124b.ca42a667.js new file mode 100644 index 00000000..24816322 --- /dev/null +++ b/build/assets/js/8d23124b.ca42a667.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5742],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>c});var a=t(7294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,a)}return t}function l(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var o=a.createContext({}),s=function(e){var n=a.useContext(o),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},d=function(e){var n=s(e.components);return a.createElement(o.Provider,{value:n},e.children)},m="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},k=a.forwardRef((function(e,n){var t=e.components,i=e.mdxType,r=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),m=s(t),k=i,c=m["".concat(o,".").concat(k)]||m[k]||u[k]||r;return t?a.createElement(c,l(l({ref:n},d),{},{components:t})):a.createElement(c,l({ref:n},d))}));function c(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var r=t.length,l=new Array(r);l[0]=k;var p={};for(var o in n)hasOwnProperty.call(n,o)&&(p[o]=n[o]);p.originalType=e,p[m]="string"==typeof e?e:i,l[1]=p;for(var s=2;s{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>c,frontMatter:()=>p,metadata:()=>s,toc:()=>m});var a=t(7462),i=t(3366),r=(t(7294),t(3905)),l=["components"],p={id:"openbim_components.ScreenCuller",title:"Class: ScreenCuller",sidebar_label:"ScreenCuller",custom_edit_url:null},o=void 0,s={unversionedId:"api/classes/openbim_components.ScreenCuller",id:"api/classes/openbim_components.ScreenCuller",title:"Class: ScreenCuller",description:"openbim-components.ScreenCuller",source:"@site/docs/api/classes/openbim_components.ScreenCuller.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.ScreenCuller",permalink:"/api/classes/openbim_components.ScreenCuller",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.ScreenCuller",title:"Class: ScreenCuller",sidebar_label:"ScreenCuller",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"PropertiesStreamingSettings",permalink:"/api/classes/openbim_components.PropertiesStreamingSettings"},next:{title:"Simple2DScene",permalink:"/api/classes/openbim_components.Simple2DScene"}},d={},m=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Accessors",id:"accessors",level:2},{value:"enabled",id:"enabled",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"needsUpdate",id:"needsupdate",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"onViewUpdated",id:"onviewupdated",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"renderDebugFrame",id:"renderdebugframe",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"renderer",id:"renderer",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Methods",id:"methods",level:2},{value:"add",id:"add",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"updateVisibility",id:"updatevisibility",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-17",level:4}],u={toc:m},k="wrapper";function c(e){var n=e.components,t=(0,i.Z)(e,l);return(0,r.kt)(k,(0,a.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".ScreenCuller"),(0,r.kt)("p",null,"A tool to handle big scenes efficiently by automatically hiding the objects\nthat are not visible to the camera."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,r.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Map"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"THREE.InstancedMesh"),">",">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"ScreenCuller"))))),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,r.kt)("inlineCode",{parentName:"a"},"Disposable"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Configurable"},(0,r.kt)("inlineCode",{parentName:"a"},"Configurable")),"<",(0,r.kt)("inlineCode",{parentName:"li"},"CullerRendererSettings"),">")),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,r.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/ScreenCuller/index.ts#L27"},"src/core/ScreenCuller/index.ts:27")),(0,r.kt)("h2",{id:"accessors"},"Accessors"),(0,r.kt)("h3",{id:"enabled"},"enabled"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"enabled"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,"Component.enabled"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/ScreenCuller/index.ts#L30"},"src/core/ScreenCuller/index.ts:30")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"needsupdate"},"needsUpdate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"needsUpdate"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"use ScreenCuller.elements.needsUpdate instead."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/ScreenCuller/index.ts#L50"},"src/core/ScreenCuller/index.ts:50")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"needsUpdate"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"use ScreenCuller.elements.needsUpdate instead."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/ScreenCuller/index.ts#L55"},"src/core/ScreenCuller/index.ts:55")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onviewupdated"},"onViewUpdated"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"onViewUpdated"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"seen"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Set"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,r.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">",">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"unseen"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Set"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,r.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">",">"," }",">"),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"seen"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Set"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,r.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">",">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"unseen"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Set"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,r.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">",">"," }",">"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"use ScreenCuller.elements.onViewUpdated instead."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/ScreenCuller/index.ts#L45"},"src/core/ScreenCuller/index.ts:45")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"renderdebugframe"},"renderDebugFrame"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"renderDebugFrame"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"use ScreenCuller.elements.renderDebugFrame instead."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/ScreenCuller/index.ts#L60"},"src/core/ScreenCuller/index.ts:60")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"renderDebugFrame"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"use ScreenCuller.elements.renderDebugFrame instead."),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/ScreenCuller/index.ts#L65"},"src/core/ScreenCuller/index.ts:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"renderer"},"renderer"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"renderer"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"WebGLRenderer")),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"WebGLRenderer")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"use ScreenCuller.elements.get instead."),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/ScreenCuller/index.ts#L81"},"src/core/ScreenCuller/index.ts:81")),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"add"},"add"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"add"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"mesh"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"mesh")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Mesh"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Material"),"[], ",(0,r.kt)("inlineCode",{parentName:"td"},"Object3DEventMap"),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"InstancedMesh"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Material"),"[]",">")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"use ScreenCuller.elements.add instead."),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/ScreenCuller/index.ts#L125"},"src/core/ScreenCuller/index.ts:125")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"dispose"},"dispose"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/ScreenCuller/index.ts#L115"},"src/core/ScreenCuller/index.ts:115")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"get"},"get"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"get"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Map"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"InstancedMesh"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Material"),"[]",">",">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get"),"."),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Map"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"InstancedMesh"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Material"),"[]",">",">"),(0,r.kt)("p",null,"the map of internal meshes used to determine visibility."),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/ScreenCuller/index.ts#L110"},"src/core/ScreenCuller/index.ts:110")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hasui"},"hasUI"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,r.kt)("p",null,"Whether is component implements any kind of ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,"this is UI"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,"this is Configurable"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,"this is Disposable"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ishideable"},"isHideable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,"this is Hideable"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,"this is Resizeable"),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,"this is Updateable"),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"updatevisibility"},"updateVisibility"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"updateVisibility"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"force?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"force?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"use ScreenCuller.elements.updateVisibility instead."),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/ScreenCuller/index.ts#L132"},"src/core/ScreenCuller/index.ts:132")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/935f2afb.89f3f606.js b/build/assets/js/935f2afb.89f3f606.js new file mode 100644 index 00000000..c79a3211 --- /dev/null +++ b/build/assets/js/935f2afb.89f3f606.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Introduction","href":"/intro","docId":"intro"},{"type":"category","label":"Components","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Getting started","href":"/components/getting-started","docId":"components/getting-started"},{"type":"link","label":"Creating new components","href":"/components/creating-components","docId":"components/creating-components"},{"type":"link","label":"Clean components ABC","href":"/components/clean-components-guide","docId":"components/clean-components-guide"},{"type":"link","label":"Tutorial paths","href":"/components/tutorial-paths","docId":"components/tutorial-paths"},{"type":"link","label":"Get involved","href":"/components/contributing","docId":"components/contributing"}]},{"type":"category","label":"That open platform","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Getting started","href":"/that-open-platform/getting-started","docId":"that-open-platform/getting-started"}]},{"type":"category","label":"API","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Exports","href":"/api/modules","docId":"api/modules"},{"type":"category","label":"Modules","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"bim-fragment","href":"/api/modules/bim_fragment","docId":"api/modules/bim_fragment"},{"type":"link","label":"openbim-components","href":"/api/modules/openbim_components","docId":"api/modules/openbim_components"}]},{"type":"category","label":"Classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"BaseRenderer","href":"/api/classes/openbim_components.BaseRenderer","docId":"api/classes/openbim_components.BaseRenderer"},{"type":"link","label":"CloudStorage","href":"/api/classes/openbim_components.CloudStorage","docId":"api/classes/openbim_components.CloudStorage"},{"type":"link","label":"Component","href":"/api/classes/openbim_components.Component","docId":"api/classes/openbim_components.Component"},{"type":"link","label":"Components","href":"/api/classes/openbim_components.Components","docId":"api/classes/openbim_components.Components"},{"type":"link","label":"CubeMap","href":"/api/classes/openbim_components.CubeMap","docId":"api/classes/openbim_components.CubeMap"},{"type":"link","label":"Disposer","href":"/api/classes/openbim_components.Disposer","docId":"api/classes/openbim_components.Disposer"},{"type":"link","label":"EdgesClipper","href":"/api/classes/openbim_components.EdgesClipper","docId":"api/classes/openbim_components.EdgesClipper"},{"type":"link","label":"EdgesPlane","href":"/api/classes/openbim_components.EdgesPlane","docId":"api/classes/openbim_components.EdgesPlane"},{"type":"link","label":"Event","href":"/api/classes/openbim_components.Event","docId":"api/classes/openbim_components.Event"},{"type":"link","label":"FragmentBoundingBox","href":"/api/classes/openbim_components.FragmentBoundingBox","docId":"api/classes/openbim_components.FragmentBoundingBox"},{"type":"link","label":"FragmentManager","href":"/api/classes/openbim_components.FragmentManager","docId":"api/classes/openbim_components.FragmentManager"},{"type":"link","label":"FragmentPlans","href":"/api/classes/openbim_components.FragmentPlans","docId":"api/classes/openbim_components.FragmentPlans"},{"type":"link","label":"IfcJsonExporter","href":"/api/classes/openbim_components.IfcJsonExporter","docId":"api/classes/openbim_components.IfcJsonExporter"},{"type":"link","label":"IfcStreamingSettings","href":"/api/classes/openbim_components.IfcStreamingSettings","docId":"api/classes/openbim_components.IfcStreamingSettings"},{"type":"link","label":"LengthMeasurement","href":"/api/classes/openbim_components.LengthMeasurement","docId":"api/classes/openbim_components.LengthMeasurement"},{"type":"link","label":"MaterialManager","href":"/api/classes/openbim_components.MaterialManager","docId":"api/classes/openbim_components.MaterialManager"},{"type":"link","label":"Mouse","href":"/api/classes/openbim_components.Mouse","docId":"api/classes/openbim_components.Mouse"},{"type":"link","label":"OrthoPerspectiveCamera","href":"/api/classes/openbim_components.OrthoPerspectiveCamera","docId":"api/classes/openbim_components.OrthoPerspectiveCamera"},{"type":"link","label":"PostproductionRenderer","href":"/api/classes/openbim_components.PostproductionRenderer","docId":"api/classes/openbim_components.PostproductionRenderer"},{"type":"link","label":"PropertiesStreamingSettings","href":"/api/classes/openbim_components.PropertiesStreamingSettings","docId":"api/classes/openbim_components.PropertiesStreamingSettings"},{"type":"link","label":"ScreenCuller","href":"/api/classes/openbim_components.ScreenCuller","docId":"api/classes/openbim_components.ScreenCuller"},{"type":"link","label":"Simple2DScene","href":"/api/classes/openbim_components.Simple2DScene","docId":"api/classes/openbim_components.Simple2DScene"},{"type":"link","label":"SimpleCamera","href":"/api/classes/openbim_components.SimpleCamera","docId":"api/classes/openbim_components.SimpleCamera"},{"type":"link","label":"SimpleClipper","href":"/api/classes/openbim_components.SimpleClipper","docId":"api/classes/openbim_components.SimpleClipper"},{"type":"link","label":"SimpleGrid","href":"/api/classes/openbim_components.SimpleGrid","docId":"api/classes/openbim_components.SimpleGrid"},{"type":"link","label":"SimplePlane","href":"/api/classes/openbim_components.SimplePlane","docId":"api/classes/openbim_components.SimplePlane"},{"type":"link","label":"SimpleRaycaster","href":"/api/classes/openbim_components.SimpleRaycaster","docId":"api/classes/openbim_components.SimpleRaycaster"},{"type":"link","label":"SimpleRenderer","href":"/api/classes/openbim_components.SimpleRenderer","docId":"api/classes/openbim_components.SimpleRenderer"},{"type":"link","label":"SimpleScene","href":"/api/classes/openbim_components.SimpleScene","docId":"api/classes/openbim_components.SimpleScene"},{"type":"link","label":"ToolComponent","href":"/api/classes/openbim_components.ToolComponent","docId":"api/classes/openbim_components.ToolComponent"},{"type":"link","label":"UIElement","href":"/api/classes/openbim_components.UIElement","docId":"api/classes/openbim_components.UIElement"},{"type":"link","label":"UIManager","href":"/api/classes/openbim_components.UIManager","docId":"api/classes/openbim_components.UIManager"}]},{"type":"category","label":"Interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Configurable","href":"/api/interfaces/openbim_components.Configurable","docId":"api/interfaces/openbim_components.Configurable"},{"type":"link","label":"Createable","href":"/api/interfaces/openbim_components.Createable","docId":"api/interfaces/openbim_components.Createable"},{"type":"link","label":"Disposable","href":"/api/interfaces/openbim_components.Disposable","docId":"api/interfaces/openbim_components.Disposable"},{"type":"link","label":"FragmentIdMap","href":"/api/interfaces/openbim_components.FragmentIdMap","docId":"api/interfaces/openbim_components.FragmentIdMap"},{"type":"link","label":"Hideable","href":"/api/interfaces/openbim_components.Hideable","docId":"api/interfaces/openbim_components.Hideable"},{"type":"link","label":"NavigationMode","href":"/api/interfaces/openbim_components.NavigationMode","docId":"api/interfaces/openbim_components.NavigationMode"},{"type":"link","label":"Progress","href":"/api/interfaces/openbim_components.Progress","docId":"api/interfaces/openbim_components.Progress"},{"type":"link","label":"Resizeable","href":"/api/interfaces/openbim_components.Resizeable","docId":"api/interfaces/openbim_components.Resizeable"},{"type":"link","label":"UI","href":"/api/interfaces/openbim_components.UI","docId":"api/interfaces/openbim_components.UI"},{"type":"link","label":"Updateable","href":"/api/interfaces/openbim_components.Updateable","docId":"api/interfaces/openbim_components.Updateable"}]}],"href":"/api/"},{"type":"category","label":"Tutorials","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AngleMeasurement","href":"/Tutorials/AngleMeasurement","docId":"Tutorials/AngleMeasurement"},{"type":"link","label":"AreaMeasurement","href":"/Tutorials/AreaMeasurement","docId":"Tutorials/AreaMeasurement"},{"type":"link","label":"EdgesClipper","href":"/Tutorials/EdgesClipper","docId":"Tutorials/EdgesClipper"},{"type":"link","label":"FragmentBoundingBox","href":"/Tutorials/FragmentBoundingBox","docId":"Tutorials/FragmentBoundingBox"},{"type":"link","label":"FragmentClipStyler","href":"/Tutorials/FragmentClipStyler","docId":"Tutorials/FragmentClipStyler"},{"type":"link","label":"FragmentExploder","href":"/Tutorials/FragmentExploder","docId":"Tutorials/FragmentExploder"},{"type":"link","label":"FragmentHider","href":"/Tutorials/FragmentHider","docId":"Tutorials/FragmentHider"},{"type":"link","label":"FragmentHighlighter","href":"/Tutorials/FragmentHighlighter","docId":"Tutorials/FragmentHighlighter"},{"type":"link","label":"FragmentIfcLoader","href":"/Tutorials/FragmentIfcLoader","docId":"Tutorials/FragmentIfcLoader"},{"type":"link","label":"FragmentIfcStreamer","href":"/Tutorials/FragmentIfcStreamer","docId":"Tutorials/FragmentIfcStreamer"},{"type":"link","label":"FragmentManager","href":"/Tutorials/FragmentManager","docId":"Tutorials/FragmentManager"},{"type":"link","label":"FragmentPlans","href":"/Tutorials/FragmentPlans","docId":"Tutorials/FragmentPlans"},{"type":"link","label":"FragmentTree","href":"/Tutorials/FragmentTree","docId":"Tutorials/FragmentTree"},{"type":"link","label":"IfcPropertiesFinder","href":"/Tutorials/IfcPropertiesFinder","docId":"Tutorials/IfcPropertiesFinder"},{"type":"link","label":"IfcPropertiesManager","href":"/Tutorials/IfcPropertiesManager","docId":"Tutorials/IfcPropertiesManager"},{"type":"link","label":"IfcPropertiesProcessor","href":"/Tutorials/IfcPropertiesProcessor","docId":"Tutorials/IfcPropertiesProcessor"},{"type":"link","label":"LengthMeasurement","href":"/Tutorials/LengthMeasurement","docId":"Tutorials/LengthMeasurement"},{"type":"link","label":"MaterialManager","href":"/Tutorials/MaterialManager","docId":"Tutorials/MaterialManager"},{"type":"link","label":"MiniMap","href":"/Tutorials/MiniMap","docId":"Tutorials/MiniMap"},{"type":"link","label":"OrthoPerspectiveCamera","href":"/Tutorials/OrthoPerspectiveCamera","docId":"Tutorials/OrthoPerspectiveCamera"},{"type":"link","label":"PostproductionRenderer","href":"/Tutorials/PostproductionRenderer","docId":"Tutorials/PostproductionRenderer"},{"type":"link","label":"ScreenCuller","href":"/Tutorials/ScreenCuller","docId":"Tutorials/ScreenCuller"},{"type":"link","label":"ShadowDropper","href":"/Tutorials/ShadowDropper","docId":"Tutorials/ShadowDropper"},{"type":"link","label":"Simple2DScene","href":"/Tutorials/Simple2DScene","docId":"Tutorials/Simple2DScene"},{"type":"link","label":"SimpleClipper","href":"/Tutorials/SimpleClipper","docId":"Tutorials/SimpleClipper"},{"type":"link","label":"SimpleRaycaster","href":"/Tutorials/SimpleRaycaster","docId":"Tutorials/SimpleRaycaster"},{"type":"link","label":"SimpleScene","href":"/Tutorials/SimpleScene","docId":"Tutorials/SimpleScene"},{"type":"link","label":"ToolsComponent","href":"/Tutorials/ToolsComponent","docId":"Tutorials/ToolsComponent"},{"type":"link","label":"UIManager","href":"/Tutorials/UIManager","docId":"Tutorials/UIManager"}]}]},"docs":{"api/classes/openbim_components.BaseRenderer":{"id":"api/classes/openbim_components.BaseRenderer","title":"Class: BaseRenderer","description":"openbim-components.BaseRenderer","sidebar":"tutorialSidebar"},"api/classes/openbim_components.CloudStorage":{"id":"api/classes/openbim_components.CloudStorage","title":"Class: CloudStorage","description":"openbim-components.CloudStorage","sidebar":"tutorialSidebar"},"api/classes/openbim_components.Component":{"id":"api/classes/openbim_components.Component","title":"Class: Component","description":"openbim-components.Component","sidebar":"tutorialSidebar"},"api/classes/openbim_components.Components":{"id":"api/classes/openbim_components.Components","title":"Class: Components","description":"openbim-components.Components","sidebar":"tutorialSidebar"},"api/classes/openbim_components.CubeMap":{"id":"api/classes/openbim_components.CubeMap","title":"Class: CubeMap","description":"openbim-components.CubeMap","sidebar":"tutorialSidebar"},"api/classes/openbim_components.Disposer":{"id":"api/classes/openbim_components.Disposer","title":"Class: Disposer","description":"openbim-components.Disposer","sidebar":"tutorialSidebar"},"api/classes/openbim_components.EdgesClipper":{"id":"api/classes/openbim_components.EdgesClipper","title":"Class: EdgesClipper","description":"openbim-components.EdgesClipper","sidebar":"tutorialSidebar"},"api/classes/openbim_components.EdgesPlane":{"id":"api/classes/openbim_components.EdgesPlane","title":"Class: EdgesPlane","description":"openbim-components.EdgesPlane","sidebar":"tutorialSidebar"},"api/classes/openbim_components.Event":{"id":"api/classes/openbim_components.Event","title":"Class: Event","description":"openbim-components.Event","sidebar":"tutorialSidebar"},"api/classes/openbim_components.FragmentBoundingBox":{"id":"api/classes/openbim_components.FragmentBoundingBox","title":"Class: FragmentBoundingBox","description":"openbim-components.FragmentBoundingBox","sidebar":"tutorialSidebar"},"api/classes/openbim_components.FragmentManager":{"id":"api/classes/openbim_components.FragmentManager","title":"Class: FragmentManager","description":"openbim-components.FragmentManager","sidebar":"tutorialSidebar"},"api/classes/openbim_components.FragmentPlans":{"id":"api/classes/openbim_components.FragmentPlans","title":"Class: FragmentPlans","description":"openbim-components.FragmentPlans","sidebar":"tutorialSidebar"},"api/classes/openbim_components.IfcJsonExporter":{"id":"api/classes/openbim_components.IfcJsonExporter","title":"Class: IfcJsonExporter","description":"openbim-components.IfcJsonExporter","sidebar":"tutorialSidebar"},"api/classes/openbim_components.IfcStreamingSettings":{"id":"api/classes/openbim_components.IfcStreamingSettings","title":"Class: IfcStreamingSettings","description":"openbim-components.IfcStreamingSettings","sidebar":"tutorialSidebar"},"api/classes/openbim_components.LengthMeasurement":{"id":"api/classes/openbim_components.LengthMeasurement","title":"Class: LengthMeasurement","description":"openbim-components.LengthMeasurement","sidebar":"tutorialSidebar"},"api/classes/openbim_components.MaterialManager":{"id":"api/classes/openbim_components.MaterialManager","title":"Class: MaterialManager","description":"openbim-components.MaterialManager","sidebar":"tutorialSidebar"},"api/classes/openbim_components.Mouse":{"id":"api/classes/openbim_components.Mouse","title":"Class: Mouse","description":"openbim-components.Mouse","sidebar":"tutorialSidebar"},"api/classes/openbim_components.OrthoPerspectiveCamera":{"id":"api/classes/openbim_components.OrthoPerspectiveCamera","title":"Class: OrthoPerspectiveCamera","description":"openbim-components.OrthoPerspectiveCamera","sidebar":"tutorialSidebar"},"api/classes/openbim_components.PostproductionRenderer":{"id":"api/classes/openbim_components.PostproductionRenderer","title":"Class: PostproductionRenderer","description":"openbim-components.PostproductionRenderer","sidebar":"tutorialSidebar"},"api/classes/openbim_components.PropertiesStreamingSettings":{"id":"api/classes/openbim_components.PropertiesStreamingSettings","title":"Class: PropertiesStreamingSettings","description":"openbim-components.PropertiesStreamingSettings","sidebar":"tutorialSidebar"},"api/classes/openbim_components.ScreenCuller":{"id":"api/classes/openbim_components.ScreenCuller","title":"Class: ScreenCuller","description":"openbim-components.ScreenCuller","sidebar":"tutorialSidebar"},"api/classes/openbim_components.Simple2DScene":{"id":"api/classes/openbim_components.Simple2DScene","title":"Class: Simple2DScene","description":"openbim-components.Simple2DScene","sidebar":"tutorialSidebar"},"api/classes/openbim_components.SimpleCamera":{"id":"api/classes/openbim_components.SimpleCamera","title":"Class: SimpleCamera","description":"openbim-components.SimpleCamera","sidebar":"tutorialSidebar"},"api/classes/openbim_components.SimpleClipper":{"id":"api/classes/openbim_components.SimpleClipper","title":"Class: SimpleClipper","description":"openbim-components.SimpleClipper","sidebar":"tutorialSidebar"},"api/classes/openbim_components.SimpleGrid":{"id":"api/classes/openbim_components.SimpleGrid","title":"Class: SimpleGrid","description":"openbim-components.SimpleGrid","sidebar":"tutorialSidebar"},"api/classes/openbim_components.SimplePlane":{"id":"api/classes/openbim_components.SimplePlane","title":"Class: SimplePlane","description":"openbim-components.SimplePlane","sidebar":"tutorialSidebar"},"api/classes/openbim_components.SimpleRaycaster":{"id":"api/classes/openbim_components.SimpleRaycaster","title":"Class: SimpleRaycaster","description":"openbim-components.SimpleRaycaster","sidebar":"tutorialSidebar"},"api/classes/openbim_components.SimpleRenderer":{"id":"api/classes/openbim_components.SimpleRenderer","title":"Class: SimpleRenderer","description":"openbim-components.SimpleRenderer","sidebar":"tutorialSidebar"},"api/classes/openbim_components.SimpleScene":{"id":"api/classes/openbim_components.SimpleScene","title":"Class: SimpleScene","description":"openbim-components.SimpleScene","sidebar":"tutorialSidebar"},"api/classes/openbim_components.ToolComponent":{"id":"api/classes/openbim_components.ToolComponent","title":"Class: ToolComponent","description":"openbim-components.ToolComponent","sidebar":"tutorialSidebar"},"api/classes/openbim_components.UIElement":{"id":"api/classes/openbim_components.UIElement","title":"Class: UIElement","description":"openbim-components.UIElement","sidebar":"tutorialSidebar"},"api/classes/openbim_components.UIManager":{"id":"api/classes/openbim_components.UIManager","title":"Class: UIManager","description":"openbim-components.UIManager","sidebar":"tutorialSidebar"},"api/index":{"id":"api/index","title":"Open BIM Docs","description":"TOC","sidebar":"tutorialSidebar"},"api/interfaces/openbim_components.Configurable":{"id":"api/interfaces/openbim_components.Configurable","title":"Interface: Configurable","description":"openbim-components.Configurable","sidebar":"tutorialSidebar"},"api/interfaces/openbim_components.Createable":{"id":"api/interfaces/openbim_components.Createable","title":"Interface: Createable","description":"openbim-components.Createable","sidebar":"tutorialSidebar"},"api/interfaces/openbim_components.Disposable":{"id":"api/interfaces/openbim_components.Disposable","title":"Interface: Disposable","description":"openbim-components.Disposable","sidebar":"tutorialSidebar"},"api/interfaces/openbim_components.FragmentIdMap":{"id":"api/interfaces/openbim_components.FragmentIdMap","title":"Interface: FragmentIdMap","description":"openbim-components.FragmentIdMap","sidebar":"tutorialSidebar"},"api/interfaces/openbim_components.Hideable":{"id":"api/interfaces/openbim_components.Hideable","title":"Interface: Hideable","description":"openbim-components.Hideable","sidebar":"tutorialSidebar"},"api/interfaces/openbim_components.NavigationMode":{"id":"api/interfaces/openbim_components.NavigationMode","title":"Interface: NavigationMode","description":"openbim-components.NavigationMode","sidebar":"tutorialSidebar"},"api/interfaces/openbim_components.Progress":{"id":"api/interfaces/openbim_components.Progress","title":"Interface: Progress","description":"openbim-components.Progress","sidebar":"tutorialSidebar"},"api/interfaces/openbim_components.Resizeable":{"id":"api/interfaces/openbim_components.Resizeable","title":"Interface: Resizeable","description":"openbim-components.Resizeable","sidebar":"tutorialSidebar"},"api/interfaces/openbim_components.UI":{"id":"api/interfaces/openbim_components.UI","title":"Interface: UI","description":"openbim-components.UI","sidebar":"tutorialSidebar"},"api/interfaces/openbim_components.Updateable":{"id":"api/interfaces/openbim_components.Updateable","title":"Interface: Updateable","description":"openbim-components.Updateable","sidebar":"tutorialSidebar"},"api/modules":{"id":"api/modules","title":"Open BIM Docs","description":"","sidebar":"tutorialSidebar"},"api/modules/bim_fragment":{"id":"api/modules/bim_fragment","title":"Module: bim-fragment","description":"","sidebar":"tutorialSidebar"},"api/modules/openbim_components":{"id":"api/modules/openbim_components","title":"Module: openbim-components","description":"Classes","sidebar":"tutorialSidebar"},"components/clean-components-guide":{"id":"components/clean-components-guide","title":"Clean components ABC","description":"Basics","sidebar":"tutorialSidebar"},"components/contributing":{"id":"components/contributing","title":"Get involved","description":"Want to help us make this project even more amazing? Great! Contributing is easy, and on this page you\'ll find a quick guide on how to do it.","sidebar":"tutorialSidebar"},"components/creating-components":{"id":"components/creating-components","title":"Creating new components","description":"Components","sidebar":"tutorialSidebar"},"components/getting-started":{"id":"components/getting-started","title":"Getting started","description":"Component ABC","sidebar":"tutorialSidebar"},"components/tutorial-paths":{"id":"components/tutorial-paths","title":"Tutorial paths","description":"As you can see, we have tons of tutorials in this documentations, and we will keep adding more as new features come out. If you\'re not looking for anything specific, it can be a little difficult to know where to start. For that reason, here are some interesting itineraries to take your first steps in the library!","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Introduction","description":"Welcome to That Open Docs! Have you ever wanted to create your own BIM software, but don\'t know","sidebar":"tutorialSidebar"},"that-open-platform/getting-started":{"id":"that-open-platform/getting-started","title":"Getting started","description":"That Open Platform is a cloud app where we bring the features of our libraries to the next level! One of the things you will find in the platform is a free IFC viewer and editor that you can extend with your own custom tools. How cool is that? Let\'s see how to do that: \ud83d\udc47","sidebar":"tutorialSidebar"},"Tutorials/AngleMeasurement":{"id":"Tutorials/AngleMeasurement","title":"AngleMeasurement","description":"\ud83d\udccf Dimensions Tool","sidebar":"tutorialSidebar"},"Tutorials/AreaMeasurement":{"id":"Tutorials/AreaMeasurement","title":"AreaMeasurement","description":"\ud83d\udccf Dimensions Tool","sidebar":"tutorialSidebar"},"Tutorials/EdgesClipper":{"id":"Tutorials/EdgesClipper","title":"EdgesClipper","description":"\u2b55\ufe0f Aesthetic Clipping Edges","sidebar":"tutorialSidebar"},"Tutorials/FragmentBoundingBox":{"id":"Tutorials/FragmentBoundingBox","title":"FragmentBoundingBox","description":"\ud83e\uddf3 Gathering BIM Data","sidebar":"tutorialSidebar"},"Tutorials/FragmentClipStyler":{"id":"Tutorials/FragmentClipStyler","title":"FragmentClipStyler","description":"\ud83d\udc84 Styling those fills and edges","sidebar":"tutorialSidebar"},"Tutorials/FragmentExploder":{"id":"Tutorials/FragmentExploder","title":"FragmentExploder","description":"\ud83d\udca3 Breaking down Model Dynamically","sidebar":"tutorialSidebar"},"Tutorials/FragmentHider":{"id":"Tutorials/FragmentHider","title":"FragmentHider","description":"\ud83d\udd0e Custom filters for your BIM models","sidebar":"tutorialSidebar"},"Tutorials/FragmentHighlighter":{"id":"Tutorials/FragmentHighlighter","title":"FragmentHighlighter","description":"\ud83e\udd0f Nudging Fragments","sidebar":"tutorialSidebar"},"Tutorials/FragmentIfcLoader":{"id":"Tutorials/FragmentIfcLoader","title":"FragmentIfcLoader","description":"\ud83c\udfe0\ud83d\udc49\ud83e\udd16 From IFC to fragment in 1 minute","sidebar":"tutorialSidebar"},"Tutorials/FragmentIfcStreamer":{"id":"Tutorials/FragmentIfcStreamer","title":"FragmentIfcStreamer","description":"\ud83d\udcaa Let\'s go BIG","sidebar":"tutorialSidebar"},"Tutorials/FragmentManager":{"id":"Tutorials/FragmentManager","title":"FragmentManager","description":"\ud83e\uddf6 Managing Fragment Efficiently","sidebar":"tutorialSidebar"},"Tutorials/FragmentPlans":{"id":"Tutorials/FragmentPlans","title":"FragmentPlans","description":"\ud83d\udcc3\ud83d\udcdc\ud83d\udcc4 Navigating our 3D world in 2D","sidebar":"tutorialSidebar"},"Tutorials/FragmentTree":{"id":"Tutorials/FragmentTree","title":"FragmentTree","description":"\ud83c\udf32 Gathering Structured Insights","sidebar":"tutorialSidebar"},"Tutorials/IfcPropertiesFinder":{"id":"Tutorials/IfcPropertiesFinder","title":"IfcPropertiesFinder","description":"\ud83d\udd0e Find just what you need","sidebar":"tutorialSidebar"},"Tutorials/IfcPropertiesManager":{"id":"Tutorials/IfcPropertiesManager","title":"IfcPropertiesManager","description":"\u270d Edit properties at will!","sidebar":"tutorialSidebar"},"Tutorials/IfcPropertiesProcessor":{"id":"Tutorials/IfcPropertiesProcessor","title":"IfcPropertiesProcessor","description":"\ud83e\uddf6 View all IFC properties FAST","sidebar":"tutorialSidebar"},"Tutorials/LengthMeasurement":{"id":"Tutorials/LengthMeasurement","title":"LengthMeasurement","description":"\ud83d\udccf Dimensions Tool","sidebar":"tutorialSidebar"},"Tutorials/MaterialManager":{"id":"Tutorials/MaterialManager","title":"MaterialManager","description":"\ud83d\udc68\u200d\ud83c\udfa8 Seamless Material Control","sidebar":"tutorialSidebar"},"Tutorials/MiniMap":{"id":"Tutorials/MiniMap","title":"MiniMap","description":"\ud83c\udfc2 Navigate through BIM like Pro!","sidebar":"tutorialSidebar"},"Tutorials/OrthoPerspectiveCamera":{"id":"Tutorials/OrthoPerspectiveCamera","title":"OrthoPerspectiveCamera","description":"\ud83d\udcfd\ufe0f Managing Multiple Views","sidebar":"tutorialSidebar"},"Tutorials/PostproductionRenderer":{"id":"Tutorials/PostproductionRenderer","title":"PostproductionRenderer","description":"\ud83e\uddea Cool Post-Production Effects","sidebar":"tutorialSidebar"},"Tutorials/ScreenCuller":{"id":"Tutorials/ScreenCuller","title":"ScreenCuller","description":"\ud83d\ude85 Managing Performance","sidebar":"tutorialSidebar"},"Tutorials/ShadowDropper":{"id":"Tutorials/ShadowDropper","title":"ShadowDropper","description":"\ud83c\udf12 Adding Realism","sidebar":"tutorialSidebar"},"Tutorials/Simple2DScene":{"id":"Tutorials/Simple2DScene","title":"Simple2DScene","description":"\ud83c\udfa8 Draw in 2D on top of 3D!","sidebar":"tutorialSidebar"},"Tutorials/SimpleClipper":{"id":"Tutorials/SimpleClipper","title":"SimpleClipper","description":"\u2702\ufe0f Clipping Tool","sidebar":"tutorialSidebar"},"Tutorials/SimpleRaycaster":{"id":"Tutorials/SimpleRaycaster","title":"SimpleRaycaster","description":"\ud83e\udd0f Touching things","sidebar":"tutorialSidebar"},"Tutorials/SimpleScene":{"id":"Tutorials/SimpleScene","title":"SimpleScene","description":"\ud83c\udf0d Let\'s create a 3D world!","sidebar":"tutorialSidebar"},"Tutorials/ToolsComponent":{"id":"Tutorials/ToolsComponent","title":"ToolsComponent","description":"\ud83c\udf71 Keeping things tidy","sidebar":"tutorialSidebar"},"Tutorials/UIManager":{"id":"Tutorials/UIManager","title":"UIManager","description":"\ud83c\udf9b\ufe0f Making your user interactive","sidebar":"tutorialSidebar"}}}')}}]); \ No newline at end of file diff --git a/build/assets/js/935f2afb.f07a4bd4.js b/build/assets/js/935f2afb.f07a4bd4.js deleted file mode 100644 index b66eeb9a..00000000 --- a/build/assets/js/935f2afb.f07a4bd4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Introduction","href":"/intro","docId":"intro"},{"type":"category","label":"Components","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Getting started","href":"/components/getting-started","docId":"components/getting-started"},{"type":"link","label":"Creating new components","href":"/components/creating-components","docId":"components/creating-components"},{"type":"link","label":"Clean components ABC","href":"/components/clean-components-guide","docId":"components/clean-components-guide"},{"type":"link","label":"Tutorial paths","href":"/components/tutorial-paths","docId":"components/tutorial-paths"},{"type":"link","label":"Get involved","href":"/components/contributing","docId":"components/contributing"}]},{"type":"category","label":"That open platform","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Getting started","href":"/that-open-platform/getting-started","docId":"that-open-platform/getting-started"}]},{"type":"category","label":"API","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Exports","href":"/api/modules","docId":"api/modules"},{"type":"category","label":"Modules","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"bim-fragment","href":"/api/modules/bim_fragment","docId":"api/modules/bim_fragment"},{"type":"link","label":"openbim-components","href":"/api/modules/openbim_components","docId":"api/modules/openbim_components"}]},{"type":"category","label":"Classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Serializer","href":"/api/classes/bim_fragment.Serializer","docId":"api/classes/bim_fragment.Serializer"},{"type":"link","label":"BaseRenderer","href":"/api/classes/openbim_components.BaseRenderer","docId":"api/classes/openbim_components.BaseRenderer"},{"type":"link","label":"CloudStorage","href":"/api/classes/openbim_components.CloudStorage","docId":"api/classes/openbim_components.CloudStorage"},{"type":"link","label":"Component","href":"/api/classes/openbim_components.Component","docId":"api/classes/openbim_components.Component"},{"type":"link","label":"Components","href":"/api/classes/openbim_components.Components","docId":"api/classes/openbim_components.Components"},{"type":"link","label":"CubeMap","href":"/api/classes/openbim_components.CubeMap","docId":"api/classes/openbim_components.CubeMap"},{"type":"link","label":"Disposer","href":"/api/classes/openbim_components.Disposer","docId":"api/classes/openbim_components.Disposer"},{"type":"link","label":"EdgesClipper","href":"/api/classes/openbim_components.EdgesClipper","docId":"api/classes/openbim_components.EdgesClipper"},{"type":"link","label":"EdgesPlane","href":"/api/classes/openbim_components.EdgesPlane","docId":"api/classes/openbim_components.EdgesPlane"},{"type":"link","label":"Event","href":"/api/classes/openbim_components.Event","docId":"api/classes/openbim_components.Event"},{"type":"link","label":"FragmentBoundingBox","href":"/api/classes/openbim_components.FragmentBoundingBox","docId":"api/classes/openbim_components.FragmentBoundingBox"},{"type":"link","label":"FragmentManager","href":"/api/classes/openbim_components.FragmentManager","docId":"api/classes/openbim_components.FragmentManager"},{"type":"link","label":"FragmentPlans","href":"/api/classes/openbim_components.FragmentPlans","docId":"api/classes/openbim_components.FragmentPlans"},{"type":"link","label":"IfcJsonExporter","href":"/api/classes/openbim_components.IfcJsonExporter","docId":"api/classes/openbim_components.IfcJsonExporter"},{"type":"link","label":"IfcStreamingSettings","href":"/api/classes/openbim_components.IfcStreamingSettings","docId":"api/classes/openbim_components.IfcStreamingSettings"},{"type":"link","label":"LengthMeasurement","href":"/api/classes/openbim_components.LengthMeasurement","docId":"api/classes/openbim_components.LengthMeasurement"},{"type":"link","label":"MaterialManager","href":"/api/classes/openbim_components.MaterialManager","docId":"api/classes/openbim_components.MaterialManager"},{"type":"link","label":"Mouse","href":"/api/classes/openbim_components.Mouse","docId":"api/classes/openbim_components.Mouse"},{"type":"link","label":"OrthoPerspectiveCamera","href":"/api/classes/openbim_components.OrthoPerspectiveCamera","docId":"api/classes/openbim_components.OrthoPerspectiveCamera"},{"type":"link","label":"PostproductionRenderer","href":"/api/classes/openbim_components.PostproductionRenderer","docId":"api/classes/openbim_components.PostproductionRenderer"},{"type":"link","label":"PropertiesStreamingSettings","href":"/api/classes/openbim_components.PropertiesStreamingSettings","docId":"api/classes/openbim_components.PropertiesStreamingSettings"},{"type":"link","label":"ScreenCuller","href":"/api/classes/openbim_components.ScreenCuller","docId":"api/classes/openbim_components.ScreenCuller"},{"type":"link","label":"Simple2DScene","href":"/api/classes/openbim_components.Simple2DScene","docId":"api/classes/openbim_components.Simple2DScene"},{"type":"link","label":"SimpleCamera","href":"/api/classes/openbim_components.SimpleCamera","docId":"api/classes/openbim_components.SimpleCamera"},{"type":"link","label":"SimpleClipper","href":"/api/classes/openbim_components.SimpleClipper","docId":"api/classes/openbim_components.SimpleClipper"},{"type":"link","label":"SimpleGrid","href":"/api/classes/openbim_components.SimpleGrid","docId":"api/classes/openbim_components.SimpleGrid"},{"type":"link","label":"SimplePlane","href":"/api/classes/openbim_components.SimplePlane","docId":"api/classes/openbim_components.SimplePlane"},{"type":"link","label":"SimpleRaycaster","href":"/api/classes/openbim_components.SimpleRaycaster","docId":"api/classes/openbim_components.SimpleRaycaster"},{"type":"link","label":"SimpleRenderer","href":"/api/classes/openbim_components.SimpleRenderer","docId":"api/classes/openbim_components.SimpleRenderer"},{"type":"link","label":"SimpleScene","href":"/api/classes/openbim_components.SimpleScene","docId":"api/classes/openbim_components.SimpleScene"},{"type":"link","label":"ToolComponent","href":"/api/classes/openbim_components.ToolComponent","docId":"api/classes/openbim_components.ToolComponent"},{"type":"link","label":"UIElement","href":"/api/classes/openbim_components.UIElement","docId":"api/classes/openbim_components.UIElement"},{"type":"link","label":"UIManager","href":"/api/classes/openbim_components.UIManager","docId":"api/classes/openbim_components.UIManager"}]},{"type":"category","label":"Interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Configurable","href":"/api/interfaces/openbim_components.Configurable","docId":"api/interfaces/openbim_components.Configurable"},{"type":"link","label":"Createable","href":"/api/interfaces/openbim_components.Createable","docId":"api/interfaces/openbim_components.Createable"},{"type":"link","label":"Disposable","href":"/api/interfaces/openbim_components.Disposable","docId":"api/interfaces/openbim_components.Disposable"},{"type":"link","label":"FragmentIdMap","href":"/api/interfaces/openbim_components.FragmentIdMap","docId":"api/interfaces/openbim_components.FragmentIdMap"},{"type":"link","label":"Hideable","href":"/api/interfaces/openbim_components.Hideable","docId":"api/interfaces/openbim_components.Hideable"},{"type":"link","label":"NavigationMode","href":"/api/interfaces/openbim_components.NavigationMode","docId":"api/interfaces/openbim_components.NavigationMode"},{"type":"link","label":"Progress","href":"/api/interfaces/openbim_components.Progress","docId":"api/interfaces/openbim_components.Progress"},{"type":"link","label":"Resizeable","href":"/api/interfaces/openbim_components.Resizeable","docId":"api/interfaces/openbim_components.Resizeable"},{"type":"link","label":"UI","href":"/api/interfaces/openbim_components.UI","docId":"api/interfaces/openbim_components.UI"},{"type":"link","label":"Updateable","href":"/api/interfaces/openbim_components.Updateable","docId":"api/interfaces/openbim_components.Updateable"}]}],"href":"/api/"},{"type":"category","label":"Tutorials","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AngleMeasurement","href":"/Tutorials/AngleMeasurement","docId":"Tutorials/AngleMeasurement"},{"type":"link","label":"AreaMeasurement","href":"/Tutorials/AreaMeasurement","docId":"Tutorials/AreaMeasurement"},{"type":"link","label":"EdgesClipper","href":"/Tutorials/EdgesClipper","docId":"Tutorials/EdgesClipper"},{"type":"link","label":"FragmentBoundingBox","href":"/Tutorials/FragmentBoundingBox","docId":"Tutorials/FragmentBoundingBox"},{"type":"link","label":"FragmentClipStyler","href":"/Tutorials/FragmentClipStyler","docId":"Tutorials/FragmentClipStyler"},{"type":"link","label":"FragmentExploder","href":"/Tutorials/FragmentExploder","docId":"Tutorials/FragmentExploder"},{"type":"link","label":"FragmentHider","href":"/Tutorials/FragmentHider","docId":"Tutorials/FragmentHider"},{"type":"link","label":"FragmentHighlighter","href":"/Tutorials/FragmentHighlighter","docId":"Tutorials/FragmentHighlighter"},{"type":"link","label":"FragmentIfcLoader","href":"/Tutorials/FragmentIfcLoader","docId":"Tutorials/FragmentIfcLoader"},{"type":"link","label":"FragmentIfcStreamer","href":"/Tutorials/FragmentIfcStreamer","docId":"Tutorials/FragmentIfcStreamer"},{"type":"link","label":"FragmentManager","href":"/Tutorials/FragmentManager","docId":"Tutorials/FragmentManager"},{"type":"link","label":"FragmentPlans","href":"/Tutorials/FragmentPlans","docId":"Tutorials/FragmentPlans"},{"type":"link","label":"FragmentTree","href":"/Tutorials/FragmentTree","docId":"Tutorials/FragmentTree"},{"type":"link","label":"IfcPropertiesFinder","href":"/Tutorials/IfcPropertiesFinder","docId":"Tutorials/IfcPropertiesFinder"},{"type":"link","label":"IfcPropertiesManager","href":"/Tutorials/IfcPropertiesManager","docId":"Tutorials/IfcPropertiesManager"},{"type":"link","label":"IfcPropertiesProcessor","href":"/Tutorials/IfcPropertiesProcessor","docId":"Tutorials/IfcPropertiesProcessor"},{"type":"link","label":"LengthMeasurement","href":"/Tutorials/LengthMeasurement","docId":"Tutorials/LengthMeasurement"},{"type":"link","label":"MaterialManager","href":"/Tutorials/MaterialManager","docId":"Tutorials/MaterialManager"},{"type":"link","label":"MiniMap","href":"/Tutorials/MiniMap","docId":"Tutorials/MiniMap"},{"type":"link","label":"OrthoPerspectiveCamera","href":"/Tutorials/OrthoPerspectiveCamera","docId":"Tutorials/OrthoPerspectiveCamera"},{"type":"link","label":"PostproductionRenderer","href":"/Tutorials/PostproductionRenderer","docId":"Tutorials/PostproductionRenderer"},{"type":"link","label":"ScreenCuller","href":"/Tutorials/ScreenCuller","docId":"Tutorials/ScreenCuller"},{"type":"link","label":"ShadowDropper","href":"/Tutorials/ShadowDropper","docId":"Tutorials/ShadowDropper"},{"type":"link","label":"Simple2DScene","href":"/Tutorials/Simple2DScene","docId":"Tutorials/Simple2DScene"},{"type":"link","label":"SimpleClipper","href":"/Tutorials/SimpleClipper","docId":"Tutorials/SimpleClipper"},{"type":"link","label":"SimpleRaycaster","href":"/Tutorials/SimpleRaycaster","docId":"Tutorials/SimpleRaycaster"},{"type":"link","label":"SimpleScene","href":"/Tutorials/SimpleScene","docId":"Tutorials/SimpleScene"},{"type":"link","label":"ToolsComponent","href":"/Tutorials/ToolsComponent","docId":"Tutorials/ToolsComponent"},{"type":"link","label":"UIManager","href":"/Tutorials/UIManager","docId":"Tutorials/UIManager"}]}]},"docs":{"api/classes/bim_fragment.Serializer":{"id":"api/classes/bim_fragment.Serializer","title":"Class: Serializer","description":"bim-fragment.Serializer","sidebar":"tutorialSidebar"},"api/classes/openbim_components.BaseRenderer":{"id":"api/classes/openbim_components.BaseRenderer","title":"Class: BaseRenderer","description":"openbim-components.BaseRenderer","sidebar":"tutorialSidebar"},"api/classes/openbim_components.CloudStorage":{"id":"api/classes/openbim_components.CloudStorage","title":"Class: CloudStorage","description":"openbim-components.CloudStorage","sidebar":"tutorialSidebar"},"api/classes/openbim_components.Component":{"id":"api/classes/openbim_components.Component","title":"Class: Component","description":"openbim-components.Component","sidebar":"tutorialSidebar"},"api/classes/openbim_components.Components":{"id":"api/classes/openbim_components.Components","title":"Class: Components","description":"openbim-components.Components","sidebar":"tutorialSidebar"},"api/classes/openbim_components.CubeMap":{"id":"api/classes/openbim_components.CubeMap","title":"Class: CubeMap","description":"openbim-components.CubeMap","sidebar":"tutorialSidebar"},"api/classes/openbim_components.Disposer":{"id":"api/classes/openbim_components.Disposer","title":"Class: Disposer","description":"openbim-components.Disposer","sidebar":"tutorialSidebar"},"api/classes/openbim_components.EdgesClipper":{"id":"api/classes/openbim_components.EdgesClipper","title":"Class: EdgesClipper","description":"openbim-components.EdgesClipper","sidebar":"tutorialSidebar"},"api/classes/openbim_components.EdgesPlane":{"id":"api/classes/openbim_components.EdgesPlane","title":"Class: EdgesPlane","description":"openbim-components.EdgesPlane","sidebar":"tutorialSidebar"},"api/classes/openbim_components.Event":{"id":"api/classes/openbim_components.Event","title":"Class: Event","description":"openbim-components.Event","sidebar":"tutorialSidebar"},"api/classes/openbim_components.FragmentBoundingBox":{"id":"api/classes/openbim_components.FragmentBoundingBox","title":"Class: FragmentBoundingBox","description":"openbim-components.FragmentBoundingBox","sidebar":"tutorialSidebar"},"api/classes/openbim_components.FragmentManager":{"id":"api/classes/openbim_components.FragmentManager","title":"Class: FragmentManager","description":"openbim-components.FragmentManager","sidebar":"tutorialSidebar"},"api/classes/openbim_components.FragmentPlans":{"id":"api/classes/openbim_components.FragmentPlans","title":"Class: FragmentPlans","description":"openbim-components.FragmentPlans","sidebar":"tutorialSidebar"},"api/classes/openbim_components.IfcJsonExporter":{"id":"api/classes/openbim_components.IfcJsonExporter","title":"Class: IfcJsonExporter","description":"openbim-components.IfcJsonExporter","sidebar":"tutorialSidebar"},"api/classes/openbim_components.IfcStreamingSettings":{"id":"api/classes/openbim_components.IfcStreamingSettings","title":"Class: IfcStreamingSettings","description":"openbim-components.IfcStreamingSettings","sidebar":"tutorialSidebar"},"api/classes/openbim_components.LengthMeasurement":{"id":"api/classes/openbim_components.LengthMeasurement","title":"Class: LengthMeasurement","description":"openbim-components.LengthMeasurement","sidebar":"tutorialSidebar"},"api/classes/openbim_components.MaterialManager":{"id":"api/classes/openbim_components.MaterialManager","title":"Class: MaterialManager","description":"openbim-components.MaterialManager","sidebar":"tutorialSidebar"},"api/classes/openbim_components.Mouse":{"id":"api/classes/openbim_components.Mouse","title":"Class: Mouse","description":"openbim-components.Mouse","sidebar":"tutorialSidebar"},"api/classes/openbim_components.OrthoPerspectiveCamera":{"id":"api/classes/openbim_components.OrthoPerspectiveCamera","title":"Class: OrthoPerspectiveCamera","description":"openbim-components.OrthoPerspectiveCamera","sidebar":"tutorialSidebar"},"api/classes/openbim_components.PostproductionRenderer":{"id":"api/classes/openbim_components.PostproductionRenderer","title":"Class: PostproductionRenderer","description":"openbim-components.PostproductionRenderer","sidebar":"tutorialSidebar"},"api/classes/openbim_components.PropertiesStreamingSettings":{"id":"api/classes/openbim_components.PropertiesStreamingSettings","title":"Class: PropertiesStreamingSettings","description":"openbim-components.PropertiesStreamingSettings","sidebar":"tutorialSidebar"},"api/classes/openbim_components.ScreenCuller":{"id":"api/classes/openbim_components.ScreenCuller","title":"Class: ScreenCuller","description":"openbim-components.ScreenCuller","sidebar":"tutorialSidebar"},"api/classes/openbim_components.Simple2DScene":{"id":"api/classes/openbim_components.Simple2DScene","title":"Class: Simple2DScene","description":"openbim-components.Simple2DScene","sidebar":"tutorialSidebar"},"api/classes/openbim_components.SimpleCamera":{"id":"api/classes/openbim_components.SimpleCamera","title":"Class: SimpleCamera","description":"openbim-components.SimpleCamera","sidebar":"tutorialSidebar"},"api/classes/openbim_components.SimpleClipper":{"id":"api/classes/openbim_components.SimpleClipper","title":"Class: SimpleClipper","description":"openbim-components.SimpleClipper","sidebar":"tutorialSidebar"},"api/classes/openbim_components.SimpleGrid":{"id":"api/classes/openbim_components.SimpleGrid","title":"Class: SimpleGrid","description":"openbim-components.SimpleGrid","sidebar":"tutorialSidebar"},"api/classes/openbim_components.SimplePlane":{"id":"api/classes/openbim_components.SimplePlane","title":"Class: SimplePlane","description":"openbim-components.SimplePlane","sidebar":"tutorialSidebar"},"api/classes/openbim_components.SimpleRaycaster":{"id":"api/classes/openbim_components.SimpleRaycaster","title":"Class: SimpleRaycaster","description":"openbim-components.SimpleRaycaster","sidebar":"tutorialSidebar"},"api/classes/openbim_components.SimpleRenderer":{"id":"api/classes/openbim_components.SimpleRenderer","title":"Class: SimpleRenderer","description":"openbim-components.SimpleRenderer","sidebar":"tutorialSidebar"},"api/classes/openbim_components.SimpleScene":{"id":"api/classes/openbim_components.SimpleScene","title":"Class: SimpleScene","description":"openbim-components.SimpleScene","sidebar":"tutorialSidebar"},"api/classes/openbim_components.ToolComponent":{"id":"api/classes/openbim_components.ToolComponent","title":"Class: ToolComponent","description":"openbim-components.ToolComponent","sidebar":"tutorialSidebar"},"api/classes/openbim_components.UIElement":{"id":"api/classes/openbim_components.UIElement","title":"Class: UIElement","description":"openbim-components.UIElement","sidebar":"tutorialSidebar"},"api/classes/openbim_components.UIManager":{"id":"api/classes/openbim_components.UIManager","title":"Class: UIManager","description":"openbim-components.UIManager","sidebar":"tutorialSidebar"},"api/index":{"id":"api/index","title":"Open BIM Docs","description":"TOC","sidebar":"tutorialSidebar"},"api/interfaces/openbim_components.Configurable":{"id":"api/interfaces/openbim_components.Configurable","title":"Interface: Configurable","description":"openbim-components.Configurable","sidebar":"tutorialSidebar"},"api/interfaces/openbim_components.Createable":{"id":"api/interfaces/openbim_components.Createable","title":"Interface: Createable","description":"openbim-components.Createable","sidebar":"tutorialSidebar"},"api/interfaces/openbim_components.Disposable":{"id":"api/interfaces/openbim_components.Disposable","title":"Interface: Disposable","description":"openbim-components.Disposable","sidebar":"tutorialSidebar"},"api/interfaces/openbim_components.FragmentIdMap":{"id":"api/interfaces/openbim_components.FragmentIdMap","title":"Interface: FragmentIdMap","description":"openbim-components.FragmentIdMap","sidebar":"tutorialSidebar"},"api/interfaces/openbim_components.Hideable":{"id":"api/interfaces/openbim_components.Hideable","title":"Interface: Hideable","description":"openbim-components.Hideable","sidebar":"tutorialSidebar"},"api/interfaces/openbim_components.NavigationMode":{"id":"api/interfaces/openbim_components.NavigationMode","title":"Interface: NavigationMode","description":"openbim-components.NavigationMode","sidebar":"tutorialSidebar"},"api/interfaces/openbim_components.Progress":{"id":"api/interfaces/openbim_components.Progress","title":"Interface: Progress","description":"openbim-components.Progress","sidebar":"tutorialSidebar"},"api/interfaces/openbim_components.Resizeable":{"id":"api/interfaces/openbim_components.Resizeable","title":"Interface: Resizeable","description":"openbim-components.Resizeable","sidebar":"tutorialSidebar"},"api/interfaces/openbim_components.UI":{"id":"api/interfaces/openbim_components.UI","title":"Interface: UI","description":"openbim-components.UI","sidebar":"tutorialSidebar"},"api/interfaces/openbim_components.Updateable":{"id":"api/interfaces/openbim_components.Updateable","title":"Interface: Updateable","description":"openbim-components.Updateable","sidebar":"tutorialSidebar"},"api/modules":{"id":"api/modules","title":"Open BIM Docs","description":"","sidebar":"tutorialSidebar"},"api/modules/bim_fragment":{"id":"api/modules/bim_fragment","title":"Module: bim-fragment","description":"Classes","sidebar":"tutorialSidebar"},"api/modules/openbim_components":{"id":"api/modules/openbim_components","title":"Module: openbim-components","description":"Classes","sidebar":"tutorialSidebar"},"components/clean-components-guide":{"id":"components/clean-components-guide","title":"Clean components ABC","description":"Basics","sidebar":"tutorialSidebar"},"components/contributing":{"id":"components/contributing","title":"Get involved","description":"Want to help us make this project even more amazing? Great! Contributing is easy, and on this page you\'ll find a quick guide on how to do it.","sidebar":"tutorialSidebar"},"components/creating-components":{"id":"components/creating-components","title":"Creating new components","description":"Components","sidebar":"tutorialSidebar"},"components/getting-started":{"id":"components/getting-started","title":"Getting started","description":"Component ABC","sidebar":"tutorialSidebar"},"components/tutorial-paths":{"id":"components/tutorial-paths","title":"Tutorial paths","description":"As you can see, we have tons of tutorials in this documentations, and we will keep adding more as new features come out. If you\'re not looking for anything specific, it can be a little difficult to know where to start. For that reason, here are some interesting itineraries to take your first steps in the library!","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Introduction","description":"Welcome to That Open Docs! Have you ever wanted to create your own BIM software, but don\'t know","sidebar":"tutorialSidebar"},"that-open-platform/getting-started":{"id":"that-open-platform/getting-started","title":"Getting started","description":"That Open Platform is a cloud app where we bring the features of our libraries to the next level! One of the things you will find in the platform is a free IFC viewer and editor that you can extend with your own custom tools. How cool is that? Let\'s see how to do that: \ud83d\udc47","sidebar":"tutorialSidebar"},"Tutorials/AngleMeasurement":{"id":"Tutorials/AngleMeasurement","title":"AngleMeasurement","description":"\ud83d\udccf Dimensions Tool","sidebar":"tutorialSidebar"},"Tutorials/AreaMeasurement":{"id":"Tutorials/AreaMeasurement","title":"AreaMeasurement","description":"\ud83d\udccf Dimensions Tool","sidebar":"tutorialSidebar"},"Tutorials/EdgesClipper":{"id":"Tutorials/EdgesClipper","title":"EdgesClipper","description":"\u2b55\ufe0f Aesthetic Clipping Edges","sidebar":"tutorialSidebar"},"Tutorials/FragmentBoundingBox":{"id":"Tutorials/FragmentBoundingBox","title":"FragmentBoundingBox","description":"\ud83e\uddf3 Gathering BIM Data","sidebar":"tutorialSidebar"},"Tutorials/FragmentClipStyler":{"id":"Tutorials/FragmentClipStyler","title":"FragmentClipStyler","description":"\ud83d\udc84 Styling those fills and edges","sidebar":"tutorialSidebar"},"Tutorials/FragmentExploder":{"id":"Tutorials/FragmentExploder","title":"FragmentExploder","description":"\ud83d\udca3 Breaking down Model Dynamically","sidebar":"tutorialSidebar"},"Tutorials/FragmentHider":{"id":"Tutorials/FragmentHider","title":"FragmentHider","description":"\ud83d\udd0e Custom filters for your BIM models","sidebar":"tutorialSidebar"},"Tutorials/FragmentHighlighter":{"id":"Tutorials/FragmentHighlighter","title":"FragmentHighlighter","description":"\ud83e\udd0f Nudging Fragments","sidebar":"tutorialSidebar"},"Tutorials/FragmentIfcLoader":{"id":"Tutorials/FragmentIfcLoader","title":"FragmentIfcLoader","description":"\ud83c\udfe0\ud83d\udc49\ud83e\udd16 From IFC to fragment in 1 minute","sidebar":"tutorialSidebar"},"Tutorials/FragmentIfcStreamer":{"id":"Tutorials/FragmentIfcStreamer","title":"FragmentIfcStreamer","description":"\ud83d\udcaa Let\'s go BIG","sidebar":"tutorialSidebar"},"Tutorials/FragmentManager":{"id":"Tutorials/FragmentManager","title":"FragmentManager","description":"\ud83e\uddf6 Managing Fragment Efficiently","sidebar":"tutorialSidebar"},"Tutorials/FragmentPlans":{"id":"Tutorials/FragmentPlans","title":"FragmentPlans","description":"\ud83d\udcc3\ud83d\udcdc\ud83d\udcc4 Navigating our 3D world in 2D","sidebar":"tutorialSidebar"},"Tutorials/FragmentTree":{"id":"Tutorials/FragmentTree","title":"FragmentTree","description":"\ud83c\udf32 Gathering Structured Insights","sidebar":"tutorialSidebar"},"Tutorials/IfcPropertiesFinder":{"id":"Tutorials/IfcPropertiesFinder","title":"IfcPropertiesFinder","description":"\ud83d\udd0e Find just what you need","sidebar":"tutorialSidebar"},"Tutorials/IfcPropertiesManager":{"id":"Tutorials/IfcPropertiesManager","title":"IfcPropertiesManager","description":"\u270d Edit properties at will!","sidebar":"tutorialSidebar"},"Tutorials/IfcPropertiesProcessor":{"id":"Tutorials/IfcPropertiesProcessor","title":"IfcPropertiesProcessor","description":"\ud83e\uddf6 View all IFC properties FAST","sidebar":"tutorialSidebar"},"Tutorials/LengthMeasurement":{"id":"Tutorials/LengthMeasurement","title":"LengthMeasurement","description":"\ud83d\udccf Dimensions Tool","sidebar":"tutorialSidebar"},"Tutorials/MaterialManager":{"id":"Tutorials/MaterialManager","title":"MaterialManager","description":"\ud83d\udc68\u200d\ud83c\udfa8 Seamless Material Control","sidebar":"tutorialSidebar"},"Tutorials/MiniMap":{"id":"Tutorials/MiniMap","title":"MiniMap","description":"\ud83c\udfc2 Navigate through BIM like Pro!","sidebar":"tutorialSidebar"},"Tutorials/OrthoPerspectiveCamera":{"id":"Tutorials/OrthoPerspectiveCamera","title":"OrthoPerspectiveCamera","description":"\ud83d\udcfd\ufe0f Managing Multiple Views","sidebar":"tutorialSidebar"},"Tutorials/PostproductionRenderer":{"id":"Tutorials/PostproductionRenderer","title":"PostproductionRenderer","description":"\ud83e\uddea Cool Post-Production Effects","sidebar":"tutorialSidebar"},"Tutorials/ScreenCuller":{"id":"Tutorials/ScreenCuller","title":"ScreenCuller","description":"\ud83d\ude85 Managing Performance","sidebar":"tutorialSidebar"},"Tutorials/ShadowDropper":{"id":"Tutorials/ShadowDropper","title":"ShadowDropper","description":"\ud83c\udf12 Adding Realism","sidebar":"tutorialSidebar"},"Tutorials/Simple2DScene":{"id":"Tutorials/Simple2DScene","title":"Simple2DScene","description":"\ud83c\udfa8 Draw in 2D on top of 3D!","sidebar":"tutorialSidebar"},"Tutorials/SimpleClipper":{"id":"Tutorials/SimpleClipper","title":"SimpleClipper","description":"\u2702\ufe0f Clipping Tool","sidebar":"tutorialSidebar"},"Tutorials/SimpleRaycaster":{"id":"Tutorials/SimpleRaycaster","title":"SimpleRaycaster","description":"\ud83e\udd0f Touching things","sidebar":"tutorialSidebar"},"Tutorials/SimpleScene":{"id":"Tutorials/SimpleScene","title":"SimpleScene","description":"\ud83c\udf0d Let\'s create a 3D world!","sidebar":"tutorialSidebar"},"Tutorials/ToolsComponent":{"id":"Tutorials/ToolsComponent","title":"ToolsComponent","description":"\ud83c\udf71 Keeping things tidy","sidebar":"tutorialSidebar"},"Tutorials/UIManager":{"id":"Tutorials/UIManager","title":"UIManager","description":"\ud83c\udf9b\ufe0f Making your user interactive","sidebar":"tutorialSidebar"}}}')}}]); \ No newline at end of file diff --git a/build/assets/js/9365e866.d202e4d0.js b/build/assets/js/9365e866.d202e4d0.js deleted file mode 100644 index 74452559..00000000 --- a/build/assets/js/9365e866.d202e4d0.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[770],{5745:s=>{s.exports=JSON.parse('{"name":"docusaurus-plugin-content-pages","id":"default"}')}}]); \ No newline at end of file diff --git a/build/assets/js/963ae1bc.1d21ea79.js b/build/assets/js/963ae1bc.1d21ea79.js new file mode 100644 index 00000000..131c641f --- /dev/null +++ b/build/assets/js/963ae1bc.1d21ea79.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5470],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>k});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function p(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function r(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=a.createContext({}),l=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},m=function(e){var t=l(e.components);return a.createElement(s.Provider,{value:t},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,p=e.originalType,s=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),d=l(n),u=i,k=d["".concat(s,".").concat(u)]||d[u]||c[u]||p;return n?a.createElement(k,r(r({ref:t},m),{},{components:n})):a.createElement(k,r({ref:t},m))}));function k(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var p=n.length,r=new Array(p);r[0]=u;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[d]="string"==typeof e?e:i,r[1]=o;for(var l=2;l{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>s,default:()=>k,frontMatter:()=>o,metadata:()=>l,toc:()=>d});var a=n(7462),i=n(3366),p=(n(7294),n(3905)),r=["components"],o={id:"openbim_components.Component",title:"Class: Component",sidebar_label:"Component",custom_edit_url:null},s=void 0,l={unversionedId:"api/classes/openbim_components.Component",id:"api/classes/openbim_components.Component",title:"Class: Component",description:"openbim-components.Component",source:"@site/docs/api/classes/openbim_components.Component.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.Component",permalink:"/api/classes/openbim_components.Component",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Component",title:"Class: Component",sidebar_label:"Component",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"CloudStorage",permalink:"/api/classes/openbim_components.CloudStorage"},next:{title:"Components",permalink:"/api/classes/openbim_components.Components"}},m={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"enabled",id:"enabled",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods",level:2},{value:"get",id:"get",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],c={toc:d},u="wrapper";function k(e){var t=e.components,n=(0,i.Z)(e,r);return(0,p.kt)(u,(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Component"),(0,p.kt)("p",null,"Components are the building blocks of this library. Everything is a\ncomponent: tools, scenes, objects, cameras, etc.\nAll components must inherit from this class. The ",(0,p.kt)("inlineCode",{parentName:"p"},"Type")," parameter defines\nthe type of the core of this component. For instance, a component containing a"),(0,p.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"Type"))))),(0,p.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("p",{parentName:"li"},(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"Component"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},(0,p.kt)("inlineCode",{parentName:"a"},"BaseRenderer"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Disposer"},(0,p.kt)("inlineCode",{parentName:"a"},"Disposer"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleScene"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleScene"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.ToolComponent"},(0,p.kt)("inlineCode",{parentName:"a"},"ToolComponent"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleCamera"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleGrid"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleGrid"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleClipper"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},(0,p.kt)("inlineCode",{parentName:"a"},"SimplePlane"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.ScreenCuller"},(0,p.kt)("inlineCode",{parentName:"a"},"ScreenCuller"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.MaterialManager"},(0,p.kt)("inlineCode",{parentName:"a"},"MaterialManager"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Simple2DScene"},(0,p.kt)("inlineCode",{parentName:"a"},"Simple2DScene"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.FragmentManager"},(0,p.kt)("inlineCode",{parentName:"a"},"FragmentManager"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.FragmentPlans"},(0,p.kt)("inlineCode",{parentName:"a"},"FragmentPlans"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.FragmentBoundingBox"},(0,p.kt)("inlineCode",{parentName:"a"},"FragmentBoundingBox"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.UIManager"},(0,p.kt)("inlineCode",{parentName:"a"},"UIManager"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.CloudStorage"},(0,p.kt)("inlineCode",{parentName:"a"},"CloudStorage"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.CubeMap"},(0,p.kt)("inlineCode",{parentName:"a"},"CubeMap"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.LengthMeasurement"},(0,p.kt)("inlineCode",{parentName:"a"},"LengthMeasurement"))))),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"enabled"},"enabled"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Abstract")," ",(0,p.kt)("strong",{parentName:"p"},"enabled"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("p",null,"Whether this component is active or not. The behaviour can vary depending\non the type of component. E.g. a disabled dimension tool will stop creating\ndimensions, while a disabled camera will stop moving. A disabled component\nwill not be updated automatically each frame."),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L24"},"src/base-types/component.ts:24")),(0,p.kt)("h2",{id:"methods"},"Methods"),(0,p.kt)("h3",{id:"get"},"get"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"get"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"...args"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"Type")),(0,p.kt)("p",null,"The core of the component. For instance, if it's a camera component, it\ncould be a ",(0,p.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/cameras/Camera"},"THREE.Camera"),"."),(0,p.kt)("h4",{id:"parameters"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"...args")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"any"))))),(0,p.kt)("h4",{id:"returns"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Type")),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L30"},"src/base-types/component.ts:30")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"hasui"},"hasUI"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,p.kt)("p",null,"Whether is component implements any kind of ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,p.kt)("h4",{id:"returns-1"},"Returns"),(0,p.kt)("p",null,"this is UI"),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,p.kt)("h4",{id:"returns-2"},"Returns"),(0,p.kt)("p",null,"this is Configurable"),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,p.kt)("h4",{id:"returns-3"},"Returns"),(0,p.kt)("p",null,"this is Disposable"),(0,p.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ishideable"},"isHideable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,p.kt)("h4",{id:"returns-4"},"Returns"),(0,p.kt)("p",null,"this is Hideable"),(0,p.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,p.kt)("h4",{id:"returns-5"},"Returns"),(0,p.kt)("p",null,"this is Resizeable"),(0,p.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,p.kt)("h4",{id:"returns-6"},"Returns"),(0,p.kt)("p",null,"this is Updateable"),(0,p.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/963ae1bc.263f3448.js b/build/assets/js/963ae1bc.263f3448.js deleted file mode 100644 index 9595910b..00000000 --- a/build/assets/js/963ae1bc.263f3448.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5470],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>b});var a=t(7294);function p(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,a)}return t}function r(e){for(var n=1;n=0||(p[t]=e[t]);return p}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(p[t]=e[t])}return p}var s=a.createContext({}),l=function(e){var n=a.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):r(r({},n),e)),t},m=function(e){var n=l(e.components);return a.createElement(s.Provider,{value:n},e.children)},c="mdxType",d={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},u=a.forwardRef((function(e,n){var t=e.components,p=e.mdxType,i=e.originalType,s=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),c=l(t),u=p,b=c["".concat(s,".").concat(u)]||c[u]||d[u]||i;return t?a.createElement(b,r(r({ref:n},m),{},{components:t})):a.createElement(b,r({ref:n},m))}));function b(e,n){var t=arguments,p=n&&n.mdxType;if("string"==typeof e||p){var i=t.length,r=new Array(i);r[0]=u;var o={};for(var s in n)hasOwnProperty.call(n,s)&&(o[s]=n[s]);o.originalType=e,o[c]="string"==typeof e?e:p,r[1]=o;for(var l=2;l{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>s,default:()=>b,frontMatter:()=>o,metadata:()=>l,toc:()=>c});var a=t(7462),p=t(3366),i=(t(7294),t(3905)),r=["components"],o={id:"openbim_components.Component",title:"Class: Component",sidebar_label:"Component",custom_edit_url:null},s=void 0,l={unversionedId:"api/classes/openbim_components.Component",id:"api/classes/openbim_components.Component",title:"Class: Component",description:"openbim-components.Component",source:"@site/docs/api/classes/openbim_components.Component.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.Component",permalink:"/api/classes/openbim_components.Component",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Component",title:"Class: Component",sidebar_label:"Component",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"CloudStorage",permalink:"/api/classes/openbim_components.CloudStorage"},next:{title:"Components",permalink:"/api/classes/openbim_components.Components"}},m={},c=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"enabled",id:"enabled",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods",level:2},{value:"get",id:"get",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c},u="wrapper";function b(e){var n=e.components,t=(0,p.Z)(e,r);return(0,i.kt)(u,(0,a.Z)({},d,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Component"),(0,i.kt)("p",null,"Components are the building blocks of this library. Everything is a\ncomponent: tools, scenes, objects, cameras, etc.\nAll components must inherit from this class. The ",(0,i.kt)("inlineCode",{parentName:"p"},"Type")," parameter defines\nthe type of the core of this component. For instance, a component containing a"),(0,i.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Type"))))),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Component"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},(0,i.kt)("inlineCode",{parentName:"a"},"BaseRenderer"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Disposer"},(0,i.kt)("inlineCode",{parentName:"a"},"Disposer"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleScene"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleScene"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.ToolComponent"},(0,i.kt)("inlineCode",{parentName:"a"},"ToolComponent"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleCamera"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleGrid"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleGrid"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleClipper"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},(0,i.kt)("inlineCode",{parentName:"a"},"SimplePlane"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.ScreenCuller"},(0,i.kt)("inlineCode",{parentName:"a"},"ScreenCuller"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.MaterialManager"},(0,i.kt)("inlineCode",{parentName:"a"},"MaterialManager"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Simple2DScene"},(0,i.kt)("inlineCode",{parentName:"a"},"Simple2DScene"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.FragmentManager"},(0,i.kt)("inlineCode",{parentName:"a"},"FragmentManager"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.FragmentPlans"},(0,i.kt)("inlineCode",{parentName:"a"},"FragmentPlans"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.FragmentBoundingBox"},(0,i.kt)("inlineCode",{parentName:"a"},"FragmentBoundingBox"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.UIManager"},(0,i.kt)("inlineCode",{parentName:"a"},"UIManager"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.CloudStorage"},(0,i.kt)("inlineCode",{parentName:"a"},"CloudStorage"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.CubeMap"},(0,i.kt)("inlineCode",{parentName:"a"},"CubeMap"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.LengthMeasurement"},(0,i.kt)("inlineCode",{parentName:"a"},"LengthMeasurement"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"enabled"},"enabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Abstract")," ",(0,i.kt)("strong",{parentName:"p"},"enabled"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Whether this component is active or not. The behaviour can vary depending\non the type of component. E.g. a disabled dimension tool will stop creating\ndimensions, while a disabled camera will stop moving. A disabled component\nwill not be updated automatically each frame."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L24"},"temp/engine_components/src/base-types/component.ts:24")),(0,i.kt)("h2",{id:"methods"},"Methods"),(0,i.kt)("h3",{id:"get"},"get"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"get"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"...args"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Type")),(0,i.kt)("p",null,"The core of the component. For instance, if it's a camera component, it\ncould be a ",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/cameras/Camera"},"THREE.Camera"),"."),(0,i.kt)("h4",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"...args")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))))),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Type")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L30"},"temp/engine_components/src/base-types/component.ts:30")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"hasui"},"hasUI"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,i.kt)("p",null,"Whether is component implements any kind of ",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,"this is UI"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,i.kt)("p",null,"Whether is component is ",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,i.kt)("h4",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,"this is Configurable"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,i.kt)("p",null,"Whether is component is ",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,i.kt)("h4",{id:"returns-3"},"Returns"),(0,i.kt)("p",null,"this is Disposable"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ishideable"},"isHideable"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,i.kt)("p",null,"Whether is component is ",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,i.kt)("h4",{id:"returns-4"},"Returns"),(0,i.kt)("p",null,"this is Hideable"),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,i.kt)("p",null,"Whether is component is ",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,i.kt)("h4",{id:"returns-5"},"Returns"),(0,i.kt)("p",null,"this is Resizeable"),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,i.kt)("p",null,"Whether is component is ",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,i.kt)("h4",{id:"returns-6"},"Returns"),(0,i.kt)("p",null,"this is Updateable"),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")))}b.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/969ec0f0.3da69d1b.js b/build/assets/js/969ec0f0.3da69d1b.js new file mode 100644 index 00000000..be5e7ebe --- /dev/null +++ b/build/assets/js/969ec0f0.3da69d1b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8044],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>k});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var o=a.createContext({}),d=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},s=function(e){var t=d(e.components);return a.createElement(o.Provider,{value:t},e.children)},m="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,l=e.originalType,o=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),m=d(n),u=r,k=m["".concat(o,".").concat(u)]||m[u]||c[u]||l;return n?a.createElement(k,i(i({ref:t},s),{},{components:n})):a.createElement(k,i({ref:t},s))}));function k(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=n.length,i=new Array(l);i[0]=u;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[m]="string"==typeof e?e:r,i[1]=p;for(var d=2;d{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>k,frontMatter:()=>p,metadata:()=>d,toc:()=>m});var a=n(7462),r=n(3366),l=(n(7294),n(3905)),i=["components"],p={id:"openbim_components.Event",title:"Class: Event",sidebar_label:"Event",custom_edit_url:null},o=void 0,d={unversionedId:"api/classes/openbim_components.Event",id:"api/classes/openbim_components.Event",title:"Class: Event",description:"openbim-components.Event",source:"@site/docs/api/classes/openbim_components.Event.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.Event",permalink:"/api/classes/openbim_components.Event",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Event",title:"Class: Event",sidebar_label:"Event",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"EdgesPlane",permalink:"/api/classes/openbim_components.EdgesPlane"},next:{title:"FragmentBoundingBox",permalink:"/api/classes/openbim_components.FragmentBoundingBox"}},s={},m=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Methods",id:"methods",level:2},{value:"add",id:"add",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"remove",id:"remove",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"reset",id:"reset",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"trigger",id:"trigger",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:m},u="wrapper";function k(e){var t=e.components,n=(0,r.Z)(e,i);return(0,l.kt)(u,(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Event"),(0,l.kt)("p",null,"Simple event handler by\n",(0,l.kt)("a",{parentName:"p",href:"https://gist.github.com/JasonKleban/50cee44960c225ac1993c922563aa540"},"Jason Kleban"),".\nKeep in mind that:"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},"If you want to remove it later, you might want to declare the callback as\nan object."),(0,l.kt)("li",{parentName:"ul"},"If you want to maintain the reference to ",(0,l.kt)("inlineCode",{parentName:"li"},"this"),", you will need to declare\nthe callback as an arrow function.")),(0,l.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T"))))),(0,l.kt)("h2",{id:"methods"},"Methods"),(0,l.kt)("h3",{id:"add"},"add"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"add"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"handler"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("p",null,"Add a callback to this event instance."),(0,l.kt)("h4",{id:"parameters"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"handler")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T")," extends ",(0,l.kt)("inlineCode",{parentName:"td"},"void")," ? () => ",(0,l.kt)("inlineCode",{parentName:"td"},"void")," : (",(0,l.kt)("inlineCode",{parentName:"td"},"data"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"T"),") => ",(0,l.kt)("inlineCode",{parentName:"td"},"void")),(0,l.kt)("td",{parentName:"tr",align:"left"},"the callback to be added to this event.")))),(0,l.kt)("h4",{id:"returns"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"defined-in"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L19"},"src/base-types/base-types.ts:19")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"remove"},"remove"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"remove"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"handler"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("p",null,"Removes a callback from this event instance."),(0,l.kt)("h4",{id:"parameters-1"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"handler")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T")," extends ",(0,l.kt)("inlineCode",{parentName:"td"},"void")," ? () => ",(0,l.kt)("inlineCode",{parentName:"td"},"void")," : (",(0,l.kt)("inlineCode",{parentName:"td"},"data"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"T"),") => ",(0,l.kt)("inlineCode",{parentName:"td"},"void")),(0,l.kt)("td",{parentName:"tr",align:"left"},"the callback to be removed from this event.")))),(0,l.kt)("h4",{id:"returns-1"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L27"},"src/base-types/base-types.ts:27")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"reset"},"reset"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"reset"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("p",null,"Gets rid of all the suscribed events."),(0,l.kt)("h4",{id:"returns-2"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L40"},"src/base-types/base-types.ts:40")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"trigger"},"trigger"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"trigger"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"data?"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("p",null,"Triggers all the callbacks assigned to this event."),(0,l.kt)("h4",{id:"parameters-2"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"data?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T"))))),(0,l.kt)("h4",{id:"returns-3"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L32"},"src/base-types/base-types.ts:32")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/969ec0f0.5c676bc1.js b/build/assets/js/969ec0f0.5c676bc1.js deleted file mode 100644 index fef37dda..00000000 --- a/build/assets/js/969ec0f0.5c676bc1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8044],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>k});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var o=a.createContext({}),s=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},d=function(e){var t=s(e.components);return a.createElement(o.Provider,{value:t},e.children)},m="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),m=s(n),u=r,k=m["".concat(o,".").concat(u)]||m[u]||c[u]||i;return n?a.createElement(k,l(l({ref:t},d),{},{components:n})):a.createElement(k,l({ref:t},d))}));function k(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=u;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[m]="string"==typeof e?e:r,l[1]=p;for(var s=2;s{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>k,frontMatter:()=>p,metadata:()=>s,toc:()=>m});var a=n(7462),r=n(3366),i=(n(7294),n(3905)),l=["components"],p={id:"openbim_components.Event",title:"Class: Event",sidebar_label:"Event",custom_edit_url:null},o=void 0,s={unversionedId:"api/classes/openbim_components.Event",id:"api/classes/openbim_components.Event",title:"Class: Event",description:"openbim-components.Event",source:"@site/docs/api/classes/openbim_components.Event.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.Event",permalink:"/api/classes/openbim_components.Event",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Event",title:"Class: Event",sidebar_label:"Event",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"EdgesPlane",permalink:"/api/classes/openbim_components.EdgesPlane"},next:{title:"FragmentBoundingBox",permalink:"/api/classes/openbim_components.FragmentBoundingBox"}},d={},m=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Methods",id:"methods",level:2},{value:"add",id:"add",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"remove",id:"remove",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"reset",id:"reset",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"trigger",id:"trigger",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:m},u="wrapper";function k(e){var t=e.components,n=(0,r.Z)(e,l);return(0,i.kt)(u,(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Event"),(0,i.kt)("p",null,"Simple event handler by\n",(0,i.kt)("a",{parentName:"p",href:"https://gist.github.com/JasonKleban/50cee44960c225ac1993c922563aa540"},"Jason Kleban"),".\nKeep in mind that:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"If you want to remove it later, you might want to declare the callback as\nan object."),(0,i.kt)("li",{parentName:"ul"},"If you want to maintain the reference to ",(0,i.kt)("inlineCode",{parentName:"li"},"this"),", you will need to declare\nthe callback as an arrow function.")),(0,i.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T"))))),(0,i.kt)("h2",{id:"methods"},"Methods"),(0,i.kt)("h3",{id:"add"},"add"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"add"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"handler"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Add a callback to this event instance."),(0,i.kt)("h4",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"handler")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T")," extends ",(0,i.kt)("inlineCode",{parentName:"td"},"void")," ? () => ",(0,i.kt)("inlineCode",{parentName:"td"},"void")," : (",(0,i.kt)("inlineCode",{parentName:"td"},"data"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"T"),") => ",(0,i.kt)("inlineCode",{parentName:"td"},"void")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the callback to be added to this event.")))),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L19"},"temp/engine_components/src/base-types/base-types.ts:19")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"remove"},"remove"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"remove"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"handler"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Removes a callback from this event instance."),(0,i.kt)("h4",{id:"parameters-1"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"handler")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T")," extends ",(0,i.kt)("inlineCode",{parentName:"td"},"void")," ? () => ",(0,i.kt)("inlineCode",{parentName:"td"},"void")," : (",(0,i.kt)("inlineCode",{parentName:"td"},"data"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"T"),") => ",(0,i.kt)("inlineCode",{parentName:"td"},"void")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the callback to be removed from this event.")))),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L27"},"temp/engine_components/src/base-types/base-types.ts:27")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"reset"},"reset"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"reset"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Gets rid of all the suscribed events."),(0,i.kt)("h4",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L40"},"temp/engine_components/src/base-types/base-types.ts:40")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"trigger"},"trigger"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"trigger"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"data?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Triggers all the callbacks assigned to this event."),(0,i.kt)("h4",{id:"parameters-2"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"data?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T"))))),(0,i.kt)("h4",{id:"returns-3"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L32"},"temp/engine_components/src/base-types/base-types.ts:32")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/9a5f9594.66efc705.js b/build/assets/js/9a5f9594.de6b5e8b.js similarity index 73% rename from build/assets/js/9a5f9594.66efc705.js rename to build/assets/js/9a5f9594.de6b5e8b.js index deb6d0f0..9b5c35a6 100644 --- a/build/assets/js/9a5f9594.66efc705.js +++ b/build/assets/js/9a5f9594.de6b5e8b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1361],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>d});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function s(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function a(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=n.createContext({}),p=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):a(a({},t),e)),r},c=function(e){var t=p(e.components);return n.createElement(l.Provider,{value:t},e.children)},u="mdxType",f={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,s=e.originalType,l=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),u=p(r),m=o,d=u["".concat(l,".").concat(m)]||u[m]||f[m]||s;return r?n.createElement(d,a(a({ref:t},c),{},{components:r})):n.createElement(d,a({ref:t},c))}));function d(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var s=r.length,a=new Array(s);a[0]=m;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[u]="string"==typeof e?e:o,a[1]=i;for(var p=2;p{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>p,toc:()=>u});var n=r(7462),o=r(3366),s=(r(7294),r(3905)),a=["components"],i={},l=void 0,p={unversionedId:"Tutorials/IfcPropertiesProcessor",id:"Tutorials/IfcPropertiesProcessor",title:"IfcPropertiesProcessor",description:"\ud83e\uddf6 View all IFC properties FAST",source:"@site/docs/Tutorials/IfcPropertiesProcessor.mdx",sourceDirName:"Tutorials",slug:"/Tutorials/IfcPropertiesProcessor",permalink:"/Tutorials/IfcPropertiesProcessor",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"IfcPropertiesManager",permalink:"/Tutorials/IfcPropertiesManager"},next:{title:"LengthMeasurement",permalink:"/Tutorials/LengthMeasurement"}},c={},u=[{value:"\ud83e\uddf6 View all IFC properties FAST",id:"-view-all-ifc-properties-fast",level:3}],f={toc:u},m="wrapper";function d(e){var t=e.components,r=(0,o.Z)(e,a);return(0,s.kt)(m,(0,n.Z)({},f,r,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("h3",{id:"-view-all-ifc-properties-fast"},"\ud83e\uddf6 View all IFC properties FAST"),(0,s.kt)("hr",null),(0,s.kt)("p",null,"IFC elements have tons of data, and it's often indirectly\nbound to the elements. Luckily, getting all the data for any\nIFC element is trivial with these libraries. Let\xb4s see how! First,\nas usually, we'll load our classic fragment model and set up\nthe fragment highlighter:"),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js"},'const fragments = new OBC.FragmentManager(components);\nconst file = await fetch("../../../resources/small.frag");\nconst dataBlob = await file.arrayBuffer();\nconst buffer = new Uint8Array(dataBlob);\nconst model = await fragments.load(buffer);\nconst properties = await fetch("../../../resources/small.json");\nconst props = await properties.json();\nmodel.setLocalProperties(props);\nconst highlighter = new OBC.FragmentHighlighter(components, fragments);\nhighlighter.setup();\ncomponents.renderer.postproduction.customEffects.outlineEnabled = true;\nhighlighter.outlinesEnabled = true;\n')),(0,s.kt)("p",null,"Next, we will create a new instance of the component to navigate\nIFC properties: the ",(0,s.kt)("inlineCode",{parentName:"p"},"IfcPropertiesProcessor"),". We will also\nmake its built-in floating window visible by default."),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js"},'const propsProcessor = new OBC.IfcPropertiesProcessor(components)\npropsProcessor.uiElement.get("propertiesWindow").visible = true\n')),(0,s.kt)("p",null,"Now, to view the properties of a model we need to process it:"),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js"},"propsProcessor.process(model);\n")),(0,s.kt)("p",null,"And now, we will bind the highlihgter logic to the properties\nprocessor, so that each time that we click on an element, its\nproperties will be shown:"),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js"},"const highlighterEvents = highlighter.events;\nhighlighterEvents.select.onClear.add(() => {\npropsProcessor.cleanPropertiesList();\n});\nhighlighterEvents.select.onHighlight.add(\n(selection) => {\nconst fragmentID = Object.keys(selection)[0];\nconst expressID = [...selection[fragmentID]][0];\nlet model\nfor (const group of fragments.groups) {\nfor(const [_key, value] of group.keyFragments) {\nif(value === fragmentID) {\nmodel = group;\nbreak;\n}\n}\n}\nif(model) {\npropsProcessor.renderProperties(model, expressID);\n}\n}\n);\n// console.log(propsProcessor._indexMap);\n//\n// setTimeout(\n// () => {\n// const toExport = {};\n// for(const fragID in propsProcessor._indexMap) {\n// const ids = propsProcessor._indexMap[fragID];\n// for(const expressID in ids) {\n// const associatedIDs = ids[expressID];\n// toExport[expressID] = [...associatedIDs];\n// }\n// }\n//\n// console.log(JSON.stringify(toExport));\n// },\n// 1000\n// )\n")),(0,s.kt)("p",null,"Finally, we will add the main built-in button of the properties\nprocessor to a simple toolbar at the bottom of our app:"),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js"},'const mainToolbar = new OBC.Toolbar(components);\ncomponents.ui.addToolbar(mainToolbar);\nmainToolbar.addChild(propsProcessor.uiElement.get("main"));\n')),(0,s.kt)("p",null,"This is it! Congratulations, now you can see and navigate\nthe properties of any IFC model you load in your apps. Now,\nlet's continue navigating these docs for more cool open BIM tools!"),(0,s.kt)("iframe",{src:"https://thatopen.github.io/engine_components/src/ifc/IfcPropertiesProcessor/index.html"}))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1361],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>g});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function s(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function a(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=n.createContext({}),p=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):a(a({},t),e)),r},c=function(e){var t=p(e.components);return n.createElement(l.Provider,{value:t},e.children)},u="mdxType",f={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,s=e.originalType,l=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),u=p(r),m=o,g=u["".concat(l,".").concat(m)]||u[m]||f[m]||s;return r?n.createElement(g,a(a({ref:t},c),{},{components:r})):n.createElement(g,a({ref:t},c))}));function g(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var s=r.length,a=new Array(s);a[0]=m;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[u]="string"==typeof e?e:o,a[1]=i;for(var p=2;p{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>g,frontMatter:()=>i,metadata:()=>p,toc:()=>u});var n=r(7462),o=r(3366),s=(r(7294),r(3905)),a=["components"],i={},l=void 0,p={unversionedId:"Tutorials/IfcPropertiesProcessor",id:"Tutorials/IfcPropertiesProcessor",title:"IfcPropertiesProcessor",description:"\ud83e\uddf6 View all IFC properties FAST",source:"@site/docs/Tutorials/IfcPropertiesProcessor.mdx",sourceDirName:"Tutorials",slug:"/Tutorials/IfcPropertiesProcessor",permalink:"/Tutorials/IfcPropertiesProcessor",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"IfcPropertiesManager",permalink:"/Tutorials/IfcPropertiesManager"},next:{title:"LengthMeasurement",permalink:"/Tutorials/LengthMeasurement"}},c={},u=[{value:"\ud83e\uddf6 View all IFC properties FAST",id:"-view-all-ifc-properties-fast",level:3}],f={toc:u},m="wrapper";function g(e){var t=e.components,r=(0,o.Z)(e,a);return(0,s.kt)(m,(0,n.Z)({},f,r,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("h3",{id:"-view-all-ifc-properties-fast"},"\ud83e\uddf6 View all IFC properties FAST"),(0,s.kt)("hr",null),(0,s.kt)("p",null,"IFC elements have tons of data, and it's often indirectly\nbound to the elements. Luckily, getting all the data for any\nIFC element is trivial with these libraries. Let\xb4s see how! First,\nas usually, we'll load our classic fragment model and set up\nthe fragment highlighter:"),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js"},'const fragments = new OBC.FragmentManager(components);\nconst file = await fetch("../../../resources/small.frag");\nconst dataBlob = await file.arrayBuffer();\nconst buffer = new Uint8Array(dataBlob);\nconst model = await fragments.load(buffer);\nconst properties = await fetch("../../../resources/small.json");\nconst props = await properties.json();\nmodel.setLocalProperties(props);\nconst highlighter = new OBC.FragmentHighlighter(components, fragments);\nhighlighter.setup();\ncomponents.renderer.postproduction.customEffects.outlineEnabled = true;\nhighlighter.outlinesEnabled = true;\n')),(0,s.kt)("p",null,"Next, we will create a new instance of the component to navigate\nIFC properties: the ",(0,s.kt)("inlineCode",{parentName:"p"},"IfcPropertiesProcessor"),". We will also\nmake its built-in floating window visible by default."),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js"},'const propsProcessor = new OBC.IfcPropertiesProcessor(components)\npropsProcessor.uiElement.get("propertiesWindow").visible = true\n')),(0,s.kt)("p",null,"Now, to view the properties of a model we need to process it:"),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js"},"propsProcessor.process(model);\n")),(0,s.kt)("p",null,"And now, we will bind the highlihgter logic to the properties\nprocessor, so that each time that we click on an element, its\nproperties will be shown:"),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js"},"const highlighterEvents = highlighter.events;\nhighlighterEvents.select.onClear.add(() => {\npropsProcessor.cleanPropertiesList();\n});\nhighlighterEvents.select.onHighlight.add(\n(selection) => {\nconst fragmentID = Object.keys(selection)[0];\nconst expressID = [...selection[fragmentID]][0];\nconst fragment = fragments.list[fragmentID];\nif(fragment.group) {\npropsProcessor.renderProperties(fragment.group, expressID);\n}\n}\n);\n// console.log(propsProcessor._indexMap);\n//\n// setTimeout(\n// () => {\n// const toExport = {};\n// for(const fragID in propsProcessor._indexMap) {\n// const ids = propsProcessor._indexMap[fragID];\n// for(const expressID in ids) {\n// const associatedIDs = ids[expressID];\n// toExport[expressID] = [...associatedIDs];\n// }\n// }\n//\n// console.log(JSON.stringify(toExport));\n// },\n// 1000\n// )\n")),(0,s.kt)("p",null,"Finally, we will add the main built-in button of the properties\nprocessor to a simple toolbar at the bottom of our app:"),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js"},'const mainToolbar = new OBC.Toolbar(components);\ncomponents.ui.addToolbar(mainToolbar);\nmainToolbar.addChild(propsProcessor.uiElement.get("main"));\n')),(0,s.kt)("p",null,"This is it! Congratulations, now you can see and navigate\nthe properties of any IFC model you load in your apps. Now,\nlet's continue navigating these docs for more cool open BIM tools!"),(0,s.kt)("iframe",{src:"https://thatopen.github.io/engine_components/src/ifc/IfcPropertiesProcessor/index.html"}))}g.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/9ba2e06a.21f4a197.js b/build/assets/js/9ba2e06a.21f4a197.js new file mode 100644 index 00000000..c3b0e1ba --- /dev/null +++ b/build/assets/js/9ba2e06a.21f4a197.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4073],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>f});var a=t(7294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function l(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,a)}return t}function r(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var o=a.createContext({}),s=function(e){var n=a.useContext(o),t=n;return e&&(t="function"==typeof e?e(n):r(r({},n),e)),t},m=function(e){var n=s(e.components);return a.createElement(o.Provider,{value:n},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},u=a.forwardRef((function(e,n){var t=e.components,i=e.mdxType,l=e.originalType,o=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),d=s(t),u=i,f=d["".concat(o,".").concat(u)]||d[u]||k[u]||l;return t?a.createElement(f,r(r({ref:n},m),{},{components:t})):a.createElement(f,r({ref:n},m))}));function f(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var l=t.length,r=new Array(l);r[0]=u;var p={};for(var o in n)hasOwnProperty.call(n,o)&&(p[o]=n[o]);p.originalType=e,p[d]="string"==typeof e?e:i,r[1]=p;for(var s=2;s{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>o,default:()=>f,frontMatter:()=>p,metadata:()=>s,toc:()=>d});var a=t(7462),i=t(3366),l=(t(7294),t(3905)),r=["components"],p={id:"openbim_components.FragmentPlans",title:"Class: FragmentPlans",sidebar_label:"FragmentPlans",custom_edit_url:null},o=void 0,s={unversionedId:"api/classes/openbim_components.FragmentPlans",id:"api/classes/openbim_components.FragmentPlans",title:"Class: FragmentPlans",description:"openbim-components.FragmentPlans",source:"@site/docs/api/classes/openbim_components.FragmentPlans.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.FragmentPlans",permalink:"/api/classes/openbim_components.FragmentPlans",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.FragmentPlans",title:"Class: FragmentPlans",sidebar_label:"FragmentPlans",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"FragmentManager",permalink:"/api/classes/openbim_components.FragmentManager"},next:{title:"IfcJsonExporter",permalink:"/api/classes/openbim_components.IfcJsonExporter"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"currentPlan",id:"currentplan",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"defaultCameraOffset",id:"defaultcameraoffset",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultSectionOffset",id:"defaultsectionoffset",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"storeys",id:"storeys",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"uiElement",id:"uielement",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"create",id:"create",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"exitPlanView",id:"exitplanview",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"goTo",id:"goto",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-17",level:4}],k={toc:d},u="wrapper";function f(e){var n=e.components,t=(0,i.Z)(e,r);return(0,l.kt)(u,(0,a.Z)({},k,t,{components:n,mdxType:"MDXLayout"}),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".FragmentPlans"),(0,l.kt)("p",null,"Helper to control the camera and easily define and navigate 2D floor plans."),(0,l.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,l.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,l.kt)("inlineCode",{parentName:"p"},"PlanView"),"[]",">"),(0,l.kt)("p",{parentName:"li"},"\u21b3 ",(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"FragmentPlans"))))),(0,l.kt)("h2",{id:"implements"},"Implements"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,l.kt)("inlineCode",{parentName:"a"},"Disposable"))),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},(0,l.kt)("inlineCode",{parentName:"a"},"UI")))),(0,l.kt)("h2",{id:"properties"},"Properties"),(0,l.kt)("h3",{id:"currentplan"},"currentPlan"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"currentPlan"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"PlanView")," = ",(0,l.kt)("inlineCode",{parentName:"p"},"null")),(0,l.kt)("p",null,"The floorplan that is currently selected."),(0,l.kt)("h4",{id:"defined-in"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentPlans/index.ts#L44"},"src/fragments/FragmentPlans/index.ts:44")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"defaultcameraoffset"},"defaultCameraOffset"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"defaultCameraOffset"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,l.kt)("inlineCode",{parentName:"p"},"30")),(0,l.kt)("p",null,"The offset of the 2D camera to the floor plan elevation."),(0,l.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentPlans/index.ts#L50"},"src/fragments/FragmentPlans/index.ts:50")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"defaultsectionoffset"},"defaultSectionOffset"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"defaultSectionOffset"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,l.kt)("inlineCode",{parentName:"p"},"1.5")),(0,l.kt)("p",null,"The offset from the clipping planes to their respective floor plan elevation."),(0,l.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentPlans/index.ts#L47"},"src/fragments/FragmentPlans/index.ts:47")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"enabled"},"enabled"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"enabled"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,l.kt)("inlineCode",{parentName:"p"},"false")),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,l.kt)("h4",{id:"overrides"},"Overrides"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,l.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentPlans/index.ts#L41"},"src/fragments/FragmentPlans/index.ts:41")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,l.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,l.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,l.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentPlans/index.ts#L34"},"src/fragments/FragmentPlans/index.ts:34")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"storeys"},"storeys"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"storeys"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")," = ",(0,l.kt)("inlineCode",{parentName:"p"},"[]")),(0,l.kt)("p",null,"The created floor plans."),(0,l.kt)("h4",{id:"index-signature"},"Index signature"),(0,l.kt)("p",null,"\u25aa ","[modelID: ",(0,l.kt)("inlineCode",{parentName:"p"},"number"),"]",": ",(0,l.kt)("inlineCode",{parentName:"p"},"any"),"[]"),(0,l.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentPlans/index.ts#L53"},"src/fragments/FragmentPlans/index.ts:53")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"uielement"},"uiElement"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"uiElement"),": ",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.UIElement"},(0,l.kt)("inlineCode",{parentName:"a"},"UIElement")),"<{ ",(0,l.kt)("inlineCode",{parentName:"p"},"commandsMenu"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"CommandsMenu"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"PlanView"),">"," ; ",(0,l.kt)("inlineCode",{parentName:"p"},"defaultText"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"SimpleUIComponent"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"HTMLParagraphElement"),">"," ; ",(0,l.kt)("inlineCode",{parentName:"p"},"exitButton"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Button")," ; ",(0,l.kt)("inlineCode",{parentName:"p"},"floatingWindow"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"FloatingWindow")," ; ",(0,l.kt)("inlineCode",{parentName:"p"},"main"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Button")," ; ",(0,l.kt)("inlineCode",{parentName:"p"},"planList"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"SimpleUIComponent"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"HTMLElement"),">"," }",">"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI#uielement"},"UI.uiElement")),(0,l.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),".",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI#uielement"},"uiElement")),(0,l.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentPlans/index.ts#L58"},"src/fragments/FragmentPlans/index.ts:58")),(0,l.kt)("h2",{id:"methods"},"Methods"),(0,l.kt)("h3",{id:"create"},"create"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"create"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("p",null,"Creates a new floor plan in the navigator."),(0,l.kt)("h4",{id:"parameters"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"config")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"PlanView")),(0,l.kt)("td",{parentName:"tr",align:"left"},"Necessary data to initialize the floor plan.")))),(0,l.kt)("h4",{id:"returns"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentPlans/index.ts#L154"},"src/fragments/FragmentPlans/index.ts:154")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"dispose"},"dispose"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,l.kt)("h4",{id:"returns-1"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,l.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentPlans/index.ts#L99"},"src/fragments/FragmentPlans/index.ts:99")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"exitplanview"},"exitPlanView"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"exitPlanView"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"animate?"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("p",null,"Deactivate navigator and go back to the previous view."),(0,l.kt)("h4",{id:"parameters-1"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"animate")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"false")),(0,l.kt)("td",{parentName:"tr",align:"left"},"Whether to animate the camera transition.")))),(0,l.kt)("h4",{id:"returns-2"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentPlans/index.ts#L198"},"src/fragments/FragmentPlans/index.ts:198")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"get"},"get"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"get"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"PlanView"),"[]"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,l.kt)("h4",{id:"returns-3"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"PlanView"),"[]"),(0,l.kt)("h4",{id:"overrides-1"},"Overrides"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,l.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentPlans/index.ts#L94"},"src/fragments/FragmentPlans/index.ts:94")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"goto"},"goTo"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"goTo"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"animate?"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("p",null,"Make the navigator go to the specified floor plan."),(0,l.kt)("h4",{id:"parameters-2"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"id")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"undefined")),(0,l.kt)("td",{parentName:"tr",align:"left"},"Floor plan to go to.")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"animate")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"false")),(0,l.kt)("td",{parentName:"tr",align:"left"},"Whether to animate the camera transition.")))),(0,l.kt)("h4",{id:"returns-4"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentPlans/index.ts#L173"},"src/fragments/FragmentPlans/index.ts:173")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"hasui"},"hasUI"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,l.kt)("p",null,"Whether is component implements any kind of ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,l.kt)("h4",{id:"returns-5"},"Returns"),(0,l.kt)("p",null,"this is UI"),(0,l.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,l.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,l.kt)("p",null,"Whether is component is ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,l.kt)("h4",{id:"returns-6"},"Returns"),(0,l.kt)("p",null,"this is Configurable"),(0,l.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,l.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,l.kt)("p",null,"Whether is component is ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,l.kt)("h4",{id:"returns-7"},"Returns"),(0,l.kt)("p",null,"this is Disposable"),(0,l.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,l.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"ishideable"},"isHideable"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,l.kt)("p",null,"Whether is component is ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,l.kt)("h4",{id:"returns-8"},"Returns"),(0,l.kt)("p",null,"this is Hideable"),(0,l.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,l.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,l.kt)("p",null,"Whether is component is ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,l.kt)("h4",{id:"returns-9"},"Returns"),(0,l.kt)("p",null,"this is Resizeable"),(0,l.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,l.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,l.kt)("p",null,"Whether is component is ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,l.kt)("h4",{id:"returns-10"},"Returns"),(0,l.kt)("p",null,"this is Updateable"),(0,l.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,l.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/9ba2e06a.bb4f0552.js b/build/assets/js/9ba2e06a.bb4f0552.js deleted file mode 100644 index 1381ea2f..00000000 --- a/build/assets/js/9ba2e06a.bb4f0552.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4073],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>u});var a=t(7294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function l(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,a)}return t}function p(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var o=a.createContext({}),s=function(e){var n=a.useContext(o),t=n;return e&&(t="function"==typeof e?e(n):p(p({},n),e)),t},m=function(e){var n=s(e.components);return a.createElement(o.Provider,{value:n},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},f=a.forwardRef((function(e,n){var t=e.components,i=e.mdxType,l=e.originalType,o=e.parentName,m=r(e,["components","mdxType","originalType","parentName"]),d=s(t),f=i,u=d["".concat(o,".").concat(f)]||d[f]||k[f]||l;return t?a.createElement(u,p(p({ref:n},m),{},{components:t})):a.createElement(u,p({ref:n},m))}));function u(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var l=t.length,p=new Array(l);p[0]=f;var r={};for(var o in n)hasOwnProperty.call(n,o)&&(r[o]=n[o]);r.originalType=e,r[d]="string"==typeof e?e:i,p[1]=r;for(var s=2;s{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>d});var a=t(7462),i=t(3366),l=(t(7294),t(3905)),p=["components"],r={id:"openbim_components.FragmentPlans",title:"Class: FragmentPlans",sidebar_label:"FragmentPlans",custom_edit_url:null},o=void 0,s={unversionedId:"api/classes/openbim_components.FragmentPlans",id:"api/classes/openbim_components.FragmentPlans",title:"Class: FragmentPlans",description:"openbim-components.FragmentPlans",source:"@site/docs/api/classes/openbim_components.FragmentPlans.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.FragmentPlans",permalink:"/api/classes/openbim_components.FragmentPlans",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.FragmentPlans",title:"Class: FragmentPlans",sidebar_label:"FragmentPlans",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"FragmentManager",permalink:"/api/classes/openbim_components.FragmentManager"},next:{title:"IfcJsonExporter",permalink:"/api/classes/openbim_components.IfcJsonExporter"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"currentPlan",id:"currentplan",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"defaultCameraOffset",id:"defaultcameraoffset",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultSectionOffset",id:"defaultsectionoffset",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"storeys",id:"storeys",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"uiElement",id:"uielement",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"create",id:"create",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"exitPlanView",id:"exitplanview",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"goTo",id:"goto",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-17",level:4}],k={toc:d},f="wrapper";function u(e){var n=e.components,t=(0,i.Z)(e,p);return(0,l.kt)(f,(0,a.Z)({},k,t,{components:n,mdxType:"MDXLayout"}),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".FragmentPlans"),(0,l.kt)("p",null,"Helper to control the camera and easily define and navigate 2D floor plans."),(0,l.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,l.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,l.kt)("inlineCode",{parentName:"p"},"PlanView"),"[]",">"),(0,l.kt)("p",{parentName:"li"},"\u21b3 ",(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"FragmentPlans"))))),(0,l.kt)("h2",{id:"implements"},"Implements"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,l.kt)("inlineCode",{parentName:"a"},"Disposable"))),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},(0,l.kt)("inlineCode",{parentName:"a"},"UI")))),(0,l.kt)("h2",{id:"properties"},"Properties"),(0,l.kt)("h3",{id:"currentplan"},"currentPlan"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"currentPlan"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"PlanView")," = ",(0,l.kt)("inlineCode",{parentName:"p"},"null")),(0,l.kt)("p",null,"The floorplan that is currently selected."),(0,l.kt)("h4",{id:"defined-in"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentPlans/index.ts#L44"},"temp/engine_components/src/fragments/FragmentPlans/index.ts:44")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"defaultcameraoffset"},"defaultCameraOffset"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"defaultCameraOffset"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,l.kt)("inlineCode",{parentName:"p"},"30")),(0,l.kt)("p",null,"The offset of the 2D camera to the floor plan elevation."),(0,l.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentPlans/index.ts#L50"},"temp/engine_components/src/fragments/FragmentPlans/index.ts:50")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"defaultsectionoffset"},"defaultSectionOffset"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"defaultSectionOffset"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,l.kt)("inlineCode",{parentName:"p"},"1.5")),(0,l.kt)("p",null,"The offset from the clipping planes to their respective floor plan elevation."),(0,l.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentPlans/index.ts#L47"},"temp/engine_components/src/fragments/FragmentPlans/index.ts:47")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"enabled"},"enabled"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"enabled"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,l.kt)("inlineCode",{parentName:"p"},"false")),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,l.kt)("h4",{id:"overrides"},"Overrides"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,l.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentPlans/index.ts#L41"},"temp/engine_components/src/fragments/FragmentPlans/index.ts:41")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,l.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,l.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,l.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentPlans/index.ts#L34"},"temp/engine_components/src/fragments/FragmentPlans/index.ts:34")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"storeys"},"storeys"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"storeys"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")," = ",(0,l.kt)("inlineCode",{parentName:"p"},"[]")),(0,l.kt)("p",null,"The created floor plans."),(0,l.kt)("h4",{id:"index-signature"},"Index signature"),(0,l.kt)("p",null,"\u25aa ","[modelID: ",(0,l.kt)("inlineCode",{parentName:"p"},"number"),"]",": ",(0,l.kt)("inlineCode",{parentName:"p"},"any"),"[]"),(0,l.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentPlans/index.ts#L53"},"temp/engine_components/src/fragments/FragmentPlans/index.ts:53")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"uielement"},"uiElement"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"uiElement"),": ",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.UIElement"},(0,l.kt)("inlineCode",{parentName:"a"},"UIElement")),"<{ ",(0,l.kt)("inlineCode",{parentName:"p"},"commandsMenu"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"CommandsMenu"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"PlanView"),">"," ; ",(0,l.kt)("inlineCode",{parentName:"p"},"defaultText"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"SimpleUIComponent"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"HTMLParagraphElement"),">"," ; ",(0,l.kt)("inlineCode",{parentName:"p"},"exitButton"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Button")," ; ",(0,l.kt)("inlineCode",{parentName:"p"},"floatingWindow"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"FloatingWindow")," ; ",(0,l.kt)("inlineCode",{parentName:"p"},"main"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Button")," ; ",(0,l.kt)("inlineCode",{parentName:"p"},"planList"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"SimpleUIComponent"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"HTMLElement"),">"," }",">"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI#uielement"},"UI.uiElement")),(0,l.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),".",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI#uielement"},"uiElement")),(0,l.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentPlans/index.ts#L58"},"temp/engine_components/src/fragments/FragmentPlans/index.ts:58")),(0,l.kt)("h2",{id:"methods"},"Methods"),(0,l.kt)("h3",{id:"create"},"create"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"create"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("p",null,"Creates a new floor plan in the navigator."),(0,l.kt)("h4",{id:"parameters"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"config")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"PlanView")),(0,l.kt)("td",{parentName:"tr",align:"left"},"Necessary data to initialize the floor plan.")))),(0,l.kt)("h4",{id:"returns"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentPlans/index.ts#L154"},"temp/engine_components/src/fragments/FragmentPlans/index.ts:154")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"dispose"},"dispose"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,l.kt)("h4",{id:"returns-1"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,l.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentPlans/index.ts#L99"},"temp/engine_components/src/fragments/FragmentPlans/index.ts:99")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"exitplanview"},"exitPlanView"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"exitPlanView"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"animate?"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("p",null,"Deactivate navigator and go back to the previous view."),(0,l.kt)("h4",{id:"parameters-1"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"animate")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"false")),(0,l.kt)("td",{parentName:"tr",align:"left"},"Whether to animate the camera transition.")))),(0,l.kt)("h4",{id:"returns-2"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentPlans/index.ts#L198"},"temp/engine_components/src/fragments/FragmentPlans/index.ts:198")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"get"},"get"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"get"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"PlanView"),"[]"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,l.kt)("h4",{id:"returns-3"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"PlanView"),"[]"),(0,l.kt)("h4",{id:"overrides-1"},"Overrides"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,l.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentPlans/index.ts#L94"},"temp/engine_components/src/fragments/FragmentPlans/index.ts:94")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"goto"},"goTo"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"goTo"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"animate?"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("p",null,"Make the navigator go to the specified floor plan."),(0,l.kt)("h4",{id:"parameters-2"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"id")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"undefined")),(0,l.kt)("td",{parentName:"tr",align:"left"},"Floor plan to go to.")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"animate")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"false")),(0,l.kt)("td",{parentName:"tr",align:"left"},"Whether to animate the camera transition.")))),(0,l.kt)("h4",{id:"returns-4"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentPlans/index.ts#L173"},"temp/engine_components/src/fragments/FragmentPlans/index.ts:173")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"hasui"},"hasUI"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,l.kt)("p",null,"Whether is component implements any kind of ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,l.kt)("h4",{id:"returns-5"},"Returns"),(0,l.kt)("p",null,"this is UI"),(0,l.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,l.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,l.kt)("p",null,"Whether is component is ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,l.kt)("h4",{id:"returns-6"},"Returns"),(0,l.kt)("p",null,"this is Configurable"),(0,l.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,l.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,l.kt)("p",null,"Whether is component is ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,l.kt)("h4",{id:"returns-7"},"Returns"),(0,l.kt)("p",null,"this is Disposable"),(0,l.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,l.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"ishideable"},"isHideable"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,l.kt)("p",null,"Whether is component is ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,l.kt)("h4",{id:"returns-8"},"Returns"),(0,l.kt)("p",null,"this is Hideable"),(0,l.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,l.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,l.kt)("p",null,"Whether is component is ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,l.kt)("h4",{id:"returns-9"},"Returns"),(0,l.kt)("p",null,"this is Resizeable"),(0,l.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,l.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,l.kt)("p",null,"Whether is component is ",(0,l.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,l.kt)("h4",{id:"returns-10"},"Returns"),(0,l.kt)("p",null,"this is Updateable"),(0,l.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,l.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,l.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/9dd8a0d2.32165b2d.js b/build/assets/js/9dd8a0d2.32165b2d.js new file mode 100644 index 00000000..fc28f0fc --- /dev/null +++ b/build/assets/js/9dd8a0d2.32165b2d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7054],{7275:(e,t,c)=>{c.r(t),c.d(t,{default:()=>s});var n=c(7294),r=c(6550);function s(){return n.createElement(r.l_,{to:"/intro"})}}}]); \ No newline at end of file diff --git a/build/assets/js/9edcb13d.e13adaf1.js b/build/assets/js/9edcb13d.e13adaf1.js deleted file mode 100644 index 25328b70..00000000 --- a/build/assets/js/9edcb13d.e13adaf1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6599],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>c});var i=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function p(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function o(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var l=i.createContext({}),r=function(e){var n=i.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},m=function(e){var n=r(e.components);return i.createElement(l.Provider,{value:n},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},b=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,p=e.originalType,l=e.parentName,m=s(e,["components","mdxType","originalType","parentName"]),d=r(t),b=a,c=d["".concat(l,".").concat(b)]||d[b]||u[b]||p;return t?i.createElement(c,o(o({ref:n},m),{},{components:t})):i.createElement(c,o({ref:n},m))}));function c(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var p=t.length,o=new Array(p);o[0]=b;var s={};for(var l in n)hasOwnProperty.call(n,l)&&(s[l]=n[l]);s.originalType=e,s[d]="string"==typeof e?e:a,o[1]=s;for(var r=2;r{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>l,default:()=>c,frontMatter:()=>s,metadata:()=>r,toc:()=>d});var i=t(7462),a=t(3366),p=(t(7294),t(3905)),o=["components"],s={id:"openbim_components.CubeMap",title:"Class: CubeMap",sidebar_label:"CubeMap",custom_edit_url:null},l=void 0,r={unversionedId:"api/classes/openbim_components.CubeMap",id:"api/classes/openbim_components.CubeMap",title:"Class: CubeMap",description:"openbim-components.CubeMap",source:"@site/docs/api/classes/openbim_components.CubeMap.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.CubeMap",permalink:"/api/classes/openbim_components.CubeMap",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.CubeMap",title:"Class: CubeMap",sidebar_label:"CubeMap",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Components",permalink:"/api/classes/openbim_components.Components"},next:{title:"Disposer",permalink:"/api/classes/openbim_components.Disposer"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"offset",id:"offset",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"onAfterUpdate",id:"onafterupdate",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onBeforeUpdate",id:"onbeforeupdate",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Methods",id:"methods",level:2},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-10",level:4}],u={toc:d},b="wrapper";function c(e){var n=e.components,t=(0,a.Z)(e,o);return(0,p.kt)(b,(0,i.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".CubeMap"),(0,p.kt)("p",null,"A simple navigation cube to zoom the scene to its basic views (top, bottom,\nleft, right, back and front)."),(0,p.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("p",{parentName:"li"},(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,p.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"HTMLDivElement"),">"),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"CubeMap"))))),(0,p.kt)("h2",{id:"implements"},"Implements"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Updateable"},(0,p.kt)("inlineCode",{parentName:"a"},"Updateable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Hideable"},(0,p.kt)("inlineCode",{parentName:"a"},"Hideable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,p.kt)("inlineCode",{parentName:"a"},"Disposable")))),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"enabled"},"enabled"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"enabled"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,p.kt)("inlineCode",{parentName:"p"},"true")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,p.kt)("h4",{id:"overrides"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/CubeMap/index.ts#L40"},"temp/engine_components/src/navigation/CubeMap/index.ts:40")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"offset"},"offset"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"offset"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,p.kt)("inlineCode",{parentName:"p"},"1")),(0,p.kt)("p",null,"The minimum zoom distance to the scene."),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/CubeMap/index.ts#L49"},"temp/engine_components/src/navigation/CubeMap/index.ts:49")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.CubeMap"},(0,p.kt)("inlineCode",{parentName:"a"},"CubeMap")),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"Updateable.onAfterUpdate")),(0,p.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"onAfterUpdate")),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/CubeMap/index.ts#L43"},"temp/engine_components/src/navigation/CubeMap/index.ts:43")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.CubeMap"},(0,p.kt)("inlineCode",{parentName:"a"},"CubeMap")),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"Updateable.onBeforeUpdate")),(0,p.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"onBeforeUpdate")),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/CubeMap/index.ts#L46"},"temp/engine_components/src/navigation/CubeMap/index.ts:46")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,p.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,p.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/CubeMap/index.ts#L37"},"temp/engine_components/src/navigation/CubeMap/index.ts:37")),(0,p.kt)("h2",{id:"methods"},"Methods"),(0,p.kt)("h3",{id:"hasui"},"hasUI"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,p.kt)("p",null,"Whether is component implements any kind of ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,p.kt)("h4",{id:"returns"},"Returns"),(0,p.kt)("p",null,"this is UI"),(0,p.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,p.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,p.kt)("h4",{id:"returns-1"},"Returns"),(0,p.kt)("p",null,"this is Configurable"),(0,p.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,p.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,p.kt)("h4",{id:"returns-2"},"Returns"),(0,p.kt)("p",null,"this is Disposable"),(0,p.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,p.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ishideable"},"isHideable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,p.kt)("h4",{id:"returns-3"},"Returns"),(0,p.kt)("p",null,"this is Hideable"),(0,p.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,p.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,p.kt)("h4",{id:"returns-4"},"Returns"),(0,p.kt)("p",null,"this is Resizeable"),(0,p.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,p.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,p.kt)("h4",{id:"returns-5"},"Returns"),(0,p.kt)("p",null,"this is Updateable"),(0,p.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,p.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/9edcb13d.f39b22d6.js b/build/assets/js/9edcb13d.f39b22d6.js new file mode 100644 index 00000000..2714f528 --- /dev/null +++ b/build/assets/js/9edcb13d.f39b22d6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6599],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>c});var a=t(7294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function p(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,a)}return t}function o(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var l=a.createContext({}),r=function(e){var n=a.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},m=function(e){var n=r(e.components);return a.createElement(l.Provider,{value:n},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},b=a.forwardRef((function(e,n){var t=e.components,i=e.mdxType,p=e.originalType,l=e.parentName,m=s(e,["components","mdxType","originalType","parentName"]),d=r(t),b=i,c=d["".concat(l,".").concat(b)]||d[b]||u[b]||p;return t?a.createElement(c,o(o({ref:n},m),{},{components:t})):a.createElement(c,o({ref:n},m))}));function c(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var p=t.length,o=new Array(p);o[0]=b;var s={};for(var l in n)hasOwnProperty.call(n,l)&&(s[l]=n[l]);s.originalType=e,s[d]="string"==typeof e?e:i,o[1]=s;for(var r=2;r{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>l,default:()=>c,frontMatter:()=>s,metadata:()=>r,toc:()=>d});var a=t(7462),i=t(3366),p=(t(7294),t(3905)),o=["components"],s={id:"openbim_components.CubeMap",title:"Class: CubeMap",sidebar_label:"CubeMap",custom_edit_url:null},l=void 0,r={unversionedId:"api/classes/openbim_components.CubeMap",id:"api/classes/openbim_components.CubeMap",title:"Class: CubeMap",description:"openbim-components.CubeMap",source:"@site/docs/api/classes/openbim_components.CubeMap.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.CubeMap",permalink:"/api/classes/openbim_components.CubeMap",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.CubeMap",title:"Class: CubeMap",sidebar_label:"CubeMap",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Components",permalink:"/api/classes/openbim_components.Components"},next:{title:"Disposer",permalink:"/api/classes/openbim_components.Disposer"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"offset",id:"offset",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"onAfterUpdate",id:"onafterupdate",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onBeforeUpdate",id:"onbeforeupdate",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Methods",id:"methods",level:2},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-10",level:4}],u={toc:d},b="wrapper";function c(e){var n=e.components,t=(0,i.Z)(e,o);return(0,p.kt)(b,(0,a.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".CubeMap"),(0,p.kt)("p",null,"A simple navigation cube to zoom the scene to its basic views (top, bottom,\nleft, right, back and front)."),(0,p.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("p",{parentName:"li"},(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,p.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"HTMLDivElement"),">"),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"CubeMap"))))),(0,p.kt)("h2",{id:"implements"},"Implements"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Updateable"},(0,p.kt)("inlineCode",{parentName:"a"},"Updateable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Hideable"},(0,p.kt)("inlineCode",{parentName:"a"},"Hideable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,p.kt)("inlineCode",{parentName:"a"},"Disposable")))),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"enabled"},"enabled"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"enabled"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,p.kt)("inlineCode",{parentName:"p"},"true")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,p.kt)("h4",{id:"overrides"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/CubeMap/index.ts#L40"},"src/navigation/CubeMap/index.ts:40")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"offset"},"offset"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"offset"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,p.kt)("inlineCode",{parentName:"p"},"1")),(0,p.kt)("p",null,"The minimum zoom distance to the scene."),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/CubeMap/index.ts#L49"},"src/navigation/CubeMap/index.ts:49")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.CubeMap"},(0,p.kt)("inlineCode",{parentName:"a"},"CubeMap")),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"Updateable.onAfterUpdate")),(0,p.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"onAfterUpdate")),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/CubeMap/index.ts#L43"},"src/navigation/CubeMap/index.ts:43")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.CubeMap"},(0,p.kt)("inlineCode",{parentName:"a"},"CubeMap")),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"Updateable.onBeforeUpdate")),(0,p.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"onBeforeUpdate")),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/CubeMap/index.ts#L46"},"src/navigation/CubeMap/index.ts:46")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,p.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,p.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/CubeMap/index.ts#L37"},"src/navigation/CubeMap/index.ts:37")),(0,p.kt)("h2",{id:"methods"},"Methods"),(0,p.kt)("h3",{id:"hasui"},"hasUI"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,p.kt)("p",null,"Whether is component implements any kind of ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,p.kt)("h4",{id:"returns"},"Returns"),(0,p.kt)("p",null,"this is UI"),(0,p.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,p.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,p.kt)("h4",{id:"returns-1"},"Returns"),(0,p.kt)("p",null,"this is Configurable"),(0,p.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,p.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,p.kt)("h4",{id:"returns-2"},"Returns"),(0,p.kt)("p",null,"this is Disposable"),(0,p.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,p.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ishideable"},"isHideable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,p.kt)("h4",{id:"returns-3"},"Returns"),(0,p.kt)("p",null,"this is Hideable"),(0,p.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,p.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,p.kt)("h4",{id:"returns-4"},"Returns"),(0,p.kt)("p",null,"this is Resizeable"),(0,p.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,p.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,p.kt)("h4",{id:"returns-5"},"Returns"),(0,p.kt)("p",null,"this is Updateable"),(0,p.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,p.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/a94c8b81.3292da88.js b/build/assets/js/a94c8b81.ff4a3225.js similarity index 98% rename from build/assets/js/a94c8b81.3292da88.js rename to build/assets/js/a94c8b81.ff4a3225.js index 89ea8b9c..d85f9da9 100644 --- a/build/assets/js/a94c8b81.3292da88.js +++ b/build/assets/js/a94c8b81.ff4a3225.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3010],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>u});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),s=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},c=function(e){var t=s(e.components);return r.createElement(l.Provider,{value:t},e.children)},m="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,l=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),m=s(n),f=a,u=m["".concat(l,".").concat(f)]||m[f]||d[f]||o;return n?r.createElement(u,i(i({ref:t},c),{},{components:n})):r.createElement(u,i({ref:t},c))}));function u(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,i=new Array(o);i[0]=f;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p[m]="string"==typeof e?e:a,i[1]=p;for(var s=2;s{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>u,frontMatter:()=>p,metadata:()=>s,toc:()=>m});var r=n(7462),a=n(3366),o=(n(7294),n(3905)),i=["components"],p={id:"openbim_components.IfcJsonExporter",title:"Class: IfcJsonExporter",sidebar_label:"IfcJsonExporter",custom_edit_url:null},l=void 0,s={unversionedId:"api/classes/openbim_components.IfcJsonExporter",id:"api/classes/openbim_components.IfcJsonExporter",title:"Class: IfcJsonExporter",description:"openbim-components.IfcJsonExporter",source:"@site/docs/api/classes/openbim_components.IfcJsonExporter.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.IfcJsonExporter",permalink:"/api/classes/openbim_components.IfcJsonExporter",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.IfcJsonExporter",title:"Class: IfcJsonExporter",sidebar_label:"IfcJsonExporter",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"FragmentPlans",permalink:"/api/classes/openbim_components.FragmentPlans"},next:{title:"IfcStreamingSettings",permalink:"/api/classes/openbim_components.IfcStreamingSettings"}},c={},m=[{value:"Methods",id:"methods",level:2},{value:"export",id:"export",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4}],d={toc:m},f="wrapper";function u(e){var t=e.components,n=(0,a.Z)(e,i);return(0,o.kt)(f,(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".IfcJsonExporter"),(0,o.kt)("p",null,"Object to export all the properties from an IFC to a JS object."),(0,o.kt)("h2",{id:"methods"},"Methods"),(0,o.kt)("h3",{id:"export"},"export"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"export"),"(",(0,o.kt)("inlineCode",{parentName:"p"},"webIfc"),", ",(0,o.kt)("inlineCode",{parentName:"p"},"modelID"),", ",(0,o.kt)("inlineCode",{parentName:"p"},"indirect?"),", ",(0,o.kt)("inlineCode",{parentName:"p"},"recursiveSpatial?"),"): ",(0,o.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,o.kt)("inlineCode",{parentName:"p"},"IfcProperties"),">"),(0,o.kt)("p",null,"Exports all the properties of an IFC into an array of JS objects."),(0,o.kt)("h4",{id:"parameters"},"Parameters"),(0,o.kt)("table",null,(0,o.kt)("thead",{parentName:"table"},(0,o.kt)("tr",{parentName:"thead"},(0,o.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,o.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,o.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,o.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,o.kt)("tbody",{parentName:"table"},(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"webIfc")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"IfcAPI")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"undefined")),(0,o.kt)("td",{parentName:"tr",align:"left"},"The instance of ","[web-ifc][https://github.com/ThatOpen/engine_web-ifc]","(",(0,o.kt)("a",{parentName:"td",href:"https://github.com/ThatOpen/engine_web-ifc"},"https://github.com/ThatOpen/engine_web-ifc"),") to use.")),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"modelID")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"number")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"undefined")),(0,o.kt)("td",{parentName:"tr",align:"left"},"ID of the IFC model whose properties to extract.")),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"indirect")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"boolean")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"false")),(0,o.kt)("td",{parentName:"tr",align:"left"},"whether to get the indirect relationships as well.")),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"recursiveSpatial")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"boolean")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"true")),(0,o.kt)("td",{parentName:"tr",align:"left"},"whether to get the properties of spatial items recursively to make the location data available (e.g. absolute position of building).")))),(0,o.kt)("h4",{id:"returns"},"Returns"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,o.kt)("inlineCode",{parentName:"p"},"IfcProperties"),">"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/ifc/IfcJsonExporter/index.ts#L17"},"temp/engine_components/src/ifc/IfcJsonExporter/index.ts:17")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3010],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>u});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),s=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},c=function(e){var t=s(e.components);return r.createElement(l.Provider,{value:t},e.children)},m="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,l=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),m=s(n),f=a,u=m["".concat(l,".").concat(f)]||m[f]||d[f]||o;return n?r.createElement(u,i(i({ref:t},c),{},{components:n})):r.createElement(u,i({ref:t},c))}));function u(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,i=new Array(o);i[0]=f;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p[m]="string"==typeof e?e:a,i[1]=p;for(var s=2;s{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>u,frontMatter:()=>p,metadata:()=>s,toc:()=>m});var r=n(7462),a=n(3366),o=(n(7294),n(3905)),i=["components"],p={id:"openbim_components.IfcJsonExporter",title:"Class: IfcJsonExporter",sidebar_label:"IfcJsonExporter",custom_edit_url:null},l=void 0,s={unversionedId:"api/classes/openbim_components.IfcJsonExporter",id:"api/classes/openbim_components.IfcJsonExporter",title:"Class: IfcJsonExporter",description:"openbim-components.IfcJsonExporter",source:"@site/docs/api/classes/openbim_components.IfcJsonExporter.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.IfcJsonExporter",permalink:"/api/classes/openbim_components.IfcJsonExporter",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.IfcJsonExporter",title:"Class: IfcJsonExporter",sidebar_label:"IfcJsonExporter",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"FragmentPlans",permalink:"/api/classes/openbim_components.FragmentPlans"},next:{title:"IfcStreamingSettings",permalink:"/api/classes/openbim_components.IfcStreamingSettings"}},c={},m=[{value:"Methods",id:"methods",level:2},{value:"export",id:"export",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4}],d={toc:m},f="wrapper";function u(e){var t=e.components,n=(0,a.Z)(e,i);return(0,o.kt)(f,(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".IfcJsonExporter"),(0,o.kt)("p",null,"Object to export all the properties from an IFC to a JS object."),(0,o.kt)("h2",{id:"methods"},"Methods"),(0,o.kt)("h3",{id:"export"},"export"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"export"),"(",(0,o.kt)("inlineCode",{parentName:"p"},"webIfc"),", ",(0,o.kt)("inlineCode",{parentName:"p"},"modelID"),", ",(0,o.kt)("inlineCode",{parentName:"p"},"indirect?"),", ",(0,o.kt)("inlineCode",{parentName:"p"},"recursiveSpatial?"),"): ",(0,o.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,o.kt)("inlineCode",{parentName:"p"},"IfcProperties"),">"),(0,o.kt)("p",null,"Exports all the properties of an IFC into an array of JS objects."),(0,o.kt)("h4",{id:"parameters"},"Parameters"),(0,o.kt)("table",null,(0,o.kt)("thead",{parentName:"table"},(0,o.kt)("tr",{parentName:"thead"},(0,o.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,o.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,o.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,o.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,o.kt)("tbody",{parentName:"table"},(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"webIfc")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"IfcAPI")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"undefined")),(0,o.kt)("td",{parentName:"tr",align:"left"},"The instance of ","[web-ifc][https://github.com/ThatOpen/engine_web-ifc]","(",(0,o.kt)("a",{parentName:"td",href:"https://github.com/ThatOpen/engine_web-ifc"},"https://github.com/ThatOpen/engine_web-ifc"),") to use.")),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"modelID")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"number")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"undefined")),(0,o.kt)("td",{parentName:"tr",align:"left"},"ID of the IFC model whose properties to extract.")),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"indirect")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"boolean")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"false")),(0,o.kt)("td",{parentName:"tr",align:"left"},"whether to get the indirect relationships as well.")),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"recursiveSpatial")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"boolean")),(0,o.kt)("td",{parentName:"tr",align:"left"},(0,o.kt)("inlineCode",{parentName:"td"},"true")),(0,o.kt)("td",{parentName:"tr",align:"left"},"whether to get the properties of spatial items recursively to make the location data available (e.g. absolute position of building).")))),(0,o.kt)("h4",{id:"returns"},"Returns"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,o.kt)("inlineCode",{parentName:"p"},"IfcProperties"),">"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/ifc/IfcJsonExporter/index.ts#L17"},"src/ifc/IfcJsonExporter/index.ts:17")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/aad57e98.45911558.js b/build/assets/js/aad57e98.45911558.js deleted file mode 100644 index eb651565..00000000 --- a/build/assets/js/aad57e98.45911558.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7944],{3905:(e,t,r)=>{r.d(t,{Zo:()=>m,kt:()=>d});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var s=n.createContext({}),c=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},m=function(e){var t=c(e.components);return n.createElement(s.Provider,{value:t},e.children)},p="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),p=c(r),f=a,d=p["".concat(s,".").concat(f)]||p[f]||u[f]||i;return r?n.createElement(d,o(o({ref:t},m),{},{components:r})):n.createElement(d,o({ref:t},m))}));function d(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,o=new Array(i);o[0]=f;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[p]="string"==typeof e?e:a,o[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>m,contentTitle:()=>s,default:()=>d,frontMatter:()=>l,metadata:()=>c,toc:()=>p});var n=r(7462),a=r(3366),i=(r(7294),r(3905)),o=["components"],l={id:"bim_fragment",title:"Module: bim-fragment",sidebar_label:"bim-fragment",sidebar_position:0,custom_edit_url:null},s=void 0,c={unversionedId:"api/modules/bim_fragment",id:"api/modules/bim_fragment",title:"Module: bim-fragment",description:"Classes",source:"@site/docs/api/modules/bim_fragment.md",sourceDirName:"api/modules",slug:"/api/modules/bim_fragment",permalink:"/api/modules/bim_fragment",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"bim_fragment",title:"Module: bim-fragment",sidebar_label:"bim-fragment",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Exports",permalink:"/api/modules"},next:{title:"openbim-components",permalink:"/api/modules/openbim_components"}},m={},p=[{value:"Classes",id:"classes",level:2}],u={toc:p},f="wrapper";function d(e){var t=e.components,r=(0,a.Z)(e,o);return(0,i.kt)(f,(0,n.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h2",{id:"classes"},"Classes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/bim_fragment.Serializer"},"Serializer"))))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/aad57e98.86a9cadb.js b/build/assets/js/aad57e98.86a9cadb.js new file mode 100644 index 00000000..0339e3e3 --- /dev/null +++ b/build/assets/js/aad57e98.86a9cadb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7944],{3905:(e,t,r)=>{r.d(t,{Zo:()=>m,kt:()=>d});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function a(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var c=n.createContext({}),p=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):a(a({},t),e)),r},m=function(e){var t=p(e.components);return n.createElement(c.Provider,{value:t},e.children)},u="mdxType",s={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,i=e.originalType,c=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),u=p(r),f=o,d=u["".concat(c,".").concat(f)]||u[f]||s[f]||i;return r?n.createElement(d,a(a({ref:t},m),{},{components:r})):n.createElement(d,a({ref:t},m))}));function d(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=r.length,a=new Array(i);a[0]=f;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l[u]="string"==typeof e?e:o,a[1]=l;for(var p=2;p{r.r(t),r.d(t,{assets:()=>m,contentTitle:()=>c,default:()=>d,frontMatter:()=>l,metadata:()=>p,toc:()=>u});var n=r(7462),o=r(3366),i=(r(7294),r(3905)),a=["components"],l={id:"bim_fragment",title:"Module: bim-fragment",sidebar_label:"bim-fragment",sidebar_position:0,custom_edit_url:null},c=void 0,p={unversionedId:"api/modules/bim_fragment",id:"api/modules/bim_fragment",title:"Module: bim-fragment",description:"",source:"@site/docs/api/modules/bim_fragment.md",sourceDirName:"api/modules",slug:"/api/modules/bim_fragment",permalink:"/api/modules/bim_fragment",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"bim_fragment",title:"Module: bim-fragment",sidebar_label:"bim-fragment",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Exports",permalink:"/api/modules"},next:{title:"openbim-components",permalink:"/api/modules/openbim_components"}},m={},u=[],s={toc:u},f="wrapper";function d(e){var t=e.components,r=(0,o.Z)(e,a);return(0,i.kt)(f,(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/ab682f67.c4e6016b.js b/build/assets/js/ab682f67.06e1b4dd.js similarity index 58% rename from build/assets/js/ab682f67.c4e6016b.js rename to build/assets/js/ab682f67.06e1b4dd.js index 51b1ca29..d5eafb3f 100644 --- a/build/assets/js/ab682f67.c4e6016b.js +++ b/build/assets/js/ab682f67.06e1b4dd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1349],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>f});var o=n(7294);function s(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function p(e){for(var t=1;t=0||(s[n]=e[n]);return s}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(s[n]=e[n])}return s}var a=o.createContext({}),l=function(e){var t=o.useContext(a),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},m=function(e){var t=l(e.components);return o.createElement(a.Provider,{value:t},e.children)},c="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},u=o.forwardRef((function(e,t){var n=e.components,s=e.mdxType,i=e.originalType,a=e.parentName,m=r(e,["components","mdxType","originalType","parentName"]),c=l(n),u=s,f=c["".concat(a,".").concat(u)]||c[u]||d[u]||i;return n?o.createElement(f,p(p({ref:t},m),{},{components:n})):o.createElement(f,p({ref:t},m))}));function f(e,t){var n=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var i=n.length,p=new Array(i);p[0]=u;var r={};for(var a in t)hasOwnProperty.call(t,a)&&(r[a]=t[a]);r.originalType=e,r[c]="string"==typeof e?e:s,p[1]=r;for(var l=2;l{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>a,default:()=>f,frontMatter:()=>r,metadata:()=>l,toc:()=>c});var o=n(7462),s=n(3366),i=(n(7294),n(3905)),p=["components"],r={id:"openbim_components.Mouse",title:"Class: Mouse",sidebar_label:"Mouse",custom_edit_url:null},a=void 0,l={unversionedId:"api/classes/openbim_components.Mouse",id:"api/classes/openbim_components.Mouse",title:"Class: Mouse",description:"openbim-components.Mouse",source:"@site/docs/api/classes/openbim_components.Mouse.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.Mouse",permalink:"/api/classes/openbim_components.Mouse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Mouse",title:"Class: Mouse",sidebar_label:"Mouse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"MaterialManager",permalink:"/api/classes/openbim_components.MaterialManager"},next:{title:"OrthoPerspectiveCamera",permalink:"/api/classes/openbim_components.OrthoPerspectiveCamera"}},m={},c=[{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Accessors",id:"accessors",level:2},{value:"position",id:"position",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-2",level:4}],d={toc:c},u="wrapper";function f(e){var t=e.components,n=(0,s.Z)(e,p);return(0,i.kt)(u,(0,o.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Mouse"),(0,i.kt)("p",null,"A helper to easily get the real position of the mouse in the Three.js canvas\nto work with tools like the\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/core/Raycaster"},"raycaster"),", even if it has\nbeen transformed through CSS or doesn't occupy the whole screen."),(0,i.kt)("h2",{id:"implements"},"Implements"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,i.kt)("inlineCode",{parentName:"a"},"Disposable")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined"),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,i.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/mouse.ts#L15"},"temp/engine_components/src/base-types/mouse.ts:15")),(0,i.kt)("h2",{id:"accessors"},"Accessors"),(0,i.kt)("h3",{id:"position"},"position"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"position"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,i.kt)("p",null,"The real position of the mouse of the Three.js canvas."),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/mouse.ts#L24"},"temp/engine_components/src/base-types/mouse.ts:24")),(0,i.kt)("h2",{id:"methods"},"Methods"),(0,i.kt)("h3",{id:"dispose"},"dispose"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/mouse.ts#L34"},"temp/engine_components/src/base-types/mouse.ts:34")))}f.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1349],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>f});var o=n(7294);function s(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function r(e){for(var t=1;t=0||(s[n]=e[n]);return s}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(s[n]=e[n])}return s}var p=o.createContext({}),l=function(e){var t=o.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},m=function(e){var t=l(e.components);return o.createElement(p.Provider,{value:t},e.children)},c="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},u=o.forwardRef((function(e,t){var n=e.components,s=e.mdxType,i=e.originalType,p=e.parentName,m=a(e,["components","mdxType","originalType","parentName"]),c=l(n),u=s,f=c["".concat(p,".").concat(u)]||c[u]||d[u]||i;return n?o.createElement(f,r(r({ref:t},m),{},{components:n})):o.createElement(f,r({ref:t},m))}));function f(e,t){var n=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var i=n.length,r=new Array(i);r[0]=u;var a={};for(var p in t)hasOwnProperty.call(t,p)&&(a[p]=t[p]);a.originalType=e,a[c]="string"==typeof e?e:s,r[1]=a;for(var l=2;l{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>p,default:()=>f,frontMatter:()=>a,metadata:()=>l,toc:()=>c});var o=n(7462),s=n(3366),i=(n(7294),n(3905)),r=["components"],a={id:"openbim_components.Mouse",title:"Class: Mouse",sidebar_label:"Mouse",custom_edit_url:null},p=void 0,l={unversionedId:"api/classes/openbim_components.Mouse",id:"api/classes/openbim_components.Mouse",title:"Class: Mouse",description:"openbim-components.Mouse",source:"@site/docs/api/classes/openbim_components.Mouse.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.Mouse",permalink:"/api/classes/openbim_components.Mouse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Mouse",title:"Class: Mouse",sidebar_label:"Mouse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"MaterialManager",permalink:"/api/classes/openbim_components.MaterialManager"},next:{title:"OrthoPerspectiveCamera",permalink:"/api/classes/openbim_components.OrthoPerspectiveCamera"}},m={},c=[{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Accessors",id:"accessors",level:2},{value:"position",id:"position",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-2",level:4}],d={toc:c},u="wrapper";function f(e){var t=e.components,n=(0,s.Z)(e,r);return(0,i.kt)(u,(0,o.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Mouse"),(0,i.kt)("p",null,"A helper to easily get the real position of the mouse in the Three.js canvas\nto work with tools like the\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/core/Raycaster"},"raycaster"),", even if it has\nbeen transformed through CSS or doesn't occupy the whole screen."),(0,i.kt)("h2",{id:"implements"},"Implements"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,i.kt)("inlineCode",{parentName:"a"},"Disposable")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined"),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,i.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/mouse.ts#L15"},"src/base-types/mouse.ts:15")),(0,i.kt)("h2",{id:"accessors"},"Accessors"),(0,i.kt)("h3",{id:"position"},"position"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"position"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,i.kt)("p",null,"The real position of the mouse of the Three.js canvas."),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/mouse.ts#L24"},"src/base-types/mouse.ts:24")),(0,i.kt)("h2",{id:"methods"},"Methods"),(0,i.kt)("h3",{id:"dispose"},"dispose"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/mouse.ts#L34"},"src/base-types/mouse.ts:34")))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/addcbcd0.6b62de2c.js b/build/assets/js/addcbcd0.6b62de2c.js deleted file mode 100644 index 36feb75a..00000000 --- a/build/assets/js/addcbcd0.6b62de2c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6934],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>h});var a=t(7294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function p(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,a)}return t}function r(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var s=a.createContext({}),o=function(e){var n=a.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):r(r({},n),e)),t},m=function(e){var n=o(e.components);return a.createElement(s.Provider,{value:n},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},u=a.forwardRef((function(e,n){var t=e.components,i=e.mdxType,p=e.originalType,s=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),d=o(t),u=i,h=d["".concat(s,".").concat(u)]||d[u]||c[u]||p;return t?a.createElement(h,r(r({ref:n},m),{},{components:t})):a.createElement(h,r({ref:n},m))}));function h(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var p=t.length,r=new Array(p);r[0]=u;var l={};for(var s in n)hasOwnProperty.call(n,s)&&(l[s]=n[s]);l.originalType=e,l[d]="string"==typeof e?e:i,r[1]=l;for(var o=2;o{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>s,default:()=>h,frontMatter:()=>l,metadata:()=>o,toc:()=>d});var a=t(7462),i=t(3366),p=(t(7294),t(3905)),r=["components"],l={id:"openbim_components.BaseRenderer",title:"Class: BaseRenderer",sidebar_label:"BaseRenderer",custom_edit_url:null},s=void 0,o={unversionedId:"api/classes/openbim_components.BaseRenderer",id:"api/classes/openbim_components.BaseRenderer",title:"Class: BaseRenderer",description:"openbim-components.BaseRenderer",source:"@site/docs/api/classes/openbim_components.BaseRenderer.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.BaseRenderer",permalink:"/api/classes/openbim_components.BaseRenderer",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.BaseRenderer",title:"Class: BaseRenderer",sidebar_label:"BaseRenderer",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Serializer",permalink:"/api/classes/bim_fragment.Serializer"},next:{title:"CloudStorage",permalink:"/api/classes/openbim_components.CloudStorage"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"clippingPlanes",id:"clippingplanes",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"enabled",id:"enabled",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"onClippingPlanesUpdated",id:"onclippingplanesupdated",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"onResize",id:"onresize",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Methods",id:"methods",level:2},{value:"get",id:"get",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"getSize",id:"getsize",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"resize",id:"resize",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"togglePlane",id:"toggleplane",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"updateClippingPlanes",id:"updateclippingplanes",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-14",level:4}],c={toc:d},u="wrapper";function h(e){var n=e.components,t=(0,i.Z)(e,r);return(0,p.kt)(u,(0,a.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".BaseRenderer"),(0,p.kt)("p",null,"A base component for other components whose main mission is to render a\n",(0,p.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/scenes/Scene"},"scene"),"."),(0,p.kt)("p",null,(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"No Inherit Doc"))),(0,p.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("p",{parentName:"li"},(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,p.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"THREE.WebGLRenderer"),">"),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"BaseRenderer"))),(0,p.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleRenderer"))))),(0,p.kt)("h2",{id:"implements"},"Implements"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Resizeable"},(0,p.kt)("inlineCode",{parentName:"a"},"Resizeable")))),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"clippingplanes"},"clippingPlanes"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"clippingPlanes"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"Plane"),"[] = ",(0,p.kt)("inlineCode",{parentName:"p"},"[]")),(0,p.kt)("p",null,"The list of ",(0,p.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer.clippingPlanes"},"clipping planes")," used by this\ninstance of the renderer."),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-renderer.ts#L33"},"temp/engine_components/src/base-types/base-renderer.ts:33")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"enabled"},"enabled"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Abstract")," ",(0,p.kt)("strong",{parentName:"p"},"enabled"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("p",null,"Whether this component is active or not. The behaviour can vary depending\non the type of component. E.g. a disabled dimension tool will stop creating\ndimensions, while a disabled camera will stop moving. A disabled component\nwill not be updated automatically each frame."),(0,p.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L24"},"temp/engine_components/src/base-types/component.ts:24")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onclippingplanesupdated"},"onClippingPlanesUpdated"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onClippingPlanesUpdated"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,p.kt)("p",null,"Event that fires when there has been a change to the list of clipping\nplanes used by the active renderer."),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-renderer.ts#L27"},"temp/engine_components/src/base-types/base-renderer.ts:27")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onresize"},"onResize"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onResize"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#onresize"},"Resizeable.onResize")),(0,p.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#onresize"},"onResize")),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-renderer.ts#L21"},"temp/engine_components/src/base-types/base-renderer.ts:21")),(0,p.kt)("h2",{id:"methods"},"Methods"),(0,p.kt)("h3",{id:"get"},"get"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"get"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"...args"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"WebGLRenderer")),(0,p.kt)("p",null,"The core of the component. For instance, if it's a camera component, it\ncould be a ",(0,p.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/cameras/Camera"},"THREE.Camera"),"."),(0,p.kt)("h4",{id:"parameters"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"...args")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"any"))))),(0,p.kt)("h4",{id:"returns"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"WebGLRenderer")),(0,p.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,p.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L30"},"temp/engine_components/src/base-types/component.ts:30")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"getsize"},"getSize"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"getSize"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#getsize"},"Resizeable.getSize"),"."),(0,p.kt)("h4",{id:"returns-1"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,p.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#getsize"},"getSize")),(0,p.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-renderer.ts#L15"},"temp/engine_components/src/base-types/base-renderer.ts:15")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"hasui"},"hasUI"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,p.kt)("p",null,"Whether is component implements any kind of ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,p.kt)("h4",{id:"returns-2"},"Returns"),(0,p.kt)("p",null,"this is UI"),(0,p.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,p.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,p.kt)("h4",{id:"returns-3"},"Returns"),(0,p.kt)("p",null,"this is Configurable"),(0,p.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,p.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,p.kt)("h4",{id:"returns-4"},"Returns"),(0,p.kt)("p",null,"this is Disposable"),(0,p.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,p.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ishideable"},"isHideable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,p.kt)("h4",{id:"returns-5"},"Returns"),(0,p.kt)("p",null,"this is Hideable"),(0,p.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,p.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,p.kt)("h4",{id:"returns-6"},"Returns"),(0,p.kt)("p",null,"this is Resizeable"),(0,p.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,p.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,p.kt)("h4",{id:"returns-7"},"Returns"),(0,p.kt)("p",null,"this is Updateable"),(0,p.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,p.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"resize"},"resize"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"resize"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#resize"},"Resizeable.resize"),"."),(0,p.kt)("h4",{id:"returns-8"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#resize"},"resize")),(0,p.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-renderer.ts#L18"},"temp/engine_components/src/base-types/base-renderer.ts:18")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"toggleplane"},"togglePlane"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"togglePlane"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"active"),", ",(0,p.kt)("inlineCode",{parentName:"p"},"plane"),", ",(0,p.kt)("inlineCode",{parentName:"p"},"isLocal?"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,"Adds or removes a\n",(0,p.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer.clippingPlanes"},"clipping plane"),"\nto the renderer."),(0,p.kt)("h4",{id:"parameters-1"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"active")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"plane")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"Plane"))),(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"isLocal?")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,p.kt)("h4",{id:"returns-9"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-renderer.ts#L48"},"temp/engine_components/src/base-types/base-renderer.ts:48")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"updateclippingplanes"},"updateClippingPlanes"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"updateClippingPlanes"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,"Forces the update of the clipping planes and all components that depend\non them that are subscribed to ",(0,p.kt)("inlineCode",{parentName:"p"},"onClippingPlanesUpdated"),"."),(0,p.kt)("h4",{id:"returns-10"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-renderer.ts#L39"},"temp/engine_components/src/base-types/base-renderer.ts:39")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/addcbcd0.ce767441.js b/build/assets/js/addcbcd0.ce767441.js new file mode 100644 index 00000000..c2f8dc27 --- /dev/null +++ b/build/assets/js/addcbcd0.ce767441.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6934],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>h});var a=t(7294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,a)}return t}function p(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var s=a.createContext({}),o=function(e){var n=a.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):p(p({},n),e)),t},d=function(e){var n=o(e.components);return a.createElement(s.Provider,{value:n},e.children)},m="mdxType",c={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},u=a.forwardRef((function(e,n){var t=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),m=o(t),u=i,h=m["".concat(s,".").concat(u)]||m[u]||c[u]||r;return t?a.createElement(h,p(p({ref:n},d),{},{components:t})):a.createElement(h,p({ref:n},d))}));function h(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var r=t.length,p=new Array(r);p[0]=u;var l={};for(var s in n)hasOwnProperty.call(n,s)&&(l[s]=n[s]);l.originalType=e,l[m]="string"==typeof e?e:i,p[1]=l;for(var o=2;o{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>h,frontMatter:()=>l,metadata:()=>o,toc:()=>m});var a=t(7462),i=t(3366),r=(t(7294),t(3905)),p=["components"],l={id:"openbim_components.BaseRenderer",title:"Class: BaseRenderer",sidebar_label:"BaseRenderer",custom_edit_url:null},s=void 0,o={unversionedId:"api/classes/openbim_components.BaseRenderer",id:"api/classes/openbim_components.BaseRenderer",title:"Class: BaseRenderer",description:"openbim-components.BaseRenderer",source:"@site/docs/api/classes/openbim_components.BaseRenderer.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.BaseRenderer",permalink:"/api/classes/openbim_components.BaseRenderer",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.BaseRenderer",title:"Class: BaseRenderer",sidebar_label:"BaseRenderer",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"openbim-components",permalink:"/api/modules/openbim_components"},next:{title:"CloudStorage",permalink:"/api/classes/openbim_components.CloudStorage"}},d={},m=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"clippingPlanes",id:"clippingplanes",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"enabled",id:"enabled",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"onClippingPlanesUpdated",id:"onclippingplanesupdated",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"onResize",id:"onresize",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Methods",id:"methods",level:2},{value:"get",id:"get",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"getSize",id:"getsize",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"resize",id:"resize",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"togglePlane",id:"toggleplane",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"updateClippingPlanes",id:"updateclippingplanes",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-14",level:4}],c={toc:m},u="wrapper";function h(e){var n=e.components,t=(0,i.Z)(e,p);return(0,r.kt)(u,(0,a.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".BaseRenderer"),(0,r.kt)("p",null,"A base component for other components whose main mission is to render a\n",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/scenes/Scene"},"scene"),"."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"No Inherit Doc"))),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,r.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"THREE.WebGLRenderer"),">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"BaseRenderer"))),(0,r.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleRenderer"))))),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Resizeable"},(0,r.kt)("inlineCode",{parentName:"a"},"Resizeable")))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"clippingplanes"},"clippingPlanes"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"clippingPlanes"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Plane"),"[] = ",(0,r.kt)("inlineCode",{parentName:"p"},"[]")),(0,r.kt)("p",null,"The list of ",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer.clippingPlanes"},"clipping planes")," used by this\ninstance of the renderer."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-renderer.ts#L33"},"src/base-types/base-renderer.ts:33")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"enabled"},"enabled"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Abstract")," ",(0,r.kt)("strong",{parentName:"p"},"enabled"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Whether this component is active or not. The behaviour can vary depending\non the type of component. E.g. a disabled dimension tool will stop creating\ndimensions, while a disabled camera will stop moving. A disabled component\nwill not be updated automatically each frame."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L24"},"src/base-types/component.ts:24")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onclippingplanesupdated"},"onClippingPlanesUpdated"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onClippingPlanesUpdated"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,r.kt)("p",null,"Event that fires when there has been a change to the list of clipping\nplanes used by the active renderer."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-renderer.ts#L27"},"src/base-types/base-renderer.ts:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onresize"},"onResize"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onResize"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#onresize"},"Resizeable.onResize")),(0,r.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#onresize"},"onResize")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-renderer.ts#L21"},"src/base-types/base-renderer.ts:21")),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"get"},"get"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"get"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"...args"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"WebGLRenderer")),(0,r.kt)("p",null,"The core of the component. For instance, if it's a camera component, it\ncould be a ",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/cameras/Camera"},"THREE.Camera"),"."),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"...args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"WebGLRenderer")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L30"},"src/base-types/component.ts:30")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsize"},"getSize"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSize"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#getsize"},"Resizeable.getSize"),"."),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,r.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#getsize"},"getSize")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-renderer.ts#L15"},"src/base-types/base-renderer.ts:15")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hasui"},"hasUI"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,r.kt)("p",null,"Whether is component implements any kind of ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,"this is UI"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,"this is Configurable"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,"this is Disposable"),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ishideable"},"isHideable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,"this is Hideable"),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,"this is Resizeable"),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,"this is Updateable"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"resize"},"resize"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"resize"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#resize"},"Resizeable.resize"),"."),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#resize"},"resize")),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-renderer.ts#L18"},"src/base-types/base-renderer.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"toggleplane"},"togglePlane"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"togglePlane"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"active"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"plane"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"isLocal?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Adds or removes a\n",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer.clippingPlanes"},"clipping plane"),"\nto the renderer."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"active")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"plane")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Plane"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isLocal?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-renderer.ts#L48"},"src/base-types/base-renderer.ts:48")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"updateclippingplanes"},"updateClippingPlanes"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"updateClippingPlanes"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Forces the update of the clipping planes and all components that depend\non them that are subscribed to ",(0,r.kt)("inlineCode",{parentName:"p"},"onClippingPlanesUpdated"),"."),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-renderer.ts#L39"},"src/base-types/base-renderer.ts:39")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/afcc017a.0a88a249.js b/build/assets/js/afcc017a.f9aec6e8.js similarity index 86% rename from build/assets/js/afcc017a.0a88a249.js rename to build/assets/js/afcc017a.f9aec6e8.js index 77d0ed98..c3534cc9 100644 --- a/build/assets/js/afcc017a.0a88a249.js +++ b/build/assets/js/afcc017a.f9aec6e8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5825],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>d});var r=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var p=r.createContext({}),l=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},c=function(e){var t=l(e.components);return r.createElement(p.Provider,{value:t},e.children)},u="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,p=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),u=l(n),f=o,d=u["".concat(p,".").concat(f)]||u[f]||m[f]||i;return n?r.createElement(d,a(a({ref:t},c),{},{components:n})):r.createElement(d,a({ref:t},c))}));function d(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,a=new Array(i);a[0]=f;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[u]="string"==typeof e?e:o,a[1]=s;for(var l=2;l{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>p,default:()=>d,frontMatter:()=>s,metadata:()=>l,toc:()=>u});var r=n(7462),o=n(3366),i=(n(7294),n(3905)),a=["components"],s={id:"openbim_components.Progress",title:"Interface: Progress",sidebar_label:"Progress",custom_edit_url:null},p=void 0,l={unversionedId:"api/interfaces/openbim_components.Progress",id:"api/interfaces/openbim_components.Progress",title:"Interface: Progress",description:"openbim-components.Progress",source:"@site/docs/api/interfaces/openbim_components.Progress.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/openbim_components.Progress",permalink:"/api/interfaces/openbim_components.Progress",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Progress",title:"Interface: Progress",sidebar_label:"Progress",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"NavigationMode",permalink:"/api/interfaces/openbim_components.NavigationMode"},next:{title:"Resizeable",permalink:"/api/interfaces/openbim_components.Resizeable"}},c={},u=[{value:"Properties",id:"properties",level:2},{value:"current",id:"current",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"total",id:"total",level:3},{value:"Defined in",id:"defined-in-1",level:4}],m={toc:u},f="wrapper";function d(e){var t=e.components,n=(0,o.Z)(e,a);return(0,i.kt)(f,(0,r.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Progress"),(0,i.kt)("p",null,"Basic type to describe the progress of any kind of process."),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"current"},"current"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"current"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The amount of things that have been done already."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L124"},"temp/engine_components/src/base-types/base-types.ts:124")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"total"},"total"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"total"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The total amount of things to be done by the process."),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L127"},"temp/engine_components/src/base-types/base-types.ts:127")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5825],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>d});var r=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var p=r.createContext({}),l=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},c=function(e){var t=l(e.components);return r.createElement(p.Provider,{value:t},e.children)},u="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,p=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),u=l(n),f=o,d=u["".concat(p,".").concat(f)]||u[f]||m[f]||i;return n?r.createElement(d,a(a({ref:t},c),{},{components:n})):r.createElement(d,a({ref:t},c))}));function d(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,a=new Array(i);a[0]=f;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[u]="string"==typeof e?e:o,a[1]=s;for(var l=2;l{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>p,default:()=>d,frontMatter:()=>s,metadata:()=>l,toc:()=>u});var r=n(7462),o=n(3366),i=(n(7294),n(3905)),a=["components"],s={id:"openbim_components.Progress",title:"Interface: Progress",sidebar_label:"Progress",custom_edit_url:null},p=void 0,l={unversionedId:"api/interfaces/openbim_components.Progress",id:"api/interfaces/openbim_components.Progress",title:"Interface: Progress",description:"openbim-components.Progress",source:"@site/docs/api/interfaces/openbim_components.Progress.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/openbim_components.Progress",permalink:"/api/interfaces/openbim_components.Progress",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Progress",title:"Interface: Progress",sidebar_label:"Progress",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"NavigationMode",permalink:"/api/interfaces/openbim_components.NavigationMode"},next:{title:"Resizeable",permalink:"/api/interfaces/openbim_components.Resizeable"}},c={},u=[{value:"Properties",id:"properties",level:2},{value:"current",id:"current",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"total",id:"total",level:3},{value:"Defined in",id:"defined-in-1",level:4}],m={toc:u},f="wrapper";function d(e){var t=e.components,n=(0,o.Z)(e,a);return(0,i.kt)(f,(0,r.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Progress"),(0,i.kt)("p",null,"Basic type to describe the progress of any kind of process."),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"current"},"current"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"current"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The amount of things that have been done already."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L124"},"src/base-types/base-types.ts:124")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"total"},"total"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"total"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The total amount of things to be done by the process."),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L127"},"src/base-types/base-types.ts:127")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/b013f614.bb0ac32e.js b/build/assets/js/b013f614.bb0ac32e.js deleted file mode 100644 index 0ea78d6e..00000000 --- a/build/assets/js/b013f614.bb0ac32e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4829],{3905:(e,r,t)=>{t.d(r,{Zo:()=>p,kt:()=>b});var n=t(7294);function a(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}function i(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function o(e){for(var r=1;r=0||(a[t]=e[t]);return a}(e,r);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=n.createContext({}),c=function(e){var r=n.useContext(s),t=r;return e&&(t="function"==typeof e?e(r):o(o({},r),e)),t},p=function(e){var r=c(e.components);return n.createElement(s.Provider,{value:r},e.children)},m="mdxType",u={inlineCode:"code",wrapper:function(e){var r=e.children;return n.createElement(n.Fragment,{},r)}},f=n.forwardRef((function(e,r){var t=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),m=c(t),f=a,b=m["".concat(s,".").concat(f)]||m[f]||u[f]||i;return t?n.createElement(b,o(o({ref:r},p),{},{components:t})):n.createElement(b,o({ref:r},p))}));function b(e,r){var t=arguments,a=r&&r.mdxType;if("string"==typeof e||a){var i=t.length,o=new Array(i);o[0]=f;var l={};for(var s in r)hasOwnProperty.call(r,s)&&(l[s]=r[s]);l.originalType=e,l[m]="string"==typeof e?e:a,o[1]=l;for(var c=2;c{t.r(r),t.d(r,{assets:()=>p,contentTitle:()=>s,default:()=>b,frontMatter:()=>l,metadata:()=>c,toc:()=>m});var n=t(7462),a=t(3366),i=(t(7294),t(3905)),o=["components"],l={id:"bim_fragment.Serializer",title:"Class: Serializer",sidebar_label:"Serializer",custom_edit_url:null},s=void 0,c={unversionedId:"api/classes/bim_fragment.Serializer",id:"api/classes/bim_fragment.Serializer",title:"Class: Serializer",description:"bim-fragment.Serializer",source:"@site/docs/api/classes/bim_fragment.Serializer.md",sourceDirName:"api/classes",slug:"/api/classes/bim_fragment.Serializer",permalink:"/api/classes/bim_fragment.Serializer",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"bim_fragment.Serializer",title:"Class: Serializer",sidebar_label:"Serializer",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"openbim-components",permalink:"/api/modules/openbim_components"},next:{title:"BaseRenderer",permalink:"/api/classes/openbim_components.BaseRenderer"}},p={},m=[],u={toc:m},f="wrapper";function b(e){var r=e.components,t=(0,a.Z)(e,o);return(0,i.kt)(f,(0,n.Z)({},u,t,{components:r,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/modules/bim_fragment"},"bim-fragment"),".Serializer"),(0,i.kt)("p",null,"Object to export and import sets of fragments efficiently using the library\n",(0,i.kt)("a",{parentName:"p",href:"https://flatbuffers.dev/"},"flatbuffers"),"."))}b.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/b67f8c3e.f8588bb2.js b/build/assets/js/b67f8c3e.171809c2.js similarity index 83% rename from build/assets/js/b67f8c3e.f8588bb2.js rename to build/assets/js/b67f8c3e.171809c2.js index fc75c0ac..de94bb54 100644 --- a/build/assets/js/b67f8c3e.f8588bb2.js +++ b/build/assets/js/b67f8c3e.171809c2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1613],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>d});var a=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var l=a.createContext({}),p=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},c=function(e){var t=p(e.components);return a.createElement(l.Provider,{value:t},e.children)},m="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var n=e.components,o=e.mdxType,r=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),m=p(n),h=o,d=m["".concat(l,".").concat(h)]||m[h]||u[h]||r;return n?a.createElement(d,i(i({ref:t},c),{},{components:n})):a.createElement(d,i({ref:t},c))}));function d(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var r=n.length,i=new Array(r);i[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[m]="string"==typeof e?e:o,i[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>d,frontMatter:()=>s,metadata:()=>p,toc:()=>m});var a=n(7462),o=n(3366),r=(n(7294),n(3905)),i=["components"],s={},l=void 0,p={unversionedId:"Tutorials/SimpleScene",id:"Tutorials/SimpleScene",title:"SimpleScene",description:"\ud83c\udf0d Let's create a 3D world!",source:"@site/docs/Tutorials/SimpleScene.mdx",sourceDirName:"Tutorials",slug:"/Tutorials/SimpleScene",permalink:"/Tutorials/SimpleScene",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"SimpleRaycaster",permalink:"/Tutorials/SimpleRaycaster"},next:{title:"ToolsComponent",permalink:"/Tutorials/ToolsComponent"}},c={},m=[{value:"\ud83c\udf0d Let's create a 3D world!",id:"-lets-create-a-3d-world",level:3},{value:"\ud83e\uddf0 Setting up a components project",id:"-setting-up-a-components-project",level:3},{value:"\ud83c\udfa5 Adjusting scene and camera",id:"-adjusting-scene-and-camera",level:3},{value:"\ud83c\udfc0 Adding some 3D objects",id:"-adding-some-3d-objects",level:3},{value:"\ud83d\udd26 Lighting things up",id:"-lighting-things-up",level:3},{value:"\ud83e\uddf9 Cleaning up",id:"-cleaning-up",level:3}],u={toc:m},h="wrapper";function d(e){var t=e.components,n=(0,o.Z)(e,i);return(0,r.kt)(h,(0,a.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h3",{id:"-lets-create-a-3d-world"},"\ud83c\udf0d Let's create a 3D world!"),(0,r.kt)("hr",null),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"SimpleScene")," component is the easiest way to create a 3D space to start working.\nLet's start by importing Components and Three.js:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"import * as THREE from 'three';\nimport * as OBC from 'openbim-components';\n")),(0,r.kt)("p",null,"Now, the first step is getting a container for our viewer. \ud83d\udce6\nThis is just a place where the 3D scene will be rendered.\nIn this example we have just added an HTML ",(0,r.kt)("inlineCode",{parentName:"p"},"div")," element with\nthe ID ",(0,r.kt)("inlineCode",{parentName:"p"},'"container"'),"."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const container = document.getElementById('container');\n")),(0,r.kt)("p",null,"Now, let's create an awesome 3D scene inside that HTML element! \ud83d\udd25"),(0,r.kt)("admonition",{title:"Are you using a library/framework like React, Angular or vue?",type:"info"},(0,r.kt)("p",{parentName:"admonition"},"Then probably you have other mechanisms for getting a reference to the\nHTML div element. However you do it, as long as you get a reference\nin your code, you are good to go!")),(0,r.kt)("h3",{id:"-setting-up-a-components-project"},"\ud83e\uddf0 Setting up a components project"),(0,r.kt)("hr",null),(0,r.kt)("p",null,"Next, we will instantiate the main object of the library: ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("a",{parentName:"strong",href:"../api/classes/components.Components"},"Components")),". \ud83e\udd16\nThis object will keep track of all the components that you create, making them\neasily accessible in all your application and making sure to update them\nin each frame, so you don't have to worry about that. \ud83d\udcaa"),(0,r.kt)("admonition",{title:"The minimum components application",type:"danger"},(0,r.kt)("p",{parentName:"admonition"},"Any components app needs 4 things to work:"),(0,r.kt)("ul",{parentName:"admonition"},(0,r.kt)("li",{parentName:"ul"},"\ud83c\udf0d A ",(0,r.kt)("strong",{parentName:"li"},(0,r.kt)("a",{parentName:"strong",href:"../api/classes/components.SimpleScene"},"scene component"))," where our objects will live in 3D."),(0,r.kt)("li",{parentName:"ul"},"\u231a A ",(0,r.kt)("strong",{parentName:"li"},(0,r.kt)("a",{parentName:"strong",href:"../api/classes/components.SimpleRenderer"},"renderer component"))," that allows us to see things moving around."),(0,r.kt)("li",{parentName:"ul"},"\ud83c\udfa5 A ",(0,r.kt)("strong",{parentName:"li"},(0,r.kt)("a",{parentName:"strong",href:"../api/classes/components.SimpleCamera"},"camera component"))," that defines where we are and in that 3D world."),(0,r.kt)("li",{parentName:"ul"},"\u26a1 A ",(0,r.kt)("strong",{parentName:"li"},(0,r.kt)("a",{parentName:"strong",href:"../api/classes/components.SimpleRaycaster"},"raycaster component"))," that makes it possible to interact with\nthat 3D scene with our mouse / touch."))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const components = new OBC.Components();\ncomponents.scene = new OBC.SimpleScene(components);\ncomponents.renderer = new OBC.SimpleRenderer(components, container);\ncomponents.camera = new OBC.SimpleCamera(components);\ncomponents.raycaster = new OBC.SimpleRaycaster(components);\n")),(0,r.kt)("p",null,"Now that everything is set up, let's start the app! You can do that with the ",(0,r.kt)("inlineCode",{parentName:"p"},"init")," method.\nIt will start updating all the components at 60 fps, so that you don't have to worry about the\nanimation loop: \ud83d\ude97\ud83d\udca8\ud83d\udca8\ud83d\udca8"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"components.init();\n")),(0,r.kt)("p",null,"And that's it! You already have set up 3D scene that can run on any device. Easy, right? \ud83e\udd73 But right now or scene\nis not very interesting, as it's only a infinite white void. Let's add some things to it! First, we need a reference\nto the scene, which you can get with the ",(0,r.kt)("inlineCode",{parentName:"p"},"get()")," method. This method is present in all the components and is used to\nget the core of the component. We can do it like this:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const scene = components.scene.get();\n")),(0,r.kt)("h3",{id:"-adjusting-scene-and-camera"},"\ud83c\udfa5 Adjusting scene and camera"),(0,r.kt)("hr",null),(0,r.kt)("p",null,"Great! Now we will locate the camera in a nice starting position. We can control the ",(0,r.kt)("inlineCode",{parentName:"p"},"SimpleCamera")," component through its\n",(0,r.kt)("inlineCode",{parentName:"p"},"controls")," attribute. This object is an instance of the ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/yomotsu/camera-controls"},"camera-controls"),"\nlibrary, which makes it super easy to control the camera in our 3D scene. We will set the position of the camera\nto ",(0,r.kt)("inlineCode",{parentName:"p"},"[10, 10, 10]")," and make it look at the origin (",(0,r.kt)("inlineCode",{parentName:"p"},"[0, 0, 0]"),")."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"components.camera.controls.setLookAt(10, 10, 10, 0, 0, 0);\n")),(0,r.kt)("h3",{id:"-adding-some-3d-objects"},"\ud83c\udfc0 Adding some 3D objects"),(0,r.kt)("hr",null),(0,r.kt)("p",null,"Awesome! We are now ready to start adding some objects. First, we will add a\n",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("a",{parentName:"strong",href:"../api/classes/components.SimpleGrid"},"simple grid component")),". As the name implies, this component adds a simple\n2D grid to the scene that we can use as a reference."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const grid = new OBC.SimpleGrid(components);\n")),(0,r.kt)("p",null,"\ud83d\ude80 Also, let's add some real geometry to our small 3D app. All the components are built on top of\n",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/"},"Three.js"),", which means that Three.js code will work natively with them.\nThis is great, because you can easily integrate components with any 3D app that you create.\nLet's try it by adding a simple cube:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const boxMaterial = new THREE.MeshStandardMaterial({ color: '#6528D7' });\nconst boxGeometry = new THREE.BoxGeometry(3, 3, 3);\nconst cube = new THREE.Mesh(boxGeometry, boxMaterial);\ncube.position.set(0, 1.5, 0);\nscene.add(cube);\n")),(0,r.kt)("h3",{id:"-lighting-things-up"},"\ud83d\udd26 Lighting things up"),(0,r.kt)("hr",null),(0,r.kt)("p",null,"Of course, everything is black because we have no lights! Let's fix it by adding some basic illumination:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"components.scene.setup();\n")),(0,r.kt)("h3",{id:"-cleaning-up"},"\ud83e\uddf9 Cleaning up"),(0,r.kt)("hr",null),(0,r.kt)("p",null,"As you might now, JavaScript has an automatic garbage collector that gets rid of the variables that you are no longer\nusing. Unfortunately, that's not the case for\n",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#manual/en/introduction/How-to-dispose-of-objects"},"Three.js"),". But don't worry: components\ntakes care of this for you. When you are finished working with a ",(0,r.kt)("inlineCode",{parentName:"p"},"Components")," instance, simply call\n",(0,r.kt)("inlineCode",{parentName:"p"},"components.dispose()")," and we will clean everything up for you!"),(0,r.kt)("admonition",{title:"Watch your variables!",type:"caution"},(0,r.kt)("p",{parentName:"admonition"},"When you dispose the memory, make sure that you don't have any object or array referencing anything inside the\n",(0,r.kt)("inlineCode",{parentName:"p"},"Components")," instance or this won't work, because JavaScript will detect that you are still using it!")),(0,r.kt)("admonition",{title:"Using React, Angular, Vue...?",type:"tip"},(0,r.kt)("p",{parentName:"admonition"},"This topic is especially relevant in Single Page Application technologies because they never reload the page (which\nwould release all the memory automatically). If you are using some of these, make sure that you set up the disposing\nlogic to fire when you re-render the component that has the 3D app.")),(0,r.kt)("p",null,"And voil\xe0! You have made your first 3D application using components. Easy, right? Of course, this is still far from a\nfull-fledged BIM app, but don't worry! Keep following our tutorials and your app will go from zero to hero in no time! \ud83d\ude80"),(0,r.kt)("iframe",{src:"https://thatopen.github.io/engine_components/src/core/SimpleScene/index.html"}))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1613],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>d});var a=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var l=a.createContext({}),p=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},c=function(e){var t=p(e.components);return a.createElement(l.Provider,{value:t},e.children)},m="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var n=e.components,o=e.mdxType,r=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),m=p(n),h=o,d=m["".concat(l,".").concat(h)]||m[h]||u[h]||r;return n?a.createElement(d,i(i({ref:t},c),{},{components:n})):a.createElement(d,i({ref:t},c))}));function d(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var r=n.length,i=new Array(r);i[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[m]="string"==typeof e?e:o,i[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>d,frontMatter:()=>s,metadata:()=>p,toc:()=>m});var a=n(7462),o=n(3366),r=(n(7294),n(3905)),i=["components"],s={},l=void 0,p={unversionedId:"Tutorials/SimpleScene",id:"Tutorials/SimpleScene",title:"SimpleScene",description:"\ud83c\udf0d Let's create a 3D world!",source:"@site/docs/Tutorials/SimpleScene.mdx",sourceDirName:"Tutorials",slug:"/Tutorials/SimpleScene",permalink:"/Tutorials/SimpleScene",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"SimpleRaycaster",permalink:"/Tutorials/SimpleRaycaster"},next:{title:"ToolsComponent",permalink:"/Tutorials/ToolsComponent"}},c={},m=[{value:"\ud83c\udf0d Let's create a 3D world!",id:"-lets-create-a-3d-world",level:3},{value:"\ud83e\uddf0 Setting up a components project",id:"-setting-up-a-components-project",level:3},{value:"\ud83c\udfa5 Adjusting scene and camera",id:"-adjusting-scene-and-camera",level:3},{value:"\ud83c\udfc0 Adding some 3D objects",id:"-adding-some-3d-objects",level:3},{value:"\ud83d\udd26 Lighting things up",id:"-lighting-things-up",level:3},{value:"\ud83e\uddf9 Cleaning up",id:"-cleaning-up",level:3}],u={toc:m},h="wrapper";function d(e){var t=e.components,n=(0,o.Z)(e,i);return(0,r.kt)(h,(0,a.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h3",{id:"-lets-create-a-3d-world"},"\ud83c\udf0d Let's create a 3D world!"),(0,r.kt)("hr",null),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"SimpleScene")," component is the easiest way to create a 3D space to start working.\nLet's start by importing Components and Three.js:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"import * as THREE from 'three';\nimport * as OBC from 'openbim-components';\n")),(0,r.kt)("p",null,"Now, the first step is getting a container for our viewer. \ud83d\udce6\nThis is just a place where the 3D scene will be rendered.\nIn this example we have just added an HTML ",(0,r.kt)("inlineCode",{parentName:"p"},"div")," element with\nthe ID ",(0,r.kt)("inlineCode",{parentName:"p"},'"container"'),"."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const container = document.getElementById('container');\n")),(0,r.kt)("p",null,"Now, let's create an awesome 3D scene inside that HTML element! \ud83d\udd25"),(0,r.kt)("admonition",{title:"Are you using a library/framework like React, Angular or vue?",type:"info"},(0,r.kt)("p",{parentName:"admonition"},"Then probably you have other mechanisms for getting a reference to the\nHTML div element. However you do it, as long as you get a reference\nin your code, you are good to go!")),(0,r.kt)("h3",{id:"-setting-up-a-components-project"},"\ud83e\uddf0 Setting up a components project"),(0,r.kt)("hr",null),(0,r.kt)("p",null,"Next, we will instantiate the main object of the library: ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("a",{parentName:"strong",href:"../api/classes/components.Components"},"Components")),". \ud83e\udd16\nThis object will keep track of all the components that you create, making them\neasily accessible in all your application and making sure to update them\nin each frame, so you don't have to worry about that. \ud83d\udcaa"),(0,r.kt)("admonition",{title:"The minimum components application",type:"danger"},(0,r.kt)("p",{parentName:"admonition"},"Any components app needs 4 things to work:"),(0,r.kt)("ul",{parentName:"admonition"},(0,r.kt)("li",{parentName:"ul"},"\ud83c\udf0d A ",(0,r.kt)("strong",{parentName:"li"},(0,r.kt)("a",{parentName:"strong",href:"../api/classes/components.SimpleScene"},"scene component"))," where our objects will live in 3D."),(0,r.kt)("li",{parentName:"ul"},"\u231a A ",(0,r.kt)("strong",{parentName:"li"},(0,r.kt)("a",{parentName:"strong",href:"../api/classes/components.SimpleRenderer"},"renderer component"))," that allows us to see things moving around."),(0,r.kt)("li",{parentName:"ul"},"\ud83c\udfa5 A ",(0,r.kt)("strong",{parentName:"li"},(0,r.kt)("a",{parentName:"strong",href:"../api/classes/components.SimpleCamera"},"camera component"))," that defines where we are and in that 3D world."),(0,r.kt)("li",{parentName:"ul"},"\u26a1 A ",(0,r.kt)("strong",{parentName:"li"},(0,r.kt)("a",{parentName:"strong",href:"../api/classes/components.SimpleRaycaster"},"raycaster component"))," that makes it possible to interact with\nthat 3D scene with our mouse / touch."))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const components = new OBC.Components();\ncomponents.scene = new OBC.SimpleScene(components);\ncomponents.renderer = new OBC.SimpleRenderer(components, container);\ncomponents.camera = new OBC.SimpleCamera(components);\ncomponents.raycaster = new OBC.SimpleRaycaster(components);\n")),(0,r.kt)("p",null,"Now that everything is set up, let's start the app! You can do that with the ",(0,r.kt)("inlineCode",{parentName:"p"},"init")," method.\nIt will start updating all the components at 60 fps, so that you don't have to worry about the\nanimation loop: \ud83d\ude97\ud83d\udca8\ud83d\udca8\ud83d\udca8"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"components.init();\n")),(0,r.kt)("p",null,"And that's it! You already have set up 3D scene that can run on any device. Easy, right? \ud83e\udd73 But right now or scene\nis not very interesting, as it's only a infinite white void. Let's add some things to it! First, we need a reference\nto the scene, which you can get with the ",(0,r.kt)("inlineCode",{parentName:"p"},"get()")," method. This method is present in all the components and is used to\nget the core of the component. We can do it like this:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const scene = components.scene.get();\n")),(0,r.kt)("h3",{id:"-adjusting-scene-and-camera"},"\ud83c\udfa5 Adjusting scene and camera"),(0,r.kt)("hr",null),(0,r.kt)("p",null,"Great! Now we will locate the camera in a nice starting position. We can control the ",(0,r.kt)("inlineCode",{parentName:"p"},"SimpleCamera")," component through its\n",(0,r.kt)("inlineCode",{parentName:"p"},"controls")," attribute. This object is an instance of the ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/yomotsu/camera-controls"},"camera-controls"),"\nlibrary, which makes it super easy to control the camera in our 3D scene. We will set the position of the camera\nto ",(0,r.kt)("inlineCode",{parentName:"p"},"[10, 10, 10]")," and make it look at the origin (",(0,r.kt)("inlineCode",{parentName:"p"},"[0, 0, 0]"),")."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"components.camera.controls.setLookAt(10, 10, 10, 0, 0, 0);\n")),(0,r.kt)("h3",{id:"-adding-some-3d-objects"},"\ud83c\udfc0 Adding some 3D objects"),(0,r.kt)("hr",null),(0,r.kt)("p",null,"Awesome! We are now ready to start adding some objects. First, we will add a\n",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("a",{parentName:"strong",href:"../api/classes/components.SimpleGrid"},"simple grid component")),". As the name implies, this component adds a simple\n2D grid to the scene that we can use as a reference."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const grid = new OBC.SimpleGrid(components);\n")),(0,r.kt)("p",null,"\ud83d\ude80 Also, let's add some real geometry to our small 3D app. All the components are built on top of\n",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/"},"Three.js"),", which means that Three.js code will work natively with them.\nThis is great, because you can easily integrate components with any 3D app that you create.\nLet's try it by adding a simple cube:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const boxMaterial = new THREE.MeshStandardMaterial({ color: '#6528D7' });\nconst boxGeometry = new THREE.BoxGeometry(3, 3, 3);\nconst cube = new THREE.Mesh(boxGeometry, boxMaterial);\ncube.position.set(0, 1.5, 0);\nscene.add(cube);\n")),(0,r.kt)("h3",{id:"-lighting-things-up"},"\ud83d\udd26 Lighting things up"),(0,r.kt)("hr",null),(0,r.kt)("p",null,"Of course, everything is black because we have no lights! Let's fix it by adding some basic illumination:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"components.scene.setup();\nconst label = new OBC.Simple2DMarker(components);\nlabel.get().position.set(0, 4, 0);\nlabel.get().element.textContent = 'Hello, Components!';\nlabel.get().element.addEventListener('pointerdown', () => {\nconsole.log('Hello, Components!');\n});\n")),(0,r.kt)("h3",{id:"-cleaning-up"},"\ud83e\uddf9 Cleaning up"),(0,r.kt)("hr",null),(0,r.kt)("p",null,"As you might now, JavaScript has an automatic garbage collector that gets rid of the variables that you are no longer\nusing. Unfortunately, that's not the case for\n",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#manual/en/introduction/How-to-dispose-of-objects"},"Three.js"),". But don't worry: components\ntakes care of this for you. When you are finished working with a ",(0,r.kt)("inlineCode",{parentName:"p"},"Components")," instance, simply call\n",(0,r.kt)("inlineCode",{parentName:"p"},"components.dispose()")," and we will clean everything up for you!"),(0,r.kt)("admonition",{title:"Watch your variables!",type:"caution"},(0,r.kt)("p",{parentName:"admonition"},"When you dispose the memory, make sure that you don't have any object or array referencing anything inside the\n",(0,r.kt)("inlineCode",{parentName:"p"},"Components")," instance or this won't work, because JavaScript will detect that you are still using it!")),(0,r.kt)("admonition",{title:"Using React, Angular, Vue...?",type:"tip"},(0,r.kt)("p",{parentName:"admonition"},"This topic is especially relevant in Single Page Application technologies because they never reload the page (which\nwould release all the memory automatically). If you are using some of these, make sure that you set up the disposing\nlogic to fire when you re-render the component that has the 3D app.")),(0,r.kt)("p",null,"And voil\xe0! You have made your first 3D application using components. Easy, right? Of course, this is still far from a\nfull-fledged BIM app, but don't worry! Keep following our tutorials and your app will go from zero to hero in no time! \ud83d\ude80"),(0,r.kt)("iframe",{src:"https://thatopen.github.io/engine_components/src/core/SimpleScene/index.html"}))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/b82b585f.8ddc666c.js b/build/assets/js/b82b585f.8ddc666c.js deleted file mode 100644 index d7d2b398..00000000 --- a/build/assets/js/b82b585f.8ddc666c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[215],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>k});var a=t(7294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function p(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,a)}return t}function r(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var l=a.createContext({}),s=function(e){var n=a.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):r(r({},n),e)),t},m=function(e){var n=s(e.components);return a.createElement(l.Provider,{value:n},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},u=a.forwardRef((function(e,n){var t=e.components,i=e.mdxType,p=e.originalType,l=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),d=s(t),u=i,k=d["".concat(l,".").concat(u)]||d[u]||c[u]||p;return t?a.createElement(k,r(r({ref:n},m),{},{components:t})):a.createElement(k,r({ref:n},m))}));function k(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var p=t.length,r=new Array(p);r[0]=u;var o={};for(var l in n)hasOwnProperty.call(n,l)&&(o[l]=n[l]);o.originalType=e,o[d]="string"==typeof e?e:i,r[1]=o;for(var s=2;s{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>l,default:()=>k,frontMatter:()=>o,metadata:()=>s,toc:()=>d});var a=t(7462),i=t(3366),p=(t(7294),t(3905)),r=["components"],o={id:"openbim_components.SimpleCamera",title:"Class: SimpleCamera",sidebar_label:"SimpleCamera",custom_edit_url:null},l=void 0,s={unversionedId:"api/classes/openbim_components.SimpleCamera",id:"api/classes/openbim_components.SimpleCamera",title:"Class: SimpleCamera",description:"openbim-components.SimpleCamera",source:"@site/docs/api/classes/openbim_components.SimpleCamera.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.SimpleCamera",permalink:"/api/classes/openbim_components.SimpleCamera",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.SimpleCamera",title:"Class: SimpleCamera",sidebar_label:"SimpleCamera",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Simple2DScene",permalink:"/api/classes/openbim_components.Simple2DScene"},next:{title:"SimpleClipper",permalink:"/api/classes/openbim_components.SimpleClipper"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"activeCamera",id:"activecamera",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"controls",id:"controls",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"onAfterUpdate",id:"onafterupdate",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onBeforeUpdate",id:"onbeforeupdate",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Accessors",id:"accessors",level:2},{value:"enabled",id:"enabled",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"update",id:"update",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Implementation of",id:"implementation-of-4",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"updateAspect",id:"updateaspect",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-16",level:4}],c={toc:d},u="wrapper";function k(e){var n=e.components,t=(0,i.Z)(e,r);return(0,p.kt)(u,(0,a.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".SimpleCamera"),(0,p.kt)("p",null,"A basic camera that uses\n",(0,p.kt)("a",{parentName:"p",href:"https://github.com/yomotsu/camera-controls"},"yomotsu's cameracontrols")," to\neasily control the camera in 2D and 3D. Check out it's API to find out\nwhat features it offers."),(0,p.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("p",{parentName:"li"},(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,p.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"THREE.PerspectiveCamera")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"THREE.OrthographicCamera"),">"),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"SimpleCamera"))),(0,p.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.OrthoPerspectiveCamera"},(0,p.kt)("inlineCode",{parentName:"a"},"OrthoPerspectiveCamera"))))),(0,p.kt)("h2",{id:"implements"},"Implements"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Updateable"},(0,p.kt)("inlineCode",{parentName:"a"},"Updateable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,p.kt)("inlineCode",{parentName:"a"},"Disposable")))),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"activecamera"},"activeCamera"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"activeCamera"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"PerspectiveCamera")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,p.kt)("p",null,"The camera that is being used now according to the current ",(0,p.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection"),"."),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleCamera/index.ts#L48"},"temp/engine_components/src/core/SimpleCamera/index.ts:48")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"controls"},"controls"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"controls"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"CameraControls")),(0,p.kt)("p",null,"The object that controls the camera. An instance of\n",(0,p.kt)("a",{parentName:"p",href:"https://github.com/yomotsu/camera-controls"},"yomotsu's cameracontrols"),".\nTransforming the camera directly will have no effect: you need to use this\nobject to move, rotate, look at objects, etc."),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleCamera/index.ts#L33"},"temp/engine_components/src/core/SimpleCamera/index.ts:33")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleCamera")),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"Updateable.onAfterUpdate")),(0,p.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"onAfterUpdate")),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleCamera/index.ts#L20"},"temp/engine_components/src/core/SimpleCamera/index.ts:20")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleCamera")),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"Updateable.onBeforeUpdate")),(0,p.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"onBeforeUpdate")),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleCamera/index.ts#L17"},"temp/engine_components/src/core/SimpleCamera/index.ts:17")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,p.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,p.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleCamera/index.ts#L25"},"temp/engine_components/src/core/SimpleCamera/index.ts:25")),(0,p.kt)("h2",{id:"accessors"},"Accessors"),(0,p.kt)("h3",{id:"enabled"},"enabled"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"enabled"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,p.kt)("h4",{id:"returns"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("h4",{id:"overrides"},"Overrides"),(0,p.kt)("p",null,"Component.enabled"),(0,p.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleCamera/index.ts#L36"},"temp/engine_components/src/core/SimpleCamera/index.ts:36")),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"enabled"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"enabled"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,p.kt)("h4",{id:"parameters"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"enabled")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,p.kt)("h4",{id:"returns-1"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"overrides-1"},"Overrides"),(0,p.kt)("p",null,"Component.enabled"),(0,p.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleCamera/index.ts#L41"},"temp/engine_components/src/core/SimpleCamera/index.ts:41")),(0,p.kt)("h2",{id:"methods"},"Methods"),(0,p.kt)("h3",{id:"dispose"},"dispose"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,p.kt)("h4",{id:"returns-2"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,p.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleCamera/index.ts#L68"},"temp/engine_components/src/core/SimpleCamera/index.ts:68")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"get"},"get"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"get"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"PerspectiveCamera")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,p.kt)("h4",{id:"returns-3"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"PerspectiveCamera")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,p.kt)("h4",{id:"overrides-2"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,p.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleCamera/index.ts#L63"},"temp/engine_components/src/core/SimpleCamera/index.ts:63")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"hasui"},"hasUI"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,p.kt)("p",null,"Whether is component implements any kind of ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,p.kt)("h4",{id:"returns-4"},"Returns"),(0,p.kt)("p",null,"this is UI"),(0,p.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,p.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,p.kt)("h4",{id:"returns-5"},"Returns"),(0,p.kt)("p",null,"this is Configurable"),(0,p.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,p.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,p.kt)("h4",{id:"returns-6"},"Returns"),(0,p.kt)("p",null,"this is Disposable"),(0,p.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,p.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ishideable"},"isHideable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,p.kt)("h4",{id:"returns-7"},"Returns"),(0,p.kt)("p",null,"this is Hideable"),(0,p.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,p.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,p.kt)("h4",{id:"returns-8"},"Returns"),(0,p.kt)("p",null,"this is Resizeable"),(0,p.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,p.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,p.kt)("h4",{id:"returns-9"},"Returns"),(0,p.kt)("p",null,"this is Updateable"),(0,p.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,p.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"update"},"update"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"update"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"_delta"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"Updateable.update")),(0,p.kt)("h4",{id:"parameters-1"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"_delta")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"number"))))),(0,p.kt)("h4",{id:"returns-10"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"implementation-of-4"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"update")),(0,p.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleCamera/index.ts#L81"},"temp/engine_components/src/core/SimpleCamera/index.ts:81")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"updateaspect"},"updateAspect"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"updateAspect"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,"Updates the aspect of the camera to match the size of the\n",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Components#renderer"},"Components.renderer"),"."),(0,p.kt)("h4",{id:"returns-11"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleCamera/index.ts#L93"},"temp/engine_components/src/core/SimpleCamera/index.ts:93")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/b82b585f.e60c638f.js b/build/assets/js/b82b585f.e60c638f.js new file mode 100644 index 00000000..c1a76e63 --- /dev/null +++ b/build/assets/js/b82b585f.e60c638f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[215],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>k});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function p(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function r(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=a.createContext({}),s=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},m=function(e){var t=s(e.components);return a.createElement(l.Provider,{value:t},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,p=e.originalType,l=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),d=s(n),u=i,k=d["".concat(l,".").concat(u)]||d[u]||c[u]||p;return n?a.createElement(k,r(r({ref:t},m),{},{components:n})):a.createElement(k,r({ref:t},m))}));function k(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var p=n.length,r=new Array(p);r[0]=u;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o[d]="string"==typeof e?e:i,r[1]=o;for(var s=2;s{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>l,default:()=>k,frontMatter:()=>o,metadata:()=>s,toc:()=>d});var a=n(7462),i=n(3366),p=(n(7294),n(3905)),r=["components"],o={id:"openbim_components.SimpleCamera",title:"Class: SimpleCamera",sidebar_label:"SimpleCamera",custom_edit_url:null},l=void 0,s={unversionedId:"api/classes/openbim_components.SimpleCamera",id:"api/classes/openbim_components.SimpleCamera",title:"Class: SimpleCamera",description:"openbim-components.SimpleCamera",source:"@site/docs/api/classes/openbim_components.SimpleCamera.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.SimpleCamera",permalink:"/api/classes/openbim_components.SimpleCamera",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.SimpleCamera",title:"Class: SimpleCamera",sidebar_label:"SimpleCamera",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Simple2DScene",permalink:"/api/classes/openbim_components.Simple2DScene"},next:{title:"SimpleClipper",permalink:"/api/classes/openbim_components.SimpleClipper"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"activeCamera",id:"activecamera",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"controls",id:"controls",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"onAfterUpdate",id:"onafterupdate",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onBeforeUpdate",id:"onbeforeupdate",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Accessors",id:"accessors",level:2},{value:"enabled",id:"enabled",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"update",id:"update",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Implementation of",id:"implementation-of-4",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"updateAspect",id:"updateaspect",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-16",level:4}],c={toc:d},u="wrapper";function k(e){var t=e.components,n=(0,i.Z)(e,r);return(0,p.kt)(u,(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".SimpleCamera"),(0,p.kt)("p",null,"A basic camera that uses\n",(0,p.kt)("a",{parentName:"p",href:"https://github.com/yomotsu/camera-controls"},"yomotsu's cameracontrols")," to\neasily control the camera in 2D and 3D. Check out it's API to find out\nwhat features it offers."),(0,p.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("p",{parentName:"li"},(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,p.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"THREE.PerspectiveCamera")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"THREE.OrthographicCamera"),">"),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"SimpleCamera"))),(0,p.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.OrthoPerspectiveCamera"},(0,p.kt)("inlineCode",{parentName:"a"},"OrthoPerspectiveCamera"))))),(0,p.kt)("h2",{id:"implements"},"Implements"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Updateable"},(0,p.kt)("inlineCode",{parentName:"a"},"Updateable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,p.kt)("inlineCode",{parentName:"a"},"Disposable")))),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"activecamera"},"activeCamera"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"activeCamera"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"PerspectiveCamera")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,p.kt)("p",null,"The camera that is being used now according to the current ",(0,p.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection"),"."),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleCamera/index.ts#L48"},"src/core/SimpleCamera/index.ts:48")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"controls"},"controls"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"controls"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"CameraControls")),(0,p.kt)("p",null,"The object that controls the camera. An instance of\n",(0,p.kt)("a",{parentName:"p",href:"https://github.com/yomotsu/camera-controls"},"yomotsu's cameracontrols"),".\nTransforming the camera directly will have no effect: you need to use this\nobject to move, rotate, look at objects, etc."),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleCamera/index.ts#L33"},"src/core/SimpleCamera/index.ts:33")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleCamera")),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"Updateable.onAfterUpdate")),(0,p.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"onAfterUpdate")),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleCamera/index.ts#L20"},"src/core/SimpleCamera/index.ts:20")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleCamera")),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"Updateable.onBeforeUpdate")),(0,p.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"onBeforeUpdate")),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleCamera/index.ts#L17"},"src/core/SimpleCamera/index.ts:17")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,p.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,p.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleCamera/index.ts#L25"},"src/core/SimpleCamera/index.ts:25")),(0,p.kt)("h2",{id:"accessors"},"Accessors"),(0,p.kt)("h3",{id:"enabled"},"enabled"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"enabled"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,p.kt)("h4",{id:"returns"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("h4",{id:"overrides"},"Overrides"),(0,p.kt)("p",null,"Component.enabled"),(0,p.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleCamera/index.ts#L36"},"src/core/SimpleCamera/index.ts:36")),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"enabled"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"enabled"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,p.kt)("h4",{id:"parameters"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"enabled")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,p.kt)("h4",{id:"returns-1"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"overrides-1"},"Overrides"),(0,p.kt)("p",null,"Component.enabled"),(0,p.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleCamera/index.ts#L41"},"src/core/SimpleCamera/index.ts:41")),(0,p.kt)("h2",{id:"methods"},"Methods"),(0,p.kt)("h3",{id:"dispose"},"dispose"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,p.kt)("h4",{id:"returns-2"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,p.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleCamera/index.ts#L68"},"src/core/SimpleCamera/index.ts:68")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"get"},"get"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"get"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"PerspectiveCamera")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,p.kt)("h4",{id:"returns-3"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"PerspectiveCamera")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,p.kt)("h4",{id:"overrides-2"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,p.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleCamera/index.ts#L63"},"src/core/SimpleCamera/index.ts:63")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"hasui"},"hasUI"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,p.kt)("p",null,"Whether is component implements any kind of ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,p.kt)("h4",{id:"returns-4"},"Returns"),(0,p.kt)("p",null,"this is UI"),(0,p.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,p.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,p.kt)("h4",{id:"returns-5"},"Returns"),(0,p.kt)("p",null,"this is Configurable"),(0,p.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,p.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,p.kt)("h4",{id:"returns-6"},"Returns"),(0,p.kt)("p",null,"this is Disposable"),(0,p.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,p.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ishideable"},"isHideable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,p.kt)("h4",{id:"returns-7"},"Returns"),(0,p.kt)("p",null,"this is Hideable"),(0,p.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,p.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,p.kt)("h4",{id:"returns-8"},"Returns"),(0,p.kt)("p",null,"this is Resizeable"),(0,p.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,p.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,p.kt)("h4",{id:"returns-9"},"Returns"),(0,p.kt)("p",null,"this is Updateable"),(0,p.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,p.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"update"},"update"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"update"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"_delta"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"Updateable.update")),(0,p.kt)("h4",{id:"parameters-1"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"_delta")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"number"))))),(0,p.kt)("h4",{id:"returns-10"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"implementation-of-4"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"update")),(0,p.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleCamera/index.ts#L81"},"src/core/SimpleCamera/index.ts:81")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"updateaspect"},"updateAspect"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"updateAspect"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,"Updates the aspect of the camera to match the size of the\n",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Components#renderer"},"Components.renderer"),"."),(0,p.kt)("h4",{id:"returns-11"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleCamera/index.ts#L93"},"src/core/SimpleCamera/index.ts:93")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/b82c8867.45e4611b.js b/build/assets/js/b82c8867.45e4611b.js deleted file mode 100644 index 97db963b..00000000 --- a/build/assets/js/b82c8867.45e4611b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5972],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>f});var a=t(7294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function p(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,a)}return t}function r(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var o=a.createContext({}),s=function(e){var n=a.useContext(o),t=n;return e&&(t="function"==typeof e?e(n):r(r({},n),e)),t},m=function(e){var n=s(e.components);return a.createElement(o.Provider,{value:n},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},k=a.forwardRef((function(e,n){var t=e.components,i=e.mdxType,p=e.originalType,o=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),d=s(t),k=i,f=d["".concat(o,".").concat(k)]||d[k]||u[k]||p;return t?a.createElement(f,r(r({ref:n},m),{},{components:t})):a.createElement(f,r({ref:n},m))}));function f(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var p=t.length,r=new Array(p);r[0]=k;var l={};for(var o in n)hasOwnProperty.call(n,o)&&(l[o]=n[o]);l.originalType=e,l[d]="string"==typeof e?e:i,r[1]=l;for(var s=2;s{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>o,default:()=>f,frontMatter:()=>l,metadata:()=>s,toc:()=>d});var a=t(7462),i=t(3366),p=(t(7294),t(3905)),r=["components"],l={id:"openbim_components.LengthMeasurement",title:"Class: LengthMeasurement",sidebar_label:"LengthMeasurement",custom_edit_url:null},o=void 0,s={unversionedId:"api/classes/openbim_components.LengthMeasurement",id:"api/classes/openbim_components.LengthMeasurement",title:"Class: LengthMeasurement",description:"openbim-components.LengthMeasurement",source:"@site/docs/api/classes/openbim_components.LengthMeasurement.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.LengthMeasurement",permalink:"/api/classes/openbim_components.LengthMeasurement",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.LengthMeasurement",title:"Class: LengthMeasurement",sidebar_label:"LengthMeasurement",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"IfcStreamingSettings",permalink:"/api/classes/openbim_components.IfcStreamingSettings"},next:{title:"MaterialManager",permalink:"/api/classes/openbim_components.MaterialManager"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"onAfterCancel",id:"onaftercancel",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"onAfterCreate",id:"onaftercreate",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"onAfterDelete",id:"onafterdelete",level:3},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onAfterUpdate",id:"onafterupdate",level:3},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"onBeforeCancel",id:"onbeforecancel",level:3},{value:"Implementation of",id:"implementation-of-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"onBeforeCreate",id:"onbeforecreate",level:3},{value:"Implementation of",id:"implementation-of-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"onBeforeDelete",id:"onbeforedelete",level:3},{value:"Implementation of",id:"implementation-of-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"onBeforeUpdate",id:"onbeforeupdate",level:3},{value:"Implementation of",id:"implementation-of-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"previewElement",id:"previewelement",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"snapDistance",id:"snapdistance",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"Accessors",id:"accessors",level:2},{value:"color",id:"color",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"enabled",id:"enabled",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"visible",id:"visible",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Implementation of",id:"implementation-of-9",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Implementation of",id:"implementation-of-10",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"Methods",id:"methods",level:2},{value:"cancelCreation",id:"cancelcreation",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Implementation of",id:"implementation-of-11",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"create",id:"create",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Implementation of",id:"implementation-of-12",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"delete",id:"delete",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Implementation of",id:"implementation-of-13",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"deleteAll",id:"deleteall",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Implementation of",id:"implementation-of-14",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"update",id:"update",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Implementation of",id:"implementation-of-15",level:4},{value:"Defined in",id:"defined-in-28",level:4}],u={toc:d},k="wrapper";function f(e){var n=e.components,t=(0,i.Z)(e,r);return(0,p.kt)(k,(0,a.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".LengthMeasurement"),(0,p.kt)("p",null,"A basic dimension tool to measure distances between 2 points in 3D and\ndisplay a 3D symbol displaying the numeric value."),(0,p.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("p",{parentName:"li"},(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,p.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"SimpleDimensionLine"),"[]",">"),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"LengthMeasurement"))))),(0,p.kt)("h2",{id:"implements"},"Implements"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Createable"},(0,p.kt)("inlineCode",{parentName:"a"},"Createable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Hideable"},(0,p.kt)("inlineCode",{parentName:"a"},"Hideable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,p.kt)("inlineCode",{parentName:"a"},"Disposable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Updateable"},(0,p.kt)("inlineCode",{parentName:"a"},"Updateable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},(0,p.kt)("inlineCode",{parentName:"a"},"UI")))),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"onaftercancel"},"onAfterCancel"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onAfterCancel"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"SimpleDimensionLine"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onaftercancel"},"Createable.onAfterCancel")),(0,p.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onaftercancel"},"onAfterCancel")),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/LengthMeasurement/index.ts#L52"},"temp/engine_components/src/measurement/LengthMeasurement/index.ts:52")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onaftercreate"},"onAfterCreate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onAfterCreate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"SimpleDimensionLine"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onaftercreate"},"Createable.onAfterCreate")),(0,p.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onaftercreate"},"onAfterCreate")),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/LengthMeasurement/index.ts#L37"},"temp/engine_components/src/measurement/LengthMeasurement/index.ts:37")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onafterdelete"},"onAfterDelete"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onAfterDelete"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.LengthMeasurement"},(0,p.kt)("inlineCode",{parentName:"a"},"LengthMeasurement")),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onafterdelete"},"Createable.onAfterDelete")),(0,p.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onafterdelete"},"onAfterDelete")),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/LengthMeasurement/index.ts#L43"},"temp/engine_components/src/measurement/LengthMeasurement/index.ts:43")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.LengthMeasurement"},(0,p.kt)("inlineCode",{parentName:"a"},"LengthMeasurement")),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"Updateable.onAfterUpdate")),(0,p.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"onAfterUpdate")),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/LengthMeasurement/index.ts#L34"},"temp/engine_components/src/measurement/LengthMeasurement/index.ts:34")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onbeforecancel"},"onBeforeCancel"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onBeforeCancel"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.LengthMeasurement"},(0,p.kt)("inlineCode",{parentName:"a"},"LengthMeasurement")),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onbeforecancel"},"Createable.onBeforeCancel")),(0,p.kt)("h4",{id:"implementation-of-4"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onbeforecancel"},"onBeforeCancel")),(0,p.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/LengthMeasurement/index.ts#L49"},"temp/engine_components/src/measurement/LengthMeasurement/index.ts:49")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onbeforecreate"},"onBeforeCreate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onBeforeCreate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.LengthMeasurement"},(0,p.kt)("inlineCode",{parentName:"a"},"LengthMeasurement")),">"),(0,p.kt)("p",null,"Createable.onBeforeCreate"),(0,p.kt)("h4",{id:"implementation-of-5"},"Implementation of"),(0,p.kt)("p",null,"Createable.onBeforeCreate"),(0,p.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/LengthMeasurement/index.ts#L40"},"temp/engine_components/src/measurement/LengthMeasurement/index.ts:40")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onbeforedelete"},"onBeforeDelete"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onBeforeDelete"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"SimpleDimensionLine"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onbeforedelete"},"Createable.onBeforeDelete")),(0,p.kt)("h4",{id:"implementation-of-6"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onbeforedelete"},"onBeforeDelete")),(0,p.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/LengthMeasurement/index.ts#L46"},"temp/engine_components/src/measurement/LengthMeasurement/index.ts:46")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.LengthMeasurement"},(0,p.kt)("inlineCode",{parentName:"a"},"LengthMeasurement")),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"Updateable.onBeforeUpdate")),(0,p.kt)("h4",{id:"implementation-of-7"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"onBeforeUpdate")),(0,p.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/LengthMeasurement/index.ts#L31"},"temp/engine_components/src/measurement/LengthMeasurement/index.ts:31")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,p.kt)("h4",{id:"implementation-of-8"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,p.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/LengthMeasurement/index.ts#L28"},"temp/engine_components/src/measurement/LengthMeasurement/index.ts:28")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"previewelement"},"previewElement"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"previewElement"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"HTMLElement")),(0,p.kt)("p",null,"The ",(0,p.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#examples/en/renderers/CSS2DRenderer"},"symbol"),"\nthat is displayed where the dimension will be drawn."),(0,p.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/LengthMeasurement/index.ts#L61"},"temp/engine_components/src/measurement/LengthMeasurement/index.ts:61")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"snapdistance"},"snapDistance"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"snapDistance"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,p.kt)("inlineCode",{parentName:"p"},"0.25")),(0,p.kt)("p",null,"The minimum distance to force the dimension cursor to a vertex."),(0,p.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/LengthMeasurement/index.ts#L57"},"temp/engine_components/src/measurement/LengthMeasurement/index.ts:57")),(0,p.kt)("h2",{id:"accessors"},"Accessors"),(0,p.kt)("h3",{id:"color"},"color"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"color"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"color"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,"The ",(0,p.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/math/Color"},"Color"),"\nof the geometry of the dimensions."),(0,p.kt)("h4",{id:"parameters"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"color")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"Color"))))),(0,p.kt)("h4",{id:"returns"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/LengthMeasurement/index.ts#L117"},"temp/engine_components/src/measurement/LengthMeasurement/index.ts:117")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"enabled"},"enabled"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"enabled"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,p.kt)("h4",{id:"returns-1"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("h4",{id:"overrides"},"Overrides"),(0,p.kt)("p",null,"Component.enabled"),(0,p.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/LengthMeasurement/index.ts#L85"},"temp/engine_components/src/measurement/LengthMeasurement/index.ts:85")),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"enabled"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,p.kt)("h4",{id:"parameters-1"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"value")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,p.kt)("h4",{id:"returns-2"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"overrides-1"},"Overrides"),(0,p.kt)("p",null,"Component.enabled"),(0,p.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/LengthMeasurement/index.ts#L90"},"temp/engine_components/src/measurement/LengthMeasurement/index.ts:90")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"visible"},"visible"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"visible"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,p.kt)("h4",{id:"returns-3"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("h4",{id:"implementation-of-9"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"visible")),(0,p.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/LengthMeasurement/index.ts#L101"},"temp/engine_components/src/measurement/LengthMeasurement/index.ts:101")),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"visible"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,p.kt)("h4",{id:"parameters-2"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"value")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,p.kt)("h4",{id:"returns-4"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"implementation-of-10"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"visible")),(0,p.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/LengthMeasurement/index.ts#L106"},"temp/engine_components/src/measurement/LengthMeasurement/index.ts:106")),(0,p.kt)("h2",{id:"methods"},"Methods"),(0,p.kt)("h3",{id:"cancelcreation"},"cancelCreation"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"cancelCreation"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,"Cancels the drawing of the current dimension."),(0,p.kt)("h4",{id:"returns-5"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"implementation-of-11"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#cancelcreation"},"cancelCreation")),(0,p.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/LengthMeasurement/index.ts#L258"},"temp/engine_components/src/measurement/LengthMeasurement/index.ts:258")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"create"},"create"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"create"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"data?"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,"Starts or finishes drawing a new dimension line."),(0,p.kt)("h4",{id:"parameters-3"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"data?")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"any")),(0,p.kt)("td",{parentName:"tr",align:"left"},"forces the dimension to be drawn on a plane. Use this if you are drawing dimensions in floor plan navigation.")))),(0,p.kt)("h4",{id:"returns-6"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"implementation-of-12"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#create"},"create")),(0,p.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/LengthMeasurement/index.ts#L203"},"temp/engine_components/src/measurement/LengthMeasurement/index.ts:203")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"delete"},"delete"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"delete"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,"Deletes the dimension that the user is hovering over with the mouse or touch event."),(0,p.kt)("h4",{id:"returns-7"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"implementation-of-13"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#delete"},"delete")),(0,p.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/LengthMeasurement/index.ts#L223"},"temp/engine_components/src/measurement/LengthMeasurement/index.ts:223")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"deleteall"},"deleteAll"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"deleteAll"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,"Deletes all the dimensions that have been previously created."),(0,p.kt)("h4",{id:"returns-8"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/LengthMeasurement/index.ts#L249"},"temp/engine_components/src/measurement/LengthMeasurement/index.ts:249")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"dispose"},"dispose"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,p.kt)("h4",{id:"returns-9"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"implementation-of-14"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,p.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/LengthMeasurement/index.ts#L160"},"temp/engine_components/src/measurement/LengthMeasurement/index.ts:160")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"get"},"get"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"get"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"SimpleDimensionLine"),"[]"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,p.kt)("h4",{id:"returns-10"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"SimpleDimensionLine"),"[]"),(0,p.kt)("h4",{id:"overrides-2"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,p.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/LengthMeasurement/index.ts#L155"},"temp/engine_components/src/measurement/LengthMeasurement/index.ts:155")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"hasui"},"hasUI"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,p.kt)("p",null,"Whether is component implements any kind of ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,p.kt)("h4",{id:"returns-11"},"Returns"),(0,p.kt)("p",null,"this is UI"),(0,p.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,p.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,p.kt)("h4",{id:"returns-12"},"Returns"),(0,p.kt)("p",null,"this is Configurable"),(0,p.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,p.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,p.kt)("h4",{id:"returns-13"},"Returns"),(0,p.kt)("p",null,"this is Disposable"),(0,p.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,p.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ishideable"},"isHideable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,p.kt)("h4",{id:"returns-14"},"Returns"),(0,p.kt)("p",null,"this is Hideable"),(0,p.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,p.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,p.kt)("h4",{id:"returns-15"},"Returns"),(0,p.kt)("p",null,"this is Resizeable"),(0,p.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,p.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,p.kt)("h4",{id:"returns-16"},"Returns"),(0,p.kt)("p",null,"this is Updateable"),(0,p.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,p.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"update"},"update"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"update"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"_delta"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"Updateable.update")),(0,p.kt)("h4",{id:"parameters-4"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"_delta")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"number"))))),(0,p.kt)("h4",{id:"returns-17"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"implementation-of-15"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"update")),(0,p.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/LengthMeasurement/index.ts#L186"},"temp/engine_components/src/measurement/LengthMeasurement/index.ts:186")))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/b82c8867.e5db230a.js b/build/assets/js/b82c8867.e5db230a.js new file mode 100644 index 00000000..11ab5a39 --- /dev/null +++ b/build/assets/js/b82c8867.e5db230a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5972],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>h});var a=t(7294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,a)}return t}function p(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var o=a.createContext({}),s=function(e){var n=a.useContext(o),t=n;return e&&(t="function"==typeof e?e(n):p(p({},n),e)),t},m=function(e){var n=s(e.components);return a.createElement(o.Provider,{value:n},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},k=a.forwardRef((function(e,n){var t=e.components,i=e.mdxType,r=e.originalType,o=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),d=s(t),k=i,h=d["".concat(o,".").concat(k)]||d[k]||u[k]||r;return t?a.createElement(h,p(p({ref:n},m),{},{components:t})):a.createElement(h,p({ref:n},m))}));function h(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var r=t.length,p=new Array(r);p[0]=k;var l={};for(var o in n)hasOwnProperty.call(n,o)&&(l[o]=n[o]);l.originalType=e,l[d]="string"==typeof e?e:i,p[1]=l;for(var s=2;s{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>o,default:()=>h,frontMatter:()=>l,metadata:()=>s,toc:()=>d});var a=t(7462),i=t(3366),r=(t(7294),t(3905)),p=["components"],l={id:"openbim_components.LengthMeasurement",title:"Class: LengthMeasurement",sidebar_label:"LengthMeasurement",custom_edit_url:null},o=void 0,s={unversionedId:"api/classes/openbim_components.LengthMeasurement",id:"api/classes/openbim_components.LengthMeasurement",title:"Class: LengthMeasurement",description:"openbim-components.LengthMeasurement",source:"@site/docs/api/classes/openbim_components.LengthMeasurement.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.LengthMeasurement",permalink:"/api/classes/openbim_components.LengthMeasurement",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.LengthMeasurement",title:"Class: LengthMeasurement",sidebar_label:"LengthMeasurement",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"IfcStreamingSettings",permalink:"/api/classes/openbim_components.IfcStreamingSettings"},next:{title:"MaterialManager",permalink:"/api/classes/openbim_components.MaterialManager"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"onAfterCancel",id:"onaftercancel",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"onAfterCreate",id:"onaftercreate",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"onAfterDelete",id:"onafterdelete",level:3},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onAfterUpdate",id:"onafterupdate",level:3},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"onBeforeCancel",id:"onbeforecancel",level:3},{value:"Implementation of",id:"implementation-of-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"onBeforeCreate",id:"onbeforecreate",level:3},{value:"Implementation of",id:"implementation-of-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"onBeforeDelete",id:"onbeforedelete",level:3},{value:"Implementation of",id:"implementation-of-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"onBeforeUpdate",id:"onbeforeupdate",level:3},{value:"Implementation of",id:"implementation-of-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"previewElement",id:"previewelement",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"snapDistance",id:"snapdistance",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"Accessors",id:"accessors",level:2},{value:"color",id:"color",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"enabled",id:"enabled",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"visible",id:"visible",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Implementation of",id:"implementation-of-9",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Implementation of",id:"implementation-of-10",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"Methods",id:"methods",level:2},{value:"cancelCreation",id:"cancelcreation",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Implementation of",id:"implementation-of-11",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"create",id:"create",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Implementation of",id:"implementation-of-12",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"delete",id:"delete",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Implementation of",id:"implementation-of-13",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"deleteAll",id:"deleteall",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Implementation of",id:"implementation-of-14",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"update",id:"update",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Implementation of",id:"implementation-of-15",level:4},{value:"Defined in",id:"defined-in-28",level:4}],u={toc:d},k="wrapper";function h(e){var n=e.components,t=(0,i.Z)(e,p);return(0,r.kt)(k,(0,a.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".LengthMeasurement"),(0,r.kt)("p",null,"A basic dimension tool to measure distances between 2 points in 3D and\ndisplay a 3D symbol displaying the numeric value."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,r.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"SimpleDimensionLine"),"[]",">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"LengthMeasurement"))))),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Createable"},(0,r.kt)("inlineCode",{parentName:"a"},"Createable"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Hideable"},(0,r.kt)("inlineCode",{parentName:"a"},"Hideable"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,r.kt)("inlineCode",{parentName:"a"},"Disposable"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Updateable"},(0,r.kt)("inlineCode",{parentName:"a"},"Updateable"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},(0,r.kt)("inlineCode",{parentName:"a"},"UI")))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"onaftercancel"},"onAfterCancel"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onAfterCancel"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"SimpleDimensionLine"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onaftercancel"},"Createable.onAfterCancel")),(0,r.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onaftercancel"},"onAfterCancel")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/LengthMeasurement/index.ts#L52"},"src/measurement/LengthMeasurement/index.ts:52")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onaftercreate"},"onAfterCreate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onAfterCreate"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"SimpleDimensionLine"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onaftercreate"},"Createable.onAfterCreate")),(0,r.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onaftercreate"},"onAfterCreate")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/LengthMeasurement/index.ts#L37"},"src/measurement/LengthMeasurement/index.ts:37")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onafterdelete"},"onAfterDelete"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onAfterDelete"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.LengthMeasurement"},(0,r.kt)("inlineCode",{parentName:"a"},"LengthMeasurement")),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onafterdelete"},"Createable.onAfterDelete")),(0,r.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onafterdelete"},"onAfterDelete")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/LengthMeasurement/index.ts#L43"},"src/measurement/LengthMeasurement/index.ts:43")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.LengthMeasurement"},(0,r.kt)("inlineCode",{parentName:"a"},"LengthMeasurement")),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"Updateable.onAfterUpdate")),(0,r.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"onAfterUpdate")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/LengthMeasurement/index.ts#L34"},"src/measurement/LengthMeasurement/index.ts:34")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onbeforecancel"},"onBeforeCancel"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onBeforeCancel"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.LengthMeasurement"},(0,r.kt)("inlineCode",{parentName:"a"},"LengthMeasurement")),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onbeforecancel"},"Createable.onBeforeCancel")),(0,r.kt)("h4",{id:"implementation-of-4"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onbeforecancel"},"onBeforeCancel")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/LengthMeasurement/index.ts#L49"},"src/measurement/LengthMeasurement/index.ts:49")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onbeforecreate"},"onBeforeCreate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onBeforeCreate"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.LengthMeasurement"},(0,r.kt)("inlineCode",{parentName:"a"},"LengthMeasurement")),">"),(0,r.kt)("p",null,"Createable.onBeforeCreate"),(0,r.kt)("h4",{id:"implementation-of-5"},"Implementation of"),(0,r.kt)("p",null,"Createable.onBeforeCreate"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/LengthMeasurement/index.ts#L40"},"src/measurement/LengthMeasurement/index.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onbeforedelete"},"onBeforeDelete"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onBeforeDelete"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"SimpleDimensionLine"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onbeforedelete"},"Createable.onBeforeDelete")),(0,r.kt)("h4",{id:"implementation-of-6"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onbeforedelete"},"onBeforeDelete")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/LengthMeasurement/index.ts#L46"},"src/measurement/LengthMeasurement/index.ts:46")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.LengthMeasurement"},(0,r.kt)("inlineCode",{parentName:"a"},"LengthMeasurement")),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"Updateable.onBeforeUpdate")),(0,r.kt)("h4",{id:"implementation-of-7"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"onBeforeUpdate")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/LengthMeasurement/index.ts#L31"},"src/measurement/LengthMeasurement/index.ts:31")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,r.kt)("h4",{id:"implementation-of-8"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/LengthMeasurement/index.ts#L28"},"src/measurement/LengthMeasurement/index.ts:28")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"previewelement"},"previewElement"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"previewElement"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"HTMLElement")),(0,r.kt)("p",null,"The ",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#examples/en/renderers/CSS2DRenderer"},"symbol"),"\nthat is displayed where the dimension will be drawn."),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/LengthMeasurement/index.ts#L61"},"src/measurement/LengthMeasurement/index.ts:61")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"snapdistance"},"snapDistance"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"snapDistance"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"0.25")),(0,r.kt)("p",null,"The minimum distance to force the dimension cursor to a vertex."),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/LengthMeasurement/index.ts#L57"},"src/measurement/LengthMeasurement/index.ts:57")),(0,r.kt)("h2",{id:"accessors"},"Accessors"),(0,r.kt)("h3",{id:"color"},"color"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"color"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"color"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"The ",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/math/Color"},"Color"),"\nof the geometry of the dimensions."),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"color")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Color"))))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/LengthMeasurement/index.ts#L117"},"src/measurement/LengthMeasurement/index.ts:117")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"enabled"},"enabled"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"enabled"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,"Component.enabled"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/LengthMeasurement/index.ts#L85"},"src/measurement/LengthMeasurement/index.ts:85")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"enabled"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,"Component.enabled"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/LengthMeasurement/index.ts#L90"},"src/measurement/LengthMeasurement/index.ts:90")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"visible"},"visible"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"visible"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"implementation-of-9"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"visible")),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/LengthMeasurement/index.ts#L101"},"src/measurement/LengthMeasurement/index.ts:101")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"visible"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"implementation-of-10"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"visible")),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/LengthMeasurement/index.ts#L106"},"src/measurement/LengthMeasurement/index.ts:106")),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"cancelcreation"},"cancelCreation"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"cancelCreation"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Cancels the drawing of the current dimension."),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"implementation-of-11"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#cancelcreation"},"cancelCreation")),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/LengthMeasurement/index.ts#L258"},"src/measurement/LengthMeasurement/index.ts:258")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"create"},"create"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"create"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"data?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Starts or finishes drawing a new dimension line."),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"forces the dimension to be drawn on a plane. Use this if you are drawing dimensions in floor plan navigation.")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"implementation-of-12"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#create"},"create")),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/LengthMeasurement/index.ts#L203"},"src/measurement/LengthMeasurement/index.ts:203")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"delete"},"delete"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"delete"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Deletes the dimension that the user is hovering over with the mouse or touch event."),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"implementation-of-13"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#delete"},"delete")),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/LengthMeasurement/index.ts#L223"},"src/measurement/LengthMeasurement/index.ts:223")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"deleteall"},"deleteAll"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"deleteAll"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Deletes all the dimensions that have been previously created."),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/LengthMeasurement/index.ts#L249"},"src/measurement/LengthMeasurement/index.ts:249")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"dispose"},"dispose"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"implementation-of-14"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/LengthMeasurement/index.ts#L160"},"src/measurement/LengthMeasurement/index.ts:160")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"get"},"get"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"get"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"SimpleDimensionLine"),"[]"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SimpleDimensionLine"),"[]"),(0,r.kt)("h4",{id:"overrides-2"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/LengthMeasurement/index.ts#L155"},"src/measurement/LengthMeasurement/index.ts:155")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hasui"},"hasUI"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,r.kt)("p",null,"Whether is component implements any kind of ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,"this is UI"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,"this is Configurable"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,"this is Disposable"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ishideable"},"isHideable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,"this is Hideable"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,"this is Resizeable"),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,"this is Updateable"),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,r.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"update"},"update"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"update"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"_delta"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"Updateable.update")),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"_delta")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"implementation-of-15"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"update")),(0,r.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/LengthMeasurement/index.ts#L186"},"src/measurement/LengthMeasurement/index.ts:186")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/ba12a54e.02cab8e7.js b/build/assets/js/ba12a54e.788e942d.js similarity index 65% rename from build/assets/js/ba12a54e.02cab8e7.js rename to build/assets/js/ba12a54e.788e942d.js index 4646c3ae..1b1bdcce 100644 --- a/build/assets/js/ba12a54e.02cab8e7.js +++ b/build/assets/js/ba12a54e.788e942d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4175],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>b});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function p(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),s=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},c=function(e){var t=s(e.components);return r.createElement(l.Provider,{value:t},e.children)},m="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),m=s(n),u=a,b=m["".concat(l,".").concat(u)]||m[u]||d[u]||i;return n?r.createElement(b,p(p({ref:t},c),{},{components:n})):r.createElement(b,p({ref:t},c))}));function b(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,p=new Array(i);p[0]=u;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o[m]="string"==typeof e?e:a,p[1]=o;for(var s=2;s{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>b,frontMatter:()=>o,metadata:()=>s,toc:()=>m});var r=n(7462),a=n(3366),i=(n(7294),n(3905)),p=["components"],o={id:"openbim_components.Resizeable",title:"Interface: Resizeable",sidebar_label:"Resizeable",custom_edit_url:null},l=void 0,s={unversionedId:"api/interfaces/openbim_components.Resizeable",id:"api/interfaces/openbim_components.Resizeable",title:"Interface: Resizeable",description:"openbim-components.Resizeable",source:"@site/docs/api/interfaces/openbim_components.Resizeable.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/openbim_components.Resizeable",permalink:"/api/interfaces/openbim_components.Resizeable",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Resizeable",title:"Interface: Resizeable",sidebar_label:"Resizeable",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Progress",permalink:"/api/interfaces/openbim_components.Progress"},next:{title:"UI",permalink:"/api/interfaces/openbim_components.UI"}},c={},m=[{value:"Implemented by",id:"implemented-by",level:2},{value:"Properties",id:"properties",level:2},{value:"getSize",id:"getsize",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in",level:4},{value:"onResize",id:"onresize",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"resize",id:"resize",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Defined in",id:"defined-in-2",level:4}],d={toc:m},u="wrapper";function b(e){var t=e.components,n=(0,a.Z)(e,p);return(0,i.kt)(u,(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Resizeable"),(0,i.kt)("p",null,"Whether this component can be resized. The meaning of this can vary depending\non the component: resizing a\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer"},"Renderer"),"\ncomponent could mean changing its resolution, whereas resizing a\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/objects/Mesh"},"Mesh")," would change its scale."),(0,i.kt)("h2",{id:"implemented-by"},"Implemented by"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.BaseRenderer"},(0,i.kt)("inlineCode",{parentName:"a"},"BaseRenderer"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Simple2DScene"},(0,i.kt)("inlineCode",{parentName:"a"},"Simple2DScene"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleRenderer"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleRenderer")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"getsize"},"getSize"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"getSize"),": () => ",(0,i.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("p",null,"\u25b8 (): ",(0,i.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,i.kt)("p",null,"Gets the current size of this component (e.g. the resolution of a\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer"},"Renderer"),"\ncomponent."),(0,i.kt)("h5",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L103"},"temp/engine_components/src/base-types/base-types.ts:103")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onresize"},"onResize"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"onResize"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Vector2"),">"),(0,i.kt)("p",null,"Event that fires when the component has been resized."),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L96"},"temp/engine_components/src/base-types/base-types.ts:96")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"resize"},"resize"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"resize"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"size?"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Vector2"),") => ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,i.kt)("p",null,"\u25b8 (",(0,i.kt)("inlineCode",{parentName:"p"},"size?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Sets size of this component (e.g. the resolution of a\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer"},"Renderer"),"\ncomponent."),(0,i.kt)("h5",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"size?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Vector2"))))),(0,i.kt)("h5",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L93"},"temp/engine_components/src/base-types/base-types.ts:93")))}b.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4175],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>b});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function p(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),s=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},c=function(e){var t=s(e.components);return r.createElement(l.Provider,{value:t},e.children)},d="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),d=s(n),u=a,b=d["".concat(l,".").concat(u)]||d[u]||m[u]||i;return n?r.createElement(b,p(p({ref:t},c),{},{components:n})):r.createElement(b,p({ref:t},c))}));function b(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,p=new Array(i);p[0]=u;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o[d]="string"==typeof e?e:a,p[1]=o;for(var s=2;s{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>b,frontMatter:()=>o,metadata:()=>s,toc:()=>d});var r=n(7462),a=n(3366),i=(n(7294),n(3905)),p=["components"],o={id:"openbim_components.Resizeable",title:"Interface: Resizeable",sidebar_label:"Resizeable",custom_edit_url:null},l=void 0,s={unversionedId:"api/interfaces/openbim_components.Resizeable",id:"api/interfaces/openbim_components.Resizeable",title:"Interface: Resizeable",description:"openbim-components.Resizeable",source:"@site/docs/api/interfaces/openbim_components.Resizeable.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/openbim_components.Resizeable",permalink:"/api/interfaces/openbim_components.Resizeable",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Resizeable",title:"Interface: Resizeable",sidebar_label:"Resizeable",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Progress",permalink:"/api/interfaces/openbim_components.Progress"},next:{title:"UI",permalink:"/api/interfaces/openbim_components.UI"}},c={},d=[{value:"Implemented by",id:"implemented-by",level:2},{value:"Properties",id:"properties",level:2},{value:"getSize",id:"getsize",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in",level:4},{value:"onResize",id:"onresize",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"resize",id:"resize",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Defined in",id:"defined-in-2",level:4}],m={toc:d},u="wrapper";function b(e){var t=e.components,n=(0,a.Z)(e,p);return(0,i.kt)(u,(0,r.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Resizeable"),(0,i.kt)("p",null,"Whether this component can be resized. The meaning of this can vary depending\non the component: resizing a\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer"},"Renderer"),"\ncomponent could mean changing its resolution, whereas resizing a\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/objects/Mesh"},"Mesh")," would change its scale."),(0,i.kt)("h2",{id:"implemented-by"},"Implemented by"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.BaseRenderer"},(0,i.kt)("inlineCode",{parentName:"a"},"BaseRenderer"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Simple2DScene"},(0,i.kt)("inlineCode",{parentName:"a"},"Simple2DScene"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleRenderer"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleRenderer")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"getsize"},"getSize"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"getSize"),": () => ",(0,i.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("p",null,"\u25b8 (): ",(0,i.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,i.kt)("p",null,"Gets the current size of this component (e.g. the resolution of a\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer"},"Renderer"),"\ncomponent."),(0,i.kt)("h5",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L103"},"src/base-types/base-types.ts:103")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onresize"},"onResize"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"onResize"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Vector2"),">"),(0,i.kt)("p",null,"Event that fires when the component has been resized."),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L96"},"src/base-types/base-types.ts:96")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"resize"},"resize"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"resize"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"size?"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Vector2"),") => ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,i.kt)("p",null,"\u25b8 (",(0,i.kt)("inlineCode",{parentName:"p"},"size?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Sets size of this component (e.g. the resolution of a\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer"},"Renderer"),"\ncomponent."),(0,i.kt)("h5",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"size?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Vector2"))))),(0,i.kt)("h5",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L93"},"src/base-types/base-types.ts:93")))}b.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/bc6e2bb0.81a117cd.js b/build/assets/js/bc6e2bb0.81a117cd.js new file mode 100644 index 00000000..b9fa9953 --- /dev/null +++ b/build/assets/js/bc6e2bb0.81a117cd.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9799],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>k});var i=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function p(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function r(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var o=i.createContext({}),s=function(e){var n=i.useContext(o),t=n;return e&&(t="function"==typeof e?e(n):r(r({},n),e)),t},d=function(e){var n=s(e.components);return i.createElement(o.Provider,{value:n},e.children)},m="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},c=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,p=e.originalType,o=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),m=s(t),c=a,k=m["".concat(o,".").concat(c)]||m[c]||u[c]||p;return t?i.createElement(k,r(r({ref:n},d),{},{components:t})):i.createElement(k,r({ref:n},d))}));function k(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var p=t.length,r=new Array(p);r[0]=c;var l={};for(var o in n)hasOwnProperty.call(n,o)&&(l[o]=n[o]);l.originalType=e,l[m]="string"==typeof e?e:a,r[1]=l;for(var s=2;s{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>k,frontMatter:()=>l,metadata:()=>s,toc:()=>m});var i=t(7462),a=t(3366),p=(t(7294),t(3905)),r=["components"],l={id:"openbim_components.SimpleGrid",title:"Class: SimpleGrid",sidebar_label:"SimpleGrid",custom_edit_url:null},o=void 0,s={unversionedId:"api/classes/openbim_components.SimpleGrid",id:"api/classes/openbim_components.SimpleGrid",title:"Class: SimpleGrid",description:"openbim-components.SimpleGrid",source:"@site/docs/api/classes/openbim_components.SimpleGrid.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.SimpleGrid",permalink:"/api/classes/openbim_components.SimpleGrid",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.SimpleGrid",title:"Class: SimpleGrid",sidebar_label:"SimpleGrid",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"SimpleClipper",permalink:"/api/classes/openbim_components.SimpleClipper"},next:{title:"SimplePlane",permalink:"/api/classes/openbim_components.SimplePlane"}},d={},m=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"Accessors",id:"accessors",level:2},{value:"fade",id:"fade",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"material",id:"material",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"visible",id:"visible",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-14",level:4}],u={toc:m},c="wrapper";function k(e){var n=e.components,t=(0,a.Z)(e,r);return(0,p.kt)(c,(0,i.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".SimpleGrid"),(0,p.kt)("p",null,"An infinite grid. Created by\n",(0,p.kt)("a",{parentName:"p",href:"https://github.com/Fyrestar/THREE.InfiniteGridHelper"},"fyrestar"),"\nand translated to typescript by\n",(0,p.kt)("a",{parentName:"p",href:"https://github.com/dkaraush/THREE.InfiniteGridHelper/blob/master/InfiniteGridHelper.ts"},"dkaraush"),"."),(0,p.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("p",{parentName:"li"},(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,p.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"THREE.Mesh"),">"),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"SimpleGrid"))))),(0,p.kt)("h2",{id:"implements"},"Implements"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Hideable"},(0,p.kt)("inlineCode",{parentName:"a"},"Hideable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,p.kt)("inlineCode",{parentName:"a"},"Disposable")))),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"enabled"},"enabled"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"enabled"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,p.kt)("inlineCode",{parentName:"p"},"true")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,p.kt)("h4",{id:"overrides"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleGrid/index.ts#L24"},"src/core/SimpleGrid/index.ts:24")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,p.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleGrid/index.ts#L21"},"src/core/SimpleGrid/index.ts:21")),(0,p.kt)("h2",{id:"accessors"},"Accessors"),(0,p.kt)("h3",{id:"fade"},"fade"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"fade"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("p",null,"Whether the grid should fade away with distance. Recommended to be true for\nperspective cameras and false for orthographic cameras."),(0,p.kt)("h4",{id:"returns"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleGrid/index.ts#L50"},"src/core/SimpleGrid/index.ts:50")),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"fade"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"active"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,"Whether the grid should fade away with distance. Recommended to be true for\nperspective cameras and false for orthographic cameras."),(0,p.kt)("h4",{id:"parameters"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"active")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,p.kt)("h4",{id:"returns-1"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleGrid/index.ts#L58"},"src/core/SimpleGrid/index.ts:58")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"material"},"material"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"material"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"ShaderMaterial")),(0,p.kt)("p",null,"The material of the grid."),(0,p.kt)("h4",{id:"returns-2"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"ShaderMaterial")),(0,p.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleGrid/index.ts#L42"},"src/core/SimpleGrid/index.ts:42")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"visible"},"visible"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"visible"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,p.kt)("h4",{id:"returns-3"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"visible")),(0,p.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleGrid/index.ts#L27"},"src/core/SimpleGrid/index.ts:27")),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"visible"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"visible"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,p.kt)("h4",{id:"parameters-1"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"visible")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,p.kt)("h4",{id:"returns-4"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"visible")),(0,p.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleGrid/index.ts#L32"},"src/core/SimpleGrid/index.ts:32")),(0,p.kt)("h2",{id:"methods"},"Methods"),(0,p.kt)("h3",{id:"dispose"},"dispose"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,p.kt)("h4",{id:"returns-5"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,p.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleGrid/index.ts#L189"},"src/core/SimpleGrid/index.ts:189")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"get"},"get"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"get"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,p.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,p.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,p.kt)("h4",{id:"returns-6"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,p.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,p.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">"),(0,p.kt)("h4",{id:"overrides-1"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,p.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleGrid/index.ts#L184"},"src/core/SimpleGrid/index.ts:184")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"hasui"},"hasUI"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,p.kt)("p",null,"Whether is component implements any kind of ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,p.kt)("h4",{id:"returns-7"},"Returns"),(0,p.kt)("p",null,"this is UI"),(0,p.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,p.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,p.kt)("h4",{id:"returns-8"},"Returns"),(0,p.kt)("p",null,"this is Configurable"),(0,p.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,p.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,p.kt)("h4",{id:"returns-9"},"Returns"),(0,p.kt)("p",null,"this is Disposable"),(0,p.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,p.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ishideable"},"isHideable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,p.kt)("h4",{id:"returns-10"},"Returns"),(0,p.kt)("p",null,"this is Hideable"),(0,p.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,p.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,p.kt)("h4",{id:"returns-11"},"Returns"),(0,p.kt)("p",null,"this is Resizeable"),(0,p.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,p.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,p.kt)("h4",{id:"returns-12"},"Returns"),(0,p.kt)("p",null,"this is Updateable"),(0,p.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,p.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/bc6e2bb0.9987c77a.js b/build/assets/js/bc6e2bb0.9987c77a.js deleted file mode 100644 index f5a7b51f..00000000 --- a/build/assets/js/bc6e2bb0.9987c77a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9799],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>k});var i=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function p(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function r(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var o=i.createContext({}),s=function(e){var n=i.useContext(o),t=n;return e&&(t="function"==typeof e?e(n):r(r({},n),e)),t},m=function(e){var n=s(e.components);return i.createElement(o.Provider,{value:n},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},u=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,p=e.originalType,o=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),d=s(t),u=a,k=d["".concat(o,".").concat(u)]||d[u]||c[u]||p;return t?i.createElement(k,r(r({ref:n},m),{},{components:t})):i.createElement(k,r({ref:n},m))}));function k(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var p=t.length,r=new Array(p);r[0]=u;var l={};for(var o in n)hasOwnProperty.call(n,o)&&(l[o]=n[o]);l.originalType=e,l[d]="string"==typeof e?e:a,r[1]=l;for(var s=2;s{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>o,default:()=>k,frontMatter:()=>l,metadata:()=>s,toc:()=>d});var i=t(7462),a=t(3366),p=(t(7294),t(3905)),r=["components"],l={id:"openbim_components.SimpleGrid",title:"Class: SimpleGrid",sidebar_label:"SimpleGrid",custom_edit_url:null},o=void 0,s={unversionedId:"api/classes/openbim_components.SimpleGrid",id:"api/classes/openbim_components.SimpleGrid",title:"Class: SimpleGrid",description:"openbim-components.SimpleGrid",source:"@site/docs/api/classes/openbim_components.SimpleGrid.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.SimpleGrid",permalink:"/api/classes/openbim_components.SimpleGrid",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.SimpleGrid",title:"Class: SimpleGrid",sidebar_label:"SimpleGrid",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"SimpleClipper",permalink:"/api/classes/openbim_components.SimpleClipper"},next:{title:"SimplePlane",permalink:"/api/classes/openbim_components.SimplePlane"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"Accessors",id:"accessors",level:2},{value:"fade",id:"fade",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"material",id:"material",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"visible",id:"visible",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-14",level:4}],c={toc:d},u="wrapper";function k(e){var n=e.components,t=(0,a.Z)(e,r);return(0,p.kt)(u,(0,i.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".SimpleGrid"),(0,p.kt)("p",null,"An infinite grid. Created by\n",(0,p.kt)("a",{parentName:"p",href:"https://github.com/Fyrestar/THREE.InfiniteGridHelper"},"fyrestar"),"\nand translated to typescript by\n",(0,p.kt)("a",{parentName:"p",href:"https://github.com/dkaraush/THREE.InfiniteGridHelper/blob/master/InfiniteGridHelper.ts"},"dkaraush"),"."),(0,p.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("p",{parentName:"li"},(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,p.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"THREE.Mesh"),">"),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"SimpleGrid"))))),(0,p.kt)("h2",{id:"implements"},"Implements"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Hideable"},(0,p.kt)("inlineCode",{parentName:"a"},"Hideable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,p.kt)("inlineCode",{parentName:"a"},"Disposable")))),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"enabled"},"enabled"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"enabled"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,p.kt)("inlineCode",{parentName:"p"},"true")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,p.kt)("h4",{id:"overrides"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleGrid/index.ts#L24"},"temp/engine_components/src/core/SimpleGrid/index.ts:24")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,p.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleGrid/index.ts#L21"},"temp/engine_components/src/core/SimpleGrid/index.ts:21")),(0,p.kt)("h2",{id:"accessors"},"Accessors"),(0,p.kt)("h3",{id:"fade"},"fade"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"fade"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("p",null,"Whether the grid should fade away with distance. Recommended to be true for\nperspective cameras and false for orthographic cameras."),(0,p.kt)("h4",{id:"returns"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleGrid/index.ts#L50"},"temp/engine_components/src/core/SimpleGrid/index.ts:50")),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"fade"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"active"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,"Whether the grid should fade away with distance. Recommended to be true for\nperspective cameras and false for orthographic cameras."),(0,p.kt)("h4",{id:"parameters"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"active")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,p.kt)("h4",{id:"returns-1"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleGrid/index.ts#L58"},"temp/engine_components/src/core/SimpleGrid/index.ts:58")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"material"},"material"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"material"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"ShaderMaterial")),(0,p.kt)("p",null,"The material of the grid."),(0,p.kt)("h4",{id:"returns-2"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"ShaderMaterial")),(0,p.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleGrid/index.ts#L42"},"temp/engine_components/src/core/SimpleGrid/index.ts:42")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"visible"},"visible"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"visible"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,p.kt)("h4",{id:"returns-3"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"visible")),(0,p.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleGrid/index.ts#L27"},"temp/engine_components/src/core/SimpleGrid/index.ts:27")),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"visible"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"visible"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,p.kt)("h4",{id:"parameters-1"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"visible")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,p.kt)("h4",{id:"returns-4"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"visible")),(0,p.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleGrid/index.ts#L32"},"temp/engine_components/src/core/SimpleGrid/index.ts:32")),(0,p.kt)("h2",{id:"methods"},"Methods"),(0,p.kt)("h3",{id:"dispose"},"dispose"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,p.kt)("h4",{id:"returns-5"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,p.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleGrid/index.ts#L189"},"temp/engine_components/src/core/SimpleGrid/index.ts:189")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"get"},"get"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"get"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,p.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,p.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,p.kt)("h4",{id:"returns-6"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,p.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"Material"),"[], ",(0,p.kt)("inlineCode",{parentName:"p"},"Object3DEventMap"),">"),(0,p.kt)("h4",{id:"overrides-1"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,p.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleGrid/index.ts#L184"},"temp/engine_components/src/core/SimpleGrid/index.ts:184")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"hasui"},"hasUI"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,p.kt)("p",null,"Whether is component implements any kind of ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,p.kt)("h4",{id:"returns-7"},"Returns"),(0,p.kt)("p",null,"this is UI"),(0,p.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,p.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,p.kt)("h4",{id:"returns-8"},"Returns"),(0,p.kt)("p",null,"this is Configurable"),(0,p.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,p.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,p.kt)("h4",{id:"returns-9"},"Returns"),(0,p.kt)("p",null,"this is Disposable"),(0,p.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,p.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ishideable"},"isHideable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,p.kt)("h4",{id:"returns-10"},"Returns"),(0,p.kt)("p",null,"this is Hideable"),(0,p.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,p.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,p.kt)("h4",{id:"returns-11"},"Returns"),(0,p.kt)("p",null,"this is Resizeable"),(0,p.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,p.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,p.kt)("h4",{id:"returns-12"},"Returns"),(0,p.kt)("p",null,"this is Updateable"),(0,p.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,p.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/bfa94da9.0e3b1e62.js b/build/assets/js/bfa94da9.0e3b1e62.js new file mode 100644 index 00000000..b8ecd5a1 --- /dev/null +++ b/build/assets/js/bfa94da9.0e3b1e62.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5261],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>h});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var o=a.createContext({}),s=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},d=function(e){var t=s(e.components);return a.createElement(o.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),m=s(n),u=i,h=m["".concat(o,".").concat(u)]||m[u]||k[u]||r;return n?a.createElement(h,l(l({ref:t},d),{},{components:n})):a.createElement(h,l({ref:t},d))}));function h(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,l=new Array(r);l[0]=u;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[m]="string"==typeof e?e:i,l[1]=p;for(var s=2;s{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>p,metadata:()=>s,toc:()=>m});var a=n(7462),i=n(3366),r=(n(7294),n(3905)),l=["components"],p={id:"openbim_components.MaterialManager",title:"Class: MaterialManager",sidebar_label:"MaterialManager",custom_edit_url:null},o=void 0,s={unversionedId:"api/classes/openbim_components.MaterialManager",id:"api/classes/openbim_components.MaterialManager",title:"Class: MaterialManager",description:"openbim-components.MaterialManager",source:"@site/docs/api/classes/openbim_components.MaterialManager.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.MaterialManager",permalink:"/api/classes/openbim_components.MaterialManager",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.MaterialManager",title:"Class: MaterialManager",sidebar_label:"MaterialManager",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"LengthMeasurement",permalink:"/api/classes/openbim_components.LengthMeasurement"},next:{title:"Mouse",permalink:"/api/classes/openbim_components.Mouse"}},d={},m=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"Methods",id:"methods",level:2},{value:"addMaterial",id:"addmaterial",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"addMeshes",id:"addmeshes",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"removeMeshes",id:"removemeshes",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"resetBackgroundColor",id:"resetbackgroundcolor",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"set",id:"set",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"setBackgroundColor",id:"setbackgroundcolor",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-15",level:4}],k={toc:m},u="wrapper";function h(e){var t=e.components,n=(0,i.Z)(e,l);return(0,r.kt)(u,(0,a.Z)({},k,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".MaterialManager"),(0,r.kt)("p",null,"A tool to easily handle the materials of massive amounts of\nobjects and scene background easily."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,r.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]",">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"MaterialManager"))))),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,r.kt)("inlineCode",{parentName:"a"},"Disposable")))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"enabled"},"enabled"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"enabled"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"true")),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/MaterialManager/index.ts#L17"},"src/core/MaterialManager/index.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,r.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/MaterialManager/index.ts#L22"},"src/core/MaterialManager/index.ts:22")),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"addmaterial"},"addMaterial"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addMaterial"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"material"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Creates a new material style."),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the identifier of the style to create.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"material")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Material")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the material of the style.")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/MaterialManager/index.ts#L125"},"src/core/MaterialManager/index.ts:125")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"addmeshes"},"addMeshes"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addMeshes"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"meshes"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Assign meshes to a certain style."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the identifier of the style.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"meshes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Mesh"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Material"),"[], ",(0,r.kt)("inlineCode",{parentName:"td"},"Object3DEventMap"),">","[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"the meshes to assign to the style.")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/MaterialManager/index.ts#L137"},"src/core/MaterialManager/index.ts:137")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"dispose"},"dispose"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/MaterialManager/index.ts#L83"},"src/core/MaterialManager/index.ts:83")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"get"},"get"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"get"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get"),"."),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"list of created materials."),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/MaterialManager/index.ts#L47"},"src/core/MaterialManager/index.ts:47")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hasui"},"hasUI"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,r.kt)("p",null,"Whether is component implements any kind of ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,"this is UI"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,"this is Configurable"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,"this is Disposable"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ishideable"},"isHideable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,"this is Hideable"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,"this is Resizeable"),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,"this is Updateable"),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removemeshes"},"removeMeshes"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeMeshes"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"meshes"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Remove meshes from a certain style."),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the identifier of the style.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"meshes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Mesh"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Material"),"[], ",(0,r.kt)("inlineCode",{parentName:"td"},"Object3DEventMap"),">","[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"the meshes to assign to the style.")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/MaterialManager/index.ts#L151"},"src/core/MaterialManager/index.ts:151")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"resetbackgroundcolor"},"resetBackgroundColor"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"resetBackgroundColor"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Resets the scene background to the color that was being used\nbefore applying the material manager."),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/MaterialManager/index.ts#L113"},"src/core/MaterialManager/index.ts:113")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"set"},"set"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"set"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"active"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"ids?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Turns the specified material styles on or off."),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"active")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"whether to turn it on or off.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ids")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"the ids of the style to turn on or off.")))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/MaterialManager/index.ts#L57"},"src/core/MaterialManager/index.ts:57")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setbackgroundcolor"},"setBackgroundColor"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setBackgroundColor"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"color"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Sets the color of the background of the scene."),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"color")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Color"))))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/MaterialManager/index.ts#L99"},"src/core/MaterialManager/index.ts:99")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/bfa94da9.b74c43b3.js b/build/assets/js/bfa94da9.b74c43b3.js deleted file mode 100644 index eba3ee4e..00000000 --- a/build/assets/js/bfa94da9.b74c43b3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5261],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>h});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var o=a.createContext({}),s=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},d=function(e){var t=s(e.components);return a.createElement(o.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),m=s(n),u=i,h=m["".concat(o,".").concat(u)]||m[u]||k[u]||r;return n?a.createElement(h,l(l({ref:t},d),{},{components:n})):a.createElement(h,l({ref:t},d))}));function h(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,l=new Array(r);l[0]=u;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[m]="string"==typeof e?e:i,l[1]=p;for(var s=2;s{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>p,metadata:()=>s,toc:()=>m});var a=n(7462),i=n(3366),r=(n(7294),n(3905)),l=["components"],p={id:"openbim_components.MaterialManager",title:"Class: MaterialManager",sidebar_label:"MaterialManager",custom_edit_url:null},o=void 0,s={unversionedId:"api/classes/openbim_components.MaterialManager",id:"api/classes/openbim_components.MaterialManager",title:"Class: MaterialManager",description:"openbim-components.MaterialManager",source:"@site/docs/api/classes/openbim_components.MaterialManager.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.MaterialManager",permalink:"/api/classes/openbim_components.MaterialManager",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.MaterialManager",title:"Class: MaterialManager",sidebar_label:"MaterialManager",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"LengthMeasurement",permalink:"/api/classes/openbim_components.LengthMeasurement"},next:{title:"Mouse",permalink:"/api/classes/openbim_components.Mouse"}},d={},m=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"Methods",id:"methods",level:2},{value:"addMaterial",id:"addmaterial",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"addMeshes",id:"addmeshes",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"removeMeshes",id:"removemeshes",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"resetBackgroundColor",id:"resetbackgroundcolor",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"set",id:"set",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"setBackgroundColor",id:"setbackgroundcolor",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-15",level:4}],k={toc:m},u="wrapper";function h(e){var t=e.components,n=(0,i.Z)(e,l);return(0,r.kt)(u,(0,a.Z)({},k,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".MaterialManager"),(0,r.kt)("p",null,"A tool to easily handle the materials of massive amounts of\nobjects and scene background easily."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,r.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]",">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"MaterialManager"))))),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,r.kt)("inlineCode",{parentName:"a"},"Disposable")))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"enabled"},"enabled"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"enabled"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"true")),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/MaterialManager/index.ts#L17"},"temp/engine_components/src/core/MaterialManager/index.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,r.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/MaterialManager/index.ts#L22"},"temp/engine_components/src/core/MaterialManager/index.ts:22")),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"addmaterial"},"addMaterial"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addMaterial"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"material"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Creates a new material style."),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the identifier of the style to create.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"material")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Material")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the material of the style.")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/MaterialManager/index.ts#L125"},"temp/engine_components/src/core/MaterialManager/index.ts:125")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"addmeshes"},"addMeshes"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addMeshes"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"meshes"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Assign meshes to a certain style."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the identifier of the style.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"meshes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Mesh"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Material"),"[], ",(0,r.kt)("inlineCode",{parentName:"td"},"Object3DEventMap"),">","[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"the meshes to assign to the style.")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/MaterialManager/index.ts#L137"},"temp/engine_components/src/core/MaterialManager/index.ts:137")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"dispose"},"dispose"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/MaterialManager/index.ts#L83"},"temp/engine_components/src/core/MaterialManager/index.ts:83")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"get"},"get"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"get"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get"),"."),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"list of created materials."),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/MaterialManager/index.ts#L47"},"temp/engine_components/src/core/MaterialManager/index.ts:47")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hasui"},"hasUI"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,r.kt)("p",null,"Whether is component implements any kind of ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,"this is UI"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,"this is Configurable"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,"this is Disposable"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ishideable"},"isHideable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,"this is Hideable"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,"this is Resizeable"),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,"this is Updateable"),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removemeshes"},"removeMeshes"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeMeshes"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"meshes"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Remove meshes from a certain style."),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the identifier of the style.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"meshes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Mesh"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"NormalBufferAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Material"),"[], ",(0,r.kt)("inlineCode",{parentName:"td"},"Object3DEventMap"),">","[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"the meshes to assign to the style.")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/MaterialManager/index.ts#L151"},"temp/engine_components/src/core/MaterialManager/index.ts:151")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"resetbackgroundcolor"},"resetBackgroundColor"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"resetBackgroundColor"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Resets the scene background to the color that was being used\nbefore applying the material manager."),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/MaterialManager/index.ts#L113"},"temp/engine_components/src/core/MaterialManager/index.ts:113")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"set"},"set"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"set"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"active"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"ids?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Turns the specified material styles on or off."),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"active")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"whether to turn it on or off.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ids")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"the ids of the style to turn on or off.")))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/MaterialManager/index.ts#L57"},"temp/engine_components/src/core/MaterialManager/index.ts:57")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setbackgroundcolor"},"setBackgroundColor"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setBackgroundColor"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"color"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Sets the color of the background of the scene."),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"color")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Color"))))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/MaterialManager/index.ts#L99"},"temp/engine_components/src/core/MaterialManager/index.ts:99")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/c45a2468.2e412114.js b/build/assets/js/c45a2468.2e412114.js deleted file mode 100644 index 607d8b43..00000000 --- a/build/assets/js/c45a2468.2e412114.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[930],{3905:(e,n,a)=>{a.d(n,{Zo:()=>m,kt:()=>f});var t=a(7294);function i(e,n,a){return n in e?Object.defineProperty(e,n,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[n]=a,e}function r(e,n){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var t=Object.getOwnPropertySymbols(e);n&&(t=t.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),a.push.apply(a,t)}return a}function p(e){for(var n=1;n=0||(i[a]=e[a]);return i}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(t=0;t=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var o=t.createContext({}),s=function(e){var n=t.useContext(o),a=n;return e&&(a="function"==typeof e?e(n):p(p({},n),e)),a},m=function(e){var n=s(e.components);return t.createElement(o.Provider,{value:n},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return t.createElement(t.Fragment,{},n)}},d=t.forwardRef((function(e,n){var a=e.components,i=e.mdxType,r=e.originalType,o=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),c=s(a),d=i,f=c["".concat(o,".").concat(d)]||c[d]||u[d]||r;return a?t.createElement(f,p(p({ref:n},m),{},{components:a})):t.createElement(f,p({ref:n},m))}));function f(e,n){var a=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var r=a.length,p=new Array(r);p[0]=d;var l={};for(var o in n)hasOwnProperty.call(n,o)&&(l[o]=n[o]);l.originalType=e,l[c]="string"==typeof e?e:i,p[1]=l;for(var s=2;s{a.r(n),a.d(n,{assets:()=>m,contentTitle:()=>o,default:()=>f,frontMatter:()=>l,metadata:()=>s,toc:()=>c});var t=a(7462),i=a(3366),r=(a(7294),a(3905)),p=["components"],l={id:"openbim_components",title:"Module: openbim-components",sidebar_label:"openbim-components",sidebar_position:0,custom_edit_url:null},o=void 0,s={unversionedId:"api/modules/openbim_components",id:"api/modules/openbim_components",title:"Module: openbim-components",description:"Classes",source:"@site/docs/api/modules/openbim_components.md",sourceDirName:"api/modules",slug:"/api/modules/openbim_components",permalink:"/api/modules/openbim_components",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"openbim_components",title:"Module: openbim-components",sidebar_label:"openbim-components",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"bim-fragment",permalink:"/api/modules/bim_fragment"},next:{title:"Serializer",permalink:"/api/classes/bim_fragment.Serializer"}},m={},c=[{value:"Classes",id:"classes",level:2},{value:"Interfaces",id:"interfaces",level:2},{value:"Type Aliases",id:"type-aliases",level:2},{value:"CameraProjection",id:"cameraprojection",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"NavModeID",id:"navmodeid",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Variables",id:"variables",level:2},{value:"DimensionLabelClassName",id:"dimensionlabelclassname",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"DimensionPreviewClassName",id:"dimensionpreviewclassname",level:3},{value:"Defined in",id:"defined-in-3",level:4}],u={toc:c},d="wrapper";function f(e){var n=e.components,a=(0,i.Z)(e,p);return(0,r.kt)(d,(0,t.Z)({},u,a,{components:n,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"classes"},"Classes"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.CloudStorage"},"CloudStorage")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Component"},"Component")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Components"},"Components")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.CubeMap"},"CubeMap")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Disposer"},"Disposer")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.EdgesClipper"},"EdgesClipper")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.EdgesPlane"},"EdgesPlane")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Event"},"Event")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentBoundingBox"},"FragmentBoundingBox")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentManager"},"FragmentManager")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentPlans"},"FragmentPlans")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.IfcJsonExporter"},"IfcJsonExporter")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.IfcStreamingSettings"},"IfcStreamingSettings")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.LengthMeasurement"},"LengthMeasurement")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.MaterialManager"},"MaterialManager")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Mouse"},"Mouse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.OrthoPerspectiveCamera"},"OrthoPerspectiveCamera")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.PostproductionRenderer"},"PostproductionRenderer")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.PropertiesStreamingSettings"},"PropertiesStreamingSettings")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.ScreenCuller"},"ScreenCuller")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Simple2DScene"},"Simple2DScene")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleGrid"},"SimpleGrid")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleRaycaster"},"SimpleRaycaster")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleScene"},"SimpleScene")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.ToolComponent"},"ToolComponent")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.UIElement"},"UIElement")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.UIManager"},"UIManager"))),(0,r.kt)("h2",{id:"interfaces"},"Interfaces"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Configurable"},"Configurable")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Createable"},"Createable")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},"Disposable")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.FragmentIdMap"},"FragmentIdMap")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Hideable"},"Hideable")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.NavigationMode"},"NavigationMode")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Progress"},"Progress")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},"UI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"))),(0,r.kt)("h2",{id:"type-aliases"},"Type Aliases"),(0,r.kt)("h3",{id:"cameraprojection"},"CameraProjection"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"CameraProjection"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"Perspective"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"Orthographic"')),(0,r.kt)("p",null,"The projection system of the camera."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/OrthoPerspectiveCamera/src/types.ts#L7"},"temp/engine_components/src/navigation/OrthoPerspectiveCamera/src/types.ts:7")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"navmodeid"},"NavModeID"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"NavModeID"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"Orbit"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"FirstPerson"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"Plan"')),(0,r.kt)("p",null,"The extensible list of supported navigation modes."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/OrthoPerspectiveCamera/src/types.ts#L12"},"temp/engine_components/src/navigation/OrthoPerspectiveCamera/src/types.ts:12")),(0,r.kt)("h2",{id:"variables"},"Variables"),(0,r.kt)("h3",{id:"dimensionlabelclassname"},"DimensionLabelClassName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"DimensionLabelClassName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"text-white text-sm bg-ifcjs-100 rounded-md px-3 py-1"')),(0,r.kt)("p",null,"The name of the CSS class that styles the dimension label."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/SimpleDimensionLine/types.ts#L4"},"temp/engine_components/src/measurement/SimpleDimensionLine/types.ts:4")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"dimensionpreviewclassname"},"DimensionPreviewClassName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"DimensionPreviewClassName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"bg-ifcjs-100 rounded-full w-[8px] h-[8px]"')),(0,r.kt)("p",null,"The name of the CSS class that styles the dimension label."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/measurement/SimpleDimensionLine/types.ts#L8"},"temp/engine_components/src/measurement/SimpleDimensionLine/types.ts:8")))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/c45a2468.472fc769.js b/build/assets/js/c45a2468.472fc769.js new file mode 100644 index 00000000..2a4b8277 --- /dev/null +++ b/build/assets/js/c45a2468.472fc769.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[930],{3905:(e,n,a)=>{a.d(n,{Zo:()=>m,kt:()=>k});var t=a(7294);function i(e,n,a){return n in e?Object.defineProperty(e,n,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[n]=a,e}function r(e,n){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var t=Object.getOwnPropertySymbols(e);n&&(t=t.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),a.push.apply(a,t)}return a}function p(e){for(var n=1;n=0||(i[a]=e[a]);return i}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(t=0;t=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var o=t.createContext({}),s=function(e){var n=t.useContext(o),a=n;return e&&(a="function"==typeof e?e(n):p(p({},n),e)),a},m=function(e){var n=s(e.components);return t.createElement(o.Provider,{value:n},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return t.createElement(t.Fragment,{},n)}},d=t.forwardRef((function(e,n){var a=e.components,i=e.mdxType,r=e.originalType,o=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),c=s(a),d=i,k=c["".concat(o,".").concat(d)]||c[d]||u[d]||r;return a?t.createElement(k,p(p({ref:n},m),{},{components:a})):t.createElement(k,p({ref:n},m))}));function k(e,n){var a=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var r=a.length,p=new Array(r);p[0]=d;var l={};for(var o in n)hasOwnProperty.call(n,o)&&(l[o]=n[o]);l.originalType=e,l[c]="string"==typeof e?e:i,p[1]=l;for(var s=2;s{a.r(n),a.d(n,{assets:()=>m,contentTitle:()=>o,default:()=>k,frontMatter:()=>l,metadata:()=>s,toc:()=>c});var t=a(7462),i=a(3366),r=(a(7294),a(3905)),p=["components"],l={id:"openbim_components",title:"Module: openbim-components",sidebar_label:"openbim-components",sidebar_position:0,custom_edit_url:null},o=void 0,s={unversionedId:"api/modules/openbim_components",id:"api/modules/openbim_components",title:"Module: openbim-components",description:"Classes",source:"@site/docs/api/modules/openbim_components.md",sourceDirName:"api/modules",slug:"/api/modules/openbim_components",permalink:"/api/modules/openbim_components",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"openbim_components",title:"Module: openbim-components",sidebar_label:"openbim-components",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"bim-fragment",permalink:"/api/modules/bim_fragment"},next:{title:"BaseRenderer",permalink:"/api/classes/openbim_components.BaseRenderer"}},m={},c=[{value:"Classes",id:"classes",level:2},{value:"Interfaces",id:"interfaces",level:2},{value:"Type Aliases",id:"type-aliases",level:2},{value:"CameraProjection",id:"cameraprojection",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"NavModeID",id:"navmodeid",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Variables",id:"variables",level:2},{value:"DimensionLabelClassName",id:"dimensionlabelclassname",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"DimensionPreviewClassName",id:"dimensionpreviewclassname",level:3},{value:"Defined in",id:"defined-in-3",level:4}],u={toc:c},d="wrapper";function k(e){var n=e.components,a=(0,i.Z)(e,p);return(0,r.kt)(d,(0,t.Z)({},u,a,{components:n,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"classes"},"Classes"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.CloudStorage"},"CloudStorage")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Component"},"Component")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Components"},"Components")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.CubeMap"},"CubeMap")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Disposer"},"Disposer")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.EdgesClipper"},"EdgesClipper")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.EdgesPlane"},"EdgesPlane")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Event"},"Event")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentBoundingBox"},"FragmentBoundingBox")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentManager"},"FragmentManager")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentPlans"},"FragmentPlans")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.IfcJsonExporter"},"IfcJsonExporter")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.IfcStreamingSettings"},"IfcStreamingSettings")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.LengthMeasurement"},"LengthMeasurement")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.MaterialManager"},"MaterialManager")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Mouse"},"Mouse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.OrthoPerspectiveCamera"},"OrthoPerspectiveCamera")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.PostproductionRenderer"},"PostproductionRenderer")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.PropertiesStreamingSettings"},"PropertiesStreamingSettings")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.ScreenCuller"},"ScreenCuller")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Simple2DScene"},"Simple2DScene")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleGrid"},"SimpleGrid")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleRaycaster"},"SimpleRaycaster")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleScene"},"SimpleScene")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.ToolComponent"},"ToolComponent")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.UIElement"},"UIElement")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.UIManager"},"UIManager"))),(0,r.kt)("h2",{id:"interfaces"},"Interfaces"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Configurable"},"Configurable")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Createable"},"Createable")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},"Disposable")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.FragmentIdMap"},"FragmentIdMap")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Hideable"},"Hideable")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.NavigationMode"},"NavigationMode")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Progress"},"Progress")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},"UI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"))),(0,r.kt)("h2",{id:"type-aliases"},"Type Aliases"),(0,r.kt)("h3",{id:"cameraprojection"},"CameraProjection"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"CameraProjection"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"Perspective"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"Orthographic"')),(0,r.kt)("p",null,"The projection system of the camera."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/OrthoPerspectiveCamera/src/types.ts#L7"},"src/navigation/OrthoPerspectiveCamera/src/types.ts:7")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"navmodeid"},"NavModeID"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"NavModeID"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"Orbit"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"FirstPerson"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"Plan"')),(0,r.kt)("p",null,"The extensible list of supported navigation modes."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/OrthoPerspectiveCamera/src/types.ts#L12"},"src/navigation/OrthoPerspectiveCamera/src/types.ts:12")),(0,r.kt)("h2",{id:"variables"},"Variables"),(0,r.kt)("h3",{id:"dimensionlabelclassname"},"DimensionLabelClassName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"DimensionLabelClassName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"text-white text-sm bg-ifcjs-100 rounded-md px-3 py-1"')),(0,r.kt)("p",null,"The name of the CSS class that styles the dimension label."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/SimpleDimensionLine/types.ts#L4"},"src/measurement/SimpleDimensionLine/types.ts:4")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"dimensionpreviewclassname"},"DimensionPreviewClassName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"DimensionPreviewClassName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"bg-ifcjs-100 rounded-full w-[8px] h-[8px]"')),(0,r.kt)("p",null,"The name of the CSS class that styles the dimension label."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/measurement/SimpleDimensionLine/types.ts#L8"},"src/measurement/SimpleDimensionLine/types.ts:8")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/c4f5d8e4.331c8656.js b/build/assets/js/c4f5d8e4.331c8656.js deleted file mode 100644 index ab8a4fe2..00000000 --- a/build/assets/js/c4f5d8e4.331c8656.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4195],{2841:(e,t,c)=>{c.r(t),c.d(t,{default:()=>r});var n=c(7294),s=c(6550);const r=function(){return n.createElement(s.l_,{to:"/intro"})}}}]); \ No newline at end of file diff --git a/build/assets/js/c5b82270.682229c2.js b/build/assets/js/c5b82270.682229c2.js new file mode 100644 index 00000000..395ba26c --- /dev/null +++ b/build/assets/js/c5b82270.682229c2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2121],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>c});var i=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function p(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=i.createContext({}),l=function(e){var t=i.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},m=function(e){var t=l(e.components);return i.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},h=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,r=e.originalType,s=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),d=l(n),h=a,c=d["".concat(s,".").concat(h)]||d[h]||u[h]||r;return n?i.createElement(c,p(p({ref:t},m),{},{components:n})):i.createElement(c,p({ref:t},m))}));function c(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,p=new Array(r);p[0]=h;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[d]="string"==typeof e?e:a,p[1]=o;for(var l=2;l{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>s,default:()=>c,frontMatter:()=>o,metadata:()=>l,toc:()=>d});var i=n(7462),a=n(3366),r=(n(7294),n(3905)),p=["components"],o={id:"openbim_components.Disposer",title:"Class: Disposer",sidebar_label:"Disposer",custom_edit_url:null},s=void 0,l={unversionedId:"api/classes/openbim_components.Disposer",id:"api/classes/openbim_components.Disposer",title:"Class: Disposer",description:"openbim-components.Disposer",source:"@site/docs/api/classes/openbim_components.Disposer.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.Disposer",permalink:"/api/classes/openbim_components.Disposer",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Disposer",title:"Class: Disposer",sidebar_label:"Disposer",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"CubeMap",permalink:"/api/classes/openbim_components.CubeMap"},next:{title:"EdgesClipper",permalink:"/api/classes/openbim_components.EdgesClipper"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods",level:2},{value:"destroy",id:"destroy",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"disposeGeometry",id:"disposegeometry",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-9",level:4}],u={toc:d},h="wrapper";function c(e){var t=e.components,n=(0,a.Z)(e,p);return(0,r.kt)(h,(0,i.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Disposer"),(0,r.kt)("p",null,"A tool to safely remove meshes and geometries from memory to\n",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#manual/en/introduction/How-to-dispose-of-objects"},"prevent memory leaks"),"."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,r.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Set"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">",">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Disposer"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"enabled"},"enabled"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"enabled"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"true")),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Disposer/index.ts#L14"},"src/core/Disposer/index.ts:14")),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"destroy"},"destroy"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"destroy"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"object"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"materials?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"recursive?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Removes a mesh, its geometry and its materials from memory. If you are\nusing any of these in other parts of the application, make sure that you\nremove them from the mesh before disposing it."),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"object")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object3D"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Object3DEventMap"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the ",(0,r.kt)("a",{parentName:"td",href:"https://threejs.org/docs/#api/en/core/Object3D"},"object")," to remove.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"materials")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"true")),(0,r.kt)("td",{parentName:"tr",align:"left"},"whether to dispose the materials of the mesh.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"recursive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"true")),(0,r.kt)("td",{parentName:"tr",align:"left"},"whether to recursively dispose the children of the mesh.")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Disposer/index.ts#L43"},"src/core/Disposer/index.ts:43")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"disposegeometry"},"disposeGeometry"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"disposeGeometry"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"geometry"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Disposes a geometry from memory."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"geometry")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"NormalBufferAttributes"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"the ",(0,r.kt)("a",{parentName:"td",href:"https://threejs.org/docs/#api/en/core/BufferGeometry"},"geometry")," to remove.")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Disposer/index.ts#L64"},"src/core/Disposer/index.ts:64")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"get"},"get"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"get"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Set"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Component.uuid."),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Set"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"the list of UUIDs of deleted components."),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/Disposer/index.ts#L27"},"src/core/Disposer/index.ts:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hasui"},"hasUI"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,r.kt)("p",null,"Whether is component implements any kind of ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,"this is UI"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,"this is Configurable"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,"this is Disposable"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ishideable"},"isHideable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,"this is Hideable"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,"this is Resizeable"),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,"this is Updateable"),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/c5b82270.b5d85e65.js b/build/assets/js/c5b82270.b5d85e65.js deleted file mode 100644 index 00e02b38..00000000 --- a/build/assets/js/c5b82270.b5d85e65.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2121],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>h});var i=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function p(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=i.createContext({}),l=function(e){var t=i.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},m=function(e){var t=l(e.components);return i.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},c=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,r=e.originalType,s=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),d=l(n),c=a,h=d["".concat(s,".").concat(c)]||d[c]||u[c]||r;return n?i.createElement(h,p(p({ref:t},m),{},{components:n})):i.createElement(h,p({ref:t},m))}));function h(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,p=new Array(r);p[0]=c;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[d]="string"==typeof e?e:a,p[1]=o;for(var l=2;l{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>s,default:()=>h,frontMatter:()=>o,metadata:()=>l,toc:()=>d});var i=n(7462),a=n(3366),r=(n(7294),n(3905)),p=["components"],o={id:"openbim_components.Disposer",title:"Class: Disposer",sidebar_label:"Disposer",custom_edit_url:null},s=void 0,l={unversionedId:"api/classes/openbim_components.Disposer",id:"api/classes/openbim_components.Disposer",title:"Class: Disposer",description:"openbim-components.Disposer",source:"@site/docs/api/classes/openbim_components.Disposer.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.Disposer",permalink:"/api/classes/openbim_components.Disposer",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Disposer",title:"Class: Disposer",sidebar_label:"Disposer",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"CubeMap",permalink:"/api/classes/openbim_components.CubeMap"},next:{title:"EdgesClipper",permalink:"/api/classes/openbim_components.EdgesClipper"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods",level:2},{value:"destroy",id:"destroy",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"disposeGeometry",id:"disposegeometry",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-9",level:4}],u={toc:d},c="wrapper";function h(e){var t=e.components,n=(0,a.Z)(e,p);return(0,r.kt)(c,(0,i.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Disposer"),(0,r.kt)("p",null,"A tool to safely remove meshes and geometries from memory to\n",(0,r.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#manual/en/introduction/How-to-dispose-of-objects"},"prevent memory leaks"),"."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,r.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Set"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">",">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Disposer"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"enabled"},"enabled"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"enabled"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"true")),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Disposer/index.ts#L14"},"temp/engine_components/src/core/Disposer/index.ts:14")),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"destroy"},"destroy"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"destroy"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"object"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"materials?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"recursive?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Removes a mesh, its geometry and its materials from memory. If you are\nusing any of these in other parts of the application, make sure that you\nremove them from the mesh before disposing it."),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"object")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object3D"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Object3DEventMap"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the ",(0,r.kt)("a",{parentName:"td",href:"https://threejs.org/docs/#api/en/core/Object3D"},"object")," to remove.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"materials")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"true")),(0,r.kt)("td",{parentName:"tr",align:"left"},"whether to dispose the materials of the mesh.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"recursive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"true")),(0,r.kt)("td",{parentName:"tr",align:"left"},"whether to recursively dispose the children of the mesh.")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Disposer/index.ts#L43"},"temp/engine_components/src/core/Disposer/index.ts:43")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"disposegeometry"},"disposeGeometry"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"disposeGeometry"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"geometry"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Disposes a geometry from memory."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"geometry")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"BufferGeometry"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"NormalBufferAttributes"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"the ",(0,r.kt)("a",{parentName:"td",href:"https://threejs.org/docs/#api/en/core/BufferGeometry"},"geometry")," to remove.")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Disposer/index.ts#L64"},"temp/engine_components/src/core/Disposer/index.ts:64")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"get"},"get"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"get"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Set"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Component.uuid."),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Set"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"the list of UUIDs of deleted components."),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/Disposer/index.ts#L27"},"temp/engine_components/src/core/Disposer/index.ts:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hasui"},"hasUI"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,r.kt)("p",null,"Whether is component implements any kind of ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,"this is UI"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,"this is Configurable"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,"this is Disposable"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ishideable"},"isHideable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,"this is Hideable"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,"this is Resizeable"),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,r.kt)("p",null,"Whether is component is ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,"this is Updateable"),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/c8ce6040.0ff6da5e.js b/build/assets/js/c8ce6040.8e5224ce.js similarity index 97% rename from build/assets/js/c8ce6040.0ff6da5e.js rename to build/assets/js/c8ce6040.8e5224ce.js index c146535e..80c582f5 100644 --- a/build/assets/js/c8ce6040.0ff6da5e.js +++ b/build/assets/js/c8ce6040.8e5224ce.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8182],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>f});var r=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var l=r.createContext({}),s=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},m=function(e){var n=s(e.components);return r.createElement(l.Provider,{value:n},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),c=s(t),d=a,f=c["".concat(l,".").concat(d)]||c[d]||u[d]||i;return t?r.createElement(f,o(o({ref:n},m),{},{components:t})):r.createElement(f,o({ref:n},m))}));function f(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,o=new Array(i);o[0]=d;var p={};for(var l in n)hasOwnProperty.call(n,l)&&(p[l]=n[l]);p.originalType=e,p[c]="string"==typeof e?e:a,o[1]=p;for(var s=2;s{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>l,default:()=>f,frontMatter:()=>p,metadata:()=>s,toc:()=>c});var r=t(7462),a=t(3366),i=(t(7294),t(3905)),o=["components"],p={id:"openbim_components.UI",title:"Interface: UI",sidebar_label:"UI",custom_edit_url:null},l=void 0,s={unversionedId:"api/interfaces/openbim_components.UI",id:"api/interfaces/openbim_components.UI",title:"Interface: UI",description:"openbim-components.UI",source:"@site/docs/api/interfaces/openbim_components.UI.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/openbim_components.UI",permalink:"/api/interfaces/openbim_components.UI",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.UI",title:"Interface: UI",sidebar_label:"UI",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Resizeable",permalink:"/api/interfaces/openbim_components.Resizeable"},next:{title:"Updateable",permalink:"/api/interfaces/openbim_components.Updateable"}},m={},c=[{value:"Implemented by",id:"implemented-by",level:2},{value:"Properties",id:"properties",level:2},{value:"uiElement",id:"uielement",level:3},{value:"Defined in",id:"defined-in",level:4}],u={toc:c},d="wrapper";function f(e){var n=e.components,t=(0,a.Z)(e,o);return(0,i.kt)(d,(0,r.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".UI"),(0,i.kt)("p",null,"Whether this component has a representation in the user\ninterface, like a button or a window."),(0,i.kt)("h2",{id:"implemented-by"},"Implemented by"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentManager"},(0,i.kt)("inlineCode",{parentName:"a"},"FragmentManager"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentPlans"},(0,i.kt)("inlineCode",{parentName:"a"},"FragmentPlans"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.LengthMeasurement"},(0,i.kt)("inlineCode",{parentName:"a"},"LengthMeasurement"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.OrthoPerspectiveCamera"},(0,i.kt)("inlineCode",{parentName:"a"},"OrthoPerspectiveCamera"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Simple2DScene"},(0,i.kt)("inlineCode",{parentName:"a"},"Simple2DScene"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleClipper"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleClipper")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"uielement"},"uiElement"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"uiElement"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.UIElement"},(0,i.kt)("inlineCode",{parentName:"a"},"UIElement")),"<{ ",(0,i.kt)("inlineCode",{parentName:"p"},"[name: string]"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"SimpleUIComponent"),"; }",">"),(0,i.kt)("p",null,"The class containing all the buttons, windows, tables, etc., of this component."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L197"},"temp/engine_components/src/base-types/base-types.ts:197")))}f.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8182],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>f});var r=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var l=r.createContext({}),s=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},m=function(e){var n=s(e.components);return r.createElement(l.Provider,{value:n},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),c=s(t),d=a,f=c["".concat(l,".").concat(d)]||c[d]||u[d]||i;return t?r.createElement(f,o(o({ref:n},m),{},{components:t})):r.createElement(f,o({ref:n},m))}));function f(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,o=new Array(i);o[0]=d;var p={};for(var l in n)hasOwnProperty.call(n,l)&&(p[l]=n[l]);p.originalType=e,p[c]="string"==typeof e?e:a,o[1]=p;for(var s=2;s{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>l,default:()=>f,frontMatter:()=>p,metadata:()=>s,toc:()=>c});var r=t(7462),a=t(3366),i=(t(7294),t(3905)),o=["components"],p={id:"openbim_components.UI",title:"Interface: UI",sidebar_label:"UI",custom_edit_url:null},l=void 0,s={unversionedId:"api/interfaces/openbim_components.UI",id:"api/interfaces/openbim_components.UI",title:"Interface: UI",description:"openbim-components.UI",source:"@site/docs/api/interfaces/openbim_components.UI.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/openbim_components.UI",permalink:"/api/interfaces/openbim_components.UI",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.UI",title:"Interface: UI",sidebar_label:"UI",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Resizeable",permalink:"/api/interfaces/openbim_components.Resizeable"},next:{title:"Updateable",permalink:"/api/interfaces/openbim_components.Updateable"}},m={},c=[{value:"Implemented by",id:"implemented-by",level:2},{value:"Properties",id:"properties",level:2},{value:"uiElement",id:"uielement",level:3},{value:"Defined in",id:"defined-in",level:4}],u={toc:c},d="wrapper";function f(e){var n=e.components,t=(0,a.Z)(e,o);return(0,i.kt)(d,(0,r.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".UI"),(0,i.kt)("p",null,"Whether this component has a representation in the user\ninterface, like a button or a window."),(0,i.kt)("h2",{id:"implemented-by"},"Implemented by"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentManager"},(0,i.kt)("inlineCode",{parentName:"a"},"FragmentManager"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentPlans"},(0,i.kt)("inlineCode",{parentName:"a"},"FragmentPlans"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.LengthMeasurement"},(0,i.kt)("inlineCode",{parentName:"a"},"LengthMeasurement"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.OrthoPerspectiveCamera"},(0,i.kt)("inlineCode",{parentName:"a"},"OrthoPerspectiveCamera"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Simple2DScene"},(0,i.kt)("inlineCode",{parentName:"a"},"Simple2DScene"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleClipper"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleClipper")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"uielement"},"uiElement"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"uiElement"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.UIElement"},(0,i.kt)("inlineCode",{parentName:"a"},"UIElement")),"<{ ",(0,i.kt)("inlineCode",{parentName:"p"},"[name: string]"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"SimpleUIComponent"),"; }",">"),(0,i.kt)("p",null,"The class containing all the buttons, windows, tables, etc., of this component."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L197"},"src/base-types/base-types.ts:197")))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/cce8cd0d.1c5fe7f0.js b/build/assets/js/cce8cd0d.c6f78c15.js similarity index 59% rename from build/assets/js/cce8cd0d.1c5fe7f0.js rename to build/assets/js/cce8cd0d.c6f78c15.js index 4d7d273f..31405049 100644 --- a/build/assets/js/cce8cd0d.1c5fe7f0.js +++ b/build/assets/js/cce8cd0d.c6f78c15.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[984],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>f});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function p(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=a.createContext({}),s=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},m=function(e){var t=s(e.components);return a.createElement(l.Provider,{value:t},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,l=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),d=s(n),u=r,f=d["".concat(l,".").concat(u)]||d[u]||c[u]||i;return n?a.createElement(f,p(p({ref:t},m),{},{components:n})):a.createElement(f,p({ref:t},m))}));function f(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,p=new Array(i);p[0]=u;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o[d]="string"==typeof e?e:r,p[1]=o;for(var s=2;s{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>l,default:()=>f,frontMatter:()=>o,metadata:()=>s,toc:()=>d});var a=n(7462),r=n(3366),i=(n(7294),n(3905)),p=["components"],o={id:"openbim_components.Configurable",title:"Interface: Configurable",sidebar_label:"Configurable",custom_edit_url:null},l=void 0,s={unversionedId:"api/interfaces/openbim_components.Configurable",id:"api/interfaces/openbim_components.Configurable",title:"Interface: Configurable",description:"openbim-components.Configurable",source:"@site/docs/api/interfaces/openbim_components.Configurable.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/openbim_components.Configurable",permalink:"/api/interfaces/openbim_components.Configurable",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Configurable",title:"Interface: Configurable",sidebar_label:"Configurable",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"UIManager",permalink:"/api/classes/openbim_components.UIManager"},next:{title:"Createable",permalink:"/api/interfaces/openbim_components.Createable"}},m={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Implemented by",id:"implemented-by",level:2},{value:"Properties",id:"properties",level:2},{value:"config",id:"config",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"isSetup",id:"issetup",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"onSetup",id:"onsetup",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"setup",id:"setup",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:d},u="wrapper";function f(e){var t=e.components,n=(0,r.Z)(e,p);return(0,i.kt)(u,(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Configurable"),(0,i.kt)("p",null,"Whether this component supports to be configured."),(0,i.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,i.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,i.kt)("h2",{id:"implemented-by"},"Implemented by"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.ScreenCuller"},(0,i.kt)("inlineCode",{parentName:"a"},"ScreenCuller"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleScene"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleScene")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"config"},"config"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"config"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Required"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,i.kt)("p",null,"Object holding the tool configuration. Is not meant to be edited directly, if you need\nto make changes to this object, use ",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable#setup"},"()")," just after the tool is instantiated."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L188"},"temp/engine_components/src/base-types/base-types.ts:188")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"issetup"},"isSetup"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"isSetup"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Wether this components has been already configured."),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L177"},"temp/engine_components/src/base-types/base-types.ts:177")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onsetup"},"onSetup"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onSetup"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("p",null,"Fired after successfully calling ",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable#setup"},"()")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L183"},"temp/engine_components/src/base-types/base-types.ts:183")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"setup"},"setup"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"setup"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"config?"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">",") => ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("p",null,"\u25b8 (",(0,i.kt)("inlineCode",{parentName:"p"},"config?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Use the provided configuration to setup the tool."),(0,i.kt)("h5",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"config?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,i.kt)("h5",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L180"},"temp/engine_components/src/base-types/base-types.ts:180")))}f.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[984],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>f});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function p(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=a.createContext({}),s=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},m=function(e){var t=s(e.components);return a.createElement(l.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},c=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,l=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),d=s(n),c=r,f=d["".concat(l,".").concat(c)]||d[c]||u[c]||i;return n?a.createElement(f,p(p({ref:t},m),{},{components:n})):a.createElement(f,p({ref:t},m))}));function f(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,p=new Array(i);p[0]=c;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o[d]="string"==typeof e?e:r,p[1]=o;for(var s=2;s{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>l,default:()=>f,frontMatter:()=>o,metadata:()=>s,toc:()=>d});var a=n(7462),r=n(3366),i=(n(7294),n(3905)),p=["components"],o={id:"openbim_components.Configurable",title:"Interface: Configurable",sidebar_label:"Configurable",custom_edit_url:null},l=void 0,s={unversionedId:"api/interfaces/openbim_components.Configurable",id:"api/interfaces/openbim_components.Configurable",title:"Interface: Configurable",description:"openbim-components.Configurable",source:"@site/docs/api/interfaces/openbim_components.Configurable.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/openbim_components.Configurable",permalink:"/api/interfaces/openbim_components.Configurable",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Configurable",title:"Interface: Configurable",sidebar_label:"Configurable",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"UIManager",permalink:"/api/classes/openbim_components.UIManager"},next:{title:"Createable",permalink:"/api/interfaces/openbim_components.Createable"}},m={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Implemented by",id:"implemented-by",level:2},{value:"Properties",id:"properties",level:2},{value:"config",id:"config",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"isSetup",id:"issetup",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"onSetup",id:"onsetup",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"setup",id:"setup",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-3",level:4}],u={toc:d},c="wrapper";function f(e){var t=e.components,n=(0,r.Z)(e,p);return(0,i.kt)(c,(0,a.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Configurable"),(0,i.kt)("p",null,"Whether this component supports to be configured."),(0,i.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,i.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,i.kt)("h2",{id:"implemented-by"},"Implemented by"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.ScreenCuller"},(0,i.kt)("inlineCode",{parentName:"a"},"ScreenCuller"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleScene"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleScene")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"config"},"config"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"config"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Required"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,i.kt)("p",null,"Object holding the tool configuration. Is not meant to be edited directly, if you need\nto make changes to this object, use ",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable#setup"},"()")," just after the tool is instantiated."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L188"},"src/base-types/base-types.ts:188")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"issetup"},"isSetup"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"isSetup"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Wether this components has been already configured."),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L177"},"src/base-types/base-types.ts:177")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onsetup"},"onSetup"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onSetup"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("p",null,"Fired after successfully calling ",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable#setup"},"()")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L183"},"src/base-types/base-types.ts:183")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"setup"},"setup"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"setup"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"config?"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">",") => ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("p",null,"\u25b8 (",(0,i.kt)("inlineCode",{parentName:"p"},"config?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Use the provided configuration to setup the tool."),(0,i.kt)("h5",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"config?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,i.kt)("h5",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L180"},"src/base-types/base-types.ts:180")))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/cd51b51b.a542e752.js b/build/assets/js/cd51b51b.9d27f28e.js similarity index 58% rename from build/assets/js/cd51b51b.a542e752.js rename to build/assets/js/cd51b51b.9d27f28e.js index 9cd83447..ff005aef 100644 --- a/build/assets/js/cd51b51b.a542e752.js +++ b/build/assets/js/cd51b51b.9d27f28e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6993],{3905:(e,n,t)=>{t.d(n,{Zo:()=>c,kt:()=>u});var r=t(7294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var l=r.createContext({}),s=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},c=function(e){var n=s(e.components);return r.createElement(l.Provider,{value:n},e.children)},m="mdxType",d={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},b=r.forwardRef((function(e,n){var t=e.components,i=e.mdxType,a=e.originalType,l=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),m=s(t),b=i,u=m["".concat(l,".").concat(b)]||m[b]||d[b]||a;return t?r.createElement(u,o(o({ref:n},c),{},{components:t})):r.createElement(u,o({ref:n},c))}));function u(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var a=t.length,o=new Array(a);o[0]=b;var p={};for(var l in n)hasOwnProperty.call(n,l)&&(p[l]=n[l]);p.originalType=e,p[m]="string"==typeof e?e:i,o[1]=p;for(var s=2;s{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>u,frontMatter:()=>p,metadata:()=>s,toc:()=>m});var r=t(7462),i=t(3366),a=(t(7294),t(3905)),o=["components"],p={id:"openbim_components.Hideable",title:"Interface: Hideable",sidebar_label:"Hideable",custom_edit_url:null},l=void 0,s={unversionedId:"api/interfaces/openbim_components.Hideable",id:"api/interfaces/openbim_components.Hideable",title:"Interface: Hideable",description:"openbim-components.Hideable",source:"@site/docs/api/interfaces/openbim_components.Hideable.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/openbim_components.Hideable",permalink:"/api/interfaces/openbim_components.Hideable",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Hideable",title:"Interface: Hideable",sidebar_label:"Hideable",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"FragmentIdMap",permalink:"/api/interfaces/openbim_components.FragmentIdMap"},next:{title:"NavigationMode",permalink:"/api/interfaces/openbim_components.NavigationMode"}},c={},m=[{value:"Implemented by",id:"implemented-by",level:2},{value:"Properties",id:"properties",level:2},{value:"visible",id:"visible",level:3},{value:"Defined in",id:"defined-in",level:4}],d={toc:m},b="wrapper";function u(e){var n=e.components,t=(0,i.Z)(e,o);return(0,a.kt)(b,(0,r.Z)({},d,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Hideable"),(0,a.kt)("p",null,"Whether the geometric representation of this component can be\nhidden or shown in the\n",(0,a.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/scenes/Scene"},"Three.js scene"),"."),(0,a.kt)("h2",{id:"implemented-by"},"Implemented by"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.CubeMap"},(0,a.kt)("inlineCode",{parentName:"a"},"CubeMap"))),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.LengthMeasurement"},(0,a.kt)("inlineCode",{parentName:"a"},"LengthMeasurement"))),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleClipper"},(0,a.kt)("inlineCode",{parentName:"a"},"SimpleClipper"))),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleGrid"},(0,a.kt)("inlineCode",{parentName:"a"},"SimpleGrid"))),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimplePlane"},(0,a.kt)("inlineCode",{parentName:"a"},"SimplePlane")))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"visible"},"visible"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"visible"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"Whether the geometric representation of this component is\ncurrently visible or not in the\n",(0,a.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/scenes/Scene"},"Three.js scene"),"."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/base-types.ts#L77"},"temp/engine_components/src/base-types/base-types.ts:77")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6993],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>b});var r=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=r.createContext({}),s=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},c=function(e){var t=s(e.components);return r.createElement(l.Provider,{value:t},e.children)},m="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,l=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),m=s(n),u=i,b=m["".concat(l,".").concat(u)]||m[u]||d[u]||a;return n?r.createElement(b,o(o({ref:t},c),{},{components:n})):r.createElement(b,o({ref:t},c))}));function b(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,o=new Array(a);o[0]=u;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p[m]="string"==typeof e?e:i,o[1]=p;for(var s=2;s{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>b,frontMatter:()=>p,metadata:()=>s,toc:()=>m});var r=n(7462),i=n(3366),a=(n(7294),n(3905)),o=["components"],p={id:"openbim_components.Hideable",title:"Interface: Hideable",sidebar_label:"Hideable",custom_edit_url:null},l=void 0,s={unversionedId:"api/interfaces/openbim_components.Hideable",id:"api/interfaces/openbim_components.Hideable",title:"Interface: Hideable",description:"openbim-components.Hideable",source:"@site/docs/api/interfaces/openbim_components.Hideable.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/openbim_components.Hideable",permalink:"/api/interfaces/openbim_components.Hideable",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.Hideable",title:"Interface: Hideable",sidebar_label:"Hideable",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"FragmentIdMap",permalink:"/api/interfaces/openbim_components.FragmentIdMap"},next:{title:"NavigationMode",permalink:"/api/interfaces/openbim_components.NavigationMode"}},c={},m=[{value:"Implemented by",id:"implemented-by",level:2},{value:"Properties",id:"properties",level:2},{value:"visible",id:"visible",level:3},{value:"Defined in",id:"defined-in",level:4}],d={toc:m},u="wrapper";function b(e){var t=e.components,n=(0,i.Z)(e,o);return(0,a.kt)(u,(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Hideable"),(0,a.kt)("p",null,"Whether the geometric representation of this component can be\nhidden or shown in the\n",(0,a.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/scenes/Scene"},"Three.js scene"),"."),(0,a.kt)("h2",{id:"implemented-by"},"Implemented by"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.CubeMap"},(0,a.kt)("inlineCode",{parentName:"a"},"CubeMap"))),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.LengthMeasurement"},(0,a.kt)("inlineCode",{parentName:"a"},"LengthMeasurement"))),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleClipper"},(0,a.kt)("inlineCode",{parentName:"a"},"SimpleClipper"))),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleGrid"},(0,a.kt)("inlineCode",{parentName:"a"},"SimpleGrid"))),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimplePlane"},(0,a.kt)("inlineCode",{parentName:"a"},"SimplePlane")))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"visible"},"visible"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"visible"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"Whether the geometric representation of this component is\ncurrently visible or not in the\n",(0,a.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/scenes/Scene"},"Three.js scene"),"."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/base-types.ts#L77"},"src/base-types/base-types.ts:77")))}b.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/cf0958e4.4fd15b2b.js b/build/assets/js/cf0958e4.4fd15b2b.js deleted file mode 100644 index b68fb3fb..00000000 --- a/build/assets/js/cf0958e4.4fd15b2b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6630],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>b});var i=t(7294);function o(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function p(e){for(var n=1;n=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var r=i.createContext({}),l=function(e){var n=i.useContext(r),t=n;return e&&(t="function"==typeof e?e(n):p(p({},n),e)),t},m=function(e){var n=l(e.components);return i.createElement(r.Provider,{value:n},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},c=i.forwardRef((function(e,n){var t=e.components,o=e.mdxType,a=e.originalType,r=e.parentName,m=s(e,["components","mdxType","originalType","parentName"]),d=l(t),c=o,b=d["".concat(r,".").concat(c)]||d[c]||u[c]||a;return t?i.createElement(b,p(p({ref:n},m),{},{components:t})):i.createElement(b,p({ref:n},m))}));function b(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var a=t.length,p=new Array(a);p[0]=c;var s={};for(var r in n)hasOwnProperty.call(n,r)&&(s[r]=n[r]);s.originalType=e,s[d]="string"==typeof e?e:o,p[1]=s;for(var l=2;l{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>r,default:()=>b,frontMatter:()=>s,metadata:()=>l,toc:()=>d});var i=t(7462),o=t(3366),a=(t(7294),t(3905)),p=["components"],s={id:"openbim_components.FragmentBoundingBox",title:"Class: FragmentBoundingBox",sidebar_label:"FragmentBoundingBox",custom_edit_url:null},r=void 0,l={unversionedId:"api/classes/openbim_components.FragmentBoundingBox",id:"api/classes/openbim_components.FragmentBoundingBox",title:"Class: FragmentBoundingBox",description:"openbim-components.FragmentBoundingBox",source:"@site/docs/api/classes/openbim_components.FragmentBoundingBox.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.FragmentBoundingBox",permalink:"/api/classes/openbim_components.FragmentBoundingBox",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.FragmentBoundingBox",title:"Class: FragmentBoundingBox",sidebar_label:"FragmentBoundingBox",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Event",permalink:"/api/classes/openbim_components.Event"},next:{title:"FragmentManager",permalink:"/api/classes/openbim_components.FragmentManager"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-8",level:4}],u={toc:d},c="wrapper";function b(e){var n=e.components,t=(0,o.Z)(e,p);return(0,a.kt)(c,(0,i.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".FragmentBoundingBox"),(0,a.kt)("p",null,"A simple implementation of bounding box that works for fragments. The resulting bbox is not 100% precise, but\nit's fast, and should suffice for general use cases such as camera zooming or general boundary determination."),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,a.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"FragmentBoundingBox"))))),(0,a.kt)("h2",{id:"implements"},"Implements"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,a.kt)("inlineCode",{parentName:"a"},"Disposable")))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"enabled"},"enabled"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"enabled"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"true")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentBoundingBox/index.ts#L16"},"temp/engine_components/src/fragments/FragmentBoundingBox/index.ts:16")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,a.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,a.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentBoundingBox/index.ts#L19"},"temp/engine_components/src/fragments/FragmentBoundingBox/index.ts:19")),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"dispose"},"dispose"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentBoundingBox/index.ts#L72"},"temp/engine_components/src/fragments/FragmentBoundingBox/index.ts:72")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"hasui"},"hasUI"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,a.kt)("p",null,"Whether is component implements any kind of ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,"this is UI"),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,"this is Configurable"),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,"this is Disposable"),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ishideable"},"isHideable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,"this is Hideable"),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,"this is Resizeable"),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,"this is Updateable"),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")))}b.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/cf0958e4.f10b8a37.js b/build/assets/js/cf0958e4.f10b8a37.js new file mode 100644 index 00000000..83b2107f --- /dev/null +++ b/build/assets/js/cf0958e4.f10b8a37.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6630],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>b});var i=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function o(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function s(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var r=i.createContext({}),l=function(e){var n=i.useContext(r),t=n;return e&&(t="function"==typeof e?e(n):s(s({},n),e)),t},m=function(e){var n=l(e.components);return i.createElement(r.Provider,{value:n},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},c=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,o=e.originalType,r=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),d=l(t),c=a,b=d["".concat(r,".").concat(c)]||d[c]||u[c]||o;return t?i.createElement(b,s(s({ref:n},m),{},{components:t})):i.createElement(b,s({ref:n},m))}));function b(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var o=t.length,s=new Array(o);s[0]=c;var p={};for(var r in n)hasOwnProperty.call(n,r)&&(p[r]=n[r]);p.originalType=e,p[d]="string"==typeof e?e:a,s[1]=p;for(var l=2;l{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>r,default:()=>b,frontMatter:()=>p,metadata:()=>l,toc:()=>d});var i=t(7462),a=t(3366),o=(t(7294),t(3905)),s=["components"],p={id:"openbim_components.FragmentBoundingBox",title:"Class: FragmentBoundingBox",sidebar_label:"FragmentBoundingBox",custom_edit_url:null},r=void 0,l={unversionedId:"api/classes/openbim_components.FragmentBoundingBox",id:"api/classes/openbim_components.FragmentBoundingBox",title:"Class: FragmentBoundingBox",description:"openbim-components.FragmentBoundingBox",source:"@site/docs/api/classes/openbim_components.FragmentBoundingBox.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.FragmentBoundingBox",permalink:"/api/classes/openbim_components.FragmentBoundingBox",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.FragmentBoundingBox",title:"Class: FragmentBoundingBox",sidebar_label:"FragmentBoundingBox",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Event",permalink:"/api/classes/openbim_components.Event"},next:{title:"FragmentManager",permalink:"/api/classes/openbim_components.FragmentManager"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"enabled",id:"enabled",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-8",level:4}],u={toc:d},c="wrapper";function b(e){var n=e.components,t=(0,a.Z)(e,s);return(0,o.kt)(c,(0,i.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".FragmentBoundingBox"),(0,o.kt)("p",null,"A simple implementation of bounding box that works for fragments. The resulting bbox is not 100% precise, but\nit's fast, and should suffice for general use cases such as camera zooming or general boundary determination."),(0,o.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("p",{parentName:"li"},(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,o.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,o.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,o.kt)("p",{parentName:"li"},"\u21b3 ",(0,o.kt)("strong",{parentName:"p"},(0,o.kt)("inlineCode",{parentName:"strong"},"FragmentBoundingBox"))))),(0,o.kt)("h2",{id:"implements"},"Implements"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,o.kt)("inlineCode",{parentName:"a"},"Disposable")))),(0,o.kt)("h2",{id:"properties"},"Properties"),(0,o.kt)("h3",{id:"enabled"},"enabled"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"enabled"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,o.kt)("inlineCode",{parentName:"p"},"true")),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,o.kt)("h4",{id:"overrides"},"Overrides"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentBoundingBox/index.ts#L17"},"src/fragments/FragmentBoundingBox/index.ts:17")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,o.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,o.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,o.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,o.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,o.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentBoundingBox/index.ts#L20"},"src/fragments/FragmentBoundingBox/index.ts:20")),(0,o.kt)("h2",{id:"methods"},"Methods"),(0,o.kt)("h3",{id:"dispose"},"dispose"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,o.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,o.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,o.kt)("h4",{id:"returns"},"Returns"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,o.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,o.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,o.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentBoundingBox/index.ts#L73"},"src/fragments/FragmentBoundingBox/index.ts:73")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"hasui"},"hasUI"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,o.kt)("p",null,"Whether is component implements any kind of ",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,o.kt)("h4",{id:"returns-1"},"Returns"),(0,o.kt)("p",null,"this is UI"),(0,o.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,o.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,o.kt)("p",null,"Whether is component is ",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,o.kt)("h4",{id:"returns-2"},"Returns"),(0,o.kt)("p",null,"this is Configurable"),(0,o.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,o.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,o.kt)("p",null,"Whether is component is ",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,o.kt)("h4",{id:"returns-3"},"Returns"),(0,o.kt)("p",null,"this is Disposable"),(0,o.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,o.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"ishideable"},"isHideable"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,o.kt)("p",null,"Whether is component is ",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,o.kt)("h4",{id:"returns-4"},"Returns"),(0,o.kt)("p",null,"this is Hideable"),(0,o.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,o.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,o.kt)("p",null,"Whether is component is ",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,o.kt)("h4",{id:"returns-5"},"Returns"),(0,o.kt)("p",null,"this is Resizeable"),(0,o.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,o.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,o.kt)("p",null,"\u25b8 ",(0,o.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,o.kt)("p",null,"Whether is component is ",(0,o.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,o.kt)("h4",{id:"returns-6"},"Returns"),(0,o.kt)("p",null,"this is Updateable"),(0,o.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,o.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,o.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")))}b.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/d05ab5b9.a01219f1.js b/build/assets/js/d05ab5b9.a01219f1.js new file mode 100644 index 00000000..721e4570 --- /dev/null +++ b/build/assets/js/d05ab5b9.a01219f1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4646],{5745:s=>{s.exports=JSON.parse('{"name":"docusaurus-plugin-content-pages","id":"default"}')}}]); \ No newline at end of file diff --git a/build/assets/js/d2ce3c47.df1d4159.js b/build/assets/js/d2ce3c47.03e65e26.js similarity index 80% rename from build/assets/js/d2ce3c47.df1d4159.js rename to build/assets/js/d2ce3c47.03e65e26.js index e7cda637..89ce0654 100644 --- a/build/assets/js/d2ce3c47.df1d4159.js +++ b/build/assets/js/d2ce3c47.03e65e26.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4961],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>h});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=a.createContext({}),m=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},p=function(e){var t=m(e.components);return a.createElement(l.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,l=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),c=m(n),d=r,h=c["".concat(l,".").concat(d)]||c[d]||u[d]||o;return n?a.createElement(h,s(s({ref:t},p),{},{components:n})):a.createElement(h,s({ref:t},p))}));function h(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,s=new Array(o);s[0]=d;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[c]="string"==typeof e?e:r,s[1]=i;for(var m=2;m{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>h,frontMatter:()=>i,metadata:()=>m,toc:()=>c});var a=n(7462),r=n(3366),o=(n(7294),n(3905)),s=["components"],i={},l=void 0,m={unversionedId:"Tutorials/FragmentIfcStreamer",id:"Tutorials/FragmentIfcStreamer",title:"FragmentIfcStreamer",description:"\ud83d\udcaa Let's go BIG",source:"@site/docs/Tutorials/FragmentIfcStreamer.mdx",sourceDirName:"Tutorials",slug:"/Tutorials/FragmentIfcStreamer",permalink:"/Tutorials/FragmentIfcStreamer",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"FragmentIfcLoader",permalink:"/Tutorials/FragmentIfcLoader"},next:{title:"FragmentManager",permalink:"/Tutorials/FragmentManager"}},p={},c=[{value:"\ud83d\udcaa Let's go BIG",id:"-lets-go-big",level:3},{value:"\ud83e\udde9 Converting the IFC model to tiles",id:"-converting-the-ifc-model-to-tiles",level:3},{value:"\ud83d\udccb Streaming the properties",id:"-streaming-the-properties",level:3},{value:"\ud83e\uddf1 Assembling the data",id:"-assembling-the-data",level:3},{value:"\ud83e\uddf1 Streaming the data",id:"-streaming-the-data",level:3}],u={toc:c},d="wrapper";function h(e){var t=e.components,n=(0,r.Z)(e,s);return(0,o.kt)(d,(0,a.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h3",{id:"-lets-go-big"},"\ud83d\udcaa Let's go BIG"),(0,o.kt)("hr",null),(0,o.kt)("p",null,"Do you need to open huge big IFC files fast, even on more modest devices?\nIf so, you are in luck! We can open virtually any model on any device in\nseconds thanks to BIM TILES!"),(0,o.kt)("admonition",{title:"BIM tiles?",type:"info"},(0,o.kt)("p",{parentName:"admonition"},"The idea behind BIM tiles is pretty simple! Instead of loading the whole BIM\nmodel at once, we just load the explicit geometries that are seen by the user.\nIt's way faster than opening the IFC directly, but for this you'll need\na backend (or to rely on the file system of the user if you are building a\ndesktop or mobile app).")),(0,o.kt)("p",null,"Let's see how to do this step by step!"),(0,o.kt)("h3",{id:"-converting-the-ifc-model-to-tiles"},"\ud83e\udde9 Converting the IFC model to tiles"),(0,o.kt)("hr",null),(0,o.kt)("p",null,"The first step is to transform the IFC model into BIM tiles. The reason why we\nhave to do this is pretty simple: geometry in IFC is implicit (e.g. a wall is\ndefined as an extrusion). This means that it needs to be computed and converted\nto explicit geometry (triangles) so that it can be displayed in 3D. Let's start\nconverting the IFC geometry:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'const streamer = new OBC.FragmentIfcStreamConverter(components);\nstreamer.settings.wasm = {\npath: "https://unpkg.com/web-ifc@0.0.51/",\nabsolute: true\n}\n')),(0,o.kt)("p",null,"The ",(0,o.kt)("inlineCode",{parentName:"p"},"FragmentIfcStreamConverter")," class takes IFC files and transform them into\ntiles. You can use events to get the data. The ",(0,o.kt)("inlineCode",{parentName:"p"},"onGeometryStreamed")," event will\ngive you the geometries bundled in a binary file, as well as an object with\ninformation about the geometries contained within this file."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},"streamer.onGeometryStreamed.add((geometry) => {\nconsole.log(geometry);\n});\n")),(0,o.kt)("p",null,"You can control the amount of geometries inside a file using the settings. The\nway the streaming works can't guarantee a precise number of geometries within a file,\nbut in most cases it will be quite close to the given number."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},"streamer.settings.minGeometrySize = 20;\n")),(0,o.kt)("p",null,"Similarly, you can get the assets data and control the number of assets per chunk like this:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},"streamer.onAssetStreamed.add((assets) => {\nconsole.log(assets);\n});\nstreamer.settings.minAssetsSize = 1000;\n")),(0,o.kt)("p",null,"Just like when using the normal ",(0,o.kt)("inlineCode",{parentName:"p"},"FragmentIfcLoader"),", when you stream an IFC file you are\ncreating a ",(0,o.kt)("inlineCode",{parentName:"p"},"FragmentsGroup"),". Using this event, you can get it:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},"streamer.onIfcLoaded.add(async (groupBuffer) => {\nconsole.log(groupBuffer);\n})\n")),(0,o.kt)("p",null,"Finally, you can use this to get notified as the streaming process progresses:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},"streamer.onProgress.add((progress) => {\nconsole.log(progress);\n})\n")),(0,o.kt)("p",null,"With everything in place, it's time to stream the IFC file and get all the tiles!"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'const fetchedIfc = await fetch("../../../resources/small.ifc");\nconst ifcBuffer = await fetchedIfc.arrayBuffer();\nstreamer.streamFromBuffer(new Uint8Array(ifcBuffer));\n')),(0,o.kt)("h3",{id:"-streaming-the-properties"},"\ud83d\udccb Streaming the properties"),(0,o.kt)("hr",null),(0,o.kt)("p",null,"You can also stream the properties of an IFC file. Why? Because some files can have\nmillions of properties, and trying to save them naively in a normal DB is not very\nscalable/affordable. Using this system, you'll be able to store and retrieve the\ndata of models of any size without big cloud costs. We can do this conversion\nusing the ",(0,o.kt)("inlineCode",{parentName:"p"},"FragmentPropsStreamConverter"),":"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'const propsStreamer = new OBC.FragmentPropsStreamConverter(components);\npropsStreamer.settings.wasm = {\npath: "https://unpkg.com/web-ifc@0.0.51/",\nabsolute: true\n}\n')),(0,o.kt)("p",null,"Similarly to geometries, here you will also get data and progress notification\nusing events. In addition to properties, you will get ",(0,o.kt)("inlineCode",{parentName:"p"},"indices"),", which is an\nindexation data of the properties to be able to use them effectively when\nstreamed."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},"propsStreamer.onPropertiesStreamed.add(async (props) => {\nconsole.log(props);\n})\npropsStreamer.onProgress.add(async (progress) => {\nconsole.log(progress);\n})\npropsStreamer.onIndicesStreamed.add(async (props) => {\nconsole.log(props);\n})\n")),(0,o.kt)("p",null,"Just call the ",(0,o.kt)("inlineCode",{parentName:"p"},"streamFromBuffer")," method and you are ready to go!"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},"propsStreamer.streamFromBuffer(new Uint8Array(ifcBuffer));\n")),(0,o.kt)("h3",{id:"-assembling-the-data"},"\ud83e\uddf1 Assembling the data"),(0,o.kt)("hr",null),(0,o.kt)("p",null,"Now you are ready to start streaming your data. The first step is to create 2 JSON\nfiles so that the library can access your backend: one for the geometries and other for\nthe properties. You have examples of both JSONs ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/main/resources/small.ifc-processed.json"},"here"),"\nand ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/main/resources/small.ifc-processed-properties.json"},"here"),".\nThe JSON file for the geometries should look like this, and you should\nbe able to create them with the data given in the previous steps. The ",(0,o.kt)("inlineCode",{parentName:"p"},"globalDataIDFile"),"\nis expected to have a name that ends with ",(0,o.kt)("inlineCode",{parentName:"p"},"-global"),"."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},'interface StreamedGeometries {\nassets: {\nid: number;\ngeometries: {\ncolor: number[];\ngeometryID: number;\ntransformation: number[];\n}[];\n}[];\ngeometries: {\n[id: number]: {\nboundingBox: {[id: number]: number};\nhasHoles: boolean;\ngeometryFile: "url-to-geometry-file-in-your-backend";\n};\n};\nglobalDataFileId: "url-to-fragments-group-file-in-your-backend";\n}\n')),(0,o.kt)("p",null,"The JSON for geometries should look like this. The values in ",(0,o.kt)("inlineCode",{parentName:"p"},"types")," and in ",(0,o.kt)("inlineCode",{parentName:"p"},"ids"),"\nare the suffix of the name of the properties file in your backend. In other words,\nthe library expects that if your globalDataFile is called ",(0,o.kt)("inlineCode",{parentName:"p"},"small.ifc-global"),", the\nproperties files will be called ",(0,o.kt)("inlineCode",{parentName:"p"},"small.ifc-properties-1"),", ",(0,o.kt)("inlineCode",{parentName:"p"},"small.ifc-properties-2"),",\netc. In other words: ",(0,o.kt)("inlineCode",{parentName:"p"},"types: {1837: [1, 2], ...}, ids: {8: 1, ...}")," means that\nall the items of type ",(0,o.kt)("inlineCode",{parentName:"p"},"1837")," are in the files ",(0,o.kt)("inlineCode",{parentName:"p"},"small.ifc-properties-1")," and\n",(0,o.kt)("inlineCode",{parentName:"p"},"small.ifc-properties-2"),", and that the properties of the item with id 8 is in the\nfile ",(0,o.kt)("inlineCode",{parentName:"p"},"small.ifc-properties-1"),"."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},'interface StreamedProperties {\ntypes: {\n[typeID: number]: number[]\n};\nids: {\n[id: number]: {\nboundingBox: {[id: number]: number};\nhasHoles: boolean;\ngeometryFile: "url-to-geometry-file-in-your-backend";\n};\n};\nindexesFile: "url-to-indexes-file-in-your-backend";\n}\n')),(0,o.kt)("p",null,"Once you get both files, you are ready to start streaming!"),(0,o.kt)("h3",{id:"-streaming-the-data"},"\ud83e\uddf1 Streaming the data"),(0,o.kt)("hr",null),(0,o.kt)("p",null,"Now, streaming the data is quite easy once you have the JSON files.\nYou can just instantiate the loader, give it the base URL to your\nbackend and just load the models like this:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'let loader = new OBC.FragmentStreamLoader(components);\nloader.url = "http://YOUR_BACKEND_URL";\nlet fragments = new OBC.FragmentManager(components);\nasync function loadModel(geometryURL, propertiesURL) {\nconst rawGeometryData = await fetch(geometryURL);\nconst geometryData = await rawGeometryData.json();\nlet propertiesData;\nif (propertiesURL) {\nconst rawPropertiesData = await fetch(propertiesURL);\npropertiesData = await rawPropertiesData.json();\n}\nawait loader.load(geometryData, true, propertiesData);\n}\nawait loadModel(\n"../../../resources/small.ifc-processed.json",\n"../../../resources/small.ifc-processed-properties.json"\n);\n')),(0,o.kt)("p",null,"Now, streaming works by updating the scene depending on the user's perspective\nand getting the necessary geometries from the backend. A simple way to achieve\nthis is by updating the scene each time the user stops the camera:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'components.camera.controls.addEventListener("controlend", () => {\nloader.culler.needsUpdate = true;\n});\n')),(0,o.kt)("p",null,"As you can imagine, downloading the geometries from the server each time can\ntake time, especially for heavier geometries. This is why the stream loader\nautomatically caches the files locally to get them much faster. This means that\nthe loading experience the first time might be a bit slower, but then later\nit will be much better. You can control this using the ",(0,o.kt)("inlineCode",{parentName:"p"},"useCache")," property\nand clear the cache using the ",(0,o.kt)("inlineCode",{parentName:"p"},"clearCache()")," method:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},"loader.useCache = true;\nawait loader.clearCache();\n")),(0,o.kt)("p",null,"You can also customize the loader through the ",(0,o.kt)("inlineCode",{parentName:"p"},"culler")," property:"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"Threshold determines how bit an object must be in the screen to stream it."),(0,o.kt)("li",{parentName:"ul"},"maxHiddenTime determines how long an object must be lost to remove it from the scene."),(0,o.kt)("li",{parentName:"ul"},"maxLostTime determines how long an object must be lost to remove it from memory.")),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},"loader.culler.threshold = 20;\nloader.culler.maxHiddenTime = 1000;\nloader.culler.maxLostTime = 40000;\n")),(0,o.kt)("p",null,"This is it! Now you should be able to stream your own IFC models and open them anywhere,\nno matter how big they are! \ud83d\udcaa We will keep improving and making this API more powerful\nto handle any model on any device smoothly."))}h.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4961],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>h});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=a.createContext({}),m=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},p=function(e){var t=m(e.components);return a.createElement(l.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,l=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),c=m(n),d=r,h=c["".concat(l,".").concat(d)]||c[d]||u[d]||o;return n?a.createElement(h,s(s({ref:t},p),{},{components:n})):a.createElement(h,s({ref:t},p))}));function h(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,s=new Array(o);s[0]=d;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[c]="string"==typeof e?e:r,s[1]=i;for(var m=2;m{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>h,frontMatter:()=>i,metadata:()=>m,toc:()=>c});var a=n(7462),r=n(3366),o=(n(7294),n(3905)),s=["components"],i={},l=void 0,m={unversionedId:"Tutorials/FragmentIfcStreamer",id:"Tutorials/FragmentIfcStreamer",title:"FragmentIfcStreamer",description:"\ud83d\udcaa Let's go BIG",source:"@site/docs/Tutorials/FragmentIfcStreamer.mdx",sourceDirName:"Tutorials",slug:"/Tutorials/FragmentIfcStreamer",permalink:"/Tutorials/FragmentIfcStreamer",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"FragmentIfcLoader",permalink:"/Tutorials/FragmentIfcLoader"},next:{title:"FragmentManager",permalink:"/Tutorials/FragmentManager"}},p={},c=[{value:"\ud83d\udcaa Let's go BIG",id:"-lets-go-big",level:3},{value:"\ud83e\udde9 Converting the IFC model to tiles",id:"-converting-the-ifc-model-to-tiles",level:3},{value:"\ud83d\udccb Streaming the properties",id:"-streaming-the-properties",level:3},{value:"\ud83e\uddf1 Assembling the data",id:"-assembling-the-data",level:3},{value:"\ud83e\uddf1 Streaming the data",id:"-streaming-the-data",level:3}],u={toc:c},d="wrapper";function h(e){var t=e.components,n=(0,r.Z)(e,s);return(0,o.kt)(d,(0,a.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h3",{id:"-lets-go-big"},"\ud83d\udcaa Let's go BIG"),(0,o.kt)("hr",null),(0,o.kt)("p",null,"Do you need to open huge big IFC files fast, even on more modest devices?\nIf so, you are in luck! We can open virtually any model on any device in\nseconds thanks to BIM TILES!"),(0,o.kt)("admonition",{title:"BIM tiles?",type:"info"},(0,o.kt)("p",{parentName:"admonition"},"The idea behind BIM tiles is pretty simple! Instead of loading the whole BIM\nmodel at once, we just load the explicit geometries that are seen by the user.\nIt's way faster than opening the IFC directly, but for this you'll need\na backend (or to rely on the file system of the user if you are building a\ndesktop or mobile app).")),(0,o.kt)("p",null,"Let's see how to do this step by step!"),(0,o.kt)("h3",{id:"-converting-the-ifc-model-to-tiles"},"\ud83e\udde9 Converting the IFC model to tiles"),(0,o.kt)("hr",null),(0,o.kt)("p",null,"The first step is to transform the IFC model into BIM tiles. The reason why we\nhave to do this is pretty simple: geometry in IFC is implicit (e.g. a wall is\ndefined as an extrusion). This means that it needs to be computed and converted\nto explicit geometry (triangles) so that it can be displayed in 3D. Let's start\nconverting the IFC geometry:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'const streamer = new OBC.FragmentIfcStreamConverter(components);\nstreamer.settings.wasm = {\npath: "https://unpkg.com/web-ifc@0.0.53/",\nabsolute: true\n}\n')),(0,o.kt)("p",null,"The ",(0,o.kt)("inlineCode",{parentName:"p"},"FragmentIfcStreamConverter")," class takes IFC files and transform them into\ntiles. You can use events to get the data. The ",(0,o.kt)("inlineCode",{parentName:"p"},"onGeometryStreamed")," event will\ngive you the geometries bundled in a binary file, as well as an object with\ninformation about the geometries contained within this file."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},"streamer.onGeometryStreamed.add((geometry) => {\nconsole.log(geometry);\n});\n")),(0,o.kt)("p",null,"You can control the amount of geometries inside a file using the settings. The\nway the streaming works can't guarantee a precise number of geometries within a file,\nbut in most cases it will be quite close to the given number."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},"streamer.settings.minGeometrySize = 20;\n")),(0,o.kt)("p",null,"Similarly, you can get the assets data and control the number of assets per chunk like this:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},"streamer.onAssetStreamed.add((assets) => {\nconsole.log(assets);\n});\nstreamer.settings.minAssetsSize = 1000;\n")),(0,o.kt)("p",null,"Just like when using the normal ",(0,o.kt)("inlineCode",{parentName:"p"},"FragmentIfcLoader"),", when you stream an IFC file you are\ncreating a ",(0,o.kt)("inlineCode",{parentName:"p"},"FragmentsGroup"),". Using this event, you can get it:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},"streamer.onIfcLoaded.add(async (groupBuffer) => {\nconsole.log(groupBuffer);\n})\n")),(0,o.kt)("p",null,"Finally, you can use this to get notified as the streaming process progresses:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},"streamer.onProgress.add((progress) => {\nconsole.log(progress);\n})\n")),(0,o.kt)("p",null,"With everything in place, it's time to stream the IFC file and get all the tiles!"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'const fetchedIfc = await fetch("../../../resources/small.ifc");\nconst ifcBuffer = await fetchedIfc.arrayBuffer();\nstreamer.streamFromBuffer(new Uint8Array(ifcBuffer));\n')),(0,o.kt)("h3",{id:"-streaming-the-properties"},"\ud83d\udccb Streaming the properties"),(0,o.kt)("hr",null),(0,o.kt)("p",null,"You can also stream the properties of an IFC file. Why? Because some files can have\nmillions of properties, and trying to save them naively in a normal DB is not very\nscalable/affordable. Using this system, you'll be able to store and retrieve the\ndata of models of any size without big cloud costs. We can do this conversion\nusing the ",(0,o.kt)("inlineCode",{parentName:"p"},"FragmentPropsStreamConverter"),":"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'const propsStreamer = new OBC.FragmentPropsStreamConverter(components);\npropsStreamer.settings.wasm = {\npath: "https://unpkg.com/web-ifc@0.0.53/",\nabsolute: true\n}\n')),(0,o.kt)("p",null,"Similarly to geometries, here you will also get data and progress notification\nusing events. In addition to properties, you will get ",(0,o.kt)("inlineCode",{parentName:"p"},"indices"),", which is an\nindexation data of the properties to be able to use them effectively when\nstreamed."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},"propsStreamer.onPropertiesStreamed.add(async (props) => {\nconsole.log(props);\n})\npropsStreamer.onProgress.add(async (progress) => {\nconsole.log(progress);\n})\npropsStreamer.onIndicesStreamed.add(async (props) => {\nconsole.log(props);\n})\n")),(0,o.kt)("p",null,"Just call the ",(0,o.kt)("inlineCode",{parentName:"p"},"streamFromBuffer")," method and you are ready to go!"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},"propsStreamer.streamFromBuffer(new Uint8Array(ifcBuffer));\n")),(0,o.kt)("h3",{id:"-assembling-the-data"},"\ud83e\uddf1 Assembling the data"),(0,o.kt)("hr",null),(0,o.kt)("p",null,"Now you are ready to start streaming your data. The first step is to create 2 JSON\nfiles so that the library can access your backend: one for the geometries and other for\nthe properties. You have examples of both JSONs ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/main/resources/small.ifc-processed.json"},"here"),"\nand ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/main/resources/small.ifc-processed-properties.json"},"here"),".\nThe JSON file for the geometries should look like this, and you should\nbe able to create them with the data given in the previous steps. The ",(0,o.kt)("inlineCode",{parentName:"p"},"globalDataIDFile"),"\nis expected to have a name that ends with ",(0,o.kt)("inlineCode",{parentName:"p"},"-global"),"."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},'interface StreamedGeometries {\nassets: {\nid: number;\ngeometries: {\ncolor: number[];\ngeometryID: number;\ntransformation: number[];\n}[];\n}[];\ngeometries: {\n[id: number]: {\nboundingBox: {[id: number]: number};\nhasHoles: boolean;\ngeometryFile: "url-to-geometry-file-in-your-backend";\n};\n};\nglobalDataFileId: "url-to-fragments-group-file-in-your-backend";\n}\n')),(0,o.kt)("p",null,"The JSON for geometries should look like this. The values in ",(0,o.kt)("inlineCode",{parentName:"p"},"types")," and in ",(0,o.kt)("inlineCode",{parentName:"p"},"ids"),"\nare the suffix of the name of the properties file in your backend. In other words,\nthe library expects that if your globalDataFile is called ",(0,o.kt)("inlineCode",{parentName:"p"},"small.ifc-global"),", the\nproperties files will be called ",(0,o.kt)("inlineCode",{parentName:"p"},"small.ifc-properties-1"),", ",(0,o.kt)("inlineCode",{parentName:"p"},"small.ifc-properties-2"),",\netc. In other words: ",(0,o.kt)("inlineCode",{parentName:"p"},"types: {1837: [1, 2], ...}, ids: {8: 1, ...}")," means that\nall the items of type ",(0,o.kt)("inlineCode",{parentName:"p"},"1837")," are in the files ",(0,o.kt)("inlineCode",{parentName:"p"},"small.ifc-properties-1")," and\n",(0,o.kt)("inlineCode",{parentName:"p"},"small.ifc-properties-2"),", and that the properties of the item with id 8 is in the\nfile ",(0,o.kt)("inlineCode",{parentName:"p"},"small.ifc-properties-1"),"."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},'interface StreamedProperties {\ntypes: {\n[typeID: number]: number[]\n};\nids: {\n[id: number]: {\nboundingBox: {[id: number]: number};\nhasHoles: boolean;\ngeometryFile: "url-to-geometry-file-in-your-backend";\n};\n};\nindexesFile: "url-to-indexes-file-in-your-backend";\n}\n')),(0,o.kt)("p",null,"Once you get both files, you are ready to start streaming!"),(0,o.kt)("h3",{id:"-streaming-the-data"},"\ud83e\uddf1 Streaming the data"),(0,o.kt)("hr",null),(0,o.kt)("p",null,"Now, streaming the data is quite easy once you have the JSON files.\nYou can just instantiate the loader, give it the base URL to your\nbackend and just load the models like this:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'let loader = new OBC.FragmentStreamLoader(components);\nloader.url = "http://YOUR_BACKEND_URL";\nlet fragments = components.tools.get(OBC.FragmentManager);\nasync function loadModel(geometryURL, propertiesURL) {\nconst rawGeometryData = await fetch(geometryURL);\nconst geometryData = await rawGeometryData.json();\nlet propertiesData;\nif (propertiesURL) {\nconst rawPropertiesData = await fetch(propertiesURL);\npropertiesData = await rawPropertiesData.json();\n}\nawait loader.load(geometryData, true, propertiesData);\n}\nawait loadModel(\n"../../../resources/small.ifc-processed.json",\n"../../../resources/small.ifc-processed-properties.json"\n);\n')),(0,o.kt)("p",null,"Now, streaming works by updating the scene depending on the user's perspective\nand getting the necessary geometries from the backend. A simple way to achieve\nthis is by updating the scene each time the user stops the camera:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'components.camera.controls.addEventListener("controlend", () => {\nloader.culler.needsUpdate = true;\n});\n')),(0,o.kt)("p",null,"As you can imagine, downloading the geometries from the server each time can\ntake time, especially for heavier geometries. This is why the stream loader\nautomatically caches the files locally to get them much faster. This means that\nthe loading experience the first time might be a bit slower, but then later\nit will be much better. You can control this using the ",(0,o.kt)("inlineCode",{parentName:"p"},"useCache")," property\nand clear the cache using the ",(0,o.kt)("inlineCode",{parentName:"p"},"clearCache()")," method:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},"loader.useCache = true;\nawait loader.clearCache();\n")),(0,o.kt)("p",null,"You can also customize the loader through the ",(0,o.kt)("inlineCode",{parentName:"p"},"culler")," property:"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"Threshold determines how bit an object must be in the screen to stream it."),(0,o.kt)("li",{parentName:"ul"},"maxHiddenTime determines how long an object must be lost to remove it from the scene."),(0,o.kt)("li",{parentName:"ul"},"maxLostTime determines how long an object must be lost to remove it from memory.")),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},"loader.culler.threshold = 20;\nloader.culler.maxHiddenTime = 1000;\nloader.culler.maxLostTime = 40000;\n")),(0,o.kt)("p",null,"This is it! Now you should be able to stream your own IFC models and open them anywhere,\nno matter how big they are! \ud83d\udcaa We will keep improving and making this API more powerful\nto handle any model on any device smoothly."),(0,o.kt)("iframe",{src:"https://thatopen.github.io/engine_components/src/fragments/FragmentIfcStreamer/index.html"}))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/d785d616.54e0c7bb.js b/build/assets/js/d785d616.54e0c7bb.js deleted file mode 100644 index c87b1523..00000000 --- a/build/assets/js/d785d616.54e0c7bb.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9211],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>g});var r=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},m=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},c="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,s=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),c=p(n),f=i,g=c["".concat(s,".").concat(f)]||c[f]||d[f]||a;return n?r.createElement(g,o(o({ref:t},m),{},{components:n})):r.createElement(g,o({ref:t},m))}));function g(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,o=new Array(a);o[0]=f;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[c]="string"==typeof e?e:i,o[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>s,default:()=>g,frontMatter:()=>l,metadata:()=>p,toc:()=>c});var r=n(7462),i=n(3366),a=(n(7294),n(3905)),o=["components"],l={id:"openbim_components.IfcStreamingSettings",title:"Class: IfcStreamingSettings",sidebar_label:"IfcStreamingSettings",custom_edit_url:null},s=void 0,p={unversionedId:"api/classes/openbim_components.IfcStreamingSettings",id:"api/classes/openbim_components.IfcStreamingSettings",title:"Class: IfcStreamingSettings",description:"openbim-components.IfcStreamingSettings",source:"@site/docs/api/classes/openbim_components.IfcStreamingSettings.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.IfcStreamingSettings",permalink:"/api/classes/openbim_components.IfcStreamingSettings",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.IfcStreamingSettings",title:"Class: IfcStreamingSettings",sidebar_label:"IfcStreamingSettings",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"IfcJsonExporter",permalink:"/api/classes/openbim_components.IfcJsonExporter"},next:{title:"LengthMeasurement",permalink:"/api/classes/openbim_components.LengthMeasurement"}},m={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"coordinate",id:"coordinate",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"excludedCategories",id:"excludedcategories",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"includeProperties",id:"includeproperties",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"optionalCategories",id:"optionalcategories",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"saveLocations",id:"savelocations",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"wasm",id:"wasm",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"webIfc",id:"webifc",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:c},f="wrapper";function g(e){var t=e.components,n=(0,i.Z)(e,o);return(0,a.kt)(f,(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".IfcStreamingSettings"),(0,a.kt)("p",null,"Configuration of the IFC-fragment streaming."),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"IfcFragmentSettings")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"IfcStreamingSettings"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"coordinate"},"coordinate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"coordinate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"true")),(0,a.kt)("p",null,"Whether to use the coordination data coming from the IFC files."),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.coordinate"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L15"},"temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:15")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"excludedcategories"},"excludedCategories"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"excludedCategories"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Set"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,a.kt)("p",null,"List of categories that won't be converted to fragments."),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.excludedCategories"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L25"},"temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:25")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"includeproperties"},"includeProperties"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"includeProperties"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"true")),(0,a.kt)("p",null,"Whether to extract the IFC properties into a JSON."),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.includeProperties"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L6"},"temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:6")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"optionalcategories"},"optionalCategories"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"optionalCategories"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,a.kt)("p",null,"Generate the geometry for categories that are not included by default,\nlike IFCSPACE."),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.optionalCategories"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L12"},"temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:12")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"savelocations"},"saveLocations"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"saveLocations"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"false")),(0,a.kt)("p",null,"Whether to save the absolute location of all IFC items."),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.saveLocations"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L28"},"temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:28")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"wasm"},"wasm"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"wasm"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Object")),(0,a.kt)("p",null,"Path of the WASM for ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_web-ifc"},"web-ifc"),"."),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"absolute")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"logLevel")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"LogLevel"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"path")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.wasm"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L18"},"temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:18")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"webifc"},"webIfc"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"webIfc"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"LoaderSettings")),(0,a.kt)("p",null,"Loader settings for ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_web-ifc"},"web-ifc"),"."),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.webIfc"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L31"},"temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:31")))}g.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/d785d616.95106690.js b/build/assets/js/d785d616.95106690.js new file mode 100644 index 00000000..89f83610 --- /dev/null +++ b/build/assets/js/d785d616.95106690.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9211],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>g});var r=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},c=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},d="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),d=p(n),f=i,g=d["".concat(s,".").concat(f)]||d[f]||m[f]||a;return n?r.createElement(g,o(o({ref:t},c),{},{components:n})):r.createElement(g,o({ref:t},c))}));function g(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,o=new Array(a);o[0]=f;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[d]="string"==typeof e?e:i,o[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>g,frontMatter:()=>l,metadata:()=>p,toc:()=>d});var r=n(7462),i=n(3366),a=(n(7294),n(3905)),o=["components"],l={id:"openbim_components.IfcStreamingSettings",title:"Class: IfcStreamingSettings",sidebar_label:"IfcStreamingSettings",custom_edit_url:null},s=void 0,p={unversionedId:"api/classes/openbim_components.IfcStreamingSettings",id:"api/classes/openbim_components.IfcStreamingSettings",title:"Class: IfcStreamingSettings",description:"openbim-components.IfcStreamingSettings",source:"@site/docs/api/classes/openbim_components.IfcStreamingSettings.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.IfcStreamingSettings",permalink:"/api/classes/openbim_components.IfcStreamingSettings",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.IfcStreamingSettings",title:"Class: IfcStreamingSettings",sidebar_label:"IfcStreamingSettings",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"IfcJsonExporter",permalink:"/api/classes/openbim_components.IfcJsonExporter"},next:{title:"LengthMeasurement",permalink:"/api/classes/openbim_components.LengthMeasurement"}},c={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"coordinate",id:"coordinate",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"excludedCategories",id:"excludedcategories",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"includeProperties",id:"includeproperties",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"optionalCategories",id:"optionalcategories",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"saveLocations",id:"savelocations",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"wasm",id:"wasm",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"webIfc",id:"webifc",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],m={toc:d},f="wrapper";function g(e){var t=e.components,n=(0,i.Z)(e,o);return(0,a.kt)(f,(0,r.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".IfcStreamingSettings"),(0,a.kt)("p",null,"Configuration of the IFC-fragment streaming."),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"IfcFragmentSettings")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"IfcStreamingSettings"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"coordinate"},"coordinate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"coordinate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"true")),(0,a.kt)("p",null,"Whether to use the coordination data coming from the IFC files."),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.coordinate"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L15"},"src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:15")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"excludedcategories"},"excludedCategories"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"excludedCategories"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Set"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,a.kt)("p",null,"List of categories that won't be converted to fragments."),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.excludedCategories"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L29"},"src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:29")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"includeproperties"},"includeProperties"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"includeProperties"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"true")),(0,a.kt)("p",null,"Whether to extract the IFC properties into a JSON."),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.includeProperties"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L6"},"src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:6")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"optionalcategories"},"optionalCategories"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"optionalCategories"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,a.kt)("p",null,"Generate the geometry for categories that are not included by default,\nlike IFCSPACE."),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.optionalCategories"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L12"},"src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:12")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"savelocations"},"saveLocations"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"saveLocations"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"false")),(0,a.kt)("p",null,"Whether to save the absolute location of all IFC items."),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.saveLocations"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L32"},"src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:32")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"wasm"},"wasm"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"wasm"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Object")),(0,a.kt)("p",null,"Path of the WASM for ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_web-ifc"},"web-ifc"),"."),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"absolute")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"logLevel?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"LogLevel"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"path")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.wasm"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L18"},"src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:18")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"webifc"},"webIfc"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"webIfc"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"LoaderSettings")),(0,a.kt)("p",null,"Loader settings for ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_web-ifc"},"web-ifc"),"."),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.webIfc"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L35"},"src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:35")))}g.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/da20bba5.2986f741.js b/build/assets/js/da20bba5.2986f741.js deleted file mode 100644 index 1995c0d8..00000000 --- a/build/assets/js/da20bba5.2986f741.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3118],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>g});var r=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},m=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,s=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),d=p(n),f=i,g=d["".concat(s,".").concat(f)]||d[f]||c[f]||a;return n?r.createElement(g,o(o({ref:t},m),{},{components:n})):r.createElement(g,o({ref:t},m))}));function g(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,o=new Array(a);o[0]=f;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[d]="string"==typeof e?e:i,o[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>s,default:()=>g,frontMatter:()=>l,metadata:()=>p,toc:()=>d});var r=n(7462),i=n(3366),a=(n(7294),n(3905)),o=["components"],l={id:"openbim_components.PropertiesStreamingSettings",title:"Class: PropertiesStreamingSettings",sidebar_label:"PropertiesStreamingSettings",custom_edit_url:null},s=void 0,p={unversionedId:"api/classes/openbim_components.PropertiesStreamingSettings",id:"api/classes/openbim_components.PropertiesStreamingSettings",title:"Class: PropertiesStreamingSettings",description:"openbim-components.PropertiesStreamingSettings",source:"@site/docs/api/classes/openbim_components.PropertiesStreamingSettings.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.PropertiesStreamingSettings",permalink:"/api/classes/openbim_components.PropertiesStreamingSettings",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.PropertiesStreamingSettings",title:"Class: PropertiesStreamingSettings",sidebar_label:"PropertiesStreamingSettings",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"PostproductionRenderer",permalink:"/api/classes/openbim_components.PostproductionRenderer"},next:{title:"ScreenCuller",permalink:"/api/classes/openbim_components.ScreenCuller"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"coordinate",id:"coordinate",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"excludedCategories",id:"excludedcategories",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"includeProperties",id:"includeproperties",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"optionalCategories",id:"optionalcategories",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"saveLocations",id:"savelocations",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"wasm",id:"wasm",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"webIfc",id:"webifc",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],c={toc:d},f="wrapper";function g(e){var t=e.components,n=(0,i.Z)(e,o);return(0,a.kt)(f,(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".PropertiesStreamingSettings"),(0,a.kt)("p",null,"Configuration of the IFC-fragment streaming."),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"IfcFragmentSettings")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"PropertiesStreamingSettings"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"coordinate"},"coordinate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"coordinate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"true")),(0,a.kt)("p",null,"Whether to use the coordination data coming from the IFC files."),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.coordinate"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L15"},"temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:15")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"excludedcategories"},"excludedCategories"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"excludedCategories"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Set"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,a.kt)("p",null,"List of categories that won't be converted to fragments."),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.excludedCategories"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L25"},"temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:25")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"includeproperties"},"includeProperties"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"includeProperties"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"true")),(0,a.kt)("p",null,"Whether to extract the IFC properties into a JSON."),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.includeProperties"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L6"},"temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:6")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"optionalcategories"},"optionalCategories"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"optionalCategories"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,a.kt)("p",null,"Generate the geometry for categories that are not included by default,\nlike IFCSPACE."),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.optionalCategories"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L12"},"temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:12")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"savelocations"},"saveLocations"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"saveLocations"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"false")),(0,a.kt)("p",null,"Whether to save the absolute location of all IFC items."),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.saveLocations"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L28"},"temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:28")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"wasm"},"wasm"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"wasm"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Object")),(0,a.kt)("p",null,"Path of the WASM for ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_web-ifc"},"web-ifc"),"."),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"absolute")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"logLevel")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"LogLevel"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"path")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.wasm"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L18"},"temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:18")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"webifc"},"webIfc"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"webIfc"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"LoaderSettings")),(0,a.kt)("p",null,"Loader settings for ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_web-ifc"},"web-ifc"),"."),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.webIfc"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L31"},"temp/engine_components/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:31")))}g.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/da20bba5.3920b11a.js b/build/assets/js/da20bba5.3920b11a.js new file mode 100644 index 00000000..c7a39900 --- /dev/null +++ b/build/assets/js/da20bba5.3920b11a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3118],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>g});var r=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},m="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),m=p(n),f=i,g=m["".concat(s,".").concat(f)]||m[f]||c[f]||a;return n?r.createElement(g,o(o({ref:t},d),{},{components:n})):r.createElement(g,o({ref:t},d))}));function g(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,o=new Array(a);o[0]=f;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[m]="string"==typeof e?e:i,o[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>s,default:()=>g,frontMatter:()=>l,metadata:()=>p,toc:()=>m});var r=n(7462),i=n(3366),a=(n(7294),n(3905)),o=["components"],l={id:"openbim_components.PropertiesStreamingSettings",title:"Class: PropertiesStreamingSettings",sidebar_label:"PropertiesStreamingSettings",custom_edit_url:null},s=void 0,p={unversionedId:"api/classes/openbim_components.PropertiesStreamingSettings",id:"api/classes/openbim_components.PropertiesStreamingSettings",title:"Class: PropertiesStreamingSettings",description:"openbim-components.PropertiesStreamingSettings",source:"@site/docs/api/classes/openbim_components.PropertiesStreamingSettings.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.PropertiesStreamingSettings",permalink:"/api/classes/openbim_components.PropertiesStreamingSettings",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.PropertiesStreamingSettings",title:"Class: PropertiesStreamingSettings",sidebar_label:"PropertiesStreamingSettings",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"PostproductionRenderer",permalink:"/api/classes/openbim_components.PostproductionRenderer"},next:{title:"ScreenCuller",permalink:"/api/classes/openbim_components.ScreenCuller"}},d={},m=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"coordinate",id:"coordinate",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"excludedCategories",id:"excludedcategories",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"includeProperties",id:"includeproperties",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"optionalCategories",id:"optionalcategories",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"saveLocations",id:"savelocations",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"wasm",id:"wasm",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"webIfc",id:"webifc",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],c={toc:m},f="wrapper";function g(e){var t=e.components,n=(0,i.Z)(e,o);return(0,a.kt)(f,(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".PropertiesStreamingSettings"),(0,a.kt)("p",null,"Configuration of the IFC-fragment streaming."),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"IfcFragmentSettings")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"PropertiesStreamingSettings"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"coordinate"},"coordinate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"coordinate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"true")),(0,a.kt)("p",null,"Whether to use the coordination data coming from the IFC files."),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.coordinate"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L15"},"src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:15")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"excludedcategories"},"excludedCategories"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"excludedCategories"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Set"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,a.kt)("p",null,"List of categories that won't be converted to fragments."),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.excludedCategories"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L29"},"src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:29")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"includeproperties"},"includeProperties"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"includeProperties"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"true")),(0,a.kt)("p",null,"Whether to extract the IFC properties into a JSON."),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.includeProperties"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L6"},"src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:6")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"optionalcategories"},"optionalCategories"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"optionalCategories"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,a.kt)("p",null,"Generate the geometry for categories that are not included by default,\nlike IFCSPACE."),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.optionalCategories"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L12"},"src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:12")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"savelocations"},"saveLocations"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"saveLocations"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"false")),(0,a.kt)("p",null,"Whether to save the absolute location of all IFC items."),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.saveLocations"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L32"},"src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:32")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"wasm"},"wasm"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"wasm"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Object")),(0,a.kt)("p",null,"Path of the WASM for ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_web-ifc"},"web-ifc"),"."),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"absolute")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"logLevel?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"LogLevel"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"path")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.wasm"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L18"},"src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:18")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"webifc"},"webIfc"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"webIfc"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"LoaderSettings")),(0,a.kt)("p",null,"Loader settings for ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_web-ifc"},"web-ifc"),"."),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,"IfcFragmentSettings.webIfc"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts#L35"},"src/fragments/FragmentIfcLoader/src/ifc-fragment-settings.ts:35")))}g.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/e0514c78.17788887.js b/build/assets/js/e0514c78.17788887.js deleted file mode 100644 index c7f4ec51..00000000 --- a/build/assets/js/e0514c78.17788887.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2388],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>b});var i=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function p(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function o(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var r=i.createContext({}),l=function(e){var n=i.useContext(r),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},m=function(e){var n=l(e.components);return i.createElement(r.Provider,{value:n},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},u=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,p=e.originalType,r=e.parentName,m=s(e,["components","mdxType","originalType","parentName"]),d=l(t),u=a,b=d["".concat(r,".").concat(u)]||d[u]||c[u]||p;return t?i.createElement(b,o(o({ref:n},m),{},{components:t})):i.createElement(b,o({ref:n},m))}));function b(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var p=t.length,o=new Array(p);o[0]=u;var s={};for(var r in n)hasOwnProperty.call(n,r)&&(s[r]=n[r]);s.originalType=e,s[d]="string"==typeof e?e:a,o[1]=s;for(var l=2;l{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>r,default:()=>b,frontMatter:()=>s,metadata:()=>l,toc:()=>d});var i=t(7462),a=t(3366),p=(t(7294),t(3905)),o=["components"],s={id:"openbim_components.UIManager",title:"Class: UIManager",sidebar_label:"UIManager",custom_edit_url:null},r=void 0,l={unversionedId:"api/classes/openbim_components.UIManager",id:"api/classes/openbim_components.UIManager",title:"Class: UIManager",description:"openbim-components.UIManager",source:"@site/docs/api/classes/openbim_components.UIManager.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.UIManager",permalink:"/api/classes/openbim_components.UIManager",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.UIManager",title:"Class: UIManager",sidebar_label:"UIManager",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"UIElement",permalink:"/api/classes/openbim_components.UIElement"},next:{title:"Configurable",permalink:"/api/interfaces/openbim_components.Configurable"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods",level:2},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4}],c={toc:d},u="wrapper";function b(e){var n=e.components,t=(0,a.Z)(e,o);return(0,p.kt)(u,(0,i.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".UIManager"),(0,p.kt)("p",null,"A component that handles all UI components."),(0,p.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("p",{parentName:"li"},(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,p.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"Toolbar"),"[]",">"),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"UIManager"))))),(0,p.kt)("h2",{id:"implements"},"Implements"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,p.kt)("inlineCode",{parentName:"a"},"Disposable")))),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"undefined"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,p.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/ui/UIManager/index.ts#L30"},"temp/engine_components/src/ui/UIManager/index.ts:30")),(0,p.kt)("h2",{id:"methods"},"Methods"),(0,p.kt)("h3",{id:"hasui"},"hasUI"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,p.kt)("p",null,"Whether is component implements any kind of ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,p.kt)("h4",{id:"returns"},"Returns"),(0,p.kt)("p",null,"this is UI"),(0,p.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,p.kt)("h4",{id:"returns-1"},"Returns"),(0,p.kt)("p",null,"this is Configurable"),(0,p.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,p.kt)("h4",{id:"returns-2"},"Returns"),(0,p.kt)("p",null,"this is Disposable"),(0,p.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ishideable"},"isHideable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,p.kt)("h4",{id:"returns-3"},"Returns"),(0,p.kt)("p",null,"this is Hideable"),(0,p.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,p.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,p.kt)("h4",{id:"returns-4"},"Returns"),(0,p.kt)("p",null,"this is Resizeable"),(0,p.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,p.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,p.kt)("h4",{id:"returns-5"},"Returns"),(0,p.kt)("p",null,"this is Updateable"),(0,p.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,p.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")))}b.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/e0514c78.99ea4d94.js b/build/assets/js/e0514c78.99ea4d94.js new file mode 100644 index 00000000..a76ed160 --- /dev/null +++ b/build/assets/js/e0514c78.99ea4d94.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2388],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>h});var i=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function s(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function p(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var r=i.createContext({}),l=function(e){var n=i.useContext(r),t=n;return e&&(t="function"==typeof e?e(n):p(p({},n),e)),t},m=function(e){var n=l(e.components);return i.createElement(r.Provider,{value:n},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},u=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,s=e.originalType,r=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),d=l(t),u=a,h=d["".concat(r,".").concat(u)]||d[u]||c[u]||s;return t?i.createElement(h,p(p({ref:n},m),{},{components:t})):i.createElement(h,p({ref:n},m))}));function h(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var s=t.length,p=new Array(s);p[0]=u;var o={};for(var r in n)hasOwnProperty.call(n,r)&&(o[r]=n[r]);o.originalType=e,o[d]="string"==typeof e?e:a,p[1]=o;for(var l=2;l{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>l,toc:()=>d});var i=t(7462),a=t(3366),s=(t(7294),t(3905)),p=["components"],o={id:"openbim_components.UIManager",title:"Class: UIManager",sidebar_label:"UIManager",custom_edit_url:null},r=void 0,l={unversionedId:"api/classes/openbim_components.UIManager",id:"api/classes/openbim_components.UIManager",title:"Class: UIManager",description:"openbim-components.UIManager",source:"@site/docs/api/classes/openbim_components.UIManager.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.UIManager",permalink:"/api/classes/openbim_components.UIManager",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.UIManager",title:"Class: UIManager",sidebar_label:"UIManager",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"UIElement",permalink:"/api/classes/openbim_components.UIElement"},next:{title:"Configurable",permalink:"/api/interfaces/openbim_components.Configurable"}},m={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods",level:2},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4}],c={toc:d},u="wrapper";function h(e){var n=e.components,t=(0,a.Z)(e,p);return(0,s.kt)(u,(0,i.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".UIManager"),(0,s.kt)("p",null,"A component that handles all UI components."),(0,s.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("p",{parentName:"li"},(0,s.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,s.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,s.kt)("inlineCode",{parentName:"p"},"Toolbar"),"[]",">"),(0,s.kt)("p",{parentName:"li"},"\u21b3 ",(0,s.kt)("strong",{parentName:"p"},(0,s.kt)("inlineCode",{parentName:"strong"},"UIManager"))))),(0,s.kt)("h2",{id:"implements"},"Implements"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,s.kt)("inlineCode",{parentName:"a"},"Disposable")))),(0,s.kt)("h2",{id:"properties"},"Properties"),(0,s.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,s.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,s.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,s.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,s.kt)("inlineCode",{parentName:"p"},"undefined"),">"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,s.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,s.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/ui/UIManager/index.ts#L30"},"src/ui/UIManager/index.ts:30")),(0,s.kt)("h2",{id:"methods"},"Methods"),(0,s.kt)("h3",{id:"hasui"},"hasUI"),(0,s.kt)("p",null,"\u25b8 ",(0,s.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,s.kt)("p",null,"Whether is component implements any kind of ",(0,s.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,s.kt)("h4",{id:"returns"},"Returns"),(0,s.kt)("p",null,"this is UI"),(0,s.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,s.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,s.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,s.kt)("p",null,"\u25b8 ",(0,s.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,s.kt)("p",null,"Whether is component is ",(0,s.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,s.kt)("h4",{id:"returns-1"},"Returns"),(0,s.kt)("p",null,"this is Configurable"),(0,s.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,s.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,s.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,s.kt)("p",null,"\u25b8 ",(0,s.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,s.kt)("p",null,"Whether is component is ",(0,s.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,s.kt)("h4",{id:"returns-2"},"Returns"),(0,s.kt)("p",null,"this is Disposable"),(0,s.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,s.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,s.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"ishideable"},"isHideable"),(0,s.kt)("p",null,"\u25b8 ",(0,s.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,s.kt)("p",null,"Whether is component is ",(0,s.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,s.kt)("h4",{id:"returns-3"},"Returns"),(0,s.kt)("p",null,"this is Hideable"),(0,s.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,s.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,s.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,s.kt)("p",null,"\u25b8 ",(0,s.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,s.kt)("p",null,"Whether is component is ",(0,s.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,s.kt)("h4",{id:"returns-4"},"Returns"),(0,s.kt)("p",null,"this is Resizeable"),(0,s.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,s.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,s.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,s.kt)("p",null,"\u25b8 ",(0,s.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,s.kt)("p",null,"Whether is component is ",(0,s.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,s.kt)("h4",{id:"returns-5"},"Returns"),(0,s.kt)("p",null,"this is Updateable"),(0,s.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,s.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,s.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/ece573d0.72adaa38.js b/build/assets/js/ece573d0.1a760438.js similarity index 61% rename from build/assets/js/ece573d0.72adaa38.js rename to build/assets/js/ece573d0.1a760438.js index 0af91b1c..7d6fef09 100644 --- a/build/assets/js/ece573d0.72adaa38.js +++ b/build/assets/js/ece573d0.1a760438.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9881],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>k});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var o=a.createContext({}),s=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},m=function(e){var t=s(e.components);return a.createElement(o.Provider,{value:t},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,l=e.originalType,o=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),d=s(n),u=r,k=d["".concat(o,".").concat(u)]||d[u]||c[u]||l;return n?a.createElement(k,i(i({ref:t},m),{},{components:n})):a.createElement(k,i({ref:t},m))}));function k(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=n.length,i=new Array(l);i[0]=u;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[d]="string"==typeof e?e:r,i[1]=p;for(var s=2;s{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>o,default:()=>k,frontMatter:()=>p,metadata:()=>s,toc:()=>d});var a=n(7462),r=n(3366),l=(n(7294),n(3905)),i=["components"],p={id:"openbim_components.UIElement",title:"Class: UIElement",sidebar_label:"UIElement",custom_edit_url:null},o=void 0,s={unversionedId:"api/classes/openbim_components.UIElement",id:"api/classes/openbim_components.UIElement",title:"Class: UIElement",description:"openbim-components.UIElement",source:"@site/docs/api/classes/openbim_components.UIElement.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.UIElement",permalink:"/api/classes/openbim_components.UIElement",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.UIElement",title:"Class: UIElement",sidebar_label:"UIElement",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ToolComponent",permalink:"/api/classes/openbim_components.ToolComponent"},next:{title:"UIManager",permalink:"/api/classes/openbim_components.UIManager"}},m={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"get",id:"get",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"set",id:"set",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4}],c={toc:d},u="wrapper";function k(e){var t=e.components,n=(0,r.Z)(e,i);return(0,l.kt)(u,(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".UIElement"),(0,l.kt)("p",null,"A simple object to handle UI components. You can use the generic constructor\nto specify the types of your UI components."),(0,l.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T")),(0,l.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,l.kt)("inlineCode",{parentName:"td"},"Object"))))),(0,l.kt)("h2",{id:"methods"},"Methods"),(0,l.kt)("h3",{id:"dispose"},"dispose"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("p",null,"Release all the memory used by this instance deleting all the UI components\ninside."),(0,l.kt)("h4",{id:"returns"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("h4",{id:"defined-in"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/ui-element.ts#L37"},"temp/engine_components/src/base-types/ui-element.ts:37")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"get"},"get"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"get"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"U"),">","(",(0,l.kt)("inlineCode",{parentName:"p"},"name"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"U")),(0,l.kt)("p",null,"Gets the UI Component with the given name. If it doesn't exist, it will\nthrow an error."),(0,l.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"U")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"SimpleUIComponent"),"<",(0,l.kt)("inlineCode",{parentName:"td"},"HTMLElement"),">")))),(0,l.kt)("h4",{id:"parameters"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"name")),(0,l.kt)("td",{parentName:"tr",align:"left"},"keyof ",(0,l.kt)("inlineCode",{parentName:"td"},"T")),(0,l.kt)("td",{parentName:"tr",align:"left"},"the identifier of the UI component.")))),(0,l.kt)("h4",{id:"returns-1"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"U")),(0,l.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/ui-element.ts#L17"},"temp/engine_components/src/base-types/ui-element.ts:17")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"set"},"set"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"set"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("p",null,"Sets all the UI components of this instance."),(0,l.kt)("h4",{id:"parameters-1"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"data")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T")),(0,l.kt)("td",{parentName:"tr",align:"left"},"all the UI components sorted by name in an object.")))),(0,l.kt)("h4",{id:"returns-2"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/ui-element.ts#L29"},"temp/engine_components/src/base-types/ui-element.ts:29")))}k.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9881],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>k});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var o=a.createContext({}),s=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},m=function(e){var t=s(e.components);return a.createElement(o.Provider,{value:t},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,l=e.originalType,o=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),d=s(n),u=r,k=d["".concat(o,".").concat(u)]||d[u]||c[u]||l;return n?a.createElement(k,i(i({ref:t},m),{},{components:n})):a.createElement(k,i({ref:t},m))}));function k(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=n.length,i=new Array(l);i[0]=u;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[d]="string"==typeof e?e:r,i[1]=p;for(var s=2;s{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>o,default:()=>k,frontMatter:()=>p,metadata:()=>s,toc:()=>d});var a=n(7462),r=n(3366),l=(n(7294),n(3905)),i=["components"],p={id:"openbim_components.UIElement",title:"Class: UIElement",sidebar_label:"UIElement",custom_edit_url:null},o=void 0,s={unversionedId:"api/classes/openbim_components.UIElement",id:"api/classes/openbim_components.UIElement",title:"Class: UIElement",description:"openbim-components.UIElement",source:"@site/docs/api/classes/openbim_components.UIElement.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.UIElement",permalink:"/api/classes/openbim_components.UIElement",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.UIElement",title:"Class: UIElement",sidebar_label:"UIElement",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ToolComponent",permalink:"/api/classes/openbim_components.ToolComponent"},next:{title:"UIManager",permalink:"/api/classes/openbim_components.UIManager"}},m={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"get",id:"get",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"set",id:"set",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4}],c={toc:d},u="wrapper";function k(e){var t=e.components,n=(0,r.Z)(e,i);return(0,l.kt)(u,(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".UIElement"),(0,l.kt)("p",null,"A simple object to handle UI components. You can use the generic constructor\nto specify the types of your UI components."),(0,l.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T")),(0,l.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,l.kt)("inlineCode",{parentName:"td"},"Object"))))),(0,l.kt)("h2",{id:"methods"},"Methods"),(0,l.kt)("h3",{id:"dispose"},"dispose"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("p",null,"Release all the memory used by this instance deleting all the UI components\ninside."),(0,l.kt)("h4",{id:"returns"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("h4",{id:"defined-in"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/ui-element.ts#L37"},"src/base-types/ui-element.ts:37")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"get"},"get"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"get"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"U"),">","(",(0,l.kt)("inlineCode",{parentName:"p"},"name"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"U")),(0,l.kt)("p",null,"Gets the UI Component with the given name. If it doesn't exist, it will\nthrow an error."),(0,l.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"U")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"SimpleUIComponent"),"<",(0,l.kt)("inlineCode",{parentName:"td"},"HTMLElement"),">")))),(0,l.kt)("h4",{id:"parameters"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"name")),(0,l.kt)("td",{parentName:"tr",align:"left"},"keyof ",(0,l.kt)("inlineCode",{parentName:"td"},"T")),(0,l.kt)("td",{parentName:"tr",align:"left"},"the identifier of the UI component.")))),(0,l.kt)("h4",{id:"returns-1"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"U")),(0,l.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/ui-element.ts#L17"},"src/base-types/ui-element.ts:17")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"set"},"set"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"set"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("p",null,"Sets all the UI components of this instance."),(0,l.kt)("h4",{id:"parameters-1"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"data")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T")),(0,l.kt)("td",{parentName:"tr",align:"left"},"all the UI components sorted by name in an object.")))),(0,l.kt)("h4",{id:"returns-2"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/ui-element.ts#L29"},"src/base-types/ui-element.ts:29")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/f7fb8d22.9f978fef.js b/build/assets/js/f7fb8d22.9f978fef.js new file mode 100644 index 00000000..4527a5b3 --- /dev/null +++ b/build/assets/js/f7fb8d22.9f978fef.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6632],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>u});var i=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function p(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var o=i.createContext({}),s=function(e){var t=i.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},d=function(e){var t=s(e.components);return i.createElement(o.Provider,{value:t},e.children)},m="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},k=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,p=e.originalType,o=e.parentName,d=r(e,["components","mdxType","originalType","parentName"]),m=s(n),k=a,u=m["".concat(o,".").concat(k)]||m[k]||h[k]||p;return n?i.createElement(u,l(l({ref:t},d),{},{components:n})):i.createElement(u,l({ref:t},d))}));function u(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var p=n.length,l=new Array(p);l[0]=k;var r={};for(var o in t)hasOwnProperty.call(t,o)&&(r[o]=t[o]);r.originalType=e,r[m]="string"==typeof e?e:a,l[1]=r;for(var s=2;s{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>m});var i=n(7462),a=n(3366),p=(n(7294),n(3905)),l=["components"],r={id:"openbim_components.EdgesClipper",title:"Class: EdgesClipper",sidebar_label:"EdgesClipper",custom_edit_url:null},o=void 0,s={unversionedId:"api/classes/openbim_components.EdgesClipper",id:"api/classes/openbim_components.EdgesClipper",title:"Class: EdgesClipper",description:"openbim-components.EdgesClipper",source:"@site/docs/api/classes/openbim_components.EdgesClipper.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.EdgesClipper",permalink:"/api/classes/openbim_components.EdgesClipper",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.EdgesClipper",title:"Class: EdgesClipper",sidebar_label:"EdgesClipper",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Disposer",permalink:"/api/classes/openbim_components.Disposer"},next:{title:"EdgesPlane",permalink:"/api/classes/openbim_components.EdgesPlane"}},d={},m=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"onAfterCreate",id:"onaftercreate",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"onAfterDelete",id:"onafterdelete",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"onAfterDrag",id:"onafterdrag",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onBeforeDrag",id:"onbeforedrag",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"orthogonalY",id:"orthogonaly",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"styles",id:"styles",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"toleranceOrthogonalY",id:"toleranceorthogonaly",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"uiElement",id:"uielement",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"Accessors",id:"accessors",level:2},{value:"enabled",id:"enabled",level:3},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"material",id:"material",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"visible",id:"visible",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"Methods",id:"methods",level:2},{value:"create",id:"create",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"createFromNormalAndCoplanarPoint",id:"createfromnormalandcoplanarpoint",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"delete",id:"delete",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"deleteAll",id:"deleteall",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-25",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-19",level:4},{value:"Inherited from",id:"inherited-from-26",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"updateEdges",id:"updateedges",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-20",level:4},{value:"Defined in",id:"defined-in-29",level:4}],h={toc:m},k="wrapper";function u(e){var t=e.components,n=(0,a.Z)(e,l);return(0,p.kt)(k,(0,i.Z)({},h,n,{components:t,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".EdgesClipper"),(0,p.kt)("p",null,"A more advanced version of ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper")," that also supports\nClippingEdges with customizable lines."),(0,p.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("p",{parentName:"li"},(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},(0,p.kt)("inlineCode",{parentName:"a"},"SimpleClipper")),"<",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.EdgesPlane"},(0,p.kt)("inlineCode",{parentName:"a"},"EdgesPlane")),">"),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"EdgesClipper"))))),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"onaftercreate"},"onAfterCreate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onAfterCreate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.EdgesPlane"},(0,p.kt)("inlineCode",{parentName:"a"},"EdgesPlane")),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onaftercreate"},"Createable.onAfterCreate")),(0,p.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#onaftercreate"},"onAfterCreate")),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L35"},"src/core/SimpleClipper/index.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onafterdelete"},"onAfterDelete"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onAfterDelete"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.EdgesPlane"},(0,p.kt)("inlineCode",{parentName:"a"},"EdgesPlane")),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onafterdelete"},"Createable.onAfterDelete")),(0,p.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#onafterdelete"},"onAfterDelete")),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L38"},"src/core/SimpleClipper/index.ts:38")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onafterdrag"},"onAfterDrag"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onAfterDrag"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,"Event that fires when the user stops dragging a clipping plane."),(0,p.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#onafterdrag"},"onAfterDrag")),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L44"},"src/core/SimpleClipper/index.ts:44")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onbeforedrag"},"onBeforeDrag"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onBeforeDrag"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,"Event that fires when the user starts dragging a clipping plane."),(0,p.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#onbeforedrag"},"onBeforeDrag")),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L41"},"src/core/SimpleClipper/index.ts:41")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,p.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#ondisposed"},"onDisposed")),(0,p.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L73"},"src/core/SimpleClipper/index.ts:73")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"orthogonaly"},"orthogonalY"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"orthogonalY"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,p.kt)("inlineCode",{parentName:"p"},"false")),(0,p.kt)("p",null,"Whether to force the clipping plane to be orthogonal in the Y direction\n(up). This is desirable when clipping a building horizontally and a\nclipping plane is created in it's roof, which might have a slight\nslope for draining purposes."),(0,p.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#orthogonaly"},"orthogonalY")),(0,p.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L60"},"src/core/SimpleClipper/index.ts:60")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"styles"},"styles"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"styles"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"EdgesStyles")),(0,p.kt)("p",null,"The list of defined LineStyle instances."),(0,p.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/EdgesClipper/index.ts#L14"},"src/navigation/EdgesClipper/index.ts:14")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"toleranceorthogonaly"},"toleranceOrthogonalY"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"toleranceOrthogonalY"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,p.kt)("inlineCode",{parentName:"p"},"0.7")),(0,p.kt)("p",null,"The tolerance that determines whether a horizontallish clipping plane\nwill be forced to be orthogonal to the Y direction. ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.EdgesClipper#orthogonaly"},"orthogonalY"),"\nhas to be ",(0,p.kt)("inlineCode",{parentName:"p"},"true")," for this to apply."),(0,p.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#toleranceorthogonaly"},"toleranceOrthogonalY")),(0,p.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L67"},"src/core/SimpleClipper/index.ts:67")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"uielement"},"uiElement"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"uiElement"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.UIElement"},(0,p.kt)("inlineCode",{parentName:"a"},"UIElement")),"<{ ",(0,p.kt)("inlineCode",{parentName:"p"},"main"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"Button")," }",">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI#uielement"},"UI.uiElement")),(0,p.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#uielement"},"uiElement")),(0,p.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L52"},"src/core/SimpleClipper/index.ts:52")),(0,p.kt)("h2",{id:"accessors"},"Accessors"),(0,p.kt)("h3",{id:"enabled"},"enabled"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"enabled"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,p.kt)("h4",{id:"returns"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,p.kt)("p",null,"SimpleClipper.enabled"),(0,p.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L88"},"src/core/SimpleClipper/index.ts:88")),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"enabled"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"state"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,p.kt)("h4",{id:"parameters"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"state")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,p.kt)("h4",{id:"returns-1"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,p.kt)("p",null,"SimpleClipper.enabled"),(0,p.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L93"},"src/core/SimpleClipper/index.ts:93")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"material"},"material"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"material"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Material")),(0,p.kt)("p",null,"The material of the clipping plane representation."),(0,p.kt)("h4",{id:"returns-2"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Material")),(0,p.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,p.kt)("p",null,"SimpleClipper.material"),(0,p.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L118"},"src/core/SimpleClipper/index.ts:118")),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"material"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"material"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,"The material of the clipping plane representation."),(0,p.kt)("h4",{id:"parameters-1"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"material")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"Material"))))),(0,p.kt)("h4",{id:"returns-3"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,p.kt)("p",null,"SimpleClipper.material"),(0,p.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L123"},"src/core/SimpleClipper/index.ts:123")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"size"},"size"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"size"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"number")),(0,p.kt)("p",null,"The size of the geometric representation of the clippings planes."),(0,p.kt)("h4",{id:"returns-4"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"number")),(0,p.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,p.kt)("p",null,"SimpleClipper.size"),(0,p.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L131"},"src/core/SimpleClipper/index.ts:131")),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"size"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"size"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,"The size of the geometric representation of the clippings planes."),(0,p.kt)("h4",{id:"parameters-2"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"size")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"number"))))),(0,p.kt)("h4",{id:"returns-5"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,p.kt)("p",null,"SimpleClipper.size"),(0,p.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L136"},"src/core/SimpleClipper/index.ts:136")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"visible"},"visible"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"visible"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,p.kt)("h4",{id:"returns-6"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,p.kt)("p",null,"SimpleClipper.visible"),(0,p.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L105"},"src/core/SimpleClipper/index.ts:105")),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"visible"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"state"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,p.kt)("h4",{id:"parameters-3"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"state")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,p.kt)("h4",{id:"returns-7"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,p.kt)("p",null,"SimpleClipper.visible"),(0,p.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L110"},"src/core/SimpleClipper/index.ts:110")),(0,p.kt)("h2",{id:"methods"},"Methods"),(0,p.kt)("h3",{id:"create"},"create"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"create"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#create"},"Createable.create")),(0,p.kt)("h4",{id:"returns-8"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#create"},"create")),(0,p.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L184"},"src/core/SimpleClipper/index.ts:184")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"createfromnormalandcoplanarpoint"},"createFromNormalAndCoplanarPoint"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"createFromNormalAndCoplanarPoint"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"normal"),", ",(0,p.kt)("inlineCode",{parentName:"p"},"point"),"): ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.EdgesPlane"},(0,p.kt)("inlineCode",{parentName:"a"},"EdgesPlane"))),(0,p.kt)("p",null,"Creates a plane in a certain place and with a certain orientation,\nwithout the need of the mouse."),(0,p.kt)("h4",{id:"parameters-4"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"normal")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"Vector3")),(0,p.kt)("td",{parentName:"tr",align:"left"},"the orientation of the clipping plane.")),(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"point")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"Vector3")),(0,p.kt)("td",{parentName:"tr",align:"left"},"the position of the clipping plane.")))),(0,p.kt)("h4",{id:"returns-9"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.EdgesPlane"},(0,p.kt)("inlineCode",{parentName:"a"},"EdgesPlane"))),(0,p.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#createfromnormalandcoplanarpoint"},"createFromNormalAndCoplanarPoint")),(0,p.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L200"},"src/core/SimpleClipper/index.ts:200")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"delete"},"delete"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"delete"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"plane?"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#delete"},"Createable.delete")),(0,p.kt)("h4",{id:"parameters-5"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"plane?")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.EdgesPlane"},(0,p.kt)("inlineCode",{parentName:"a"},"EdgesPlane"))),(0,p.kt)("td",{parentName:"tr",align:"left"},"the plane to delete. If undefined, the the first plane found under the cursor will be deleted.")))),(0,p.kt)("h4",{id:"returns-10"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#delete"},"delete")),(0,p.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L215"},"src/core/SimpleClipper/index.ts:215")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"deleteall"},"deleteAll"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"deleteAll"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,"Deletes all the existing clipping planes."),(0,p.kt)("h4",{id:"returns-11"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#deleteall"},"deleteAll")),(0,p.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L227"},"src/core/SimpleClipper/index.ts:227")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"dispose"},"dispose"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,p.kt)("h4",{id:"returns-12"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"overrides"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#dispose"},"dispose")),(0,p.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/EdgesClipper/index.ts#L28"},"src/navigation/EdgesClipper/index.ts:28")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"get"},"get"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"get"),"(): ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.EdgesPlane"},(0,p.kt)("inlineCode",{parentName:"a"},"EdgesPlane")),"[]"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,p.kt)("h4",{id:"returns-13"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.EdgesPlane"},(0,p.kt)("inlineCode",{parentName:"a"},"EdgesPlane")),"[]"),(0,p.kt)("h4",{id:"inherited-from-20"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#get"},"get")),(0,p.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L158"},"src/core/SimpleClipper/index.ts:158")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"hasui"},"hasUI"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,p.kt)("p",null,"Whether is component implements any kind of ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,p.kt)("h4",{id:"returns-14"},"Returns"),(0,p.kt)("p",null,"this is UI"),(0,p.kt)("h4",{id:"inherited-from-21"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#hasui"},"hasUI")),(0,p.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,p.kt)("h4",{id:"returns-15"},"Returns"),(0,p.kt)("p",null,"this is Configurable"),(0,p.kt)("h4",{id:"inherited-from-22"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#isconfigurable"},"isConfigurable")),(0,p.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,p.kt)("h4",{id:"returns-16"},"Returns"),(0,p.kt)("p",null,"this is Disposable"),(0,p.kt)("h4",{id:"inherited-from-23"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#isdisposeable"},"isDisposeable")),(0,p.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ishideable"},"isHideable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,p.kt)("h4",{id:"returns-17"},"Returns"),(0,p.kt)("p",null,"this is Hideable"),(0,p.kt)("h4",{id:"inherited-from-24"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#ishideable"},"isHideable")),(0,p.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,p.kt)("h4",{id:"returns-18"},"Returns"),(0,p.kt)("p",null,"this is Resizeable"),(0,p.kt)("h4",{id:"inherited-from-25"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#isresizeable"},"isResizeable")),(0,p.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,p.kt)("h4",{id:"returns-19"},"Returns"),(0,p.kt)("p",null,"this is Updateable"),(0,p.kt)("h4",{id:"inherited-from-26"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#isupdateable"},"isUpdateable")),(0,p.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"updateedges"},"updateEdges"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"updateEdges"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"updateFills?"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,"Updates all the lines of the ClippingEdges."),(0,p.kt)("h4",{id:"parameters-6"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"updateFills")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"false"))))),(0,p.kt)("h4",{id:"returns-20"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/navigation/EdgesClipper/index.ts#L36"},"src/navigation/EdgesClipper/index.ts:36")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/f7fb8d22.d886b486.js b/build/assets/js/f7fb8d22.d886b486.js deleted file mode 100644 index 7300ae0b..00000000 --- a/build/assets/js/f7fb8d22.d886b486.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6632],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>f});var i=n(7294);function p(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function l(e){for(var t=1;t=0||(p[n]=e[n]);return p}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(p[n]=e[n])}return p}var o=i.createContext({}),s=function(e){var t=i.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},d=function(e){var t=s(e.components);return i.createElement(o.Provider,{value:t},e.children)},m="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},k=i.forwardRef((function(e,t){var n=e.components,p=e.mdxType,a=e.originalType,o=e.parentName,d=r(e,["components","mdxType","originalType","parentName"]),m=s(n),k=p,f=m["".concat(o,".").concat(k)]||m[k]||h[k]||a;return n?i.createElement(f,l(l({ref:t},d),{},{components:n})):i.createElement(f,l({ref:t},d))}));function f(e,t){var n=arguments,p=t&&t.mdxType;if("string"==typeof e||p){var a=n.length,l=new Array(a);l[0]=k;var r={};for(var o in t)hasOwnProperty.call(t,o)&&(r[o]=t[o]);r.originalType=e,r[m]="string"==typeof e?e:p,l[1]=r;for(var s=2;s{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>f,frontMatter:()=>r,metadata:()=>s,toc:()=>m});var i=n(7462),p=n(3366),a=(n(7294),n(3905)),l=["components"],r={id:"openbim_components.EdgesClipper",title:"Class: EdgesClipper",sidebar_label:"EdgesClipper",custom_edit_url:null},o=void 0,s={unversionedId:"api/classes/openbim_components.EdgesClipper",id:"api/classes/openbim_components.EdgesClipper",title:"Class: EdgesClipper",description:"openbim-components.EdgesClipper",source:"@site/docs/api/classes/openbim_components.EdgesClipper.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.EdgesClipper",permalink:"/api/classes/openbim_components.EdgesClipper",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.EdgesClipper",title:"Class: EdgesClipper",sidebar_label:"EdgesClipper",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Disposer",permalink:"/api/classes/openbim_components.Disposer"},next:{title:"EdgesPlane",permalink:"/api/classes/openbim_components.EdgesPlane"}},d={},m=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"onAfterCreate",id:"onaftercreate",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"onAfterDelete",id:"onafterdelete",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"onAfterDrag",id:"onafterdrag",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onBeforeDrag",id:"onbeforedrag",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"orthogonalY",id:"orthogonaly",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"styles",id:"styles",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"toleranceOrthogonalY",id:"toleranceorthogonaly",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"uiElement",id:"uielement",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"Accessors",id:"accessors",level:2},{value:"enabled",id:"enabled",level:3},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"material",id:"material",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"visible",id:"visible",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"Methods",id:"methods",level:2},{value:"create",id:"create",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"createFromNormalAndCoplanarPoint",id:"createfromnormalandcoplanarpoint",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"delete",id:"delete",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"deleteAll",id:"deleteall",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-25",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-19",level:4},{value:"Inherited from",id:"inherited-from-26",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"updateEdges",id:"updateedges",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-20",level:4},{value:"Defined in",id:"defined-in-29",level:4}],h={toc:m},k="wrapper";function f(e){var t=e.components,n=(0,p.Z)(e,l);return(0,a.kt)(k,(0,i.Z)({},h,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".EdgesClipper"),(0,a.kt)("p",null,"A more advanced version of ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper")," that also supports\nClippingEdges with customizable lines."),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},(0,a.kt)("inlineCode",{parentName:"a"},"SimpleClipper")),"<",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.EdgesPlane"},(0,a.kt)("inlineCode",{parentName:"a"},"EdgesPlane")),">"),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"EdgesClipper"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"onaftercreate"},"onAfterCreate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"onAfterCreate"),": ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,a.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.EdgesPlane"},(0,a.kt)("inlineCode",{parentName:"a"},"EdgesPlane")),">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onaftercreate"},"Createable.onAfterCreate")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#onaftercreate"},"onAfterCreate")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L35"},"temp/engine_components/src/core/SimpleClipper/index.ts:35")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"onafterdelete"},"onAfterDelete"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"onAfterDelete"),": ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,a.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.EdgesPlane"},(0,a.kt)("inlineCode",{parentName:"a"},"EdgesPlane")),">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onafterdelete"},"Createable.onAfterDelete")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#onafterdelete"},"onAfterDelete")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L38"},"temp/engine_components/src/core/SimpleClipper/index.ts:38")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"onafterdrag"},"onAfterDrag"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"onAfterDrag"),": ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,a.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("p",null,"Event that fires when the user stops dragging a clipping plane."),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#onafterdrag"},"onAfterDrag")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L44"},"temp/engine_components/src/core/SimpleClipper/index.ts:44")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"onbeforedrag"},"onBeforeDrag"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"onBeforeDrag"),": ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,a.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("p",null,"Event that fires when the user starts dragging a clipping plane."),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#onbeforedrag"},"onBeforeDrag")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L41"},"temp/engine_components/src/core/SimpleClipper/index.ts:41")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,a.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#ondisposed"},"onDisposed")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L73"},"temp/engine_components/src/core/SimpleClipper/index.ts:73")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"orthogonaly"},"orthogonalY"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"orthogonalY"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"false")),(0,a.kt)("p",null,"Whether to force the clipping plane to be orthogonal in the Y direction\n(up). This is desirable when clipping a building horizontally and a\nclipping plane is created in it's roof, which might have a slight\nslope for draining purposes."),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#orthogonaly"},"orthogonalY")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L60"},"temp/engine_components/src/core/SimpleClipper/index.ts:60")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"styles"},"styles"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"styles"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"EdgesStyles")),(0,a.kt)("p",null,"The list of defined LineStyle instances."),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/EdgesClipper/index.ts#L14"},"temp/engine_components/src/navigation/EdgesClipper/index.ts:14")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"toleranceorthogonaly"},"toleranceOrthogonalY"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"toleranceOrthogonalY"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"0.7")),(0,a.kt)("p",null,"The tolerance that determines whether a horizontallish clipping plane\nwill be forced to be orthogonal to the Y direction. ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.EdgesClipper#orthogonaly"},"orthogonalY"),"\nhas to be ",(0,a.kt)("inlineCode",{parentName:"p"},"true")," for this to apply."),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#toleranceorthogonaly"},"toleranceOrthogonalY")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L67"},"temp/engine_components/src/core/SimpleClipper/index.ts:67")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"uielement"},"uiElement"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"uiElement"),": ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.UIElement"},(0,a.kt)("inlineCode",{parentName:"a"},"UIElement")),"<{ ",(0,a.kt)("inlineCode",{parentName:"p"},"main"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Button")," }",">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI#uielement"},"UI.uiElement")),(0,a.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#uielement"},"uiElement")),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L52"},"temp/engine_components/src/core/SimpleClipper/index.ts:52")),(0,a.kt)("h2",{id:"accessors"},"Accessors"),(0,a.kt)("h3",{id:"enabled"},"enabled"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"enabled"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,a.kt)("p",null,"SimpleClipper.enabled"),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L88"},"temp/engine_components/src/core/SimpleClipper/index.ts:88")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"enabled"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"state"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"state")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,a.kt)("p",null,"SimpleClipper.enabled"),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L93"},"temp/engine_components/src/core/SimpleClipper/index.ts:93")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"material"},"material"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"material"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Material")),(0,a.kt)("p",null,"The material of the clipping plane representation."),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Material")),(0,a.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,a.kt)("p",null,"SimpleClipper.material"),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L118"},"temp/engine_components/src/core/SimpleClipper/index.ts:118")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"material"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"material"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"The material of the clipping plane representation."),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"material")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Material"))))),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,a.kt)("p",null,"SimpleClipper.material"),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L123"},"temp/engine_components/src/core/SimpleClipper/index.ts:123")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"size"},"size"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"size"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The size of the geometric representation of the clippings planes."),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,a.kt)("p",null,"SimpleClipper.size"),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L131"},"temp/engine_components/src/core/SimpleClipper/index.ts:131")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"size"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"size"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"The size of the geometric representation of the clippings planes."),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"size")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,a.kt)("p",null,"SimpleClipper.size"),(0,a.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L136"},"temp/engine_components/src/core/SimpleClipper/index.ts:136")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"visible"},"visible"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"visible"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,a.kt)("p",null,"SimpleClipper.visible"),(0,a.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L105"},"temp/engine_components/src/core/SimpleClipper/index.ts:105")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"visible"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"state"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,a.kt)("h4",{id:"parameters-3"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"state")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,a.kt)("h4",{id:"returns-7"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,a.kt)("p",null,"SimpleClipper.visible"),(0,a.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L110"},"temp/engine_components/src/core/SimpleClipper/index.ts:110")),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"create"},"create"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"create"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#create"},"Createable.create")),(0,a.kt)("h4",{id:"returns-8"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#create"},"create")),(0,a.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L184"},"temp/engine_components/src/core/SimpleClipper/index.ts:184")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"createfromnormalandcoplanarpoint"},"createFromNormalAndCoplanarPoint"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"createFromNormalAndCoplanarPoint"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"normal"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"point"),"): ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.EdgesPlane"},(0,a.kt)("inlineCode",{parentName:"a"},"EdgesPlane"))),(0,a.kt)("p",null,"Creates a plane in a certain place and with a certain orientation,\nwithout the need of the mouse."),(0,a.kt)("h4",{id:"parameters-4"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"normal")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Vector3")),(0,a.kt)("td",{parentName:"tr",align:"left"},"the orientation of the clipping plane.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"point")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Vector3")),(0,a.kt)("td",{parentName:"tr",align:"left"},"the position of the clipping plane.")))),(0,a.kt)("h4",{id:"returns-9"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.EdgesPlane"},(0,a.kt)("inlineCode",{parentName:"a"},"EdgesPlane"))),(0,a.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#createfromnormalandcoplanarpoint"},"createFromNormalAndCoplanarPoint")),(0,a.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L200"},"temp/engine_components/src/core/SimpleClipper/index.ts:200")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"delete"},"delete"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"delete"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"plane?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#delete"},"Createable.delete")),(0,a.kt)("h4",{id:"parameters-5"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"plane?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.EdgesPlane"},(0,a.kt)("inlineCode",{parentName:"a"},"EdgesPlane"))),(0,a.kt)("td",{parentName:"tr",align:"left"},"the plane to delete. If undefined, the the first plane found under the cursor will be deleted.")))),(0,a.kt)("h4",{id:"returns-10"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#delete"},"delete")),(0,a.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L215"},"temp/engine_components/src/core/SimpleClipper/index.ts:215")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"deleteall"},"deleteAll"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"deleteAll"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"Deletes all the existing clipping planes."),(0,a.kt)("h4",{id:"returns-11"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#deleteall"},"deleteAll")),(0,a.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L227"},"temp/engine_components/src/core/SimpleClipper/index.ts:227")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"dispose"},"dispose"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,a.kt)("h4",{id:"returns-12"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#dispose"},"dispose")),(0,a.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/EdgesClipper/index.ts#L28"},"temp/engine_components/src/navigation/EdgesClipper/index.ts:28")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"get"},"get"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"get"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.EdgesPlane"},(0,a.kt)("inlineCode",{parentName:"a"},"EdgesPlane")),"[]"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,a.kt)("h4",{id:"returns-13"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.EdgesPlane"},(0,a.kt)("inlineCode",{parentName:"a"},"EdgesPlane")),"[]"),(0,a.kt)("h4",{id:"inherited-from-20"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#get"},"get")),(0,a.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L158"},"temp/engine_components/src/core/SimpleClipper/index.ts:158")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"hasui"},"hasUI"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,a.kt)("p",null,"Whether is component implements any kind of ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,a.kt)("h4",{id:"returns-14"},"Returns"),(0,a.kt)("p",null,"this is UI"),(0,a.kt)("h4",{id:"inherited-from-21"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#hasui"},"hasUI")),(0,a.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,a.kt)("h4",{id:"returns-15"},"Returns"),(0,a.kt)("p",null,"this is Configurable"),(0,a.kt)("h4",{id:"inherited-from-22"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#isconfigurable"},"isConfigurable")),(0,a.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,a.kt)("h4",{id:"returns-16"},"Returns"),(0,a.kt)("p",null,"this is Disposable"),(0,a.kt)("h4",{id:"inherited-from-23"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#isdisposeable"},"isDisposeable")),(0,a.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ishideable"},"isHideable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,a.kt)("h4",{id:"returns-17"},"Returns"),(0,a.kt)("p",null,"this is Hideable"),(0,a.kt)("h4",{id:"inherited-from-24"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#ishideable"},"isHideable")),(0,a.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,a.kt)("h4",{id:"returns-18"},"Returns"),(0,a.kt)("p",null,"this is Resizeable"),(0,a.kt)("h4",{id:"inherited-from-25"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#isresizeable"},"isResizeable")),(0,a.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,a.kt)("p",null,"Whether is component is ",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,a.kt)("h4",{id:"returns-19"},"Returns"),(0,a.kt)("p",null,"this is Updateable"),(0,a.kt)("h4",{id:"inherited-from-26"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#isupdateable"},"isUpdateable")),(0,a.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"updateedges"},"updateEdges"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"updateEdges"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"updateFills?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("p",null,"Updates all the lines of the ClippingEdges."),(0,a.kt)("h4",{id:"parameters-6"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"updateFills")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"false"))))),(0,a.kt)("h4",{id:"returns-20"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/navigation/EdgesClipper/index.ts#L36"},"temp/engine_components/src/navigation/EdgesClipper/index.ts:36")))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/fa613aa0.605eb72c.js b/build/assets/js/fa613aa0.605eb72c.js new file mode 100644 index 00000000..3f5ad9b3 --- /dev/null +++ b/build/assets/js/fa613aa0.605eb72c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3060],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>u});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function p(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var o=a.createContext({}),s=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},m=function(e){var t=s(e.components);return a.createElement(o.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,p=e.originalType,o=e.parentName,m=r(e,["components","mdxType","originalType","parentName"]),d=s(n),h=i,u=d["".concat(o,".").concat(h)]||d[h]||k[h]||p;return n?a.createElement(u,l(l({ref:t},m),{},{components:n})):a.createElement(u,l({ref:t},m))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var p=n.length,l=new Array(p);l[0]=h;var r={};for(var o in t)hasOwnProperty.call(t,o)&&(r[o]=t[o]);r.originalType=e,r[d]="string"==typeof e?e:i,l[1]=r;for(var s=2;s{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>d});var a=n(7462),i=n(3366),p=(n(7294),n(3905)),l=["components"],r={id:"openbim_components.SimpleClipper",title:"Class: SimpleClipper",sidebar_label:"SimpleClipper",custom_edit_url:null},o=void 0,s={unversionedId:"api/classes/openbim_components.SimpleClipper",id:"api/classes/openbim_components.SimpleClipper",title:"Class: SimpleClipper",description:"openbim-components.SimpleClipper",source:"@site/docs/api/classes/openbim_components.SimpleClipper.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.SimpleClipper",permalink:"/api/classes/openbim_components.SimpleClipper",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.SimpleClipper",title:"Class: SimpleClipper",sidebar_label:"SimpleClipper",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"SimpleCamera",permalink:"/api/classes/openbim_components.SimpleCamera"},next:{title:"SimpleGrid",permalink:"/api/classes/openbim_components.SimpleGrid"}},m={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"onAfterCreate",id:"onaftercreate",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"onAfterDelete",id:"onafterdelete",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"onAfterDrag",id:"onafterdrag",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"onBeforeDrag",id:"onbeforedrag",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"orthogonalY",id:"orthogonaly",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"toleranceOrthogonalY",id:"toleranceorthogonaly",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"uiElement",id:"uielement",level:3},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Accessors",id:"accessors",level:2},{value:"enabled",id:"enabled",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"material",id:"material",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"visible",id:"visible",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Implementation of",id:"implementation-of-4",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Implementation of",id:"implementation-of-5",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"Methods",id:"methods",level:2},{value:"create",id:"create",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Implementation of",id:"implementation-of-6",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"createFromNormalAndCoplanarPoint",id:"createfromnormalandcoplanarpoint",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"delete",id:"delete",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Implementation of",id:"implementation-of-7",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"deleteAll",id:"deleteall",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Implementation of",id:"implementation-of-8",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-19",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-27",level:4}],k={toc:d},h="wrapper";function u(e){var t=e.components,n=(0,i.Z)(e,l);return(0,p.kt)(h,(0,a.Z)({},k,n,{components:t,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".SimpleClipper"),(0,p.kt)("p",null,"A lightweight component to easily create and handle\n",(0,p.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/materials/Material.clippingPlanes"},"clipping planes"),"."),(0,p.kt)("p",null,(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"Param"))),(0,p.kt)("p",null,"the instance of ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Components"},"Components")," used."),(0,p.kt)("p",null,(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"Param"))),(0,p.kt)("p",null,"the type of plane to be used by the clipper.\nE.g. ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),"."),(0,p.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"T")),(0,p.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,p.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.SimplePlane"},(0,p.kt)("inlineCode",{parentName:"a"},"SimplePlane")))))),(0,p.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("p",{parentName:"li"},(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,p.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"SimpleClipper"))),(0,p.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.EdgesClipper"},(0,p.kt)("inlineCode",{parentName:"a"},"EdgesClipper"))))),(0,p.kt)("h2",{id:"implements"},"Implements"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Createable"},(0,p.kt)("inlineCode",{parentName:"a"},"Createable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,p.kt)("inlineCode",{parentName:"a"},"Disposable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Hideable"},(0,p.kt)("inlineCode",{parentName:"a"},"Hideable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},(0,p.kt)("inlineCode",{parentName:"a"},"UI")))),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"onaftercreate"},"onAfterCreate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onAfterCreate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onaftercreate"},"Createable.onAfterCreate")),(0,p.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onaftercreate"},"onAfterCreate")),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L35"},"src/core/SimpleClipper/index.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onafterdelete"},"onAfterDelete"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onAfterDelete"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onafterdelete"},"Createable.onAfterDelete")),(0,p.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onafterdelete"},"onAfterDelete")),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L38"},"src/core/SimpleClipper/index.ts:38")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onafterdrag"},"onAfterDrag"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onAfterDrag"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,"Event that fires when the user stops dragging a clipping plane."),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L44"},"src/core/SimpleClipper/index.ts:44")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onbeforedrag"},"onBeforeDrag"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onBeforeDrag"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,"Event that fires when the user starts dragging a clipping plane."),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L41"},"src/core/SimpleClipper/index.ts:41")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,p.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,p.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L73"},"src/core/SimpleClipper/index.ts:73")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"orthogonaly"},"orthogonalY"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"orthogonalY"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,p.kt)("inlineCode",{parentName:"p"},"false")),(0,p.kt)("p",null,"Whether to force the clipping plane to be orthogonal in the Y direction\n(up). This is desirable when clipping a building horizontally and a\nclipping plane is created in it's roof, which might have a slight\nslope for draining purposes."),(0,p.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L60"},"src/core/SimpleClipper/index.ts:60")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"toleranceorthogonaly"},"toleranceOrthogonalY"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"toleranceOrthogonalY"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,p.kt)("inlineCode",{parentName:"p"},"0.7")),(0,p.kt)("p",null,"The tolerance that determines whether a horizontallish clipping plane\nwill be forced to be orthogonal to the Y direction. ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#orthogonaly"},"orthogonalY"),"\nhas to be ",(0,p.kt)("inlineCode",{parentName:"p"},"true")," for this to apply."),(0,p.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L67"},"src/core/SimpleClipper/index.ts:67")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"uielement"},"uiElement"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"uiElement"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.UIElement"},(0,p.kt)("inlineCode",{parentName:"a"},"UIElement")),"<{ ",(0,p.kt)("inlineCode",{parentName:"p"},"main"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"Button")," }",">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI#uielement"},"UI.uiElement")),(0,p.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI#uielement"},"uiElement")),(0,p.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L52"},"src/core/SimpleClipper/index.ts:52")),(0,p.kt)("h2",{id:"accessors"},"Accessors"),(0,p.kt)("h3",{id:"enabled"},"enabled"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"enabled"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,p.kt)("h4",{id:"returns"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("h4",{id:"overrides"},"Overrides"),(0,p.kt)("p",null,"Component.enabled"),(0,p.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L88"},"src/core/SimpleClipper/index.ts:88")),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"enabled"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"state"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,p.kt)("h4",{id:"parameters"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"state")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,p.kt)("h4",{id:"returns-1"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"overrides-1"},"Overrides"),(0,p.kt)("p",null,"Component.enabled"),(0,p.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L93"},"src/core/SimpleClipper/index.ts:93")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"material"},"material"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"material"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Material")),(0,p.kt)("p",null,"The material of the clipping plane representation."),(0,p.kt)("h4",{id:"returns-2"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Material")),(0,p.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L118"},"src/core/SimpleClipper/index.ts:118")),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"material"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"material"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,"The material of the clipping plane representation."),(0,p.kt)("h4",{id:"parameters-1"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"material")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"Material"))))),(0,p.kt)("h4",{id:"returns-3"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L123"},"src/core/SimpleClipper/index.ts:123")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"size"},"size"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"size"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"number")),(0,p.kt)("p",null,"The size of the geometric representation of the clippings planes."),(0,p.kt)("h4",{id:"returns-4"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"number")),(0,p.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L131"},"src/core/SimpleClipper/index.ts:131")),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"size"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"size"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,"The size of the geometric representation of the clippings planes."),(0,p.kt)("h4",{id:"parameters-2"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"size")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"number"))))),(0,p.kt)("h4",{id:"returns-5"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L136"},"src/core/SimpleClipper/index.ts:136")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"visible"},"visible"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"visible"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,p.kt)("h4",{id:"returns-6"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("h4",{id:"implementation-of-4"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"visible")),(0,p.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L105"},"src/core/SimpleClipper/index.ts:105")),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"visible"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"state"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,p.kt)("h4",{id:"parameters-3"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"state")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,p.kt)("h4",{id:"returns-7"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"implementation-of-5"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"visible")),(0,p.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L110"},"src/core/SimpleClipper/index.ts:110")),(0,p.kt)("h2",{id:"methods"},"Methods"),(0,p.kt)("h3",{id:"create"},"create"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"create"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#create"},"Createable.create")),(0,p.kt)("h4",{id:"returns-8"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"implementation-of-6"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#create"},"create")),(0,p.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L184"},"src/core/SimpleClipper/index.ts:184")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"createfromnormalandcoplanarpoint"},"createFromNormalAndCoplanarPoint"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"createFromNormalAndCoplanarPoint"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"normal"),", ",(0,p.kt)("inlineCode",{parentName:"p"},"point"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"T")),(0,p.kt)("p",null,"Creates a plane in a certain place and with a certain orientation,\nwithout the need of the mouse."),(0,p.kt)("h4",{id:"parameters-4"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"normal")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"Vector3")),(0,p.kt)("td",{parentName:"tr",align:"left"},"the orientation of the clipping plane.")),(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"point")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"Vector3")),(0,p.kt)("td",{parentName:"tr",align:"left"},"the position of the clipping plane.")))),(0,p.kt)("h4",{id:"returns-9"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"T")),(0,p.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L200"},"src/core/SimpleClipper/index.ts:200")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"delete"},"delete"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"delete"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"plane?"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#delete"},"Createable.delete")),(0,p.kt)("h4",{id:"parameters-5"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"plane?")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"T")),(0,p.kt)("td",{parentName:"tr",align:"left"},"the plane to delete. If undefined, the the first plane found under the cursor will be deleted.")))),(0,p.kt)("h4",{id:"returns-10"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"implementation-of-7"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#delete"},"delete")),(0,p.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L215"},"src/core/SimpleClipper/index.ts:215")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"deleteall"},"deleteAll"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"deleteAll"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,"Deletes all the existing clipping planes."),(0,p.kt)("h4",{id:"returns-11"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L227"},"src/core/SimpleClipper/index.ts:227")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"dispose"},"dispose"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,p.kt)("h4",{id:"returns-12"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"implementation-of-8"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,p.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L163"},"src/core/SimpleClipper/index.ts:163")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"get"},"get"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"get"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"T"),"[]"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,p.kt)("h4",{id:"returns-13"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"T"),"[]"),(0,p.kt)("h4",{id:"overrides-2"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,p.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/core/SimpleClipper/index.ts#L158"},"src/core/SimpleClipper/index.ts:158")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"hasui"},"hasUI"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,p.kt)("p",null,"Whether is component implements any kind of ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,p.kt)("h4",{id:"returns-14"},"Returns"),(0,p.kt)("p",null,"this is UI"),(0,p.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,p.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,p.kt)("h4",{id:"returns-15"},"Returns"),(0,p.kt)("p",null,"this is Configurable"),(0,p.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,p.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L57"},"src/base-types/component.ts:57")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,p.kt)("h4",{id:"returns-16"},"Returns"),(0,p.kt)("p",null,"this is Disposable"),(0,p.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,p.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L35"},"src/base-types/component.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ishideable"},"isHideable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,p.kt)("h4",{id:"returns-17"},"Returns"),(0,p.kt)("p",null,"this is Hideable"),(0,p.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,p.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L52"},"src/base-types/component.ts:52")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,p.kt)("h4",{id:"returns-18"},"Returns"),(0,p.kt)("p",null,"this is Resizeable"),(0,p.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,p.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L40"},"src/base-types/component.ts:40")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,p.kt)("h4",{id:"returns-19"},"Returns"),(0,p.kt)("p",null,"this is Updateable"),(0,p.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,p.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/444e81a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/fa613aa0.af1c51a6.js b/build/assets/js/fa613aa0.af1c51a6.js deleted file mode 100644 index c3f86061..00000000 --- a/build/assets/js/fa613aa0.af1c51a6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3060],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>h});var i=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function p(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var o=i.createContext({}),s=function(e){var t=i.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},m=function(e){var t=s(e.components);return i.createElement(o.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},c=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,p=e.originalType,o=e.parentName,m=r(e,["components","mdxType","originalType","parentName"]),d=s(n),c=a,h=d["".concat(o,".").concat(c)]||d[c]||k[c]||p;return n?i.createElement(h,l(l({ref:t},m),{},{components:n})):i.createElement(h,l({ref:t},m))}));function h(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var p=n.length,l=new Array(p);l[0]=c;var r={};for(var o in t)hasOwnProperty.call(t,o)&&(r[o]=t[o]);r.originalType=e,r[d]="string"==typeof e?e:a,l[1]=r;for(var s=2;s{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>s,toc:()=>d});var i=n(7462),a=n(3366),p=(n(7294),n(3905)),l=["components"],r={id:"openbim_components.SimpleClipper",title:"Class: SimpleClipper",sidebar_label:"SimpleClipper",custom_edit_url:null},o=void 0,s={unversionedId:"api/classes/openbim_components.SimpleClipper",id:"api/classes/openbim_components.SimpleClipper",title:"Class: SimpleClipper",description:"openbim-components.SimpleClipper",source:"@site/docs/api/classes/openbim_components.SimpleClipper.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.SimpleClipper",permalink:"/api/classes/openbim_components.SimpleClipper",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.SimpleClipper",title:"Class: SimpleClipper",sidebar_label:"SimpleClipper",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"SimpleCamera",permalink:"/api/classes/openbim_components.SimpleCamera"},next:{title:"SimpleGrid",permalink:"/api/classes/openbim_components.SimpleGrid"}},m={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Properties",id:"properties",level:2},{value:"onAfterCreate",id:"onaftercreate",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"onAfterDelete",id:"onafterdelete",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"onAfterDrag",id:"onafterdrag",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"onBeforeDrag",id:"onbeforedrag",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"onDisposed",id:"ondisposed",level:3},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"orthogonalY",id:"orthogonaly",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"toleranceOrthogonalY",id:"toleranceorthogonaly",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"uiElement",id:"uielement",level:3},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Accessors",id:"accessors",level:2},{value:"enabled",id:"enabled",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"material",id:"material",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"visible",id:"visible",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Implementation of",id:"implementation-of-4",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Implementation of",id:"implementation-of-5",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"Methods",id:"methods",level:2},{value:"create",id:"create",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Implementation of",id:"implementation-of-6",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"createFromNormalAndCoplanarPoint",id:"createfromnormalandcoplanarpoint",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"delete",id:"delete",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Implementation of",id:"implementation-of-7",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"deleteAll",id:"deleteall",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Implementation of",id:"implementation-of-8",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-19",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-27",level:4}],k={toc:d},c="wrapper";function h(e){var t=e.components,n=(0,a.Z)(e,l);return(0,p.kt)(c,(0,i.Z)({},k,n,{components:t,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".SimpleClipper"),(0,p.kt)("p",null,"A lightweight component to easily create and handle\n",(0,p.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/materials/Material.clippingPlanes"},"clipping planes"),"."),(0,p.kt)("p",null,(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"Param"))),(0,p.kt)("p",null,"the instance of ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Components"},"Components")," used."),(0,p.kt)("p",null,(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"Param"))),(0,p.kt)("p",null,"the type of plane to be used by the clipper.\nE.g. ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),"."),(0,p.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"T")),(0,p.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,p.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.SimplePlane"},(0,p.kt)("inlineCode",{parentName:"a"},"SimplePlane")))))),(0,p.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("p",{parentName:"li"},(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,p.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"SimpleClipper"))),(0,p.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.EdgesClipper"},(0,p.kt)("inlineCode",{parentName:"a"},"EdgesClipper"))))),(0,p.kt)("h2",{id:"implements"},"Implements"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Createable"},(0,p.kt)("inlineCode",{parentName:"a"},"Createable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},(0,p.kt)("inlineCode",{parentName:"a"},"Disposable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Hideable"},(0,p.kt)("inlineCode",{parentName:"a"},"Hideable"))),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},(0,p.kt)("inlineCode",{parentName:"a"},"UI")))),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"onaftercreate"},"onAfterCreate"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onAfterCreate"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onaftercreate"},"Createable.onAfterCreate")),(0,p.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onaftercreate"},"onAfterCreate")),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L35"},"temp/engine_components/src/core/SimpleClipper/index.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onafterdelete"},"onAfterDelete"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onAfterDelete"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onafterdelete"},"Createable.onAfterDelete")),(0,p.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onafterdelete"},"onAfterDelete")),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L38"},"temp/engine_components/src/core/SimpleClipper/index.ts:38")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onafterdrag"},"onAfterDrag"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onAfterDrag"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,"Event that fires when the user stops dragging a clipping plane."),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L44"},"temp/engine_components/src/core/SimpleClipper/index.ts:44")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"onbeforedrag"},"onBeforeDrag"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onBeforeDrag"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,"Event that fires when the user starts dragging a clipping plane."),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L41"},"temp/engine_components/src/core/SimpleClipper/index.ts:41")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ondisposed"},"onDisposed"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,p.kt)("strong",{parentName:"p"},"onDisposed"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,p.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,p.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"Disposable.onDisposed")),(0,p.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#ondisposed"},"onDisposed")),(0,p.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L73"},"temp/engine_components/src/core/SimpleClipper/index.ts:73")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"orthogonaly"},"orthogonalY"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"orthogonalY"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,p.kt)("inlineCode",{parentName:"p"},"false")),(0,p.kt)("p",null,"Whether to force the clipping plane to be orthogonal in the Y direction\n(up). This is desirable when clipping a building horizontally and a\nclipping plane is created in it's roof, which might have a slight\nslope for draining purposes."),(0,p.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L60"},"temp/engine_components/src/core/SimpleClipper/index.ts:60")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"toleranceorthogonaly"},"toleranceOrthogonalY"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"toleranceOrthogonalY"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,p.kt)("inlineCode",{parentName:"p"},"0.7")),(0,p.kt)("p",null,"The tolerance that determines whether a horizontallish clipping plane\nwill be forced to be orthogonal to the Y direction. ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#orthogonaly"},"orthogonalY"),"\nhas to be ",(0,p.kt)("inlineCode",{parentName:"p"},"true")," for this to apply."),(0,p.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L67"},"temp/engine_components/src/core/SimpleClipper/index.ts:67")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"uielement"},"uiElement"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"uiElement"),": ",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.UIElement"},(0,p.kt)("inlineCode",{parentName:"a"},"UIElement")),"<{ ",(0,p.kt)("inlineCode",{parentName:"p"},"main"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"Button")," }",">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI#uielement"},"UI.uiElement")),(0,p.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI#uielement"},"uiElement")),(0,p.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L52"},"temp/engine_components/src/core/SimpleClipper/index.ts:52")),(0,p.kt)("h2",{id:"accessors"},"Accessors"),(0,p.kt)("h3",{id:"enabled"},"enabled"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"enabled"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,p.kt)("h4",{id:"returns"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("h4",{id:"overrides"},"Overrides"),(0,p.kt)("p",null,"Component.enabled"),(0,p.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L88"},"temp/engine_components/src/core/SimpleClipper/index.ts:88")),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"enabled"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"state"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,p.kt)("h4",{id:"parameters"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"state")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,p.kt)("h4",{id:"returns-1"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"overrides-1"},"Overrides"),(0,p.kt)("p",null,"Component.enabled"),(0,p.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L93"},"temp/engine_components/src/core/SimpleClipper/index.ts:93")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"material"},"material"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"material"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Material")),(0,p.kt)("p",null,"The material of the clipping plane representation."),(0,p.kt)("h4",{id:"returns-2"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Material")),(0,p.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L118"},"temp/engine_components/src/core/SimpleClipper/index.ts:118")),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"material"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"material"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,"The material of the clipping plane representation."),(0,p.kt)("h4",{id:"parameters-1"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"material")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"Material"))))),(0,p.kt)("h4",{id:"returns-3"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L123"},"temp/engine_components/src/core/SimpleClipper/index.ts:123")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"size"},"size"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"size"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"number")),(0,p.kt)("p",null,"The size of the geometric representation of the clippings planes."),(0,p.kt)("h4",{id:"returns-4"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"number")),(0,p.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L131"},"temp/engine_components/src/core/SimpleClipper/index.ts:131")),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"size"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"size"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,"The size of the geometric representation of the clippings planes."),(0,p.kt)("h4",{id:"parameters-2"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"size")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"number"))))),(0,p.kt)("h4",{id:"returns-5"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L136"},"temp/engine_components/src/core/SimpleClipper/index.ts:136")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"visible"},"visible"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"get")," ",(0,p.kt)("strong",{parentName:"p"},"visible"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,p.kt)("h4",{id:"returns-6"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("h4",{id:"implementation-of-4"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"visible")),(0,p.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L105"},"temp/engine_components/src/core/SimpleClipper/index.ts:105")),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"set")," ",(0,p.kt)("strong",{parentName:"p"},"visible"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"state"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,p.kt)("h4",{id:"parameters-3"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"state")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,p.kt)("h4",{id:"returns-7"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"implementation-of-5"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"visible")),(0,p.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L110"},"temp/engine_components/src/core/SimpleClipper/index.ts:110")),(0,p.kt)("h2",{id:"methods"},"Methods"),(0,p.kt)("h3",{id:"create"},"create"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"create"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#create"},"Createable.create")),(0,p.kt)("h4",{id:"returns-8"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"implementation-of-6"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#create"},"create")),(0,p.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L184"},"temp/engine_components/src/core/SimpleClipper/index.ts:184")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"createfromnormalandcoplanarpoint"},"createFromNormalAndCoplanarPoint"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"createFromNormalAndCoplanarPoint"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"normal"),", ",(0,p.kt)("inlineCode",{parentName:"p"},"point"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"T")),(0,p.kt)("p",null,"Creates a plane in a certain place and with a certain orientation,\nwithout the need of the mouse."),(0,p.kt)("h4",{id:"parameters-4"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"normal")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"Vector3")),(0,p.kt)("td",{parentName:"tr",align:"left"},"the orientation of the clipping plane.")),(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"point")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"Vector3")),(0,p.kt)("td",{parentName:"tr",align:"left"},"the position of the clipping plane.")))),(0,p.kt)("h4",{id:"returns-9"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"T")),(0,p.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L200"},"temp/engine_components/src/core/SimpleClipper/index.ts:200")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"delete"},"delete"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"delete"),"(",(0,p.kt)("inlineCode",{parentName:"p"},"plane?"),"): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#delete"},"Createable.delete")),(0,p.kt)("h4",{id:"parameters-5"},"Parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,p.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"plane?")),(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"T")),(0,p.kt)("td",{parentName:"tr",align:"left"},"the plane to delete. If undefined, the the first plane found under the cursor will be deleted.")))),(0,p.kt)("h4",{id:"returns-10"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"implementation-of-7"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#delete"},"delete")),(0,p.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L215"},"temp/engine_components/src/core/SimpleClipper/index.ts:215")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"deleteall"},"deleteAll"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"deleteAll"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("p",null,"Deletes all the existing clipping planes."),(0,p.kt)("h4",{id:"returns-11"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"void")),(0,p.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L227"},"temp/engine_components/src/core/SimpleClipper/index.ts:227")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"dispose"},"dispose"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,p.kt)("h4",{id:"returns-12"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,p.kt)("h4",{id:"implementation-of-8"},"Implementation of"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),".",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"dispose")),(0,p.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L163"},"temp/engine_components/src/core/SimpleClipper/index.ts:163")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"get"},"get"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"get"),"(): ",(0,p.kt)("inlineCode",{parentName:"p"},"T"),"[]"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,p.kt)("h4",{id:"returns-13"},"Returns"),(0,p.kt)("p",null,(0,p.kt)("inlineCode",{parentName:"p"},"T"),"[]"),(0,p.kt)("h4",{id:"overrides-2"},"Overrides"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,p.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/core/SimpleClipper/index.ts#L158"},"temp/engine_components/src/core/SimpleClipper/index.ts:158")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"hasui"},"hasUI"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"hasUI"),"(): this is UI"),(0,p.kt)("p",null,"Whether is component implements any kind of ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),"."),(0,p.kt)("h4",{id:"returns-14"},"Returns"),(0,p.kt)("p",null,"this is UI"),(0,p.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,p.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L62"},"temp/engine_components/src/base-types/component.ts:62")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isconfigurable"},"isConfigurable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isConfigurable"),"(): this is Configurable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable"},"Configurable"),"."),(0,p.kt)("h4",{id:"returns-15"},"Returns"),(0,p.kt)("p",null,"this is Configurable"),(0,p.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,p.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L57"},"temp/engine_components/src/base-types/component.ts:57")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isdisposeable"},"isDisposeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isDisposeable"),"(): this is Disposable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable"},"Disposable"),"."),(0,p.kt)("h4",{id:"returns-16"},"Returns"),(0,p.kt)("p",null,"this is Disposable"),(0,p.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,p.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L35"},"temp/engine_components/src/base-types/component.ts:35")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"ishideable"},"isHideable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isHideable"),"(): this is Hideable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),"."),(0,p.kt)("h4",{id:"returns-17"},"Returns"),(0,p.kt)("p",null,"this is Hideable"),(0,p.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,p.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L52"},"temp/engine_components/src/base-types/component.ts:52")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isresizeable"},"isResizeable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isResizeable"),"(): this is Resizeable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),"."),(0,p.kt)("h4",{id:"returns-18"},"Returns"),(0,p.kt)("p",null,"this is Resizeable"),(0,p.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,p.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L40"},"temp/engine_components/src/base-types/component.ts:40")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isupdateable"},"isUpdateable"),(0,p.kt)("p",null,"\u25b8 ",(0,p.kt)("strong",{parentName:"p"},"isUpdateable"),"(): this is Updateable"),(0,p.kt)("p",null,"Whether is component is ",(0,p.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),"."),(0,p.kt)("h4",{id:"returns-19"},"Returns"),(0,p.kt)("p",null,"this is Updateable"),(0,p.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,p.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,p.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/ThatOpen/engine_components/blob/31b6f97/src/base-types/component.ts#L45"},"temp/engine_components/src/base-types/component.ts:45")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/main.2ca30f89.js b/build/assets/js/main.2ca30f89.js new file mode 100644 index 00000000..0ba61aa8 --- /dev/null +++ b/build/assets/js/main.2ca30f89.js @@ -0,0 +1,2 @@ +/*! For license information please see main.2ca30f89.js.LICENSE.txt */ +(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[179],{723:(e,t,n)=>{"use strict";n.d(t,{Z:()=>f});var r=n(7294),a=n(7462),o=n(8356),i=n.n(o),l=n(6887);const s={"0123be5b":[function(){return n.e(7524).then(n.bind(n,3192))},"@site/docs/Tutorials/FragmentTree.mdx",3192],"0b4ea834":[function(){return n.e(3877).then(n.bind(n,2510))},"@site/docs/api/interfaces/openbim_components.Updateable.md",2510],"0e384e19":[function(){return n.e(9671).then(n.bind(n,9881))},"@site/docs/intro.md",9881],"10f5d381":[function(){return n.e(2981).then(n.bind(n,1746))},"@site/docs/api/interfaces/openbim_components.Createable.md",1746],"1202d222":[function(){return n.e(1461).then(n.bind(n,9545))},"@site/docs/api/classes/openbim_components.FragmentManager.md",9545],17896441:[function(){return Promise.all([n.e(532),n.e(7918)]).then(n.bind(n,907))},"@theme/DocItem",907],"18ed70ed":[function(){return n.e(5229).then(n.bind(n,9857))},"@site/docs/api/classes/openbim_components.SimplePlane.md",9857],"18f6f55e":[function(){return n.e(3116).then(n.bind(n,4631))},"@site/docs/api/classes/openbim_components.EdgesPlane.md",4631],"1be78505":[function(){return Promise.all([n.e(532),n.e(9514)]).then(n.bind(n,9963))},"@theme/DocPage",9963],"23f030fe":[function(){return n.e(1569).then(n.bind(n,8995))},"@site/docs/api/classes/openbim_components.ToolComponent.md",8995],"24ba3c39":[function(){return n.e(9922).then(n.bind(n,1797))},"@site/docs/Tutorials/FragmentPlans.mdx",1797],"25b18b72":[function(){return n.e(7150).then(n.bind(n,285))},"@site/docs/Tutorials/FragmentHighlighter.mdx",285],"2b6dbb63":[function(){return n.e(5361).then(n.bind(n,6625))},"@site/docs/Tutorials/LengthMeasurement.mdx",6625],"31eca0ce":[function(){return n.e(6827).then(n.bind(n,2647))},"@site/docs/Tutorials/FragmentIfcLoader.mdx",2647],"32cf703e":[function(){return n.e(3053).then(n.bind(n,7967))},"@site/docs/Tutorials/IfcPropertiesManager.mdx",7967],"3303a5a5":[function(){return n.e(6692).then(n.bind(n,1603))},"@site/docs/api/classes/openbim_components.SimpleRaycaster.md",1603],"338df764":[function(){return n.e(9111).then(n.bind(n,6492))},"@site/docs/Tutorials/ScreenCuller.mdx",6492],"34e61bbc":[function(){return n.e(6258).then(n.bind(n,3595))},"@site/docs/Tutorials/FragmentManager.mdx",3595],"399dfa47":[function(){return n.e(7260).then(n.bind(n,8185))},"@site/docs/Tutorials/FragmentExploder.mdx",8185],"3c3e2ba6":[function(){return n.e(273).then(n.bind(n,8168))},"@site/docs/Tutorials/MiniMap.mdx",8168],"4f2f3afd":[function(){return n.e(3554).then(n.bind(n,2689))},"@site/docs/api/interfaces/openbim_components.Disposable.md",2689],"5094df0e":[function(){return n.e(7621).then(n.bind(n,3263))},"@site/docs/components/tutorial-paths.md",3263],"51e85c26":[function(){return n.e(4345).then(n.bind(n,5563))},"@site/docs/api/classes/openbim_components.Components.md",5563],"5434cfcf":[function(){return n.e(527).then(n.bind(n,484))},"@site/docs/Tutorials/ToolsComponent.mdx",484],"55483fbd":[function(){return n.e(5241).then(n.bind(n,2502))},"@site/docs/api/classes/openbim_components.Simple2DScene.md",2502],"567fda46":[function(){return n.e(347).then(n.bind(n,3091))},"@site/docs/Tutorials/UIManager.mdx",3091],59791038:[function(){return n.e(2218).then(n.bind(n,6658))},"@site/docs/api/classes/openbim_components.CloudStorage.md",6658],"5c34dd2a":[function(){return n.e(5531).then(n.bind(n,6744))},"@site/docs/api/classes/openbim_components.PostproductionRenderer.md",6744],"5e8c322a":[function(){return n.e(7597).then(n.bind(n,7926))},"@site/docs/api/index.md",7926],"5e9f5e1a":[function(){return Promise.resolve().then(n.bind(n,6809))},"@generated/docusaurus.config",6809],"5f173d68":[function(){return n.e(8440).then(n.bind(n,6580))},"@site/docs/api/classes/openbim_components.SimpleScene.md",6580],"63603fbd":[function(){return n.e(9763).then(n.bind(n,9257))},"@site/docs/components/contributing.md",9257],"6488a50e":[function(){return n.e(3355).then(n.bind(n,9815))},"@site/docs/Tutorials/AngleMeasurement.mdx",9815],"6713fb58":[function(){return n.e(9280).then(n.bind(n,4317))},"@site/docs/api/interfaces/openbim_components.NavigationMode.md",4317],"746f2b6a":[function(){return n.e(884).then(n.bind(n,1376))},"@site/docs/api/classes/openbim_components.SimpleRenderer.md",1376],"7cf9e350":[function(){return n.e(1510).then(n.bind(n,6321))},"@site/docs/api/classes/openbim_components.OrthoPerspectiveCamera.md",6321],"8004d10c":[function(){return n.e(8892).then(n.t.bind(n,3769,19))},"C:\\Users\\anton\\Desktop\\code\\engine_docs\\.docusaurus\\docusaurus-plugin-content-docs\\default\\plugin-route-context-module-100.json",3769],"82c425bb":[function(){return n.e(8604).then(n.bind(n,3106))},"@site/docs/components/getting-started.md",3106],"83488e61":[function(){return n.e(6420).then(n.bind(n,6789))},"@site/docs/Tutorials/SimpleClipper.mdx",6789],"84d6d046":[function(){return n.e(7735).then(n.bind(n,2388))},"@site/docs/Tutorials/SimpleRaycaster.mdx",2388],"8d23124b":[function(){return n.e(5742).then(n.bind(n,9773))},"@site/docs/api/classes/openbim_components.ScreenCuller.md",9773],"9049477b":[function(){return n.e(8449).then(n.bind(n,7745))},"@site/docs/Tutorials/IfcPropertiesFinder.mdx",7745],"92d7e00e":[function(){return n.e(1835).then(n.bind(n,362))},"@site/docs/Tutorials/FragmentClipStyler.mdx",362],"935f2afb":[function(){return n.e(53).then(n.t.bind(n,1109,19))},"~docs/default/version-current-metadata-prop-751.json",1109],"963ae1bc":[function(){return n.e(5470).then(n.bind(n,381))},"@site/docs/api/classes/openbim_components.Component.md",381],"969ec0f0":[function(){return n.e(8044).then(n.bind(n,1052))},"@site/docs/api/classes/openbim_components.Event.md",1052],"9a5f9594":[function(){return n.e(1361).then(n.bind(n,3652))},"@site/docs/Tutorials/IfcPropertiesProcessor.mdx",3652],"9ba2e06a":[function(){return n.e(4073).then(n.bind(n,7736))},"@site/docs/api/classes/openbim_components.FragmentPlans.md",7736],"9d7eea47":[function(){return n.e(3941).then(n.bind(n,1344))},"@site/docs/components/creating-components.md",1344],"9dd8a0d2":[function(){return n.e(7054).then(n.bind(n,7275))},"@site/src/pages/index.jsx",7275],"9edcb13d":[function(){return n.e(6599).then(n.bind(n,3867))},"@site/docs/api/classes/openbim_components.CubeMap.md",3867],a04d5955:[function(){return n.e(1441).then(n.bind(n,3277))},"@site/docs/Tutorials/OrthoPerspectiveCamera.mdx",3277],a62869d9:[function(){return n.e(3492).then(n.bind(n,806))},"@site/docs/Tutorials/ShadowDropper.mdx",806],a94c8b81:[function(){return n.e(3010).then(n.bind(n,931))},"@site/docs/api/classes/openbim_components.IfcJsonExporter.md",931],aad57e98:[function(){return n.e(7944).then(n.bind(n,9673))},"@site/docs/api/modules/bim_fragment.md",9673],ab682f67:[function(){return n.e(1349).then(n.bind(n,6240))},"@site/docs/api/classes/openbim_components.Mouse.md",6240],addcbcd0:[function(){return n.e(6934).then(n.bind(n,9804))},"@site/docs/api/classes/openbim_components.BaseRenderer.md",9804],afcc017a:[function(){return n.e(5825).then(n.bind(n,5430))},"@site/docs/api/interfaces/openbim_components.Progress.md",5430],b67f8c3e:[function(){return n.e(1613).then(n.bind(n,5210))},"@site/docs/Tutorials/SimpleScene.mdx",5210],b82b585f:[function(){return n.e(215).then(n.bind(n,9273))},"@site/docs/api/classes/openbim_components.SimpleCamera.md",9273],b82c8867:[function(){return n.e(5972).then(n.bind(n,5164))},"@site/docs/api/classes/openbim_components.LengthMeasurement.md",5164],ba12a54e:[function(){return n.e(4175).then(n.bind(n,9469))},"@site/docs/api/interfaces/openbim_components.Resizeable.md",9469],bc6e2bb0:[function(){return n.e(9799).then(n.bind(n,9308))},"@site/docs/api/classes/openbim_components.SimpleGrid.md",9308],beba2f4c:[function(){return n.e(3372).then(n.bind(n,6082))},"@site/docs/Tutorials/EdgesClipper.mdx",6082],bfa94da9:[function(){return n.e(5261).then(n.bind(n,2889))},"@site/docs/api/classes/openbim_components.MaterialManager.md",2889],c45a2468:[function(){return n.e(930).then(n.bind(n,5666))},"@site/docs/api/modules/openbim_components.md",5666],c542e6fd:[function(){return n.e(8566).then(n.bind(n,7774))},"@site/docs/Tutorials/FragmentBoundingBox.mdx",7774],c5b82270:[function(){return n.e(2121).then(n.bind(n,3401))},"@site/docs/api/classes/openbim_components.Disposer.md",3401],c8ce6040:[function(){return n.e(8182).then(n.bind(n,642))},"@site/docs/api/interfaces/openbim_components.UI.md",642],ca8c1512:[function(){return n.e(7458).then(n.bind(n,2706))},"@site/docs/Tutorials/AreaMeasurement.mdx",2706],cce8cd0d:[function(){return n.e(984).then(n.bind(n,1175))},"@site/docs/api/interfaces/openbim_components.Configurable.md",1175],cd51b51b:[function(){return n.e(6993).then(n.bind(n,9808))},"@site/docs/api/interfaces/openbim_components.Hideable.md",9808],cf0958e4:[function(){return n.e(6630).then(n.bind(n,2069))},"@site/docs/api/classes/openbim_components.FragmentBoundingBox.md",2069],d05ab5b9:[function(){return n.e(4646).then(n.t.bind(n,5745,19))},"C:\\Users\\anton\\Desktop\\code\\engine_docs\\.docusaurus\\docusaurus-plugin-content-pages\\default\\plugin-route-context-module-100.json",5745],d2ce3c47:[function(){return n.e(4961).then(n.bind(n,5295))},"@site/docs/Tutorials/FragmentIfcStreamer.mdx",5295],d785d616:[function(){return n.e(9211).then(n.bind(n,1432))},"@site/docs/api/classes/openbim_components.IfcStreamingSettings.md",1432],da20bba5:[function(){return n.e(3118).then(n.bind(n,4358))},"@site/docs/api/classes/openbim_components.PropertiesStreamingSettings.md",4358],dae2beb5:[function(){return n.e(2021).then(n.bind(n,4818))},"@site/docs/Tutorials/MaterialManager.mdx",4818],dccbb392:[function(){return n.e(617).then(n.bind(n,8004))},"@site/docs/Tutorials/PostproductionRenderer.mdx",8004],e0514c78:[function(){return n.e(2388).then(n.bind(n,5060))},"@site/docs/api/classes/openbim_components.UIManager.md",5060],e33e0127:[function(){return n.e(5018).then(n.bind(n,5907))},"@site/docs/Tutorials/Simple2DScene.mdx",5907],e3702cd4:[function(){return n.e(2232).then(n.bind(n,186))},"@site/docs/components/clean-components-guide.md",186],e62aa4fb:[function(){return n.e(2463).then(n.bind(n,5415))},"@site/docs/api/interfaces/openbim_components.FragmentIdMap.md",5415],ece573d0:[function(){return n.e(9881).then(n.bind(n,2243))},"@site/docs/api/classes/openbim_components.UIElement.md",2243],f6aebfbf:[function(){return n.e(7306).then(n.bind(n,4440))},"@site/docs/api/modules.md",4440],f73cc3ee:[function(){return n.e(7115).then(n.bind(n,6943))},"@site/docs/Tutorials/FragmentHider.mdx",6943],f7fb8d22:[function(){return n.e(6632).then(n.bind(n,1142))},"@site/docs/api/classes/openbim_components.EdgesClipper.md",1142],fa613aa0:[function(){return n.e(3060).then(n.bind(n,6450))},"@site/docs/api/classes/openbim_components.SimpleClipper.md",6450],fe22553b:[function(){return n.e(7553).then(n.bind(n,7872))},"@site/docs/that-open-platform/getting-started.mdx",7872]};function u(e){var t=e.error,n=e.retry,a=e.pastDelay;return t?r.createElement("div",{style:{textAlign:"center",color:"#fff",backgroundColor:"#fa383e",borderColor:"#fa383e",borderStyle:"solid",borderRadius:"0.25rem",borderWidth:"1px",boxSizing:"border-box",display:"block",padding:"1rem",flex:"0 0 50%",marginLeft:"25%",marginRight:"25%",marginTop:"5rem",maxWidth:"50%",width:"100%"}},r.createElement("p",null,String(t)),r.createElement("div",null,r.createElement("button",{type:"button",onClick:n},"Retry"))):a?r.createElement("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"100vh"}},r.createElement("svg",{id:"loader",style:{width:128,height:110,position:"absolute",top:"calc(100vh - 64%)"},viewBox:"0 0 45 45",xmlns:"http://www.w3.org/2000/svg",stroke:"#61dafb"},r.createElement("g",{fill:"none",fillRule:"evenodd",transform:"translate(1 1)",strokeWidth:"2"},r.createElement("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0"},r.createElement("animate",{attributeName:"r",begin:"1.5s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-opacity",begin:"1.5s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-width",begin:"1.5s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})),r.createElement("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0"},r.createElement("animate",{attributeName:"r",begin:"3s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-opacity",begin:"3s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-width",begin:"3s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})),r.createElement("circle",{cx:"22",cy:"22",r:"8"},r.createElement("animate",{attributeName:"r",begin:"0s",dur:"1.5s",values:"6;1;2;3;4;5;6",calcMode:"linear",repeatCount:"indefinite"}))))):null}var c=n(9670),d=n(226);function p(e,t){if("*"===e)return i()({loading:u,loader:function(){return n.e(4972).then(n.bind(n,4972))},modules:["@theme/NotFound"],webpack:function(){return[4972]},render:function(e,t){var n=e.default;return r.createElement(d.z,{value:{plugin:{name:"native",id:"default"}}},r.createElement(n,t))}});var o=l[e+"-"+t],p={},f=[],m=[],h=(0,c.Z)(o);return Object.entries(h).forEach((function(e){var t=e[0],n=e[1],r=s[n];r&&(p[t]=r[0],f.push(r[1]),m.push(r[2]))})),i().Map({loading:u,loader:p,modules:f,webpack:function(){return m},render:function(t,n){var i=JSON.parse(JSON.stringify(o));Object.entries(t).forEach((function(t){var n=t[0],r=t[1],a=r.default;if(!a)throw new Error("The page component at "+e+" doesn't have a default export. This makes it impossible to render anything. Consider default-exporting a React component.");"object"!=typeof a&&"function"!=typeof a||Object.keys(r).filter((function(e){return"default"!==e})).forEach((function(e){a[e]=r[e]}));var o=i,l=n.split(".");l.slice(0,-1).forEach((function(e){o=o[e]})),o[l[l.length-1]]=a}));var l=i.__comp;delete i.__comp;var s=i.__context;return delete i.__context,r.createElement(d.z,{value:s},r.createElement(l,(0,a.Z)({},i,n)))}})}const f=[{path:"/",component:p("/","cfc"),exact:!0},{path:"/",component:p("/","536"),routes:[{path:"/api/",component:p("/api/","093"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.BaseRenderer",component:p("/api/classes/openbim_components.BaseRenderer","041"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.CloudStorage",component:p("/api/classes/openbim_components.CloudStorage","f26"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.Component",component:p("/api/classes/openbim_components.Component","35c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.Components",component:p("/api/classes/openbim_components.Components","23b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.CubeMap",component:p("/api/classes/openbim_components.CubeMap","383"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.Disposer",component:p("/api/classes/openbim_components.Disposer","aa5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.EdgesClipper",component:p("/api/classes/openbim_components.EdgesClipper","b9e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.EdgesPlane",component:p("/api/classes/openbim_components.EdgesPlane","41d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.Event",component:p("/api/classes/openbim_components.Event","ace"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.FragmentBoundingBox",component:p("/api/classes/openbim_components.FragmentBoundingBox","64d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.FragmentManager",component:p("/api/classes/openbim_components.FragmentManager","bc3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.FragmentPlans",component:p("/api/classes/openbim_components.FragmentPlans","4fa"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.IfcJsonExporter",component:p("/api/classes/openbim_components.IfcJsonExporter","e09"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.IfcStreamingSettings",component:p("/api/classes/openbim_components.IfcStreamingSettings","19e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.LengthMeasurement",component:p("/api/classes/openbim_components.LengthMeasurement","d9c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.MaterialManager",component:p("/api/classes/openbim_components.MaterialManager","26e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.Mouse",component:p("/api/classes/openbim_components.Mouse","98b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.OrthoPerspectiveCamera",component:p("/api/classes/openbim_components.OrthoPerspectiveCamera","1b7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.PostproductionRenderer",component:p("/api/classes/openbim_components.PostproductionRenderer","6f6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.PropertiesStreamingSettings",component:p("/api/classes/openbim_components.PropertiesStreamingSettings","f13"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.ScreenCuller",component:p("/api/classes/openbim_components.ScreenCuller","863"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.Simple2DScene",component:p("/api/classes/openbim_components.Simple2DScene","95e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.SimpleCamera",component:p("/api/classes/openbim_components.SimpleCamera","830"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.SimpleClipper",component:p("/api/classes/openbim_components.SimpleClipper","f56"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.SimpleGrid",component:p("/api/classes/openbim_components.SimpleGrid","9ea"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.SimplePlane",component:p("/api/classes/openbim_components.SimplePlane","156"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.SimpleRaycaster",component:p("/api/classes/openbim_components.SimpleRaycaster","c87"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.SimpleRenderer",component:p("/api/classes/openbim_components.SimpleRenderer","829"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.SimpleScene",component:p("/api/classes/openbim_components.SimpleScene","915"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.ToolComponent",component:p("/api/classes/openbim_components.ToolComponent","b02"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.UIElement",component:p("/api/classes/openbim_components.UIElement","755"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.UIManager",component:p("/api/classes/openbim_components.UIManager","f5d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/interfaces/openbim_components.Configurable",component:p("/api/interfaces/openbim_components.Configurable","f64"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/interfaces/openbim_components.Createable",component:p("/api/interfaces/openbim_components.Createable","17a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/interfaces/openbim_components.Disposable",component:p("/api/interfaces/openbim_components.Disposable","761"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/interfaces/openbim_components.FragmentIdMap",component:p("/api/interfaces/openbim_components.FragmentIdMap","515"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/interfaces/openbim_components.Hideable",component:p("/api/interfaces/openbim_components.Hideable","014"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/interfaces/openbim_components.NavigationMode",component:p("/api/interfaces/openbim_components.NavigationMode","b2c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/interfaces/openbim_components.Progress",component:p("/api/interfaces/openbim_components.Progress","1e9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/interfaces/openbim_components.Resizeable",component:p("/api/interfaces/openbim_components.Resizeable","744"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/interfaces/openbim_components.UI",component:p("/api/interfaces/openbim_components.UI","a2b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/interfaces/openbim_components.Updateable",component:p("/api/interfaces/openbim_components.Updateable","baa"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/modules",component:p("/api/modules","49b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/modules/bim_fragment",component:p("/api/modules/bim_fragment","2de"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/modules/openbim_components",component:p("/api/modules/openbim_components","406"),exact:!0,sidebar:"tutorialSidebar"},{path:"/components/clean-components-guide",component:p("/components/clean-components-guide","181"),exact:!0,sidebar:"tutorialSidebar"},{path:"/components/contributing",component:p("/components/contributing","6a1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/components/creating-components",component:p("/components/creating-components","bc7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/components/getting-started",component:p("/components/getting-started","8e9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/components/tutorial-paths",component:p("/components/tutorial-paths","97b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/intro",component:p("/intro","283"),exact:!0,sidebar:"tutorialSidebar"},{path:"/that-open-platform/getting-started",component:p("/that-open-platform/getting-started","80c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/AngleMeasurement",component:p("/Tutorials/AngleMeasurement","398"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/AreaMeasurement",component:p("/Tutorials/AreaMeasurement","675"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/EdgesClipper",component:p("/Tutorials/EdgesClipper","d9f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/FragmentBoundingBox",component:p("/Tutorials/FragmentBoundingBox","8e1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/FragmentClipStyler",component:p("/Tutorials/FragmentClipStyler","09d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/FragmentExploder",component:p("/Tutorials/FragmentExploder","689"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/FragmentHider",component:p("/Tutorials/FragmentHider","bfc"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/FragmentHighlighter",component:p("/Tutorials/FragmentHighlighter","646"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/FragmentIfcLoader",component:p("/Tutorials/FragmentIfcLoader","ba0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/FragmentIfcStreamer",component:p("/Tutorials/FragmentIfcStreamer","c11"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/FragmentManager",component:p("/Tutorials/FragmentManager","990"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/FragmentPlans",component:p("/Tutorials/FragmentPlans","045"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/FragmentTree",component:p("/Tutorials/FragmentTree","7b1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/IfcPropertiesFinder",component:p("/Tutorials/IfcPropertiesFinder","ae7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/IfcPropertiesManager",component:p("/Tutorials/IfcPropertiesManager","f1d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/IfcPropertiesProcessor",component:p("/Tutorials/IfcPropertiesProcessor","e5e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/LengthMeasurement",component:p("/Tutorials/LengthMeasurement","8eb"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/MaterialManager",component:p("/Tutorials/MaterialManager","29d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/MiniMap",component:p("/Tutorials/MiniMap","2ee"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/OrthoPerspectiveCamera",component:p("/Tutorials/OrthoPerspectiveCamera","91c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/PostproductionRenderer",component:p("/Tutorials/PostproductionRenderer","fb2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/ScreenCuller",component:p("/Tutorials/ScreenCuller","924"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/ShadowDropper",component:p("/Tutorials/ShadowDropper","413"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/Simple2DScene",component:p("/Tutorials/Simple2DScene","2d5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/SimpleClipper",component:p("/Tutorials/SimpleClipper","3ac"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/SimpleRaycaster",component:p("/Tutorials/SimpleRaycaster","58b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/SimpleScene",component:p("/Tutorials/SimpleScene","11e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/ToolsComponent",component:p("/Tutorials/ToolsComponent","f63"),exact:!0,sidebar:"tutorialSidebar"},{path:"/Tutorials/UIManager",component:p("/Tutorials/UIManager","cb6"),exact:!0,sidebar:"tutorialSidebar"}]},{path:"*",component:p("*")}]},8934:(e,t,n)=>{"use strict";n.d(t,{_:()=>a,t:()=>o});var r=n(7294),a=r.createContext(!1);function o(e){var t=e.children,n=(0,r.useState)(!1),o=n[0],i=n[1];return(0,r.useEffect)((function(){i(!0)}),[]),r.createElement(a.Provider,{value:o},t)}},6562:(e,t,n)=>{"use strict";var r=n(7294),a=n(3935),o=n(3727),i=n(405),l=n(412);const s=[n(2497),n(3310),n(8320),n(2295)];var u=n(723),c=n(6550),d=n(8790);const p={gradientBackground:"gradientBackground_W6vG",accentGradient:"accentGradient_xnKm","accent-movement":"accent-movement_uLvs",mainGradient:"mainGradient_BHIB","main-movement":"main-movement_tjJ8"};function f(e){var t=e.children;return r.createElement(r.Fragment,null,r.createElement(m,null),t)}function m(){return r.createElement("div",{className:p.gradientBackground},r.createElement(h,null),r.createElement(g,null))}function h(){return r.createElement("div",{className:p.accentGradient})}function g(){return r.createElement("div",{className:p.mainGradient})}function b(e){var t=e.children;return r.createElement(f,null,t)}var v=n(7462),y=n(5742),w=n(2263),S=n(4996),k=n(6668),E=n(1944),_=n(4711),x=n(9727),T=n(3320),C=n(8780),P=n(197);function A(){var e=(0,w.Z)().i18n,t=e.defaultLocale,n=e.localeConfigs,a=(0,_.l)();return r.createElement(y.Z,null,Object.entries(n).map((function(e){var t=e[0],n=e[1].htmlLang;return r.createElement("link",{key:t,rel:"alternate",href:a.createUrl({locale:t,fullyQualified:!0}),hrefLang:n})})),r.createElement("link",{rel:"alternate",href:a.createUrl({locale:t,fullyQualified:!0}),hrefLang:"x-default"}))}function L(e){var t=e.permalink,n=(0,w.Z)().siteConfig.url,a=function(){var e=(0,w.Z)().siteConfig,t=e.url,n=e.baseUrl,r=e.trailingSlash,a=(0,c.TH)().pathname;return t+(0,C.applyTrailingSlash)((0,S.Z)(a),{trailingSlash:r,baseUrl:n})}(),o=t?""+n+t:a;return r.createElement(y.Z,null,r.createElement("meta",{property:"og:url",content:o}),r.createElement("link",{rel:"canonical",href:o}))}function R(){var e=(0,w.Z)().i18n.currentLocale,t=(0,k.L)(),n=t.metadata,a=t.image;return r.createElement(r.Fragment,null,r.createElement(y.Z,null,r.createElement("meta",{name:"twitter:card",content:"summary_large_image"}),r.createElement("body",{className:x.h})),a&&r.createElement(E.d,{image:a}),r.createElement(L,null),r.createElement(A,null),r.createElement(P.Z,{tag:T.HX,locale:e}),r.createElement(y.Z,null,n.map((function(e,t){return r.createElement("meta",(0,v.Z)({key:t},e))}))))}var O=new Map;function N(e){if(O.has(e.pathname))return Object.assign({},e,{pathname:O.get(e.pathname)});if((0,d.f)(u.Z,e.pathname).some((function(e){return!0===e.route.exact})))return O.set(e.pathname,e.pathname),e;var t=e.pathname.trim().replace(/(?:\/index)?\.html$/,"")||"/";return O.set(e.pathname,t),Object.assign({},e,{pathname:t})}var I=n(8934),M=n(8940),D=n(4578);function F(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),r=1;r\n

    Your Docusaurus site did not load properly.

    \n

    A very common reason is a wrong site baseUrl configuration.

    \n

    Current configured baseUrl = '+e+" "+("/"===e?" (default value)":"")+'

    \n

    We suggest trying baseUrl =

    \n\n'}(e)).replace(/{"use strict";n.d(t,{_:()=>c,M:()=>d});var r=n(7294),a=n(6809);const o=JSON.parse('{"docusaurus-plugin-content-docs":{"default":{"path":"/","versions":[{"name":"current","label":"Next","isLast":true,"path":"/","mainDocId":"intro","docs":[{"id":"api/classes/openbim_components.BaseRenderer","path":"/api/classes/openbim_components.BaseRenderer","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.CloudStorage","path":"/api/classes/openbim_components.CloudStorage","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.Component","path":"/api/classes/openbim_components.Component","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.Components","path":"/api/classes/openbim_components.Components","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.CubeMap","path":"/api/classes/openbim_components.CubeMap","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.Disposer","path":"/api/classes/openbim_components.Disposer","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.EdgesClipper","path":"/api/classes/openbim_components.EdgesClipper","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.EdgesPlane","path":"/api/classes/openbim_components.EdgesPlane","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.Event","path":"/api/classes/openbim_components.Event","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.FragmentBoundingBox","path":"/api/classes/openbim_components.FragmentBoundingBox","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.FragmentManager","path":"/api/classes/openbim_components.FragmentManager","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.FragmentPlans","path":"/api/classes/openbim_components.FragmentPlans","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.IfcJsonExporter","path":"/api/classes/openbim_components.IfcJsonExporter","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.IfcStreamingSettings","path":"/api/classes/openbim_components.IfcStreamingSettings","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.LengthMeasurement","path":"/api/classes/openbim_components.LengthMeasurement","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.MaterialManager","path":"/api/classes/openbim_components.MaterialManager","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.Mouse","path":"/api/classes/openbim_components.Mouse","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.OrthoPerspectiveCamera","path":"/api/classes/openbim_components.OrthoPerspectiveCamera","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.PostproductionRenderer","path":"/api/classes/openbim_components.PostproductionRenderer","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.PropertiesStreamingSettings","path":"/api/classes/openbim_components.PropertiesStreamingSettings","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.ScreenCuller","path":"/api/classes/openbim_components.ScreenCuller","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.Simple2DScene","path":"/api/classes/openbim_components.Simple2DScene","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.SimpleCamera","path":"/api/classes/openbim_components.SimpleCamera","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.SimpleClipper","path":"/api/classes/openbim_components.SimpleClipper","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.SimpleGrid","path":"/api/classes/openbim_components.SimpleGrid","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.SimplePlane","path":"/api/classes/openbim_components.SimplePlane","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.SimpleRaycaster","path":"/api/classes/openbim_components.SimpleRaycaster","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.SimpleRenderer","path":"/api/classes/openbim_components.SimpleRenderer","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.SimpleScene","path":"/api/classes/openbim_components.SimpleScene","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.ToolComponent","path":"/api/classes/openbim_components.ToolComponent","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.UIElement","path":"/api/classes/openbim_components.UIElement","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.UIManager","path":"/api/classes/openbim_components.UIManager","sidebar":"tutorialSidebar"},{"id":"api/index","path":"/api/","sidebar":"tutorialSidebar"},{"id":"api/interfaces/openbim_components.Configurable","path":"/api/interfaces/openbim_components.Configurable","sidebar":"tutorialSidebar"},{"id":"api/interfaces/openbim_components.Createable","path":"/api/interfaces/openbim_components.Createable","sidebar":"tutorialSidebar"},{"id":"api/interfaces/openbim_components.Disposable","path":"/api/interfaces/openbim_components.Disposable","sidebar":"tutorialSidebar"},{"id":"api/interfaces/openbim_components.FragmentIdMap","path":"/api/interfaces/openbim_components.FragmentIdMap","sidebar":"tutorialSidebar"},{"id":"api/interfaces/openbim_components.Hideable","path":"/api/interfaces/openbim_components.Hideable","sidebar":"tutorialSidebar"},{"id":"api/interfaces/openbim_components.NavigationMode","path":"/api/interfaces/openbim_components.NavigationMode","sidebar":"tutorialSidebar"},{"id":"api/interfaces/openbim_components.Progress","path":"/api/interfaces/openbim_components.Progress","sidebar":"tutorialSidebar"},{"id":"api/interfaces/openbim_components.Resizeable","path":"/api/interfaces/openbim_components.Resizeable","sidebar":"tutorialSidebar"},{"id":"api/interfaces/openbim_components.UI","path":"/api/interfaces/openbim_components.UI","sidebar":"tutorialSidebar"},{"id":"api/interfaces/openbim_components.Updateable","path":"/api/interfaces/openbim_components.Updateable","sidebar":"tutorialSidebar"},{"id":"api/modules","path":"/api/modules","sidebar":"tutorialSidebar"},{"id":"api/modules/bim_fragment","path":"/api/modules/bim_fragment","sidebar":"tutorialSidebar"},{"id":"api/modules/openbim_components","path":"/api/modules/openbim_components","sidebar":"tutorialSidebar"},{"id":"components/clean-components-guide","path":"/components/clean-components-guide","sidebar":"tutorialSidebar"},{"id":"components/contributing","path":"/components/contributing","sidebar":"tutorialSidebar"},{"id":"components/creating-components","path":"/components/creating-components","sidebar":"tutorialSidebar"},{"id":"components/getting-started","path":"/components/getting-started","sidebar":"tutorialSidebar"},{"id":"components/tutorial-paths","path":"/components/tutorial-paths","sidebar":"tutorialSidebar"},{"id":"intro","path":"/intro","sidebar":"tutorialSidebar"},{"id":"that-open-platform/getting-started","path":"/that-open-platform/getting-started","sidebar":"tutorialSidebar"},{"id":"Tutorials/AngleMeasurement","path":"/Tutorials/AngleMeasurement","sidebar":"tutorialSidebar"},{"id":"Tutorials/AreaMeasurement","path":"/Tutorials/AreaMeasurement","sidebar":"tutorialSidebar"},{"id":"Tutorials/EdgesClipper","path":"/Tutorials/EdgesClipper","sidebar":"tutorialSidebar"},{"id":"Tutorials/FragmentBoundingBox","path":"/Tutorials/FragmentBoundingBox","sidebar":"tutorialSidebar"},{"id":"Tutorials/FragmentClipStyler","path":"/Tutorials/FragmentClipStyler","sidebar":"tutorialSidebar"},{"id":"Tutorials/FragmentExploder","path":"/Tutorials/FragmentExploder","sidebar":"tutorialSidebar"},{"id":"Tutorials/FragmentHider","path":"/Tutorials/FragmentHider","sidebar":"tutorialSidebar"},{"id":"Tutorials/FragmentHighlighter","path":"/Tutorials/FragmentHighlighter","sidebar":"tutorialSidebar"},{"id":"Tutorials/FragmentIfcLoader","path":"/Tutorials/FragmentIfcLoader","sidebar":"tutorialSidebar"},{"id":"Tutorials/FragmentIfcStreamer","path":"/Tutorials/FragmentIfcStreamer","sidebar":"tutorialSidebar"},{"id":"Tutorials/FragmentManager","path":"/Tutorials/FragmentManager","sidebar":"tutorialSidebar"},{"id":"Tutorials/FragmentPlans","path":"/Tutorials/FragmentPlans","sidebar":"tutorialSidebar"},{"id":"Tutorials/FragmentTree","path":"/Tutorials/FragmentTree","sidebar":"tutorialSidebar"},{"id":"Tutorials/IfcPropertiesFinder","path":"/Tutorials/IfcPropertiesFinder","sidebar":"tutorialSidebar"},{"id":"Tutorials/IfcPropertiesManager","path":"/Tutorials/IfcPropertiesManager","sidebar":"tutorialSidebar"},{"id":"Tutorials/IfcPropertiesProcessor","path":"/Tutorials/IfcPropertiesProcessor","sidebar":"tutorialSidebar"},{"id":"Tutorials/LengthMeasurement","path":"/Tutorials/LengthMeasurement","sidebar":"tutorialSidebar"},{"id":"Tutorials/MaterialManager","path":"/Tutorials/MaterialManager","sidebar":"tutorialSidebar"},{"id":"Tutorials/MiniMap","path":"/Tutorials/MiniMap","sidebar":"tutorialSidebar"},{"id":"Tutorials/OrthoPerspectiveCamera","path":"/Tutorials/OrthoPerspectiveCamera","sidebar":"tutorialSidebar"},{"id":"Tutorials/PostproductionRenderer","path":"/Tutorials/PostproductionRenderer","sidebar":"tutorialSidebar"},{"id":"Tutorials/ScreenCuller","path":"/Tutorials/ScreenCuller","sidebar":"tutorialSidebar"},{"id":"Tutorials/ShadowDropper","path":"/Tutorials/ShadowDropper","sidebar":"tutorialSidebar"},{"id":"Tutorials/Simple2DScene","path":"/Tutorials/Simple2DScene","sidebar":"tutorialSidebar"},{"id":"Tutorials/SimpleClipper","path":"/Tutorials/SimpleClipper","sidebar":"tutorialSidebar"},{"id":"Tutorials/SimpleRaycaster","path":"/Tutorials/SimpleRaycaster","sidebar":"tutorialSidebar"},{"id":"Tutorials/SimpleScene","path":"/Tutorials/SimpleScene","sidebar":"tutorialSidebar"},{"id":"Tutorials/ToolsComponent","path":"/Tutorials/ToolsComponent","sidebar":"tutorialSidebar"},{"id":"Tutorials/UIManager","path":"/Tutorials/UIManager","sidebar":"tutorialSidebar"}],"draftIds":[],"sidebars":{"tutorialSidebar":{"link":{"path":"/intro","label":"intro"}}}}],"breadcrumbs":true}}}'),i=JSON.parse('{"defaultLocale":"en","locales":["en"],"path":"i18n","currentLocale":"en","localeConfigs":{"en":{"label":"English","direction":"ltr","htmlLang":"en","calendar":"gregory","path":"en"}}}');var l=n(7529);const s=JSON.parse('{"docusaurusVersion":"2.4.3","siteVersion":"0.0.0","pluginVersions":{"docusaurus-plugin-content-docs":{"type":"package","name":"@docusaurus/plugin-content-docs","version":"2.4.3"},"docusaurus-plugin-content-pages":{"type":"package","name":"@docusaurus/plugin-content-pages","version":"2.4.3"},"docusaurus-plugin-sitemap":{"type":"package","name":"@docusaurus/plugin-sitemap","version":"2.4.3"},"docusaurus-theme-classic":{"type":"package","name":"@docusaurus/theme-classic","version":"2.4.3"},"docusaurus-plugin-typedoc":{"type":"package","name":"docusaurus-plugin-typedoc","version":"0.20.2"}}}');var u={siteConfig:a.default,siteMetadata:s,globalData:o,i18n:i,codeTranslations:l},c=r.createContext(u);function d(e){var t=e.children;return r.createElement(c.Provider,{value:u},t)}},4763:(e,t,n)=>{"use strict";n.d(t,{Z:()=>f});var r=n(4578),a=n(7294),o=n(412),i=n(5742),l=n(8780),s=n(7961);function u(e){var t=e.error,n=e.tryAgain;return a.createElement("div",{style:{display:"flex",flexDirection:"column",justifyContent:"center",alignItems:"flex-start",minHeight:"100vh",width:"100%",maxWidth:"80ch",fontSize:"20px",margin:"0 auto",padding:"1rem"}},a.createElement("h1",{style:{fontSize:"3rem"}},"This page crashed"),a.createElement("button",{type:"button",onClick:n,style:{margin:"1rem 0",fontSize:"2rem",cursor:"pointer",borderRadius:20,padding:"1rem"}},"Try again"),a.createElement(c,{error:t}))}function c(e){var t=e.error,n=(0,l.getErrorCausalChain)(t).map((function(e){return e.message})).join("\n\nCause:\n");return a.createElement("p",{style:{whiteSpace:"pre-wrap"}},n)}function d(e){var t=e.error,n=e.tryAgain;return a.createElement(f,{fallback:function(){return a.createElement(u,{error:t,tryAgain:n})}},a.createElement(i.Z,null,a.createElement("title",null,"Page Error")),a.createElement(s.Z,null,a.createElement(u,{error:t,tryAgain:n})))}var p=function(e){return a.createElement(d,e)},f=function(e){function t(t){var n;return(n=e.call(this,t)||this).state={error:null},n}(0,r.Z)(t,e);var n=t.prototype;return n.componentDidCatch=function(e){o.Z.canUseDOM&&this.setState({error:e})},n.render=function(){var e=this,t=this.props.children,n=this.state.error;if(n){var r,a={error:n,tryAgain:function(){return e.setState({error:null})}};return(null!=(r=this.props.fallback)?r:p)(a)}return null!=t?t:null},t}(a.Component)},412:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});var r="undefined"!=typeof window&&"document"in window&&"createElement"in window.document;const a={canUseDOM:r,canUseEventListeners:r&&("addEventListener"in window||"attachEvent"in window),canUseIntersectionObserver:r&&"IntersectionObserver"in window,canUseViewport:r&&"screen"in window}},5742:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294),a=n(405);function o(e){return r.createElement(a.ql,e)}},9960:(e,t,n)=>{"use strict";n.d(t,{Z:()=>h});var r=n(7462),a=n(3366),o=n(7294),i=n(3727),l=n(8780),s=n(2263),u=n(3919),c=n(412),d=o.createContext({collectLink:function(){}});var p=n(4996),f=["isNavLink","to","href","activeClassName","isActive","data-noBrokenLinkCheck","autoAddBaseUrl"];function m(e,t){var n,m,h=e.isNavLink,g=e.to,b=e.href,v=e.activeClassName,y=e.isActive,w=e["data-noBrokenLinkCheck"],S=e.autoAddBaseUrl,k=void 0===S||S,E=(0,a.Z)(e,f),_=(0,s.Z)().siteConfig,x=_.trailingSlash,T=_.baseUrl,C=(0,p.C)().withBaseUrl,P=(0,o.useContext)(d),A=(0,o.useRef)(null);(0,o.useImperativeHandle)(t,(function(){return A.current}));var L=g||b;var R,O=(0,u.Z)(L),N=null==L?void 0:L.replace("pathname://",""),I=void 0!==N?(R=N,k&&function(e){return e.startsWith("/")}(R)?C(R):R):void 0;I&&O&&(I=(0,l.applyTrailingSlash)(I,{trailingSlash:x,baseUrl:T}));var M=(0,o.useRef)(!1),D=h?i.OL:i.rU,F=c.Z.canUseIntersectionObserver,B=(0,o.useRef)(),j=function(){M.current||null==I||(window.docusaurus.preload(I),M.current=!0)};(0,o.useEffect)((function(){return!F&&O&&null!=I&&window.docusaurus.prefetch(I),function(){F&&B.current&&B.current.disconnect()}}),[B,I,F,O]);var U=null!=(n=null==(m=I)?void 0:m.startsWith("#"))&&n,z=!I||!O||U;return z||w||P.collectLink(I),z?o.createElement("a",(0,r.Z)({ref:A,href:I},L&&!O&&{target:"_blank",rel:"noopener noreferrer"},E)):o.createElement(D,(0,r.Z)({},E,{onMouseEnter:j,onTouchStart:j,innerRef:function(e){A.current=e,F&&e&&O&&(B.current=new window.IntersectionObserver((function(t){t.forEach((function(t){e===t.target&&(t.isIntersecting||t.intersectionRatio>0)&&(B.current.unobserve(e),B.current.disconnect(),null!=I&&window.docusaurus.prefetch(I))}))})),B.current.observe(e))},to:I},h&&{isActive:y,activeClassName:v}))}const h=o.forwardRef(m)},1875:(e,t,n)=>{"use strict";n.d(t,{Z:()=>r});const r=function(){return null}},5999:(e,t,n)=>{"use strict";n.d(t,{Z:()=>s,I:()=>l});var r=n(7294);function a(e,t){var n=e.split(/(\{\w+\})/).map((function(e,n){if(n%2==1){var r=null==t?void 0:t[e.slice(1,-1)];if(void 0!==r)return r}return e}));return n.some((function(e){return(0,r.isValidElement)(e)}))?n.map((function(e,t){return(0,r.isValidElement)(e)?r.cloneElement(e,{key:t}):e})).filter((function(e){return""!==e})):n.join("")}var o=n(7529);function i(e){var t,n,r=e.id,a=e.message;if(void 0===r&&void 0===a)throw new Error("Docusaurus translation declarations must have at least a translation id or a default translation message");return null!=(t=null!=(n=o[null!=r?r:a])?n:a)?t:r}function l(e,t){return a(i({message:e.message,id:e.id}),t)}function s(e){var t=e.children,n=e.id,o=e.values;if(t&&"string"!=typeof t)throw console.warn("Illegal children",t),new Error("The Docusaurus component only accept simple string values");var l=i({message:t,id:n});return r.createElement(r.Fragment,null,a(l,o))}},9935:(e,t,n)=>{"use strict";n.d(t,{m:()=>r});var r="default"},3919:(e,t,n)=>{"use strict";function r(e){return/^(?:\w*:|\/\/)/.test(e)}function a(e){return void 0!==e&&!r(e)}n.d(t,{Z:()=>a,b:()=>r})},4996:(e,t,n)=>{"use strict";n.d(t,{C:()=>i,Z:()=>l});var r=n(7294),a=n(2263),o=n(3919);function i(){var e=(0,a.Z)().siteConfig,t=e.baseUrl,n=e.url,i=(0,r.useCallback)((function(e,r){return function(e,t,n,r){var a=void 0===r?{}:r,i=a.forcePrependBaseUrl,l=void 0!==i&&i,s=a.absolute,u=void 0!==s&&s;if(!n||n.startsWith("#")||(0,o.b)(n))return n;if(l)return t+n.replace(/^\//,"");if(n===t.replace(/\/$/,""))return t;var c=n.startsWith(t)?n:t+n.replace(/^\//,"");return u?e+c:c}(n,t,e,r)}),[n,t]);return{withBaseUrl:i}}function l(e,t){return void 0===t&&(t={}),(0,i().withBaseUrl)(e,t)}},2263:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294),a=n(8940);function o(){return(0,r.useContext)(a._)}},2389:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294),a=n(8934);function o(){return(0,r.useContext)(a._)}},9670:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});var r=function(e){return"object"==typeof e&&!!e&&Object.keys(e).length>0};function a(e){var t={};return function e(n,a){Object.entries(n).forEach((function(n){var o=n[0],i=n[1],l=a?a+"."+o:o;r(i)?e(i,l):t[l]=i}))}(e),t}},226:(e,t,n)=>{"use strict";n.d(t,{_:()=>a,z:()=>o});var r=n(7294),a=r.createContext(null);function o(e){var t=e.children,n=e.value,o=r.useContext(a),i=(0,r.useMemo)((function(){return function(e){var t=e.parent,n=e.value;if(!t){if(!n)throw new Error("Unexpected: no Docusaurus route context found");if(!("plugin"in n))throw new Error("Unexpected: Docusaurus topmost route context has no `plugin` attribute");return n}var r=Object.assign({},t.data,null==n?void 0:n.data);return{plugin:t.plugin,data:r}}({parent:o,value:n})}),[o,n]);return r.createElement(a.Provider,{value:i},t)}},143:(e,t,n)=>{"use strict";n.d(t,{Iw:()=>h,gA:()=>p,_r:()=>c,Jo:()=>g,zh:()=>d,yW:()=>m,gB:()=>f});var r=n(6550),a=n(2263),o=n(9935);function i(e,t){void 0===t&&(t={});var n=(0,a.Z)().globalData[e];if(!n&&t.failfast)throw new Error('Docusaurus plugin global data not found for "'+e+'" plugin.');return n}var l=function(e){return e.versions.find((function(e){return e.isLast}))};function s(e,t){var n,a,o=function(e,t){var n=l(e);return[].concat(e.versions.filter((function(e){return e!==n})),[n]).find((function(e){return!!(0,r.LX)(t,{path:e.path,exact:!1,strict:!1})}))}(e,t),i=null==o?void 0:o.docs.find((function(e){return!!(0,r.LX)(t,{path:e.path,exact:!0,strict:!1})}));return{activeVersion:o,activeDoc:i,alternateDocVersions:i?(n=i.id,a={},e.versions.forEach((function(e){e.docs.forEach((function(t){t.id===n&&(a[e.name]=t)}))})),a):{}}}var u={},c=function(){var e;return null!=(e=i("docusaurus-plugin-content-docs"))?e:u},d=function(e){return function(e,t,n){void 0===t&&(t=o.m),void 0===n&&(n={});var r=i(e),a=null==r?void 0:r[t];if(!a&&n.failfast)throw new Error('Docusaurus plugin global data not found for "'+e+'" plugin with id "'+t+'".');return a}("docusaurus-plugin-content-docs",e,{failfast:!0})};function p(e){return void 0===e&&(e={}),function(e,t,n){void 0===n&&(n={});var a=Object.entries(e).sort((function(e,t){return t[1].path.localeCompare(e[1].path)})).find((function(e){var n=e[1];return!!(0,r.LX)(t,{path:n.path,exact:!1,strict:!1})})),o=a?{pluginId:a[0],pluginData:a[1]}:void 0;if(!o&&n.failfast)throw new Error("Can't find active docs plugin for \""+t+'" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: '+Object.values(e).map((function(e){return e.path})).join(", "));return o}(c(),(0,r.TH)().pathname,e)}function f(e){return d(e).versions}function m(e){var t=d(e);return l(t)}function h(e){return s(d(e),(0,r.TH)().pathname)}function g(e){return function(e,t){var n=l(e);return{latestDocSuggestion:s(e,t).alternateDocVersions[n.name],latestVersionSuggestion:n}}(d(e),(0,r.TH)().pathname)}},8320:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>o});var r=n(4865),a=n.n(r);a().configure({showSpinner:!1});const o={onRouteUpdate:function(e){var t=e.location,n=e.previousLocation;if(n&&t.pathname!==n.pathname){var r=window.setTimeout((function(){a().start()}),200);return function(){return window.clearTimeout(r)}}},onRouteDidUpdate:function(){a().done()}}},3310:(e,t,n)=>{"use strict";n.r(t);var r,a,o=n(7410),i=n(6809);r=o.Z,a=i.default.themeConfig.prism.additionalLanguages,globalThis.Prism=r,a.forEach((function(e){n(6726)("./prism-"+e)})),delete globalThis.Prism},9471:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294);const a={iconExternalLink:"iconExternalLink_nPIU"};function o(e){var t=e.width,n=void 0===t?13.5:t,o=e.height,i=void 0===o?13.5:o;return r.createElement("svg",{width:n,height:i,"aria-hidden":"true",viewBox:"0 0 24 24",className:a.iconExternalLink},r.createElement("path",{fill:"currentColor",d:"M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"}))}},7961:(e,t,n)=>{"use strict";n.d(t,{Z:()=>Lt});var r=n(7294),a=n(6010),o=n(4763),i=n(1944),l=n(7462),s=n(6550),u=n(5999),c=n(5936),d="__docusaurus_skipToContent_fallback";function p(e){e.setAttribute("tabindex","-1"),e.focus(),e.removeAttribute("tabindex")}function f(){var e=(0,r.useRef)(null),t=(0,s.k6)().action,n=(0,r.useCallback)((function(e){e.preventDefault();var t,n=null!=(t=document.querySelector("main:first-of-type"))?t:document.getElementById(d);n&&p(n)}),[]);return(0,c.S)((function(n){var r=n.location;e.current&&!r.hash&&"PUSH"===t&&p(e.current)})),{containerRef:e,onClick:n}}var m=(0,u.I)({id:"theme.common.skipToMainContent",description:"The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation",message:"Skip to main content"});function h(e){var t,n=null!=(t=e.children)?t:m,a=f(),o=a.containerRef,i=a.onClick;return r.createElement("div",{ref:o,role:"region","aria-label":m},r.createElement("a",(0,l.Z)({},e,{href:"#"+d,onClick:i}),n))}var g=n(5281),b=n(9727);const v={skipToContent:"skipToContent_fXgn"};function y(){return r.createElement(h,{className:v.skipToContent})}var w=n(6668),S=n(9689),k=n(3366),E=["width","height","color","strokeWidth","className"];function _(e){var t=e.width,n=void 0===t?21:t,a=e.height,o=void 0===a?21:a,i=e.color,s=void 0===i?"currentColor":i,u=e.strokeWidth,c=void 0===u?1.2:u,d=(e.className,(0,k.Z)(e,E));return r.createElement("svg",(0,l.Z)({viewBox:"0 0 15 15",width:n,height:o},d),r.createElement("g",{stroke:s,strokeWidth:c},r.createElement("path",{d:"M.75.75l13.5 13.5M14.25.75L.75 14.25"})))}const x={closeButton:"closeButton_CVFx"};function T(e){return r.createElement("button",(0,l.Z)({type:"button","aria-label":(0,u.I)({id:"theme.AnnouncementBar.closeButtonAriaLabel",message:"Close",description:"The ARIA label for close button of announcement bar"})},e,{className:(0,a.Z)("clean-btn close",x.closeButton,e.className)}),r.createElement(_,{width:14,height:14,strokeWidth:3.1}))}const C={content:"content_knG7"};function P(e){var t=(0,w.L)().announcementBar.content;return r.createElement("div",(0,l.Z)({},e,{className:(0,a.Z)(C.content,e.className),dangerouslySetInnerHTML:{__html:t}}))}const A={announcementBar:"announcementBar_mb4j",announcementBarPlaceholder:"announcementBarPlaceholder_vyr4",announcementBarClose:"announcementBarClose_gvF7",announcementBarContent:"announcementBarContent_xLdY"};function L(){var e=(0,w.L)().announcementBar,t=(0,S.nT)(),n=t.isActive,a=t.close;if(!n)return null;var o=e.backgroundColor,i=e.textColor,l=e.isCloseable;return r.createElement("div",{className:A.announcementBar,style:{backgroundColor:o,color:i},role:"banner"},l&&r.createElement("div",{className:A.announcementBarPlaceholder}),r.createElement(P,{className:A.announcementBarContent}),l&&r.createElement(T,{onClick:a,className:A.announcementBarClose}))}var R=n(2961),O=n(2466);var N=n(9688),I=n(3102),M=r.createContext(null);function D(e){var t,n,a,o,i,l,s,u=e.children,c=(t=(0,R.e)(),n=(0,I.HY)(),a=(0,r.useState)(!1),o=a[0],i=a[1],l=null!==n.component,s=(0,N.D9)(l),(0,r.useEffect)((function(){l&&!s&&i(!0)}),[l,s]),(0,r.useEffect)((function(){l?t.shown||i(!0):i(!1)}),[t.shown,l]),(0,r.useMemo)((function(){return[o,i]}),[o]));return r.createElement(M.Provider,{value:c},u)}function F(e){if(e.component){var t=e.component;return r.createElement(t,e.props)}}function B(){var e=(0,r.useContext)(M);if(!e)throw new N.i6("NavbarSecondaryMenuDisplayProvider");var t=e[0],n=e[1],a=(0,r.useCallback)((function(){return n(!1)}),[n]),o=(0,I.HY)();return(0,r.useMemo)((function(){return{shown:t,hide:a,content:F(o)}}),[a,o,t])}function j(e){var t=e.header,n=e.primaryMenu,o=e.secondaryMenu,i=B().shown;return r.createElement("div",{className:"navbar-sidebar"},t,r.createElement("div",{className:(0,a.Z)("navbar-sidebar__items",{"navbar-sidebar__items--show-secondary":i})},r.createElement("div",{className:"navbar-sidebar__item menu"},n),r.createElement("div",{className:"navbar-sidebar__item menu"},o)))}var U=n(2949),z=n(2389);function H(e){return r.createElement("svg",(0,l.Z)({viewBox:"0 0 24 24",width:24,height:24},e),r.createElement("path",{fill:"currentColor",d:"M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"}))}function Z(e){return r.createElement("svg",(0,l.Z)({viewBox:"0 0 24 24",width:24,height:24},e),r.createElement("path",{fill:"currentColor",d:"M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"}))}const $={toggle:"toggle_vylO",toggleButton:"toggleButton_gllP",darkToggleIcon:"darkToggleIcon_wfgR",lightToggleIcon:"lightToggleIcon_pyhR",toggleButtonDisabled:"toggleButtonDisabled_aARS"};function G(e){var t=e.className,n=e.buttonClassName,o=e.value,i=e.onChange,l=(0,z.Z)(),s=(0,u.I)({message:"Switch between dark and light mode (currently {mode})",id:"theme.colorToggle.ariaLabel",description:"The ARIA label for the navbar color mode toggle"},{mode:"dark"===o?(0,u.I)({message:"dark mode",id:"theme.colorToggle.ariaLabel.mode.dark",description:"The name for the dark color mode"}):(0,u.I)({message:"light mode",id:"theme.colorToggle.ariaLabel.mode.light",description:"The name for the light color mode"})});return r.createElement("div",{className:(0,a.Z)($.toggle,t)},r.createElement("button",{className:(0,a.Z)("clean-btn",$.toggleButton,!l&&$.toggleButtonDisabled,n),type:"button",onClick:function(){return i("dark"===o?"light":"dark")},disabled:!l,title:s,"aria-label":s,"aria-live":"polite"},r.createElement(H,{className:(0,a.Z)($.toggleIcon,$.lightToggleIcon)}),r.createElement(Z,{className:(0,a.Z)($.toggleIcon,$.darkToggleIcon)})))}const q=r.memo(G),V={darkNavbarColorModeToggle:"darkNavbarColorModeToggle_X3D1"};function W(e){var t=e.className,n=(0,w.L)().navbar.style,a=(0,w.L)().colorMode.disableSwitch,o=(0,U.I)(),i=o.colorMode,l=o.setColorMode;return a?null:r.createElement(q,{className:t,buttonClassName:"dark"===n?V.darkNavbarColorModeToggle:void 0,value:i,onChange:l})}var Y=n(1327);function K(){return r.createElement(Y.Z,{className:"navbar__brand",imageClassName:"navbar__logo",titleClassName:"navbar__title text--truncate"})}function Q(){var e=(0,R.e)();return r.createElement("button",{type:"button","aria-label":(0,u.I)({id:"theme.docs.sidebar.closeSidebarButtonAriaLabel",message:"Close navigation bar",description:"The ARIA label for close button of mobile sidebar"}),className:"clean-btn navbar-sidebar__close",onClick:function(){return e.toggle()}},r.createElement(_,{color:"var(--ifm-color-emphasis-600)"}))}function X(){return r.createElement("div",{className:"navbar-sidebar__brand"},r.createElement(K,null),r.createElement(W,{className:"margin-right--md"}),r.createElement(Q,null))}var J=n(9960),ee=n(4996),te=n(3919);function ne(e,t){return void 0!==e&&void 0!==t&&new RegExp(e,"gi").test(t)}var re=n(9471),ae=["activeBasePath","activeBaseRegex","to","href","label","html","isDropdownLink","prependBaseUrlToHref"];function oe(e){var t=e.activeBasePath,n=e.activeBaseRegex,a=e.to,o=e.href,i=e.label,s=e.html,u=e.isDropdownLink,c=e.prependBaseUrlToHref,d=(0,k.Z)(e,ae),p=(0,ee.Z)(a),f=(0,ee.Z)(t),m=(0,ee.Z)(o,{forcePrependBaseUrl:!0}),h=i&&o&&!(0,te.Z)(o),g=s?{dangerouslySetInnerHTML:{__html:s}}:{children:r.createElement(r.Fragment,null,i,h&&r.createElement(re.Z,u&&{width:12,height:12}))};return o?r.createElement(J.Z,(0,l.Z)({href:c?m:o},d,g)):r.createElement(J.Z,(0,l.Z)({to:p,isNavLink:!0},(t||n)&&{isActive:function(e,t){return n?ne(n,t.pathname):t.pathname.startsWith(f)}},d,g))}var ie=["className","isDropdownItem"],le=["className","isDropdownItem"],se=["mobile","position"];function ue(e){var t=e.className,n=e.isDropdownItem,o=void 0!==n&&n,i=(0,k.Z)(e,ie),s=r.createElement(oe,(0,l.Z)({className:(0,a.Z)(o?"dropdown__link":"navbar__item navbar__link",t),isDropdownLink:o},i));return o?r.createElement("li",null,s):s}function ce(e){var t=e.className,n=(e.isDropdownItem,(0,k.Z)(e,le));return r.createElement("li",{className:"menu__list-item"},r.createElement(oe,(0,l.Z)({className:(0,a.Z)("menu__link",t)},n)))}function de(e){var t,n=e.mobile,a=void 0!==n&&n,o=(e.position,(0,k.Z)(e,se)),i=a?ce:ue;return r.createElement(i,(0,l.Z)({},o,{activeClassName:null!=(t=o.activeClassName)?t:a?"menu__link--active":"navbar__link--active"}))}var pe=n(6043),fe=n(8596),me=n(2263);var he=["items","position","className","onClick"],ge=["items","className","position","onClick"],be=["mobile"];function ve(e,t){return e.some((function(e){return function(e,t){return!!(0,fe.Mg)(e.to,t)||!!ne(e.activeBaseRegex,t)||!(!e.activeBasePath||!t.startsWith(e.activeBasePath))}(e,t)}))}function ye(e){var t,n=e.items,o=e.position,i=e.className,s=(e.onClick,(0,k.Z)(e,he)),u=(0,r.useRef)(null),c=(0,r.useState)(!1),d=c[0],p=c[1];return(0,r.useEffect)((function(){var e=function(e){u.current&&!u.current.contains(e.target)&&p(!1)};return document.addEventListener("mousedown",e),document.addEventListener("touchstart",e),document.addEventListener("focusin",e),function(){document.removeEventListener("mousedown",e),document.removeEventListener("touchstart",e),document.removeEventListener("focusin",e)}}),[u]),r.createElement("div",{ref:u,className:(0,a.Z)("navbar__item","dropdown","dropdown--hoverable",{"dropdown--right":"right"===o,"dropdown--show":d})},r.createElement(oe,(0,l.Z)({"aria-haspopup":"true","aria-expanded":d,role:"button",href:s.to?void 0:"#",className:(0,a.Z)("navbar__link",i)},s,{onClick:s.to?void 0:function(e){return e.preventDefault()},onKeyDown:function(e){"Enter"===e.key&&(e.preventDefault(),p(!d))}}),null!=(t=s.children)?t:s.label),r.createElement("ul",{className:"dropdown__menu"},n.map((function(e,t){return r.createElement(Ue,(0,l.Z)({isDropdownItem:!0,activeClassName:"dropdown__link--active"},e,{key:t}))}))))}function we(e){var t,n,o=e.items,i=e.className,u=(e.position,e.onClick),c=(0,k.Z)(e,ge),d=(n=(0,me.Z)().siteConfig.baseUrl,(0,s.TH)().pathname.replace(n,"/")),p=ve(o,d),f=(0,pe.u)({initialState:function(){return!p}}),m=f.collapsed,h=f.toggleCollapsed,g=f.setCollapsed;return(0,r.useEffect)((function(){p&&g(!p)}),[d,p,g]),r.createElement("li",{className:(0,a.Z)("menu__list-item",{"menu__list-item--collapsed":m})},r.createElement(oe,(0,l.Z)({role:"button",className:(0,a.Z)("menu__link menu__link--sublist menu__link--sublist-caret",i)},c,{onClick:function(e){e.preventDefault(),h()}}),null!=(t=c.children)?t:c.label),r.createElement(pe.z,{lazy:!0,as:"ul",className:"menu__list",collapsed:m},o.map((function(e,t){return r.createElement(Ue,(0,l.Z)({mobile:!0,isDropdownItem:!0,onClick:u,activeClassName:"menu__link--active"},e,{key:t}))}))))}function Se(e){var t=e.mobile,n=void 0!==t&&t,a=(0,k.Z)(e,be),o=n?we:ye;return r.createElement(o,a)}var ke=n(4711),Ee=["width","height"];function _e(e){var t=e.width,n=void 0===t?20:t,a=e.height,o=void 0===a?20:a,i=(0,k.Z)(e,Ee);return r.createElement("svg",(0,l.Z)({viewBox:"0 0 24 24",width:n,height:o,"aria-hidden":!0},i),r.createElement("path",{fill:"currentColor",d:"M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"}))}const xe="iconLanguage_nlXk";var Te=["mobile","dropdownItemsBefore","dropdownItemsAfter"];var Ce=n(1875);const Pe={searchBox:"searchBox_ZlJk"};function Ae(e){var t=e.children,n=e.className;return r.createElement("div",{className:(0,a.Z)(n,Pe.searchBox)},t)}var Le=n(143),Re=n(8425),Oe=["docId","label","docsPluginId"];var Ne=["sidebarId","label","docsPluginId"];var Ie=["label","to","docsPluginId"];var Me=n(373),De=["mobile","docsPluginId","dropdownActiveClassDisabled","dropdownItemsBefore","dropdownItemsAfter"],Fe=function(e){return e.docs.find((function(t){return t.id===e.mainDocId}))};const Be={default:de,localeDropdown:function(e){var t=e.mobile,n=e.dropdownItemsBefore,a=e.dropdownItemsAfter,o=(0,k.Z)(e,Te),i=(0,me.Z)().i18n,c=i.currentLocale,d=i.locales,p=i.localeConfigs,f=(0,ke.l)(),m=(0,s.TH)(),h=m.search,g=m.hash,b=d.map((function(e){var n=""+("pathname://"+f.createUrl({locale:e,fullyQualified:!1}))+h+g;return{label:p[e].label,lang:p[e].htmlLang,to:n,target:"_self",autoAddBaseUrl:!1,className:e===c?t?"menu__link--active":"dropdown__link--active":""}})),v=[].concat(n,b,a),y=t?(0,u.I)({message:"Languages",id:"theme.navbar.mobileLanguageDropdown.label",description:"The label for the mobile language switcher dropdown"}):p[c].label;return r.createElement(Se,(0,l.Z)({},o,{mobile:t,label:r.createElement(r.Fragment,null,r.createElement(_e,{className:xe}),y),items:v}))},search:function(e){var t=e.mobile,n=e.className;return t?null:r.createElement(Ae,{className:n},r.createElement(Ce.Z,null))},dropdown:Se,html:function(e){var t=e.value,n=e.className,o=e.mobile,i=void 0!==o&&o,l=e.isDropdownItem,s=void 0!==l&&l,u=s?"li":"div";return r.createElement(u,{className:(0,a.Z)({navbar__item:!i&&!s,"menu__list-item":i},n),dangerouslySetInnerHTML:{__html:t}})},doc:function(e){var t=e.docId,n=e.label,a=e.docsPluginId,o=(0,k.Z)(e,Oe),i=(0,Le.Iw)(a).activeDoc,s=(0,Re.vY)(t,a);return null===s?null:r.createElement(de,(0,l.Z)({exact:!0},o,{isActive:function(){return(null==i?void 0:i.path)===s.path||!(null==i||!i.sidebar)&&i.sidebar===s.sidebar},label:null!=n?n:s.id,to:s.path}))},docSidebar:function(e){var t=e.sidebarId,n=e.label,a=e.docsPluginId,o=(0,k.Z)(e,Ne),i=(0,Le.Iw)(a).activeDoc,s=(0,Re.oz)(t,a).link;if(!s)throw new Error('DocSidebarNavbarItem: Sidebar with ID "'+t+"\" doesn't have anything to be linked to.");return r.createElement(de,(0,l.Z)({exact:!0},o,{isActive:function(){return(null==i?void 0:i.sidebar)===t},label:null!=n?n:s.label,to:s.path}))},docsVersion:function(e){var t=e.label,n=e.to,a=e.docsPluginId,o=(0,k.Z)(e,Ie),i=(0,Re.lO)(a)[0],s=null!=t?t:i.label,u=null!=n?n:function(e){return e.docs.find((function(t){return t.id===e.mainDocId}))}(i).path;return r.createElement(de,(0,l.Z)({},o,{label:s,to:u}))},docsVersionDropdown:function(e){var t=e.mobile,n=e.docsPluginId,a=e.dropdownActiveClassDisabled,o=e.dropdownItemsBefore,i=e.dropdownItemsAfter,c=(0,k.Z)(e,De),d=(0,s.TH)(),p=d.search,f=d.hash,m=(0,Le.Iw)(n),h=(0,Le.gB)(n),g=(0,Me.J)(n).savePreferredVersionName,b=h.map((function(e){var t,n=null!=(t=m.alternateDocVersions[e.name])?t:Fe(e);return{label:e.label,to:""+n.path+p+f,isActive:function(){return e===m.activeVersion},onClick:function(){return g(e.name)}}})),v=[].concat(o,b,i),y=(0,Re.lO)(n)[0],w=t&&v.length>1?(0,u.I)({id:"theme.navbar.mobileVersionsDropdown.label",message:"Versions",description:"The label for the navbar versions dropdown on mobile view"}):y.label,S=t&&v.length>1?void 0:Fe(y).path;return v.length<=1?r.createElement(de,(0,l.Z)({},c,{mobile:t,label:w,to:S,isActive:a?function(){return!1}:void 0})):r.createElement(Se,(0,l.Z)({},c,{mobile:t,label:w,to:S,items:v,isActive:a?function(){return!1}:void 0}))}};var je=["type"];function Ue(e){var t=e.type,n=(0,k.Z)(e,je),a=function(e,t){return e&&"default"!==e?e:"items"in t?"dropdown":"default"}(t,n),o=Be[a];if(!o)throw new Error('No NavbarItem component found for type "'+t+'".');return r.createElement(o,n)}function ze(){var e=(0,R.e)(),t=(0,w.L)().navbar.items;return r.createElement("ul",{className:"menu__list"},t.map((function(t,n){return r.createElement(Ue,(0,l.Z)({mobile:!0},t,{onClick:function(){return e.toggle()},key:n}))})))}function He(e){return r.createElement("button",(0,l.Z)({},e,{type:"button",className:"clean-btn navbar-sidebar__back"}),r.createElement(u.Z,{id:"theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel",description:"The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)"},"\u2190 Back to main menu"))}function Ze(){var e=0===(0,w.L)().navbar.items.length,t=B();return r.createElement(r.Fragment,null,!e&&r.createElement(He,{onClick:function(){return t.hide()}}),t.content)}function $e(){var e,t=(0,R.e)();return void 0===(e=t.shown)&&(e=!0),(0,r.useEffect)((function(){return document.body.style.overflow=e?"hidden":"visible",function(){document.body.style.overflow="visible"}}),[e]),t.shouldRender?r.createElement(j,{header:r.createElement(X,null),primaryMenu:r.createElement(ze,null),secondaryMenu:r.createElement(Ze,null)}):null}const Ge={navbarHideable:"navbarHideable_m1mJ",navbarHidden:"navbarHidden_jGov"};function qe(e){return r.createElement("div",(0,l.Z)({role:"presentation"},e,{className:(0,a.Z)("navbar-sidebar__backdrop",e.className)}))}function Ve(e){var t=e.children,n=(0,w.L)().navbar,o=n.hideOnScroll,i=n.style,l=(0,R.e)(),s=function(e){var t=(0,r.useState)(e),n=t[0],a=t[1],o=(0,r.useRef)(!1),i=(0,r.useRef)(0),l=(0,r.useCallback)((function(e){null!==e&&(i.current=e.getBoundingClientRect().height)}),[]);return(0,O.RF)((function(t,n){var r=t.scrollY;if(e)if(r=l?a(!1):r+u0&&r.createElement(bt,{links:n}),logo:a&&r.createElement(St,{logo:a}),copyright:t&&r.createElement(kt,{copyright:t})})}const xt=r.memo(_t);var Tt=(0,N.Qc)([U.S,S.pl,O.OC,Me.L5,i.VC,function(e){var t=e.children;return r.createElement(I.n2,null,r.createElement(R.M,null,r.createElement(D,null,t)))}]);function Ct(e){var t=e.children;return r.createElement(Tt,null,t)}function Pt(e){var t=e.error,n=e.tryAgain;return r.createElement("main",{className:"container margin-vert--xl"},r.createElement("div",{className:"row"},r.createElement("div",{className:"col col--6 col--offset-3"},r.createElement("h1",{className:"hero__title"},r.createElement(u.Z,{id:"theme.ErrorPageContent.title",description:"The title of the fallback page when the page crashed"},"This page crashed.")),r.createElement("div",{className:"margin-vert--lg"},r.createElement(Qe,{onClick:n,className:"button button--primary shadow--lw"})),r.createElement("hr",null),r.createElement("div",{className:"margin-vert--md"},r.createElement(Xe,{error:t})))))}const At={mainWrapper:"mainWrapper_z2l0"};function Lt(e){var t=e.children,n=e.noFooter,l=e.wrapperClassName,s=e.title,u=e.description;return(0,b.t)(),r.createElement(Ct,null,r.createElement(i.d,{title:s,description:u}),r.createElement(y,null),r.createElement(L,null),r.createElement(st,null),r.createElement("div",{id:d,className:(0,a.Z)(g.k.wrapper.main,At.mainWrapper,l)},r.createElement(o.Z,{fallback:function(e){return r.createElement(Pt,e)}},t)),!n&&r.createElement(xt,null))}},1327:(e,t,n)=>{"use strict";n.d(t,{Z:()=>f});var r=n(7462),a=n(3366),o=n(7294),i=n(9960),l=n(4996),s=n(2263),u=n(6668),c=n(941),d=["imageClassName","titleClassName"];function p(e){var t=e.logo,n=e.alt,r=e.imageClassName,a={light:(0,l.Z)(t.src),dark:(0,l.Z)(t.srcDark||t.src)},i=o.createElement(c.Z,{className:t.className,sources:a,height:t.height,width:t.width,alt:n,style:t.style});return r?o.createElement("div",{className:r},i):i}function f(e){var t,n=(0,s.Z)().siteConfig.title,c=(0,u.L)().navbar,f=c.title,m=c.logo,h=e.imageClassName,g=e.titleClassName,b=(0,a.Z)(e,d),v=(0,l.Z)((null==m?void 0:m.href)||"/"),y=f?"":n,w=null!=(t=null==m?void 0:m.alt)?t:y;return o.createElement(i.Z,(0,r.Z)({to:v},b,(null==m?void 0:m.target)&&{target:m.target}),m&&o.createElement(p,{logo:m,alt:w,imageClassName:h}),null!=f&&o.createElement("b",{className:g},f))}},197:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294),a=n(5742);function o(e){var t=e.locale,n=e.version,o=e.tag,i=t;return r.createElement(a.Z,null,t&&r.createElement("meta",{name:"docusaurus_locale",content:t}),n&&r.createElement("meta",{name:"docusaurus_version",content:n}),o&&r.createElement("meta",{name:"docusaurus_tag",content:o}),i&&r.createElement("meta",{name:"docsearch:language",content:i}),n&&r.createElement("meta",{name:"docsearch:version",content:n}),o&&r.createElement("meta",{name:"docsearch:docusaurus_tag",content:o}))}},941:(e,t,n)=>{"use strict";n.d(t,{Z:()=>d});var r=n(7462),a=n(3366),o=n(7294),i=n(6010),l=n(2389),s=n(2949);const u={themedImage:"themedImage_ToTc","themedImage--light":"themedImage--light_HNdA","themedImage--dark":"themedImage--dark_i4oU"};var c=["sources","className","alt"];function d(e){var t=(0,l.Z)(),n=(0,s.I)().colorMode,d=e.sources,p=e.className,f=e.alt,m=(0,a.Z)(e,c),h=t?"dark"===n?["dark"]:["light"]:["light","dark"];return o.createElement(o.Fragment,null,h.map((function(e){return o.createElement("img",(0,r.Z)({key:e,src:d[e],alt:f,className:(0,i.Z)(u.themedImage,u["themedImage--"+e],p)},m))})))}},6043:(e,t,n)=>{"use strict";n.d(t,{u:()=>d,z:()=>y});var r=n(7462),a=n(3366),o=n(7294),i=n(412),l=n(1442),s=["collapsed"],u=["lazy"],c="ease-in-out";function d(e){var t=e.initialState,n=(0,o.useState)(null!=t&&t),r=n[0],a=n[1],i=(0,o.useCallback)((function(){a((function(e){return!e}))}),[]);return{collapsed:r,setCollapsed:a,toggleCollapsed:i}}var p={display:"none",overflow:"hidden",height:"0px"},f={display:"block",overflow:"visible",height:"auto"};function m(e,t){var n=t?p:f;e.style.display=n.display,e.style.overflow=n.overflow,e.style.height=n.height}function h(e){var t=e.collapsibleRef,n=e.collapsed,r=e.animation,a=(0,o.useRef)(!1);(0,o.useEffect)((function(){var e,o=t.current;function i(){var e,t,n=o.scrollHeight,a=null!=(e=null==r?void 0:r.duration)?e:function(e){if((0,l.n)())return 1;var t=e/36;return Math.round(10*(4+15*Math.pow(t,.25)+t/5))}(n);return{transition:"height "+a+"ms "+(null!=(t=null==r?void 0:r.easing)?t:c),height:n+"px"}}function s(){var e=i();o.style.transition=e.transition,o.style.height=e.height}if(!a.current)return m(o,n),void(a.current=!0);return o.style.willChange="height",e=requestAnimationFrame((function(){n?(s(),requestAnimationFrame((function(){o.style.height=p.height,o.style.overflow=p.overflow}))):(o.style.display="block",requestAnimationFrame((function(){s()})))})),function(){return cancelAnimationFrame(e)}}),[t,n,r])}function g(e){if(!i.Z.canUseDOM)return e?p:f}function b(e){var t=e.as,n=void 0===t?"div":t,r=e.collapsed,a=e.children,i=e.animation,l=e.onCollapseTransitionEnd,s=e.className,u=e.disableSSRStyle,c=(0,o.useRef)(null);return h({collapsibleRef:c,collapsed:r,animation:i}),o.createElement(n,{ref:c,style:u?void 0:g(r),onTransitionEnd:function(e){"height"===e.propertyName&&(m(c.current,r),null==l||l(r))},className:s},a)}function v(e){var t=e.collapsed,n=(0,a.Z)(e,s),i=(0,o.useState)(!t),l=i[0],u=i[1],c=(0,o.useState)(t),d=c[0],p=c[1];return(0,o.useLayoutEffect)((function(){t||u(!0)}),[t]),(0,o.useLayoutEffect)((function(){l&&p(t)}),[l,t]),l?o.createElement(b,(0,r.Z)({},n,{collapsed:d})):null}function y(e){var t=e.lazy,n=(0,a.Z)(e,u),r=t?v:b;return o.createElement(r,n)}},9689:(e,t,n)=>{"use strict";n.d(t,{nT:()=>m,pl:()=>f});var r=n(7294),a=n(2389),o=n(12),i=n(9688),l=n(6668),s=(0,o.WA)("docusaurus.announcement.dismiss"),u=(0,o.WA)("docusaurus.announcement.id"),c=function(){return"true"===s.get()},d=function(e){return s.set(String(e))},p=r.createContext(null);function f(e){var t=e.children,n=function(){var e=(0,l.L)().announcementBar,t=(0,a.Z)(),n=(0,r.useState)((function(){return!!t&&c()})),o=n[0],i=n[1];(0,r.useEffect)((function(){i(c())}),[]);var s=(0,r.useCallback)((function(){d(!0),i(!0)}),[]);return(0,r.useEffect)((function(){if(e){var t=e.id,n=u.get();"annoucement-bar"===n&&(n="announcement-bar");var r=t!==n;u.set(t),r&&d(!1),!r&&c()||i(!1)}}),[e]),(0,r.useMemo)((function(){return{isActive:!!e&&!o,close:s}}),[e,o,s])}();return r.createElement(p.Provider,{value:n},t)}function m(){var e=(0,r.useContext)(p);if(!e)throw new i.i6("AnnouncementBarProvider");return e}},2949:(e,t,n)=>{"use strict";n.d(t,{I:()=>g,S:()=>h});var r=n(7294),a=n(412),o=n(9688),i=n(12),l=n(6668),s=r.createContext(void 0),u="theme",c=(0,i.WA)(u),d={light:"light",dark:"dark"},p=function(e){return e===d.dark?d.dark:d.light},f=function(e){return a.Z.canUseDOM?p(document.documentElement.getAttribute("data-theme")):p(e)},m=function(e){c.set(p(e))};function h(e){var t=e.children,n=function(){var e=(0,l.L)().colorMode,t=e.defaultMode,n=e.disableSwitch,a=e.respectPrefersColorScheme,o=(0,r.useState)(f(t)),i=o[0],s=o[1];(0,r.useEffect)((function(){n&&c.del()}),[n]);var h=(0,r.useCallback)((function(e,n){void 0===n&&(n={});var r=n.persist,o=void 0===r||r;e?(s(e),o&&m(e)):(s(a?window.matchMedia("(prefers-color-scheme: dark)").matches?d.dark:d.light:t),c.del())}),[a,t]);(0,r.useEffect)((function(){document.documentElement.setAttribute("data-theme",p(i))}),[i]),(0,r.useEffect)((function(){if(!n){var e=function(e){if(e.key===u){var t=c.get();null!==t&&h(p(t))}};return window.addEventListener("storage",e),function(){return window.removeEventListener("storage",e)}}}),[n,h]);var g=(0,r.useRef)(!1);return(0,r.useEffect)((function(){if(!n||a){var e=window.matchMedia("(prefers-color-scheme: dark)"),t=function(){window.matchMedia("print").matches||g.current?g.current=window.matchMedia("print").matches:h(null)};return e.addListener(t),function(){return e.removeListener(t)}}}),[h,n,a]),(0,r.useMemo)((function(){return{colorMode:i,setColorMode:h,get isDarkTheme(){return i===d.dark},setLightTheme:function(){h(d.light)},setDarkTheme:function(){h(d.dark)}}}),[i,h])}();return r.createElement(s.Provider,{value:n},t)}function g(){var e=(0,r.useContext)(s);if(null==e)throw new o.i6("ColorModeProvider","Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.");return e}},373:(e,t,n)=>{"use strict";n.d(t,{J:()=>v,L5:()=>g});var r=n(7294),a=n(143),o=n(9935),i=n(6668),l=n(8425),s=n(9688),u=n(12),c=function(e){return"docs-preferred-version-"+e},d={save:function(e,t,n){(0,u.WA)(c(e),{persistence:t}).set(n)},read:function(e,t){return(0,u.WA)(c(e),{persistence:t}).get()},clear:function(e,t){(0,u.WA)(c(e),{persistence:t}).del()}},p=function(e){return Object.fromEntries(e.map((function(e){return[e,{preferredVersionName:null}]})))};var f=r.createContext(null);function m(){var e=(0,a._r)(),t=(0,i.L)().docs.versionPersistence,n=(0,r.useMemo)((function(){return Object.keys(e)}),[e]),o=(0,r.useState)((function(){return p(n)})),l=o[0],s=o[1];return(0,r.useEffect)((function(){s(function(e){var t=e.pluginIds,n=e.versionPersistence,r=e.allDocsData;return Object.fromEntries(t.map((function(e){return[e,(t=e,a=d.read(t,n),r[t].versions.some((function(e){return e.name===a}))?{preferredVersionName:a}:(d.clear(t,n),{preferredVersionName:null}))];var t,a})))}({allDocsData:e,versionPersistence:t,pluginIds:n}))}),[e,t,n]),[l,(0,r.useMemo)((function(){return{savePreferredVersion:function(e,n){d.save(e,t,n),s((function(t){var r;return Object.assign({},t,((r={})[e]={preferredVersionName:n},r))}))}}}),[t])]}function h(e){var t=e.children,n=m();return r.createElement(f.Provider,{value:n},t)}function g(e){var t=e.children;return l.cE?r.createElement(h,null,t):r.createElement(r.Fragment,null,t)}function b(){var e=(0,r.useContext)(f);if(!e)throw new s.i6("DocsPreferredVersionContextProvider");return e}function v(e){var t;void 0===e&&(e=o.m);var n=(0,a.zh)(e),i=b(),l=i[0],s=i[1],u=l[e].preferredVersionName;return{preferredVersion:null!=(t=n.versions.find((function(e){return e.name===u})))?t:null,savePreferredVersionName:(0,r.useCallback)((function(t){s.savePreferredVersion(e,t)}),[s,e])}}},1116:(e,t,n)=>{"use strict";n.d(t,{V:()=>s,b:()=>l});var r=n(7294),a=n(9688),o=Symbol("EmptyContext"),i=r.createContext(o);function l(e){var t=e.children,n=e.name,a=e.items,o=(0,r.useMemo)((function(){return n&&a?{name:n,items:a}:null}),[n,a]);return r.createElement(i.Provider,{value:o},t)}function s(){var e=(0,r.useContext)(i);if(e===o)throw new a.i6("DocsSidebarProvider");return e}},2961:(e,t,n)=>{"use strict";n.d(t,{M:()=>p,e:()=>f});var r=n(7294),a=n(3102),o=n(7524),i=n(6550),l=(n(1688),n(9688));function s(e){!function(e){var t=(0,i.k6)(),n=(0,l.zX)(e);(0,r.useEffect)((function(){return t.block((function(e,t){return n(e,t)}))}),[t,n])}((function(t,n){if("POP"===n)return e(t,n)}))}var u=n(6668),c=r.createContext(void 0);function d(){var e,t=(e=(0,a.HY)(),0===(0,u.L)().navbar.items.length&&!e.component),n=(0,o.i)(),i=!t&&"mobile"===n,l=(0,r.useState)(!1),c=l[0],d=l[1];s((function(){if(c)return d(!1),!1}));var p=(0,r.useCallback)((function(){d((function(e){return!e}))}),[]);return(0,r.useEffect)((function(){"desktop"===n&&d(!1)}),[n]),(0,r.useMemo)((function(){return{disabled:t,shouldRender:i,toggle:p,shown:c}}),[t,i,p,c])}function p(e){var t=e.children,n=d();return r.createElement(c.Provider,{value:n},t)}function f(){var e=r.useContext(c);if(void 0===e)throw new l.i6("NavbarMobileSidebarProvider");return e}},3102:(e,t,n)=>{"use strict";n.d(t,{HY:()=>l,Zo:()=>s,n2:()=>i});var r=n(7294),a=n(9688),o=r.createContext(null);function i(e){var t=e.children,n=(0,r.useState)({component:null,props:null});return r.createElement(o.Provider,{value:n},t)}function l(){var e=(0,r.useContext)(o);if(!e)throw new a.i6("NavbarSecondaryMenuContentProvider");return e[0]}function s(e){var t=e.component,n=e.props,i=(0,r.useContext)(o);if(!i)throw new a.i6("NavbarSecondaryMenuContentProvider");var l=i[1],s=(0,a.Ql)(n);return(0,r.useEffect)((function(){l({component:t,props:s})}),[l,t,s]),(0,r.useEffect)((function(){return function(){return l({component:null,props:null})}}),[l]),null}},9727:(e,t,n)=>{"use strict";n.d(t,{h:()=>a,t:()=>o});var r=n(7294),a="navigation-with-keyboard";function o(){(0,r.useEffect)((function(){function e(e){"keydown"===e.type&&"Tab"===e.key&&document.body.classList.add(a),"mousedown"===e.type&&document.body.classList.remove(a)}return document.addEventListener("keydown",e),document.addEventListener("mousedown",e),function(){document.body.classList.remove(a),document.removeEventListener("keydown",e),document.removeEventListener("mousedown",e)}}),[])}},7524:(e,t,n)=>{"use strict";n.d(t,{i:()=>u});var r=n(7294),a=n(412),o={desktop:"desktop",mobile:"mobile",ssr:"ssr"},i=996;function l(){return a.Z.canUseDOM?window.innerWidth>i?o.desktop:o.mobile:o.ssr}var s=!1;function u(){var e=(0,r.useState)((function(){return s?"ssr":l()})),t=e[0],n=e[1];return(0,r.useEffect)((function(){function e(){n(l())}var t=s?window.setTimeout(e,1e3):void 0;return window.addEventListener("resize",e),function(){window.removeEventListener("resize",e),clearTimeout(t)}}),[]),t}},5281:(e,t,n)=>{"use strict";n.d(t,{k:()=>r});var r={page:{blogListPage:"blog-list-page",blogPostPage:"blog-post-page",blogTagsListPage:"blog-tags-list-page",blogTagPostListPage:"blog-tags-post-list-page",docsDocPage:"docs-doc-page",docsTagsListPage:"docs-tags-list-page",docsTagDocListPage:"docs-tags-doc-list-page",mdxPage:"mdx-page"},wrapper:{main:"main-wrapper",blogPages:"blog-wrapper",docsPages:"docs-wrapper",mdxPages:"mdx-wrapper"},common:{editThisPage:"theme-edit-this-page",lastUpdated:"theme-last-updated",backToTopButton:"theme-back-to-top-button",codeBlock:"theme-code-block",admonition:"theme-admonition",admonitionType:function(e){return"theme-admonition-"+e}},layout:{},docs:{docVersionBanner:"theme-doc-version-banner",docVersionBadge:"theme-doc-version-badge",docBreadcrumbs:"theme-doc-breadcrumbs",docMarkdown:"theme-doc-markdown",docTocMobile:"theme-doc-toc-mobile",docTocDesktop:"theme-doc-toc-desktop",docFooter:"theme-doc-footer",docFooterTagsRow:"theme-doc-footer-tags-row",docFooterEditMetaRow:"theme-doc-footer-edit-meta-row",docSidebarContainer:"theme-doc-sidebar-container",docSidebarMenu:"theme-doc-sidebar-menu",docSidebarItemCategory:"theme-doc-sidebar-item-category",docSidebarItemLink:"theme-doc-sidebar-item-link",docSidebarItemCategoryLevel:function(e){return"theme-doc-sidebar-item-category-level-"+e},docSidebarItemLinkLevel:function(e){return"theme-doc-sidebar-item-link-level-"+e}},blog:{}}},1442:(e,t,n)=>{"use strict";function r(){return window.matchMedia("(prefers-reduced-motion: reduce)").matches}n.d(t,{n:()=>r})},8425:(e,t,n)=>{"use strict";function r(e,t){(null==t||t>e.length)&&(t=e.length);for(var n=0,r=new Array(t);n=e.length?{done:!0}:{done:!1,value:e[a++]}}}throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}n.d(t,{Wl:()=>m,_F:()=>b,cE:()=>f,hI:()=>E,lO:()=>w,vY:()=>k,oz:()=>S,s1:()=>y});var o=n(7294),i=n(6550),l=n(8790),s=n(143),u=n(373),c=n(1116);function d(e){return Array.from(new Set(e))}var p=n(8596),f=!!s._r;function m(e){if(e.href)return e.href;for(var t,n=a(e.items);!(t=n()).done;){var r=t.value;if("link"===r.type)return r.href;if("category"===r.type){var o=m(r);if(o)return o}}}var h=function(e,t){return void 0!==e&&(0,p.Mg)(e,t)},g=function(e,t){return e.some((function(e){return b(e,t)}))};function b(e,t){return"link"===e.type?h(e.href,t):"category"===e.type&&(h(e.href,t)||g(e.items,t))}function v(e){var t=e.sidebarItems,n=e.pathname,r=e.onlyCategories,o=void 0!==r&&r,i=[];return function e(t){for(var r,l=a(t);!(r=l()).done;){var s=r.value;if("category"===s.type&&((0,p.Mg)(s.href,n)||e(s.items))||"link"===s.type&&(0,p.Mg)(s.href,n))return o&&"category"!==s.type||i.unshift(s),!0}return!1}(t),i}function y(){var e,t=(0,c.V)(),n=(0,i.TH)().pathname;return!1!==(null==(e=(0,s.gA)())?void 0:e.pluginData.breadcrumbs)&&t?v({sidebarItems:t.items,pathname:n}):null}function w(e){var t=(0,s.Iw)(e).activeVersion,n=(0,u.J)(e).preferredVersion,r=(0,s.yW)(e);return(0,o.useMemo)((function(){return d([t,n,r].filter(Boolean))}),[t,n,r])}function S(e,t){var n=w(t);return(0,o.useMemo)((function(){var t=n.flatMap((function(e){return e.sidebars?Object.entries(e.sidebars):[]})),r=t.find((function(t){return t[0]===e}));if(!r)throw new Error("Can't find any sidebar with id \""+e+'" in version'+(n.length>1?"s":"")+" "+n.map((function(e){return e.name})).join(", ")+'".\nAvailable sidebar ids are:\n- '+t.map((function(e){return e[0]})).join("\n- "));return r[1]}),[e,n])}function k(e,t){var n=w(t);return(0,o.useMemo)((function(){var t=n.flatMap((function(e){return e.docs})),r=t.find((function(t){return t.id===e}));if(!r){if(n.flatMap((function(e){return e.draftIds})).includes(e))return null;throw new Error("Couldn't find any doc with id \""+e+'" in version'+(n.length>1?"s":"")+' "'+n.map((function(e){return e.name})).join(", ")+'".\nAvailable doc ids are:\n- '+d(t.map((function(e){return e.id}))).join("\n- "))}return r}),[e,n])}function E(e){var t=e.route,n=e.versionMetadata,r=(0,i.TH)(),a=t.routes,o=a.find((function(e){return(0,i.LX)(r.pathname,e)}));if(!o)return null;var s=o.sidebar,u=s?n.docsSidebars[s]:void 0;return{docElement:(0,l.H)(a),sidebarName:s,sidebarItems:u}}},1944:(e,t,n)=>{"use strict";n.d(t,{FG:()=>p,d:()=>c,VC:()=>f});var r=n(7294),a=n(6010),o=n(5742),i=n(226);function l(){var e=r.useContext(i._);if(!e)throw new Error("Unexpected: no Docusaurus route context found");return e}var s=n(4996),u=n(2263);function c(e){var t=e.title,n=e.description,a=e.keywords,i=e.image,l=e.children,c=function(e){var t=(0,u.Z)().siteConfig,n=t.title,r=t.titleDelimiter;return null!=e&&e.trim().length?e.trim()+" "+r+" "+n:n}(t),d=(0,s.C)().withBaseUrl,p=i?d(i,{absolute:!0}):void 0;return r.createElement(o.Z,null,t&&r.createElement("title",null,c),t&&r.createElement("meta",{property:"og:title",content:c}),n&&r.createElement("meta",{name:"description",content:n}),n&&r.createElement("meta",{property:"og:description",content:n}),a&&r.createElement("meta",{name:"keywords",content:Array.isArray(a)?a.join(","):a}),p&&r.createElement("meta",{property:"og:image",content:p}),p&&r.createElement("meta",{name:"twitter:image",content:p}),l)}var d=r.createContext(void 0);function p(e){var t=e.className,n=e.children,i=r.useContext(d),l=(0,a.Z)(i,t);return r.createElement(d.Provider,{value:l},r.createElement(o.Z,null,r.createElement("html",{className:l})),n)}function f(e){var t=e.children,n=l(),o="plugin-"+n.plugin.name.replace(/docusaurus-(?:plugin|theme)-(?:content-)?/gi,""),i="plugin-id-"+n.plugin.id;return r.createElement(p,{className:(0,a.Z)(o,i)},t)}},9688:(e,t,n)=>{"use strict";n.d(t,{i6:()=>f,Qc:()=>h,zX:()=>d,D9:()=>p,Ql:()=>m});var r=n(6528),a=n(4578);function o(e){return o=Object.setPrototypeOf?Object.getPrototypeOf.bind():function(e){return e.__proto__||Object.getPrototypeOf(e)},o(e)}var i=n(9611);function l(e,t,n){return l=function(){if("undefined"==typeof Reflect||!Reflect.construct)return!1;if(Reflect.construct.sham)return!1;if("function"==typeof Proxy)return!0;try{return Boolean.prototype.valueOf.call(Reflect.construct(Boolean,[],(function(){}))),!0}catch(e){return!1}}()?Reflect.construct.bind():function(e,t,n){var r=[null];r.push.apply(r,t);var a=new(Function.bind.apply(e,r));return n&&(0,i.Z)(a,n.prototype),a},l.apply(null,arguments)}function s(e){var t="function"==typeof Map?new Map:void 0;return s=function(e){if(null===e||!function(e){try{return-1!==Function.toString.call(e).indexOf("[native code]")}catch(t){return"function"==typeof e}}(e))return e;if("function"!=typeof e)throw new TypeError("Super expression must either be null or a function");if(void 0!==t){if(t.has(e))return t.get(e);t.set(e,n)}function n(){return l(e,arguments,o(this).constructor)}return n.prototype=Object.create(e.prototype,{constructor:{value:n,enumerable:!1,writable:!0,configurable:!0}}),(0,i.Z)(n,e)},s(e)}var u=n(7294),c=n(412).Z.canUseDOM?u.useLayoutEffect:u.useEffect;function d(e){var t=(0,u.useRef)(e);return c((function(){t.current=e}),[e]),(0,u.useCallback)((function(){return t.current.apply(t,arguments)}),[])}function p(e){var t=(0,u.useRef)();return c((function(){t.current=e})),t.current}var f=function(e){function t(t,n){var a,o,i;return(i=e.call(this)||this).name="ReactContextError",i.message="Hook "+(null!=(a=null==(o=i.stack)||null==(o=o.split("\n")[1])||null==(o=o.match((0,r.Z)(/at (?:\w+\.)?(\w+)/,{name:1})))?void 0:o.groups.name)?a:"")+" is called outside the <"+t+">. "+(null!=n?n:""),i}return(0,a.Z)(t,e),t}(s(Error));function m(e){var t=Object.entries(e);return t.sort((function(e,t){return e[0].localeCompare(t[0])})),(0,u.useMemo)((function(){return e}),t.flat())}function h(e){return function(t){var n=t.children;return u.createElement(u.Fragment,null,e.reduceRight((function(e,t){return u.createElement(t,null,e)}),n))}}},8596:(e,t,n)=>{"use strict";n.d(t,{Mg:()=>i,Ns:()=>l});var r=n(7294),a=n(723),o=n(2263);function i(e,t){var n=function(e){var t;return null==(t=!e||e.endsWith("/")?e:e+"/")?void 0:t.toLowerCase()};return n(e)===n(t)}function l(){var e=(0,o.Z)().siteConfig.baseUrl;return(0,r.useMemo)((function(){return function(e){var t=e.baseUrl;function n(e){return e.path===t&&!0===e.exact}function r(e){return e.path===t&&!e.exact}return function e(t){if(0!==t.length)return t.find(n)||e(t.filter(r).flatMap((function(e){var t;return null!=(t=e.routes)?t:[]})))}(e.routes)}({routes:a.Z,baseUrl:e})}),[e])}},2466:(e,t,n)=>{"use strict";n.d(t,{Ct:()=>p,OC:()=>s,RF:()=>d});var r=n(7294),a=n(412),o=n(2389),i=n(9688);var l=r.createContext(void 0);function s(e){var t,n=e.children,a=(t=(0,r.useRef)(!0),(0,r.useMemo)((function(){return{scrollEventsEnabledRef:t,enableScrollEvents:function(){t.current=!0},disableScrollEvents:function(){t.current=!1}}}),[]));return r.createElement(l.Provider,{value:a},n)}function u(){var e=(0,r.useContext)(l);if(null==e)throw new i.i6("ScrollControllerProvider");return e}var c=function(){return a.Z.canUseDOM?{scrollX:window.pageXOffset,scrollY:window.pageYOffset}:null};function d(e,t){void 0===t&&(t=[]);var n=u().scrollEventsEnabledRef,a=(0,r.useRef)(c()),o=(0,i.zX)(e);(0,r.useEffect)((function(){var e=function(){if(n.current){var e=c();o(e,a.current),a.current=e}},t={passive:!0};return e(),window.addEventListener("scroll",e,t),function(){return window.removeEventListener("scroll",e,t)}}),[o,n].concat(t))}function p(){var e=(0,r.useRef)(null),t=(0,o.Z)()&&"smooth"===getComputedStyle(document.documentElement).scrollBehavior;return{startScroll:function(n){e.current=t?function(e){return window.scrollTo({top:e,behavior:"smooth"}),function(){}}(n):function(e){var t=null,n=document.documentElement.scrollTop>e;return function r(){var a=document.documentElement.scrollTop;(n&&a>e||!n&&a{"use strict";n.d(t,{HX:()=>r,os:()=>a});n(2263);var r="default";function a(e,t){return"docs-"+e+"-"+t}},12:(e,t,n)=>{"use strict";n.d(t,{WA:()=>s});n(7294),n(1688);var r="localStorage";function a(e){var t=e.key,n=e.oldValue,r=e.newValue,a=e.storage;if(n!==r){var o=document.createEvent("StorageEvent");o.initStorageEvent("storage",!1,!1,t,n,r,window.location.href,a),window.dispatchEvent(o)}}function o(e){if(void 0===e&&(e=r),"undefined"==typeof window)throw new Error("Browser storage is not available on Node.js/Docusaurus SSR process.");if("none"===e)return null;try{return window[e]}catch(n){return t=n,i||(console.warn("Docusaurus browser storage is not available.\nPossible reasons: running Docusaurus in an iframe, in an incognito browser session, or using too strict browser privacy settings.",t),i=!0),null}var t}var i=!1;var l={get:function(){return null},set:function(){},del:function(){},listen:function(){return function(){}}};function s(e,t){if("undefined"==typeof window)return function(e){function t(){throw new Error('Illegal storage API usage for storage key "'+e+'".\nDocusaurus storage APIs are not supposed to be called on the server-rendering process.\nPlease only call storage APIs in effects and event handlers.')}return{get:t,set:t,del:t,listen:t}}(e);var n=o(null==t?void 0:t.persistence);return null===n?l:{get:function(){try{return n.getItem(e)}catch(t){return console.error("Docusaurus storage error, can't get key="+e,t),null}},set:function(t){try{var r=n.getItem(e);n.setItem(e,t),a({key:e,oldValue:r,newValue:t,storage:n})}catch(o){console.error("Docusaurus storage error, can't set "+e+"="+t,o)}},del:function(){try{var t=n.getItem(e);n.removeItem(e),a({key:e,oldValue:t,newValue:null,storage:n})}catch(r){console.error("Docusaurus storage error, can't delete key="+e,r)}},listen:function(t){try{var r=function(r){r.storageArea===n&&r.key===e&&t(r)};return window.addEventListener("storage",r),function(){return window.removeEventListener("storage",r)}}catch(a){return console.error("Docusaurus storage error, can't listen for changes of key="+e,a),function(){}}}}}},4711:(e,t,n)=>{"use strict";n.d(t,{l:()=>i});var r=n(2263),a=n(6550),o=n(8780);function i(){var e=(0,r.Z)(),t=e.siteConfig,n=t.baseUrl,i=t.url,l=t.trailingSlash,s=e.i18n,u=s.defaultLocale,c=s.currentLocale,d=(0,a.TH)().pathname,p=(0,o.applyTrailingSlash)(d,{trailingSlash:l,baseUrl:n}),f=c===u?n:n.replace("/"+c+"/","/"),m=p.replace(n,"");return{createUrl:function(e){var t=e.locale;return""+(e.fullyQualified?i:"")+function(e){return e===u?""+f:""+f+e+"/"}(t)+m}}}},5936:(e,t,n)=>{"use strict";n.d(t,{S:()=>i});var r=n(7294),a=n(6550),o=n(9688);function i(e){var t=(0,a.TH)(),n=(0,o.D9)(t),i=(0,o.zX)(e);(0,r.useEffect)((function(){n&&t!==n&&i({location:t,previousLocation:n})}),[i,t,n])}},6668:(e,t,n)=>{"use strict";n.d(t,{L:()=>a});var r=n(2263);function a(){return(0,r.Z)().siteConfig.themeConfig}},8802:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.default=function(e,t){var n=t.trailingSlash,r=t.baseUrl;if(e.startsWith("#"))return e;if(void 0===n)return e;var a,o=e.split(/[#?]/)[0],i="/"===o||o===r?o:(a=o,n?function(e){return e.endsWith("/")?e:e+"/"}(a):function(e){return e.endsWith("/")?e.slice(0,-1):e}(a));return e.replace(o,i)}},4143:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=void 0,t.getErrorCausalChain=function e(t){return t.cause?[t].concat(e(t.cause)):[t]}},8780:function(e,t,n){"use strict";var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=t.applyTrailingSlash=t.blogPostContainerID=void 0,t.blogPostContainerID="__blog-post-container";var a=n(8802);Object.defineProperty(t,"applyTrailingSlash",{enumerable:!0,get:function(){return r(a).default}});var o=n(4143);Object.defineProperty(t,"getErrorCausalChain",{enumerable:!0,get:function(){return o.getErrorCausalChain}})},6010:(e,t,n)=>{"use strict";function r(e){var t,n,a="";if("string"==typeof e||"number"==typeof e)a+=e;else if("object"==typeof e)if(Array.isArray(e))for(t=0;ta});const a=function(){for(var e,t,n=0,a="";n{"use strict";n.d(t,{lX:()=>E,q_:()=>A,ob:()=>h,PP:()=>R,Ep:()=>m,Hp:()=>g});var r=n(7462);function a(e){return"/"===e.charAt(0)}function o(e,t){for(var n=t,r=n+1,a=e.length;r=0;p--){var f=i[p];"."===f?o(i,p):".."===f?(o(i,p),d++):d&&(o(i,p),d--)}if(!u)for(;d--;d)i.unshift("..");!u||""===i[0]||i[0]&&a(i[0])||i.unshift("");var m=i.join("/");return n&&"/"!==m.substr(-1)&&(m+="/"),m};function l(e){return e.valueOf?e.valueOf():Object.prototype.valueOf.call(e)}const s=function e(t,n){if(t===n)return!0;if(null==t||null==n)return!1;if(Array.isArray(t))return Array.isArray(n)&&t.length===n.length&&t.every((function(t,r){return e(t,n[r])}));if("object"==typeof t||"object"==typeof n){var r=l(t),a=l(n);return r!==t||a!==n?e(r,a):Object.keys(Object.assign({},t,n)).every((function(r){return e(t[r],n[r])}))}return!1};var u=n(8776);function c(e){return"/"===e.charAt(0)?e:"/"+e}function d(e){return"/"===e.charAt(0)?e.substr(1):e}function p(e,t){return function(e,t){return 0===e.toLowerCase().indexOf(t.toLowerCase())&&-1!=="/?#".indexOf(e.charAt(t.length))}(e,t)?e.substr(t.length):e}function f(e){return"/"===e.charAt(e.length-1)?e.slice(0,-1):e}function m(e){var t=e.pathname,n=e.search,r=e.hash,a=t||"/";return n&&"?"!==n&&(a+="?"===n.charAt(0)?n:"?"+n),r&&"#"!==r&&(a+="#"===r.charAt(0)?r:"#"+r),a}function h(e,t,n,a){var o;"string"==typeof e?(o=function(e){var t=e||"/",n="",r="",a=t.indexOf("#");-1!==a&&(r=t.substr(a),t=t.substr(0,a));var o=t.indexOf("?");return-1!==o&&(n=t.substr(o),t=t.substr(0,o)),{pathname:t,search:"?"===n?"":n,hash:"#"===r?"":r}}(e),o.state=t):(void 0===(o=(0,r.Z)({},e)).pathname&&(o.pathname=""),o.search?"?"!==o.search.charAt(0)&&(o.search="?"+o.search):o.search="",o.hash?"#"!==o.hash.charAt(0)&&(o.hash="#"+o.hash):o.hash="",void 0!==t&&void 0===o.state&&(o.state=t));try{o.pathname=decodeURI(o.pathname)}catch(l){throw l instanceof URIError?new URIError('Pathname "'+o.pathname+'" could not be decoded. This is likely caused by an invalid percent-encoding.'):l}return n&&(o.key=n),a?o.pathname?"/"!==o.pathname.charAt(0)&&(o.pathname=i(o.pathname,a.pathname)):o.pathname=a.pathname:o.pathname||(o.pathname="/"),o}function g(e,t){return e.pathname===t.pathname&&e.search===t.search&&e.hash===t.hash&&e.key===t.key&&s(e.state,t.state)}function b(){var e=null;var t=[];return{setPrompt:function(t){return e=t,function(){e===t&&(e=null)}},confirmTransitionTo:function(t,n,r,a){if(null!=e){var o="function"==typeof e?e(t,n):e;"string"==typeof o?"function"==typeof r?r(o,a):a(!0):a(!1!==o)}else a(!0)},appendListener:function(e){var n=!0;function r(){n&&e.apply(void 0,arguments)}return t.push(r),function(){n=!1,t=t.filter((function(e){return e!==r}))}},notifyListeners:function(){for(var e=arguments.length,n=new Array(e),r=0;rt?n.splice(t,n.length-t,a):n.push(a),d({action:r,location:a,index:t,entries:n})}}))},replace:function(e,t){var r="REPLACE",a=h(e,t,p(),w.location);c.confirmTransitionTo(a,r,n,(function(e){e&&(w.entries[w.index]=a,d({action:r,location:a}))}))},go:y,goBack:function(){y(-1)},goForward:function(){y(1)},canGo:function(e){var t=w.index+e;return t>=0&&t{"use strict";var r=n(9864),a={childContextTypes:!0,contextType:!0,contextTypes:!0,defaultProps:!0,displayName:!0,getDefaultProps:!0,getDerivedStateFromError:!0,getDerivedStateFromProps:!0,mixins:!0,propTypes:!0,type:!0},o={name:!0,length:!0,prototype:!0,caller:!0,callee:!0,arguments:!0,arity:!0},i={$$typeof:!0,compare:!0,defaultProps:!0,displayName:!0,propTypes:!0,type:!0},l={};function s(e){return r.isMemo(e)?i:l[e.$$typeof]||a}l[r.ForwardRef]={$$typeof:!0,render:!0,defaultProps:!0,displayName:!0,propTypes:!0},l[r.Memo]=i;var u=Object.defineProperty,c=Object.getOwnPropertyNames,d=Object.getOwnPropertySymbols,p=Object.getOwnPropertyDescriptor,f=Object.getPrototypeOf,m=Object.prototype;e.exports=function e(t,n,r){if("string"!=typeof n){if(m){var a=f(n);a&&a!==m&&e(t,a,r)}var i=c(n);d&&(i=i.concat(d(n)));for(var l=s(t),h=s(n),g=0;g{"use strict";e.exports=function(e,t,n,r,a,o,i,l){if(!e){var s;if(void 0===t)s=new Error("Minified exception occurred; use the non-minified dev environment for the full error message and additional helpful warnings.");else{var u=[n,r,a,o,i,l],c=0;(s=new Error(t.replace(/%s/g,(function(){return u[c++]})))).name="Invariant Violation"}throw s.framesToPop=1,s}}},2497:(e,t,n)=>{"use strict";n.r(t)},2295:(e,t,n)=>{"use strict";n.r(t)},4865:function(e,t,n){var r,a;r=function(){var e,t,n={version:"0.2.0"},r=n.settings={minimum:.08,easing:"ease",positionUsing:"",speed:200,trickle:!0,trickleRate:.02,trickleSpeed:800,showSpinner:!0,barSelector:'[role="bar"]',spinnerSelector:'[role="spinner"]',parent:"body",template:'
    '};function a(e,t,n){return en?n:e}function o(e){return 100*(-1+e)}function i(e,t,n){var a;return(a="translate3d"===r.positionUsing?{transform:"translate3d("+o(e)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+o(e)+"%,0)"}:{"margin-left":o(e)+"%"}).transition="all "+t+"ms "+n,a}n.configure=function(e){var t,n;for(t in e)void 0!==(n=e[t])&&e.hasOwnProperty(t)&&(r[t]=n);return this},n.status=null,n.set=function(e){var t=n.isStarted();e=a(e,r.minimum,1),n.status=1===e?null:e;var o=n.render(!t),u=o.querySelector(r.barSelector),c=r.speed,d=r.easing;return o.offsetWidth,l((function(t){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),s(u,i(e,c,d)),1===e?(s(o,{transition:"none",opacity:1}),o.offsetWidth,setTimeout((function(){s(o,{transition:"all "+c+"ms linear",opacity:0}),setTimeout((function(){n.remove(),t()}),c)}),c)):setTimeout(t,c)})),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var e=function(){setTimeout((function(){n.status&&(n.trickle(),e())}),r.trickleSpeed)};return r.trickle&&e(),this},n.done=function(e){return e||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(e){var t=n.status;return t?("number"!=typeof e&&(e=(1-t)*a(Math.random()*t,.1,.95)),t=a(t+e,0,.994),n.set(t)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},e=0,t=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===t&&n.start(),e++,t++,r.always((function(){0==--t?(e=0,n.done()):n.set((e-t)/e)})),this):this},n.render=function(e){if(n.isRendered())return document.getElementById("nprogress");c(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=r.template;var a,i=t.querySelector(r.barSelector),l=e?"-100":o(n.status||0),u=document.querySelector(r.parent);return s(i,{transition:"all 0 linear",transform:"translate3d("+l+"%,0,0)"}),r.showSpinner||(a=t.querySelector(r.spinnerSelector))&&f(a),u!=document.body&&c(u,"nprogress-custom-parent"),u.appendChild(t),t},n.remove=function(){d(document.documentElement,"nprogress-busy"),d(document.querySelector(r.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&f(e)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var l=function(){var e=[];function t(){var n=e.shift();n&&n(t)}return function(n){e.push(n),1==e.length&&t()}}(),s=function(){var e=["Webkit","O","Moz","ms"],t={};function n(e){return e.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(e,t){return t.toUpperCase()}))}function r(t){var n=document.body.style;if(t in n)return t;for(var r,a=e.length,o=t.charAt(0).toUpperCase()+t.slice(1);a--;)if((r=e[a]+o)in n)return r;return t}function a(e){return e=n(e),t[e]||(t[e]=r(e))}function o(e,t,n){t=a(t),e.style[t]=n}return function(e,t){var n,r,a=arguments;if(2==a.length)for(n in t)void 0!==(r=t[n])&&t.hasOwnProperty(n)&&o(e,n,r);else o(e,a[1],a[2])}}();function u(e,t){return("string"==typeof e?e:p(e)).indexOf(" "+t+" ")>=0}function c(e,t){var n=p(e),r=n+t;u(n,t)||(e.className=r.substring(1))}function d(e,t){var n,r=p(e);u(e,t)&&(n=r.replace(" "+t+" "," "),e.className=n.substring(1,n.length-1))}function p(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function f(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return n},void 0===(a="function"==typeof r?r.call(t,n,t,e):r)||(e.exports=a)},7418:e=>{"use strict";var t=Object.getOwnPropertySymbols,n=Object.prototype.hasOwnProperty,r=Object.prototype.propertyIsEnumerable;e.exports=function(){try{if(!Object.assign)return!1;var e=new String("abc");if(e[5]="de","5"===Object.getOwnPropertyNames(e)[0])return!1;for(var t={},n=0;n<10;n++)t["_"+String.fromCharCode(n)]=n;if("0123456789"!==Object.getOwnPropertyNames(t).map((function(e){return t[e]})).join(""))return!1;var r={};return"abcdefghijklmnopqrst".split("").forEach((function(e){r[e]=e})),"abcdefghijklmnopqrst"===Object.keys(Object.assign({},r)).join("")}catch(a){return!1}}()?Object.assign:function(e,a){for(var o,i,l=function(e){if(null==e)throw new TypeError("Object.assign cannot be called with null or undefined");return Object(e)}(e),s=1;s{"use strict";n.d(t,{Z:()=>o});var r=function(){var e=/(?:^|\s)lang(?:uage)?-([\w-]+)(?=\s|$)/i,t=0,n={},r={util:{encode:function e(t){return t instanceof a?new a(t.type,e(t.content),t.alias):Array.isArray(t)?t.map(e):t.replace(/&/g,"&").replace(/=d.reach);E+=k.value.length,k=k.next){var _=k.value;if(t.length>e.length)return;if(!(_ instanceof a)){var x,T=1;if(v){if(!(x=o(S,E,e,b))||x.index>=e.length)break;var C=x.index,P=x.index+x[0].length,A=E;for(A+=k.value.length;C>=A;)A+=(k=k.next).value.length;if(E=A-=k.value.length,k.value instanceof a)continue;for(var L=k;L!==t.tail&&(Ad.reach&&(d.reach=I);var M=k.prev;if(O&&(M=s(t,M,O),E+=O.length),u(t,M,T),k=s(t,M,new a(p,g?r.tokenize(R,g):R,y,R)),N&&s(t,k,N),T>1){var D={cause:p+","+m,reach:I};i(e,t,n,k.prev,E,D),d&&D.reach>d.reach&&(d.reach=D.reach)}}}}}}function l(){var e={value:null,prev:null,next:null},t={value:null,prev:e,next:null};e.next=t,this.head=e,this.tail=t,this.length=0}function s(e,t,n){var r=t.next,a={value:n,prev:t,next:r};return t.next=a,r.prev=a,e.length++,a}function u(e,t,n){for(var r=t.next,a=0;a"+o.content+""},r}(),a=r;r.default=r,a.languages.markup={comment:{pattern://,greedy:!0},prolog:{pattern:/<\?[\s\S]+?\?>/,greedy:!0},doctype:{pattern:/"'[\]]|"[^"]*"|'[^']*')+(?:\[(?:[^<"'\]]|"[^"]*"|'[^']*'|<(?!!--)|)*\]\s*)?>/i,greedy:!0,inside:{"internal-subset":{pattern:/(^[^\[]*\[)[\s\S]+(?=\]>$)/,lookbehind:!0,greedy:!0,inside:null},string:{pattern:/"[^"]*"|'[^']*'/,greedy:!0},punctuation:/^$|[[\]]/,"doctype-tag":/^DOCTYPE/i,name:/[^\s<>'"]+/}},cdata:{pattern://i,greedy:!0},tag:{pattern:/<\/?(?!\d)[^\s>\/=$<%]+(?:\s(?:\s*[^\s>\/=]+(?:\s*=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+(?=[\s>]))|(?=[\s/>])))+)?\s*\/?>/,greedy:!0,inside:{tag:{pattern:/^<\/?[^\s>\/]+/,inside:{punctuation:/^<\/?/,namespace:/^[^\s>\/:]+:/}},"special-attr":[],"attr-value":{pattern:/=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+)/,inside:{punctuation:[{pattern:/^=/,alias:"attr-equals"},/"|'/]}},punctuation:/\/?>/,"attr-name":{pattern:/[^\s>\/]+/,inside:{namespace:/^[^\s>\/:]+:/}}}},entity:[{pattern:/&[\da-z]{1,8};/i,alias:"named-entity"},/&#x?[\da-f]{1,8};/i]},a.languages.markup.tag.inside["attr-value"].inside.entity=a.languages.markup.entity,a.languages.markup.doctype.inside["internal-subset"].inside=a.languages.markup,a.hooks.add("wrap",(function(e){"entity"===e.type&&(e.attributes.title=e.content.replace(/&/,"&"))})),Object.defineProperty(a.languages.markup.tag,"addInlined",{value:function(e,t){var n={};n["language-"+t]={pattern:/(^$)/i,lookbehind:!0,inside:a.languages[t]},n.cdata=/^$/i;var r={"included-cdata":{pattern://i,inside:n}};r["language-"+t]={pattern:/[\s\S]+/,inside:a.languages[t]};var o={};o[e]={pattern:RegExp(/(<__[^>]*>)(?:))*\]\]>|(?!)/.source.replace(/__/g,(function(){return e})),"i"),lookbehind:!0,greedy:!0,inside:r},a.languages.insertBefore("markup","cdata",o)}}),Object.defineProperty(a.languages.markup.tag,"addAttribute",{value:function(e,t){a.languages.markup.tag.inside["special-attr"].push({pattern:RegExp(/(^|["'\s])/.source+"(?:"+e+")"+/\s*=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+(?=[\s>]))/.source,"i"),lookbehind:!0,inside:{"attr-name":/^[^\s=]+/,"attr-value":{pattern:/=[\s\S]+/,inside:{value:{pattern:/(^=\s*(["']|(?!["'])))\S[\s\S]*(?=\2$)/,lookbehind:!0,alias:[t,"language-"+t],inside:a.languages[t]},punctuation:[{pattern:/^=/,alias:"attr-equals"},/"|'/]}}}})}}),a.languages.html=a.languages.markup,a.languages.mathml=a.languages.markup,a.languages.svg=a.languages.markup,a.languages.xml=a.languages.extend("markup",{}),a.languages.ssml=a.languages.xml,a.languages.atom=a.languages.xml,a.languages.rss=a.languages.xml,function(e){var t="\\b(?:BASH|BASHOPTS|BASH_ALIASES|BASH_ARGC|BASH_ARGV|BASH_CMDS|BASH_COMPLETION_COMPAT_DIR|BASH_LINENO|BASH_REMATCH|BASH_SOURCE|BASH_VERSINFO|BASH_VERSION|COLORTERM|COLUMNS|COMP_WORDBREAKS|DBUS_SESSION_BUS_ADDRESS|DEFAULTS_PATH|DESKTOP_SESSION|DIRSTACK|DISPLAY|EUID|GDMSESSION|GDM_LANG|GNOME_KEYRING_CONTROL|GNOME_KEYRING_PID|GPG_AGENT_INFO|GROUPS|HISTCONTROL|HISTFILE|HISTFILESIZE|HISTSIZE|HOME|HOSTNAME|HOSTTYPE|IFS|INSTANCE|JOB|LANG|LANGUAGE|LC_ADDRESS|LC_ALL|LC_IDENTIFICATION|LC_MEASUREMENT|LC_MONETARY|LC_NAME|LC_NUMERIC|LC_PAPER|LC_TELEPHONE|LC_TIME|LESSCLOSE|LESSOPEN|LINES|LOGNAME|LS_COLORS|MACHTYPE|MAILCHECK|MANDATORY_PATH|NO_AT_BRIDGE|OLDPWD|OPTERR|OPTIND|ORBIT_SOCKETDIR|OSTYPE|PAPERSIZE|PATH|PIPESTATUS|PPID|PS1|PS2|PS3|PS4|PWD|RANDOM|REPLY|SECONDS|SELINUX_INIT|SESSION|SESSIONTYPE|SESSION_MANAGER|SHELL|SHELLOPTS|SHLVL|SSH_AUTH_SOCK|TERM|UID|UPSTART_EVENTS|UPSTART_INSTANCE|UPSTART_JOB|UPSTART_SESSION|USER|WINDOWID|XAUTHORITY|XDG_CONFIG_DIRS|XDG_CURRENT_DESKTOP|XDG_DATA_DIRS|XDG_GREETER_DATA_DIR|XDG_MENU_PREFIX|XDG_RUNTIME_DIR|XDG_SEAT|XDG_SEAT_PATH|XDG_SESSION_DESKTOP|XDG_SESSION_ID|XDG_SESSION_PATH|XDG_SESSION_TYPE|XDG_VTNR|XMODIFIERS)\\b",n={pattern:/(^(["']?)\w+\2)[ \t]+\S.*/,lookbehind:!0,alias:"punctuation",inside:null},r={bash:n,environment:{pattern:RegExp("\\$"+t),alias:"constant"},variable:[{pattern:/\$?\(\([\s\S]+?\)\)/,greedy:!0,inside:{variable:[{pattern:/(^\$\(\([\s\S]+)\)\)/,lookbehind:!0},/^\$\(\(/],number:/\b0x[\dA-Fa-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:[Ee]-?\d+)?/,operator:/--|\+\+|\*\*=?|<<=?|>>=?|&&|\|\||[=!+\-*/%<>^&|]=?|[?~:]/,punctuation:/\(\(?|\)\)?|,|;/}},{pattern:/\$\((?:\([^)]+\)|[^()])+\)|`[^`]+`/,greedy:!0,inside:{variable:/^\$\(|^`|\)$|`$/}},{pattern:/\$\{[^}]+\}/,greedy:!0,inside:{operator:/:[-=?+]?|[!\/]|##?|%%?|\^\^?|,,?/,punctuation:/[\[\]]/,environment:{pattern:RegExp("(\\{)"+t),lookbehind:!0,alias:"constant"}}},/\$(?:\w+|[#?*!@$])/],entity:/\\(?:[abceEfnrtv\\"]|O?[0-7]{1,3}|U[0-9a-fA-F]{8}|u[0-9a-fA-F]{4}|x[0-9a-fA-F]{1,2})/};e.languages.bash={shebang:{pattern:/^#!\s*\/.*/,alias:"important"},comment:{pattern:/(^|[^"{\\$])#.*/,lookbehind:!0},"function-name":[{pattern:/(\bfunction\s+)[\w-]+(?=(?:\s*\(?:\s*\))?\s*\{)/,lookbehind:!0,alias:"function"},{pattern:/\b[\w-]+(?=\s*\(\s*\)\s*\{)/,alias:"function"}],"for-or-select":{pattern:/(\b(?:for|select)\s+)\w+(?=\s+in\s)/,alias:"variable",lookbehind:!0},"assign-left":{pattern:/(^|[\s;|&]|[<>]\()\w+(?=\+?=)/,inside:{environment:{pattern:RegExp("(^|[\\s;|&]|[<>]\\()"+t),lookbehind:!0,alias:"constant"}},alias:"variable",lookbehind:!0},string:[{pattern:/((?:^|[^<])<<-?\s*)(\w+)\s[\s\S]*?(?:\r?\n|\r)\2/,lookbehind:!0,greedy:!0,inside:r},{pattern:/((?:^|[^<])<<-?\s*)(["'])(\w+)\2\s[\s\S]*?(?:\r?\n|\r)\3/,lookbehind:!0,greedy:!0,inside:{bash:n}},{pattern:/(^|[^\\](?:\\\\)*)"(?:\\[\s\S]|\$\([^)]+\)|\$(?!\()|`[^`]+`|[^"\\`$])*"/,lookbehind:!0,greedy:!0,inside:r},{pattern:/(^|[^$\\])'[^']*'/,lookbehind:!0,greedy:!0},{pattern:/\$'(?:[^'\\]|\\[\s\S])*'/,greedy:!0,inside:{entity:r.entity}}],environment:{pattern:RegExp("\\$?"+t),alias:"constant"},variable:r.variable,function:{pattern:/(^|[\s;|&]|[<>]\()(?:add|apropos|apt|apt-cache|apt-get|aptitude|aspell|automysqlbackup|awk|basename|bash|bc|bconsole|bg|bzip2|cal|cat|cfdisk|chgrp|chkconfig|chmod|chown|chroot|cksum|clear|cmp|column|comm|composer|cp|cron|crontab|csplit|curl|cut|date|dc|dd|ddrescue|debootstrap|df|diff|diff3|dig|dir|dircolors|dirname|dirs|dmesg|docker|docker-compose|du|egrep|eject|env|ethtool|expand|expect|expr|fdformat|fdisk|fg|fgrep|file|find|fmt|fold|format|free|fsck|ftp|fuser|gawk|git|gparted|grep|groupadd|groupdel|groupmod|groups|grub-mkconfig|gzip|halt|head|hg|history|host|hostname|htop|iconv|id|ifconfig|ifdown|ifup|import|install|ip|jobs|join|kill|killall|less|link|ln|locate|logname|logrotate|look|lpc|lpr|lprint|lprintd|lprintq|lprm|ls|lsof|lynx|make|man|mc|mdadm|mkconfig|mkdir|mke2fs|mkfifo|mkfs|mkisofs|mknod|mkswap|mmv|more|most|mount|mtools|mtr|mutt|mv|nano|nc|netstat|nice|nl|node|nohup|notify-send|npm|nslookup|op|open|parted|passwd|paste|pathchk|ping|pkill|pnpm|podman|podman-compose|popd|pr|printcap|printenv|ps|pushd|pv|quota|quotacheck|quotactl|ram|rar|rcp|reboot|remsync|rename|renice|rev|rm|rmdir|rpm|rsync|scp|screen|sdiff|sed|sendmail|seq|service|sftp|sh|shellcheck|shuf|shutdown|sleep|slocate|sort|split|ssh|stat|strace|su|sudo|sum|suspend|swapon|sync|tac|tail|tar|tee|time|timeout|top|touch|tr|traceroute|tsort|tty|umount|uname|unexpand|uniq|units|unrar|unshar|unzip|update-grub|uptime|useradd|userdel|usermod|users|uudecode|uuencode|v|vcpkg|vdir|vi|vim|virsh|vmstat|wait|watch|wc|wget|whereis|which|who|whoami|write|xargs|xdg-open|yarn|yes|zenity|zip|zsh|zypper)(?=$|[)\s;|&])/,lookbehind:!0},keyword:{pattern:/(^|[\s;|&]|[<>]\()(?:case|do|done|elif|else|esac|fi|for|function|if|in|select|then|until|while)(?=$|[)\s;|&])/,lookbehind:!0},builtin:{pattern:/(^|[\s;|&]|[<>]\()(?:\.|:|alias|bind|break|builtin|caller|cd|command|continue|declare|echo|enable|eval|exec|exit|export|getopts|hash|help|let|local|logout|mapfile|printf|pwd|read|readarray|readonly|return|set|shift|shopt|source|test|times|trap|type|typeset|ulimit|umask|unalias|unset)(?=$|[)\s;|&])/,lookbehind:!0,alias:"class-name"},boolean:{pattern:/(^|[\s;|&]|[<>]\()(?:false|true)(?=$|[)\s;|&])/,lookbehind:!0},"file-descriptor":{pattern:/\B&\d\b/,alias:"important"},operator:{pattern:/\d?<>|>\||\+=|=[=~]?|!=?|<<[<-]?|[&\d]?>>|\d[<>]&?|[<>][&=]?|&[>&]?|\|[&|]?/,inside:{"file-descriptor":{pattern:/^\d/,alias:"important"}}},punctuation:/\$?\(\(?|\)\)?|\.\.|[{}[\];\\]/,number:{pattern:/(^|\s)(?:[1-9]\d*|0)(?:[.,]\d+)?\b/,lookbehind:!0}},n.inside=e.languages.bash;for(var a=["comment","function-name","for-or-select","assign-left","string","environment","function","keyword","builtin","boolean","file-descriptor","operator","punctuation","number"],o=r.variable[1].inside,i=0;i]=?|[!=]=?=?|--?|\+\+?|&&?|\|\|?|[?*/~^%]/,punctuation:/[{}[\];(),.:]/},a.languages.c=a.languages.extend("clike",{comment:{pattern:/\/\/(?:[^\r\n\\]|\\(?:\r\n?|\n|(?![\r\n])))*|\/\*[\s\S]*?(?:\*\/|$)/,greedy:!0},string:{pattern:/"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"/,greedy:!0},"class-name":{pattern:/(\b(?:enum|struct)\s+(?:__attribute__\s*\(\([\s\S]*?\)\)\s*)?)\w+|\b[a-z]\w*_t\b/,lookbehind:!0},keyword:/\b(?:_Alignas|_Alignof|_Atomic|_Bool|_Complex|_Generic|_Imaginary|_Noreturn|_Static_assert|_Thread_local|__attribute__|asm|auto|break|case|char|const|continue|default|do|double|else|enum|extern|float|for|goto|if|inline|int|long|register|return|short|signed|sizeof|static|struct|switch|typedef|typeof|union|unsigned|void|volatile|while)\b/,function:/\b[a-z_]\w*(?=\s*\()/i,number:/(?:\b0x(?:[\da-f]+(?:\.[\da-f]*)?|\.[\da-f]+)(?:p[+-]?\d+)?|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:e[+-]?\d+)?)[ful]{0,4}/i,operator:/>>=?|<<=?|->|([-+&|:])\1|[?:~]|[-+*/%&|^!=<>]=?/}),a.languages.insertBefore("c","string",{char:{pattern:/'(?:\\(?:\r\n|[\s\S])|[^'\\\r\n]){0,32}'/,greedy:!0}}),a.languages.insertBefore("c","string",{macro:{pattern:/(^[\t ]*)#\s*[a-z](?:[^\r\n\\/]|\/(?!\*)|\/\*(?:[^*]|\*(?!\/))*\*\/|\\(?:\r\n|[\s\S]))*/im,lookbehind:!0,greedy:!0,alias:"property",inside:{string:[{pattern:/^(#\s*include\s*)<[^>]+>/,lookbehind:!0},a.languages.c.string],char:a.languages.c.char,comment:a.languages.c.comment,"macro-name":[{pattern:/(^#\s*define\s+)\w+\b(?!\()/i,lookbehind:!0},{pattern:/(^#\s*define\s+)\w+\b(?=\()/i,lookbehind:!0,alias:"function"}],directive:{pattern:/^(#\s*)[a-z]+/,lookbehind:!0,alias:"keyword"},"directive-hash":/^#/,punctuation:/##|\\(?=[\r\n])/,expression:{pattern:/\S[\s\S]*/,inside:a.languages.c}}}}),a.languages.insertBefore("c","function",{constant:/\b(?:EOF|NULL|SEEK_CUR|SEEK_END|SEEK_SET|__DATE__|__FILE__|__LINE__|__TIMESTAMP__|__TIME__|__func__|stderr|stdin|stdout)\b/}),delete a.languages.c.boolean,function(e){var t=/\b(?:alignas|alignof|asm|auto|bool|break|case|catch|char|char16_t|char32_t|char8_t|class|co_await|co_return|co_yield|compl|concept|const|const_cast|consteval|constexpr|constinit|continue|decltype|default|delete|do|double|dynamic_cast|else|enum|explicit|export|extern|final|float|for|friend|goto|if|import|inline|int|int16_t|int32_t|int64_t|int8_t|long|module|mutable|namespace|new|noexcept|nullptr|operator|override|private|protected|public|register|reinterpret_cast|requires|return|short|signed|sizeof|static|static_assert|static_cast|struct|switch|template|this|thread_local|throw|try|typedef|typeid|typename|uint16_t|uint32_t|uint64_t|uint8_t|union|unsigned|using|virtual|void|volatile|wchar_t|while)\b/,n=/\b(?!)\w+(?:\s*\.\s*\w+)*\b/.source.replace(//g,(function(){return t.source}));e.languages.cpp=e.languages.extend("c",{"class-name":[{pattern:RegExp(/(\b(?:class|concept|enum|struct|typename)\s+)(?!)\w+/.source.replace(//g,(function(){return t.source}))),lookbehind:!0},/\b[A-Z]\w*(?=\s*::\s*\w+\s*\()/,/\b[A-Z_]\w*(?=\s*::\s*~\w+\s*\()/i,/\b\w+(?=\s*<(?:[^<>]|<(?:[^<>]|<[^<>]*>)*>)*>\s*::\s*\w+\s*\()/],keyword:t,number:{pattern:/(?:\b0b[01']+|\b0x(?:[\da-f']+(?:\.[\da-f']*)?|\.[\da-f']+)(?:p[+-]?[\d']+)?|(?:\b[\d']+(?:\.[\d']*)?|\B\.[\d']+)(?:e[+-]?[\d']+)?)[ful]{0,4}/i,greedy:!0},operator:/>>=?|<<=?|->|--|\+\+|&&|\|\||[?:~]|<=>|[-+*/%&|^!=<>]=?|\b(?:and|and_eq|bitand|bitor|not|not_eq|or|or_eq|xor|xor_eq)\b/,boolean:/\b(?:false|true)\b/}),e.languages.insertBefore("cpp","string",{module:{pattern:RegExp(/(\b(?:import|module)\s+)/.source+"(?:"+/"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"|<[^<>\r\n]*>/.source+"|"+/(?:\s*:\s*)?|:\s*/.source.replace(//g,(function(){return n}))+")"),lookbehind:!0,greedy:!0,inside:{string:/^[<"][\s\S]+/,operator:/:/,punctuation:/\./}},"raw-string":{pattern:/R"([^()\\ ]{0,16})\([\s\S]*?\)\1"/,alias:"string",greedy:!0}}),e.languages.insertBefore("cpp","keyword",{"generic-function":{pattern:/\b(?!operator\b)[a-z_]\w*\s*<(?:[^<>]|<[^<>]*>)*>(?=\s*\()/i,inside:{function:/^\w+/,generic:{pattern:/<[\s\S]+/,alias:"class-name",inside:e.languages.cpp}}}}),e.languages.insertBefore("cpp","operator",{"double-colon":{pattern:/::/,alias:"punctuation"}}),e.languages.insertBefore("cpp","class-name",{"base-clause":{pattern:/(\b(?:class|struct)\s+\w+\s*:\s*)[^;{}"'\s]+(?:\s+[^;{}"'\s]+)*(?=\s*[;{])/,lookbehind:!0,greedy:!0,inside:e.languages.extend("cpp",{})}}),e.languages.insertBefore("inside","double-colon",{"class-name":/\b[a-z_]\w*\b(?!\s*::)/i},e.languages.cpp["base-clause"])}(a),function(e){var t=/(?:"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"|'(?:\\(?:\r\n|[\s\S])|[^'\\\r\n])*')/;e.languages.css={comment:/\/\*[\s\S]*?\*\//,atrule:{pattern:/@[\w-](?:[^;{\s]|\s+(?![\s{]))*(?:;|(?=\s*\{))/,inside:{rule:/^@[\w-]+/,"selector-function-argument":{pattern:/(\bselector\s*\(\s*(?![\s)]))(?:[^()\s]|\s+(?![\s)])|\((?:[^()]|\([^()]*\))*\))+(?=\s*\))/,lookbehind:!0,alias:"selector"},keyword:{pattern:/(^|[^\w-])(?:and|not|only|or)(?![\w-])/,lookbehind:!0}}},url:{pattern:RegExp("\\burl\\((?:"+t.source+"|"+/(?:[^\\\r\n()"']|\\[\s\S])*/.source+")\\)","i"),greedy:!0,inside:{function:/^url/i,punctuation:/^\(|\)$/,string:{pattern:RegExp("^"+t.source+"$"),alias:"url"}}},selector:{pattern:RegExp("(^|[{}\\s])[^{}\\s](?:[^{};\"'\\s]|\\s+(?![\\s{])|"+t.source+")*(?=\\s*\\{)"),lookbehind:!0},string:{pattern:t,greedy:!0},property:{pattern:/(^|[^-\w\xA0-\uFFFF])(?!\s)[-_a-z\xA0-\uFFFF](?:(?!\s)[-\w\xA0-\uFFFF])*(?=\s*:)/i,lookbehind:!0},important:/!important\b/i,function:{pattern:/(^|[^-a-z0-9])[-a-z0-9]+(?=\()/i,lookbehind:!0},punctuation:/[(){};:,]/},e.languages.css.atrule.inside.rest=e.languages.css;var n=e.languages.markup;n&&(n.tag.addInlined("style","css"),n.tag.addAttribute("style","css"))}(a),function(e){var t,n=/("|')(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/;e.languages.css.selector={pattern:e.languages.css.selector.pattern,lookbehind:!0,inside:t={"pseudo-element":/:(?:after|before|first-letter|first-line|selection)|::[-\w]+/,"pseudo-class":/:[-\w]+/,class:/\.[-\w]+/,id:/#[-\w]+/,attribute:{pattern:RegExp("\\[(?:[^[\\]\"']|"+n.source+")*\\]"),greedy:!0,inside:{punctuation:/^\[|\]$/,"case-sensitivity":{pattern:/(\s)[si]$/i,lookbehind:!0,alias:"keyword"},namespace:{pattern:/^(\s*)(?:(?!\s)[-*\w\xA0-\uFFFF])*\|(?!=)/,lookbehind:!0,inside:{punctuation:/\|$/}},"attr-name":{pattern:/^(\s*)(?:(?!\s)[-\w\xA0-\uFFFF])+/,lookbehind:!0},"attr-value":[n,{pattern:/(=\s*)(?:(?!\s)[-\w\xA0-\uFFFF])+(?=\s*$)/,lookbehind:!0}],operator:/[|~*^$]?=/}},"n-th":[{pattern:/(\(\s*)[+-]?\d*[\dn](?:\s*[+-]\s*\d+)?(?=\s*\))/,lookbehind:!0,inside:{number:/[\dn]+/,operator:/[+-]/}},{pattern:/(\(\s*)(?:even|odd)(?=\s*\))/i,lookbehind:!0}],combinator:/>|\+|~|\|\|/,punctuation:/[(),]/}},e.languages.css.atrule.inside["selector-function-argument"].inside=t,e.languages.insertBefore("css","property",{variable:{pattern:/(^|[^-\w\xA0-\uFFFF])--(?!\s)[-_a-z\xA0-\uFFFF](?:(?!\s)[-\w\xA0-\uFFFF])*/i,lookbehind:!0}});var r={pattern:/(\b\d+)(?:%|[a-z]+(?![\w-]))/,lookbehind:!0},a={pattern:/(^|[^\w.-])-?(?:\d+(?:\.\d+)?|\.\d+)/,lookbehind:!0};e.languages.insertBefore("css","function",{operator:{pattern:/(\s)[+\-*\/](?=\s)/,lookbehind:!0},hexcode:{pattern:/\B#[\da-f]{3,8}\b/i,alias:"color"},color:[{pattern:/(^|[^\w-])(?:AliceBlue|AntiqueWhite|Aqua|Aquamarine|Azure|Beige|Bisque|Black|BlanchedAlmond|Blue|BlueViolet|Brown|BurlyWood|CadetBlue|Chartreuse|Chocolate|Coral|CornflowerBlue|Cornsilk|Crimson|Cyan|DarkBlue|DarkCyan|DarkGoldenRod|DarkGr[ae]y|DarkGreen|DarkKhaki|DarkMagenta|DarkOliveGreen|DarkOrange|DarkOrchid|DarkRed|DarkSalmon|DarkSeaGreen|DarkSlateBlue|DarkSlateGr[ae]y|DarkTurquoise|DarkViolet|DeepPink|DeepSkyBlue|DimGr[ae]y|DodgerBlue|FireBrick|FloralWhite|ForestGreen|Fuchsia|Gainsboro|GhostWhite|Gold|GoldenRod|Gr[ae]y|Green|GreenYellow|HoneyDew|HotPink|IndianRed|Indigo|Ivory|Khaki|Lavender|LavenderBlush|LawnGreen|LemonChiffon|LightBlue|LightCoral|LightCyan|LightGoldenRodYellow|LightGr[ae]y|LightGreen|LightPink|LightSalmon|LightSeaGreen|LightSkyBlue|LightSlateGr[ae]y|LightSteelBlue|LightYellow|Lime|LimeGreen|Linen|Magenta|Maroon|MediumAquaMarine|MediumBlue|MediumOrchid|MediumPurple|MediumSeaGreen|MediumSlateBlue|MediumSpringGreen|MediumTurquoise|MediumVioletRed|MidnightBlue|MintCream|MistyRose|Moccasin|NavajoWhite|Navy|OldLace|Olive|OliveDrab|Orange|OrangeRed|Orchid|PaleGoldenRod|PaleGreen|PaleTurquoise|PaleVioletRed|PapayaWhip|PeachPuff|Peru|Pink|Plum|PowderBlue|Purple|Red|RosyBrown|RoyalBlue|SaddleBrown|Salmon|SandyBrown|SeaGreen|SeaShell|Sienna|Silver|SkyBlue|SlateBlue|SlateGr[ae]y|Snow|SpringGreen|SteelBlue|Tan|Teal|Thistle|Tomato|Transparent|Turquoise|Violet|Wheat|White|WhiteSmoke|Yellow|YellowGreen)(?![\w-])/i,lookbehind:!0},{pattern:/\b(?:hsl|rgb)\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*\)\B|\b(?:hsl|rgb)a\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*,\s*(?:0|0?\.\d+|1)\s*\)\B/i,inside:{unit:r,number:a,function:/[\w-]+(?=\()/,punctuation:/[(),]/}}],entity:/\\[\da-f]{1,8}/i,unit:r,number:a})}(a),a.languages.javascript=a.languages.extend("clike",{"class-name":[a.languages.clike["class-name"],{pattern:/(^|[^$\w\xA0-\uFFFF])(?!\s)[_$A-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\.(?:constructor|prototype))/,lookbehind:!0}],keyword:[{pattern:/((?:^|\})\s*)catch\b/,lookbehind:!0},{pattern:/(^|[^.]|\.\.\.\s*)\b(?:as|assert(?=\s*\{)|async(?=\s*(?:function\b|\(|[$\w\xA0-\uFFFF]|$))|await|break|case|class|const|continue|debugger|default|delete|do|else|enum|export|extends|finally(?=\s*(?:\{|$))|for|from(?=\s*(?:['"]|$))|function|(?:get|set)(?=\s*(?:[#\[$\w\xA0-\uFFFF]|$))|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|static|super|switch|this|throw|try|typeof|undefined|var|void|while|with|yield)\b/,lookbehind:!0}],function:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*(?:\.\s*(?:apply|bind|call)\s*)?\()/,number:{pattern:RegExp(/(^|[^\w$])/.source+"(?:"+/NaN|Infinity/.source+"|"+/0[bB][01]+(?:_[01]+)*n?/.source+"|"+/0[oO][0-7]+(?:_[0-7]+)*n?/.source+"|"+/0[xX][\dA-Fa-f]+(?:_[\dA-Fa-f]+)*n?/.source+"|"+/\d+(?:_\d+)*n/.source+"|"+/(?:\d+(?:_\d+)*(?:\.(?:\d+(?:_\d+)*)?)?|\.\d+(?:_\d+)*)(?:[Ee][+-]?\d+(?:_\d+)*)?/.source+")"+/(?![\w$])/.source),lookbehind:!0},operator:/--|\+\+|\*\*=?|=>|&&=?|\|\|=?|[!=]==|<<=?|>>>?=?|[-+*/%&|^!=<>]=?|\.{3}|\?\?=?|\?\.?|[~:]/}),a.languages.javascript["class-name"][0].pattern=/(\b(?:class|extends|implements|instanceof|interface|new)\s+)[\w.\\]+/,a.languages.insertBefore("javascript","keyword",{regex:{pattern:/((?:^|[^$\w\xA0-\uFFFF."'\])\s]|\b(?:return|yield))\s*)\/(?:\[(?:[^\]\\\r\n]|\\.)*\]|\\.|[^/\\\[\r\n])+\/[dgimyus]{0,7}(?=(?:\s|\/\*(?:[^*]|\*(?!\/))*\*\/)*(?:$|[\r\n,.;:})\]]|\/\/))/,lookbehind:!0,greedy:!0,inside:{"regex-source":{pattern:/^(\/)[\s\S]+(?=\/[a-z]*$)/,lookbehind:!0,alias:"language-regex",inside:a.languages.regex},"regex-delimiter":/^\/|\/$/,"regex-flags":/^[a-z]+$/}},"function-variable":{pattern:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*[=:]\s*(?:async\s*)?(?:\bfunction\b|(?:\((?:[^()]|\([^()]*\))*\)|(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*)\s*=>))/,alias:"function"},parameter:[{pattern:/(function(?:\s+(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*)?\s*\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\))/,lookbehind:!0,inside:a.languages.javascript},{pattern:/(^|[^$\w\xA0-\uFFFF])(?!\s)[_$a-z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*=>)/i,lookbehind:!0,inside:a.languages.javascript},{pattern:/(\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\)\s*=>)/,lookbehind:!0,inside:a.languages.javascript},{pattern:/((?:\b|\s|^)(?!(?:as|async|await|break|case|catch|class|const|continue|debugger|default|delete|do|else|enum|export|extends|finally|for|from|function|get|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|set|static|super|switch|this|throw|try|typeof|undefined|var|void|while|with|yield)(?![$\w\xA0-\uFFFF]))(?:(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*\s*)\(\s*|\]\s*\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\)\s*\{)/,lookbehind:!0,inside:a.languages.javascript}],constant:/\b[A-Z](?:[A-Z_]|\dx?)*\b/}),a.languages.insertBefore("javascript","string",{hashbang:{pattern:/^#!.*/,greedy:!0,alias:"comment"},"template-string":{pattern:/`(?:\\[\s\S]|\$\{(?:[^{}]|\{(?:[^{}]|\{[^}]*\})*\})+\}|(?!\$\{)[^\\`])*`/,greedy:!0,inside:{"template-punctuation":{pattern:/^`|`$/,alias:"string"},interpolation:{pattern:/((?:^|[^\\])(?:\\{2})*)\$\{(?:[^{}]|\{(?:[^{}]|\{[^}]*\})*\})+\}/,lookbehind:!0,inside:{"interpolation-punctuation":{pattern:/^\$\{|\}$/,alias:"punctuation"},rest:a.languages.javascript}},string:/[\s\S]+/}},"string-property":{pattern:/((?:^|[,{])[ \t]*)(["'])(?:\\(?:\r\n|[\s\S])|(?!\2)[^\\\r\n])*\2(?=\s*:)/m,lookbehind:!0,greedy:!0,alias:"property"}}),a.languages.insertBefore("javascript","operator",{"literal-property":{pattern:/((?:^|[,{])[ \t]*)(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*:)/m,lookbehind:!0,alias:"property"}}),a.languages.markup&&(a.languages.markup.tag.addInlined("script","javascript"),a.languages.markup.tag.addAttribute(/on(?:abort|blur|change|click|composition(?:end|start|update)|dblclick|error|focus(?:in|out)?|key(?:down|up)|load|mouse(?:down|enter|leave|move|out|over|up)|reset|resize|scroll|select|slotchange|submit|unload|wheel)/.source,"javascript")),a.languages.js=a.languages.javascript,function(e){var t=/#(?!\{).+/,n={pattern:/#\{[^}]+\}/,alias:"variable"};e.languages.coffeescript=e.languages.extend("javascript",{comment:t,string:[{pattern:/'(?:\\[\s\S]|[^\\'])*'/,greedy:!0},{pattern:/"(?:\\[\s\S]|[^\\"])*"/,greedy:!0,inside:{interpolation:n}}],keyword:/\b(?:and|break|by|catch|class|continue|debugger|delete|do|each|else|extend|extends|false|finally|for|if|in|instanceof|is|isnt|let|loop|namespace|new|no|not|null|of|off|on|or|own|return|super|switch|then|this|throw|true|try|typeof|undefined|unless|until|when|while|window|with|yes|yield)\b/,"class-member":{pattern:/@(?!\d)\w+/,alias:"variable"}}),e.languages.insertBefore("coffeescript","comment",{"multiline-comment":{pattern:/###[\s\S]+?###/,alias:"comment"},"block-regex":{pattern:/\/{3}[\s\S]*?\/{3}/,alias:"regex",inside:{comment:t,interpolation:n}}}),e.languages.insertBefore("coffeescript","string",{"inline-javascript":{pattern:/`(?:\\[\s\S]|[^\\`])*`/,inside:{delimiter:{pattern:/^`|`$/,alias:"punctuation"},script:{pattern:/[\s\S]+/,alias:"language-javascript",inside:e.languages.javascript}}},"multiline-string":[{pattern:/'''[\s\S]*?'''/,greedy:!0,alias:"string"},{pattern:/"""[\s\S]*?"""/,greedy:!0,alias:"string",inside:{interpolation:n}}]}),e.languages.insertBefore("coffeescript","keyword",{property:/(?!\d)\w+(?=\s*:(?!:))/}),delete e.languages.coffeescript["template-string"],e.languages.coffee=e.languages.coffeescript}(a),function(e){var t=/[*&][^\s[\]{},]+/,n=/!(?:<[\w\-%#;/?:@&=+$,.!~*'()[\]]+>|(?:[a-zA-Z\d-]*!)?[\w\-%#;/?:@&=+$.~*'()]+)?/,r="(?:"+n.source+"(?:[ \t]+"+t.source+")?|"+t.source+"(?:[ \t]+"+n.source+")?)",a=/(?:[^\s\x00-\x08\x0e-\x1f!"#%&'*,\-:>?@[\]`{|}\x7f-\x84\x86-\x9f\ud800-\udfff\ufffe\uffff]|[?:-])(?:[ \t]*(?:(?![#:])|:))*/.source.replace(//g,(function(){return/[^\s\x00-\x08\x0e-\x1f,[\]{}\x7f-\x84\x86-\x9f\ud800-\udfff\ufffe\uffff]/.source})),o=/"(?:[^"\\\r\n]|\\.)*"|'(?:[^'\\\r\n]|\\.)*'/.source;function i(e,t){t=(t||"").replace(/m/g,"")+"m";var n=/([:\-,[{]\s*(?:\s<>[ \t]+)?)(?:<>)(?=[ \t]*(?:$|,|\]|\}|(?:[\r\n]\s*)?#))/.source.replace(/<>/g,(function(){return r})).replace(/<>/g,(function(){return e}));return RegExp(n,t)}e.languages.yaml={scalar:{pattern:RegExp(/([\-:]\s*(?:\s<>[ \t]+)?[|>])[ \t]*(?:((?:\r?\n|\r)[ \t]+)\S[^\r\n]*(?:\2[^\r\n]+)*)/.source.replace(/<>/g,(function(){return r}))),lookbehind:!0,alias:"string"},comment:/#.*/,key:{pattern:RegExp(/((?:^|[:\-,[{\r\n?])[ \t]*(?:<>[ \t]+)?)<>(?=\s*:\s)/.source.replace(/<>/g,(function(){return r})).replace(/<>/g,(function(){return"(?:"+a+"|"+o+")"}))),lookbehind:!0,greedy:!0,alias:"atrule"},directive:{pattern:/(^[ \t]*)%.+/m,lookbehind:!0,alias:"important"},datetime:{pattern:i(/\d{4}-\d\d?-\d\d?(?:[tT]|[ \t]+)\d\d?:\d{2}:\d{2}(?:\.\d*)?(?:[ \t]*(?:Z|[-+]\d\d?(?::\d{2})?))?|\d{4}-\d{2}-\d{2}|\d\d?:\d{2}(?::\d{2}(?:\.\d*)?)?/.source),lookbehind:!0,alias:"number"},boolean:{pattern:i(/false|true/.source,"i"),lookbehind:!0,alias:"important"},null:{pattern:i(/null|~/.source,"i"),lookbehind:!0,alias:"important"},string:{pattern:i(o),lookbehind:!0,greedy:!0},number:{pattern:i(/[+-]?(?:0x[\da-f]+|0o[0-7]+|(?:\d+(?:\.\d*)?|\.\d+)(?:e[+-]?\d+)?|\.inf|\.nan)/.source,"i"),lookbehind:!0},tag:n,important:t,punctuation:/---|[:[\]{}\-,|>?]|\.\.\./},e.languages.yml=e.languages.yaml}(a),function(e){var t=/(?:\\.|[^\\\n\r]|(?:\n|\r\n?)(?![\r\n]))/.source;function n(e){return e=e.replace(//g,(function(){return t})),RegExp(/((?:^|[^\\])(?:\\{2})*)/.source+"(?:"+e+")")}var r=/(?:\\.|``(?:[^`\r\n]|`(?!`))+``|`[^`\r\n]+`|[^\\|\r\n`])+/.source,a=/\|?__(?:\|__)+\|?(?:(?:\n|\r\n?)|(?![\s\S]))/.source.replace(/__/g,(function(){return r})),o=/\|?[ \t]*:?-{3,}:?[ \t]*(?:\|[ \t]*:?-{3,}:?[ \t]*)+\|?(?:\n|\r\n?)/.source;e.languages.markdown=e.languages.extend("markup",{}),e.languages.insertBefore("markdown","prolog",{"front-matter-block":{pattern:/(^(?:\s*[\r\n])?)---(?!.)[\s\S]*?[\r\n]---(?!.)/,lookbehind:!0,greedy:!0,inside:{punctuation:/^---|---$/,"front-matter":{pattern:/\S+(?:\s+\S+)*/,alias:["yaml","language-yaml"],inside:e.languages.yaml}}},blockquote:{pattern:/^>(?:[\t ]*>)*/m,alias:"punctuation"},table:{pattern:RegExp("^"+a+o+"(?:"+a+")*","m"),inside:{"table-data-rows":{pattern:RegExp("^("+a+o+")(?:"+a+")*$"),lookbehind:!0,inside:{"table-data":{pattern:RegExp(r),inside:e.languages.markdown},punctuation:/\|/}},"table-line":{pattern:RegExp("^("+a+")"+o+"$"),lookbehind:!0,inside:{punctuation:/\||:?-{3,}:?/}},"table-header-row":{pattern:RegExp("^"+a+"$"),inside:{"table-header":{pattern:RegExp(r),alias:"important",inside:e.languages.markdown},punctuation:/\|/}}}},code:[{pattern:/((?:^|\n)[ \t]*\n|(?:^|\r\n?)[ \t]*\r\n?)(?: {4}|\t).+(?:(?:\n|\r\n?)(?: {4}|\t).+)*/,lookbehind:!0,alias:"keyword"},{pattern:/^```[\s\S]*?^```$/m,greedy:!0,inside:{"code-block":{pattern:/^(```.*(?:\n|\r\n?))[\s\S]+?(?=(?:\n|\r\n?)^```$)/m,lookbehind:!0},"code-language":{pattern:/^(```).+/,lookbehind:!0},punctuation:/```/}}],title:[{pattern:/\S.*(?:\n|\r\n?)(?:==+|--+)(?=[ \t]*$)/m,alias:"important",inside:{punctuation:/==+$|--+$/}},{pattern:/(^\s*)#.+/m,lookbehind:!0,alias:"important",inside:{punctuation:/^#+|#+$/}}],hr:{pattern:/(^\s*)([*-])(?:[\t ]*\2){2,}(?=\s*$)/m,lookbehind:!0,alias:"punctuation"},list:{pattern:/(^\s*)(?:[*+-]|\d+\.)(?=[\t ].)/m,lookbehind:!0,alias:"punctuation"},"url-reference":{pattern:/!?\[[^\]]+\]:[\t ]+(?:\S+|<(?:\\.|[^>\\])+>)(?:[\t ]+(?:"(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'|\((?:\\.|[^)\\])*\)))?/,inside:{variable:{pattern:/^(!?\[)[^\]]+/,lookbehind:!0},string:/(?:"(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'|\((?:\\.|[^)\\])*\))$/,punctuation:/^[\[\]!:]|[<>]/},alias:"url"},bold:{pattern:n(/\b__(?:(?!_)|_(?:(?!_))+_)+__\b|\*\*(?:(?!\*)|\*(?:(?!\*))+\*)+\*\*/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^..)[\s\S]+(?=..$)/,lookbehind:!0,inside:{}},punctuation:/\*\*|__/}},italic:{pattern:n(/\b_(?:(?!_)|__(?:(?!_))+__)+_\b|\*(?:(?!\*)|\*\*(?:(?!\*))+\*\*)+\*/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^.)[\s\S]+(?=.$)/,lookbehind:!0,inside:{}},punctuation:/[*_]/}},strike:{pattern:n(/(~~?)(?:(?!~))+\2/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^~~?)[\s\S]+(?=\1$)/,lookbehind:!0,inside:{}},punctuation:/~~?/}},"code-snippet":{pattern:/(^|[^\\`])(?:``[^`\r\n]+(?:`[^`\r\n]+)*``(?!`)|`[^`\r\n]+`(?!`))/,lookbehind:!0,greedy:!0,alias:["code","keyword"]},url:{pattern:n(/!?\[(?:(?!\]))+\](?:\([^\s)]+(?:[\t ]+"(?:\\.|[^"\\])*")?\)|[ \t]?\[(?:(?!\]))+\])/.source),lookbehind:!0,greedy:!0,inside:{operator:/^!/,content:{pattern:/(^\[)[^\]]+(?=\])/,lookbehind:!0,inside:{}},variable:{pattern:/(^\][ \t]?\[)[^\]]+(?=\]$)/,lookbehind:!0},url:{pattern:/(^\]\()[^\s)]+/,lookbehind:!0},string:{pattern:/(^[ \t]+)"(?:\\.|[^"\\])*"(?=\)$)/,lookbehind:!0}}}}),["url","bold","italic","strike"].forEach((function(t){["url","bold","italic","strike","code-snippet"].forEach((function(n){t!==n&&(e.languages.markdown[t].inside.content.inside[n]=e.languages.markdown[n])}))})),e.hooks.add("after-tokenize",(function(e){"markdown"!==e.language&&"md"!==e.language||function e(t){if(t&&"string"!=typeof t)for(var n=0,r=t.length;n",quot:'"'},s=String.fromCodePoint||String.fromCharCode;e.languages.md=e.languages.markdown}(a),a.languages.graphql={comment:/#.*/,description:{pattern:/(?:"""(?:[^"]|(?!""")")*"""|"(?:\\.|[^\\"\r\n])*")(?=\s*[a-z_])/i,greedy:!0,alias:"string",inside:{"language-markdown":{pattern:/(^"(?:"")?)(?!\1)[\s\S]+(?=\1$)/,lookbehind:!0,inside:a.languages.markdown}}},string:{pattern:/"""(?:[^"]|(?!""")")*"""|"(?:\\.|[^\\"\r\n])*"/,greedy:!0},number:/(?:\B-|\b)\d+(?:\.\d+)?(?:e[+-]?\d+)?\b/i,boolean:/\b(?:false|true)\b/,variable:/\$[a-z_]\w*/i,directive:{pattern:/@[a-z_]\w*/i,alias:"function"},"attr-name":{pattern:/\b[a-z_]\w*(?=\s*(?:\((?:[^()"]|"(?:\\.|[^\\"\r\n])*")*\))?:)/i,greedy:!0},"atom-input":{pattern:/\b[A-Z]\w*Input\b/,alias:"class-name"},scalar:/\b(?:Boolean|Float|ID|Int|String)\b/,constant:/\b[A-Z][A-Z_\d]*\b/,"class-name":{pattern:/(\b(?:enum|implements|interface|on|scalar|type|union)\s+|&\s*|:\s*|\[)[A-Z_]\w*/,lookbehind:!0},fragment:{pattern:/(\bfragment\s+|\.{3}\s*(?!on\b))[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},"definition-mutation":{pattern:/(\bmutation\s+)[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},"definition-query":{pattern:/(\bquery\s+)[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},keyword:/\b(?:directive|enum|extend|fragment|implements|input|interface|mutation|on|query|repeatable|scalar|schema|subscription|type|union)\b/,operator:/[!=|&]|\.{3}/,"property-query":/\w+(?=\s*\()/,object:/\w+(?=\s*\{)/,punctuation:/[!(){}\[\]:=,]/,property:/\w+/},a.hooks.add("after-tokenize",(function(e){if("graphql"===e.language)for(var t=e.tokens.filter((function(e){return"string"!=typeof e&&"comment"!==e.type&&"scalar"!==e.type})),n=0;n0)){var l=p(/^\{$/,/^\}$/);if(-1===l)continue;for(var s=n;s=0&&f(u,"variable-input")}}}}function c(e){return t[n+e]}function d(e,t){t=t||0;for(var n=0;n?|<|>)?|>[>=]?|\b(?:AND|BETWEEN|DIV|ILIKE|IN|IS|LIKE|NOT|OR|REGEXP|RLIKE|SOUNDS LIKE|XOR)\b/i,punctuation:/[;[\]()`,.]/},function(e){var t=e.languages.javascript["template-string"],n=t.pattern.source,r=t.inside.interpolation,a=r.inside["interpolation-punctuation"],o=r.pattern.source;function i(t,r){if(e.languages[t])return{pattern:RegExp("((?:"+r+")\\s*)"+n),lookbehind:!0,greedy:!0,inside:{"template-punctuation":{pattern:/^`|`$/,alias:"string"},"embedded-code":{pattern:/[\s\S]+/,alias:t}}}}function l(e,t){return"___"+t.toUpperCase()+"_"+e+"___"}function s(t,n,r){var a={code:t,grammar:n,language:r};return e.hooks.run("before-tokenize",a),a.tokens=e.tokenize(a.code,a.grammar),e.hooks.run("after-tokenize",a),a.tokens}function u(t){var n={};n["interpolation-punctuation"]=a;var o=e.tokenize(t,n);if(3===o.length){var i=[1,1];i.push.apply(i,s(o[1],e.languages.javascript,"javascript")),o.splice.apply(o,i)}return new e.Token("interpolation",o,r.alias,t)}function c(t,n,r){var a=e.tokenize(t,{interpolation:{pattern:RegExp(o),lookbehind:!0}}),i=0,c={},d=s(a.map((function(e){if("string"==typeof e)return e;for(var n,a=e.content;-1!==t.indexOf(n=l(i++,r)););return c[n]=a,n})).join(""),n,r),p=Object.keys(c);return i=0,function e(t){for(var n=0;n=p.length)return;var r=t[n];if("string"==typeof r||"string"==typeof r.content){var a=p[i],o="string"==typeof r?r:r.content,l=o.indexOf(a);if(-1!==l){++i;var s=o.substring(0,l),d=u(c[a]),f=o.substring(l+a.length),m=[];if(s&&m.push(s),m.push(d),f){var h=[f];e(h),m.push.apply(m,h)}"string"==typeof r?(t.splice.apply(t,[n,1].concat(m)),n+=m.length-1):r.content=m}}else{var g=r.content;Array.isArray(g)?e(g):e([g])}}}(d),new e.Token(r,d,"language-"+r,t)}e.languages.javascript["template-string"]=[i("css",/\b(?:styled(?:\([^)]*\))?(?:\s*\.\s*\w+(?:\([^)]*\))*)*|css(?:\s*\.\s*(?:global|resolve))?|createGlobalStyle|keyframes)/.source),i("html",/\bhtml|\.\s*(?:inner|outer)HTML\s*\+?=/.source),i("svg",/\bsvg/.source),i("markdown",/\b(?:markdown|md)/.source),i("graphql",/\b(?:gql|graphql(?:\s*\.\s*experimental)?)/.source),i("sql",/\bsql/.source),t].filter(Boolean);var d={javascript:!0,js:!0,typescript:!0,ts:!0,jsx:!0,tsx:!0};function p(e){return"string"==typeof e?e:Array.isArray(e)?e.map(p).join(""):p(e.content)}e.hooks.add("after-tokenize",(function(t){t.language in d&&function t(n){for(var r=0,a=n.length;r]|<(?:[^<>]|<[^<>]*>)*>)*>)?/,lookbehind:!0,greedy:!0,inside:null},builtin:/\b(?:Array|Function|Promise|any|boolean|console|never|number|string|symbol|unknown)\b/}),e.languages.typescript.keyword.push(/\b(?:abstract|declare|is|keyof|readonly|require)\b/,/\b(?:asserts|infer|interface|module|namespace|type)\b(?=\s*(?:[{_$a-zA-Z\xA0-\uFFFF]|$))/,/\btype\b(?=\s*(?:[\{*]|$))/),delete e.languages.typescript.parameter,delete e.languages.typescript["literal-property"];var t=e.languages.extend("typescript",{});delete t["class-name"],e.languages.typescript["class-name"].inside=t,e.languages.insertBefore("typescript","function",{decorator:{pattern:/@[$\w\xA0-\uFFFF]+/,inside:{at:{pattern:/^@/,alias:"operator"},function:/^[\s\S]+/}},"generic-function":{pattern:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*\s*<(?:[^<>]|<(?:[^<>]|<[^<>]*>)*>)*>(?=\s*\()/,greedy:!0,inside:{function:/^#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*/,generic:{pattern:/<[\s\S]+/,alias:"class-name",inside:t}}}}),e.languages.ts=e.languages.typescript}(a),function(e){function t(e,t){return RegExp(e.replace(//g,(function(){return/(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*/.source})),t)}e.languages.insertBefore("javascript","function-variable",{"method-variable":{pattern:RegExp("(\\.\\s*)"+e.languages.javascript["function-variable"].pattern.source),lookbehind:!0,alias:["function-variable","method","function","property-access"]}}),e.languages.insertBefore("javascript","function",{method:{pattern:RegExp("(\\.\\s*)"+e.languages.javascript.function.source),lookbehind:!0,alias:["function","property-access"]}}),e.languages.insertBefore("javascript","constant",{"known-class-name":[{pattern:/\b(?:(?:Float(?:32|64)|(?:Int|Uint)(?:8|16|32)|Uint8Clamped)?Array|ArrayBuffer|BigInt|Boolean|DataView|Date|Error|Function|Intl|JSON|(?:Weak)?(?:Map|Set)|Math|Number|Object|Promise|Proxy|Reflect|RegExp|String|Symbol|WebAssembly)\b/,alias:"class-name"},{pattern:/\b(?:[A-Z]\w*)Error\b/,alias:"class-name"}]}),e.languages.insertBefore("javascript","keyword",{imports:{pattern:t(/(\bimport\b\s*)(?:(?:\s*,\s*(?:\*\s*as\s+|\{[^{}]*\}))?|\*\s*as\s+|\{[^{}]*\})(?=\s*\bfrom\b)/.source),lookbehind:!0,inside:e.languages.javascript},exports:{pattern:t(/(\bexport\b\s*)(?:\*(?:\s*as\s+)?(?=\s*\bfrom\b)|\{[^{}]*\})/.source),lookbehind:!0,inside:e.languages.javascript}}),e.languages.javascript.keyword.unshift({pattern:/\b(?:as|default|export|from|import)\b/,alias:"module"},{pattern:/\b(?:await|break|catch|continue|do|else|finally|for|if|return|switch|throw|try|while|yield)\b/,alias:"control-flow"},{pattern:/\bnull\b/,alias:["null","nil"]},{pattern:/\bundefined\b/,alias:"nil"}),e.languages.insertBefore("javascript","operator",{spread:{pattern:/\.{3}/,alias:"operator"},arrow:{pattern:/=>/,alias:"operator"}}),e.languages.insertBefore("javascript","punctuation",{"property-access":{pattern:t(/(\.\s*)#?/.source),lookbehind:!0},"maybe-class-name":{pattern:/(^|[^$\w\xA0-\uFFFF])[A-Z][$\w\xA0-\uFFFF]+/,lookbehind:!0},dom:{pattern:/\b(?:document|(?:local|session)Storage|location|navigator|performance|window)\b/,alias:"variable"},console:{pattern:/\bconsole(?=\s*\.)/,alias:"class-name"}});for(var n=["function","function-variable","method","method-variable","property-access"],r=0;r*\.{3}(?:[^{}]|)*\})/.source;function o(e,t){return e=e.replace(//g,(function(){return n})).replace(//g,(function(){return r})).replace(//g,(function(){return a})),RegExp(e,t)}a=o(a).source,e.languages.jsx=e.languages.extend("markup",t),e.languages.jsx.tag.pattern=o(/<\/?(?:[\w.:-]+(?:+(?:[\w.:$-]+(?:=(?:"(?:\\[\s\S]|[^\\"])*"|'(?:\\[\s\S]|[^\\'])*'|[^\s{'"/>=]+|))?|))**\/?)?>/.source),e.languages.jsx.tag.inside.tag.pattern=/^<\/?[^\s>\/]*/,e.languages.jsx.tag.inside["attr-value"].pattern=/=(?!\{)(?:"(?:\\[\s\S]|[^\\"])*"|'(?:\\[\s\S]|[^\\'])*'|[^\s'">]+)/,e.languages.jsx.tag.inside.tag.inside["class-name"]=/^[A-Z]\w*(?:\.[A-Z]\w*)*$/,e.languages.jsx.tag.inside.comment=t.comment,e.languages.insertBefore("inside","attr-name",{spread:{pattern:o(//.source),inside:e.languages.jsx}},e.languages.jsx.tag),e.languages.insertBefore("inside","special-attr",{script:{pattern:o(/=/.source),alias:"language-javascript",inside:{"script-punctuation":{pattern:/^=(?=\{)/,alias:"punctuation"},rest:e.languages.jsx}}},e.languages.jsx.tag);var i=function(e){return e?"string"==typeof e?e:"string"==typeof e.content?e.content:e.content.map(i).join(""):""},l=function(t){for(var n=[],r=0;r0&&n[n.length-1].tagName===i(a.content[0].content[1])&&n.pop():"/>"===a.content[a.content.length-1].content||n.push({tagName:i(a.content[0].content[1]),openedBraces:0}):n.length>0&&"punctuation"===a.type&&"{"===a.content?n[n.length-1].openedBraces++:n.length>0&&n[n.length-1].openedBraces>0&&"punctuation"===a.type&&"}"===a.content?n[n.length-1].openedBraces--:o=!0),(o||"string"==typeof a)&&n.length>0&&0===n[n.length-1].openedBraces){var s=i(a);r0&&("string"==typeof t[r-1]||"plain-text"===t[r-1].type)&&(s=i(t[r-1])+s,t.splice(r-1,1),r--),t[r]=new e.Token("plain-text",s,null,s)}a.content&&"string"!=typeof a.content&&l(a.content)}};e.hooks.add("after-tokenize",(function(e){"jsx"!==e.language&&"tsx"!==e.language||l(e.tokens)}))}(a),function(e){e.languages.diff={coord:[/^(?:\*{3}|-{3}|\+{3}).*$/m,/^@@.*@@$/m,/^\d.*$/m]};var t={"deleted-sign":"-","deleted-arrow":"<","inserted-sign":"+","inserted-arrow":">",unchanged:" ",diff:"!"};Object.keys(t).forEach((function(n){var r=t[n],a=[];/^\w+$/.test(n)||a.push(/\w+/.exec(n)[0]),"diff"===n&&a.push("bold"),e.languages.diff[n]={pattern:RegExp("^(?:["+r+"].*(?:\r\n?|\n|(?![\\s\\S])))+","m"),alias:a,inside:{line:{pattern:/(.)(?=[\s\S]).*(?:\r\n?|\n)?/,lookbehind:!0},prefix:{pattern:/[\s\S]/,alias:/\w+/.exec(n)[0]}}}})),Object.defineProperty(e.languages.diff,"PREFIXES",{value:t})}(a),a.languages.git={comment:/^#.*/m,deleted:/^[-\u2013].*/m,inserted:/^\+.*/m,string:/("|')(?:\\.|(?!\1)[^\\\r\n])*\1/,command:{pattern:/^.*\$ git .*$/m,inside:{parameter:/\s--?\w+/}},coord:/^@@.*@@$/m,"commit-sha1":/^commit \w{40}$/m},a.languages.go=a.languages.extend("clike",{string:{pattern:/(^|[^\\])"(?:\\.|[^"\\\r\n])*"|`[^`]*`/,lookbehind:!0,greedy:!0},keyword:/\b(?:break|case|chan|const|continue|default|defer|else|fallthrough|for|func|go(?:to)?|if|import|interface|map|package|range|return|select|struct|switch|type|var)\b/,boolean:/\b(?:_|false|iota|nil|true)\b/,number:[/\b0(?:b[01_]+|o[0-7_]+)i?\b/i,/\b0x(?:[a-f\d_]+(?:\.[a-f\d_]*)?|\.[a-f\d_]+)(?:p[+-]?\d+(?:_\d+)*)?i?(?!\w)/i,/(?:\b\d[\d_]*(?:\.[\d_]*)?|\B\.\d[\d_]*)(?:e[+-]?[\d_]+)?i?(?!\w)/i],operator:/[*\/%^!=]=?|\+[=+]?|-[=-]?|\|[=|]?|&(?:=|&|\^=?)?|>(?:>=?|=)?|<(?:<=?|=|-)?|:=|\.\.\./,builtin:/\b(?:append|bool|byte|cap|close|complex|complex(?:64|128)|copy|delete|error|float(?:32|64)|u?int(?:8|16|32|64)?|imag|len|make|new|panic|print(?:ln)?|real|recover|rune|string|uintptr)\b/}),a.languages.insertBefore("go","string",{char:{pattern:/'(?:\\.|[^'\\\r\n]){0,10}'/,greedy:!0}}),delete a.languages.go["class-name"],function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,a,o){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(a,(function(e){if("function"==typeof o&&!o(e))return e;for(var a,l=i.length;-1!==n.code.indexOf(a=t(r,l));)++l;return i[l]=e,a})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var a=0,o=Object.keys(n.tokenStack);!function i(l){for(var s=0;s=o.length);s++){var u=l[s];if("string"==typeof u||u.content&&"string"==typeof u.content){var c=o[a],d=n.tokenStack[c],p="string"==typeof u?u:u.content,f=t(r,c),m=p.indexOf(f);if(m>-1){++a;var h=p.substring(0,m),g=new e.Token(r,e.tokenize(d,n.grammar),"language-"+r,d),b=p.substring(m+f.length),v=[];h&&v.push.apply(v,i([h])),v.push(g),b&&v.push.apply(v,i([b])),"string"==typeof u?l.splice.apply(l,[s,1].concat(v)):u.content=v}}else u.content&&i(u.content)}return l}(n.tokens)}}}})}(a),function(e){e.languages.handlebars={comment:/\{\{![\s\S]*?\}\}/,delimiter:{pattern:/^\{\{\{?|\}\}\}?$/,alias:"punctuation"},string:/(["'])(?:\\.|(?!\1)[^\\\r\n])*\1/,number:/\b0x[\dA-Fa-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:[Ee][+-]?\d+)?/,boolean:/\b(?:false|true)\b/,block:{pattern:/^(\s*(?:~\s*)?)[#\/]\S+?(?=\s*(?:~\s*)?$|\s)/,lookbehind:!0,alias:"keyword"},brackets:{pattern:/\[[^\]]+\]/,inside:{punctuation:/\[|\]/,variable:/[\s\S]+/}},punctuation:/[!"#%&':()*+,.\/;<=>@\[\\\]^`{|}~]/,variable:/[^!"#%&'()*+,\/;<=>@\[\\\]^`{|}~\s]+/},e.hooks.add("before-tokenize",(function(t){e.languages["markup-templating"].buildPlaceholders(t,"handlebars",/\{\{\{[\s\S]+?\}\}\}|\{\{[\s\S]+?\}\}/g)})),e.hooks.add("after-tokenize",(function(t){e.languages["markup-templating"].tokenizePlaceholders(t,"handlebars")})),e.languages.hbs=e.languages.handlebars}(a),a.languages.json={property:{pattern:/(^|[^\\])"(?:\\.|[^\\"\r\n])*"(?=\s*:)/,lookbehind:!0,greedy:!0},string:{pattern:/(^|[^\\])"(?:\\.|[^\\"\r\n])*"(?!\s*:)/,lookbehind:!0,greedy:!0},comment:{pattern:/\/\/.*|\/\*[\s\S]*?(?:\*\/|$)/,greedy:!0},number:/-?\b\d+(?:\.\d+)?(?:e[+-]?\d+)?\b/i,punctuation:/[{}[\],]/,operator:/:/,boolean:/\b(?:false|true)\b/,null:{pattern:/\bnull\b/,alias:"keyword"}},a.languages.webmanifest=a.languages.json,a.languages.less=a.languages.extend("css",{comment:[/\/\*[\s\S]*?\*\//,{pattern:/(^|[^\\])\/\/.*/,lookbehind:!0}],atrule:{pattern:/@[\w-](?:\((?:[^(){}]|\([^(){}]*\))*\)|[^(){};\s]|\s+(?!\s))*?(?=\s*\{)/,inside:{punctuation:/[:()]/}},selector:{pattern:/(?:@\{[\w-]+\}|[^{};\s@])(?:@\{[\w-]+\}|\((?:[^(){}]|\([^(){}]*\))*\)|[^(){};@\s]|\s+(?!\s))*?(?=\s*\{)/,inside:{variable:/@+[\w-]+/}},property:/(?:@\{[\w-]+\}|[\w-])+(?:\+_?)?(?=\s*:)/,operator:/[+\-*\/]/}),a.languages.insertBefore("less","property",{variable:[{pattern:/@[\w-]+\s*:/,inside:{punctuation:/:/}},/@@?[\w-]+/],"mixin-usage":{pattern:/([{;]\s*)[.#](?!\d)[\w-].*?(?=[(;])/,lookbehind:!0,alias:"function"}}),a.languages.makefile={comment:{pattern:/(^|[^\\])#(?:\\(?:\r\n|[\s\S])|[^\\\r\n])*/,lookbehind:!0},string:{pattern:/(["'])(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/,greedy:!0},"builtin-target":{pattern:/\.[A-Z][^:#=\s]+(?=\s*:(?!=))/,alias:"builtin"},target:{pattern:/^(?:[^:=\s]|[ \t]+(?![\s:]))+(?=\s*:(?!=))/m,alias:"symbol",inside:{variable:/\$+(?:(?!\$)[^(){}:#=\s]+|(?=[({]))/}},variable:/\$+(?:(?!\$)[^(){}:#=\s]+|\([@*%<^+?][DF]\)|(?=[({]))/,keyword:/-include\b|\b(?:define|else|endef|endif|export|ifn?def|ifn?eq|include|override|private|sinclude|undefine|unexport|vpath)\b/,function:{pattern:/(\()(?:abspath|addsuffix|and|basename|call|dir|error|eval|file|filter(?:-out)?|findstring|firstword|flavor|foreach|guile|if|info|join|lastword|load|notdir|or|origin|patsubst|realpath|shell|sort|strip|subst|suffix|value|warning|wildcard|word(?:list|s)?)(?=[ \t])/,lookbehind:!0},operator:/(?:::|[?:+!])?=|[|@]/,punctuation:/[:;(){}]/},a.languages.objectivec=a.languages.extend("c",{string:{pattern:/@?"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"/,greedy:!0},keyword:/\b(?:asm|auto|break|case|char|const|continue|default|do|double|else|enum|extern|float|for|goto|if|in|inline|int|long|register|return|self|short|signed|sizeof|static|struct|super|switch|typedef|typeof|union|unsigned|void|volatile|while)\b|(?:@interface|@end|@implementation|@protocol|@class|@public|@protected|@private|@property|@try|@catch|@finally|@throw|@synthesize|@dynamic|@selector)\b/,operator:/-[->]?|\+\+?|!=?|<>?=?|==?|&&?|\|\|?|[~^%?*\/@]/}),delete a.languages.objectivec["class-name"],a.languages.objc=a.languages.objectivec,a.languages.ocaml={comment:{pattern:/\(\*[\s\S]*?\*\)/,greedy:!0},char:{pattern:/'(?:[^\\\r\n']|\\(?:.|[ox]?[0-9a-f]{1,3}))'/i,greedy:!0},string:[{pattern:/"(?:\\(?:[\s\S]|\r\n)|[^\\\r\n"])*"/,greedy:!0},{pattern:/\{([a-z_]*)\|[\s\S]*?\|\1\}/,greedy:!0}],number:[/\b(?:0b[01][01_]*|0o[0-7][0-7_]*)\b/i,/\b0x[a-f0-9][a-f0-9_]*(?:\.[a-f0-9_]*)?(?:p[+-]?\d[\d_]*)?(?!\w)/i,/\b\d[\d_]*(?:\.[\d_]*)?(?:e[+-]?\d[\d_]*)?(?!\w)/i],directive:{pattern:/\B#\w+/,alias:"property"},label:{pattern:/\B~\w+/,alias:"property"},"type-variable":{pattern:/\B'\w+/,alias:"function"},variant:{pattern:/`\w+/,alias:"symbol"},keyword:/\b(?:as|assert|begin|class|constraint|do|done|downto|else|end|exception|external|for|fun|function|functor|if|in|include|inherit|initializer|lazy|let|match|method|module|mutable|new|nonrec|object|of|open|private|rec|sig|struct|then|to|try|type|val|value|virtual|when|where|while|with)\b/,boolean:/\b(?:false|true)\b/,"operator-like-punctuation":{pattern:/\[[<>|]|[>|]\]|\{<|>\}/,alias:"punctuation"},operator:/\.[.~]|:[=>]|[=<>@^|&+\-*\/$%!?~][!$%&*+\-.\/:<=>?@^|~]*|\b(?:and|asr|land|lor|lsl|lsr|lxor|mod|or)\b/,punctuation:/;;|::|[(){}\[\].,:;#]|\b_\b/},a.languages.python={comment:{pattern:/(^|[^\\])#.*/,lookbehind:!0,greedy:!0},"string-interpolation":{pattern:/(?:f|fr|rf)(?:("""|''')[\s\S]*?\1|("|')(?:\\.|(?!\2)[^\\\r\n])*\2)/i,greedy:!0,inside:{interpolation:{pattern:/((?:^|[^{])(?:\{\{)*)\{(?!\{)(?:[^{}]|\{(?!\{)(?:[^{}]|\{(?!\{)(?:[^{}])+\})+\})+\}/,lookbehind:!0,inside:{"format-spec":{pattern:/(:)[^:(){}]+(?=\}$)/,lookbehind:!0},"conversion-option":{pattern:/![sra](?=[:}]$)/,alias:"punctuation"},rest:null}},string:/[\s\S]+/}},"triple-quoted-string":{pattern:/(?:[rub]|br|rb)?("""|''')[\s\S]*?\1/i,greedy:!0,alias:"string"},string:{pattern:/(?:[rub]|br|rb)?("|')(?:\\.|(?!\1)[^\\\r\n])*\1/i,greedy:!0},function:{pattern:/((?:^|\s)def[ \t]+)[a-zA-Z_]\w*(?=\s*\()/g,lookbehind:!0},"class-name":{pattern:/(\bclass\s+)\w+/i,lookbehind:!0},decorator:{pattern:/(^[\t ]*)@\w+(?:\.\w+)*/m,lookbehind:!0,alias:["annotation","punctuation"],inside:{punctuation:/\./}},keyword:/\b(?:_(?=\s*:)|and|as|assert|async|await|break|case|class|continue|def|del|elif|else|except|exec|finally|for|from|global|if|import|in|is|lambda|match|nonlocal|not|or|pass|print|raise|return|try|while|with|yield)\b/,builtin:/\b(?:__import__|abs|all|any|apply|ascii|basestring|bin|bool|buffer|bytearray|bytes|callable|chr|classmethod|cmp|coerce|compile|complex|delattr|dict|dir|divmod|enumerate|eval|execfile|file|filter|float|format|frozenset|getattr|globals|hasattr|hash|help|hex|id|input|int|intern|isinstance|issubclass|iter|len|list|locals|long|map|max|memoryview|min|next|object|oct|open|ord|pow|property|range|raw_input|reduce|reload|repr|reversed|round|set|setattr|slice|sorted|staticmethod|str|sum|super|tuple|type|unichr|unicode|vars|xrange|zip)\b/,boolean:/\b(?:False|None|True)\b/,number:/\b0(?:b(?:_?[01])+|o(?:_?[0-7])+|x(?:_?[a-f0-9])+)\b|(?:\b\d+(?:_\d+)*(?:\.(?:\d+(?:_\d+)*)?)?|\B\.\d+(?:_\d+)*)(?:e[+-]?\d+(?:_\d+)*)?j?(?!\w)/i,operator:/[-+%=]=?|!=|:=|\*\*?=?|\/\/?=?|<[<=>]?|>[=>]?|[&|^~]/,punctuation:/[{}[\];(),.:]/},a.languages.python["string-interpolation"].inside.interpolation.inside.rest=a.languages.python,a.languages.py=a.languages.python,a.languages.reason=a.languages.extend("clike",{string:{pattern:/"(?:\\(?:\r\n|[\s\S])|[^\\\r\n"])*"/,greedy:!0},"class-name":/\b[A-Z]\w*/,keyword:/\b(?:and|as|assert|begin|class|constraint|do|done|downto|else|end|exception|external|for|fun|function|functor|if|in|include|inherit|initializer|lazy|let|method|module|mutable|new|nonrec|object|of|open|or|private|rec|sig|struct|switch|then|to|try|type|val|virtual|when|while|with)\b/,operator:/\.{3}|:[:=]|\|>|->|=(?:==?|>)?|<=?|>=?|[|^?'#!~`]|[+\-*\/]\.?|\b(?:asr|land|lor|lsl|lsr|lxor|mod)\b/}),a.languages.insertBefore("reason","class-name",{char:{pattern:/'(?:\\x[\da-f]{2}|\\o[0-3][0-7][0-7]|\\\d{3}|\\.|[^'\\\r\n])'/,greedy:!0},constructor:/\b[A-Z]\w*\b(?!\s*\.)/,label:{pattern:/\b[a-z]\w*(?=::)/,alias:"symbol"}}),delete a.languages.reason.function,function(e){e.languages.sass=e.languages.extend("css",{comment:{pattern:/^([ \t]*)\/[\/*].*(?:(?:\r?\n|\r)\1[ \t].+)*/m,lookbehind:!0,greedy:!0}}),e.languages.insertBefore("sass","atrule",{"atrule-line":{pattern:/^(?:[ \t]*)[@+=].+/m,greedy:!0,inside:{atrule:/(?:@[\w-]+|[+=])/}}}),delete e.languages.sass.atrule;var t=/\$[-\w]+|#\{\$[-\w]+\}/,n=[/[+*\/%]|[=!]=|<=?|>=?|\b(?:and|not|or)\b/,{pattern:/(\s)-(?=\s)/,lookbehind:!0}];e.languages.insertBefore("sass","property",{"variable-line":{pattern:/^[ \t]*\$.+/m,greedy:!0,inside:{punctuation:/:/,variable:t,operator:n}},"property-line":{pattern:/^[ \t]*(?:[^:\s]+ *:.*|:[^:\s].*)/m,greedy:!0,inside:{property:[/[^:\s]+(?=\s*:)/,{pattern:/(:)[^:\s]+/,lookbehind:!0}],punctuation:/:/,variable:t,operator:n,important:e.languages.sass.important}}}),delete e.languages.sass.property,delete e.languages.sass.important,e.languages.insertBefore("sass","punctuation",{selector:{pattern:/^([ \t]*)\S(?:,[^,\r\n]+|[^,\r\n]*)(?:,[^,\r\n]+)*(?:,(?:\r?\n|\r)\1[ \t]+\S(?:,[^,\r\n]+|[^,\r\n]*)(?:,[^,\r\n]+)*)*/m,lookbehind:!0,greedy:!0}})}(a),a.languages.scss=a.languages.extend("css",{comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0},atrule:{pattern:/@[\w-](?:\([^()]+\)|[^()\s]|\s+(?!\s))*?(?=\s+[{;])/,inside:{rule:/@[\w-]+/}},url:/(?:[-a-z]+-)?url(?=\()/i,selector:{pattern:/(?=\S)[^@;{}()]?(?:[^@;{}()\s]|\s+(?!\s)|#\{\$[-\w]+\})+(?=\s*\{(?:\}|\s|[^}][^:{}]*[:{][^}]))/,inside:{parent:{pattern:/&/,alias:"important"},placeholder:/%[-\w]+/,variable:/\$[-\w]+|#\{\$[-\w]+\}/}},property:{pattern:/(?:[-\w]|\$[-\w]|#\{\$[-\w]+\})+(?=\s*:)/,inside:{variable:/\$[-\w]+|#\{\$[-\w]+\}/}}}),a.languages.insertBefore("scss","atrule",{keyword:[/@(?:content|debug|each|else(?: if)?|extend|for|forward|function|if|import|include|mixin|return|use|warn|while)\b/i,{pattern:/( )(?:from|through)(?= )/,lookbehind:!0}]}),a.languages.insertBefore("scss","important",{variable:/\$[-\w]+|#\{\$[-\w]+\}/}),a.languages.insertBefore("scss","function",{"module-modifier":{pattern:/\b(?:as|hide|show|with)\b/i,alias:"keyword"},placeholder:{pattern:/%[-\w]+/,alias:"selector"},statement:{pattern:/\B!(?:default|optional)\b/i,alias:"keyword"},boolean:/\b(?:false|true)\b/,null:{pattern:/\bnull\b/,alias:"keyword"},operator:{pattern:/(\s)(?:[-+*\/%]|[=!]=|<=?|>=?|and|not|or)(?=\s)/,lookbehind:!0}}),a.languages.scss.atrule.inside.rest=a.languages.scss,function(e){var t={pattern:/(\b\d+)(?:%|[a-z]+)/,lookbehind:!0},n={pattern:/(^|[^\w.-])-?(?:\d+(?:\.\d+)?|\.\d+)/,lookbehind:!0},r={comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0},url:{pattern:/\burl\((["']?).*?\1\)/i,greedy:!0},string:{pattern:/("|')(?:(?!\1)[^\\\r\n]|\\(?:\r\n|[\s\S]))*\1/,greedy:!0},interpolation:null,func:null,important:/\B!(?:important|optional)\b/i,keyword:{pattern:/(^|\s+)(?:(?:else|for|if|return|unless)(?=\s|$)|@[\w-]+)/,lookbehind:!0},hexcode:/#[\da-f]{3,6}/i,color:[/\b(?:AliceBlue|AntiqueWhite|Aqua|Aquamarine|Azure|Beige|Bisque|Black|BlanchedAlmond|Blue|BlueViolet|Brown|BurlyWood|CadetBlue|Chartreuse|Chocolate|Coral|CornflowerBlue|Cornsilk|Crimson|Cyan|DarkBlue|DarkCyan|DarkGoldenRod|DarkGr[ae]y|DarkGreen|DarkKhaki|DarkMagenta|DarkOliveGreen|DarkOrange|DarkOrchid|DarkRed|DarkSalmon|DarkSeaGreen|DarkSlateBlue|DarkSlateGr[ae]y|DarkTurquoise|DarkViolet|DeepPink|DeepSkyBlue|DimGr[ae]y|DodgerBlue|FireBrick|FloralWhite|ForestGreen|Fuchsia|Gainsboro|GhostWhite|Gold|GoldenRod|Gr[ae]y|Green|GreenYellow|HoneyDew|HotPink|IndianRed|Indigo|Ivory|Khaki|Lavender|LavenderBlush|LawnGreen|LemonChiffon|LightBlue|LightCoral|LightCyan|LightGoldenRodYellow|LightGr[ae]y|LightGreen|LightPink|LightSalmon|LightSeaGreen|LightSkyBlue|LightSlateGr[ae]y|LightSteelBlue|LightYellow|Lime|LimeGreen|Linen|Magenta|Maroon|MediumAquaMarine|MediumBlue|MediumOrchid|MediumPurple|MediumSeaGreen|MediumSlateBlue|MediumSpringGreen|MediumTurquoise|MediumVioletRed|MidnightBlue|MintCream|MistyRose|Moccasin|NavajoWhite|Navy|OldLace|Olive|OliveDrab|Orange|OrangeRed|Orchid|PaleGoldenRod|PaleGreen|PaleTurquoise|PaleVioletRed|PapayaWhip|PeachPuff|Peru|Pink|Plum|PowderBlue|Purple|Red|RosyBrown|RoyalBlue|SaddleBrown|Salmon|SandyBrown|SeaGreen|SeaShell|Sienna|Silver|SkyBlue|SlateBlue|SlateGr[ae]y|Snow|SpringGreen|SteelBlue|Tan|Teal|Thistle|Tomato|Transparent|Turquoise|Violet|Wheat|White|WhiteSmoke|Yellow|YellowGreen)\b/i,{pattern:/\b(?:hsl|rgb)\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*\)\B|\b(?:hsl|rgb)a\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*,\s*(?:0|0?\.\d+|1)\s*\)\B/i,inside:{unit:t,number:n,function:/[\w-]+(?=\()/,punctuation:/[(),]/}}],entity:/\\[\da-f]{1,8}/i,unit:t,boolean:/\b(?:false|true)\b/,operator:[/~|[+!\/%<>?=]=?|[-:]=|\*[*=]?|\.{2,3}|&&|\|\||\B-\B|\b(?:and|in|is(?: a| defined| not|nt)?|not|or)\b/],number:n,punctuation:/[{}()\[\];:,]/};r.interpolation={pattern:/\{[^\r\n}:]+\}/,alias:"variable",inside:{delimiter:{pattern:/^\{|\}$/,alias:"punctuation"},rest:r}},r.func={pattern:/[\w-]+\([^)]*\).*/,inside:{function:/^[^(]+/,rest:r}},e.languages.stylus={"atrule-declaration":{pattern:/(^[ \t]*)@.+/m,lookbehind:!0,inside:{atrule:/^@[\w-]+/,rest:r}},"variable-declaration":{pattern:/(^[ \t]*)[\w$-]+\s*.?=[ \t]*(?:\{[^{}]*\}|\S.*|$)/m,lookbehind:!0,inside:{variable:/^\S+/,rest:r}},statement:{pattern:/(^[ \t]*)(?:else|for|if|return|unless)[ \t].+/m,lookbehind:!0,inside:{keyword:/^\S+/,rest:r}},"property-declaration":{pattern:/((?:^|\{)([ \t]*))(?:[\w-]|\{[^}\r\n]+\})+(?:\s*:\s*|[ \t]+)(?!\s)[^{\r\n]*(?:;|[^{\r\n,]$(?!(?:\r?\n|\r)(?:\{|\2[ \t])))/m,lookbehind:!0,inside:{property:{pattern:/^[^\s:]+/,inside:{interpolation:r.interpolation}},rest:r}},selector:{pattern:/(^[ \t]*)(?:(?=\S)(?:[^{}\r\n:()]|::?[\w-]+(?:\([^)\r\n]*\)|(?![\w-]))|\{[^}\r\n]+\})+)(?:(?:\r?\n|\r)(?:\1(?:(?=\S)(?:[^{}\r\n:()]|::?[\w-]+(?:\([^)\r\n]*\)|(?![\w-]))|\{[^}\r\n]+\})+)))*(?:,$|\{|(?=(?:\r?\n|\r)(?:\{|\1[ \t])))/m,lookbehind:!0,inside:{interpolation:r.interpolation,comment:r.comment,punctuation:/[{},]/}},func:r.func,string:r.string,comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0,greedy:!0},interpolation:r.interpolation,punctuation:/[{}()\[\];:.]/}}(a),function(e){var t=e.util.clone(e.languages.typescript);e.languages.tsx=e.languages.extend("jsx",t),delete e.languages.tsx.parameter,delete e.languages.tsx["literal-property"];var n=e.languages.tsx.tag;n.pattern=RegExp(/(^|[^\w$]|(?=<\/))/.source+"(?:"+n.pattern.source+")",n.pattern.flags),n.lookbehind=!0}(a),a.languages.wasm={comment:[/\(;[\s\S]*?;\)/,{pattern:/;;.*/,greedy:!0}],string:{pattern:/"(?:\\[\s\S]|[^"\\])*"/,greedy:!0},keyword:[{pattern:/\b(?:align|offset)=/,inside:{operator:/=/}},{pattern:/\b(?:(?:f32|f64|i32|i64)(?:\.(?:abs|add|and|ceil|clz|const|convert_[su]\/i(?:32|64)|copysign|ctz|demote\/f64|div(?:_[su])?|eqz?|extend_[su]\/i32|floor|ge(?:_[su])?|gt(?:_[su])?|le(?:_[su])?|load(?:(?:8|16|32)_[su])?|lt(?:_[su])?|max|min|mul|neg?|nearest|or|popcnt|promote\/f32|reinterpret\/[fi](?:32|64)|rem_[su]|rot[lr]|shl|shr_[su]|sqrt|store(?:8|16|32)?|sub|trunc(?:_[su]\/f(?:32|64))?|wrap\/i64|xor))?|memory\.(?:grow|size))\b/,inside:{punctuation:/\./}},/\b(?:anyfunc|block|br(?:_if|_table)?|call(?:_indirect)?|data|drop|elem|else|end|export|func|get_(?:global|local)|global|if|import|local|loop|memory|module|mut|nop|offset|param|result|return|select|set_(?:global|local)|start|table|tee_local|then|type|unreachable)\b/],variable:/\$[\w!#$%&'*+\-./:<=>?@\\^`|~]+/,number:/[+-]?\b(?:\d(?:_?\d)*(?:\.\d(?:_?\d)*)?(?:[eE][+-]?\d(?:_?\d)*)?|0x[\da-fA-F](?:_?[\da-fA-F])*(?:\.[\da-fA-F](?:_?[\da-fA-D])*)?(?:[pP][+-]?\d(?:_?\d)*)?)\b|\binf\b|\bnan(?::0x[\da-fA-F](?:_?[\da-fA-D])*)?\b/,punctuation:/[()]/};const o=a},9901:e=>{e.exports&&(e.exports={core:{meta:{path:"components/prism-core.js",option:"mandatory"},core:"Core"},themes:{meta:{path:"themes/{id}.css",link:"index.html?theme={id}",exclusive:!0},prism:{title:"Default",option:"default"},"prism-dark":"Dark","prism-funky":"Funky","prism-okaidia":{title:"Okaidia",owner:"ocodia"},"prism-twilight":{title:"Twilight",owner:"remybach"},"prism-coy":{title:"Coy",owner:"tshedor"},"prism-solarizedlight":{title:"Solarized Light",owner:"hectormatos2011 "},"prism-tomorrow":{title:"Tomorrow Night",owner:"Rosey"}},languages:{meta:{path:"components/prism-{id}",noCSS:!0,examplesPath:"examples/prism-{id}",addCheckAll:!0},markup:{title:"Markup",alias:["html","xml","svg","mathml","ssml","atom","rss"],aliasTitles:{html:"HTML",xml:"XML",svg:"SVG",mathml:"MathML",ssml:"SSML",atom:"Atom",rss:"RSS"},option:"default"},css:{title:"CSS",option:"default",modify:"markup"},clike:{title:"C-like",option:"default"},javascript:{title:"JavaScript",require:"clike",modify:"markup",optional:"regex",alias:"js",option:"default"},abap:{title:"ABAP",owner:"dellagustin"},abnf:{title:"ABNF",owner:"RunDevelopment"},actionscript:{title:"ActionScript",require:"javascript",modify:"markup",owner:"Golmote"},ada:{title:"Ada",owner:"Lucretia"},agda:{title:"Agda",owner:"xy-ren"},al:{title:"AL",owner:"RunDevelopment"},antlr4:{title:"ANTLR4",alias:"g4",owner:"RunDevelopment"},apacheconf:{title:"Apache Configuration",owner:"GuiTeK"},apex:{title:"Apex",require:["clike","sql"],owner:"RunDevelopment"},apl:{title:"APL",owner:"ngn"},applescript:{title:"AppleScript",owner:"Golmote"},aql:{title:"AQL",owner:"RunDevelopment"},arduino:{title:"Arduino",require:"cpp",alias:"ino",owner:"dkern"},arff:{title:"ARFF",owner:"Golmote"},armasm:{title:"ARM Assembly",alias:"arm-asm",owner:"RunDevelopment"},arturo:{title:"Arturo",alias:"art",optional:["bash","css","javascript","markup","markdown","sql"],owner:"drkameleon"},asciidoc:{alias:"adoc",title:"AsciiDoc",owner:"Golmote"},aspnet:{title:"ASP.NET (C#)",require:["markup","csharp"],owner:"nauzilus"},asm6502:{title:"6502 Assembly",owner:"kzurawel"},asmatmel:{title:"Atmel AVR Assembly",owner:"cerkit"},autohotkey:{title:"AutoHotkey",owner:"aviaryan"},autoit:{title:"AutoIt",owner:"Golmote"},avisynth:{title:"AviSynth",alias:"avs",owner:"Zinfidel"},"avro-idl":{title:"Avro IDL",alias:"avdl",owner:"RunDevelopment"},awk:{title:"AWK",alias:"gawk",aliasTitles:{gawk:"GAWK"},owner:"RunDevelopment"},bash:{title:"Bash",alias:["sh","shell"],aliasTitles:{sh:"Shell",shell:"Shell"},owner:"zeitgeist87"},basic:{title:"BASIC",owner:"Golmote"},batch:{title:"Batch",owner:"Golmote"},bbcode:{title:"BBcode",alias:"shortcode",aliasTitles:{shortcode:"Shortcode"},owner:"RunDevelopment"},bbj:{title:"BBj",owner:"hyyan"},bicep:{title:"Bicep",owner:"johnnyreilly"},birb:{title:"Birb",require:"clike",owner:"Calamity210"},bison:{title:"Bison",require:"c",owner:"Golmote"},bnf:{title:"BNF",alias:"rbnf",aliasTitles:{rbnf:"RBNF"},owner:"RunDevelopment"},bqn:{title:"BQN",owner:"yewscion"},brainfuck:{title:"Brainfuck",owner:"Golmote"},brightscript:{title:"BrightScript",owner:"RunDevelopment"},bro:{title:"Bro",owner:"wayward710"},bsl:{title:"BSL (1C:Enterprise)",alias:"oscript",aliasTitles:{oscript:"OneScript"},owner:"Diversus23"},c:{title:"C",require:"clike",owner:"zeitgeist87"},csharp:{title:"C#",require:"clike",alias:["cs","dotnet"],owner:"mvalipour"},cpp:{title:"C++",require:"c",owner:"zeitgeist87"},cfscript:{title:"CFScript",require:"clike",alias:"cfc",owner:"mjclemente"},chaiscript:{title:"ChaiScript",require:["clike","cpp"],owner:"RunDevelopment"},cil:{title:"CIL",owner:"sbrl"},cilkc:{title:"Cilk/C",require:"c",alias:"cilk-c",owner:"OpenCilk"},cilkcpp:{title:"Cilk/C++",require:"cpp",alias:["cilk-cpp","cilk"],owner:"OpenCilk"},clojure:{title:"Clojure",owner:"troglotit"},cmake:{title:"CMake",owner:"mjrogozinski"},cobol:{title:"COBOL",owner:"RunDevelopment"},coffeescript:{title:"CoffeeScript",require:"javascript",alias:"coffee",owner:"R-osey"},concurnas:{title:"Concurnas",alias:"conc",owner:"jasontatton"},csp:{title:"Content-Security-Policy",owner:"ScottHelme"},cooklang:{title:"Cooklang",owner:"ahue"},coq:{title:"Coq",owner:"RunDevelopment"},crystal:{title:"Crystal",require:"ruby",owner:"MakeNowJust"},"css-extras":{title:"CSS Extras",require:"css",modify:"css",owner:"milesj"},csv:{title:"CSV",owner:"RunDevelopment"},cue:{title:"CUE",owner:"RunDevelopment"},cypher:{title:"Cypher",owner:"RunDevelopment"},d:{title:"D",require:"clike",owner:"Golmote"},dart:{title:"Dart",require:"clike",owner:"Golmote"},dataweave:{title:"DataWeave",owner:"machaval"},dax:{title:"DAX",owner:"peterbud"},dhall:{title:"Dhall",owner:"RunDevelopment"},diff:{title:"Diff",owner:"uranusjr"},django:{title:"Django/Jinja2",require:"markup-templating",alias:"jinja2",owner:"romanvm"},"dns-zone-file":{title:"DNS zone file",owner:"RunDevelopment",alias:"dns-zone"},docker:{title:"Docker",alias:"dockerfile",owner:"JustinBeckwith"},dot:{title:"DOT (Graphviz)",alias:"gv",optional:"markup",owner:"RunDevelopment"},ebnf:{title:"EBNF",owner:"RunDevelopment"},editorconfig:{title:"EditorConfig",owner:"osipxd"},eiffel:{title:"Eiffel",owner:"Conaclos"},ejs:{title:"EJS",require:["javascript","markup-templating"],owner:"RunDevelopment",alias:"eta",aliasTitles:{eta:"Eta"}},elixir:{title:"Elixir",owner:"Golmote"},elm:{title:"Elm",owner:"zwilias"},etlua:{title:"Embedded Lua templating",require:["lua","markup-templating"],owner:"RunDevelopment"},erb:{title:"ERB",require:["ruby","markup-templating"],owner:"Golmote"},erlang:{title:"Erlang",owner:"Golmote"},"excel-formula":{title:"Excel Formula",alias:["xlsx","xls"],owner:"RunDevelopment"},fsharp:{title:"F#",require:"clike",owner:"simonreynolds7"},factor:{title:"Factor",owner:"catb0t"},false:{title:"False",owner:"edukisto"},"firestore-security-rules":{title:"Firestore security rules",require:"clike",owner:"RunDevelopment"},flow:{title:"Flow",require:"javascript",owner:"Golmote"},fortran:{title:"Fortran",owner:"Golmote"},ftl:{title:"FreeMarker Template Language",require:"markup-templating",owner:"RunDevelopment"},gml:{title:"GameMaker Language",alias:"gamemakerlanguage",require:"clike",owner:"LiarOnce"},gap:{title:"GAP (CAS)",owner:"RunDevelopment"},gcode:{title:"G-code",owner:"RunDevelopment"},gdscript:{title:"GDScript",owner:"RunDevelopment"},gedcom:{title:"GEDCOM",owner:"Golmote"},gettext:{title:"gettext",alias:"po",owner:"RunDevelopment"},gherkin:{title:"Gherkin",owner:"hason"},git:{title:"Git",owner:"lgiraudel"},glsl:{title:"GLSL",require:"c",owner:"Golmote"},gn:{title:"GN",alias:"gni",owner:"RunDevelopment"},"linker-script":{title:"GNU Linker Script",alias:"ld",owner:"RunDevelopment"},go:{title:"Go",require:"clike",owner:"arnehormann"},"go-module":{title:"Go module",alias:"go-mod",owner:"RunDevelopment"},gradle:{title:"Gradle",require:"clike",owner:"zeabdelkhalek-badido18"},graphql:{title:"GraphQL",optional:"markdown",owner:"Golmote"},groovy:{title:"Groovy",require:"clike",owner:"robfletcher"},haml:{title:"Haml",require:"ruby",optional:["css","css-extras","coffeescript","erb","javascript","less","markdown","scss","textile"],owner:"Golmote"},handlebars:{title:"Handlebars",require:"markup-templating",alias:["hbs","mustache"],aliasTitles:{mustache:"Mustache"},owner:"Golmote"},haskell:{title:"Haskell",alias:"hs",owner:"bholst"},haxe:{title:"Haxe",require:"clike",optional:"regex",owner:"Golmote"},hcl:{title:"HCL",owner:"outsideris"},hlsl:{title:"HLSL",require:"c",owner:"RunDevelopment"},hoon:{title:"Hoon",owner:"matildepark"},http:{title:"HTTP",optional:["csp","css","hpkp","hsts","javascript","json","markup","uri"],owner:"danielgtaylor"},hpkp:{title:"HTTP Public-Key-Pins",owner:"ScottHelme"},hsts:{title:"HTTP Strict-Transport-Security",owner:"ScottHelme"},ichigojam:{title:"IchigoJam",owner:"BlueCocoa"},icon:{title:"Icon",owner:"Golmote"},"icu-message-format":{title:"ICU Message Format",owner:"RunDevelopment"},idris:{title:"Idris",alias:"idr",owner:"KeenS",require:"haskell"},ignore:{title:".ignore",owner:"osipxd",alias:["gitignore","hgignore","npmignore"],aliasTitles:{gitignore:".gitignore",hgignore:".hgignore",npmignore:".npmignore"}},inform7:{title:"Inform 7",owner:"Golmote"},ini:{title:"Ini",owner:"aviaryan"},io:{title:"Io",owner:"AlesTsurko"},j:{title:"J",owner:"Golmote"},java:{title:"Java",require:"clike",owner:"sherblot"},javadoc:{title:"JavaDoc",require:["markup","java","javadoclike"],modify:"java",optional:"scala",owner:"RunDevelopment"},javadoclike:{title:"JavaDoc-like",modify:["java","javascript","php"],owner:"RunDevelopment"},javastacktrace:{title:"Java stack trace",owner:"RunDevelopment"},jexl:{title:"Jexl",owner:"czosel"},jolie:{title:"Jolie",require:"clike",owner:"thesave"},jq:{title:"JQ",owner:"RunDevelopment"},jsdoc:{title:"JSDoc",require:["javascript","javadoclike","typescript"],modify:"javascript",optional:["actionscript","coffeescript"],owner:"RunDevelopment"},"js-extras":{title:"JS Extras",require:"javascript",modify:"javascript",optional:["actionscript","coffeescript","flow","n4js","typescript"],owner:"RunDevelopment"},json:{title:"JSON",alias:"webmanifest",aliasTitles:{webmanifest:"Web App Manifest"},owner:"CupOfTea696"},json5:{title:"JSON5",require:"json",owner:"RunDevelopment"},jsonp:{title:"JSONP",require:"json",owner:"RunDevelopment"},jsstacktrace:{title:"JS stack trace",owner:"sbrl"},"js-templates":{title:"JS Templates",require:"javascript",modify:"javascript",optional:["css","css-extras","graphql","markdown","markup","sql"],owner:"RunDevelopment"},julia:{title:"Julia",owner:"cdagnino"},keepalived:{title:"Keepalived Configure",owner:"dev-itsheng"},keyman:{title:"Keyman",owner:"mcdurdin"},kotlin:{title:"Kotlin",alias:["kt","kts"],aliasTitles:{kts:"Kotlin Script"},require:"clike",owner:"Golmote"},kumir:{title:"KuMir (\u041a\u0443\u041c\u0438\u0440)",alias:"kum",owner:"edukisto"},kusto:{title:"Kusto",owner:"RunDevelopment"},latex:{title:"LaTeX",alias:["tex","context"],aliasTitles:{tex:"TeX",context:"ConTeXt"},owner:"japborst"},latte:{title:"Latte",require:["clike","markup-templating","php"],owner:"nette"},less:{title:"Less",require:"css",optional:"css-extras",owner:"Golmote"},lilypond:{title:"LilyPond",require:"scheme",alias:"ly",owner:"RunDevelopment"},liquid:{title:"Liquid",require:"markup-templating",owner:"cinhtau"},lisp:{title:"Lisp",alias:["emacs","elisp","emacs-lisp"],owner:"JuanCaicedo"},livescript:{title:"LiveScript",owner:"Golmote"},llvm:{title:"LLVM IR",owner:"porglezomp"},log:{title:"Log file",optional:"javastacktrace",owner:"RunDevelopment"},lolcode:{title:"LOLCODE",owner:"Golmote"},lua:{title:"Lua",owner:"Golmote"},magma:{title:"Magma (CAS)",owner:"RunDevelopment"},makefile:{title:"Makefile",owner:"Golmote"},markdown:{title:"Markdown",require:"markup",optional:"yaml",alias:"md",owner:"Golmote"},"markup-templating":{title:"Markup templating",require:"markup",owner:"Golmote"},mata:{title:"Mata",owner:"RunDevelopment"},matlab:{title:"MATLAB",owner:"Golmote"},maxscript:{title:"MAXScript",owner:"RunDevelopment"},mel:{title:"MEL",owner:"Golmote"},mermaid:{title:"Mermaid",owner:"RunDevelopment"},metafont:{title:"METAFONT",owner:"LaeriExNihilo"},mizar:{title:"Mizar",owner:"Golmote"},mongodb:{title:"MongoDB",owner:"airs0urce",require:"javascript"},monkey:{title:"Monkey",owner:"Golmote"},moonscript:{title:"MoonScript",alias:"moon",owner:"RunDevelopment"},n1ql:{title:"N1QL",owner:"TMWilds"},n4js:{title:"N4JS",require:"javascript",optional:"jsdoc",alias:"n4jsd",owner:"bsmith-n4"},"nand2tetris-hdl":{title:"Nand To Tetris HDL",owner:"stephanmax"},naniscript:{title:"Naninovel Script",owner:"Elringus",alias:"nani"},nasm:{title:"NASM",owner:"rbmj"},neon:{title:"NEON",owner:"nette"},nevod:{title:"Nevod",owner:"nezaboodka"},nginx:{title:"nginx",owner:"volado"},nim:{title:"Nim",owner:"Golmote"},nix:{title:"Nix",owner:"Golmote"},nsis:{title:"NSIS",owner:"idleberg"},objectivec:{title:"Objective-C",require:"c",alias:"objc",owner:"uranusjr"},ocaml:{title:"OCaml",owner:"Golmote"},odin:{title:"Odin",owner:"edukisto"},opencl:{title:"OpenCL",require:"c",modify:["c","cpp"],owner:"Milania1"},openqasm:{title:"OpenQasm",alias:"qasm",owner:"RunDevelopment"},oz:{title:"Oz",owner:"Golmote"},parigp:{title:"PARI/GP",owner:"Golmote"},parser:{title:"Parser",require:"markup",owner:"Golmote"},pascal:{title:"Pascal",alias:"objectpascal",aliasTitles:{objectpascal:"Object Pascal"},owner:"Golmote"},pascaligo:{title:"Pascaligo",owner:"DefinitelyNotAGoat"},psl:{title:"PATROL Scripting Language",owner:"bertysentry"},pcaxis:{title:"PC-Axis",alias:"px",owner:"RunDevelopment"},peoplecode:{title:"PeopleCode",alias:"pcode",owner:"RunDevelopment"},perl:{title:"Perl",owner:"Golmote"},php:{title:"PHP",require:"markup-templating",owner:"milesj"},phpdoc:{title:"PHPDoc",require:["php","javadoclike"],modify:"php",owner:"RunDevelopment"},"php-extras":{title:"PHP Extras",require:"php",modify:"php",owner:"milesj"},"plant-uml":{title:"PlantUML",alias:"plantuml",owner:"RunDevelopment"},plsql:{title:"PL/SQL",require:"sql",owner:"Golmote"},powerquery:{title:"PowerQuery",alias:["pq","mscript"],owner:"peterbud"},powershell:{title:"PowerShell",owner:"nauzilus"},processing:{title:"Processing",require:"clike",owner:"Golmote"},prolog:{title:"Prolog",owner:"Golmote"},promql:{title:"PromQL",owner:"arendjr"},properties:{title:".properties",owner:"Golmote"},protobuf:{title:"Protocol Buffers",require:"clike",owner:"just-boris"},pug:{title:"Pug",require:["markup","javascript"],optional:["coffeescript","ejs","handlebars","less","livescript","markdown","scss","stylus","twig"],owner:"Golmote"},puppet:{title:"Puppet",owner:"Golmote"},pure:{title:"Pure",optional:["c","cpp","fortran"],owner:"Golmote"},purebasic:{title:"PureBasic",require:"clike",alias:"pbfasm",owner:"HeX0R101"},purescript:{title:"PureScript",require:"haskell",alias:"purs",owner:"sriharshachilakapati"},python:{title:"Python",alias:"py",owner:"multipetros"},qsharp:{title:"Q#",require:"clike",alias:"qs",owner:"fedonman"},q:{title:"Q (kdb+ database)",owner:"Golmote"},qml:{title:"QML",require:"javascript",owner:"RunDevelopment"},qore:{title:"Qore",require:"clike",owner:"temnroegg"},r:{title:"R",owner:"Golmote"},racket:{title:"Racket",require:"scheme",alias:"rkt",owner:"RunDevelopment"},cshtml:{title:"Razor C#",alias:"razor",require:["markup","csharp"],optional:["css","css-extras","javascript","js-extras"],owner:"RunDevelopment"},jsx:{title:"React JSX",require:["markup","javascript"],optional:["jsdoc","js-extras","js-templates"],owner:"vkbansal"},tsx:{title:"React TSX",require:["jsx","typescript"]},reason:{title:"Reason",require:"clike",owner:"Golmote"},regex:{title:"Regex",owner:"RunDevelopment"},rego:{title:"Rego",owner:"JordanSh"},renpy:{title:"Ren'py",alias:"rpy",owner:"HyuchiaDiego"},rescript:{title:"ReScript",alias:"res",owner:"vmarcosp"},rest:{title:"reST (reStructuredText)",owner:"Golmote"},rip:{title:"Rip",owner:"ravinggenius"},roboconf:{title:"Roboconf",owner:"Golmote"},robotframework:{title:"Robot Framework",alias:"robot",owner:"RunDevelopment"},ruby:{title:"Ruby",require:"clike",alias:"rb",owner:"samflores"},rust:{title:"Rust",owner:"Golmote"},sas:{title:"SAS",optional:["groovy","lua","sql"],owner:"Golmote"},sass:{title:"Sass (Sass)",require:"css",optional:"css-extras",owner:"Golmote"},scss:{title:"Sass (SCSS)",require:"css",optional:"css-extras",owner:"MoOx"},scala:{title:"Scala",require:"java",owner:"jozic"},scheme:{title:"Scheme",owner:"bacchus123"},"shell-session":{title:"Shell session",require:"bash",alias:["sh-session","shellsession"],owner:"RunDevelopment"},smali:{title:"Smali",owner:"RunDevelopment"},smalltalk:{title:"Smalltalk",owner:"Golmote"},smarty:{title:"Smarty",require:"markup-templating",optional:"php",owner:"Golmote"},sml:{title:"SML",alias:"smlnj",aliasTitles:{smlnj:"SML/NJ"},owner:"RunDevelopment"},solidity:{title:"Solidity (Ethereum)",alias:"sol",require:"clike",owner:"glachaud"},"solution-file":{title:"Solution file",alias:"sln",owner:"RunDevelopment"},soy:{title:"Soy (Closure Template)",require:"markup-templating",owner:"Golmote"},sparql:{title:"SPARQL",require:"turtle",owner:"Triply-Dev",alias:"rq"},"splunk-spl":{title:"Splunk SPL",owner:"RunDevelopment"},sqf:{title:"SQF: Status Quo Function (Arma 3)",require:"clike",owner:"RunDevelopment"},sql:{title:"SQL",owner:"multipetros"},squirrel:{title:"Squirrel",require:"clike",owner:"RunDevelopment"},stan:{title:"Stan",owner:"RunDevelopment"},stata:{title:"Stata Ado",require:["mata","java","python"],owner:"RunDevelopment"},iecst:{title:"Structured Text (IEC 61131-3)",owner:"serhioromano"},stylus:{title:"Stylus",owner:"vkbansal"},supercollider:{title:"SuperCollider",alias:"sclang",owner:"RunDevelopment"},swift:{title:"Swift",owner:"chrischares"},systemd:{title:"Systemd configuration file",owner:"RunDevelopment"},"t4-templating":{title:"T4 templating",owner:"RunDevelopment"},"t4-cs":{title:"T4 Text Templates (C#)",require:["t4-templating","csharp"],alias:"t4",owner:"RunDevelopment"},"t4-vb":{title:"T4 Text Templates (VB)",require:["t4-templating","vbnet"],owner:"RunDevelopment"},tap:{title:"TAP",owner:"isaacs",require:"yaml"},tcl:{title:"Tcl",owner:"PeterChaplin"},tt2:{title:"Template Toolkit 2",require:["clike","markup-templating"],owner:"gflohr"},textile:{title:"Textile",require:"markup",optional:"css",owner:"Golmote"},toml:{title:"TOML",owner:"RunDevelopment"},tremor:{title:"Tremor",alias:["trickle","troy"],owner:"darach",aliasTitles:{trickle:"trickle",troy:"troy"}},turtle:{title:"Turtle",alias:"trig",aliasTitles:{trig:"TriG"},owner:"jakubklimek"},twig:{title:"Twig",require:"markup-templating",owner:"brandonkelly"},typescript:{title:"TypeScript",require:"javascript",optional:"js-templates",alias:"ts",owner:"vkbansal"},typoscript:{title:"TypoScript",alias:"tsconfig",aliasTitles:{tsconfig:"TSConfig"},owner:"dkern"},unrealscript:{title:"UnrealScript",alias:["uscript","uc"],owner:"RunDevelopment"},uorazor:{title:"UO Razor Script",owner:"jaseowns"},uri:{title:"URI",alias:"url",aliasTitles:{url:"URL"},owner:"RunDevelopment"},v:{title:"V",require:"clike",owner:"taggon"},vala:{title:"Vala",require:"clike",optional:"regex",owner:"TemplarVolk"},vbnet:{title:"VB.Net",require:"basic",owner:"Bigsby"},velocity:{title:"Velocity",require:"markup",owner:"Golmote"},verilog:{title:"Verilog",owner:"a-rey"},vhdl:{title:"VHDL",owner:"a-rey"},vim:{title:"vim",owner:"westonganger"},"visual-basic":{title:"Visual Basic",alias:["vb","vba"],aliasTitles:{vba:"VBA"},owner:"Golmote"},warpscript:{title:"WarpScript",owner:"RunDevelopment"},wasm:{title:"WebAssembly",owner:"Golmote"},"web-idl":{title:"Web IDL",alias:"webidl",owner:"RunDevelopment"},wgsl:{title:"WGSL",owner:"Dr4gonthree"},wiki:{title:"Wiki markup",require:"markup",owner:"Golmote"},wolfram:{title:"Wolfram language",alias:["mathematica","nb","wl"],aliasTitles:{mathematica:"Mathematica",nb:"Mathematica Notebook"},owner:"msollami"},wren:{title:"Wren",owner:"clsource"},xeora:{title:"Xeora",require:"markup",alias:"xeoracube",aliasTitles:{xeoracube:"XeoraCube"},owner:"freakmaxi"},"xml-doc":{title:"XML doc (.net)",require:"markup",modify:["csharp","fsharp","vbnet"],owner:"RunDevelopment"},xojo:{title:"Xojo (REALbasic)",owner:"Golmote"},xquery:{title:"XQuery",require:"markup",owner:"Golmote"},yaml:{title:"YAML",alias:"yml",owner:"hason"},yang:{title:"YANG",owner:"RunDevelopment"},zig:{title:"Zig",owner:"RunDevelopment"}},plugins:{meta:{path:"plugins/{id}/prism-{id}",link:"plugins/{id}/"},"line-highlight":{title:"Line Highlight",description:"Highlights specific lines and/or line ranges."},"line-numbers":{title:"Line Numbers",description:"Line number at the beginning of code lines.",owner:"kuba-kubula"},"show-invisibles":{title:"Show Invisibles",description:"Show hidden characters such as tabs and line breaks.",optional:["autolinker","data-uri-highlight"]},autolinker:{title:"Autolinker",description:"Converts URLs and emails in code to clickable links. Parses Markdown links in comments."},wpd:{title:"WebPlatform Docs",description:'Makes tokens link to WebPlatform.org documentation. The links open in a new tab.'},"custom-class":{title:"Custom Class",description:"This plugin allows you to prefix Prism's default classes (.comment can become .namespace--comment) or replace them with your defined ones (like .editor__comment). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll and highlightAllUnder methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},2885:(e,t,n)=>{const r=n(9901),a=n(9642),o=new Set;function i(e){void 0===e?e=Object.keys(r.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...o,...Object.keys(Prism.languages)];a(r,e,t).load((e=>{if(!(e in r.languages))return void(i.silent||console.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(6500).resolve(t)],delete Prism.languages[e],n(6500)(t),o.add(e)}))}i.silent=!1,e.exports=i},6726:(e,t,n)=>{var r={"./":2885};function a(e){var t=o(e);return n(t)}function o(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}a.keys=function(){return Object.keys(r)},a.resolve=o,e.exports=a,a.id=6726},6500:(e,t,n)=>{var r={"./":2885};function a(e){var t=o(e);return n(t)}function o(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}a.keys=function(){return Object.keys(r)},a.resolve=o,e.exports=a,a.id=6500},9642:e=>{"use strict";var t=function(){var e=function(){};function t(e,t){Array.isArray(e)?e.forEach(t):null!=e&&t(e,0)}function n(e){for(var t={},n=0,r=e.length;n "));var l={},s=e[r];if(s){function u(t){if(!(t in e))throw new Error(r+" depends on an unknown component "+t);if(!(t in l))for(var i in a(t,o),l[t]=!0,n[t])l[i]=!0}t(s.require,u),t(s.optional,u),t(s.modify,u)}n[r]=l,o.pop()}}return function(e){var t=n[e];return t||(a(e,r),t=n[e]),t}}function a(e){for(var t in e)return!0;return!1}return function(o,i,l){var s=function(e){var t={};for(var n in e){var r=e[n];for(var a in r)if("meta"!=a){var o=r[a];t[a]="string"==typeof o?{title:o}:o}}return t}(o),u=function(e){var n;return function(r){if(r in e)return r;if(!n)for(var a in n={},e){var o=e[a];t(o&&o.alias,(function(t){if(t in n)throw new Error(t+" cannot be alias for both "+a+" and "+n[t]);if(t in e)throw new Error(t+" cannot be alias of "+a+" because it is a component.");n[t]=a}))}return n[r]||r}}(s);i=i.map(u),l=(l||[]).map(u);var c=n(i),d=n(l);i.forEach((function e(n){var r=s[n];t(r&&r.require,(function(t){t in d||(c[t]=!0,e(t))}))}));for(var p,f=r(s),m=c;a(m);){for(var h in p={},m){var g=s[h];t(g&&g.modify,(function(e){e in d&&(p[e]=!0)}))}for(var b in d)if(!(b in c))for(var v in f(b))if(v in c){p[b]=!0;break}for(var y in m=p)c[y]=!0}var w={getIds:function(){var e=[];return w.load((function(t){e.push(t)})),e},load:function(t,n){return function(t,n,r,a){var o=a?a.series:void 0,i=a?a.parallel:e,l={},s={};function u(e){if(e in l)return l[e];s[e]=!0;var a,c=[];for(var d in t(e))d in n&&c.push(d);if(0===c.length)a=r(e);else{var p=i(c.map((function(e){var t=u(e);return delete s[e],t})));o?a=o(p,(function(){return r(e)})):r(e)}return l[e]=a}for(var c in n)u(c);var d=[];for(var p in s)d.push(l[p]);return i(d)}(f,c,t,n)}};return w}}();e.exports=t},2703:(e,t,n)=>{"use strict";var r=n(414);function a(){}function o(){}o.resetWarningCache=a,e.exports=function(){function e(e,t,n,a,o,i){if(i!==r){var l=new Error("Calling PropTypes validators directly is not supported by the `prop-types` package. Use PropTypes.checkPropTypes() to call them. Read more at http://fb.me/use-check-prop-types");throw l.name="Invariant Violation",l}}function t(){return e}e.isRequired=e;var n={array:e,bigint:e,bool:e,func:e,number:e,object:e,string:e,symbol:e,any:e,arrayOf:t,element:e,elementType:e,instanceOf:t,node:e,objectOf:t,oneOf:t,oneOfType:t,shape:t,exact:t,checkPropTypes:o,resetWarningCache:a};return n.PropTypes=n,n}},5697:(e,t,n)=>{e.exports=n(2703)()},414:e=>{"use strict";e.exports="SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED"},4448:(e,t,n)=>{"use strict";var r=n(7294),a=n(7418),o=n(3840);function i(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n