diff --git a/build.log b/build.log new file mode 100644 index 000000000..71178f756 --- /dev/null +++ b/build.log @@ -0,0 +1,50 @@ +Using remote mode. gh version 2.40.1 (2023-12-13) +https://github.com/cli/cli/releases/tag/v2.40.1 + +Fetching releases... +Fetched releases: +[ + { name: 'components', release: 'v1.3.0' }, + { name: 'fragment', release: 'v1.3.0' } +] +Cloning minified repositories... +Cloned repositories: +[ + { + directory: '/home/runner/work/docs/docs/temp/components', + branch: 'v1.3.0' + }, + { + directory: '/home/runner/work/docs/docs/temp/fragment', + branch: 'v1.3.0' + } +] +Finished copying and setting up repositories! +➤ YN0000: · Yarn 4.0.1 +➤ YN0000: ┌ Resolution step +::group::Resolution step +➤ YN0085: │ + @popperjs/core@npm:2.11.8, @rollup/plugin-commonjs@npm:25.0.0, @rollup/plugin-node-resolve@npm:15.1.0, @tailwindcss/forms@npm:0.5.7, and 542 more. +::endgroup:: +➤ YN0000: └ Completed in 5s 327ms +➤ YN0000: ┌ Fetch step +::group::Fetch step +➤ YN0013: │ 546 packages were added to the project (+ 293.41 MiB). +::endgroup:: +➤ YN0000: └ Completed in 5s 653ms +➤ YN0000: ┌ Link step +::group::Link step +::endgroup:: +➤ YN0000: └ Completed in 4s 408ms +➤ YN0000: · Done in 15s 520ms +[INFO] [en] Creating an optimized production build... +[info] Loaded plugin typedoc-plugin-markdown +[info] Converting project at ./temp/components +[info] Converting project at ./temp/fragment +[info] Merging converted projects +[info] Documentation generated at ./docs/api +[info] [webpackbar] Compiling Client +[info] [webpackbar] Compiling Server +[success] [webpackbar] Client: Compiled successfully in 24.57s +[success] [webpackbar] Server: Compiled successfully in 28.46s +[SUCCESS] Generated static files in "build". +[INFO] Use `npm run serve` command to test your build locally. diff --git a/build/404.html b/build/404.html index c520a2fdb..11ced4d78 100644 --- a/build/404.html +++ b/build/404.html @@ -4,13 +4,13 @@ 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 4945ac6b1..15ec4669d 100644 --- a/build/Tutorials/AngleMeasurement/index.html +++ b/build/Tutorials/AngleMeasurement/index.html @@ -4,8 +4,8 @@ AngleMeasurement | That Open Docs - - + +
@@ -33,8 +33,8 @@ 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.

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 b143cc715..01a94b85a 100644 --- a/build/Tutorials/AreaMeasurement/index.html +++ b/build/Tutorials/AreaMeasurement/index.html @@ -4,8 +4,8 @@ AreaMeasurement | That Open Docs - - + +
@@ -33,8 +33,8 @@ 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.

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 9258ba852..6dc9e723b 100644 --- a/build/Tutorials/EdgesClipper/index.html +++ b/build/Tutorials/EdgesClipper/index.html @@ -4,8 +4,8 @@ EdgesClipper | That Open Docs - - + +
@@ -28,8 +28,8 @@ 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 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 3c3beb5dc..052eec0d0 100644 --- a/build/Tutorials/FragmentBoundingBox/index.html +++ b/build/Tutorials/FragmentBoundingBox/index.html @@ -4,8 +4,8 @@ FragmentBoundingBox | That Open Docs - - + +
@@ -21,8 +21,8 @@ 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/FragmentCacher/index.html b/build/Tutorials/FragmentCacher/index.html index 2b4301d15..ba048d41c 100644 --- a/build/Tutorials/FragmentCacher/index.html +++ b/build/Tutorials/FragmentCacher/index.html @@ -4,8 +4,8 @@ FragmentCacher | That Open Docs - - + +
@@ -24,8 +24,8 @@ you can simply use the methods getFragmentGroup and saveFragmentGroup.

Congratulations! Now you know how to cache fragments, so that the next time your user opens an IFC that was already processed, they will see it load super fast, almost like magic! Now, let's continue our journey with more -tutorials.
- - +tutorials.
+ + \ No newline at end of file diff --git a/build/Tutorials/FragmentClipStyler/index.html b/build/Tutorials/FragmentClipStyler/index.html index fba7f5ca6..9e6a8a4cc 100644 --- a/build/Tutorials/FragmentClipStyler/index.html +++ b/build/Tutorials/FragmentClipStyler/index.html @@ -4,8 +4,8 @@ FragmentClipStyler | That Open Docs - - + +
@@ -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 185c2877d..4c12f1640 100644 --- a/build/Tutorials/FragmentExploder/index.html +++ b/build/Tutorials/FragmentExploder/index.html @@ -4,8 +4,8 @@ FragmentExploder | That Open Docs - - + +
@@ -19,8 +19,8 @@ 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);
container.addEventListener("mouseup", () => culler.needsUpdate = true);
container.addEventListener("wheel", () => culler.needsUpdate = true);
for(const fragment of model.items) {
culler.add(fragment.mesh);
}
culler.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 b3b76c16c..c41515a61 100644 --- a/build/Tutorials/FragmentHider/index.html +++ b/build/Tutorials/FragmentHider/index.html @@ -4,8 +4,8 @@ FragmentHider | That Open Docs - - + +
@@ -35,8 +35,8 @@ 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 d300b26b8..a8fff856f 100644 --- a/build/Tutorials/FragmentHighlighter/index.html +++ b/build/Tutorials/FragmentHighlighter/index.html @@ -4,8 +4,8 @@ FragmentHighlighter | That Open Docs - - + +
@@ -26,8 +26,8 @@ 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 2ea9c5e68..45b1614cc 100644 --- a/build/Tutorials/FragmentIfcLoader/index.html +++ b/build/Tutorials/FragmentIfcLoader/index.html @@ -4,8 +4,8 @@ FragmentIfcLoader | That Open Docs - - + +
@@ -47,8 +47,8 @@ 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/FragmentManager/index.html b/build/Tutorials/FragmentManager/index.html index 24e3e96d1..6a0ee8925 100644 --- a/build/Tutorials/FragmentManager/index.html +++ b/build/Tutorials/FragmentManager/index.html @@ -4,8 +4,8 @@ FragmentManager | That Open Docs - - + +
@@ -25,8 +25,8 @@ 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 e3e406a2d..8068fbbc5 100644 --- a/build/Tutorials/FragmentPlans/index.html +++ b/build/Tutorials/FragmentPlans/index.html @@ -4,8 +4,8 @@ FragmentPlans | That Open Docs - - + +
@@ -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 3dd25eb5f..9492f2e6c 100644 --- a/build/Tutorials/FragmentTree/index.html +++ b/build/Tutorials/FragmentTree/index.html @@ -4,8 +4,8 @@ FragmentTree | That Open Docs - - + +
@@ -25,8 +25,8 @@ 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 4e106b3f8..eef6428a6 100644 --- a/build/Tutorials/IfcPropertiesFinder/index.html +++ b/build/Tutorials/IfcPropertiesFinder/index.html @@ -4,8 +4,8 @@ IfcPropertiesFinder | That Open Docs - - + +
@@ -26,8 +26,8 @@ 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 26478dd56..134b45e86 100644 --- a/build/Tutorials/IfcPropertiesManager/index.html +++ b/build/Tutorials/IfcPropertiesManager/index.html @@ -4,8 +4,8 @@ IfcPropertiesManager | That Open Docs - - + +
@@ -15,11 +15,11 @@ 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");
model.properties = await properties.json();

Then, we'll instance the tool that we need for editing properties: the IfcPropertiesManager! It's designed as an extension of the IfcPropertiesProcessor, so if you haven't seen that tutorial -yet, check it out before reading further.

const propsProcessor = new OBC.IfcPropertiesProcessor(components);
const propsManager = new OBC.IfcPropertiesManager(components);
propsProcessor.propertiesManager = propsManager;

The IfcPropertiesManager can edit IFCs and export new IFC models, -so we will need to get access to the same WASM files we needed when -using the FragmentIfcLoader (as it uses the web-ifc library -directly). We can do it in a similar way, and then initialize the -properties manager and process the model:

propsManager.wasm = {
path: "https://unpkg.com/web-ifc@0.0.46/",
absolute: true
}
await propsManager.init();
propsProcessor.process(model);
propsManager.onRequestFile.add(async () => {
const fetched = await fetch("../../../resources/small.ifc");
propsManager.ifcToExport = await fetched.arrayBuffer();
})

✨ Setting up highlighting and selecting​

Now, we will set up highlighting logic to make our app more +yet, check it out before reading further.

const propsProcessor = new OBC.IfcPropertiesProcessor(components);
const propsManager = new OBC.IfcPropertiesManager(components);
propsProcessor.propertiesManager = propsManager;

The IfcPropertiesManager can edit IFCs and export new IFC models. +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");
propsManager.ifcToExport = await fetched.arrayBuffer();
})

✨ 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 @@ -27,8 +27,8 @@ tutorial:

highlighterEvents.select.onHighlight.add(
(selection) => {
const fragmentID = Object.keys(selection)[0];
const expressID = Number([...selection[fragmentID]][0]);
let model
for (const group of fragments.groups) {
const fragmentFound = Object.values(group.keyFragments).find(id => id === fragmentID)
if (fragmentFound) model = group;
}
propsProcessor.renderProperties(model, 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 a88522494..32f0c1723 100644 --- a/build/Tutorials/IfcPropertiesProcessor/index.html +++ b/build/Tutorials/IfcPropertiesProcessor/index.html @@ -4,8 +4,8 @@ IfcPropertiesProcessor | That Open Docs - - + +
@@ -20,8 +20,8 @@ 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 = Number([...selection[fragmentID]][0]);
let model
for (const group of fragments.groups) {
const fragmentFound = Object.values(group.keyFragments).find(id => id === fragmentID)
if (fragmentFound) model = group;
}
propsProcessor.renderProperties(model, expressID);
}
);

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 3e5337794..20aa8b1e3 100644 --- a/build/Tutorials/LengthMeasurement/index.html +++ b/build/Tutorials/LengthMeasurement/index.html @@ -4,8 +4,8 @@ LengthMeasurement | That Open Docs - - + +
@@ -33,8 +33,8 @@ 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.

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 cb7935109..73ac875f8 100644 --- a/build/Tutorials/MaterialManager/index.html +++ b/build/Tutorials/MaterialManager/index.html @@ -4,8 +4,8 @@ MaterialManager | That Open Docs - - + +
@@ -25,8 +25,8 @@ 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!

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 b24e274d9..9712516e7 100644 --- a/build/Tutorials/MiniMap/index.html +++ b/build/Tutorials/MiniMap/index.html @@ -4,8 +4,8 @@ MiniMap | That Open Docs - - + +
@@ -21,8 +21,8 @@ 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 0a1ab34f2..61b04700b 100644 --- a/build/Tutorials/OrthoPerspectiveCamera/index.html +++ b/build/Tutorials/OrthoPerspectiveCamera/index.html @@ -4,8 +4,8 @@ OrthoPerspectiveCamera | That Open Docs - - + +
@@ -27,8 +27,8 @@ 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 d0ccd7e06..66a094f29 100644 --- a/build/Tutorials/PostproductionRenderer/index.html +++ b/build/Tutorials/PostproductionRenderer/index.html @@ -4,8 +4,8 @@ PostproductionRenderer | That Open Docs - - + +
@@ -15,8 +15,8 @@ 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);
for (const fragment of model.items) {
meshes.push(fragment.mesh);
culler.add(fragment.mesh);
}
culler.needsUpdate = true;
const controls = components.camera.controls;
controls.addEventListener('controlend', () => {
culler.needsUpdate = true;
});

🎬 Activating the Post-Production​

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

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 bf5d71290..096ccf8d3 100644 --- a/build/Tutorials/ScreenCuller/index.html +++ b/build/Tutorials/ScreenCuller/index.html @@ -4,8 +4,8 @@ ScreenCuller | That Open Docs - - + +
@@ -13,7 +13,7 @@ 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. 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);

Additionally, we will activate the culler.renderDebugFrame +This will create a Screen Culler which is now ready to be used.

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

Additionally, we will activate the culler.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.renderDebugFrame = true;
const debugFrame = culler.renderer.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 @@ -30,8 +30,8 @@ In this tutorial we are updating it each time the camera stops moving.

culler.needsUpdate = true;
components.camera.controls.addEventListener("controlend", () => {
culler.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 572d5c72c..f37e56f67 100644 --- a/build/Tutorials/ShadowDropper/index.html +++ b/build/Tutorials/ShadowDropper/index.html @@ -4,8 +4,8 @@ ShadowDropper | That Open Docs - - + +
@@ -25,8 +25,8 @@ 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 e58842909..8a933d058 100644 --- a/build/Tutorials/Simple2DScene/index.html +++ b/build/Tutorials/Simple2DScene/index.html @@ -4,8 +4,8 @@ Simple2DScene | That Open Docs - - + +
@@ -16,8 +16,8 @@ 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. 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) {
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 e4f64a86f..d7ce0fe68 100644 --- a/build/Tutorials/SimpleClipper/index.html +++ b/build/Tutorials/SimpleClipper/index.html @@ -4,8 +4,8 @@ SimpleClipper | That Open Docs - - + +
@@ -31,8 +31,8 @@ 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 3d82d4c8b..9d07dfd30 100644 --- a/build/Tutorials/SimpleRaycaster/index.html +++ b/build/Tutorials/SimpleRaycaster/index.html @@ -4,8 +4,8 @@ SimpleRaycaster | That Open Docs - - + +
@@ -21,8 +21,8 @@ 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 bcdd1502e..815b49afb 100644 --- a/build/Tutorials/SimpleScene/index.html +++ b/build/Tutorials/SimpleScene/index.html @@ -4,8 +4,8 @@ SimpleScene | That Open Docs - - + +
@@ -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 87ae386c9..599f2f4ab 100644 --- a/build/Tutorials/ToolsComponent/index.html +++ b/build/Tutorials/ToolsComponent/index.html @@ -4,8 +4,8 @@ ToolsComponent | That Open Docs - - + +
@@ -30,8 +30,8 @@ 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 9859999b7..bdf3fab88 100644 --- a/build/Tutorials/UIManager/index.html +++ b/build/Tutorials/UIManager/index.html @@ -4,8 +4,8 @@ UIManager | That Open Docs - - + +
@@ -37,8 +37,8 @@ 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 index 2a5f9e8bf..b52baffc7 100644 --- a/build/api/classes/bim_fragment.Serializer/index.html +++ b/build/api/classes/bim_fragment.Serializer/index.html @@ -4,14 +4,14 @@ 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.

- - +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 2f637fa78..cf57bc486 100644 --- a/build/api/classes/openbim_components.BaseRenderer/index.html +++ b/build/api/classes/openbim_components.BaseRenderer/index.html @@ -4,23 +4,23 @@ 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​

src/base-types/base-renderer.ts:33

enabled​

• Abstract enabled: boolean

Whether this component is active or not. The behaviour can vary depending +instance of the renderer.

Defined in​

temp/components/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​

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 +will not be updated automatically each frame.

Inherited from​

Component.enabled

Defined in​

temp/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/components/src/base-types/base-renderer.ts:27

onResize​

• Readonly onResize: Event<any>

Resizeable.onResize

Implementation of​

Resizeable.onResize

Defined in​

temp/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/components/src/base-types/component.ts:30

getSize​

▸ getSize(): Vector2

Resizeable.getSize.

Returns​

Vector2

Implementation of​

Resizeable.getSize

Defined in​

temp/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/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/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/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/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/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/components/src/base-types/component.ts:45

resize​

▸ resize(): void

Resizeable.resize.

Returns​

void

Implementation of​

Resizeable.resize

Defined in​

temp/components/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​

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

- - +to the renderer.

Parameters​

NameType
activeboolean
planePlane
isLocal?boolean

Returns​

void

Defined in​

temp/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/components/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 0a26ab4e6..9267d4050 100644 --- a/build/api/classes/openbim_components.CloudStorage/index.html +++ b/build/api/classes/openbim_components.CloudStorage/index.html @@ -4,15 +4,15 @@ 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​

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

- - +
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/components/src/services/CloudStorage/index.ts:18

name​

• name: string = "CloudProcessor"

Component.name

Defined in​

temp/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/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/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/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/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/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/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/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/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/components/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 57df17a58..f6375d546 100644 --- a/build/api/classes/openbim_components.Component/index.html +++ b/build/api/classes/openbim_components.Component/index.html @@ -4,8 +4,8 @@ Class: Component<Type> | That Open Docs - - + +
@@ -15,9 +15,9 @@ 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​

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

- - +will not be updated automatically each frame.

Defined in​

temp/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/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/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/components/src/base-types/component.ts:57

isDisposeable​

▸ isDisposeable(): this is Disposable

Whether is component is Disposable.

Returns​

this is Disposable

Defined in​

temp/components/src/base-types/component.ts:35

isHideable​

▸ isHideable(): this is Hideable

Whether is component is Hideable.

Returns​

this is Hideable

Defined in​

temp/components/src/base-types/component.ts:52

isResizeable​

▸ isResizeable(): this is Resizeable

Whether is component is Resizeable.

Returns​

this is Resizeable

Defined in​

temp/components/src/base-types/component.ts:40

isUpdateable​

▸ isUpdateable(): this is Updateable

Whether is component is Updateable.

Returns​

this is Updateable

Defined in​

temp/components/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 f0545b145..896731579 100644 --- a/build/api/classes/openbim_components.Components/index.html +++ b/build/api/classes/openbim_components.Components/index.html @@ -4,32 +4,32 @@ Class: Components | That Open Docs - - + +
Skip to main content

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.

Properties​

meshes​

• Readonly meshes: Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[] = []

All the loaded meshes. -This includes fragments, 3D scans, etc.

Defined in​

src/core/Components/index.ts:29

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:40

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:98

• 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:108

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:116

• 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:127

renderer​

• get renderer(): BaseRenderer

The Three.js renderer +loop of everything. Each instance has to be initialized with init.

Implements​

Properties​

meshes​

• Readonly meshes: Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[] = []

All the loaded meshes. +This includes fragments, 3D scans, etc.

Defined in​

temp/components/src/core/Components/index.ts:29

onDisposed​

• Readonly onDisposed: Event<string>

Disposable.onDisposed

Implementation of​

Disposable.onDisposed

Defined in​

temp/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/components/src/core/Components/index.ts:35

tools​

• Readonly tools: ToolComponent

ToolComponent

Defined in​

temp/components/src/core/Components/index.ts:23

uiEnabled​

• uiEnabled: boolean = true

Whether UI components should be created.

Defined in​

temp/components/src/core/Components/index.ts:43

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/components/src/core/Components/index.ts:101

• set camera(camera): void

This needs to be initialized before calling init().

Parameters​

NameType
cameraComponent<Camera>

Returns​

void

Defined in​

temp/components/src/core/Components/index.ts:111

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/components/src/core/Components/index.ts:119

• 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/components/src/core/Components/index.ts:130

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​

src/core/Components/index.ts:62

• set renderer(renderer): void

This needs to be initialized before calling init().

Parameters​

NameType
rendererBaseRenderer

Returns​

void

Defined in​

src/core/Components/index.ts:72

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:80

• 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:90

ui​

• get ui(): UIManager

UIManager

Returns​

UIManager

Defined in​

src/core/Components/index.ts:50

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​

temp/components/src/core/Components/index.ts:65

• set renderer(renderer): void

This needs to be initialized before calling init().

Parameters​

NameType
rendererBaseRenderer

Returns​

void

Defined in​

temp/components/src/core/Components/index.ts:75

scene​

• get scene(): Component<Scene>

The Three.js scene +where all the rendered items are placed.

Returns​

Component<Scene>

Defined in​

temp/components/src/core/Components/index.ts:83

• set scene(scene): void

This needs to be initialized before calling init().

Parameters​

NameType
sceneComponent<Scene>

Returns​

void

Defined in​

temp/components/src/core/Components/index.ts:93

ui​

• get ui(): UIManager

UIManager

Returns​

UIManager

Defined in​

temp/components/src/core/Components/index.ts:53

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>

Defined in​

src/core/Components/index.ts:169

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​

temp/components/src/core/Components/index.ts:172

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​

src/core/Components/index.ts:143

- - +used, the raycaster will need to be initialized.

Returns​

Promise<void>

Defined in​

temp/components/src/core/Components/index.ts:146

+ + \ 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 21a08b959..9ad073009 100644 --- a/build/api/classes/openbim_components.CubeMap/index.html +++ b/build/api/classes/openbim_components.CubeMap/index.html @@ -4,14 +4,14 @@ 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​

src/navigation/CubeMap/index.ts:37

offset​

• offset: number = 1

The minimum zoom distance to the scene.

Defined in​

src/navigation/CubeMap/index.ts:46

onAfterUpdate​

• Readonly onAfterUpdate: Event<CubeMap>

Updateable.onAfterUpdate

Implementation of​

Updateable.onAfterUpdate

Defined in​

src/navigation/CubeMap/index.ts:40

onBeforeUpdate​

• Readonly onBeforeUpdate: Event<CubeMap>

Updateable.onBeforeUpdate

Implementation of​

Updateable.onBeforeUpdate

Defined in​

src/navigation/CubeMap/index.ts:43

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

- - +left, right, back and front).

Hierarchy​

Implements​

Properties​

enabled​

• enabled: boolean = true

Component.enabled

Overrides​

Component.enabled

Defined in​

temp/components/src/navigation/CubeMap/index.ts:40

offset​

• offset: number = 1

The minimum zoom distance to the scene.

Defined in​

temp/components/src/navigation/CubeMap/index.ts:49

onAfterUpdate​

• Readonly onAfterUpdate: Event<CubeMap>

Updateable.onAfterUpdate

Implementation of​

Updateable.onAfterUpdate

Defined in​

temp/components/src/navigation/CubeMap/index.ts:43

onBeforeUpdate​

• Readonly onBeforeUpdate: Event<CubeMap>

Updateable.onBeforeUpdate

Implementation of​

Updateable.onBeforeUpdate

Defined in​

temp/components/src/navigation/CubeMap/index.ts:46

onDisposed​

• Readonly onDisposed: Event<string>

Disposable.onDisposed

Implementation of​

Disposable.onDisposed

Defined in​

temp/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/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/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/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/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/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/components/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 bd5b08756..47c4ed7f5 100644 --- a/build/api/classes/openbim_components.Disposer/index.html +++ b/build/api/classes/openbim_components.Disposer/index.html @@ -4,16 +4,16 @@ 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​

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 +prevent memory leaks.

Hierarchy​

Properties​

enabled​

• enabled: boolean = true

Component.enabled

Overrides​

Component.enabled

Defined in​

temp/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 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<Event>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

- - +remove them from the mesh before disposing it.

Parameters​

NameTypeDefault valueDescription
objectObject3D<Event>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/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/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/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/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/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/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/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/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/components/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 3c9c229b4..af0c11229 100644 --- a/build/api/classes/openbim_components.EdgesClipper/index.html +++ b/build/api/classes/openbim_components.EdgesClipper/index.html @@ -4,20 +4,20 @@ 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​

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

orthogonalY​

• orthogonalY: boolean = false

Whether to force the clipping plane to be orthogonal in the Y direction +ClippingEdges with customizable lines.

Hierarchy​

Properties​

onAfterCreate​

• Readonly onAfterCreate: Event<EdgesPlane>

Createable.onAfterCreate

Inherited from​

SimpleClipper.onAfterCreate

Defined in​

temp/components/src/core/SimpleClipper/index.ts:35

onAfterDelete​

• Readonly onAfterDelete: Event<EdgesPlane>

Createable.onAfterDelete

Inherited from​

SimpleClipper.onAfterDelete

Defined in​

temp/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/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/components/src/core/SimpleClipper/index.ts:41

onDisposed​

• Readonly onDisposed: Event<string>

Disposable.onDisposed

Inherited from​

SimpleClipper.onDisposed

Defined in​

temp/components/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​

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 +slope for draining purposes.

Inherited from​

SimpleClipper.orthogonalY

Defined in​

temp/components/src/core/SimpleClipper/index.ts:60

styles​

• styles: EdgesStyles

The list of defined LineStyle instances.

Defined in​

temp/components/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​

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:85

• set enabled(state): void

Component.enabled

Parameters​

NameType
stateboolean

Returns​

void

Inherited from​

SimpleClipper.enabled

Defined in​

src/core/SimpleClipper/index.ts:90

material​

• get material(): Material

The material of the clipping plane representation.

Returns​

Material

Inherited from​

SimpleClipper.material

Defined in​

src/core/SimpleClipper/index.ts:115

• 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:120

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:128

• 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:133

visible​

• get visible(): boolean

Hideable.visible

Returns​

boolean

Inherited from​

SimpleClipper.visible

Defined in​

src/core/SimpleClipper/index.ts:102

• set visible(state): void

Hideable.visible

Parameters​

NameType
stateboolean

Returns​

void

Inherited from​

SimpleClipper.visible

Defined in​

src/core/SimpleClipper/index.ts:107

Methods​

create​

▸ create(): void

Createable.create

Returns​

void

Inherited from​

SimpleClipper.create

Defined in​

src/core/SimpleClipper/index.ts:179

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:195

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:210

deleteAll​

▸ deleteAll(): void

Deletes all the existing clipping planes.

Returns​

void

Inherited from​

SimpleClipper.deleteAll

Defined in​

src/core/SimpleClipper/index.ts:222

dispose​

▸ dispose(): Promise<void>

Component.get

Returns​

Promise<void>

Overrides​

SimpleClipper.dispose

Defined in​

src/navigation/EdgesClipper/index.ts:26

get​

▸ get(): EdgesPlane[]

Component.get

Returns​

EdgesPlane[]

Inherited from​

SimpleClipper.get

Defined in​

src/core/SimpleClipper/index.ts:155

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:34

- - +has to be true for this to apply.

Inherited from​

SimpleClipper.toleranceOrthogonalY

Defined in​

temp/components/src/core/SimpleClipper/index.ts:67

uiElement​

• uiElement: UIElement<{ main: Button }>

UI.uiElement

Inherited from​

SimpleClipper.uiElement

Defined in​

temp/components/src/core/SimpleClipper/index.ts:52

Accessors​

enabled​

• get enabled(): boolean

Component.enabled

Returns​

boolean

Inherited from​

SimpleClipper.enabled

Defined in​

temp/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/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/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/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/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/components/src/core/SimpleClipper/index.ts:136

visible​

• get visible(): boolean

Hideable.visible

Returns​

boolean

Inherited from​

SimpleClipper.visible

Defined in​

temp/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/components/src/core/SimpleClipper/index.ts:110

Methods​

create​

▸ create(): void

Createable.create

Returns​

void

Inherited from​

SimpleClipper.create

Defined in​

temp/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/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/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/components/src/core/SimpleClipper/index.ts:227

dispose​

▸ dispose(): Promise<void>

Component.get

Returns​

Promise<void>

Overrides​

SimpleClipper.dispose

Defined in​

temp/components/src/navigation/EdgesClipper/index.ts:26

get​

▸ get(): EdgesPlane[]

Component.get

Returns​

EdgesPlane[]

Inherited from​

SimpleClipper.get

Defined in​

temp/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/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/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/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/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/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/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/components/src/navigation/EdgesClipper/index.ts:34

+ + \ 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 595c71cc8..57f11a846 100644 --- a/build/api/classes/openbim_components.EdgesPlane/index.html +++ b/build/api/classes/openbim_components.EdgesPlane/index.html @@ -4,15 +4,15 @@ 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​

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

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:37

meshes​

• get meshes(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]

The meshes used for raycasting

Returns​

Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]

Inherited from​

SimplePlane.meshes

Defined in​

src/core/SimpleClipper/simple-plane.ts:68

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:73

• 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:78

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:83

• 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:88

visible​

• get visible(): boolean

Hideable.visible

Returns​

boolean

Inherited from​

SimplePlane.visible

Defined in​

src/core/SimpleClipper/simple-plane.ts:55

• set visible(state): void

Hideable.visible

Parameters​

NameType
stateboolean

Returns​

void

Inherited from​

SimplePlane.visible

Defined in​

src/core/SimpleClipper/simple-plane.ts:60

Methods​

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Overrides​

SimplePlane.dispose

Defined in​

src/navigation/EdgesClipper/src/edges-plane.ts:42

get​

▸ get(): Plane

Component.get

Returns​

Plane

Inherited from​

SimplePlane.get

Defined in​

src/core/SimpleClipper/simple-plane.ts:134

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:48

update​

▸ update(): Promise<void>

Updateable.update

Returns​

Promise<void>

Overrides​

SimplePlane.update

Defined in​

src/navigation/EdgesClipper/src/edges-plane.ts:70

- - +To disable this behaviour set this to 0.

Defined in​

temp/components/src/navigation/EdgesClipper/src/edges-plane.ts:17

name​

• name: string = "SimplePlane"

Component.name

Inherited from​

SimplePlane.name

Defined in​

temp/components/src/core/SimpleClipper/simple-plane.ts:14

onDisposed​

• Readonly onDisposed: Event<undefined>

Disposable.onDisposed

Inherited from​

SimplePlane.onDisposed

Defined in​

temp/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/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/components/src/core/SimpleClipper/simple-plane.ts:17

Accessors​

enabled​

• get enabled(): boolean

Component.enabled

Returns​

boolean

Overrides​

SimplePlane.enabled

Defined in​

temp/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/components/src/navigation/EdgesClipper/src/edges-plane.ts:37

meshes​

• get meshes(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]

The meshes used for raycasting

Returns​

Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]

Inherited from​

SimplePlane.meshes

Defined in​

temp/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/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/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/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/components/src/core/SimpleClipper/simple-plane.ts:91

visible​

• get visible(): boolean

Hideable.visible

Returns​

boolean

Inherited from​

SimplePlane.visible

Defined in​

temp/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/components/src/core/SimpleClipper/simple-plane.ts:63

Methods​

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Overrides​

SimplePlane.dispose

Defined in​

temp/components/src/navigation/EdgesClipper/src/edges-plane.ts:48

get​

▸ get(): Plane

Component.get

Returns​

Plane

Inherited from​

SimplePlane.get

Defined in​

temp/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/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/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/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/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/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/components/src/base-types/component.ts:45

setEnabled​

▸ setEnabled(state): Promise<void>

Component.enabled

Parameters​

NameType
stateboolean

Returns​

Promise<void>

Defined in​

temp/components/src/navigation/EdgesClipper/src/edges-plane.ts:54

update​

▸ update(): Promise<void>

Updateable.update

Returns​

Promise<void>

Overrides​

SimplePlane.update

Defined in​

temp/components/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 529b8e354..c6c2db4e2 100644 --- a/build/api/classes/openbim_components.Event/index.html +++ b/build/api/classes/openbim_components.Event/index.html @@ -4,8 +4,8 @@ Class: Event<T> | That Open Docs - - + +
@@ -13,8 +13,8 @@ Jason Kleban. Keep in mind that:

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:18

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:26

reset​

▸ reset(): void

Gets rid of all the suscribed events.

Returns​

void

Defined in​

src/base-types/base-types.ts:39

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:31

- - +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/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/components/src/base-types/base-types.ts:27

reset​

▸ reset(): void

Gets rid of all the suscribed events.

Returns​

void

Defined in​

temp/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/components/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 a9038b172..c7316da61 100644 --- a/build/api/classes/openbim_components.FragmentBoundingBox/index.html +++ b/build/api/classes/openbim_components.FragmentBoundingBox/index.html @@ -4,14 +4,14 @@ 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​

src/fragments/FragmentBoundingBox/index.ts:15

Methods​

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

src/fragments/FragmentBoundingBox/index.ts:68

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

- - +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/components/src/fragments/FragmentBoundingBox/index.ts:17

onDisposed​

• Readonly onDisposed: Event<string>

Disposable.onDisposed

Implementation of​

Disposable.onDisposed

Defined in​

temp/components/src/fragments/FragmentBoundingBox/index.ts:20

Methods​

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

temp/components/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​

temp/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/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/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/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/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/components/src/base-types/component.ts:45

+ + \ No newline at end of file diff --git a/build/api/classes/openbim_components.FragmentIfcLoader/index.html b/build/api/classes/openbim_components.FragmentIfcLoader/index.html index ccf62295f..83832ef98 100644 --- a/build/api/classes/openbim_components.FragmentIfcLoader/index.html +++ b/build/api/classes/openbim_components.FragmentIfcLoader/index.html @@ -4,16 +4,16 @@ Class: FragmentIfcLoader | That Open Docs - - + +
Skip to main content

Class: FragmentIfcLoader

openbim-components.FragmentIfcLoader

Reads all the geometry of the IFC file and generates a set of fragments. It can also return the properties as a JSON file, as well as other sets of information within -the IFC file.

Hierarchy​

  • Component<WEBIFC.IfcAPI>

    ↳ FragmentIfcLoader

Implements​

Methods​

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

src/fragments/FragmentIfcLoader/index.ts:59

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, name): Promise<FragmentsGroup>

Loads the IFC file and converts it to a set of fragments.

Parameters​

NameType
dataUint8Array
namestring

Returns​

Promise<FragmentsGroup>

Defined in​

src/fragments/FragmentIfcLoader/index.ts:71

- - +the IFC file.

Hierarchy​

Implements​

Properties​

onDisposed​

• Readonly onDisposed: Event<string>

Disposable.onDisposed

Implementation of​

Disposable.onDisposed

Defined in​

temp/components/src/fragments/FragmentIfcLoader/index.ts:25

Methods​

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

temp/components/src/fragments/FragmentIfcLoader/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/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/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/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/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/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/components/src/base-types/component.ts:45

load​

▸ load(data, name): Promise<FragmentsGroup>

Loads the IFC file and converts it to a set of fragments.

Parameters​

NameType
dataUint8Array
namestring

Returns​

Promise<FragmentsGroup>

Defined in​

temp/components/src/fragments/FragmentIfcLoader/index.ts:77

+ + \ 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 6d2a10237..36a45983c 100644 --- a/build/api/classes/openbim_components.FragmentManager/index.html +++ b/build/api/classes/openbim_components.FragmentManager/index.html @@ -4,14 +4,14 @@ 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​

src/fragments/FragmentManager/index.ts:23

list​

• list: Object = {}

All the created fragments.

Index signature​

▪ [guid: string]: Fragment

Defined in​

src/fragments/FragmentManager/index.ts:26

Accessors​

meshes​

• get meshes(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]

The list of meshes of the created fragments.

Returns​

Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]

Defined in​

src/fragments/FragmentManager/index.ts:45

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:69

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:134

get​

▸ get(): Fragment[]

Component.get

Returns​

Fragment[]

Overrides​

Component.get

Defined in​

src/fragments/FragmentManager/index.ts:64

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): Promise<FragmentsGroup>

Loads one or many fragments into the scene.

Parameters​

NameTypeDescription
dataUint8Arraythe bytes containing the data for the fragments to load.

Returns​

Promise<FragmentsGroup>

the list of IDs of the loaded fragments.

Defined in​

src/fragments/FragmentManager/index.ts:113

reset​

▸ reset(): void

Disposes all existing fragments

Returns​

void

Defined in​

src/fragments/FragmentManager/index.ts:100

- - +fragment geometry.

Hierarchy​

Implements​

Properties​

enabled​

• enabled: boolean = true

Component.enabled

Overrides​

Component.enabled

Defined in​

temp/components/src/fragments/FragmentManager/index.ts:29

list​

• list: Object = {}

All the created fragments.

Index signature​

▪ [guid: string]: Fragment

Defined in​

temp/components/src/fragments/FragmentManager/index.ts:32

onDisposed​

• Readonly onDisposed: Event<string>

Disposable.onDisposed

Implementation of​

Disposable.onDisposed

Defined in​

temp/components/src/fragments/FragmentManager/index.ts:26

Accessors​

meshes​

• get meshes(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]

The list of meshes of the created fragments.

Returns​

Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]

Defined in​

temp/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/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/components/src/fragments/FragmentManager/index.ts:153

get​

▸ get(): Fragment[]

Component.get

Returns​

Fragment[]

Overrides​

Component.get

Defined in​

temp/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/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/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/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/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/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/components/src/base-types/component.ts:45

load​

▸ load(data): Promise<FragmentsGroup>

Loads one or many fragments into the scene.

Parameters​

NameTypeDescription
dataUint8Arraythe bytes containing the data for the fragments to load.

Returns​

Promise<FragmentsGroup>

the list of IDs of the loaded fragments.

Defined in​

temp/components/src/fragments/FragmentManager/index.ts:132

reset​

▸ reset(): void

Disposes all existing fragments

Returns​

void

Defined in​

temp/components/src/fragments/FragmentManager/index.ts:119

+ + \ 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 970e51e84..be425c331 100644 --- a/build/api/classes/openbim_components.FragmentPlans/index.html +++ b/build/api/classes/openbim_components.FragmentPlans/index.html @@ -4,13 +4,13 @@ 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​

src/fragments/FragmentPlans/index.ts:41

defaultCameraOffset​

• defaultCameraOffset: number = 30

The offset of the 2D camera to the floor plan elevation.

Defined in​

src/fragments/FragmentPlans/index.ts:47

defaultSectionOffset​

• defaultSectionOffset: number = 1.5

The offset from the clipping planes to their respective floor plan elevation.

Defined in​

src/fragments/FragmentPlans/index.ts:44

enabled​

• enabled: boolean = false

Component.enabled

Overrides​

Component.enabled

Defined in​

src/fragments/FragmentPlans/index.ts:38

storeys​

• storeys: Object = []

The created floor plans.

Index signature​

▪ [modelID: number]: any[]

Defined in​

src/fragments/FragmentPlans/index.ts:50

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:55

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:150

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

src/fragments/FragmentPlans/index.ts:96

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:194

get​

▸ get(): PlanView[]

Component.get

Returns​

PlanView[]

Overrides​

Component.get

Defined in​

src/fragments/FragmentPlans/index.ts:91

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:169

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

- - +
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/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/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/components/src/fragments/FragmentPlans/index.ts:47

enabled​

• enabled: boolean = false

Component.enabled

Overrides​

Component.enabled

Defined in​

temp/components/src/fragments/FragmentPlans/index.ts:41

onDisposed​

• Readonly onDisposed: Event<string>

Disposable.onDisposed

Implementation of​

Disposable.onDisposed

Defined in​

temp/components/src/fragments/FragmentPlans/index.ts:34

storeys​

• storeys: Object = []

The created floor plans.

Index signature​

▪ [modelID: number]: any[]

Defined in​

temp/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/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/components/src/fragments/FragmentPlans/index.ts:155

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

temp/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/components/src/fragments/FragmentPlans/index.ts:199

get​

▸ get(): PlanView[]

Component.get

Returns​

PlanView[]

Overrides​

Component.get

Defined in​

temp/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/components/src/fragments/FragmentPlans/index.ts:174

hasUI​

▸ hasUI(): this is UI

Whether is component implements any kind of UI.

Returns​

this is UI

Inherited from​

Component.hasUI

Defined in​

temp/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/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/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/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/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/components/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 469eb4b4d..d02e9487a 100644 --- a/build/api/classes/openbim_components.IfcJsonExporter/index.html +++ b/build/api/classes/openbim_components.IfcJsonExporter/index.html @@ -4,13 +4,13 @@ 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): Promise<void>

Exports all the properties of an IFC into an array of JS objects.

Parameters​

NameType
webIfcIfcAPI
modelIDnumber

Returns​

Promise<void>

Web Ifc

The instance of [web-ifc][https://github.com/ifcjs/web-ifc](https://github.com/ifcjs/web-ifc) to use.

Model ID

ID of the IFC model whose properties to extract.

Defined in​

src/ifc/IfcJsonExporter/index.ts:21

- - +
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): Promise<void>

Exports all the properties of an IFC into an array of JS objects.

Parameters​

NameType
webIfcIfcAPI
modelIDnumber

Returns​

Promise<void>

Web Ifc

The instance of [web-ifc][https://github.com/ifcjs/web-ifc](https://github.com/ifcjs/web-ifc) to use.

Model ID

ID of the IFC model whose properties to extract.

Defined in​

temp/components/src/ifc/IfcJsonExporter/index.ts:21

+ + \ 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 04479f07b..e12447c50 100644 --- a/build/api/classes/openbim_components.LengthMeasurement/index.html +++ b/build/api/classes/openbim_components.LengthMeasurement/index.html @@ -4,16 +4,16 @@ 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​

src/measurement/LengthMeasurement/index.ts:51

onAfterCreate​

• Readonly onAfterCreate: Event<SimpleDimensionLine>

Createable.onAfterCreate

Implementation of​

Createable.onAfterCreate

Defined in​

src/measurement/LengthMeasurement/index.ts:36

onAfterDelete​

• Readonly onAfterDelete: Event<LengthMeasurement>

Createable.onAfterDelete

Implementation of​

Createable.onAfterDelete

Defined in​

src/measurement/LengthMeasurement/index.ts:42

onAfterUpdate​

• Readonly onAfterUpdate: Event<LengthMeasurement>

Updateable.onAfterUpdate

Implementation of​

Updateable.onAfterUpdate

Defined in​

src/measurement/LengthMeasurement/index.ts:33

onBeforeCancel​

• Readonly onBeforeCancel: Event<LengthMeasurement>

Createable.onBeforeCancel

Implementation of​

Createable.onBeforeCancel

Defined in​

src/measurement/LengthMeasurement/index.ts:48

onBeforeCreate​

• Readonly onBeforeCreate: Event<LengthMeasurement>

Createable.onBeforeCreate

Implementation of​

Createable.onBeforeCreate

Defined in​

src/measurement/LengthMeasurement/index.ts:39

onBeforeDelete​

• Readonly onBeforeDelete: Event<SimpleDimensionLine>

Createable.onBeforeDelete

Implementation of​

Createable.onBeforeDelete

Defined in​

src/measurement/LengthMeasurement/index.ts:45

onBeforeUpdate​

• Readonly onBeforeUpdate: Event<LengthMeasurement>

Updateable.onBeforeUpdate

Implementation of​

Updateable.onBeforeUpdate

Defined in​

src/measurement/LengthMeasurement/index.ts:30

previewElement​

• Optional previewElement: HTMLElement

The symbol -that is displayed where the dimension will be drawn.

Defined in​

src/measurement/LengthMeasurement/index.ts:60

snapDistance​

• snapDistance: number = 0.25

The minimum distance to force the dimension cursor to a vertex.

Defined in​

src/measurement/LengthMeasurement/index.ts:56

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:119

enabled​

• get enabled(): boolean

Component.enabled

Returns​

boolean

Overrides​

Component.enabled

Defined in​

src/measurement/LengthMeasurement/index.ts:84

• set enabled(value): void

Component.enabled

Parameters​

NameType
valueboolean

Returns​

void

Overrides​

Component.enabled

Defined in​

src/measurement/LengthMeasurement/index.ts:89

visible​

• get visible(): boolean

Hideable.visible

Returns​

boolean

Implementation of​

Hideable.visible

Defined in​

src/measurement/LengthMeasurement/index.ts:100

• set visible(value): void

Hideable.visible

Parameters​

NameType
valueboolean

Returns​

void

Implementation of​

Hideable.visible

Defined in​

src/measurement/LengthMeasurement/index.ts:105

Methods​

cancelCreation​

▸ cancelCreation(): void

Cancels the drawing of the current dimension.

Returns​

void

Implementation of​

Createable.cancelCreation

Defined in​

src/measurement/LengthMeasurement/index.ts:240

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:202

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:214

deleteAll​

▸ deleteAll(): Promise<void>

Deletes all the dimensions that have been previously created.

Returns​

Promise<void>

Defined in​

src/measurement/LengthMeasurement/index.ts:231

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

src/measurement/LengthMeasurement/index.ts:162

get​

▸ get(): SimpleDimensionLine[]

Component.get

Returns​

SimpleDimensionLine[]

Overrides​

Component.get

Defined in​

src/measurement/LengthMeasurement/index.ts:157

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

- - +display a 3D symbol displaying the numeric value.

Hierarchy​

Implements​

Properties​

onAfterCancel​

• Readonly onAfterCancel: Event<SimpleDimensionLine>

Createable.onAfterCancel

Implementation of​

Createable.onAfterCancel

Defined in​

temp/components/src/measurement/LengthMeasurement/index.ts:54

onAfterCreate​

• Readonly onAfterCreate: Event<SimpleDimensionLine>

Createable.onAfterCreate

Implementation of​

Createable.onAfterCreate

Defined in​

temp/components/src/measurement/LengthMeasurement/index.ts:39

onAfterDelete​

• Readonly onAfterDelete: Event<LengthMeasurement>

Createable.onAfterDelete

Implementation of​

Createable.onAfterDelete

Defined in​

temp/components/src/measurement/LengthMeasurement/index.ts:45

onAfterUpdate​

• Readonly onAfterUpdate: Event<LengthMeasurement>

Updateable.onAfterUpdate

Implementation of​

Updateable.onAfterUpdate

Defined in​

temp/components/src/measurement/LengthMeasurement/index.ts:36

onBeforeCancel​

• Readonly onBeforeCancel: Event<LengthMeasurement>

Createable.onBeforeCancel

Implementation of​

Createable.onBeforeCancel

Defined in​

temp/components/src/measurement/LengthMeasurement/index.ts:51

onBeforeCreate​

• Readonly onBeforeCreate: Event<LengthMeasurement>

Createable.onBeforeCreate

Implementation of​

Createable.onBeforeCreate

Defined in​

temp/components/src/measurement/LengthMeasurement/index.ts:42

onBeforeDelete​

• Readonly onBeforeDelete: Event<SimpleDimensionLine>

Createable.onBeforeDelete

Implementation of​

Createable.onBeforeDelete

Defined in​

temp/components/src/measurement/LengthMeasurement/index.ts:48

onBeforeUpdate​

• Readonly onBeforeUpdate: Event<LengthMeasurement>

Updateable.onBeforeUpdate

Implementation of​

Updateable.onBeforeUpdate

Defined in​

temp/components/src/measurement/LengthMeasurement/index.ts:33

onDisposed​

• Readonly onDisposed: Event<string>

Disposable.onDisposed

Implementation of​

Disposable.onDisposed

Defined in​

temp/components/src/measurement/LengthMeasurement/index.ts:30

previewElement​

• Optional previewElement: HTMLElement

The symbol +that is displayed where the dimension will be drawn.

Defined in​

temp/components/src/measurement/LengthMeasurement/index.ts:63

snapDistance​

• snapDistance: number = 0.25

The minimum distance to force the dimension cursor to a vertex.

Defined in​

temp/components/src/measurement/LengthMeasurement/index.ts:59

Accessors​

color​

• set color(color): void

The Color +of the geometry of the dimensions.

Parameters​

NameType
colorColor

Returns​

void

Defined in​

temp/components/src/measurement/LengthMeasurement/index.ts:122

enabled​

• get enabled(): boolean

Component.enabled

Returns​

boolean

Overrides​

Component.enabled

Defined in​

temp/components/src/measurement/LengthMeasurement/index.ts:87

• set enabled(value): void

Component.enabled

Parameters​

NameType
valueboolean

Returns​

void

Overrides​

Component.enabled

Defined in​

temp/components/src/measurement/LengthMeasurement/index.ts:92

visible​

• get visible(): boolean

Hideable.visible

Returns​

boolean

Implementation of​

Hideable.visible

Defined in​

temp/components/src/measurement/LengthMeasurement/index.ts:103

• set visible(value): void

Hideable.visible

Parameters​

NameType
valueboolean

Returns​

void

Implementation of​

Hideable.visible

Defined in​

temp/components/src/measurement/LengthMeasurement/index.ts:108

Methods​

cancelCreation​

▸ cancelCreation(): void

Cancels the drawing of the current dimension.

Returns​

void

Implementation of​

Createable.cancelCreation

Defined in​

temp/components/src/measurement/LengthMeasurement/index.ts:254

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/components/src/measurement/LengthMeasurement/index.ts:207

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/components/src/measurement/LengthMeasurement/index.ts:219

deleteAll​

▸ deleteAll(): Promise<void>

Deletes all the dimensions that have been previously created.

Returns​

Promise<void>

Defined in​

temp/components/src/measurement/LengthMeasurement/index.ts:245

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

temp/components/src/measurement/LengthMeasurement/index.ts:165

get​

▸ get(): SimpleDimensionLine[]

Component.get

Returns​

SimpleDimensionLine[]

Overrides​

Component.get

Defined in​

temp/components/src/measurement/LengthMeasurement/index.ts:160

hasUI​

▸ hasUI(): this is UI

Whether is component implements any kind of UI.

Returns​

this is UI

Inherited from​

Component.hasUI

Defined in​

temp/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/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/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/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/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/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/components/src/measurement/LengthMeasurement/index.ts:191

+ + \ No newline at end of file diff --git a/build/api/classes/openbim_components.LocalCacher/index.html b/build/api/classes/openbim_components.LocalCacher/index.html index ec11c863a..bf441f787 100644 --- a/build/api/classes/openbim_components.LocalCacher/index.html +++ b/build/api/classes/openbim_components.LocalCacher/index.html @@ -4,15 +4,15 @@ Class: LocalCacher | That Open Docs - - + +
Skip to main content

Class: LocalCacher

openbim-components.LocalCacher

A tool to cache files using the browser's IndexedDB API. This might save loading time and infrastructure costs for files that need to be -fetched from the cloud.

Hierarchy​

Implements​

Properties​

enabled​

• enabled: boolean = true

Component.enabled

Overrides​

Component.enabled

Defined in​

src/core/LocalCacher/index.ts:24

onFileLoaded​

• Readonly onFileLoaded: Event<{ id: string }>

Fires when a file has been loaded from cache.

Defined in​

src/core/LocalCacher/index.ts:18

onItemSaved​

• Readonly onItemSaved: Event<{ id: string }>

Fires when a file has been saved into cache.

Defined in​

src/core/LocalCacher/index.ts:21

uiElement​

• uiElement: UIElement<{ floatingMenu: FloatingWindow ; loadButton: Button ; main: Button ; saveButton: Button }>

UI.uiElement

Implementation of​

UI.uiElement

Defined in​

src/core/LocalCacher/index.ts:27

Accessors​

ids​

• get ids(): string[]

The IDs of all the stored files.

Returns​

string[]

Defined in​

src/core/LocalCacher/index.ts:40

Methods​

delete​

▸ delete(ids): Promise<void>

Deletes the files stored in the given ids.

Parameters​

NameTypeDescription
idsstring[]the identifiers of the files to delete.

Returns​

Promise<void>

Defined in​

src/core/LocalCacher/index.ts:99

deleteAll​

▸ deleteAll(): Promise<void>

Deletes all the stored files.

Returns​

Promise<void>

Defined in​

src/core/LocalCacher/index.ts:111

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

src/core/LocalCacher/index.ts:120

exists​

▸ exists(id): boolean

Checks if there's a file stored with the given ID.

Parameters​

NameTypeDescription
idstringto check.

Returns​

boolean

Defined in​

src/core/LocalCacher/index.ts:90

get​

▸ get(id): Promise<null | Blob>

Component.get.

Parameters​

NameTypeDescription
idstringthe ID of the file to fetch.

Returns​

Promise<null | Blob>

Overrides​

Component.get

Defined in​

src/core/LocalCacher/index.ts:58

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

save​

▸ save(id, url): Promise<void>

Saves the file with the given ID.

Parameters​

NameTypeDescription
idstringthe ID to assign to the file.
urlstringthe URL where the file is located.

Returns​

Promise<void>

Defined in​

src/core/LocalCacher/index.ts:74

- - +fetched from the cloud.

Hierarchy​

Implements​

Properties​

enabled​

• enabled: boolean = true

Component.enabled

Overrides​

Component.enabled

Defined in​

temp/components/src/core/LocalCacher/index.ts:31

onDisposed​

• Readonly onDisposed: Event<string>

Disposable.onDisposed

Implementation of​

Disposable.onDisposed

Defined in​

temp/components/src/core/LocalCacher/index.ts:28

onFileLoaded​

• Readonly onFileLoaded: Event<{ id: string }>

Fires when a file has been loaded from cache.

Defined in​

temp/components/src/core/LocalCacher/index.ts:22

onItemSaved​

• Readonly onItemSaved: Event<{ id: string }>

Fires when a file has been saved into cache.

Defined in​

temp/components/src/core/LocalCacher/index.ts:25

uiElement​

• uiElement: UIElement<{ floatingMenu: FloatingWindow ; loadButton: Button ; main: Button ; saveButton: Button }>

UI.uiElement

Implementation of​

UI.uiElement

Defined in​

temp/components/src/core/LocalCacher/index.ts:34

Accessors​

ids​

• get ids(): string[]

The IDs of all the stored files.

Returns​

string[]

Defined in​

temp/components/src/core/LocalCacher/index.ts:47

Methods​

delete​

▸ delete(ids): Promise<void>

Deletes the files stored in the given ids.

Parameters​

NameTypeDescription
idsstring[]the identifiers of the files to delete.

Returns​

Promise<void>

Defined in​

temp/components/src/core/LocalCacher/index.ts:106

deleteAll​

▸ deleteAll(): Promise<void>

Deletes all the stored files.

Returns​

Promise<void>

Defined in​

temp/components/src/core/LocalCacher/index.ts:118

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

temp/components/src/core/LocalCacher/index.ts:127

exists​

▸ exists(id): boolean

Checks if there's a file stored with the given ID.

Parameters​

NameTypeDescription
idstringto check.

Returns​

boolean

Defined in​

temp/components/src/core/LocalCacher/index.ts:97

get​

▸ get(id): Promise<null | Blob>

Component.get.

Parameters​

NameTypeDescription
idstringthe ID of the file to fetch.

Returns​

Promise<null | Blob>

Overrides​

Component.get

Defined in​

temp/components/src/core/LocalCacher/index.ts:65

hasUI​

▸ hasUI(): this is UI

Whether is component implements any kind of UI.

Returns​

this is UI

Inherited from​

Component.hasUI

Defined in​

temp/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/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/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/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/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/components/src/base-types/component.ts:45

save​

▸ save(id, url): Promise<void>

Saves the file with the given ID.

Parameters​

NameTypeDescription
idstringthe ID to assign to the file.
urlstringthe URL where the file is located.

Returns​

Promise<void>

Defined in​

temp/components/src/core/LocalCacher/index.ts:81

+ + \ No newline at end of file diff --git a/build/api/classes/openbim_components.MapboxWindow/index.html b/build/api/classes/openbim_components.MapboxWindow/index.html index 20883985b..91bbceaf7 100644 --- a/build/api/classes/openbim_components.MapboxWindow/index.html +++ b/build/api/classes/openbim_components.MapboxWindow/index.html @@ -4,15 +4,15 @@ Class: MapboxWindow | That Open Docs - - + +
-
Skip to main content

Class: MapboxWindow

openbim-components.MapboxWindow

The main element to create a mapbox-IFC.js application.

Constructors​

constructor​

• new MapboxWindow(config): MapboxWindow

Parameters​

NameType
configMapboxParameters

Returns​

MapboxWindow

Defined in​

src/integrations/mapbox/index.ts:27

Methods​

add​

▸ add(buildings, fitToScreen?): void

Add a new set of buildings to the GIS scene.

Parameters​

NameTypeDefault valueDescription
buildingsMapboxBuilding[]undefinedThe array of MapboxBuilding to add.
fitToScreenbooleantrueWhether to center the camera to see all buildings.

Returns​

void

Defined in​

src/integrations/mapbox/index.ts:44

dispose​

▸ dispose(): Promise<void>

Disposes all the data of the map. This needs to be called if the +

Class: MapboxWindow

openbim-components.MapboxWindow

The main element to create a mapbox-IFC.js application.

Constructors​

constructor​

• new MapboxWindow(config): MapboxWindow

Parameters​

NameType
configMapboxParameters

Returns​

MapboxWindow

Defined in​

temp/components/src/integrations/mapbox/index.ts:27

Methods​

add​

▸ add(buildings, fitToScreen?): void

Add a new set of buildings to the GIS scene.

Parameters​

NameTypeDefault valueDescription
buildingsMapboxBuilding[]undefinedThe array of MapboxBuilding to add.
fitToScreenbooleantrueWhether to center the camera to see all buildings.

Returns​

void

Defined in​

temp/components/src/integrations/mapbox/index.ts:44

dispose​

▸ dispose(): Promise<void>

Disposes all the data of the map. This needs to be called if the component that contains the map is deleted: otherwise, a memory leak -will be created.

Returns​

Promise<void>

Defined in​

src/integrations/mapbox/index.ts:107

remove​

▸ remove(id): void

Removes a building from the map.

Parameters​

NameTypeDescription
idstringThe MapboxBuilding to remove.

Returns​

void

Defined in​

src/integrations/mapbox/index.ts:81

removeAll​

▸ removeAll(): void

Removes all buildings from the map.

Returns​

void

Defined in​

src/integrations/mapbox/index.ts:96

- - +will be created.

Returns​

Promise<void>

Defined in​

temp/components/src/integrations/mapbox/index.ts:107

remove​

▸ remove(id): void

Removes a building from the map.

Parameters​

NameTypeDescription
idstringThe MapboxBuilding to remove.

Returns​

void

Defined in​

temp/components/src/integrations/mapbox/index.ts:81

removeAll​

▸ removeAll(): void

Removes all buildings from the map.

Returns​

void

Defined in​

temp/components/src/integrations/mapbox/index.ts:96

+ + \ 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 7af0e8dae..b2001e051 100644 --- a/build/api/classes/openbim_components.MaterialManager/index.html +++ b/build/api/classes/openbim_components.MaterialManager/index.html @@ -4,15 +4,15 @@ 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​

src/core/MaterialManager/index.ts:17

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:120

addMeshes​

▸ addMeshes(id, meshes): void

Assign meshes to a certain style.

Parameters​

NameTypeDescription
idstringthe identifier of the style.
meshesMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]the meshes to assign to the style.

Returns​

void

Defined in​

src/core/MaterialManager/index.ts:132

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

src/core/MaterialManager/index.ts:80

get​

▸ get(): string[]

Component.get.

Returns​

string[]

list of created materials.

Overrides​

Component.get

Defined in​

src/core/MaterialManager/index.ts:44

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

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:108

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:54

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:94

- - +objects and scene background easily.

Hierarchy​

Implements​

Properties​

enabled​

• enabled: boolean = true

Component.enabled

Overrides​

Component.enabled

Defined in​

temp/components/src/core/MaterialManager/index.ts:17

onDisposed​

• Readonly onDisposed: Event<string>

Disposable.onDisposed

Implementation of​

Disposable.onDisposed

Defined in​

temp/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/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[]>[]the meshes to assign to the style.

Returns​

void

Defined in​

temp/components/src/core/MaterialManager/index.ts:137

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

temp/components/src/core/MaterialManager/index.ts:83

get​

▸ get(): string[]

Component.get.

Returns​

string[]

list of created materials.

Overrides​

Component.get

Defined in​

temp/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/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/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/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/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/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/components/src/base-types/component.ts:45

resetBackgroundColor​

▸ resetBackgroundColor(): void

Resets the scene background to the color that was being used +before applying the material manager.

Returns​

void

Defined in​

temp/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/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/components/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 4c006c963..7fe9bdc47 100644 --- a/build/api/classes/openbim_components.Mouse/index.html +++ b/build/api/classes/openbim_components.Mouse/index.html @@ -4,16 +4,16 @@ 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 to work with tools like the raycaster, even if it has -been transformed through CSS or doesn't occupy the whole screen.

Implements​

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:21

Methods​

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

src/base-types/mouse.ts:31

- - +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/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/components/src/base-types/mouse.ts:24

Methods​

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

temp/components/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 a03c8b56e..6bec40dc5 100644 --- a/build/api/classes/openbim_components.OrthoPerspectiveCamera/index.html +++ b/build/api/classes/openbim_components.OrthoPerspectiveCamera/index.html @@ -4,23 +4,23 @@ Class: OrthoPerspectiveCamera | That Open Docs - - + +
Skip to main content

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​

src/core/SimpleCamera/index.ts:45

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​

temp/components/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​

src/core/SimpleCamera/index.ts:30

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

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:33

• set enabled(enabled): void

Component.enabled

Parameters​

NameType
enabledboolean

Returns​

void

Inherited from​

SimpleCamera.enabled

Defined in​

src/core/SimpleCamera/index.ts:38

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
meshesMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]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:76

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:88

- - +object to move, rotate, look at objects, etc.

Inherited from​

SimpleCamera.controls

Defined in​

temp/components/src/core/SimpleCamera/index.ts:33

currentMode​

• currentMode: NavigationMode

The current NavigationMode.

Defined in​

temp/components/src/navigation/OrthoPerspectiveCamera/index.ts:24

onAfterUpdate​

• Readonly onAfterUpdate: Event<SimpleCamera>

Updateable.onAfterUpdate

Inherited from​

SimpleCamera.onAfterUpdate

Defined in​

temp/components/src/core/SimpleCamera/index.ts:20

onBeforeUpdate​

• Readonly onBeforeUpdate: Event<SimpleCamera>

Updateable.onBeforeUpdate

Inherited from​

SimpleCamera.onBeforeUpdate

Defined in​

temp/components/src/core/SimpleCamera/index.ts:17

onDisposed​

• Readonly onDisposed: Event<string>

Disposable.onDisposed

Inherited from​

SimpleCamera.onDisposed

Defined in​

temp/components/src/core/SimpleCamera/index.ts:25

projectionChanged​

• Readonly projectionChanged: Event<Camera>

Event that fires when the CameraProjection changes.

Defined in​

temp/components/src/navigation/OrthoPerspectiveCamera/index.ts:29

Accessors​

enabled​

• get enabled(): boolean

Component.enabled

Returns​

boolean

Inherited from​

SimpleCamera.enabled

Defined in​

temp/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/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/components/src/navigation/OrthoPerspectiveCamera/index.ts:136

Methods​

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Overrides​

SimpleCamera.dispose

Defined in​

temp/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
meshesMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]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/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/components/src/navigation/OrthoPerspectiveCamera/index.ts:121

getProjection​

▸ getProjection(): CameraProjection

Returns the current CameraProjection.

Returns​

CameraProjection

Defined in​

temp/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/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/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/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/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/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/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/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/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/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/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/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/components/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 d2b94155a..7e518d724 100644 --- a/build/api/classes/openbim_components.PostproductionRenderer/index.html +++ b/build/api/classes/openbim_components.PostproductionRenderer/index.html @@ -4,18 +4,18 @@ 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​

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:32

onBeforeUpdate​

• Readonly onBeforeUpdate: Event<SimpleRenderer>

Updateable.onBeforeUpdate

Inherited from​

SimpleRenderer.onBeforeUpdate

Defined in​

src/core/SimpleRenderer/index.ts:29

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

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:72

getSize​

▸ getSize(): Vector2

Resizeable.getSize.

Returns​

Vector2

Inherited from​

SimpleRenderer.getSize

Defined in​

src/core/SimpleRenderer/index.ts:101

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:109

togglePlane​

▸ togglePlane(active, plane, isLocal?): void

Adds or removes a +instance of the renderer.

Inherited from​

SimpleRenderer.clippingPlanes

Defined in​

temp/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/components/src/core/SimpleRenderer/index.ts:26

enabled​

• enabled: boolean = true

Component.enabled

Inherited from​

SimpleRenderer.enabled

Defined in​

temp/components/src/core/SimpleRenderer/index.ts:23

onAfterUpdate​

• Readonly onAfterUpdate: Event<SimpleRenderer>

Updateable.onAfterUpdate

Inherited from​

SimpleRenderer.onAfterUpdate

Defined in​

temp/components/src/core/SimpleRenderer/index.ts:35

onBeforeUpdate​

• Readonly onBeforeUpdate: Event<SimpleRenderer>

Updateable.onBeforeUpdate

Inherited from​

SimpleRenderer.onBeforeUpdate

Defined in​

temp/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/components/src/base-types/base-renderer.ts:27

onDisposed​

• Readonly onDisposed: Event<undefined>

Disposable.onDisposed

Inherited from​

SimpleRenderer.onDisposed

Defined in​

temp/components/src/core/SimpleRenderer/index.ts:29

onResize​

• Readonly onResize: Event<any>

Resizeable.onResize

Inherited from​

SimpleRenderer.onResize

Defined in​

temp/components/src/base-types/base-renderer.ts:21

postproduction​

• postproduction: Postproduction

Helper object to handle the postproduction effects applied.

Defined in​

temp/components/src/navigation/PostproductionRenderer/index.ts:11

Methods​

dispose​

▸ dispose(): Promise<void>

Disposable.dispose.

Returns​

Promise<void>

Overrides​

SimpleRenderer.dispose

Defined in​

temp/components/src/navigation/PostproductionRenderer/index.ts:41

get​

▸ get(): WebGLRenderer

Component.get

Returns​

WebGLRenderer

Inherited from​

SimpleRenderer.get

Defined in​

temp/components/src/core/SimpleRenderer/index.ts:75

getSize​

▸ getSize(): Vector2

Resizeable.getSize.

Returns​

Vector2

Inherited from​

SimpleRenderer.getSize

Defined in​

temp/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/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/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/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/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/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/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/components/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​

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

- - +to the renderer.

Parameters​

NameType
activeboolean
planePlane
isLocal?boolean

Returns​

void

Inherited from​

SimpleRenderer.togglePlane

Defined in​

temp/components/src/base-types/base-renderer.ts:48

update​

▸ update(): Promise<void>

Updateable.update

Returns​

Promise<void>

Overrides​

SimpleRenderer.update

Defined in​

temp/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/components/src/base-types/base-renderer.ts:39

+ + \ 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 855e30a10..edc13d222 100644 --- a/build/api/classes/openbim_components.ScreenCuller/index.html +++ b/build/api/classes/openbim_components.ScreenCuller/index.html @@ -4,17 +4,17 @@ 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​

enabled​

• enabled: boolean = true

Component.enabled

Overrides​

Component.enabled

Defined in​

src/core/ScreenCuller/index.ts:25

needsUpdate​

• needsUpdate: boolean = false

Needs to check whether there are objects that need to be hidden or shown. -You can bind this to the camera movement, to a certain interval, etc.

Defined in​

src/core/ScreenCuller/index.ts:31

onViewUpdated​

• Readonly onViewUpdated: Event<unknown>

Fires after hiding the objects that were not visible to the camera.

Defined in​

src/core/ScreenCuller/index.ts:22

renderDebugFrame​

• renderDebugFrame: boolean = false

Render the internal scene used to determine the object visibility. Used -for debugging purposes.

Defined in​

src/core/ScreenCuller/index.ts:37

Methods​

add​

▸ add(mesh): void

Adds a new mesh to be processed and managed by the culler.

Parameters​

NameType
meshMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]> | InstancedMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>

Returns​

void

Mesh

the mesh or instanced mesh to add.

Defined in​

src/core/ScreenCuller/index.ts:146

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

src/core/ScreenCuller/index.ts:112

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:107

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>

The function that the culler uses to reprocess the scene. Generally it's -better to call needsUpdate, but you can also call this to force it.

Parameters​

NameTypeDescription
force?booleanif true, it will refresh the scene even if needsUpdate is not true.

Returns​

Promise<void>

Defined in​

src/core/ScreenCuller/index.ts:213

- - +that are not visible to the camera.

Hierarchy​

Implements​

Properties​

enabled​

• enabled: boolean = true

Component.enabled

Overrides​

Component.enabled

Defined in​

temp/components/src/core/ScreenCuller/index.ts:38

needsUpdate​

• needsUpdate: boolean = false

Needs to check whether there are objects that need to be hidden or shown. +You can bind this to the camera movement, to a certain interval, etc.

Defined in​

temp/components/src/core/ScreenCuller/index.ts:44

onDisposed​

• Readonly onDisposed: Event<string>

Disposable.onDisposed

Implementation of​

Disposable.onDisposed

Defined in​

temp/components/src/core/ScreenCuller/index.ts:32

onViewUpdated​

• Readonly onViewUpdated: Event<unknown>

Fires after hiding the objects that were not visible to the camera.

Defined in​

temp/components/src/core/ScreenCuller/index.ts:35

renderDebugFrame​

• renderDebugFrame: boolean = false

Render the internal scene used to determine the object visibility. Used +for debugging purposes.

Defined in​

temp/components/src/core/ScreenCuller/index.ts:50

Methods​

add​

▸ add(mesh): void

Adds a new mesh to be processed and managed by the culler.

Parameters​

NameType
meshMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]> | InstancedMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>

Returns​

void

Mesh

the mesh or instanced mesh to add.

Defined in​

temp/components/src/core/ScreenCuller/index.ts:169

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

temp/components/src/core/ScreenCuller/index.ts:132

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/components/src/core/ScreenCuller/index.ts:127

hasUI​

▸ hasUI(): this is UI

Whether is component implements any kind of UI.

Returns​

this is UI

Inherited from​

Component.hasUI

Defined in​

temp/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/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/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/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/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/components/src/base-types/component.ts:45

updateVisibility​

▸ updateVisibility(force?): Promise<void>

The function that the culler uses to reprocess the scene. Generally it's +better to call needsUpdate, but you can also call this to force it.

Parameters​

NameTypeDescription
force?booleanif true, it will refresh the scene even if needsUpdate is not true.

Returns​

Promise<void>

Defined in​

temp/components/src/core/ScreenCuller/index.ts:251

+ + \ 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 1aabdbc62..75654246e 100644 --- a/build/api/classes/openbim_components.Simple2DScene/index.html +++ b/build/api/classes/openbim_components.Simple2DScene/index.html @@ -4,14 +4,14 @@ 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​

src/core/Simple2DScene/index.ts:52

controls​

• controls: OrbitControls

The camera controls that move around in the scene.

Defined in​

src/core/Simple2DScene/index.ts:49

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

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:44

Methods​

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

src/core/Simple2DScene/index.ts:147

get​

▸ get(): Group

Component.get

Returns​

Group

the 2D scene.

Overrides​

Component.get

Defined in​

src/core/Simple2DScene/index.ts:142

getSize​

▸ getSize(): Vector2

Resizeable.getSize

Returns​

Vector2

Implementation of​

Resizeable.getSize

Defined in​

src/core/Simple2DScene/index.ts:168

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:179

update​

▸ update(): Promise<void>

Updateable.update

Returns​

Promise<void>

Implementation of​

Updateable.update

Defined in​

src/core/Simple2DScene/index.ts:160

- - +with all the power of Three.js.

Hierarchy​

Implements​

Properties​

camera​

• Readonly camera: OrthographicCamera

The camera that renders the scene.

Defined in​

temp/components/src/core/Simple2DScene/index.ts:55

controls​

• controls: OrbitControls

The camera controls that move around in the scene.

Defined in​

temp/components/src/core/Simple2DScene/index.ts:52

enabled​

• enabled: boolean = true

Component.enabled

Overrides​

Component.enabled

Defined in​

temp/components/src/core/Simple2DScene/index.ts:41

onAfterUpdate​

• Readonly onAfterUpdate: Event<unknown>

Updateable.onAfterUpdate

Implementation of​

Updateable.onAfterUpdate

Defined in​

temp/components/src/core/Simple2DScene/index.ts:32

onBeforeUpdate​

• Readonly onBeforeUpdate: Event<unknown>

Updateable.onBeforeUpdate

Implementation of​

Updateable.onBeforeUpdate

Defined in​

temp/components/src/core/Simple2DScene/index.ts:35

onDisposed​

• Readonly onDisposed: Event<string>

Disposable.onDisposed

Implementation of​

Disposable.onDisposed

Defined in​

temp/components/src/core/Simple2DScene/index.ts:44

onResize​

• onResize: Event<Vector2>

Resizeable.onResize

Implementation of​

Resizeable.onResize

Defined in​

temp/components/src/core/Simple2DScene/index.ts:38

uiElement​

• uiElement: UIElement<{ container: SimpleUIComponent<HTMLElement> }>

UI.uiElement

Implementation of​

UI.uiElement

Defined in​

temp/components/src/core/Simple2DScene/index.ts:47

Methods​

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

temp/components/src/core/Simple2DScene/index.ts:150

get​

▸ get(): Group

Component.get

Returns​

Group

the 2D scene.

Overrides​

Component.get

Defined in​

temp/components/src/core/Simple2DScene/index.ts:145

getSize​

▸ getSize(): Vector2

Resizeable.getSize

Returns​

Vector2

Implementation of​

Resizeable.getSize

Defined in​

temp/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/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/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/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/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/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/components/src/base-types/component.ts:45

resize​

▸ resize(): void

Resizeable.resize

Returns​

void

Implementation of​

Resizeable.resize

Defined in​

temp/components/src/core/Simple2DScene/index.ts:184

update​

▸ update(): Promise<void>

Updateable.update

Returns​

Promise<void>

Implementation of​

Updateable.update

Defined in​

temp/components/src/core/Simple2DScene/index.ts:165

+ + \ 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 80878e404..56c659501 100644 --- a/build/api/classes/openbim_components.SimpleCamera/index.html +++ b/build/api/classes/openbim_components.SimpleCamera/index.html @@ -4,20 +4,20 @@ Class: SimpleCamera | That Open Docs - - + +
Skip to main content

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​

src/core/SimpleCamera/index.ts:45

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​

temp/components/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​

src/core/SimpleCamera/index.ts:30

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

Accessors​

enabled​

• get enabled(): boolean

Component.enabled

Returns​

boolean

Overrides​

Component.enabled

Defined in​

src/core/SimpleCamera/index.ts:33

• set enabled(enabled): void

Component.enabled

Parameters​

NameType
enabledboolean

Returns​

void

Overrides​

Component.enabled

Defined in​

src/core/SimpleCamera/index.ts:38

Methods​

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

src/core/SimpleCamera/index.ts:65

get​

▸ get(): PerspectiveCamera | OrthographicCamera

Component.get

Returns​

PerspectiveCamera | OrthographicCamera

Overrides​

Component.get

Defined in​

src/core/SimpleCamera/index.ts:60

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:76

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:88

- - +object to move, rotate, look at objects, etc.

Defined in​

temp/components/src/core/SimpleCamera/index.ts:33

onAfterUpdate​

• Readonly onAfterUpdate: Event<SimpleCamera>

Updateable.onAfterUpdate

Implementation of​

Updateable.onAfterUpdate

Defined in​

temp/components/src/core/SimpleCamera/index.ts:20

onBeforeUpdate​

• Readonly onBeforeUpdate: Event<SimpleCamera>

Updateable.onBeforeUpdate

Implementation of​

Updateable.onBeforeUpdate

Defined in​

temp/components/src/core/SimpleCamera/index.ts:17

onDisposed​

• Readonly onDisposed: Event<string>

Disposable.onDisposed

Implementation of​

Disposable.onDisposed

Defined in​

temp/components/src/core/SimpleCamera/index.ts:25

Accessors​

enabled​

• get enabled(): boolean

Component.enabled

Returns​

boolean

Overrides​

Component.enabled

Defined in​

temp/components/src/core/SimpleCamera/index.ts:36

• set enabled(enabled): void

Component.enabled

Parameters​

NameType
enabledboolean

Returns​

void

Overrides​

Component.enabled

Defined in​

temp/components/src/core/SimpleCamera/index.ts:41

Methods​

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

temp/components/src/core/SimpleCamera/index.ts:68

get​

▸ get(): PerspectiveCamera | OrthographicCamera

Component.get

Returns​

PerspectiveCamera | OrthographicCamera

Overrides​

Component.get

Defined in​

temp/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/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/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/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/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/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/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/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/components/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 52807d113..c52778bdf 100644 --- a/build/api/classes/openbim_components.SimpleClipper/index.html +++ b/build/api/classes/openbim_components.SimpleClipper/index.html @@ -4,21 +4,21 @@ Class: SimpleClipper<T> | That Open Docs - - + +
Skip to main content

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​

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

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​

temp/components/src/core/SimpleClipper/index.ts:35

onAfterDelete​

• Readonly onAfterDelete: Event<T>

Createable.onAfterDelete

Implementation of​

Createable.onAfterDelete

Defined in​

temp/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/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/components/src/core/SimpleClipper/index.ts:41

onDisposed​

• Readonly onDisposed: Event<string>

Disposable.onDisposed

Implementation of​

Disposable.onDisposed

Defined in​

temp/components/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​

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​

temp/components/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​

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:85

• set enabled(state): void

Component.enabled

Parameters​

NameType
stateboolean

Returns​

void

Overrides​

Component.enabled

Defined in​

src/core/SimpleClipper/index.ts:90

material​

• get material(): Material

The material of the clipping plane representation.

Returns​

Material

Defined in​

src/core/SimpleClipper/index.ts:115

• set material(material): void

The material of the clipping plane representation.

Parameters​

NameType
materialMaterial

Returns​

void

Defined in​

src/core/SimpleClipper/index.ts:120

size​

• get size(): number

The size of the geometric representation of the clippings planes.

Returns​

number

Defined in​

src/core/SimpleClipper/index.ts:128

• 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:133

visible​

• get visible(): boolean

Hideable.visible

Returns​

boolean

Implementation of​

Hideable.visible

Defined in​

src/core/SimpleClipper/index.ts:102

• set visible(state): void

Hideable.visible

Parameters​

NameType
stateboolean

Returns​

void

Implementation of​

Hideable.visible

Defined in​

src/core/SimpleClipper/index.ts:107

Methods​

create​

▸ create(): void

Createable.create

Returns​

void

Implementation of​

Createable.create

Defined in​

src/core/SimpleClipper/index.ts:179

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:195

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:210

deleteAll​

▸ deleteAll(): void

Deletes all the existing clipping planes.

Returns​

void

Defined in​

src/core/SimpleClipper/index.ts:222

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

src/core/SimpleClipper/index.ts:160

get​

▸ get(): T[]

Component.get

Returns​

T[]

Overrides​

Component.get

Defined in​

src/core/SimpleClipper/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

- - +has to be true for this to apply.

Defined in​

temp/components/src/core/SimpleClipper/index.ts:67

uiElement​

• uiElement: UIElement<{ main: Button }>

UI.uiElement

Implementation of​

UI.uiElement

Defined in​

temp/components/src/core/SimpleClipper/index.ts:52

Accessors​

enabled​

• get enabled(): boolean

Component.enabled

Returns​

boolean

Overrides​

Component.enabled

Defined in​

temp/components/src/core/SimpleClipper/index.ts:88

• set enabled(state): void

Component.enabled

Parameters​

NameType
stateboolean

Returns​

void

Overrides​

Component.enabled

Defined in​

temp/components/src/core/SimpleClipper/index.ts:93

material​

• get material(): Material

The material of the clipping plane representation.

Returns​

Material

Defined in​

temp/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/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/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/components/src/core/SimpleClipper/index.ts:136

visible​

• get visible(): boolean

Hideable.visible

Returns​

boolean

Implementation of​

Hideable.visible

Defined in​

temp/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/components/src/core/SimpleClipper/index.ts:110

Methods​

create​

▸ create(): void

Createable.create

Returns​

void

Implementation of​

Createable.create

Defined in​

temp/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/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/components/src/core/SimpleClipper/index.ts:215

deleteAll​

▸ deleteAll(): void

Deletes all the existing clipping planes.

Returns​

void

Defined in​

temp/components/src/core/SimpleClipper/index.ts:227

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

temp/components/src/core/SimpleClipper/index.ts:163

get​

▸ get(): T[]

Component.get

Returns​

T[]

Overrides​

Component.get

Defined in​

temp/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/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/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/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/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/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/components/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 0b136eac2..64f316b9c 100644 --- a/build/api/classes/openbim_components.SimpleGrid/index.html +++ b/build/api/classes/openbim_components.SimpleGrid/index.html @@ -4,18 +4,18 @@ Class: SimpleGrid | That Open Docs - - + +
Skip to main content

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​

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:47

• 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:55

material​

• get material(): ShaderMaterial

The material of the grid.

Returns​

ShaderMaterial

Defined in​

src/core/SimpleGrid/index.ts:39

visible​

• get visible(): boolean

Hideable.visible

Returns​

boolean

Implementation of​

Hideable.visible

Defined in​

src/core/SimpleGrid/index.ts:24

• set visible(visible): void

Hideable.visible

Parameters​

NameType
visibleboolean

Returns​

void

Implementation of​

Hideable.visible

Defined in​

src/core/SimpleGrid/index.ts:29

Methods​

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

src/core/SimpleGrid/index.ts:186

get​

▸ get(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>

Component.get

Returns​

Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>

Overrides​

Component.get

Defined in​

src/core/SimpleGrid/index.ts:181

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

- - +dkaraush.

Hierarchy​

Implements​

Properties​

enabled​

• enabled: boolean = true

Component.enabled

Overrides​

Component.enabled

Defined in​

temp/components/src/core/SimpleGrid/index.ts:24

onDisposed​

• Readonly onDisposed: Event<string>

Disposable.onDisposed

Implementation of​

Disposable.onDisposed

Defined in​

temp/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/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/components/src/core/SimpleGrid/index.ts:58

material​

• get material(): ShaderMaterial

The material of the grid.

Returns​

ShaderMaterial

Defined in​

temp/components/src/core/SimpleGrid/index.ts:42

visible​

• get visible(): boolean

Hideable.visible

Returns​

boolean

Implementation of​

Hideable.visible

Defined in​

temp/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/components/src/core/SimpleGrid/index.ts:32

Methods​

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

temp/components/src/core/SimpleGrid/index.ts:189

get​

▸ get(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>

Component.get

Returns​

Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>

Overrides​

Component.get

Defined in​

temp/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/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/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/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/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/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/components/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 ccb61cde4..143f81e1a 100644 --- a/build/api/classes/openbim_components.SimplePlane/index.html +++ b/build/api/classes/openbim_components.SimplePlane/index.html @@ -4,13 +4,13 @@ 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​

src/core/SimpleClipper/simple-plane.ts:14

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:44

• set enabled(state): void

Component.enabled

Parameters​

NameType
stateboolean

Returns​

void

Overrides​

Component.enabled

Defined in​

src/core/SimpleClipper/simple-plane.ts:49

meshes​

• get meshes(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]

The meshes used for raycasting

Returns​

Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]

Defined in​

src/core/SimpleClipper/simple-plane.ts:68

planeMaterial​

• get planeMaterial(): Material | Material[]

The material of the clipping plane representation.

Returns​

Material | Material[]

Defined in​

src/core/SimpleClipper/simple-plane.ts:73

• 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:78

size​

• get size(): number

The size of the clipping plane representation.

Returns​

number

Defined in​

src/core/SimpleClipper/simple-plane.ts:83

• 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:88

visible​

• get visible(): boolean

Hideable.visible

Returns​

boolean

Implementation of​

Hideable.visible

Defined in​

src/core/SimpleClipper/simple-plane.ts:55

• set visible(state): void

Hideable.visible

Parameters​

NameType
stateboolean

Returns​

void

Implementation of​

Hideable.visible

Defined in​

src/core/SimpleClipper/simple-plane.ts:60

Methods​

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

src/core/SimpleClipper/simple-plane.ts:139

get​

▸ get(): Plane

Component.get

Returns​

Plane

Overrides​

Component.get

Defined in​

src/core/SimpleClipper/simple-plane.ts:134

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(): void

Updateable.update

Returns​

void

Defined in​

src/core/SimpleClipper/simple-plane.ts:125

- - +
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/components/src/core/SimpleClipper/simple-plane.ts:14

onDisposed​

• Readonly onDisposed: Event<undefined>

Disposable.onDisposed

Implementation of​

Disposable.onDisposed

Defined in​

temp/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/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/components/src/core/SimpleClipper/simple-plane.ts:17

Accessors​

enabled​

• get enabled(): boolean

Component.enabled

Returns​

boolean

Overrides​

Component.enabled

Defined in​

temp/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/components/src/core/SimpleClipper/simple-plane.ts:52

meshes​

• get meshes(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]

The meshes used for raycasting

Returns​

Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]

Defined in​

temp/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/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/components/src/core/SimpleClipper/simple-plane.ts:81

size​

• get size(): number

The size of the clipping plane representation.

Returns​

number

Defined in​

temp/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/components/src/core/SimpleClipper/simple-plane.ts:91

visible​

• get visible(): boolean

Hideable.visible

Returns​

boolean

Implementation of​

Hideable.visible

Defined in​

temp/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/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/components/src/core/SimpleClipper/simple-plane.ts:142

get​

▸ get(): Plane

Component.get

Returns​

Plane

Overrides​

Component.get

Defined in​

temp/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/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/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/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/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/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/components/src/base-types/component.ts:45

update​

▸ update(): void

Updateable.update

Returns​

void

Defined in​

temp/components/src/core/SimpleClipper/simple-plane.ts:128

+ + \ 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 a2ad19fa5..665fc209b 100644 --- a/build/api/classes/openbim_components.SimpleRaycaster/index.html +++ b/build/api/classes/openbim_components.SimpleRaycaster/index.html @@ -4,17 +4,17 @@ Class: SimpleRaycaster | That Open Docs - - + +
Skip to main content

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​

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:16

Methods​

castRay​

▸ castRay(items?): null | Intersection<Object3D<Event>>

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​

temp/components/src/core/SimpleRaycaster/index.ts:13

mouse​

• Readonly mouse: Mouse

The position of the mouse in the screen.

Defined in​

temp/components/src/core/SimpleRaycaster/index.ts:19

onDisposed​

• Readonly onDisposed: Event<undefined>

Disposable.onDisposed

Implementation of​

Disposable.onDisposed

Overrides​

BaseRaycaster.onDisposed

Defined in​

temp/components/src/core/SimpleRaycaster/index.ts:16

Methods​

castRay​

▸ castRay(items?): null | Intersection<Object3D<Event>>

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[]>[]the meshes to query. If not provided, it will query all the meshes stored in Components.meshes.

Returns​

null | Intersection<Object3D<Event>>

Overrides​

BaseRaycaster.castRay

Defined in​

src/core/SimpleRaycaster/index.ts:46

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Overrides​

BaseRaycaster.dispose

Defined in​

src/core/SimpleRaycaster/index.ts:33

get​

▸ get(): Raycaster

Component.get

Returns​

Raycaster

Overrides​

BaseRaycaster.get

Defined in​

src/core/SimpleRaycaster/index.ts:28

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

- - +used by the renderer.

Parameters​

NameTypeDescription
itemsMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]the meshes to query. If not provided, it will query all the meshes stored in Components.meshes.

Returns​

null | Intersection<Object3D<Event>>

Overrides​

BaseRaycaster.castRay

Defined in​

temp/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/components/src/core/SimpleRaycaster/index.ts:36

get​

▸ get(): Raycaster

Component.get

Returns​

Raycaster

Overrides​

BaseRaycaster.get

Defined in​

temp/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/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/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/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/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/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/components/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 c2d9b0732..98e874ed1 100644 --- a/build/api/classes/openbim_components.SimpleRenderer/index.html +++ b/build/api/classes/openbim_components.SimpleRenderer/index.html @@ -4,8 +4,8 @@ Class: SimpleRenderer | That Open Docs - - + +
@@ -13,12 +13,12 @@ (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​

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:32

onBeforeUpdate​

• Readonly onBeforeUpdate: Event<SimpleRenderer>

Updateable.onBeforeUpdate

Implementation of​

Updateable.onBeforeUpdate

Defined in​

src/core/SimpleRenderer/index.ts:29

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

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:89

get​

▸ get(): WebGLRenderer

Component.get

Returns​

WebGLRenderer

Overrides​

BaseRenderer.get

Defined in​

src/core/SimpleRenderer/index.ts:72

getSize​

▸ getSize(): Vector2

Resizeable.getSize.

Returns​

Vector2

Implementation of​

Resizeable.getSize

Overrides​

BaseRenderer.getSize

Defined in​

src/core/SimpleRenderer/index.ts:101

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:109

togglePlane​

▸ togglePlane(active, plane, isLocal?): void

Adds or removes a +instance of the renderer.

Inherited from​

BaseRenderer.clippingPlanes

Defined in​

temp/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/components/src/core/SimpleRenderer/index.ts:26

enabled​

• enabled: boolean = true

Component.enabled

Overrides​

BaseRenderer.enabled

Defined in​

temp/components/src/core/SimpleRenderer/index.ts:23

onAfterUpdate​

• Readonly onAfterUpdate: Event<SimpleRenderer>

Updateable.onAfterUpdate

Implementation of​

Updateable.onAfterUpdate

Defined in​

temp/components/src/core/SimpleRenderer/index.ts:35

onBeforeUpdate​

• Readonly onBeforeUpdate: Event<SimpleRenderer>

Updateable.onBeforeUpdate

Implementation of​

Updateable.onBeforeUpdate

Defined in​

temp/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/components/src/base-types/base-renderer.ts:27

onDisposed​

• Readonly onDisposed: Event<undefined>

Disposable.onDisposed

Implementation of​

Disposable.onDisposed

Defined in​

temp/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/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/components/src/core/SimpleRenderer/index.ts:92

get​

▸ get(): WebGLRenderer

Component.get

Returns​

WebGLRenderer

Overrides​

BaseRenderer.get

Defined in​

temp/components/src/core/SimpleRenderer/index.ts:75

getSize​

▸ getSize(): Vector2

Resizeable.getSize.

Returns​

Vector2

Implementation of​

Resizeable.getSize

Overrides​

BaseRenderer.getSize

Defined in​

temp/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/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/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/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/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/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/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/components/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​

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:77

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

- - +to the renderer.

Parameters​

NameType
activeboolean
planePlane
isLocal?boolean

Returns​

void

Inherited from​

BaseRenderer.togglePlane

Defined in​

temp/components/src/base-types/base-renderer.ts:48

update​

▸ update(): Promise<void>

Updateable.update

Returns​

Promise<void>

Implementation of​

Updateable.update

Defined in​

temp/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/components/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 ed220da39..0cfea2409 100644 --- a/build/api/classes/openbim_components.SimpleScene/index.html +++ b/build/api/classes/openbim_components.SimpleScene/index.html @@ -4,14 +4,14 @@ 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​

src/core/SimpleScene/index.ts:28

Methods​

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

src/core/SimpleScene/index.ts:44

get​

▸ get(): Scene

Component.get

Returns​

Scene

Overrides​

Component.get

Defined in​

src/core/SimpleScene/index.ts:39

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:69

- - +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/components/src/core/SimpleScene/index.ts:28

onDisposed​

• Readonly onDisposed: Event<undefined>

Disposable.onDisposed

Implementation of​

Disposable.onDisposed

Defined in​

temp/components/src/core/SimpleScene/index.ts:31

Methods​

dispose​

▸ dispose(): Promise<void>

Disposable.dispose

Returns​

Promise<void>

Implementation of​

Disposable.dispose

Defined in​

temp/components/src/core/SimpleScene/index.ts:47

get​

▸ get(): Scene

Component.get

Returns​

Scene

Overrides​

Component.get

Defined in​

temp/components/src/core/SimpleScene/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/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/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/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/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/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/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/components/src/core/SimpleScene/index.ts:74

+ + \ 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 31ef45467..d151c953c 100644 --- a/build/api/classes/openbim_components.ToolComponent/index.html +++ b/build/api/classes/openbim_components.ToolComponent/index.html @@ -4,17 +4,17 @@ 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 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​

src/core/ToolsComponent/index.ts:28

list​

• list: Record<string, Component<any>> = {}

The list of components created in this app.

Defined in​

src/core/ToolsComponent/index.ts:16

token​

• token: string = ""

The auth token to get tools from That Open Platform.

Defined in​

src/core/ToolsComponent/index.ts:22

uuid​

• uuid: string = "ToolComponent"

Component.uuid

Defined in​

src/core/ToolsComponent/index.ts:25

libraryUUIDs​

▪ Static Readonly libraryUUIDs: Set<unknown>

The list of UUIDs of all the components in this library.

Defined in​

src/core/ToolsComponent/index.ts:19

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:55

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:104

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:71

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:43

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:92

- - +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/components/src/core/ToolsComponent/index.ts:31

list​

• list: Record<string, Component<any>> = {}

The list of components created in this app.

Defined in​

temp/components/src/core/ToolsComponent/index.ts:16

onDisposed​

• Readonly onDisposed: Event<undefined>

Disposable.onDisposed

Implementation of​

Disposable.onDisposed

Defined in​

temp/components/src/core/ToolsComponent/index.ts:19

token​

• token: string = ""

The auth token to get tools from That Open Platform.

Defined in​

temp/components/src/core/ToolsComponent/index.ts:25

uuid​

• uuid: string = "ToolComponent"

Component.uuid

Defined in​

temp/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/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/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/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/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/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/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/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/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/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/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/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/components/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 b21f87685..7fef0ef48 100644 --- a/build/api/classes/openbim_components.UIElement/index.html +++ b/build/api/classes/openbim_components.UIElement/index.html @@ -4,16 +4,16 @@ 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​

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

- - +inside.

Returns​

Promise<void>

Defined in​

temp/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/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/components/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 4dcdb715f..5e93d7e55 100644 --- a/build/api/classes/openbim_components.UIManager/index.html +++ b/build/api/classes/openbim_components.UIManager/index.html @@ -4,13 +4,13 @@ Class: UIManager | That Open Docs - - + +
-
Skip to main content

Class: UIManager

openbim-components.UIManager

A component that handles all UI components.

Hierarchy​

Implements​

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

- - +
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/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/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/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/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/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/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/components/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 790504969..dfdf36c1e 100644 --- a/build/api/index.html +++ b/build/api/index.html @@ -4,13 +4,13 @@ Open BIM Docs | That Open Docs - - + +
-
Skip to main content

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation​

$ yarn

Local Development​

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build​

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment​

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

- - +
Skip to main content

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation​

$ yarn

Local Development​

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build​

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment​

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

+ + \ 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 e27c439d7..a234052bb 100644 --- a/build/api/interfaces/openbim_components.Configurable/index.html +++ b/build/api/interfaces/openbim_components.Configurable/index.html @@ -4,14 +4,14 @@ 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​

src/base-types/base-types.ts:181

onSetup​

• Readonly onSetup: Event<any>

Fired after successfully calling ()

Defined in​

src/base-types/base-types.ts:176

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:173

- - +
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/components/src/base-types/base-types.ts:185

onSetup​

• Readonly onSetup: Event<any>

Fired after successfully calling ()

Defined in​

temp/components/src/base-types/base-types.ts:180

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/components/src/base-types/base-types.ts:177

+ + \ 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 fb41f4eb0..d08334fb2 100644 --- a/build/api/interfaces/openbim_components.Createable/index.html +++ b/build/api/interfaces/openbim_components.Createable/index.html @@ -4,17 +4,17 @@ Interface: Createable | That Open Docs - - + +
Skip to main content

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​

src/base-types/base-types.ts:153

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:135

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:162

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:144

onAfterCancel​

• Readonly onAfterCancel: Event<any>

Fired after calling Createable.cancelCreation.

Defined in​

src/base-types/base-types.ts:156

onAfterCreate​

• Readonly onAfterCreate: Event<any>

Fired after successfully calling Createable.create

Defined in​

src/base-types/base-types.ts:138

onAfterDelete​

• Readonly onAfterDelete: Event<any>

Fired after successfully calling ()

Defined in​

src/base-types/base-types.ts:165

onBeforeCancel​

• Readonly onBeforeCancel: Event<any>

Fired before calling Createable.cancelCreation.

Defined in​

src/base-types/base-types.ts:147

onBeforeDelete​

• Readonly onBeforeDelete: Event<any>

Fired before calling Createable.delete.

Defined in​

src/base-types/base-types.ts:159

- - +before starting to create.

Parameters​
NameType
dataany
Returns​

void

Defined in​

temp/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/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/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/components/src/base-types/base-types.ts:148

onAfterCancel​

• Readonly onAfterCancel: Event<any>

Fired after calling Createable.cancelCreation.

Defined in​

temp/components/src/base-types/base-types.ts:160

onAfterCreate​

• Readonly onAfterCreate: Event<any>

Fired after successfully calling Createable.create

Defined in​

temp/components/src/base-types/base-types.ts:142

onAfterDelete​

• Readonly onAfterDelete: Event<any>

Fired after successfully calling ()

Defined in​

temp/components/src/base-types/base-types.ts:169

onBeforeCancel​

• Readonly onBeforeCancel: Event<any>

Fired before calling Createable.cancelCreation.

Defined in​

temp/components/src/base-types/base-types.ts:151

onBeforeDelete​

• Readonly onBeforeDelete: Event<any>

Fired before calling Createable.delete.

Defined in​

temp/components/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 661c5fe4b..6f122446d 100644 --- a/build/api/interfaces/openbim_components.Disposable/index.html +++ b/build/api/interfaces/openbim_components.Disposable/index.html @@ -4,8 +4,8 @@ Interface: Disposable | That Open Docs - - + +
@@ -13,9 +13,9 @@ 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​

src/base-types/base-types.ts:59

- - +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/components/src/base-types/base-types.ts:60

onDisposed​

• Readonly onDisposed: Event<any>

Fired after the tool has been ()

Defined in​

temp/components/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 0308b714f..ddbf95de2 100644 --- a/build/api/interfaces/openbim_components.FragmentIdMap/index.html +++ b/build/api/interfaces/openbim_components.FragmentIdMap/index.html @@ -4,14 +4,14 @@ 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.

- - +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 ab25751fb..2850d6d5b 100644 --- a/build/api/interfaces/openbim_components.Hideable/index.html +++ b/build/api/interfaces/openbim_components.Hideable/index.html @@ -4,8 +4,8 @@ Interface: Hideable | That Open Docs - - + +
@@ -13,8 +13,8 @@ hidden or shown in the 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​

src/base-types/base-types.ts:73

- - +Three.js scene.

Defined in​

temp/components/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 c089120c9..f8611714b 100644 --- a/build/api/interfaces/openbim_components.NavigationMode/index.html +++ b/build/api/interfaces/openbim_components.NavigationMode/index.html @@ -4,16 +4,16 @@ 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​

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. +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/components/src/navigation/OrthoPerspectiveCamera/src/types.ts:33

id​

• id: NavModeID

The unique ID of this navigation mode.

Defined in​

temp/components/src/navigation/OrthoPerspectiveCamera/src/types.ts:20

projectionChanged​

• projectionChanged: Event<Camera>

Event that should fire when the camera CameraProjection changes.

Defined in​

temp/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. 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​

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​

temp/components/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 ebf54e8d7..10fb83aa3 100644 --- a/build/api/interfaces/openbim_components.Progress/index.html +++ b/build/api/interfaces/openbim_components.Progress/index.html @@ -4,13 +4,13 @@ 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 8dacc2a5a..c719790c5 100644 --- a/build/api/interfaces/openbim_components.Resizeable/index.html +++ b/build/api/interfaces/openbim_components.Resizeable/index.html @@ -4,8 +4,8 @@ Interface: Resizeable | That Open Docs - - + +
@@ -15,10 +15,10 @@ 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 Renderer -component.

Returns​

Vector2

Defined in​

src/base-types/base-types.ts:99

onResize​

• onResize: Event<Vector2>

Event that fires when the component has been resized.

Defined in​

src/base-types/base-types.ts:92

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​

temp/components/src/base-types/base-types.ts:103

onResize​

• onResize: Event<Vector2>

Event that fires when the component has been resized.

Defined in​

temp/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 Renderer -component.

Parameters​
NameType
size?Vector2
Returns​

void

Defined in​

src/base-types/base-types.ts:89

- - +component.

Parameters​
NameType
size?Vector2
Returns​

void

Defined in​

temp/components/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 9ecabb18a..2ca47488e 100644 --- a/build/api/interfaces/openbim_components.UI/index.html +++ b/build/api/interfaces/openbim_components.UI/index.html @@ -4,14 +4,14 @@ Interface: UI | That Open Docs - - + +
Skip to main content
- - +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/components/src/base-types/base-types.ts:194

+ + \ 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 651bb1ab6..fbe9605e3 100644 --- a/build/api/interfaces/openbim_components.Updateable/index.html +++ b/build/api/interfaces/openbim_components.Updateable/index.html @@ -4,14 +4,14 @@ 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​

src/base-types/base-types.ts:105

onBeforeUpdate​

• onBeforeUpdate: Event<any>

Actions that should be executed before updating the component.

Defined in​

src/base-types/base-types.ts:108

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:114

- - +
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/components/src/base-types/base-types.ts:109

onBeforeUpdate​

• onBeforeUpdate: Event<any>

Actions that should be executed before updating the component.

Defined in​

temp/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/components/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 ad7dcf7f7..36b3eaf6c 100644 --- a/build/api/modules/bim_fragment/index.html +++ b/build/api/modules/bim_fragment/index.html @@ -4,13 +4,13 @@ Module: bim-fragment | That Open Docs - - + +
-
Skip to main content
- - +
Skip to main content
+ + \ No newline at end of file diff --git a/build/api/modules/index.html b/build/api/modules/index.html index 4dd6cf575..a2ba39c88 100644 --- a/build/api/modules/index.html +++ b/build/api/modules/index.html @@ -4,13 +4,13 @@ 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 d6552a90b..3ba14708a 100644 --- a/build/api/modules/openbim_components/index.html +++ b/build/api/modules/openbim_components/index.html @@ -4,13 +4,13 @@ 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​

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/LengthMeasurement/src/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/LengthMeasurement/src/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​

temp/components/src/navigation/OrthoPerspectiveCamera/src/types.ts:7

Ƭ NavModeID: "Orbit" | "FirstPerson" | "Plan"

The extensible list of supported navigation modes.

Defined in​

temp/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/components/src/measurement/LengthMeasurement/src/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/components/src/measurement/LengthMeasurement/src/types.ts:8

+ + \ No newline at end of file diff --git a/build/assets/js/0b4ea834.a1badae3.js b/build/assets/js/0b4ea834.79aeadcd.js similarity index 63% rename from build/assets/js/0b4ea834.a1badae3.js rename to build/assets/js/0b4ea834.79aeadcd.js index cb71b64fa..f51cfe1f0 100644 --- a/build/assets/js/0b4ea834.a1badae3.js +++ b/build/assets/js/0b4ea834.79aeadcd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3877],{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 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},d=function(e){var t=s(e.components);return a.createElement(l.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,p=e.originalType,l=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),m=s(n),u=r,b=m["".concat(l,".").concat(u)]||m[u]||c[u]||p;return n?a.createElement(b,i(i({ref:t},d),{},{components:n})):a.createElement(b,i({ref:t},d))}));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[m]="string"==typeof e?e:r,i[1]=o;for(var s=2;s{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>c,frontMatter:()=>p,metadata:()=>o,toc:()=>s});var a=n(7462),r=(n(7294),n(3905));const p={id:"openbim_components.Updateable",title:"Interface: Updateable",sidebar_label:"Updateable",custom_edit_url:null},i=void 0,o={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"}},l={},s=[{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}],d={toc:s},m="wrapper";function c(e){let{components:t,...n}=e;return(0,r.kt)(m,(0,a.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Updateable"),(0,r.kt)("p",null,"Whether this component should be updated each frame."),(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.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.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.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.SimpleRenderer"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleRenderer")))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,r.kt)("p",null,"\u2022 ",(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)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Actions that should be executed after updating the component."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L105"},"src/base-types/base-types.ts:105")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,r.kt)("p",null,"\u2022 ",(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)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Actions that should be executed before updating the component."),(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/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L108"},"src/base-types/base-types.ts:108")),(0,r.kt)("h2",{id:"methods"},"Methods"),(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"},"void")),(0,r.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,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"},"delta?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(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/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L114"},"src/base-types/base-types.ts:114")))}c.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:()=>l,contentTitle:()=>i,default:()=>c,frontMatter:()=>p,metadata:()=>o,toc:()=>s});var a=n(7462),r=(n(7294),n(3905));const p={id:"openbim_components.Updateable",title:"Interface: Updateable",sidebar_label:"Updateable",custom_edit_url:null},i=void 0,o={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"}},l={},s=[{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}],m={toc:s},d="wrapper";function c(e){let{components:t,...n}=e;return(0,r.kt)(d,(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"),".Updateable"),(0,r.kt)("p",null,"Whether this component should be updated each frame."),(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.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.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.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.SimpleRenderer"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleRenderer")))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,r.kt)("p",null,"\u2022 ",(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)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Actions that should be executed after updating the component."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L109"},"temp/components/src/base-types/base-types.ts:109")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,r.kt)("p",null,"\u2022 ",(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)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Actions that should be executed before updating the component."),(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/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L112"},"temp/components/src/base-types/base-types.ts:112")),(0,r.kt)("h2",{id:"methods"},"Methods"),(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"},"void")),(0,r.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,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"},"delta?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(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/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L118"},"temp/components/src/base-types/base-types.ts:118")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/10f5d381.5ef66772.js b/build/assets/js/10f5d381.b11456b3.js similarity index 50% rename from build/assets/js/10f5d381.5ef66772.js rename to build/assets/js/10f5d381.b11456b3.js index 9b330d4d3..619a32c5b 100644 --- a/build/assets/js/10f5d381.5ef66772.js +++ b/build/assets/js/10f5d381.b11456b3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2981],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,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 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)},c="mdxType",m={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"]),c=s(n),k=r,f=c["".concat(o,".").concat(k)]||c[k]||m[k]||l;return n?a.createElement(f,i(i({ref:t},d),{},{components:n})):a.createElement(f,i({ref:t},d))}));function f(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[c]="string"==typeof e?e:r,i[1]=p;for(var s=2;s{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>m,frontMatter:()=>l,metadata:()=>p,toc:()=>s});var a=n(7462),r=(n(7294),n(3905));const l={id:"openbim_components.Createable",title:"Interface: Createable",sidebar_label:"Createable",custom_edit_url:null},i=void 0,p={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"}},o={},s=[{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}],d={toc:s},c="wrapper";function m(e){let{components:t,...n}=e;return(0,r.kt)(c,(0,a.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Createable"),(0,r.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,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.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.SimpleClipper"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleClipper")))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"cancelcreation"},"cancelCreation"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"cancelCreation"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"data"),": ",(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"},"data"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Cancels the creation process of the component, going back to the state\nbefore starting to create."),(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)("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)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(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/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L153"},"src/base-types/base-types.ts:153")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"create"},"create"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"create"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"data"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Creates a new instance of an element (e.g. a new Dimension)."),(0,r.kt)("h5",{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"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h5",{id:"returns-1"},"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/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L135"},"src/base-types/base-types.ts:135")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"delete"},"delete"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"delete"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"data"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Deletes an existing instance of an element (e.g. a Dimension)."),(0,r.kt)("h5",{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"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h5",{id:"returns-2"},"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/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L162"},"src/base-types/base-types.ts:162")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"endcreation"},"endCreation"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"endCreation"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"data"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Finish the creation process of the component, successfully creating an\ninstance of whatever the component creates."),(0,r.kt)("h5",{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"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h5",{id:"returns-3"},"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/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L144"},"src/base-types/base-types.ts:144")),(0,r.kt)("hr",null),(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"},"any"),">"),(0,r.kt)("p",null,"Fired after calling ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#cancelcreation"},"Createable.cancelCreation"),"."),(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/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L156"},"src/base-types/base-types.ts:156")),(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"},"any"),">"),(0,r.kt)("p",null,"Fired after successfully calling ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#create"},"Createable.create")),(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/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L138"},"src/base-types/base-types.ts:138")),(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)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Fired after successfully calling ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#delete"},"()")),(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/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L165"},"src/base-types/base-types.ts:165")),(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)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Fired before calling ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#cancelcreation"},"Createable.cancelCreation"),"."),(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/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L147"},"src/base-types/base-types.ts:147")),(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"},"any"),">"),(0,r.kt)("p",null,"Fired before calling ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#delete"},"Createable.delete"),"."),(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/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L159"},"src/base-types/base-types.ts:159")))}m.isMDXComponent=!0}}]); \ No newline at end of file +"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:()=>o,contentTitle:()=>i,default:()=>c,frontMatter:()=>l,metadata:()=>p,toc:()=>s});var a=n(7462),r=(n(7294),n(3905));const l={id:"openbim_components.Createable",title:"Interface: Createable",sidebar_label:"Createable",custom_edit_url:null},i=void 0,p={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"}},o={},s=[{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}],d={toc:s},m="wrapper";function c(e){let{components:t,...n}=e;return(0,r.kt)(m,(0,a.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Createable"),(0,r.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,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.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.SimpleClipper"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleClipper")))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"cancelcreation"},"cancelCreation"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"cancelCreation"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"data"),": ",(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"},"data"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Cancels the creation process of the component, going back to the state\nbefore starting to create."),(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)("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)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(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/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L157"},"temp/components/src/base-types/base-types.ts:157")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"create"},"create"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"create"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"data"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Creates a new instance of an element (e.g. a new Dimension)."),(0,r.kt)("h5",{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"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h5",{id:"returns-1"},"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/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L139"},"temp/components/src/base-types/base-types.ts:139")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"delete"},"delete"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"delete"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"data"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Deletes an existing instance of an element (e.g. a Dimension)."),(0,r.kt)("h5",{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"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h5",{id:"returns-2"},"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/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L166"},"temp/components/src/base-types/base-types.ts:166")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"endcreation"},"endCreation"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"endCreation"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"data"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Finish the creation process of the component, successfully creating an\ninstance of whatever the component creates."),(0,r.kt)("h5",{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"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h5",{id:"returns-3"},"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/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L148"},"temp/components/src/base-types/base-types.ts:148")),(0,r.kt)("hr",null),(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"},"any"),">"),(0,r.kt)("p",null,"Fired after calling ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#cancelcreation"},"Createable.cancelCreation"),"."),(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/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L160"},"temp/components/src/base-types/base-types.ts:160")),(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"},"any"),">"),(0,r.kt)("p",null,"Fired after successfully calling ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#create"},"Createable.create")),(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/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L142"},"temp/components/src/base-types/base-types.ts:142")),(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)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Fired after successfully calling ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#delete"},"()")),(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/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L169"},"temp/components/src/base-types/base-types.ts:169")),(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)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Fired before calling ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#cancelcreation"},"Createable.cancelCreation"),"."),(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/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L151"},"temp/components/src/base-types/base-types.ts:151")),(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"},"any"),">"),(0,r.kt)("p",null,"Fired before calling ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#delete"},"Createable.delete"),"."),(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/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L163"},"temp/components/src/base-types/base-types.ts:163")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/1202d222.3970aeee.js b/build/assets/js/1202d222.3970aeee.js deleted file mode 100644 index b93fb7d11..000000000 --- a/build/assets/js/1202d222.3970aeee.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 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 s=a.createContext({}),o=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},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=p(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,l(l({ref:t},m),{},{components:n})):a.createElement(f,l({ref:t},m))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,l=new Array(r);l[0]=k;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[d]="string"==typeof e?e:i,l[1]=p;for(var o=2;o{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>u,frontMatter:()=>r,metadata:()=>p,toc:()=>o});var a=n(7462),i=(n(7294),n(3905));const r={id:"openbim_components.FragmentManager",title:"Class: FragmentManager",sidebar_label:"FragmentManager",custom_edit_url:null},l=void 0,p={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:"FragmentIfcLoader",permalink:"/api/classes/openbim_components.FragmentIfcLoader"},next:{title:"FragmentPlans",permalink:"/api/classes/openbim_components.FragmentPlans"}},s={},o=[{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:"Accessors",id:"accessors",level:2},{value:"meshes",id:"meshes",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-2",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",level:4},{value:"Defined in",id:"defined-in-3",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-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:"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-12",level:4},{value:"reset",id:"reset",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-13",level:4}],m={toc:o},d="wrapper";function u(e){let{components:t,...n}=e;return(0,i.kt)(d,(0,a.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"),".FragmentManager"),(0,i.kt)("p",null,"Object that can efficiently load binary files that contain\n",(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/fragment"},"fragment geometry"),"."),(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)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Fragment"),"[]",">"),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"FragmentManager"))))),(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)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},(0,i.kt)("inlineCode",{parentName:"a"},"UI")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"enabled"},"enabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"enabled"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"true")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/fragments/FragmentManager/index.ts#L23"},"src/fragments/FragmentManager/index.ts:23")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"list"},"list"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"list"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"{}")),(0,i.kt)("p",null,"All the created ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/fragment"},"fragments"),"."),(0,i.kt)("h4",{id:"index-signature"},"Index signature"),(0,i.kt)("p",null,"\u25aa ","[guid: ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,i.kt)("inlineCode",{parentName:"p"},"Fragment")),(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/ifcjs/components/blob/e46138a/src/fragments/FragmentManager/index.ts#L26"},"src/fragments/FragmentManager/index.ts:26")),(0,i.kt)("h2",{id:"accessors"},"Accessors"),(0,i.kt)("h3",{id:"meshes"},"meshes"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"meshes"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,i.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Material"),"[]",">","[]"),(0,i.kt)("p",null,"The list of meshes of the created fragments."),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,i.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Material"),"[]",">","[]"),(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/ifcjs/components/blob/e46138a/src/fragments/FragmentManager/index.ts#L45"},"src/fragments/FragmentManager/index.ts:45")),(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"},"disposeUI?"),"): ",(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/classes/openbim_components.Component#get"},"Component.get")),(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"},"Default value"))),(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"},"disposeUI")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"false"))))),(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"},"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-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/fragments/FragmentManager/index.ts#L69"},"src/fragments/FragmentManager/index.ts:69")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"export"},"export"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"export"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"group"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,i.kt)("p",null,"Export the specified fragments."),(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"},"group")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"FragmentsGroup")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the fragments group to be exported.")))),(0,i.kt)("h4",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,i.kt)("p",null,"the exported data as binary buffer."),(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/ifcjs/components/blob/e46138a/src/fragments/FragmentManager/index.ts#L134"},"src/fragments/FragmentManager/index.ts:134")),(0,i.kt)("hr",null),(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"},"Fragment"),"[]"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,i.kt)("h4",{id:"returns-3"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Fragment"),"[]"),(0,i.kt)("h4",{id:"overrides-1"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(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/ifcjs/components/blob/e46138a/src/fragments/FragmentManager/index.ts#L64"},"src/fragments/FragmentManager/index.ts:64")),(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-4"},"Returns"),(0,i.kt)("p",null,"this is UI"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L62"},"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-5"},"Returns"),(0,i.kt)("p",null,"this is Configurable"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L57"},"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-6"},"Returns"),(0,i.kt)("p",null,"this is Disposable"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L35"},"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-7"},"Returns"),(0,i.kt)("p",null,"this is Hideable"),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L52"},"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-8"},"Returns"),(0,i.kt)("p",null,"this is Resizeable"),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L40"},"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-9"},"Returns"),(0,i.kt)("p",null,"this is Updateable"),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"load"},"load"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"load"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"FragmentsGroup"),">"),(0,i.kt)("p",null,"Loads one or many fragments into the scene."),(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)("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"},"data")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Uint8Array")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the bytes containing the data for the fragments to load.")))),(0,i.kt)("h4",{id:"returns-10"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"FragmentsGroup"),">"),(0,i.kt)("p",null,"the list of IDs of the loaded fragments."),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/fragments/FragmentManager/index.ts#L113"},"src/fragments/FragmentManager/index.ts:113")),(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,"Disposes all existing fragments"),(0,i.kt)("h4",{id:"returns-11"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/fragments/FragmentManager/index.ts#L100"},"src/fragments/FragmentManager/index.ts:100")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/1202d222.84d17218.js b/build/assets/js/1202d222.84d17218.js new file mode 100644 index 000000000..56f4a0f2a --- /dev/null +++ b/build/assets/js/1202d222.84d17218.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1461],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>c});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({}),o=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=o(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)}},k=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,l=e.parentName,m=s(e,["components","mdxType","originalType","parentName"]),d=o(n),k=i,c=d["".concat(l,".").concat(k)]||d[k]||u[k]||r;return n?a.createElement(c,p(p({ref:t},m),{},{components:n})):a.createElement(c,p({ref:t},m))}));function c(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 s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[d]="string"==typeof e?e:i,p[1]=s;for(var o=2;o{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>o});var a=n(7462),i=(n(7294),n(3905));const r={id:"openbim_components.FragmentManager",title:"Class: FragmentManager",sidebar_label:"FragmentManager",custom_edit_url:null},p=void 0,s={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:"FragmentIfcLoader",permalink:"/api/classes/openbim_components.FragmentIfcLoader"},next:{title:"FragmentPlans",permalink:"/api/classes/openbim_components.FragmentPlans"}},l={},o=[{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}],m={toc:o},d="wrapper";function u(e){let{components:t,...n}=e;return(0,i.kt)(d,(0,a.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"),".FragmentManager"),(0,i.kt)("p",null,"Object that can efficiently load binary files that contain\n",(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/fragment"},"fragment geometry"),"."),(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)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Fragment"),"[]",">"),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"FragmentManager"))))),(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)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},(0,i.kt)("inlineCode",{parentName:"a"},"UI")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"enabled"},"enabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"enabled"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"true")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/fragments/FragmentManager/index.ts#L29"},"temp/components/src/fragments/FragmentManager/index.ts:29")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"list"},"list"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"list"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"{}")),(0,i.kt)("p",null,"All the created ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/fragment"},"fragments"),"."),(0,i.kt)("h4",{id:"index-signature"},"Index signature"),(0,i.kt)("p",null,"\u25aa ","[guid: ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,i.kt)("inlineCode",{parentName:"p"},"Fragment")),(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/IFCjs/components/blob/0c38d20/src/fragments/FragmentManager/index.ts#L32"},"temp/components/src/fragments/FragmentManager/index.ts:32")),(0,i.kt)("hr",null),(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"},"string"),">"),(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-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/fragments/FragmentManager/index.ts#L26"},"temp/components/src/fragments/FragmentManager/index.ts:26")),(0,i.kt)("h2",{id:"accessors"},"Accessors"),(0,i.kt)("h3",{id:"meshes"},"meshes"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"meshes"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,i.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Material"),"[]",">","[]"),(0,i.kt)("p",null,"The list of meshes of the created fragments."),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,i.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Material"),"[]",">","[]"),(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/IFCjs/components/blob/0c38d20/src/fragments/FragmentManager/index.ts#L55"},"temp/components/src/fragments/FragmentManager/index.ts:55")),(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"},"disposeUI?"),"): ",(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/classes/openbim_components.Component#get"},"Component.get")),(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"},"Default value"))),(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"},"disposeUI")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"false"))))),(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-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/fragments/FragmentManager/index.ts#L79"},"temp/components/src/fragments/FragmentManager/index.ts:79")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"export"},"export"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"export"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"group"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,i.kt)("p",null,"Export the specified fragments."),(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"},"group")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"FragmentsGroup")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the fragments group to be exported.")))),(0,i.kt)("h4",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,i.kt)("p",null,"the exported data as binary buffer."),(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/IFCjs/components/blob/0c38d20/src/fragments/FragmentManager/index.ts#L153"},"temp/components/src/fragments/FragmentManager/index.ts:153")),(0,i.kt)("hr",null),(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"},"Fragment"),"[]"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,i.kt)("h4",{id:"returns-3"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Fragment"),"[]"),(0,i.kt)("h4",{id:"overrides-1"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(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/IFCjs/components/blob/0c38d20/src/fragments/FragmentManager/index.ts#L74"},"temp/components/src/fragments/FragmentManager/index.ts:74")),(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-4"},"Returns"),(0,i.kt)("p",null,"this is UI"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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-5"},"Returns"),(0,i.kt)("p",null,"this is Configurable"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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-6"},"Returns"),(0,i.kt)("p",null,"this is Disposable"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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-7"},"Returns"),(0,i.kt)("p",null,"this is Hideable"),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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-8"},"Returns"),(0,i.kt)("p",null,"this is Resizeable"),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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-9"},"Returns"),(0,i.kt)("p",null,"this is Updateable"),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/src/base-types/component.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"load"},"load"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"load"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"FragmentsGroup"),">"),(0,i.kt)("p",null,"Loads one or many fragments into the scene."),(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)("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"},"data")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Uint8Array")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the bytes containing the data for the fragments to load.")))),(0,i.kt)("h4",{id:"returns-10"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"FragmentsGroup"),">"),(0,i.kt)("p",null,"the list of IDs of the loaded fragments."),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/fragments/FragmentManager/index.ts#L132"},"temp/components/src/fragments/FragmentManager/index.ts:132")),(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,"Disposes all existing fragments"),(0,i.kt)("h4",{id:"returns-11"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/fragments/FragmentManager/index.ts#L119"},"temp/components/src/fragments/FragmentManager/index.ts:119")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/18ed70ed.5bdce547.js b/build/assets/js/18ed70ed.5bdce547.js new file mode 100644 index 000000000..27423cd8f --- /dev/null +++ b/build/assets/js/18ed70ed.5bdce547.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 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:()=>s,contentTitle:()=>l,default:()=>k,frontMatter:()=>a,metadata:()=>r,toc:()=>o});var i=t(7462),p=(t(7294),t(3905));const a={id:"openbim_components.SimplePlane",title:"Class: SimplePlane",sidebar_label:"SimplePlane",custom_edit_url:null},l=void 0,r={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"}},s={},o=[{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}],m={toc:o},d="wrapper";function k(e){let{components:n,...t}=e;return(0,p.kt)(d,(0,i.Z)({},m,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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L14"},"temp/components/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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L23"},"temp/components/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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L20"},"temp/components/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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L17"},"temp/components/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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L47"},"temp/components/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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L52"},"temp/components/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)("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)("h4",{id:"defined-in-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L71"},"temp/components/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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L76"},"temp/components/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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L81"},"temp/components/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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L86"},"temp/components/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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L91"},"temp/components/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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L58"},"temp/components/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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L63"},"temp/components/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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L142"},"temp/components/src/core/SimpleClipper/simple-plane.ts:142")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L137"},"temp/components/src/core/SimpleClipper/simple-plane.ts:137")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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-16"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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-17"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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-18"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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-19"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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-20"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/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"},"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"},"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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L128"},"temp/components/src/core/SimpleClipper/simple-plane.ts:128")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/18ed70ed.f5cefaf2.js b/build/assets/js/18ed70ed.f5cefaf2.js deleted file mode 100644 index 5e56df2b6..000000000 --- a/build/assets/js/18ed70ed.f5cefaf2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5229],{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 l(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 l=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=i.createContext({}),o=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=o(e.components);return i.createElement(s.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,l=e.originalType,s=e.parentName,m=r(e,["components","mdxType","originalType","parentName"]),d=o(n),u=a,c=d["".concat(s,".").concat(u)]||d[u]||k[u]||l;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 l=n.length,p=new Array(l);p[0]=u;var r={};for(var s in t)hasOwnProperty.call(t,s)&&(r[s]=t[s]);r.originalType=e,r[d]="string"==typeof e?e:a,p[1]=r;for(var o=2;o{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>k,frontMatter:()=>l,metadata:()=>r,toc:()=>o});var i=n(7462),a=(n(7294),n(3905));const l={id:"openbim_components.SimplePlane",title:"Class: SimplePlane",sidebar_label:"SimplePlane",custom_edit_url:null},p=void 0,r={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"}},s={},o=[{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:"onDraggingEnded",id:"ondraggingended",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"onDraggingStarted",id:"ondraggingstarted",level:3},{value:"Defined in",id:"defined-in-2",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-3",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-4",level:4},{value:"meshes",id:"meshes",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"planeMaterial",id:"planematerial",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"visible",id:"visible",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-11",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-2",level:4},{value:"Defined in",id:"defined-in-12",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-13",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-14",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-15",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-16",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-17",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-18",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-19",level:4},{value:"update",id:"update",level:3},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-20",level:4}],m={toc:o},d="wrapper";function k(e){let{components:t,...n}=e;return(0,a.kt)(d,(0,i.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"),".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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L14"},"src/core/SimpleClipper/simple-plane.ts:14")),(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-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L20"},"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-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L17"},"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-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L44"},"src/core/SimpleClipper/simple-plane.ts:44")),(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-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L49"},"src/core/SimpleClipper/simple-plane.ts:49")),(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)("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)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L68"},"src/core/SimpleClipper/simple-plane.ts:68")),(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-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L73"},"src/core/SimpleClipper/simple-plane.ts:73")),(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-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L78"},"src/core/SimpleClipper/simple-plane.ts:78")),(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-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L83"},"src/core/SimpleClipper/simple-plane.ts:83")),(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-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L88"},"src/core/SimpleClipper/simple-plane.ts:88")),(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"},"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-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L55"},"src/core/SimpleClipper/simple-plane.ts:55")),(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-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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L60"},"src/core/SimpleClipper/simple-plane.ts:60")),(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-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-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L139"},"src/core/SimpleClipper/simple-plane.ts:139")),(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-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L134"},"src/core/SimpleClipper/simple-plane.ts:134")),(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-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-16"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-17"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-18"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-19"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L45"},"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-20"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L125"},"src/core/SimpleClipper/simple-plane.ts:125")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/18f6f55e.28e0fd8c.js b/build/assets/js/18f6f55e.28e0fd8c.js new file mode 100644 index 000000000..b8252a1af --- /dev/null +++ b/build/assets/js/18f6f55e.28e0fd8c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3116],{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 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,c=m["".concat(s,".").concat(u)]||m[u]||k[u]||l;return t?i.createElement(c,p(p({ref:n},d),{},{components:t})):i.createElement(c,p({ref:n},d))}));function c(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:()=>s,contentTitle:()=>p,default:()=>k,frontMatter:()=>l,metadata:()=>r,toc:()=>o});var i=t(7462),a=(t(7294),t(3905));const l={id:"openbim_components.EdgesPlane",title:"Class: EdgesPlane",sidebar_label:"EdgesPlane",custom_edit_url:null},p=void 0,r={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"}},s={},o=[{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}],d={toc:o},m="wrapper";function k(e){let{components:n,...t}=e;return(0,a.kt)(m,(0,i.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"),".EdgesPlane"),(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 includes\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.SimplePlane"},(0,a.kt)("inlineCode",{parentName:"a"},"SimplePlane"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"EdgesPlane"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"edgesmaxupdaterate"},"edgesMaxUpdateRate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"edgesMaxUpdateRate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"50")),(0,a.kt)("p",null,"The max rate in milliseconds at which edges can be regenerated.\nTo disable this behaviour set this to 0."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/navigation/EdgesClipper/src/edges-plane.ts#L17"},"temp/components/src/navigation/EdgesClipper/src/edges-plane.ts:17")),(0,a.kt)("hr",null),(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:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#name"},"name")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L14"},"temp/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:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L23"},"temp/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:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#ondraggingended"},"onDraggingEnded")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L20"},"temp/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:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#ondraggingstarted"},"onDraggingStarted")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L17"},"temp/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,"SimplePlane.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/IFCjs/components/blob/0c38d20/src/navigation/EdgesClipper/src/edges-plane.ts#L43"},"temp/components/src/navigation/EdgesClipper/src/edges-plane.ts:43")),(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,"SimplePlane.enabled"),(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/IFCjs/components/blob/0c38d20/src/navigation/EdgesClipper/src/edges-plane.ts#L37"},"temp/components/src/navigation/EdgesClipper/src/edges-plane.ts:37")),(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)("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)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"SimplePlane.meshes"),(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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L71"},"temp/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:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"SimplePlane.planeMaterial"),(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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L76"},"temp/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:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,"SimplePlane.planeMaterial"),(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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L81"},"temp/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:"inherited-from-7"},"Inherited from"),(0,a.kt)("p",null,"SimplePlane.size"),(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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L86"},"temp/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:"inherited-from-8"},"Inherited from"),(0,a.kt)("p",null,"SimplePlane.size"),(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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L91"},"temp/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:"inherited-from-9"},"Inherited from"),(0,a.kt)("p",null,"SimplePlane.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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L58"},"temp/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:"inherited-from-10"},"Inherited from"),(0,a.kt)("p",null,"SimplePlane.visible"),(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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L63"},"temp/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:"overrides-2"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#dispose"},"dispose")),(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/IFCjs/components/blob/0c38d20/src/navigation/EdgesClipper/src/edges-plane.ts#L48"},"temp/components/src/navigation/EdgesClipper/src/edges-plane.ts:48")),(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:"inherited-from-11"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#get"},"get")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/simple-plane.ts#L137"},"temp/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-12"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#hasui"},"hasUI")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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-13"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#isconfigurable"},"isConfigurable")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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-14"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#isdisposeable"},"isDisposeable")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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-15"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#ishideable"},"isHideable")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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-16"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#isresizeable"},"isResizeable")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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-17"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#isupdateable"},"isUpdateable")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/src/base-types/component.ts:45")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"setenabled"},"setEnabled"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"setEnabled"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"state"),"): ",(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#enabled"},"Component.enabled")),(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)("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-17"},"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-22"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/navigation/EdgesClipper/src/edges-plane.ts#L54"},"temp/components/src/navigation/EdgesClipper/src/edges-plane.ts:54")),(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-18"},"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-3"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#update"},"update")),(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/IFCjs/components/blob/0c38d20/src/navigation/EdgesClipper/src/edges-plane.ts#L76"},"temp/components/src/navigation/EdgesClipper/src/edges-plane.ts:76")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/18f6f55e.a8327c04.js b/build/assets/js/18f6f55e.a8327c04.js deleted file mode 100644 index 0ca2a20bc..000000000 --- a/build/assets/js/18f6f55e.a8327c04.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:()=>s,contentTitle:()=>p,default:()=>k,frontMatter:()=>l,metadata:()=>r,toc:()=>o});var i=t(7462),a=(t(7294),t(3905));const l={id:"openbim_components.EdgesPlane",title:"Class: EdgesPlane",sidebar_label:"EdgesPlane",custom_edit_url:null},p=void 0,r={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"}},s={},o=[{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:"onDraggingEnded",id:"ondraggingended",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onDraggingStarted",id:"ondraggingstarted",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{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:"meshes",id:"meshes",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"planeMaterial",id:"planematerial",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"visible",id:"visible",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"setEnabled",id:"setenabled",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-16",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:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-21",level:4}],d={toc:o},m="wrapper";function k(e){let{components:n,...t}=e;return(0,a.kt)(m,(0,i.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"),".EdgesPlane"),(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 includes\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.SimplePlane"},(0,a.kt)("inlineCode",{parentName:"a"},"SimplePlane"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"EdgesPlane"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"edgesmaxupdaterate"},"edgesMaxUpdateRate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"edgesMaxUpdateRate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"50")),(0,a.kt)("p",null,"The max rate in milliseconds at which edges can be regenerated.\nTo disable this behaviour set this to 0."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/navigation/EdgesClipper/src/edges-plane.ts#L17"},"src/navigation/EdgesClipper/src/edges-plane.ts:17")),(0,a.kt)("hr",null),(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:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#name"},"name")),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L14"},"src/core/SimpleClipper/simple-plane.ts:14")),(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:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#ondraggingended"},"onDraggingEnded")),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L20"},"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:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#ondraggingstarted"},"onDraggingStarted")),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L17"},"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,"SimplePlane.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/ifcjs/components/blob/e46138a/src/navigation/EdgesClipper/src/edges-plane.ts#L37"},"src/navigation/EdgesClipper/src/edges-plane.ts:37")),(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)("p",null,"The meshes used for raycasting"),(0,a.kt)("h4",{id:"returns-1"},"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)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"SimplePlane.meshes"),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L68"},"src/core/SimpleClipper/simple-plane.ts:68")),(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-2"},"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:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"SimplePlane.planeMaterial"),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L73"},"src/core/SimpleClipper/simple-plane.ts:73")),(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"},"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-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"SimplePlane.planeMaterial"),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L78"},"src/core/SimpleClipper/simple-plane.ts:78")),(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-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,"SimplePlane.size"),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L83"},"src/core/SimpleClipper/simple-plane.ts:83")),(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-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"},"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-7"},"Inherited from"),(0,a.kt)("p",null,"SimplePlane.size"),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L88"},"src/core/SimpleClipper/simple-plane.ts:88")),(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-8"},"Inherited from"),(0,a.kt)("p",null,"SimplePlane.visible"),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L55"},"src/core/SimpleClipper/simple-plane.ts:55")),(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-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"},"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-9"},"Inherited from"),(0,a.kt)("p",null,"SimplePlane.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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L60"},"src/core/SimpleClipper/simple-plane.ts:60")),(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-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:"overrides-1"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#dispose"},"dispose")),(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/ifcjs/components/blob/e46138a/src/navigation/EdgesClipper/src/edges-plane.ts#L42"},"src/navigation/EdgesClipper/src/edges-plane.ts:42")),(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-9"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Plane")),(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.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#get"},"get")),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/simple-plane.ts#L134"},"src/core/SimpleClipper/simple-plane.ts:134")),(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-10"},"Returns"),(0,a.kt)("p",null,"this is UI"),(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.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#hasui"},"hasUI")),(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/ifcjs/components/blob/e46138a/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-11"},"Returns"),(0,a.kt)("p",null,"this is Configurable"),(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.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#isconfigurable"},"isConfigurable")),(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/ifcjs/components/blob/e46138a/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-12"},"Returns"),(0,a.kt)("p",null,"this is Disposable"),(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.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#isdisposeable"},"isDisposeable")),(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/ifcjs/components/blob/e46138a/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-13"},"Returns"),(0,a.kt)("p",null,"this is Hideable"),(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.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#ishideable"},"isHideable")),(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/ifcjs/components/blob/e46138a/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-14"},"Returns"),(0,a.kt)("p",null,"this is Resizeable"),(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.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#isresizeable"},"isResizeable")),(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/ifcjs/components/blob/e46138a/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-15"},"Returns"),(0,a.kt)("p",null,"this is Updateable"),(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.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#isupdateable"},"isUpdateable")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"setenabled"},"setEnabled"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"setEnabled"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"state"),"): ",(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#enabled"},"Component.enabled")),(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-16"},"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-20"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/navigation/EdgesClipper/src/edges-plane.ts#L48"},"src/navigation/EdgesClipper/src/edges-plane.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-17"},"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-2"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),".",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane#update"},"update")),(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/ifcjs/components/blob/e46138a/src/navigation/EdgesClipper/src/edges-plane.ts#L70"},"src/navigation/EdgesClipper/src/edges-plane.ts:70")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/23f030fe.13964c3a.js b/build/assets/js/23f030fe.13964c3a.js new file mode 100644 index 000000000..9ce41cef0 --- /dev/null +++ b/build/assets/js/23f030fe.13964c3a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1569],{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 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},m=function(e){var t=s(e.components);return a.createElement(r.Provider,{value:t},e.children)},d="mdxType",k={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,i=e.mdxType,o=e.originalType,r=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),d=s(n),c=i,u=d["".concat(r,".").concat(c)]||d[c]||k[c]||o;return n?a.createElement(u,p(p({ref:t},m),{},{components:n})):a.createElement(u,p({ref:t},m))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var o=n.length,p=new Array(o);p[0]=c;var l={};for(var r in t)hasOwnProperty.call(t,r)&&(l[r]=t[r]);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:()=>r,contentTitle:()=>p,default:()=>k,frontMatter:()=>o,metadata:()=>l,toc:()=>s});var a=n(7462),i=(n(7294),n(3905));const o={id:"openbim_components.ToolComponent",title:"Class: ToolComponent",sidebar_label:"ToolComponent",custom_edit_url:null},p=void 0,l={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"}},r={},s=[{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}],m={toc:s},d="wrapper";function k(e){let{components:t,...n}=e;return(0,i.kt)(d,(0,a.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"),".ToolComponent"),(0,i.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,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)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"ToolComponent"))))),(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:"enabled"},"enabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"enabled"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"true")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/ToolsComponent/index.ts#L31"},"temp/components/src/core/ToolsComponent/index.ts:31")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"list"},"list"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"list"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">",">"," = ",(0,i.kt)("inlineCode",{parentName:"p"},"{}")),(0,i.kt)("p",null,"The list of components created in this app."),(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/IFCjs/components/blob/0c38d20/src/core/ToolsComponent/index.ts#L16"},"temp/components/src/core/ToolsComponent/index.ts:16")),(0,i.kt)("hr",null),(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-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/ToolsComponent/index.ts#L19"},"temp/components/src/core/ToolsComponent/index.ts:19")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"token"},"token"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"token"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'""')),(0,i.kt)("p",null,"The auth token to get tools from That Open Platform."),(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/IFCjs/components/blob/0c38d20/src/core/ToolsComponent/index.ts#L25"},"temp/components/src/core/ToolsComponent/index.ts:25")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"uuid"},"uuid"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"uuid"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"ToolComponent"')),(0,i.kt)("p",null,"Component.uuid"),(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/IFCjs/components/blob/0c38d20/src/core/ToolsComponent/index.ts#L28"},"temp/components/src/core/ToolsComponent/index.ts:28")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"libraryuuids"},"libraryUUIDs"),(0,i.kt)("p",null,"\u25aa ",(0,i.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"libraryUUIDs"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Set"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,i.kt)("p",null,"The list of UUIDs of all the components in this library."),(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/IFCjs/components/blob/0c38d20/src/core/ToolsComponent/index.ts#L22"},"temp/components/src/core/ToolsComponent/index.ts:22")),(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"},"uuid"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"instance"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Adds a new tool. Use this in the constructor of your tools."),(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"},"uuid")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The UUID of your tool.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"instance")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,i.kt)("td",{parentName:"tr",align:"left"},"The instance of your tool (",(0,i.kt)("inlineCode",{parentName:"td"},"this")," inside the constructor).")))),(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-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/ToolsComponent/index.ts#L58"},"temp/components/src/core/ToolsComponent/index.ts:58")),(0,i.kt)("hr",null),(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,"Disposes all the MEMORY used by all the tools."),(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-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/ToolsComponent/index.ts#L107"},"temp/components/src/core/ToolsComponent/index.ts:107")),(0,i.kt)("hr",null),(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"},"T"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"U"),">","(",(0,i.kt)("inlineCode",{parentName:"p"},"ToolClass"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"U")),(0,i.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,i.kt)("h4",{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"},(0,i.kt)("inlineCode",{parentName:"td"},"T"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"U")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,i.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"T"),">")))),(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"},"ToolClass")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Object")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The component to get or create.")))),(0,i.kt)("h4",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"U")),(0,i.kt)("h4",{id:"overrides-1"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(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/IFCjs/components/blob/0c38d20/src/core/ToolsComponent/index.ts#L74"},"temp/components/src/core/ToolsComponent/index.ts:74")),(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-3"},"Returns"),(0,i.kt)("p",null,"this is UI"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/components/src/base-types/component.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"init"},"init"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"init"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"OBC"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Pass the whole library object as argument."),(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"},"OBC")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))))),(0,i.kt)("h4",{id:"returns-4"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/ToolsComponent/index.ts#L46"},"temp/components/src/core/ToolsComponent/index.ts:46")),(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-5"},"Returns"),(0,i.kt)("p",null,"this is Configurable"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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-6"},"Returns"),(0,i.kt)("p",null,"this is Disposable"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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-7"},"Returns"),(0,i.kt)("p",null,"this is Hideable"),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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-8"},"Returns"),(0,i.kt)("p",null,"this is Resizeable"),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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-9"},"Returns"),(0,i.kt)("p",null,"this is Updateable"),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/src/base-types/component.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"update"},"update"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"update"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"delta"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Updates all the registered tool components. Only the components where the\nproperty ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")," is true will be updated."),(0,i.kt)("h4",{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)("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"},"delta")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The ",(0,i.kt)("a",{parentName:"td",href:"https://threejs.org/docs/#api/en/core/Clock"},"delta time")," of the loop.")))),(0,i.kt)("h4",{id:"returns-10"},"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-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/ToolsComponent/index.ts#L95"},"temp/components/src/core/ToolsComponent/index.ts:95")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/23f030fe.3f14ca60.js b/build/assets/js/23f030fe.3f14ca60.js deleted file mode 100644 index 3452dcffc..000000000 --- a/build/assets/js/23f030fe.3f14ca60.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1569],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>c});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 l(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 p=a.createContext({}),s=function(e){var t=a.useContext(p),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(p.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,p=e.parentName,d=r(e,["components","mdxType","originalType","parentName"]),m=s(n),u=i,c=m["".concat(p,".").concat(u)]||m[u]||k[u]||o;return n?a.createElement(c,l(l({ref:t},d),{},{components:n})):a.createElement(c,l({ref:t},d))}));function c(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var o=n.length,l=new Array(o);l[0]=u;var r={};for(var p in t)hasOwnProperty.call(t,p)&&(r[p]=t[p]);r.originalType=e,r[m]="string"==typeof e?e:i,l[1]=r;for(var s=2;s{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>k,frontMatter:()=>o,metadata:()=>r,toc:()=>s});var a=n(7462),i=(n(7294),n(3905));const o={id:"openbim_components.ToolComponent",title:"Class: ToolComponent",sidebar_label:"ToolComponent",custom_edit_url:null},l=void 0,r={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"}},p={},s=[{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:"token",id:"token",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"uuid",id:"uuid",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"libraryUUIDs",id:"libraryuuids",level:3},{value:"Defined in",id:"defined-in-4",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-5",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-6",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-7",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-8",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-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-3",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-15",level:4}],d={toc:s},m="wrapper";function k(e){let{components:t,...n}=e;return(0,i.kt)(m,(0,a.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"),".ToolComponent"),(0,i.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,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)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"ToolComponent"))))),(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:"enabled"},"enabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"enabled"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"true")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/ToolsComponent/index.ts#L28"},"src/core/ToolsComponent/index.ts:28")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"list"},"list"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"list"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">",">"," = ",(0,i.kt)("inlineCode",{parentName:"p"},"{}")),(0,i.kt)("p",null,"The list of components created in this app."),(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/ifcjs/components/blob/e46138a/src/core/ToolsComponent/index.ts#L16"},"src/core/ToolsComponent/index.ts:16")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"token"},"token"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"token"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'""')),(0,i.kt)("p",null,"The auth token to get tools from That Open Platform."),(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/ifcjs/components/blob/e46138a/src/core/ToolsComponent/index.ts#L22"},"src/core/ToolsComponent/index.ts:22")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"uuid"},"uuid"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"uuid"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"ToolComponent"')),(0,i.kt)("p",null,"Component.uuid"),(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/ifcjs/components/blob/e46138a/src/core/ToolsComponent/index.ts#L25"},"src/core/ToolsComponent/index.ts:25")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"libraryuuids"},"libraryUUIDs"),(0,i.kt)("p",null,"\u25aa ",(0,i.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"libraryUUIDs"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Set"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,i.kt)("p",null,"The list of UUIDs of all the components in this library."),(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/ifcjs/components/blob/e46138a/src/core/ToolsComponent/index.ts#L19"},"src/core/ToolsComponent/index.ts:19")),(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"},"uuid"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"instance"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Adds a new tool. Use this in the constructor of your tools."),(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"},"uuid")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The UUID of your tool.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"instance")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,i.kt)("td",{parentName:"tr",align:"left"},"The instance of your tool (",(0,i.kt)("inlineCode",{parentName:"td"},"this")," inside the constructor).")))),(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-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/ToolsComponent/index.ts#L55"},"src/core/ToolsComponent/index.ts:55")),(0,i.kt)("hr",null),(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,"Disposes all the MEMORY used by all the tools."),(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"},"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-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/ToolsComponent/index.ts#L104"},"src/core/ToolsComponent/index.ts:104")),(0,i.kt)("hr",null),(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"},"T"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"U"),">","(",(0,i.kt)("inlineCode",{parentName:"p"},"ToolClass"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"U")),(0,i.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,i.kt)("h4",{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"},(0,i.kt)("inlineCode",{parentName:"td"},"T"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"U")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,i.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"T"),">")))),(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"},"ToolClass")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Object")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The component to get or create.")))),(0,i.kt)("h4",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"U")),(0,i.kt)("h4",{id:"overrides-1"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(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/ifcjs/components/blob/e46138a/src/core/ToolsComponent/index.ts#L71"},"src/core/ToolsComponent/index.ts:71")),(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-3"},"Returns"),(0,i.kt)("p",null,"this is UI"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L62"},"src/base-types/component.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"init"},"init"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"init"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"OBC"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Pass the whole library object as argument."),(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"},"OBC")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))))),(0,i.kt)("h4",{id:"returns-4"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/ToolsComponent/index.ts#L43"},"src/core/ToolsComponent/index.ts:43")),(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-5"},"Returns"),(0,i.kt)("p",null,"this is Configurable"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L57"},"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-6"},"Returns"),(0,i.kt)("p",null,"this is Disposable"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L35"},"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-7"},"Returns"),(0,i.kt)("p",null,"this is Hideable"),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L52"},"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-8"},"Returns"),(0,i.kt)("p",null,"this is Resizeable"),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L40"},"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-9"},"Returns"),(0,i.kt)("p",null,"this is Updateable"),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"update"},"update"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"update"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"delta"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Updates all the registered tool components. Only the components where the\nproperty ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")," is true will be updated."),(0,i.kt)("h4",{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)("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"},"delta")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The ",(0,i.kt)("a",{parentName:"td",href:"https://threejs.org/docs/#api/en/core/Clock"},"delta time")," of the loop.")))),(0,i.kt)("h4",{id:"returns-10"},"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-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/ToolsComponent/index.ts#L92"},"src/core/ToolsComponent/index.ts:92")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/27f44bf8.bb7840b1.js b/build/assets/js/247783bb.dadfb5a6.js similarity index 62% rename from build/assets/js/27f44bf8.bb7840b1.js rename to build/assets/js/247783bb.dadfb5a6.js index 76126b695..fd96dba6d 100644 --- a/build/assets/js/27f44bf8.bb7840b1.js +++ b/build/assets/js/247783bb.dadfb5a6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2853],{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([[9334],{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/2fcf8701.0370d191.js b/build/assets/js/2fcf8701.0370d191.js new file mode 100644 index 000000000..3abfb8b1a --- /dev/null +++ b/build/assets/js/2fcf8701.0370d191.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8561],{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 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 r(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var l=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):r(r({},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,i=e.mdxType,l=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),m=s(n),k=i,h=m["".concat(o,".").concat(k)]||m[k]||c[k]||l;return n?a.createElement(h,r(r({ref:t},d),{},{components:n})):a.createElement(h,r({ref:t},d))}));function h(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var l=n.length,r=new Array(l);r[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:i,r[1]=p;for(var s=2;s{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>r,default:()=>c,frontMatter:()=>l,metadata:()=>p,toc:()=>s});var a=n(7462),i=(n(7294),n(3905));const l={id:"openbim_components.LocalCacher",title:"Class: LocalCacher",sidebar_label:"LocalCacher",custom_edit_url:null},r=void 0,p={unversionedId:"api/classes/openbim_components.LocalCacher",id:"api/classes/openbim_components.LocalCacher",title:"Class: LocalCacher",description:"openbim-components.LocalCacher",source:"@site/docs/api/classes/openbim_components.LocalCacher.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.LocalCacher",permalink:"/api/classes/openbim_components.LocalCacher",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.LocalCacher",title:"Class: LocalCacher",sidebar_label:"LocalCacher",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"LengthMeasurement",permalink:"/api/classes/openbim_components.LengthMeasurement"},next:{title:"MapboxWindow",permalink:"/api/classes/openbim_components.MapboxWindow"}},o={},s=[{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:"onFileLoaded",id:"onfileloaded",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"onItemSaved",id:"onitemsaved",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"uiElement",id:"uielement",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Accessors",id:"accessors",level:2},{value:"ids",id:"ids",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Methods",id:"methods",level:2},{value:"delete",id:"delete",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"deleteAll",id:"deleteall",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"exists",id:"exists",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"get",id:"get",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-5",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-6",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-7",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-8",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-9",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-10",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-11",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"save",id:"save",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-17",level:4}],d={toc:s},m="wrapper";function c(e){let{components:t,...n}=e;return(0,i.kt)(m,(0,a.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"),".LocalCacher"),(0,i.kt)("p",null,"A tool to cache files using the browser's IndexedDB API. This might\nsave loading time and infrastructure costs for files that need to be\nfetched from the cloud."),(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)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"LocalCacher"))))),(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.UI"},(0,i.kt)("inlineCode",{parentName:"a"},"UI"))),(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:"enabled"},"enabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"enabled"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"true")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/LocalCacher/index.ts#L31"},"temp/components/src/core/LocalCacher/index.ts:31")),(0,i.kt)("hr",null),(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"},"string"),">"),(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-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/LocalCacher/index.ts#L28"},"temp/components/src/core/LocalCacher/index.ts:28")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onfileloaded"},"onFileLoaded"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onFileLoaded"),": ",(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"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," }",">"),(0,i.kt)("p",null,"Fires when a file has been loaded from cache."),(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/IFCjs/components/blob/0c38d20/src/core/LocalCacher/index.ts#L22"},"temp/components/src/core/LocalCacher/index.ts:22")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onitemsaved"},"onItemSaved"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onItemSaved"),": ",(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"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," }",">"),(0,i.kt)("p",null,"Fires when a file has been saved into cache."),(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/IFCjs/components/blob/0c38d20/src/core/LocalCacher/index.ts#L25"},"temp/components/src/core/LocalCacher/index.ts:25")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"uielement"},"uiElement"),(0,i.kt)("p",null,"\u2022 ",(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"},"floatingMenu"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"FloatingWindow")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"loadButton"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Button")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"main"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Button")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"saveButton"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Button")," }",">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI#uielement"},"UI.uiElement")),(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.UI"},"UI"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI#uielement"},"uiElement")),(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/IFCjs/components/blob/0c38d20/src/core/LocalCacher/index.ts#L34"},"temp/components/src/core/LocalCacher/index.ts:34")),(0,i.kt)("h2",{id:"accessors"},"Accessors"),(0,i.kt)("h3",{id:"ids"},"ids"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"ids"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,i.kt)("p",null,"The IDs of all the stored files."),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(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/IFCjs/components/blob/0c38d20/src/core/LocalCacher/index.ts#L47"},"temp/components/src/core/LocalCacher/index.ts:47")),(0,i.kt)("h2",{id:"methods"},"Methods"),(0,i.kt)("h3",{id:"delete"},"delete"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"delete"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"ids"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Deletes the files stored in the given ids."),(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"},"ids")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,i.kt)("td",{parentName:"tr",align:"left"},"the identifiers of the files to delete.")))),(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:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/LocalCacher/index.ts#L106"},"temp/components/src/core/LocalCacher/index.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"deleteall"},"deleteAll"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"deleteAll"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Deletes all the stored files."),(0,i.kt)("h4",{id:"returns-2"},"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-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/LocalCacher/index.ts#L118"},"temp/components/src/core/LocalCacher/index.ts:118")),(0,i.kt)("hr",null),(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-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:"implementation-of-2"},"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-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/LocalCacher/index.ts#L127"},"temp/components/src/core/LocalCacher/index.ts:127")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"exists"},"exists"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"exists"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Checks if there's a file stored with the given ID."),(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"},"id")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"to check.")))),(0,i.kt)("h4",{id:"returns-4"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/LocalCacher/index.ts#L97"},"temp/components/src/core/LocalCacher/index.ts:97")),(0,i.kt)("hr",null),(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"},"id"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Blob"),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get"),"."),(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)("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"},"id")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the ID of the file to fetch.")))),(0,i.kt)("h4",{id:"returns-5"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Blob"),">"),(0,i.kt)("h4",{id:"overrides-1"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/LocalCacher/index.ts#L65"},"temp/components/src/core/LocalCacher/index.ts:65")),(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-6"},"Returns"),(0,i.kt)("p",null,"this is UI"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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-7"},"Returns"),(0,i.kt)("p",null,"this is Configurable"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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-8"},"Returns"),(0,i.kt)("p",null,"this is Disposable"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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-9"},"Returns"),(0,i.kt)("p",null,"this is Hideable"),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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-10"},"Returns"),(0,i.kt)("p",null,"this is Resizeable"),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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-11"},"Returns"),(0,i.kt)("p",null,"this is Updateable"),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/src/base-types/component.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"save"},"save"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"save"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Saves the file with the given ID."),(0,i.kt)("h4",{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)("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"},"id")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the ID to assign to the file.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"url")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the URL where the file is located.")))),(0,i.kt)("h4",{id:"returns-12"},"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-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/LocalCacher/index.ts#L81"},"temp/components/src/core/LocalCacher/index.ts:81")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/2fcf8701.68799588.js b/build/assets/js/2fcf8701.68799588.js deleted file mode 100644 index 3b2d074f2..000000000 --- a/build/assets/js/2fcf8701.68799588.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8561],{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 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 r(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var l=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):r(r({},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,i=e.mdxType,l=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),m=s(n),k=i,h=m["".concat(o,".").concat(k)]||m[k]||c[k]||l;return n?a.createElement(h,r(r({ref:t},d),{},{components:n})):a.createElement(h,r({ref:t},d))}));function h(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var l=n.length,r=new Array(l);r[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:i,r[1]=p;for(var s=2;s{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>r,default:()=>c,frontMatter:()=>l,metadata:()=>p,toc:()=>s});var a=n(7462),i=(n(7294),n(3905));const l={id:"openbim_components.LocalCacher",title:"Class: LocalCacher",sidebar_label:"LocalCacher",custom_edit_url:null},r=void 0,p={unversionedId:"api/classes/openbim_components.LocalCacher",id:"api/classes/openbim_components.LocalCacher",title:"Class: LocalCacher",description:"openbim-components.LocalCacher",source:"@site/docs/api/classes/openbim_components.LocalCacher.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.LocalCacher",permalink:"/api/classes/openbim_components.LocalCacher",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.LocalCacher",title:"Class: LocalCacher",sidebar_label:"LocalCacher",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"LengthMeasurement",permalink:"/api/classes/openbim_components.LengthMeasurement"},next:{title:"MapboxWindow",permalink:"/api/classes/openbim_components.MapboxWindow"}},o={},s=[{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:"onFileLoaded",id:"onfileloaded",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"onItemSaved",id:"onitemsaved",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"uiElement",id:"uielement",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Accessors",id:"accessors",level:2},{value:"ids",id:"ids",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Methods",id:"methods",level:2},{value:"delete",id:"delete",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"deleteAll",id:"deleteall",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"exists",id:"exists",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"get",id:"get",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-7",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-8",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-9",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-10",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-11",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"save",id:"save",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-16",level:4}],d={toc:s},m="wrapper";function c(e){let{components:t,...n}=e;return(0,i.kt)(m,(0,a.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"),".LocalCacher"),(0,i.kt)("p",null,"A tool to cache files using the browser's IndexedDB API. This might\nsave loading time and infrastructure costs for files that need to be\nfetched from the cloud."),(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)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"LocalCacher"))))),(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.UI"},(0,i.kt)("inlineCode",{parentName:"a"},"UI"))),(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:"enabled"},"enabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"enabled"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"true")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/LocalCacher/index.ts#L24"},"src/core/LocalCacher/index.ts:24")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onfileloaded"},"onFileLoaded"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onFileLoaded"),": ",(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"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," }",">"),(0,i.kt)("p",null,"Fires when a file has been loaded from cache."),(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/ifcjs/components/blob/e46138a/src/core/LocalCacher/index.ts#L18"},"src/core/LocalCacher/index.ts:18")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onitemsaved"},"onItemSaved"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onItemSaved"),": ",(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"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," }",">"),(0,i.kt)("p",null,"Fires when a file has been saved into cache."),(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/ifcjs/components/blob/e46138a/src/core/LocalCacher/index.ts#L21"},"src/core/LocalCacher/index.ts:21")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"uielement"},"uiElement"),(0,i.kt)("p",null,"\u2022 ",(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"},"floatingMenu"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"FloatingWindow")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"loadButton"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Button")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"main"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Button")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"saveButton"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Button")," }",">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI#uielement"},"UI.uiElement")),(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.UI"},"UI"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI#uielement"},"uiElement")),(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/ifcjs/components/blob/e46138a/src/core/LocalCacher/index.ts#L27"},"src/core/LocalCacher/index.ts:27")),(0,i.kt)("h2",{id:"accessors"},"Accessors"),(0,i.kt)("h3",{id:"ids"},"ids"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"ids"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,i.kt)("p",null,"The IDs of all the stored files."),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(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/ifcjs/components/blob/e46138a/src/core/LocalCacher/index.ts#L40"},"src/core/LocalCacher/index.ts:40")),(0,i.kt)("h2",{id:"methods"},"Methods"),(0,i.kt)("h3",{id:"delete"},"delete"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"delete"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"ids"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Deletes the files stored in the given ids."),(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"},"ids")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,i.kt)("td",{parentName:"tr",align:"left"},"the identifiers of the files to delete.")))),(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:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/LocalCacher/index.ts#L99"},"src/core/LocalCacher/index.ts:99")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"deleteall"},"deleteAll"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"deleteAll"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Deletes all the stored files."),(0,i.kt)("h4",{id:"returns-2"},"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-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/LocalCacher/index.ts#L111"},"src/core/LocalCacher/index.ts:111")),(0,i.kt)("hr",null),(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-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:"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-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/LocalCacher/index.ts#L120"},"src/core/LocalCacher/index.ts:120")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"exists"},"exists"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"exists"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Checks if there's a file stored with the given ID."),(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"},"id")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"to check.")))),(0,i.kt)("h4",{id:"returns-4"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(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/ifcjs/components/blob/e46138a/src/core/LocalCacher/index.ts#L90"},"src/core/LocalCacher/index.ts:90")),(0,i.kt)("hr",null),(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"},"id"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Blob"),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get"),"."),(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)("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"},"id")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the ID of the file to fetch.")))),(0,i.kt)("h4",{id:"returns-5"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Blob"),">"),(0,i.kt)("h4",{id:"overrides-1"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/LocalCacher/index.ts#L58"},"src/core/LocalCacher/index.ts:58")),(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-6"},"Returns"),(0,i.kt)("p",null,"this is UI"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L62"},"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-7"},"Returns"),(0,i.kt)("p",null,"this is Configurable"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L57"},"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-8"},"Returns"),(0,i.kt)("p",null,"this is Disposable"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L35"},"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-9"},"Returns"),(0,i.kt)("p",null,"this is Hideable"),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L52"},"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-10"},"Returns"),(0,i.kt)("p",null,"this is Resizeable"),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L40"},"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-11"},"Returns"),(0,i.kt)("p",null,"this is Updateable"),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"save"},"save"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"save"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Saves the file with the given ID."),(0,i.kt)("h4",{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)("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"},"id")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the ID to assign to the file.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"url")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the URL where the file is located.")))),(0,i.kt)("h4",{id:"returns-12"},"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-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/LocalCacher/index.ts#L74"},"src/core/LocalCacher/index.ts:74")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/32cf703e.1da738bc.js b/build/assets/js/32cf703e.3eb1f971.js similarity index 61% rename from build/assets/js/32cf703e.1da738bc.js rename to build/assets/js/32cf703e.3eb1f971.js index 21b77f4e2..e95f577d7 100644 --- a/build/assets/js/32cf703e.1da738bc.js +++ b/build/assets/js/32cf703e.3eb1f971.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3053],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,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({}),p=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=p(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,c=s(e,["components","mdxType","originalType","parentName"]),u=p(r),g=o,f=u["".concat(l,".").concat(g)]||u[g]||d[g]||a;return r?n.createElement(f,i(i({ref:t},c),{},{components:r})):n.createElement(f,i({ref:t},c))}));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 p=2;p{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>a,metadata:()=>s,toc:()=>p});var n=r(7462),o=(r(7294),r(3905));const a={},i=void 0,s={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"}},l={},p=[{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}],c={toc:p},u="wrapper";function d(e){let{components:t,...r}=e;return(0,o.kt)(u,(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h3",{id:"-edit-properties-at-will"},"\u270d Edit properties at will!"),(0,o.kt)("hr",null),(0,o.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,o.kt)("pre",null,(0,o.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");\nmodel.properties = await properties.json();\n')),(0,o.kt)("p",null,"Then, we'll instance the tool that we need for editing properties:\nthe ",(0,o.kt)("inlineCode",{parentName:"p"},"IfcPropertiesManager"),"! It's designed as an extension of the\n",(0,o.kt)("inlineCode",{parentName:"p"},"IfcPropertiesProcessor"),", so if you haven't seen that tutorial\nyet, check it out before reading further."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},"const propsProcessor = new OBC.IfcPropertiesProcessor(components);\nconst propsManager = new OBC.IfcPropertiesManager(components);\npropsProcessor.propertiesManager = propsManager;\n")),(0,o.kt)("p",null,"The ",(0,o.kt)("inlineCode",{parentName:"p"},"IfcPropertiesManager")," can edit IFCs and export new IFC models,\nso we will need to get access to the same WASM files we needed when\nusing the ",(0,o.kt)("inlineCode",{parentName:"p"},"FragmentIfcLoader")," (as it uses the ",(0,o.kt)("inlineCode",{parentName:"p"},"web-ifc")," library\ndirectly). We can do it in a similar way, and then initialize the\nproperties manager and process the model:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'propsManager.wasm = {\npath: "https://unpkg.com/web-ifc@0.0.46/",\nabsolute: true\n}\nawait propsManager.init();\npropsProcessor.process(model);\npropsManager.onRequestFile.add(async () => {\nconst fetched = await fetch("../../../resources/small.ifc");\npropsManager.ifcToExport = await fetched.arrayBuffer();\n})\n')),(0,o.kt)("h3",{id:"-setting-up-highlighting-and-selecting"},"\u2728 Setting up highlighting and selecting"),(0,o.kt)("hr",null),(0,o.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,o.kt)("pre",null,(0,o.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,o.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,o.kt)("inlineCode",{parentName:"p"},"IfcPropertiesProcessor"),"\ntutorial:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},"highlighterEvents.select.onHighlight.add(\n(selection) => {\nconst fragmentID = Object.keys(selection)[0];\nconst expressID = Number([...selection[fragmentID]][0]);\nlet model\nfor (const group of fragments.groups) {\nconst fragmentFound = Object.values(group.keyFragments).find(id => id === fragmentID)\nif (fragmentFound) model = group;\n}\npropsProcessor.renderProperties(model, expressID);\n}\n);\n")),(0,o.kt)("p",null,"Finally, we will add the UI to the app by creating a simple\ntoolbar:"),(0,o.kt)("pre",null,(0,o.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,o.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,o.kt)("iframe",{src:"https://ifcjs.github.io/components/src/ifc/IfcPropertiesManager/index.html"}))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3053],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,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({}),p=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=p(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,c=s(e,["components","mdxType","originalType","parentName"]),u=p(r),g=o,f=u["".concat(l,".").concat(g)]||u[g]||d[g]||a;return r?n.createElement(f,i(i({ref:t},c),{},{components:r})):n.createElement(f,i({ref:t},c))}));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 p=2;p{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>a,metadata:()=>s,toc:()=>p});var n=r(7462),o=(r(7294),r(3905));const a={},i=void 0,s={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"}},l={},p=[{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}],c={toc:p},u="wrapper";function d(e){let{components:t,...r}=e;return(0,o.kt)(u,(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h3",{id:"-edit-properties-at-will"},"\u270d Edit properties at will!"),(0,o.kt)("hr",null),(0,o.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,o.kt)("pre",null,(0,o.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");\nmodel.properties = await properties.json();\n')),(0,o.kt)("p",null,"Then, we'll instance the tool that we need for editing properties:\nthe ",(0,o.kt)("inlineCode",{parentName:"p"},"IfcPropertiesManager"),"! It's designed as an extension of the\n",(0,o.kt)("inlineCode",{parentName:"p"},"IfcPropertiesProcessor"),", so if you haven't seen that tutorial\nyet, check it out before reading further."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},"const propsProcessor = new OBC.IfcPropertiesProcessor(components);\nconst propsManager = new OBC.IfcPropertiesManager(components);\npropsProcessor.propertiesManager = propsManager;\n")),(0,o.kt)("p",null,"The ",(0,o.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,o.kt)("inlineCode",{parentName:"p"},"IfcPropertiesProcessor")," to use\nthe built-in UI, because is easier!\n:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'propsProcessor.process(model);\npropsManager.onRequestFile.add(async () => {\nconst fetched = await fetch("../../../resources/small.ifc");\npropsManager.ifcToExport = await fetched.arrayBuffer();\n})\n')),(0,o.kt)("h3",{id:"-setting-up-highlighting-and-selecting"},"\u2728 Setting up highlighting and selecting"),(0,o.kt)("hr",null),(0,o.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,o.kt)("pre",null,(0,o.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,o.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,o.kt)("inlineCode",{parentName:"p"},"IfcPropertiesProcessor"),"\ntutorial:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},"highlighterEvents.select.onHighlight.add(\n(selection) => {\nconst fragmentID = Object.keys(selection)[0];\nconst expressID = Number([...selection[fragmentID]][0]);\nlet model\nfor (const group of fragments.groups) {\nconst fragmentFound = Object.values(group.keyFragments).find(id => id === fragmentID)\nif (fragmentFound) model = group;\n}\npropsProcessor.renderProperties(model, expressID);\n}\n);\n")),(0,o.kt)("p",null,"Finally, we will add the UI to the app by creating a simple\ntoolbar:"),(0,o.kt)("pre",null,(0,o.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,o.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,o.kt)("iframe",{src:"https://ifcjs.github.io/components/src/ifc/IfcPropertiesManager/index.html"}))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/3303a5a5.01895fd4.js b/build/assets/js/3303a5a5.01895fd4.js new file mode 100644 index 000000000..66228b9c2 --- /dev/null +++ b/build/assets/js/3303a5a5.01895fd4.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 s(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 r(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var s=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):r(r({},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,s=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]||s;return n?i.createElement(h,r(r({ref:t},d),{},{components:n})):i.createElement(h,r({ref:t},d))}));function h(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var s=n.length,r=new Array(s);r[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,r[1]=l;for(var o=2;o{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>r,default:()=>c,frontMatter:()=>s,metadata:()=>l,toc:()=>o});var i=n(7462),a=(n(7294),n(3905));const s={id:"openbim_components.SimpleRaycaster",title:"Class: SimpleRaycaster",sidebar_label:"SimpleRaycaster",custom_edit_url:null},r=void 0,l={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"}},p={},o=[{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}],d={toc:o},m="wrapper";function c(e){let{components:t,...n}=e;return(0,a.kt)(m,(0,i.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"),".SimpleRaycaster"),(0,a.kt)("p",null,"A simple ",(0,a.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,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"},"BaseRaycaster")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"SimpleRaycaster"))))),(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,"BaseRaycaster.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/IFCjs/components/blob/0c38d20/src/core/SimpleRaycaster/index.ts#L13"},"temp/components/src/core/SimpleRaycaster/index.ts:13")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"mouse"},"mouse"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"mouse"),": ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Mouse"},(0,a.kt)("inlineCode",{parentName:"a"},"Mouse"))),(0,a.kt)("p",null,"The position of the mouse in the screen."),(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/IFCjs/components/blob/0c38d20/src/core/SimpleRaycaster/index.ts#L19"},"temp/components/src/core/SimpleRaycaster/index.ts:19")),(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:"overrides-1"},"Overrides"),(0,a.kt)("p",null,"BaseRaycaster.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/IFCjs/components/blob/0c38d20/src/core/SimpleRaycaster/index.ts#L16"},"temp/components/src/core/SimpleRaycaster/index.ts:16")),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"castray"},"castRay"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"castRay"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"items?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"Intersection"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Object3D"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Event"),">",">"),(0,a.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,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)("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"},"items")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Mesh"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"BufferGeometry"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"NormalBufferAttributes"),">",", ",(0,a.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"Material"),"[]",">","[]"),(0,a.kt)("td",{parentName:"tr",align:"left"},"the ",(0,a.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,a.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.Components#meshes"},"Components.meshes"),".")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"Intersection"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Object3D"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Event"),">",">"),(0,a.kt)("h4",{id:"overrides-2"},"Overrides"),(0,a.kt)("p",null,"BaseRaycaster.castRay"),(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/IFCjs/components/blob/0c38d20/src/core/SimpleRaycaster/index.ts#L51"},"temp/components/src/core/SimpleRaycaster/index.ts:51")),(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/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,a.kt)("h4",{id:"returns-1"},"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:"overrides-3"},"Overrides"),(0,a.kt)("p",null,"BaseRaycaster.dispose"),(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/IFCjs/components/blob/0c38d20/src/core/SimpleRaycaster/index.ts#L36"},"temp/components/src/core/SimpleRaycaster/index.ts:36")),(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"},"Raycaster")),(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-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Raycaster")),(0,a.kt)("h4",{id:"overrides-4"},"Overrides"),(0,a.kt)("p",null,"BaseRaycaster.get"),(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/IFCjs/components/blob/0c38d20/src/core/SimpleRaycaster/index.ts#L31"},"temp/components/src/core/SimpleRaycaster/index.ts:31")),(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,"BaseRaycaster.hasUI"),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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,"BaseRaycaster.isConfigurable"),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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,"BaseRaycaster.isDisposeable"),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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,"BaseRaycaster.isHideable"),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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,"BaseRaycaster.isResizeable"),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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,"BaseRaycaster.isUpdateable"),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/src/base-types/component.ts:45")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/3303a5a5.b7b7865b.js b/build/assets/js/3303a5a5.b7b7865b.js deleted file mode 100644 index 3422ecd93..000000000 --- a/build/assets/js/3303a5a5.b7b7865b.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:()=>p,contentTitle:()=>s,default:()=>c,frontMatter:()=>r,metadata:()=>l,toc:()=>o});var i=n(7462),a=(n(7294),n(3905));const r={id:"openbim_components.SimpleRaycaster",title:"Class: SimpleRaycaster",sidebar_label:"SimpleRaycaster",custom_edit_url:null},s=void 0,l={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"}},p={},o=[{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:"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-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"get",id:"get",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-3",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}],d={toc:o},m="wrapper";function c(e){let{components:t,...n}=e;return(0,a.kt)(m,(0,i.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"),".SimpleRaycaster"),(0,a.kt)("p",null,"A simple ",(0,a.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,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"},"BaseRaycaster")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"SimpleRaycaster"))))),(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,"BaseRaycaster.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/ifcjs/components/blob/e46138a/src/core/SimpleRaycaster/index.ts#L13"},"src/core/SimpleRaycaster/index.ts:13")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"mouse"},"mouse"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"mouse"),": ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Mouse"},(0,a.kt)("inlineCode",{parentName:"a"},"Mouse"))),(0,a.kt)("p",null,"The position of the mouse in the screen."),(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/ifcjs/components/blob/e46138a/src/core/SimpleRaycaster/index.ts#L16"},"src/core/SimpleRaycaster/index.ts:16")),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"castray"},"castRay"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"castRay"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"items?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"Intersection"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Object3D"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Event"),">",">"),(0,a.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,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)("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"},"items")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Mesh"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"BufferGeometry"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"NormalBufferAttributes"),">",", ",(0,a.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"Material"),"[]",">","[]"),(0,a.kt)("td",{parentName:"tr",align:"left"},"the ",(0,a.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,a.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.Components#meshes"},"Components.meshes"),".")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"Intersection"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Object3D"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Event"),">",">"),(0,a.kt)("h4",{id:"overrides-1"},"Overrides"),(0,a.kt)("p",null,"BaseRaycaster.castRay"),(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/ifcjs/components/blob/e46138a/src/core/SimpleRaycaster/index.ts#L46"},"src/core/SimpleRaycaster/index.ts:46")),(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/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,a.kt)("h4",{id:"returns-1"},"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"},"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:"overrides-2"},"Overrides"),(0,a.kt)("p",null,"BaseRaycaster.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/ifcjs/components/blob/e46138a/src/core/SimpleRaycaster/index.ts#L33"},"src/core/SimpleRaycaster/index.ts:33")),(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"},"Raycaster")),(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-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Raycaster")),(0,a.kt)("h4",{id:"overrides-3"},"Overrides"),(0,a.kt)("p",null,"BaseRaycaster.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/ifcjs/components/blob/e46138a/src/core/SimpleRaycaster/index.ts#L28"},"src/core/SimpleRaycaster/index.ts:28")),(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,"BaseRaycaster.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/ifcjs/components/blob/e46138a/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-1"},"Inherited from"),(0,a.kt)("p",null,"BaseRaycaster.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/ifcjs/components/blob/e46138a/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-2"},"Inherited from"),(0,a.kt)("p",null,"BaseRaycaster.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/ifcjs/components/blob/e46138a/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-3"},"Inherited from"),(0,a.kt)("p",null,"BaseRaycaster.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/ifcjs/components/blob/e46138a/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-4"},"Inherited from"),(0,a.kt)("p",null,"BaseRaycaster.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/ifcjs/components/blob/e46138a/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-5"},"Inherited from"),(0,a.kt)("p",null,"BaseRaycaster.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/ifcjs/components/blob/e46138a/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/338df764.6e62dacf.js b/build/assets/js/338df764.6e62dacf.js deleted file mode 100644 index c43126445..000000000 --- a/build/assets/js/338df764.6e62dacf.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9111],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>g});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 l(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 s=r.createContext({}),u=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=u(e.components);return r.createElement(s.Provider,{value:t},e.children)},p="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,s=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),p=u(n),d=a,g=p["".concat(s,".").concat(d)]||p[d]||m[d]||o;return n?r.createElement(g,l(l({ref:t},c),{},{components:n})):r.createElement(g,l({ref:t},c))}));function g(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,l=new Array(o);l[0]=d;var i={};for(var s in t)hasOwnProperty.call(t,s)&&(i[s]=t[s]);i.originalType=e,i[p]="string"==typeof e?e:a,l[1]=i;for(var u=2;u{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>m,frontMatter:()=>o,metadata:()=>i,toc:()=>u});var r=n(7462),a=(n(7294),n(3905));const o={},l=void 0,i={unversionedId:"Tutorials/ScreenCuller",id:"Tutorials/ScreenCuller",title:"ScreenCuller",description:"\ud83d\ude85 Managing Performance",source:"@site/docs/Tutorials/ScreenCuller.mdx",sourceDirName:"Tutorials",slug:"/Tutorials/ScreenCuller",permalink:"/Tutorials/ScreenCuller",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"PostproductionRenderer",permalink:"/Tutorials/PostproductionRenderer"},next:{title:"ShadowDropper",permalink:"/Tutorials/ShadowDropper"}},s={},u=[{value:"\ud83d\ude85 Managing Performance",id:"-managing-performance",level:3},{value:"\ud83e\uddf0 Creating Screen Culler",id:"-creating-screen-culler",level:3},{value:"\ud83e\uddf1 Adding a lot of 3D Objects",id:"-adding-a-lot-of-3d-objects",level:3},{value:"\ud83e\uddea Generate Multiple Cubes",id:"-generate-multiple-cubes",level:4},{value:"\ud83e\uddf9 Cleaning the Scene",id:"-cleaning-the-scene",level:4},{value:"\ud83d\udce2 Rendering Cubes",id:"-rendering-cubes",level:4}],c={toc:u},p="wrapper";function m(e){let{components:t,...n}=e;return(0,a.kt)(p,(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h3",{id:"-managing-performance"},"\ud83d\ude85 Managing Performance"),(0,a.kt)("hr",null),(0,a.kt)("p",null,"There are occasions when your scene has too many components.\nMultiple components being rendered simultaneously ",(0,a.kt)("strong",{parentName:"p"},"lengthens computation time"),"\u231b\ufe0f and ",(0,a.kt)("strong",{parentName:"p"},"degrades performance"),".\ud83c\udf21\ufe0f"),(0,a.kt)("admonition",{title:"First, let's set up a simple scene!",type:"tip"},(0,a.kt)("p",{parentName:"admonition"},"\ud83d\udc40 If you haven't started there, check out ",(0,a.kt)("a",{parentName:"p",href:"/Tutorials/SimpleScene"},"that tutorial first"),"!")),(0,a.kt)("p",null,"In this tutorial, we will use ",(0,a.kt)("strong",{parentName:"p"},"ScreenCuller")," to improve performance by reducing unnecessary computations.\ud83d\ude80\nThis tutorial will show you how to manage a complex scenario with a lot of elements in an effective way.\ud83e\uddbe"),(0,a.kt)("h3",{id:"-creating-screen-culler"},"\ud83e\uddf0 Creating Screen Culler"),(0,a.kt)("hr",null),(0,a.kt)("p",null,"Although adding Screen Culler to your project can appear difficult, it is actually rather easy.\nNow, we will add ",(0,a.kt)("strong",{parentName:"p"},"Screen Culler Component"),".\nThis will create a Screen Culler which is now ready to be used."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"const culler = new OBC.ScreenCuller(components);\n")),(0,a.kt)("p",null,"Additionally, we will activate the ",(0,a.kt)("inlineCode",{parentName:"p"},"culler.renderDebugFrame"),"\nso that we can see the 2D screen of the elements that are not occluded.\ud83d\udcbb\nAlso, we will get the ",(0,a.kt)("strong",{parentName:"p"},"domElement")," and attach it to the body so that we can see this frame in real-time.\ud83d\udcca"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"culler.renderDebugFrame = true;\nconst debugFrame = culler.renderer.domElement;\ndocument.body.appendChild(debugFrame);\ndebugFrame.style.position = 'fixed';\ndebugFrame.style.left = '0';\ndebugFrame.style.bottom = '0';\ndebugFrame.style.visibility = 'collapse';\n")),(0,a.kt)("admonition",{title:"Randomising the Cube Placement",type:"info"},(0,a.kt)("p",{parentName:"admonition"},"We'll write a quick ",(0,a.kt)("strong",{parentName:"p"},"utility")," function that returns a random number between 0 and the specified upper limit.\nYou can use this for a variety of purposes, but for this tutorial\nit will be used to generate random positions for cube placement.\ud83d\udccc")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"function getRandomNumber(limit) {\nreturn Math.random() * limit;\n}\n")),(0,a.kt)("h3",{id:"-adding-a-lot-of-3d-objects"},"\ud83e\uddf1 Adding a lot of 3D Objects"),(0,a.kt)("p",null,"We'll add the Simple 3D Cube and do it ",(0,a.kt)("strong",{parentName:"p"},"300 times"),"!\ud83e\udd2f\nComponents are built using ",(0,a.kt)("a",{parentName:"p",href:"https://threejs.org/"},"Three.js"),", making it simple to use any three.js code.\nFor our cube, we'll generate box geometry and use basic material."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"const cubes = [];\nconst geometry = new THREE.BoxGeometry(2, 2, 2);\nconst material = new THREE.MeshLambertMaterial({ color: '#6528D7' });\n")),(0,a.kt)("h4",{id:"-generate-multiple-cubes"},"\ud83e\uddea Generate Multiple Cubes"),(0,a.kt)("p",null,"Now, using the ",(0,a.kt)("inlineCode",{parentName:"p"},"getRandomNumber()")," method we previously created, we will add the 300 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"cube"))," meshes to our scene\nand randomly position them. We'll add the cube to the scene and adjust its position between 0 and 10.\nAdditionally, we will add meshes to the ",(0,a.kt)("inlineCode",{parentName:"p"},"culler")," object, which will help ",(0,a.kt)("strong",{parentName:"p"},"SimpleCuller")," to recognize and\ndraw the elements that are visible to the camera. To do this, ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"culler.add(cube)"))," will be used."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"function regenerateCubes() {\nresetCubes();\nfor (let i = 0; i < 300; i++) {\nconst cube = new THREE.Mesh(geometry, material);\ncube.position.x = getRandomNumber(10);\ncube.position.y = getRandomNumber(10);\ncube.position.z = getRandomNumber(10);\ncube.updateMatrix();\nscene.add(cube);\nculler.add(cube);\ncubes.push(cube);\n}\n}\n")),(0,a.kt)("h4",{id:"-cleaning-the-scene"},"\ud83e\uddf9 Cleaning the Scene"),(0,a.kt)("p",null,"Now that we know how to create multiple cubes, we will write a function to remove the cubes from scene on demand.\n",(0,a.kt)("inlineCode",{parentName:"p"},"resetCubes()")," iteratively removes the ",(0,a.kt)("strong",{parentName:"p"},"cubes")," using ",(0,a.kt)("a",{parentName:"p",href:"https://threejs.org/docs/index.html?q=obje#api/en/core/Object3D.removeFromParent"},(0,a.kt)("strong",{parentName:"a"},(0,a.kt)("inlineCode",{parentName:"strong"},"cube.removeFromParent"))),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"function resetCubes() {\nfor (const cube of cubes) {\ncube.removeFromParent();\n}\ncubes.length = 0;\n}\n")),(0,a.kt)("h4",{id:"-rendering-cubes"},"\ud83d\udce2 Rendering Cubes"),(0,a.kt)("p",null,"With everything ready, we will call ",(0,a.kt)("inlineCode",{parentName:"p"},"regenerateCubes()")," which will generate cubes and add them to scene."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"regenerateCubes();\n")),(0,a.kt)("p",null,"Here comes the most crucial part! The core aim of ",(0,a.kt)("strong",{parentName:"p"},"ScreenCuller")," is to output just those components that are\nvisible to the camera.\n",(0,a.kt)("inlineCode",{parentName:"p"},"culler.needsUpdate = true")," instructs the ScreenCuller to render the updated view.\n",(0,a.kt)("strong",{parentName:"p"}," Remember to update culler every time the camera is updated \u2755 "),"\nIn this tutorial we are updating it each time the camera stops moving."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},'culler.needsUpdate = true;\ncomponents.camera.controls.addEventListener("controlend", () => {\nculler.needsUpdate = true;\n});\n')),(0,a.kt)("p",null,"Great job! \ud83c\udf89 Now you know how to optimise your 3D scene using a\n",(0,a.kt)("strong",{parentName:"p"},"Screen Culler")," component! \ud83d\udcaa\nYour BIM app will now have unmatched performance and can render huge scenes easily. \ud83d\ude80\nLet's keep it up and check out another tutorials!"),(0,a.kt)("iframe",{src:"https://ifcjs.github.io/components/src/core/ScreenCuller/index.html"}))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/338df764.ac85bd20.js b/build/assets/js/338df764.ac85bd20.js new file mode 100644 index 000000000..8bafaf780 --- /dev/null +++ b/build/assets/js/338df764.ac85bd20.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9111],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>g});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 l(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 s=r.createContext({}),u=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=u(e.components);return r.createElement(s.Provider,{value:t},e.children)},p="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,s=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),p=u(n),d=a,g=p["".concat(s,".").concat(d)]||p[d]||m[d]||o;return n?r.createElement(g,l(l({ref:t},c),{},{components:n})):r.createElement(g,l({ref:t},c))}));function g(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,l=new Array(o);l[0]=d;var i={};for(var s in t)hasOwnProperty.call(t,s)&&(i[s]=t[s]);i.originalType=e,i[p]="string"==typeof e?e:a,l[1]=i;for(var u=2;u{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>m,frontMatter:()=>o,metadata:()=>i,toc:()=>u});var r=n(7462),a=(n(7294),n(3905));const o={},l=void 0,i={unversionedId:"Tutorials/ScreenCuller",id:"Tutorials/ScreenCuller",title:"ScreenCuller",description:"\ud83d\ude85 Managing Performance",source:"@site/docs/Tutorials/ScreenCuller.mdx",sourceDirName:"Tutorials",slug:"/Tutorials/ScreenCuller",permalink:"/Tutorials/ScreenCuller",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"PostproductionRenderer",permalink:"/Tutorials/PostproductionRenderer"},next:{title:"ShadowDropper",permalink:"/Tutorials/ShadowDropper"}},s={},u=[{value:"\ud83d\ude85 Managing Performance",id:"-managing-performance",level:3},{value:"\ud83e\uddf0 Creating Screen Culler",id:"-creating-screen-culler",level:3},{value:"\ud83e\uddf1 Adding a lot of 3D Objects",id:"-adding-a-lot-of-3d-objects",level:3},{value:"\ud83e\uddea Generate Multiple Cubes",id:"-generate-multiple-cubes",level:4},{value:"\ud83e\uddf9 Cleaning the Scene",id:"-cleaning-the-scene",level:4},{value:"\ud83d\udce2 Rendering Cubes",id:"-rendering-cubes",level:4}],c={toc:u},p="wrapper";function m(e){let{components:t,...n}=e;return(0,a.kt)(p,(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h3",{id:"-managing-performance"},"\ud83d\ude85 Managing Performance"),(0,a.kt)("hr",null),(0,a.kt)("p",null,"There are occasions when your scene has too many components.\nMultiple components being rendered simultaneously ",(0,a.kt)("strong",{parentName:"p"},"lengthens computation time"),"\u231b\ufe0f and ",(0,a.kt)("strong",{parentName:"p"},"degrades performance"),".\ud83c\udf21\ufe0f"),(0,a.kt)("admonition",{title:"First, let's set up a simple scene!",type:"tip"},(0,a.kt)("p",{parentName:"admonition"},"\ud83d\udc40 If you haven't started there, check out ",(0,a.kt)("a",{parentName:"p",href:"/Tutorials/SimpleScene"},"that tutorial first"),"!")),(0,a.kt)("p",null,"In this tutorial, we will use ",(0,a.kt)("strong",{parentName:"p"},"ScreenCuller")," to improve performance by reducing unnecessary computations.\ud83d\ude80\nThis tutorial will show you how to manage a complex scenario with a lot of elements in an effective way.\ud83e\uddbe"),(0,a.kt)("h3",{id:"-creating-screen-culler"},"\ud83e\uddf0 Creating Screen Culler"),(0,a.kt)("hr",null),(0,a.kt)("p",null,"Although adding Screen Culler to your project can appear difficult, it is actually rather easy.\nNow, we will add ",(0,a.kt)("strong",{parentName:"p"},"Screen Culler Component"),".\nThis will create a Screen Culler which is now ready to be used."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"const culler = new OBC.ScreenCuller(components);\nawait culler.setup()\n")),(0,a.kt)("p",null,"Additionally, we will activate the ",(0,a.kt)("inlineCode",{parentName:"p"},"culler.renderDebugFrame"),"\nso that we can see the 2D screen of the elements that are not occluded.\ud83d\udcbb\nAlso, we will get the ",(0,a.kt)("strong",{parentName:"p"},"domElement")," and attach it to the body so that we can see this frame in real-time.\ud83d\udcca"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"culler.renderDebugFrame = true;\nconst debugFrame = culler.renderer.domElement;\ndocument.body.appendChild(debugFrame);\ndebugFrame.style.position = 'fixed';\ndebugFrame.style.left = '0';\ndebugFrame.style.bottom = '0';\ndebugFrame.style.visibility = 'collapse';\n")),(0,a.kt)("admonition",{title:"Randomising the Cube Placement",type:"info"},(0,a.kt)("p",{parentName:"admonition"},"We'll write a quick ",(0,a.kt)("strong",{parentName:"p"},"utility")," function that returns a random number between 0 and the specified upper limit.\nYou can use this for a variety of purposes, but for this tutorial\nit will be used to generate random positions for cube placement.\ud83d\udccc")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"function getRandomNumber(limit) {\nreturn Math.random() * limit;\n}\n")),(0,a.kt)("h3",{id:"-adding-a-lot-of-3d-objects"},"\ud83e\uddf1 Adding a lot of 3D Objects"),(0,a.kt)("p",null,"We'll add the Simple 3D Cube and do it ",(0,a.kt)("strong",{parentName:"p"},"300 times"),"!\ud83e\udd2f\nComponents are built using ",(0,a.kt)("a",{parentName:"p",href:"https://threejs.org/"},"Three.js"),", making it simple to use any three.js code.\nFor our cube, we'll generate box geometry and use basic material."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"const cubes = [];\nconst geometry = new THREE.BoxGeometry(2, 2, 2);\nconst material = new THREE.MeshLambertMaterial({ color: '#6528D7' });\n")),(0,a.kt)("h4",{id:"-generate-multiple-cubes"},"\ud83e\uddea Generate Multiple Cubes"),(0,a.kt)("p",null,"Now, using the ",(0,a.kt)("inlineCode",{parentName:"p"},"getRandomNumber()")," method we previously created, we will add the 300 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"cube"))," meshes to our scene\nand randomly position them. We'll add the cube to the scene and adjust its position between 0 and 10.\nAdditionally, we will add meshes to the ",(0,a.kt)("inlineCode",{parentName:"p"},"culler")," object, which will help ",(0,a.kt)("strong",{parentName:"p"},"SimpleCuller")," to recognize and\ndraw the elements that are visible to the camera. To do this, ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"culler.add(cube)"))," will be used."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"function regenerateCubes() {\nresetCubes();\nfor (let i = 0; i < 300; i++) {\nconst cube = new THREE.Mesh(geometry, material);\ncube.position.x = getRandomNumber(10);\ncube.position.y = getRandomNumber(10);\ncube.position.z = getRandomNumber(10);\ncube.updateMatrix();\nscene.add(cube);\nculler.add(cube);\ncubes.push(cube);\n}\n}\n")),(0,a.kt)("h4",{id:"-cleaning-the-scene"},"\ud83e\uddf9 Cleaning the Scene"),(0,a.kt)("p",null,"Now that we know how to create multiple cubes, we will write a function to remove the cubes from scene on demand.\n",(0,a.kt)("inlineCode",{parentName:"p"},"resetCubes()")," iteratively removes the ",(0,a.kt)("strong",{parentName:"p"},"cubes")," using ",(0,a.kt)("a",{parentName:"p",href:"https://threejs.org/docs/index.html?q=obje#api/en/core/Object3D.removeFromParent"},(0,a.kt)("strong",{parentName:"a"},(0,a.kt)("inlineCode",{parentName:"strong"},"cube.removeFromParent"))),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"function resetCubes() {\nfor (const cube of cubes) {\ncube.removeFromParent();\n}\ncubes.length = 0;\n}\n")),(0,a.kt)("h4",{id:"-rendering-cubes"},"\ud83d\udce2 Rendering Cubes"),(0,a.kt)("p",null,"With everything ready, we will call ",(0,a.kt)("inlineCode",{parentName:"p"},"regenerateCubes()")," which will generate cubes and add them to scene."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"regenerateCubes();\n")),(0,a.kt)("p",null,"Here comes the most crucial part! The core aim of ",(0,a.kt)("strong",{parentName:"p"},"ScreenCuller")," is to output just those components that are\nvisible to the camera.\n",(0,a.kt)("inlineCode",{parentName:"p"},"culler.needsUpdate = true")," instructs the ScreenCuller to render the updated view.\n",(0,a.kt)("strong",{parentName:"p"}," Remember to update culler every time the camera is updated \u2755 "),"\nIn this tutorial we are updating it each time the camera stops moving."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},'culler.needsUpdate = true;\ncomponents.camera.controls.addEventListener("controlend", () => {\nculler.needsUpdate = true;\n});\n')),(0,a.kt)("p",null,"Great job! \ud83c\udf89 Now you know how to optimise your 3D scene using a\n",(0,a.kt)("strong",{parentName:"p"},"Screen Culler")," component! \ud83d\udcaa\nYour BIM app will now have unmatched performance and can render huge scenes easily. \ud83d\ude80\nLet's keep it up and check out another tutorials!"),(0,a.kt)("iframe",{src:"https://ifcjs.github.io/components/src/core/ScreenCuller/index.html"}))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/4f2f3afd.b56c855f.js b/build/assets/js/4f2f3afd.b56c855f.js deleted file mode 100644 index fc0ab7c12..000000000 --- a/build/assets/js/4f2f3afd.b56c855f.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 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 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 p(e){for(var n=1;n=0||(r[t]=e[t]);return r}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}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,r=e.mdxType,i=e.originalType,l=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),c=s(t),u=r,b=c["".concat(l,".").concat(u)]||c[u]||d[u]||i;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,r=n&&n.mdxType;if("string"==typeof e||r){var i=t.length,p=new Array(i);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:r,p[1]=o;for(var s=2;s{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>p,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>s});var a=t(7462),r=(t(7294),t(3905));const i={id:"openbim_components.Disposable",title:"Interface: Disposable",sidebar_label:"Disposable",custom_edit_url:null},p=void 0,o={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"}},l={},s=[{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}],m={toc:s},c="wrapper";function d(e){let{components:n,...t}=e;return(0,r.kt)(c,(0,a.Z)({},m,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.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.FragmentIfcLoader"},(0,r.kt)("inlineCode",{parentName:"a"},"FragmentIfcLoader"))),(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.LocalCacher"},(0,r.kt)("inlineCode",{parentName:"a"},"LocalCacher"))),(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/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L59"},"src/base-types/base-types.ts:59")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/4f2f3afd.c39cae88.js b/build/assets/js/4f2f3afd.c39cae88.js new file mode 100644 index 000000000..457ebe5af --- /dev/null +++ b/build/assets/js/4f2f3afd.c39cae88.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3554],{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 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,k=c["".concat(l,".").concat(u)]||c[u]||d[u]||r;return t?a.createElement(k,p(p({ref:n},m),{},{components:t})):a.createElement(k,p({ref:n},m))}));function k(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:()=>l,contentTitle:()=>p,default:()=>d,frontMatter:()=>r,metadata:()=>o,toc:()=>s});var a=t(7462),i=(t(7294),t(3905));const r={id:"openbim_components.Disposable",title:"Interface: Disposable",sidebar_label:"Disposable",custom_edit_url:null},p=void 0,o={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"}},l={},s=[{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}],m={toc:s},c="wrapper";function d(e){let{components:n,...t}=e;return(0,i.kt)(c,(0,a.Z)({},m,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Disposable"),(0,i.kt)("p",null,"Whether this component has to be manually destroyed once you are done with\nit to prevent\n",(0,i.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,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.Components"},(0,i.kt)("inlineCode",{parentName:"a"},"Components"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.CubeMap"},(0,i.kt)("inlineCode",{parentName:"a"},"CubeMap"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentBoundingBox"},(0,i.kt)("inlineCode",{parentName:"a"},"FragmentBoundingBox"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentIfcLoader"},(0,i.kt)("inlineCode",{parentName:"a"},"FragmentIfcLoader"))),(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.LocalCacher"},(0,i.kt)("inlineCode",{parentName:"a"},"LocalCacher"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.MaterialManager"},(0,i.kt)("inlineCode",{parentName:"a"},"MaterialManager"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Mouse"},(0,i.kt)("inlineCode",{parentName:"a"},"Mouse"))),(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.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.SimpleCamera"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleCamera"))),(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)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleGrid"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleGrid"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimplePlane"},(0,i.kt)("inlineCode",{parentName:"a"},"SimplePlane"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleRaycaster"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleRaycaster"))),(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)("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)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.ToolComponent"},(0,i.kt)("inlineCode",{parentName:"a"},"ToolComponent"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.UIManager"},(0,i.kt)("inlineCode",{parentName:"a"},"UIManager")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"dispose"},"dispose"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"dispose"),": () => ",(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"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Destroys the object from memory to prevent a\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#manual/en/introduction/How-to-dispose-of-objects"},"memory leak"),"."),(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"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L60"},"temp/components/src/base-types/base-types.ts:60")),(0,i.kt)("hr",null),(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"},"any"),">"),(0,i.kt)("p",null,"Fired after the tool has been ",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"()")),(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/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L63"},"temp/components/src/base-types/base-types.ts:63")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/51e85c26.2b35a114.js b/build/assets/js/51e85c26.2b35a114.js new file mode 100644 index 000000000..7eb6666b7 --- /dev/null +++ b/build/assets/js/51e85c26.2b35a114.js @@ -0,0 +1 @@ +"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:()=>s,contentTitle:()=>o,default:()=>c,frontMatter:()=>r,metadata:()=>p,toc:()=>l});var a=t(7462),i=(t(7294),t(3905));const r={id:"openbim_components.Components",title:"Class: Components",sidebar_label:"Components",custom_edit_url:null},o=void 0,p={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"}},s={},l=[{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}],m={toc:l},d="wrapper";function c(e){let{components:n,...t}=e;return(0,i.kt)(d,(0,a.Z)({},m,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Components"),(0,i.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,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Components#init"},"init"),"."),(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:"meshes"},"meshes"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"meshes"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Mesh"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"BufferGeometry"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"NormalBufferAttributes"),">",", ",(0,i.kt)("inlineCode",{parentName:"p"},"Material")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Material"),"[]",">","[] = ",(0,i.kt)("inlineCode",{parentName:"p"},"[]")),(0,i.kt)("p",null,"All the loaded ",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/objects/Mesh"},"meshes"),".\nThis includes fragments, 3D scans, etc."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/Components/index.ts#L29"},"temp/components/src/core/Components/index.ts:29")),(0,i.kt)("hr",null),(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"},"string"),">"),(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-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/Components/index.ts#L38"},"temp/components/src/core/Components/index.ts:38")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"oninitialized"},"onInitialized"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onInitialized"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Components"},(0,i.kt)("inlineCode",{parentName:"a"},"Components")),">"),(0,i.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,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/Components/index.ts#L35"},"temp/components/src/core/Components/index.ts:35")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"tools"},"tools"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"tools"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.ToolComponent"},(0,i.kt)("inlineCode",{parentName:"a"},"ToolComponent"))),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.ToolComponent"},"ToolComponent")),(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/IFCjs/components/blob/0c38d20/src/core/Components/index.ts#L23"},"temp/components/src/core/Components/index.ts:23")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"uienabled"},"uiEnabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"uiEnabled"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"true")),(0,i.kt)("p",null,"Whether UI components should be created."),(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/IFCjs/components/blob/0c38d20/src/core/Components/index.ts#L43"},"temp/components/src/core/Components/index.ts:43")),(0,i.kt)("h2",{id:"accessors"},"Accessors"),(0,i.kt)("h3",{id:"camera"},"camera"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"camera"),"(): ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Camera"),">"),(0,i.kt)("p",null,"The ",(0,i.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,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Camera"),">"),(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/IFCjs/components/blob/0c38d20/src/core/Components/index.ts#L101"},"temp/components/src/core/Components/index.ts:101")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"camera"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"camera"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"This needs to be initialized before calling init()."),(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"},"camera")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"Camera"),">")))),(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-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/Components/index.ts#L111"},"temp/components/src/core/Components/index.ts:111")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"raycaster"},"raycaster"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"raycaster"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"BaseRaycaster")),(0,i.kt)("p",null,"A component using the ",(0,i.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,i.kt)("h4",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"BaseRaycaster")),(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/IFCjs/components/blob/0c38d20/src/core/Components/index.ts#L119"},"temp/components/src/core/Components/index.ts:119")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"raycaster"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"raycaster"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.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,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)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"raycaster")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"BaseRaycaster"))))),(0,i.kt)("h4",{id:"returns-3"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(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/IFCjs/components/blob/0c38d20/src/core/Components/index.ts#L130"},"temp/components/src/core/Components/index.ts:130")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"renderer"},"renderer"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"renderer"),"(): ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},(0,i.kt)("inlineCode",{parentName:"a"},"BaseRenderer"))),(0,i.kt)("p",null,"The ",(0,i.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,i.kt)("h4",{id:"returns-4"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},(0,i.kt)("inlineCode",{parentName:"a"},"BaseRenderer"))),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/Components/index.ts#L65"},"temp/components/src/core/Components/index.ts:65")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"renderer"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"renderer"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"This needs to be initialized before calling init()."),(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"},"renderer")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.BaseRenderer"},(0,i.kt)("inlineCode",{parentName:"a"},"BaseRenderer")))))),(0,i.kt)("h4",{id:"returns-5"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/Components/index.ts#L75"},"temp/components/src/core/Components/index.ts:75")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"scene"},"scene"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"scene"),"(): ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Scene"),">"),(0,i.kt)("p",null,"The ",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/scenes/Scene"},"Three.js scene"),"\nwhere all the rendered items are placed."),(0,i.kt)("h4",{id:"returns-6"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Scene"),">"),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/Components/index.ts#L83"},"temp/components/src/core/Components/index.ts:83")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"scene"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"scene"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"This needs to be initialized before calling init()."),(0,i.kt)("h4",{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"},"scene")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"Scene"),">")))),(0,i.kt)("h4",{id:"returns-7"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/Components/index.ts#L93"},"temp/components/src/core/Components/index.ts:93")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ui"},"ui"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"ui"),"(): ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.UIManager"},(0,i.kt)("inlineCode",{parentName:"a"},"UIManager"))),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.UIManager"},"UIManager")),(0,i.kt)("h4",{id:"returns-8"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.UIManager"},(0,i.kt)("inlineCode",{parentName:"a"},"UIManager"))),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/Components/index.ts#L53"},"temp/components/src/core/Components/index.ts:53")),(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,"Disposes the memory of all the components and tools of this instance of\nthe library. A memory leak will be created if:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.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,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},"Any of the objects of this instance (meshes, geometries, etc) is\nreferenced by a reference type (object or array)."))),(0,i.kt)("p",null,"You can learn more about how Three.js handles memory leaks\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#manual/en/introduction/How-to-dispose-of-objects"},"here"),"."),(0,i.kt)("h4",{id:"returns-9"},"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-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/Components/index.ts#L172"},"temp/components/src/core/Components/index.ts:172")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"init"},"init"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"init"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.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,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Components#raycaster"},"raycaster")," will need to be initialized."),(0,i.kt)("h4",{id:"returns-10"},"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-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/Components/index.ts#L146"},"temp/components/src/core/Components/index.ts:146")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/51e85c26.e1035269.js b/build/assets/js/51e85c26.e1035269.js deleted file mode 100644 index f592c89ca..000000000 --- a/build/assets/js/51e85c26.e1035269.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4345],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>u});var a=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 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 o(e){for(var n=1;n=0||(r[t]=e[t]);return r}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}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,r=e.mdxType,i=e.originalType,l=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),m=s(t),k=r,u=m["".concat(l,".").concat(k)]||m[k]||c[k]||i;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,r=n&&n.mdxType;if("string"==typeof e||r){var i=t.length,o=new Array(i);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:r,o[1]=p;for(var s=2;s{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>c,frontMatter:()=>i,metadata:()=>p,toc:()=>s});var a=t(7462),r=(t(7294),t(3905));const i={id:"openbim_components.Components",title:"Class: Components",sidebar_label:"Components",custom_edit_url:null},o=void 0,p={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"}},l={},s=[{value:"Properties",id:"properties",level:2},{value:"meshes",id:"meshes",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"onInitialized",id:"oninitialized",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"tools",id:"tools",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"uiEnabled",id:"uienabled",level:3},{value:"Defined in",id:"defined-in-3",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-4",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"raycaster",id:"raycaster",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"renderer",id:"renderer",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"scene",id:"scene",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"ui",id:"ui",level:3},{value:"Returns",id:"returns-8",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:"Defined in",id:"defined-in-13",level:4},{value:"init",id:"init",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-14",level:4}],d={toc:s},m="wrapper";function c(e){let{components:n,...t}=e;return(0,r.kt)(m,(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"),".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:"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"},"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"},"[]")),(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/ifcjs/components/blob/e46138a/src/core/Components/index.ts#L29"},"src/core/Components/index.ts:29")),(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-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/Components/index.ts#L40"},"src/core/Components/index.ts:40")),(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-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/Components/index.ts#L98"},"src/core/Components/index.ts:98")),(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-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/Components/index.ts#L108"},"src/core/Components/index.ts:108")),(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-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/Components/index.ts#L116"},"src/core/Components/index.ts:116")),(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-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/Components/index.ts#L127"},"src/core/Components/index.ts:127")),(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-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/Components/index.ts#L62"},"src/core/Components/index.ts:62")),(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-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/Components/index.ts#L72"},"src/core/Components/index.ts:72")),(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-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/Components/index.ts#L80"},"src/core/Components/index.ts:80")),(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-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/Components/index.ts#L90"},"src/core/Components/index.ts:90")),(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-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/Components/index.ts#L50"},"src/core/Components/index.ts:50")),(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:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/Components/index.ts#L169"},"src/core/Components/index.ts:169")),(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-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/Components/index.ts#L143"},"src/core/Components/index.ts:143")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/55483fbd.a78ebd9c.js b/build/assets/js/55483fbd.a78ebd9c.js new file mode 100644 index 000000000..a9da0776d --- /dev/null +++ b/build/assets/js/55483fbd.a78ebd9c.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 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,k=d["".concat(r,".").concat(u)]||d[u]||c[u]||a;return t?i.createElement(k,o(o({ref:n},m),{},{components:t})):i.createElement(k,o({ref:n},m))}));function k(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:()=>r,contentTitle:()=>o,default:()=>c,frontMatter:()=>a,metadata:()=>l,toc:()=>s});var i=t(7462),p=(t(7294),t(3905));const a={id:"openbim_components.Simple2DScene",title:"Class: Simple2DScene",sidebar_label:"Simple2DScene",custom_edit_url:null},o=void 0,l={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"}},r={},s=[{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}],m={toc:s},d="wrapper";function c(e){let{components:n,...t}=e;return(0,p.kt)(d,(0,i.Z)({},m,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/IFCjs/components/blob/0c38d20/src/core/Simple2DScene/index.ts#L55"},"temp/components/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)("strong",{parentName:"p"},"controls"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"OrbitControls")),(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/IFCjs/components/blob/0c38d20/src/core/Simple2DScene/index.ts#L52"},"temp/components/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/IFCjs/components/blob/0c38d20/src/core/Simple2DScene/index.ts#L41"},"temp/components/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/IFCjs/components/blob/0c38d20/src/core/Simple2DScene/index.ts#L32"},"temp/components/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/IFCjs/components/blob/0c38d20/src/core/Simple2DScene/index.ts#L35"},"temp/components/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/IFCjs/components/blob/0c38d20/src/core/Simple2DScene/index.ts#L44"},"temp/components/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/IFCjs/components/blob/0c38d20/src/core/Simple2DScene/index.ts#L38"},"temp/components/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/IFCjs/components/blob/0c38d20/src/core/Simple2DScene/index.ts#L47"},"temp/components/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/IFCjs/components/blob/0c38d20/src/core/Simple2DScene/index.ts#L150"},"temp/components/src/core/Simple2DScene/index.ts:150")),(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)("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)("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/IFCjs/components/blob/0c38d20/src/core/Simple2DScene/index.ts#L145"},"temp/components/src/core/Simple2DScene/index.ts:145")),(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/IFCjs/components/blob/0c38d20/src/core/Simple2DScene/index.ts#L173"},"temp/components/src/core/Simple2DScene/index.ts:173")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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-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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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-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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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-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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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-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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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-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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/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-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/IFCjs/components/blob/0c38d20/src/core/Simple2DScene/index.ts#L184"},"temp/components/src/core/Simple2DScene/index.ts:184")),(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/IFCjs/components/blob/0c38d20/src/core/Simple2DScene/index.ts#L165"},"temp/components/src/core/Simple2DScene/index.ts:165")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/55483fbd.fb409497.js b/build/assets/js/55483fbd.fb409497.js deleted file mode 100644 index 7d853932a..000000000 --- a/build/assets/js/55483fbd.fb409497.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 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,f=d["".concat(r,".").concat(u)]||d[u]||c[u]||p;return t?i.createElement(f,l(l({ref:n},m),{},{components:t})):i.createElement(f,l({ref:n},m))}));function f(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:()=>r,contentTitle:()=>l,default:()=>c,frontMatter:()=>p,metadata:()=>o,toc:()=>s});var i=t(7462),a=(t(7294),t(3905));const p={id:"openbim_components.Simple2DScene",title:"Class: Simple2DScene",sidebar_label:"Simple2DScene",custom_edit_url:null},l=void 0,o={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"}},r={},s=[{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:"onResize",id:"onresize",level:3},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"uiElement",id:"uielement",level:3},{value:"Implementation of",id:"implementation-of-3",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",level:4},{value:"Implementation of",id:"implementation-of-4",level:4},{value:"Defined in",id:"defined-in-7",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-8",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:"Defined in",id:"defined-in-9",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-10",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-11",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-12",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-13",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-14",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-15",level:4},{value:"resize",id:"resize",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Implementation of",id:"implementation-of-6",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"update",id:"update",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Implementation of",id:"implementation-of-7",level:4},{value:"Defined in",id:"defined-in-17",level:4}],m={toc:s},d="wrapper";function c(e){let{components:n,...t}=e;return(0,a.kt)(d,(0,i.Z)({},m,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/ifcjs/components/blob/e46138a/src/core/Simple2DScene/index.ts#L52"},"src/core/Simple2DScene/index.ts:52")),(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/ifcjs/components/blob/e46138a/src/core/Simple2DScene/index.ts#L49"},"src/core/Simple2DScene/index.ts:49")),(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/ifcjs/components/blob/e46138a/src/core/Simple2DScene/index.ts#L41"},"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/ifcjs/components/blob/e46138a/src/core/Simple2DScene/index.ts#L32"},"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/ifcjs/components/blob/e46138a/src/core/Simple2DScene/index.ts#L35"},"src/core/Simple2DScene/index.ts:35")),(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-2"},"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-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/Simple2DScene/index.ts#L38"},"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-3"},"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-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/Simple2DScene/index.ts#L44"},"src/core/Simple2DScene/index.ts:44")),(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-4"},"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-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/Simple2DScene/index.ts#L147"},"src/core/Simple2DScene/index.ts:147")),(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)("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)("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-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/Simple2DScene/index.ts#L142"},"src/core/Simple2DScene/index.ts:142")),(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-5"},"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-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/Simple2DScene/index.ts#L168"},"src/core/Simple2DScene/index.ts:168")),(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-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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"},"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-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#resize"},"resize")),(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/ifcjs/components/blob/e46138a/src/core/Simple2DScene/index.ts#L179"},"src/core/Simple2DScene/index.ts:179")),(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-7"},"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-17"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/Simple2DScene/index.ts#L160"},"src/core/Simple2DScene/index.ts:160")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/59791038.5b0ebb80.js b/build/assets/js/59791038.5b0ebb80.js deleted file mode 100644 index 4ff04ac06..000000000 --- a/build/assets/js/59791038.5b0ebb80.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2218],{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 o(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 l=i.createContext({}),p=function(e){var t=i.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=p(e.components);return i.createElement(l.Provider,{value:t},e.children)},m="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,l=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),m=p(n),c=a,h=m["".concat(l,".").concat(c)]||m[c]||u[c]||r;return n?i.createElement(h,o(o({ref:t},d),{},{components:n})):i.createElement(h,o({ref:t},d))}));function h(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,o=new Array(r);o[0]=c;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[m]="string"==typeof e?e:a,o[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>p});var i=n(7462),a=(n(7294),n(3905));const r={id:"openbim_components.CloudStorage",title:"Class: CloudStorage",sidebar_label:"CloudStorage",custom_edit_url:null},o=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"}},l={},p=[{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}],d={toc:p},m="wrapper";function u(e){let{components:t,...n}=e;return(0,a.kt)(m,(0,i.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"),".CloudStorage"),(0,a.kt)("p",null,"An object to easily use the services of That Open Platform."),(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"},"any"),"[]",">"),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"CloudStorage"))))),(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/ifcjs/components/blob/e46138a/src/services/CloudStorage/index.ts#L18"},"src/services/CloudStorage/index.ts:18")),(0,a.kt)("hr",null),(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"},'"CloudProcessor"')),(0,a.kt)("p",null,"Component.name"),(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/ifcjs/components/blob/e46138a/src/services/CloudStorage/index.ts#L15"},"src/services/CloudStorage/index.ts:15")),(0,a.kt)("h2",{id:"accessors"},"Accessors"),(0,a.kt)("h3",{id:"token"},"token"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"token"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The authentication token generated in\n",(0,a.kt)("a",{parentName:"p",href:"https://platform.thatopen.com/app"},"That Open Platform")),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(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/ifcjs/components/blob/e46138a/src/services/CloudStorage/index.ts#L50"},"src/services/CloudStorage/index.ts:50")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"token"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"The authentication token generated in\n",(0,a.kt)("a",{parentName:"p",href:"https://platform.thatopen.com/app"},"That Open Platform")),(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"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(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:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/services/CloudStorage/index.ts#L61"},"src/services/CloudStorage/index.ts:61")),(0,a.kt)("h2",{id:"methods"},"Methods"),(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"},"any"),"[]"),(0,a.kt)("p",null,"Retrieves a tool component by its name."),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any"),"[]"),(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/ifcjs/components/blob/e46138a/src/services/CloudStorage/index.ts#L42"},"src/services/CloudStorage/index.ts:42")),(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-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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/ifcjs/components/blob/e46138a/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-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/ifcjs/components/blob/e46138a/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-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/ifcjs/components/blob/e46138a/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-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/ifcjs/components/blob/e46138a/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-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/ifcjs/components/blob/e46138a/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/59791038.aa879011.js b/build/assets/js/59791038.aa879011.js new file mode 100644 index 000000000..babbb825e --- /dev/null +++ b/build/assets/js/59791038.aa879011.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2218],{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 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 r(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 p=i.createContext({}),l=function(e){var t=i.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},d=function(e){var t=l(e.components);return i.createElement(p.Provider,{value:t},e.children)},m="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,o=e.originalType,p=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),m=l(n),c=a,h=m["".concat(p,".").concat(c)]||m[c]||u[c]||o;return n?i.createElement(h,r(r({ref:t},d),{},{components:n})):i.createElement(h,r({ref:t},d))}));function h(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,r=new Array(o);r[0]=c;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[m]="string"==typeof e?e:a,r[1]=s;for(var l=2;l{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var i=n(7462),a=(n(7294),n(3905));const o={id:"openbim_components.CloudStorage",title:"Class: CloudStorage",sidebar_label:"CloudStorage",custom_edit_url:null},r=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"}},p={},l=[{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}],d={toc:l},m="wrapper";function u(e){let{components:t,...n}=e;return(0,a.kt)(m,(0,i.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"),".CloudStorage"),(0,a.kt)("p",null,"An object to easily use the services of That Open Platform."),(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"},"any"),"[]",">"),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"CloudStorage"))))),(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/IFCjs/components/blob/0c38d20/src/services/CloudStorage/index.ts#L18"},"temp/components/src/services/CloudStorage/index.ts:18")),(0,a.kt)("hr",null),(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"},'"CloudProcessor"')),(0,a.kt)("p",null,"Component.name"),(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/IFCjs/components/blob/0c38d20/src/services/CloudStorage/index.ts#L15"},"temp/components/src/services/CloudStorage/index.ts:15")),(0,a.kt)("h2",{id:"accessors"},"Accessors"),(0,a.kt)("h3",{id:"token"},"token"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"token"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The authentication token generated in\n",(0,a.kt)("a",{parentName:"p",href:"https://platform.thatopen.com/app"},"That Open Platform")),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(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/IFCjs/components/blob/0c38d20/src/services/CloudStorage/index.ts#L50"},"temp/components/src/services/CloudStorage/index.ts:50")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"token"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"The authentication token generated in\n",(0,a.kt)("a",{parentName:"p",href:"https://platform.thatopen.com/app"},"That Open Platform")),(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"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(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:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/services/CloudStorage/index.ts#L61"},"temp/components/src/services/CloudStorage/index.ts:61")),(0,a.kt)("h2",{id:"methods"},"Methods"),(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"},"any"),"[]"),(0,a.kt)("p",null,"Retrieves a tool component by its name."),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any"),"[]"),(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/IFCjs/components/blob/0c38d20/src/services/CloudStorage/index.ts#L42"},"temp/components/src/services/CloudStorage/index.ts:42")),(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-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/src/base-types/component.ts:45")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/5c34dd2a.118d4eb5.js b/build/assets/js/5c34dd2a.118d4eb5.js new file mode 100644 index 000000000..07db4bb58 --- /dev/null +++ b/build/assets/js/5c34dd2a.118d4eb5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5531],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>k});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,k=m["".concat(o,".").concat(u)]||m[u]||c[u]||p;return t?i.createElement(k,a(a({ref:n},d),{},{components:t})):i.createElement(k,a({ref:n},d))}));function k(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:()=>o,contentTitle:()=>a,default:()=>c,frontMatter:()=>p,metadata:()=>l,toc:()=>s});var i=t(7462),r=(t(7294),t(3905));const p={id:"openbim_components.PostproductionRenderer",title:"Class: PostproductionRenderer",sidebar_label:"PostproductionRenderer",custom_edit_url:null},a=void 0,l={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:"ScreenCuller",permalink:"/api/classes/openbim_components.ScreenCuller"}},o={},s=[{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}],d={toc:s},m="wrapper";function c(e){let{components:n,...t}=e;return(0,r.kt)(m,(0,i.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"),".PostproductionRenderer"),(0,r.kt)("p",null,"Renderer that uses efficient postproduction effects (e.g. Ambient Occlusion)."),(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.SimpleRenderer"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleRenderer"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"PostproductionRenderer"))))),(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:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#clippingplanes"},"clippingPlanes")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/base-renderer.ts#L33"},"temp/components/src/base-types/base-renderer.ts:33")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"container"},"container"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"container"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"HTMLElement")),(0,r.kt)("p",null,"The HTML container of the THREE.js canvas where the scene is rendered."),(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.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#container"},"container")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleRenderer/index.ts#L26"},"temp/components/src/core/SimpleRenderer/index.ts:26")),(0,r.kt)("hr",null),(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:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#enabled"},"enabled")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleRenderer/index.ts#L23"},"temp/components/src/core/SimpleRenderer/index.ts:23")),(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.SimpleRenderer"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleRenderer")),">"),(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-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#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/IFCjs/components/blob/0c38d20/src/core/SimpleRenderer/index.ts#L35"},"temp/components/src/core/SimpleRenderer/index.ts:35")),(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.SimpleRenderer"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleRenderer")),">"),(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-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#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/IFCjs/components/blob/0c38d20/src/core/SimpleRenderer/index.ts#L32"},"temp/components/src/core/SimpleRenderer/index.ts:32")),(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:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#onclippingplanesupdated"},"onClippingPlanesUpdated")),(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/IFCjs/components/blob/0c38d20/src/base-types/base-renderer.ts#L27"},"temp/components/src/base-types/base-renderer.ts:27")),(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:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#ondisposed"},"onDisposed")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleRenderer/index.ts#L29"},"temp/components/src/core/SimpleRenderer/index.ts:29")),(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:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#onresize"},"onResize")),(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/IFCjs/components/blob/0c38d20/src/base-types/base-renderer.ts#L21"},"temp/components/src/base-types/base-renderer.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"postproduction"},"postproduction"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"postproduction"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Postproduction")),(0,r.kt)("p",null,"Helper object to handle the postproduction effects applied."),(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/IFCjs/components/blob/0c38d20/src/navigation/PostproductionRenderer/index.ts#L11"},"temp/components/src/navigation/PostproductionRenderer/index.ts:11")),(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"},"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.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#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/IFCjs/components/blob/0c38d20/src/navigation/PostproductionRenderer/index.ts#L41"},"temp/components/src/navigation/PostproductionRenderer/index.ts:41")),(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"},"WebGLRenderer")),(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-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"WebGLRenderer")),(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.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#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/IFCjs/components/blob/0c38d20/src/core/SimpleRenderer/index.ts#L75"},"temp/components/src/core/SimpleRenderer/index.ts:75")),(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-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Vector2")),(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.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#getsize"},"getSize")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleRenderer/index.ts#L106"},"temp/components/src/core/SimpleRenderer/index.ts:106")),(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-10"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#hasui"},"hasUI")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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-11"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#isconfigurable"},"isConfigurable")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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-12"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#isdisposeable"},"isDisposeable")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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-13"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#ishideable"},"isHideable")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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-14"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#isresizeable"},"isResizeable")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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-15"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#isupdateable"},"isUpdateable")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/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"},"size?"),"): ",(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:"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"},"size?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Vector2"))))),(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:"inherited-from-16"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#resize"},"resize")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleRenderer/index.ts#L114"},"temp/components/src/core/SimpleRenderer/index.ts:114")),(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-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#toggleplane"},"togglePlane")),(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/IFCjs/components/blob/0c38d20/src/base-types/base-renderer.ts#L48"},"temp/components/src/base-types/base-renderer.ts:48")),(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"},"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:"returns-11"},"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-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#update"},"update")),(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/IFCjs/components/blob/0c38d20/src/navigation/PostproductionRenderer/index.ts#L25"},"temp/components/src/navigation/PostproductionRenderer/index.ts:25")),(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-12"},"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-18"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#updateclippingplanes"},"updateClippingPlanes")),(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/IFCjs/components/blob/0c38d20/src/base-types/base-renderer.ts#L39"},"temp/components/src/base-types/base-renderer.ts:39")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/5c34dd2a.9e9339f0.js b/build/assets/js/5c34dd2a.9e9339f0.js deleted file mode 100644 index 3ef514b27..000000000 --- a/build/assets/js/5c34dd2a.9e9339f0.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5531],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>k});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 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",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,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),m=o(t),u=r,k=m["".concat(s,".").concat(u)]||m[u]||c[u]||a;return t?i.createElement(k,p(p({ref:n},d),{},{components:t})):i.createElement(k,p({ref:n},d))}));function k(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 s in n)hasOwnProperty.call(n,s)&&(l[s]=n[s]);l.originalType=e,l[m]="string"==typeof e?e:r,p[1]=l;for(var o=2;o{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>a,metadata:()=>l,toc:()=>o});var i=t(7462),r=(t(7294),t(3905));const a={id:"openbim_components.PostproductionRenderer",title:"Class: PostproductionRenderer",sidebar_label:"PostproductionRenderer",custom_edit_url:null},p=void 0,l={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:"ScreenCuller",permalink:"/api/classes/openbim_components.ScreenCuller"}},s={},o=[{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:"onResize",id:"onresize",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"postproduction",id:"postproduction",level:3},{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:"Overrides",id:"overrides",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:"Inherited from",id:"inherited-from-7",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:"Inherited from",id:"inherited-from-8",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-9",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-10",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-11",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-12",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-13",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-14",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:"Inherited from",id:"inherited-from-15",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-16",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:"Overrides",id:"overrides-1",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-17",level:4},{value:"Defined in",id:"defined-in-20",level:4}],d={toc:o},m="wrapper";function c(e){let{components:n,...t}=e;return(0,r.kt)(m,(0,i.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"),".PostproductionRenderer"),(0,r.kt)("p",null,"Renderer that uses efficient postproduction effects (e.g. Ambient Occlusion)."),(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.SimpleRenderer"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleRenderer"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"PostproductionRenderer"))))),(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:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#clippingplanes"},"clippingPlanes")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/base-renderer.ts#L33"},"src/base-types/base-renderer.ts:33")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"container"},"container"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"container"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"HTMLElement")),(0,r.kt)("p",null,"The HTML container of the THREE.js canvas where the scene is rendered."),(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.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#container"},"container")),(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/ifcjs/components/blob/e46138a/src/core/SimpleRenderer/index.ts#L26"},"src/core/SimpleRenderer/index.ts:26")),(0,r.kt)("hr",null),(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:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#enabled"},"enabled")),(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/ifcjs/components/blob/e46138a/src/core/SimpleRenderer/index.ts#L23"},"src/core/SimpleRenderer/index.ts:23")),(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.SimpleRenderer"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleRenderer")),">"),(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-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#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/ifcjs/components/blob/e46138a/src/core/SimpleRenderer/index.ts#L32"},"src/core/SimpleRenderer/index.ts:32")),(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.SimpleRenderer"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleRenderer")),">"),(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-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#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/ifcjs/components/blob/e46138a/src/core/SimpleRenderer/index.ts#L29"},"src/core/SimpleRenderer/index.ts:29")),(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:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#onclippingplanesupdated"},"onClippingPlanesUpdated")),(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/ifcjs/components/blob/e46138a/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:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#onresize"},"onResize")),(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/ifcjs/components/blob/e46138a/src/base-types/base-renderer.ts#L21"},"src/base-types/base-renderer.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"postproduction"},"postproduction"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"postproduction"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Postproduction")),(0,r.kt)("p",null,"Helper object to handle the postproduction effects applied."),(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/ifcjs/components/blob/e46138a/src/navigation/PostproductionRenderer/index.ts#L11"},"src/navigation/PostproductionRenderer/index.ts:11")),(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"},"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.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#dispose"},"dispose")),(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/ifcjs/components/blob/e46138a/src/navigation/PostproductionRenderer/index.ts#L41"},"src/navigation/PostproductionRenderer/index.ts:41")),(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"},"WebGLRenderer")),(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-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"WebGLRenderer")),(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.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#get"},"get")),(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/ifcjs/components/blob/e46138a/src/core/SimpleRenderer/index.ts#L72"},"src/core/SimpleRenderer/index.ts:72")),(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-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Vector2")),(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.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#getsize"},"getSize")),(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/ifcjs/components/blob/e46138a/src/core/SimpleRenderer/index.ts#L101"},"src/core/SimpleRenderer/index.ts:101")),(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-9"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#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/ifcjs/components/blob/e46138a/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-10"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#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/ifcjs/components/blob/e46138a/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-11"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#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/ifcjs/components/blob/e46138a/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-12"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#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/ifcjs/components/blob/e46138a/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-13"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#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/ifcjs/components/blob/e46138a/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-14"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#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/ifcjs/components/blob/e46138a/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"},"size?"),"): ",(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:"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"},"size?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Vector2"))))),(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:"inherited-from-15"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#resize"},"resize")),(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/ifcjs/components/blob/e46138a/src/core/SimpleRenderer/index.ts#L109"},"src/core/SimpleRenderer/index.ts:109")),(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-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#toggleplane"},"togglePlane")),(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/ifcjs/components/blob/e46138a/src/base-types/base-renderer.ts#L48"},"src/base-types/base-renderer.ts:48")),(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"},"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:"returns-11"},"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-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#update"},"update")),(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/ifcjs/components/blob/e46138a/src/navigation/PostproductionRenderer/index.ts#L25"},"src/navigation/PostproductionRenderer/index.ts:25")),(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-12"},"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-17"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer"),".",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer#updateclippingplanes"},"updateClippingPlanes")),(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/ifcjs/components/blob/e46138a/src/base-types/base-renderer.ts#L39"},"src/base-types/base-renderer.ts:39")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/5f173d68.14cb2c2a.js b/build/assets/js/5f173d68.14cb2c2a.js new file mode 100644 index 000000000..8548f224b --- /dev/null +++ b/build/assets/js/5f173d68.14cb2c2a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8440],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>k});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 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",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,l=e.parentName,m=s(e,["components","mdxType","originalType","parentName"]),d=r(t),u=p,k=d["".concat(l,".").concat(u)]||d[u]||c[u]||a;return t?i.createElement(k,o(o({ref:n},m),{},{components:t})):i.createElement(k,o({ref:n},m))}));function k(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 s={};for(var l in n)hasOwnProperty.call(n,l)&&(s[l]=n[l]);s.originalType=e,s[d]="string"==typeof e?e:p,o[1]=s;for(var r=2;r{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>c,frontMatter:()=>a,metadata:()=>s,toc:()=>r});var i=t(7462),p=(t(7294),t(3905));const a={id:"openbim_components.SimpleScene",title:"Class: SimpleScene",sidebar_label:"SimpleScene",custom_edit_url:null},o=void 0,s={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"}},l={},r=[{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:"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-3",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-4",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-5",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-6",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-7",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-8",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-9",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-2",level:4},{value:"Defined in",id:"defined-in-10",level:4}],m={toc:r},d="wrapper";function c(e){let{components:n,...t}=e;return(0,p.kt)(d,(0,i.Z)({},m,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/IFCjs/components/blob/0c38d20/src/core/SimpleScene/index.ts#L28"},"temp/components/src/core/SimpleScene/index.ts:28")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleScene/index.ts#L31"},"temp/components/src/core/SimpleScene/index.ts:31")),(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-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#dispose"},"dispose")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleScene/index.ts#L47"},"temp/components/src/core/SimpleScene/index.ts:47")),(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-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleScene/index.ts#L42"},"temp/components/src/core/SimpleScene/index.ts:42")),(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-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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-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-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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-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-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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-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-7"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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-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-8"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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-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-9"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/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-2"},"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-10"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleScene/index.ts#L74"},"temp/components/src/core/SimpleScene/index.ts:74")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/5f173d68.688c6051.js b/build/assets/js/5f173d68.688c6051.js deleted file mode 100644 index 0f13cf203..000000000 --- a/build/assets/js/5f173d68.688c6051.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 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 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},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=r(e,["components","mdxType","originalType","parentName"]),d=s(t),u=a,f=d["".concat(o,".").concat(u)]||d[u]||c[u]||p;return t?i.createElement(f,l(l({ref:n},m),{},{components:t})):i.createElement(f,l({ref:n},m))}));function f(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 o in n)hasOwnProperty.call(n,o)&&(r[o]=n[o]);r.originalType=e,r[d]="string"==typeof e?e:a,l[1]=r;for(var s=2;s{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>l,default:()=>c,frontMatter:()=>p,metadata:()=>r,toc:()=>s});var i=t(7462),a=(t(7294),t(3905));const p={id:"openbim_components.SimpleScene",title:"Class: SimpleScene",sidebar_label:"SimpleScene",custom_edit_url:null},l=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"}},o={},s=[{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:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",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-2",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-3",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-4",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-5",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-6",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-7",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-8",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-1",level:4},{value:"Defined in",id:"defined-in-9",level:4}],m={toc:s},d="wrapper";function c(e){let{components:n,...t}=e;return(0,a.kt)(d,(0,i.Z)({},m,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/ifcjs/components/blob/e46138a/src/core/SimpleScene/index.ts#L28"},"src/core/SimpleScene/index.ts:28")),(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"},"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-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleScene/index.ts#L44"},"src/core/SimpleScene/index.ts:44")),(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-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleScene/index.ts#L39"},"src/core/SimpleScene/index.ts:39")),(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-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L45"},"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-1"},"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-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleScene/index.ts#L69"},"src/core/SimpleScene/index.ts:69")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/6713fb58.15dfd3d4.js b/build/assets/js/6713fb58.c00861dc.js similarity index 52% rename from build/assets/js/6713fb58.15dfd3d4.js rename to build/assets/js/6713fb58.c00861dc.js index b10725e2a..1c019aa01 100644 --- a/build/assets/js/6713fb58.15dfd3d4.js +++ b/build/assets/js/6713fb58.c00861dc.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:()=>l,contentTitle:()=>o,default:()=>m,frontMatter:()=>r,metadata:()=>p,toc:()=>d});var a=n(7462),i=(n(7294),n(3905));const r={id:"openbim_components.NavigationMode",title:"Interface: NavigationMode",sidebar_label:"NavigationMode",custom_edit_url:null},o=void 0,p={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"}},l={},d=[{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}],s={toc:d},c="wrapper";function m(e){let{components:t,...n}=e;return(0,i.kt)(c,(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".NavigationMode"),(0,i.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,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"enabled"},"enabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"enabled"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Whether this navigation mode is active or not."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/navigation/OrthoPerspectiveCamera/src/types.ts#L33"},"src/navigation/OrthoPerspectiveCamera/src/types.ts:33")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#navmodeid"},(0,i.kt)("inlineCode",{parentName:"a"},"NavModeID"))),(0,i.kt)("p",null,"The unique ID of this navigation mode."),(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/ifcjs/components/blob/e46138a/src/navigation/OrthoPerspectiveCamera/src/types.ts#L20"},"src/navigation/OrthoPerspectiveCamera/src/types.ts:20")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"projectionchanged"},"projectionChanged"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"projectionChanged"),": ",(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"},"Camera"),">"),(0,i.kt)("p",null,"Event that should fire when the camera ",(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection")," changes."),(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/ifcjs/components/blob/e46138a/src/navigation/OrthoPerspectiveCamera/src/types.ts#L38"},"src/navigation/OrthoPerspectiveCamera/src/types.ts:38")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"toggle"},"toggle"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"toggle"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"active"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"options?"),": ",(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"},"active"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Enable or disable this navigation mode.\nWhen a new navigation mode is enabled, the previous navigation mode\nmust be disabled."),(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)("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"},"active")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean")),(0,i.kt)("td",{parentName:"tr",align:"left"},"whether to enable or disable this mode.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any")),(0,i.kt)("td",{parentName:"tr",align:"left"},"any additional data required to enable or disable it.")))),(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-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/navigation/OrthoPerspectiveCamera/src/types.ts#L30"},"src/navigation/OrthoPerspectiveCamera/src/types.ts:30")))}m.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:()=>l,contentTitle:()=>o,default:()=>m,frontMatter:()=>r,metadata:()=>p,toc:()=>d});var a=n(7462),i=(n(7294),n(3905));const r={id:"openbim_components.NavigationMode",title:"Interface: NavigationMode",sidebar_label:"NavigationMode",custom_edit_url:null},o=void 0,p={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"}},l={},d=[{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}],s={toc:d},c="wrapper";function m(e){let{components:t,...n}=e;return(0,i.kt)(c,(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".NavigationMode"),(0,i.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,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"enabled"},"enabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"enabled"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Whether this navigation mode is active or not."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/navigation/OrthoPerspectiveCamera/src/types.ts#L33"},"temp/components/src/navigation/OrthoPerspectiveCamera/src/types.ts:33")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#navmodeid"},(0,i.kt)("inlineCode",{parentName:"a"},"NavModeID"))),(0,i.kt)("p",null,"The unique ID of this navigation mode."),(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/IFCjs/components/blob/0c38d20/src/navigation/OrthoPerspectiveCamera/src/types.ts#L20"},"temp/components/src/navigation/OrthoPerspectiveCamera/src/types.ts:20")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"projectionchanged"},"projectionChanged"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"projectionChanged"),": ",(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"},"Camera"),">"),(0,i.kt)("p",null,"Event that should fire when the camera ",(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection")," changes."),(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/IFCjs/components/blob/0c38d20/src/navigation/OrthoPerspectiveCamera/src/types.ts#L38"},"temp/components/src/navigation/OrthoPerspectiveCamera/src/types.ts:38")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"toggle"},"toggle"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"toggle"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"active"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"options?"),": ",(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"},"active"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Enable or disable this navigation mode.\nWhen a new navigation mode is enabled, the previous navigation mode\nmust be disabled."),(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)("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"},"active")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean")),(0,i.kt)("td",{parentName:"tr",align:"left"},"whether to enable or disable this mode.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any")),(0,i.kt)("td",{parentName:"tr",align:"left"},"any additional data required to enable or disable it.")))),(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-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/navigation/OrthoPerspectiveCamera/src/types.ts#L30"},"temp/components/src/navigation/OrthoPerspectiveCamera/src/types.ts:30")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/746f2b6a.5560ea57.js b/build/assets/js/746f2b6a.5560ea57.js new file mode 100644 index 000000000..75d3fd779 --- /dev/null +++ b/build/assets/js/746f2b6a.5560ea57.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",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,p=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),m=o(t),k=i,u=m["".concat(s,".").concat(k)]||m[k]||c[k]||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]=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:i,r[1]=l;for(var o=2;o{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>r,default:()=>c,frontMatter:()=>p,metadata:()=>l,toc:()=>o});var a=t(7462),i=(t(7294),t(3905));const p={id:"openbim_components.SimpleRenderer",title:"Class: SimpleRenderer",sidebar_label:"SimpleRenderer",custom_edit_url:null},r=void 0,l={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"}},s={},o=[{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}],d={toc:o},m="wrapper";function c(e){let{components:n,...t}=e;return(0,i.kt)(m,(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"),".SimpleRenderer"),(0,i.kt)("p",null,"A basic renderer capable of rendering 3D and 2D objects\n(",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/core/Object3D"},"Objec3Ds")," and\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#examples/en/renderers/CSS2DRenderer"},"CSS2DObjects"),"\nrespectively)."),(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)("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)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"SimpleRenderer"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.PostproductionRenderer"},(0,i.kt)("inlineCode",{parentName:"a"},"PostproductionRenderer"))))),(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)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Updateable"},(0,i.kt)("inlineCode",{parentName:"a"},"Updateable"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Resizeable"},(0,i.kt)("inlineCode",{parentName:"a"},"Resizeable")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"clippingplanes"},"clippingPlanes"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"clippingPlanes"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Plane"),"[] = ",(0,i.kt)("inlineCode",{parentName:"p"},"[]")),(0,i.kt)("p",null,"The list of ",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer.clippingPlanes"},"clipping planes")," used by this\ninstance of the renderer."),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#clippingplanes"},"clippingPlanes")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/base-renderer.ts#L33"},"temp/components/src/base-types/base-renderer.ts:33")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"container"},"container"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"container"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"HTMLElement")),(0,i.kt)("p",null,"The HTML container of the THREE.js canvas where the scene is rendered."),(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/IFCjs/components/blob/0c38d20/src/core/SimpleRenderer/index.ts#L26"},"temp/components/src/core/SimpleRenderer/index.ts:26")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"enabled"},"enabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"enabled"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"true")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#enabled"},"enabled")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleRenderer/index.ts#L23"},"temp/components/src/core/SimpleRenderer/index.ts:23")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleRenderer")),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"Updateable.onAfterUpdate")),(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.Updateable"},"Updateable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"onAfterUpdate")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleRenderer/index.ts#L35"},"temp/components/src/core/SimpleRenderer/index.ts:35")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleRenderer")),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"Updateable.onBeforeUpdate")),(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.Updateable"},"Updateable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"onBeforeUpdate")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleRenderer/index.ts#L32"},"temp/components/src/core/SimpleRenderer/index.ts:32")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onclippingplanesupdated"},"onClippingPlanesUpdated"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onClippingPlanesUpdated"),": ",(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"},"unknown"),">"),(0,i.kt)("p",null,"Event that fires when there has been a change to the list of clipping\nplanes used by the active renderer."),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#onclippingplanesupdated"},"onClippingPlanesUpdated")),(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/IFCjs/components/blob/0c38d20/src/base-types/base-renderer.ts#L27"},"temp/components/src/base-types/base-renderer.ts:27")),(0,i.kt)("hr",null),(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-2"},"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-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleRenderer/index.ts#L29"},"temp/components/src/core/SimpleRenderer/index.ts:29")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onresize"},"onResize"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(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"},"any"),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#onresize"},"Resizeable.onResize")),(0,i.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#onresize"},"onResize")),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#onresize"},"onResize")),(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/IFCjs/components/blob/0c38d20/src/base-types/base-renderer.ts#L21"},"temp/components/src/base-types/base-renderer.ts:21")),(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"},"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-4"},"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-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleRenderer/index.ts#L92"},"temp/components/src/core/SimpleRenderer/index.ts:92")),(0,i.kt)("hr",null),(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"},"WebGLRenderer")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"WebGLRenderer")),(0,i.kt)("h4",{id:"overrides-1"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#get"},"get")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleRenderer/index.ts#L75"},"temp/components/src/core/SimpleRenderer/index.ts:75")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getsize"},"getSize"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"getSize"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#getsize"},"Resizeable.getSize"),"."),(0,i.kt)("h4",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,i.kt)("h4",{id:"implementation-of-5"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#getsize"},"getSize")),(0,i.kt)("h4",{id:"overrides-2"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#getsize"},"getSize")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleRenderer/index.ts#L106"},"temp/components/src/core/SimpleRenderer/index.ts:106")),(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-3"},"Returns"),(0,i.kt)("p",null,"this is UI"),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#hasui"},"hasUI")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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-4"},"Returns"),(0,i.kt)("p",null,"this is Configurable"),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#isconfigurable"},"isConfigurable")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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-5"},"Returns"),(0,i.kt)("p",null,"this is Disposable"),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#isdisposeable"},"isDisposeable")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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-6"},"Returns"),(0,i.kt)("p",null,"this is Hideable"),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#ishideable"},"isHideable")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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-7"},"Returns"),(0,i.kt)("p",null,"this is Resizeable"),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#isresizeable"},"isResizeable")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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-8"},"Returns"),(0,i.kt)("p",null,"this is Updateable"),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#isupdateable"},"isUpdateable")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/src/base-types/component.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"resize"},"resize"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"resize"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"size?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#resize"},"Resizeable.resize"),"."),(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"},"size?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Vector2"))))),(0,i.kt)("h4",{id:"returns-9"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"implementation-of-6"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#resize"},"resize")),(0,i.kt)("h4",{id:"overrides-3"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#resize"},"resize")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleRenderer/index.ts#L114"},"temp/components/src/core/SimpleRenderer/index.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"toggleplane"},"togglePlane"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"togglePlane"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"active"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"plane"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"isLocal?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Adds or removes a\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer.clippingPlanes"},"clipping plane"),"\nto the renderer."),(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)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"active")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"plane")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Plane"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"isLocal?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,i.kt)("h4",{id:"returns-10"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#toggleplane"},"togglePlane")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/base-renderer.ts#L48"},"temp/components/src/base-types/base-renderer.ts:48")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"update"},"update"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"update"),"(): ",(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.Updateable#update"},"Updateable.update")),(0,i.kt)("h4",{id:"returns-11"},"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-7"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"update")),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleRenderer/index.ts#L80"},"temp/components/src/core/SimpleRenderer/index.ts:80")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"updateclippingplanes"},"updateClippingPlanes"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"updateClippingPlanes"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Forces the update of the clipping planes and all components that depend\non them that are subscribed to ",(0,i.kt)("inlineCode",{parentName:"p"},"onClippingPlanesUpdated"),"."),(0,i.kt)("h4",{id:"returns-12"},"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:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#updateclippingplanes"},"updateClippingPlanes")),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/base-renderer.ts#L39"},"temp/components/src/base-types/base-renderer.ts:39")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/746f2b6a.c264c0d1.js b/build/assets/js/746f2b6a.c264c0d1.js deleted file mode 100644 index b615e56cc..000000000 --- a/build/assets/js/746f2b6a.c264c0d1.js +++ /dev/null @@ -1 +0,0 @@ -"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 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)}},k=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),k=i,u=m["".concat(s,".").concat(k)]||m[k]||c[k]||r;return t?a.createElement(u,p(p({ref:n},d),{},{components:t})):a.createElement(u,p({ref:n},d))}));function u(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 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:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>r,metadata:()=>l,toc:()=>o});var a=t(7462),i=(t(7294),t(3905));const r={id:"openbim_components.SimpleRenderer",title:"Class: SimpleRenderer",sidebar_label:"SimpleRenderer",custom_edit_url:null},p=void 0,l={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"}},s={},o=[{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:"onResize",id:"onresize",level:3},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Inherited from",id:"inherited-from-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",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-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"getSize",id:"getsize",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Implementation of",id:"implementation-of-4",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-9",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-10",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-11",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-12",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-13",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-14",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-15",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-5",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-16",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-17",level:4},{value:"update",id:"update",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Implementation of",id:"implementation-of-6",level:4},{value:"Defined in",id:"defined-in-18",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-19",level:4}],d={toc:o},m="wrapper";function c(e){let{components:n,...t}=e;return(0,i.kt)(m,(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"),".SimpleRenderer"),(0,i.kt)("p",null,"A basic renderer capable of rendering 3D and 2D objects\n(",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/core/Object3D"},"Objec3Ds")," and\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#examples/en/renderers/CSS2DRenderer"},"CSS2DObjects"),"\nrespectively)."),(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)("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)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"SimpleRenderer"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.PostproductionRenderer"},(0,i.kt)("inlineCode",{parentName:"a"},"PostproductionRenderer"))))),(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)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Updateable"},(0,i.kt)("inlineCode",{parentName:"a"},"Updateable"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Resizeable"},(0,i.kt)("inlineCode",{parentName:"a"},"Resizeable")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"clippingplanes"},"clippingPlanes"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"clippingPlanes"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Plane"),"[] = ",(0,i.kt)("inlineCode",{parentName:"p"},"[]")),(0,i.kt)("p",null,"The list of ",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer.clippingPlanes"},"clipping planes")," used by this\ninstance of the renderer."),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#clippingplanes"},"clippingPlanes")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/base-renderer.ts#L33"},"src/base-types/base-renderer.ts:33")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"container"},"container"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"container"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"HTMLElement")),(0,i.kt)("p",null,"The HTML container of the THREE.js canvas where the scene is rendered."),(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/ifcjs/components/blob/e46138a/src/core/SimpleRenderer/index.ts#L26"},"src/core/SimpleRenderer/index.ts:26")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"enabled"},"enabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"enabled"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"true")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#enabled"},"enabled")),(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/ifcjs/components/blob/e46138a/src/core/SimpleRenderer/index.ts#L23"},"src/core/SimpleRenderer/index.ts:23")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleRenderer")),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"Updateable.onAfterUpdate")),(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.Updateable"},"Updateable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"onAfterUpdate")),(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/ifcjs/components/blob/e46138a/src/core/SimpleRenderer/index.ts#L32"},"src/core/SimpleRenderer/index.ts:32")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleRenderer")),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"Updateable.onBeforeUpdate")),(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.Updateable"},"Updateable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"onBeforeUpdate")),(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/ifcjs/components/blob/e46138a/src/core/SimpleRenderer/index.ts#L29"},"src/core/SimpleRenderer/index.ts:29")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onclippingplanesupdated"},"onClippingPlanesUpdated"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onClippingPlanesUpdated"),": ",(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"},"unknown"),">"),(0,i.kt)("p",null,"Event that fires when there has been a change to the list of clipping\nplanes used by the active renderer."),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#onclippingplanesupdated"},"onClippingPlanesUpdated")),(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/ifcjs/components/blob/e46138a/src/base-types/base-renderer.ts#L27"},"src/base-types/base-renderer.ts:27")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onresize"},"onResize"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(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"},"any"),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#onresize"},"Resizeable.onResize")),(0,i.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#onresize"},"onResize")),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#onresize"},"onResize")),(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/ifcjs/components/blob/e46138a/src/base-types/base-renderer.ts#L21"},"src/base-types/base-renderer.ts:21")),(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"},"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-3"},"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-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleRenderer/index.ts#L89"},"src/core/SimpleRenderer/index.ts:89")),(0,i.kt)("hr",null),(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"},"WebGLRenderer")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"WebGLRenderer")),(0,i.kt)("h4",{id:"overrides-1"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#get"},"get")),(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/ifcjs/components/blob/e46138a/src/core/SimpleRenderer/index.ts#L72"},"src/core/SimpleRenderer/index.ts:72")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getsize"},"getSize"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"getSize"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#getsize"},"Resizeable.getSize"),"."),(0,i.kt)("h4",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,i.kt)("h4",{id:"implementation-of-4"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#getsize"},"getSize")),(0,i.kt)("h4",{id:"overrides-2"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#getsize"},"getSize")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleRenderer/index.ts#L101"},"src/core/SimpleRenderer/index.ts:101")),(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-3"},"Returns"),(0,i.kt)("p",null,"this is UI"),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#hasui"},"hasUI")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L62"},"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-4"},"Returns"),(0,i.kt)("p",null,"this is Configurable"),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#isconfigurable"},"isConfigurable")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L57"},"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-5"},"Returns"),(0,i.kt)("p",null,"this is Disposable"),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#isdisposeable"},"isDisposeable")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L35"},"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-6"},"Returns"),(0,i.kt)("p",null,"this is Hideable"),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#ishideable"},"isHideable")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L52"},"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-7"},"Returns"),(0,i.kt)("p",null,"this is Resizeable"),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#isresizeable"},"isResizeable")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L40"},"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-8"},"Returns"),(0,i.kt)("p",null,"this is Updateable"),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#isupdateable"},"isUpdateable")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"resize"},"resize"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"resize"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"size?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#resize"},"Resizeable.resize"),"."),(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"},"size?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Vector2"))))),(0,i.kt)("h4",{id:"returns-9"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"implementation-of-5"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#resize"},"resize")),(0,i.kt)("h4",{id:"overrides-3"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#resize"},"resize")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleRenderer/index.ts#L109"},"src/core/SimpleRenderer/index.ts:109")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"toggleplane"},"togglePlane"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"togglePlane"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"active"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"plane"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"isLocal?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Adds or removes a\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer.clippingPlanes"},"clipping plane"),"\nto the renderer."),(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)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"active")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"plane")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Plane"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"isLocal?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,i.kt)("h4",{id:"returns-10"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#toggleplane"},"togglePlane")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/base-renderer.ts#L48"},"src/base-types/base-renderer.ts:48")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"update"},"update"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"update"),"(): ",(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.Updateable#update"},"Updateable.update")),(0,i.kt)("h4",{id:"returns-11"},"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-6"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"update")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleRenderer/index.ts#L77"},"src/core/SimpleRenderer/index.ts:77")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"updateclippingplanes"},"updateClippingPlanes"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"updateClippingPlanes"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Forces the update of the clipping planes and all components that depend\non them that are subscribed to ",(0,i.kt)("inlineCode",{parentName:"p"},"onClippingPlanesUpdated"),"."),(0,i.kt)("h4",{id:"returns-12"},"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:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer"},"BaseRenderer"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.BaseRenderer#updateclippingplanes"},"updateClippingPlanes")),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/base-renderer.ts#L39"},"src/base-types/base-renderer.ts:39")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/76e29409.a111aea6.js b/build/assets/js/76e29409.a111aea6.js deleted file mode 100644 index 55de8ba77..000000000 --- a/build/assets/js/76e29409.a111aea6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7523],{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 s(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 p=a.createContext({}),l=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},m=function(e){var t=l(e.components);return a.createElement(p.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,r=e.originalType,p=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),d=l(n),u=i,f=d["".concat(p,".").concat(u)]||d[u]||c[u]||r;return n?a.createElement(f,s(s({ref:t},m),{},{components:n})):a.createElement(f,s({ref:t},m))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,s=new Array(r);s[0]=u;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[d]="string"==typeof e?e:i,s[1]=o;for(var l=2;l{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>c,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var a=n(7462),i=(n(7294),n(3905));const r={id:"openbim_components.FragmentIfcLoader",title:"Class: FragmentIfcLoader",sidebar_label:"FragmentIfcLoader",custom_edit_url:null},s=void 0,o={unversionedId:"api/classes/openbim_components.FragmentIfcLoader",id:"api/classes/openbim_components.FragmentIfcLoader",title:"Class: FragmentIfcLoader",description:"openbim-components.FragmentIfcLoader",source:"@site/docs/api/classes/openbim_components.FragmentIfcLoader.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.FragmentIfcLoader",permalink:"/api/classes/openbim_components.FragmentIfcLoader",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.FragmentIfcLoader",title:"Class: FragmentIfcLoader",sidebar_label:"FragmentIfcLoader",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"FragmentBoundingBox",permalink:"/api/classes/openbim_components.FragmentBoundingBox"},next:{title:"FragmentManager",permalink:"/api/classes/openbim_components.FragmentManager"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in",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-1",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-2",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-3",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-4",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-5",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-6",level:4},{value:"load",id:"load",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],m={toc:l},d="wrapper";function c(e){let{components:t,...n}=e;return(0,i.kt)(d,(0,a.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"),".FragmentIfcLoader"),(0,i.kt)("p",null,"Reads all the geometry of the IFC file and generates a set of\n",(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/fragment"},"fragments"),". It can also return the\nproperties as a JSON file, as well as other sets of information within\nthe IFC file."),(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)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"WEBIFC.IfcAPI"),">"),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"FragmentIfcLoader"))))),(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)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},(0,i.kt)("inlineCode",{parentName:"a"},"UI")))),(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"},"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"},"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"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/fragments/FragmentIfcLoader/index.ts#L59"},"src/fragments/FragmentIfcLoader/index.ts:59")),(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:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L62"},"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:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L57"},"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:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L35"},"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:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L52"},"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:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L40"},"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:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"load"},"load"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"load"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"name"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"FragmentsGroup"),">"),(0,i.kt)("p",null,"Loads the IFC file and converts it to a set of fragments."),(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"},"data")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Uint8Array"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"name")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-7"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"FragmentsGroup"),">"),(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/ifcjs/components/blob/e46138a/src/fragments/FragmentIfcLoader/index.ts#L71"},"src/fragments/FragmentIfcLoader/index.ts:71")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/76e29409.ecd86639.js b/build/assets/js/76e29409.ecd86639.js new file mode 100644 index 000000000..241fbe17f --- /dev/null +++ b/build/assets/js/76e29409.ecd86639.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7523],{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 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 p=a.createContext({}),l=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},m=function(e){var t=l(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},f=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,p=e.parentName,m=s(e,["components","mdxType","originalType","parentName"]),d=l(n),f=i,u=d["".concat(p,".").concat(f)]||d[f]||c[f]||r;return n?a.createElement(u,o(o({ref:t},m),{},{components:n})):a.createElement(u,o({ref:t},m))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,o=new Array(r);o[0]=f;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[d]="string"==typeof e?e:i,o[1]=s;for(var l=2;l{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>c,frontMatter:()=>r,metadata:()=>s,toc:()=>l});var a=n(7462),i=(n(7294),n(3905));const r={id:"openbim_components.FragmentIfcLoader",title:"Class: FragmentIfcLoader",sidebar_label:"FragmentIfcLoader",custom_edit_url:null},o=void 0,s={unversionedId:"api/classes/openbim_components.FragmentIfcLoader",id:"api/classes/openbim_components.FragmentIfcLoader",title:"Class: FragmentIfcLoader",description:"openbim-components.FragmentIfcLoader",source:"@site/docs/api/classes/openbim_components.FragmentIfcLoader.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.FragmentIfcLoader",permalink:"/api/classes/openbim_components.FragmentIfcLoader",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.FragmentIfcLoader",title:"Class: FragmentIfcLoader",sidebar_label:"FragmentIfcLoader",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"FragmentBoundingBox",permalink:"/api/classes/openbim_components.FragmentBoundingBox"},next:{title:"FragmentManager",permalink:"/api/classes/openbim_components.FragmentManager"}},p={},l=[{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:"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-1",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-2",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-3",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-4",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-5",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-6",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-7",level:4},{value:"load",id:"load",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-8",level:4}],m={toc:l},d="wrapper";function c(e){let{components:t,...n}=e;return(0,i.kt)(d,(0,a.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"),".FragmentIfcLoader"),(0,i.kt)("p",null,"Reads all the geometry of the IFC file and generates a set of\n",(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/fragment"},"fragments"),". It can also return the\nproperties as a JSON file, as well as other sets of information within\nthe IFC file."),(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)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"WEBIFC.IfcAPI"),">"),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"FragmentIfcLoader"))))),(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)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},(0,i.kt)("inlineCode",{parentName:"a"},"UI")))),(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"},"string"),">"),(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/IFCjs/components/blob/0c38d20/src/fragments/FragmentIfcLoader/index.ts#L25"},"temp/components/src/fragments/FragmentIfcLoader/index.ts:25")),(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"},"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-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/fragments/FragmentIfcLoader/index.ts#L63"},"temp/components/src/fragments/FragmentIfcLoader/index.ts:63")),(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:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/src/base-types/component.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"load"},"load"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"load"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"name"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"FragmentsGroup"),">"),(0,i.kt)("p",null,"Loads the IFC file and converts it to a set of fragments."),(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"},"data")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Uint8Array"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"name")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-7"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"FragmentsGroup"),">"),(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/IFCjs/components/blob/0c38d20/src/fragments/FragmentIfcLoader/index.ts#L77"},"temp/components/src/fragments/FragmentIfcLoader/index.ts:77")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/7cf9e350.32949f76.js b/build/assets/js/7cf9e350.32949f76.js deleted file mode 100644 index 5689a1454..000000000 --- a/build/assets/js/7cf9e350.32949f76.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1510],{3905:(e,t,a)=>{a.d(t,{Zo:()=>m,kt:()=>h});var n=a(7294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var o=n.createContext({}),s=function(e){var t=n.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},m=function(e){var t=s(e.components);return n.createElement(o.Provider,{value:t},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,r=e.originalType,o=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),d=s(a),k=i,h=d["".concat(o,".").concat(k)]||d[k]||c[k]||r;return a?n.createElement(h,p(p({ref:t},m),{},{components:a})):n.createElement(h,p({ref:t},m))}));function h(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=a.length,p=new Array(r);p[0]=k;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{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>c,frontMatter:()=>r,metadata:()=>l,toc:()=>s});var n=a(7462),i=(a(7294),a(3905));const r={id:"openbim_components.OrthoPerspectiveCamera",title:"Class: OrthoPerspectiveCamera",sidebar_label:"OrthoPerspectiveCamera",custom_edit_url:null},p=void 0,l={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"}},o={},s=[{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:"projectionChanged",id:"projectionchanged",level:3},{value:"Defined in",id:"defined-in-5",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-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",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-8",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-9",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-10",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-11",level:4},{value:"getProjection",id:"getprojection",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"hasUI",id:"hasui",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"isConfigurable",id:"isconfigurable",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"isDisposeable",id:"isdisposeable",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"isHideable",id:"ishideable",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"isResizeable",id:"isresizeable",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"isUpdateable",id:"isupdateable",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-18",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-19",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-20",level:4},{value:"toggleProjection",id:"toggleprojection",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-21",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-22",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-12",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"updateAspect",id:"updateaspect",level:3},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-24",level:4}],m={toc:s},d="wrapper";function c(e){let{components:t,...a}=e;return(0,i.kt)(d,(0,n.Z)({},m,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".OrthoPerspectiveCamera"),(0,i.kt)("p",null,"A flexible camera that uses\n",(0,i.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,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)("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)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"OrthoPerspectiveCamera"))))),(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.UI"},(0,i.kt)("inlineCode",{parentName:"a"},"UI")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"activecamera"},"activeCamera"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"activeCamera"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"PerspectiveCamera")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,i.kt)("p",null,"The camera that is being used now according to the current ",(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection"),"."),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#activecamera"},"activeCamera")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleCamera/index.ts#L45"},"src/core/SimpleCamera/index.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"controls"},"controls"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"controls"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"CameraControls")),(0,i.kt)("p",null,"The object that controls the camera. An instance of\n",(0,i.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,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#controls"},"controls")),(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/ifcjs/components/blob/e46138a/src/core/SimpleCamera/index.ts#L30"},"src/core/SimpleCamera/index.ts:30")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"currentmode"},"currentMode"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"currentMode"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.NavigationMode"},(0,i.kt)("inlineCode",{parentName:"a"},"NavigationMode"))),(0,i.kt)("p",null,"The current ",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.NavigationMode"},"NavigationMode"),"."),(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/ifcjs/components/blob/e46138a/src/navigation/OrthoPerspectiveCamera/index.ts#L24"},"src/navigation/OrthoPerspectiveCamera/index.ts:24")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleCamera")),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"Updateable.onAfterUpdate")),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#onafterupdate"},"onAfterUpdate")),(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/ifcjs/components/blob/e46138a/src/core/SimpleCamera/index.ts#L20"},"src/core/SimpleCamera/index.ts:20")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleCamera")),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"Updateable.onBeforeUpdate")),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#onbeforeupdate"},"onBeforeUpdate")),(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/ifcjs/components/blob/e46138a/src/core/SimpleCamera/index.ts#L17"},"src/core/SimpleCamera/index.ts:17")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"projectionchanged"},"projectionChanged"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"projectionChanged"),": ",(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"},"Camera"),">"),(0,i.kt)("p",null,"Event that fires when the ",(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection")," changes."),(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/ifcjs/components/blob/e46138a/src/navigation/OrthoPerspectiveCamera/index.ts#L29"},"src/navigation/OrthoPerspectiveCamera/index.ts:29")),(0,i.kt)("h2",{id:"accessors"},"Accessors"),(0,i.kt)("h3",{id:"enabled"},"enabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"enabled"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,"SimpleCamera.enabled"),(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/ifcjs/components/blob/e46138a/src/core/SimpleCamera/index.ts#L33"},"src/core/SimpleCamera/index.ts:33")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"enabled"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"enabled"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(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"},"enabled")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))))),(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:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,"SimpleCamera.enabled"),(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/ifcjs/components/blob/e46138a/src/core/SimpleCamera/index.ts#L38"},"src/core/SimpleCamera/index.ts:38")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"matchorthodistanceenabled"},"matchOrthoDistanceEnabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"matchOrthoDistanceEnabled"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Match Ortho zoom with Perspective distance when changing projection mode"),(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)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))))),(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-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/navigation/OrthoPerspectiveCamera/index.ts#L136"},"src/navigation/OrthoPerspectiveCamera/index.ts:136")),(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-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:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#dispose"},"dispose")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/navigation/OrthoPerspectiveCamera/index.ts#L107"},"src/navigation/OrthoPerspectiveCamera/index.ts:107")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"fit"},"fit"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"fit"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"meshes?"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"offset?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Make the camera view fit all the specified meshes."),(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)("th",{parentName:"tr",align:"left"},"Default value"),(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"},"meshes")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Mesh"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"BufferGeometry"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"NormalBufferAttributes"),">",", ",(0,i.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"Material"),"[]",">","[]"),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"undefined")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the meshes to fit. If it is not defined, it will evaluate ",(0,i.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.Components#meshes"},"Components.meshes"),".")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"offset")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"1.5")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the distance to the fit object")))),(0,i.kt)("h4",{id:"returns-4"},"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-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/navigation/OrthoPerspectiveCamera/index.ts#L197"},"src/navigation/OrthoPerspectiveCamera/index.ts:197")),(0,i.kt)("hr",null),(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"},"projection?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"PerspectiveCamera")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,i.kt)("p",null,"Similar to ",(0,i.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,i.kt)("h4",{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)("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"},"projection?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/api/modules/openbim_components#cameraprojection"},(0,i.kt)("inlineCode",{parentName:"a"},"CameraProjection"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"The camera corresponding to the ",(0,i.kt)("a",{parentName:"td",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection")," specified. If no projection is specified, the active camera will be returned.")))),(0,i.kt)("h4",{id:"returns-5"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"PerspectiveCamera")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,i.kt)("h4",{id:"overrides-1"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#get"},"get")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/navigation/OrthoPerspectiveCamera/index.ts#L121"},"src/navigation/OrthoPerspectiveCamera/index.ts:121")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getprojection"},"getProjection"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"getProjection"),"(): ",(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},(0,i.kt)("inlineCode",{parentName:"a"},"CameraProjection"))),(0,i.kt)("p",null,"Returns the current ",(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection"),"."),(0,i.kt)("h4",{id:"returns-6"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},(0,i.kt)("inlineCode",{parentName:"a"},"CameraProjection"))),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/navigation/OrthoPerspectiveCamera/index.ts#L131"},"src/navigation/OrthoPerspectiveCamera/index.ts:131")),(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-7"},"Returns"),(0,i.kt)("p",null,"this is UI"),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#hasui"},"hasUI")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L62"},"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-8"},"Returns"),(0,i.kt)("p",null,"this is Configurable"),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#isconfigurable"},"isConfigurable")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L57"},"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-9"},"Returns"),(0,i.kt)("p",null,"this is Disposable"),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#isdisposeable"},"isDisposeable")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L35"},"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-10"},"Returns"),(0,i.kt)("p",null,"this is Hideable"),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#ishideable"},"isHideable")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L52"},"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-11"},"Returns"),(0,i.kt)("p",null,"this is Resizeable"),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#isresizeable"},"isResizeable")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L40"},"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-12"},"Returns"),(0,i.kt)("p",null,"this is Updateable"),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#isupdateable"},"isUpdateable")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"setnavigationmode"},"setNavigationMode"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"setNavigationMode"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"mode"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Sets a new ",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.NavigationMode"},"NavigationMode")," and disables the previous one."),(0,i.kt)("h4",{id:"parameters-4"},"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"},"mode")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/api/modules/openbim_components#navmodeid"},(0,i.kt)("inlineCode",{parentName:"a"},"NavModeID"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"The ",(0,i.kt)("a",{parentName:"td",href:"/api/interfaces/openbim_components.NavigationMode"},"NavigationMode")," to set.")))),(0,i.kt)("h4",{id:"returns-13"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/navigation/OrthoPerspectiveCamera/index.ts#L180"},"src/navigation/OrthoPerspectiveCamera/index.ts:180")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"setprojection"},"setProjection"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"setProjection"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"projection"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Sets the current ",(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection"),". This triggers the event\n",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.OrthoPerspectiveCamera#projectionchanged"},"projectionChanged"),"."),(0,i.kt)("h4",{id:"parameters-5"},"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"},"projection")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/api/modules/openbim_components#cameraprojection"},(0,i.kt)("inlineCode",{parentName:"a"},"CameraProjection"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"The new ",(0,i.kt)("a",{parentName:"td",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection")," to set.")))),(0,i.kt)("h4",{id:"returns-14"},"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-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/navigation/OrthoPerspectiveCamera/index.ts#L157"},"src/navigation/OrthoPerspectiveCamera/index.ts:157")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"toggleprojection"},"toggleProjection"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"toggleProjection"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Changes the current ",(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection")," from Ortographic to Perspective\nand Viceversa."),(0,i.kt)("h4",{id:"returns-15"},"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-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/navigation/OrthoPerspectiveCamera/index.ts#L144"},"src/navigation/OrthoPerspectiveCamera/index.ts:144")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"toggleuserinput"},"toggleUserInput"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"toggleUserInput"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"active"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Allows or prevents all user input."),(0,i.kt)("h4",{id:"parameters-6"},"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"},"active")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean")),(0,i.kt)("td",{parentName:"tr",align:"left"},"whether to enable or disable user inputs.")))),(0,i.kt)("h4",{id:"returns-16"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/navigation/OrthoPerspectiveCamera/index.ts#L167"},"src/navigation/OrthoPerspectiveCamera/index.ts:167")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"update"},"update"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"update"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"_delta"),"): ",(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.Updateable#update"},"Updateable.update")),(0,i.kt)("h4",{id:"parameters-7"},"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"},"_delta")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))))),(0,i.kt)("h4",{id:"returns-17"},"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:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#update"},"update")),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleCamera/index.ts#L76"},"src/core/SimpleCamera/index.ts:76")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"updateaspect"},"updateAspect"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"updateAspect"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Updates the aspect of the camera to match the size of the\n",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Components#renderer"},"Components.renderer"),"."),(0,i.kt)("h4",{id:"returns-18"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#updateaspect"},"updateAspect")),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleCamera/index.ts#L88"},"src/core/SimpleCamera/index.ts:88")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/7cf9e350.8aed9f99.js b/build/assets/js/7cf9e350.8aed9f99.js new file mode 100644 index 000000000..9ee0fe737 --- /dev/null +++ b/build/assets/js/7cf9e350.8aed9f99.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1510],{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 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)}},k=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,l=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),d=s(n),k=i,h=d["".concat(l,".").concat(k)]||d[k]||c[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 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 s=2;s{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>c,frontMatter:()=>r,metadata:()=>o,toc:()=>s});var a=n(7462),i=(n(7294),n(3905));const r={id:"openbim_components.OrthoPerspectiveCamera",title:"Class: OrthoPerspectiveCamera",sidebar_label:"OrthoPerspectiveCamera",custom_edit_url:null},p=void 0,o={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"}},l={},s=[{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}],m={toc:s},d="wrapper";function c(e){let{components:t,...n}=e;return(0,i.kt)(d,(0,a.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"),".OrthoPerspectiveCamera"),(0,i.kt)("p",null,"A flexible camera that uses\n",(0,i.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,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)("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)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"OrthoPerspectiveCamera"))))),(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.UI"},(0,i.kt)("inlineCode",{parentName:"a"},"UI")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"activecamera"},"activeCamera"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"activeCamera"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"PerspectiveCamera")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,i.kt)("p",null,"The camera that is being used now according to the current ",(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection"),"."),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#activecamera"},"activeCamera")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleCamera/index.ts#L48"},"temp/components/src/core/SimpleCamera/index.ts:48")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"controls"},"controls"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"controls"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"CameraControls")),(0,i.kt)("p",null,"The object that controls the camera. An instance of\n",(0,i.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,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#controls"},"controls")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleCamera/index.ts#L33"},"temp/components/src/core/SimpleCamera/index.ts:33")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"currentmode"},"currentMode"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"currentMode"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.NavigationMode"},(0,i.kt)("inlineCode",{parentName:"a"},"NavigationMode"))),(0,i.kt)("p",null,"The current ",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.NavigationMode"},"NavigationMode"),"."),(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/IFCjs/components/blob/0c38d20/src/navigation/OrthoPerspectiveCamera/index.ts#L24"},"temp/components/src/navigation/OrthoPerspectiveCamera/index.ts:24")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleCamera")),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"Updateable.onAfterUpdate")),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#onafterupdate"},"onAfterUpdate")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleCamera/index.ts#L20"},"temp/components/src/core/SimpleCamera/index.ts:20")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleCamera")),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"Updateable.onBeforeUpdate")),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#onbeforeupdate"},"onBeforeUpdate")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleCamera/index.ts#L17"},"temp/components/src/core/SimpleCamera/index.ts:17")),(0,i.kt)("hr",null),(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"},"string"),">"),(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:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#ondisposed"},"onDisposed")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleCamera/index.ts#L25"},"temp/components/src/core/SimpleCamera/index.ts:25")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"projectionchanged"},"projectionChanged"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"projectionChanged"),": ",(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"},"Camera"),">"),(0,i.kt)("p",null,"Event that fires when the ",(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection")," changes."),(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/IFCjs/components/blob/0c38d20/src/navigation/OrthoPerspectiveCamera/index.ts#L29"},"temp/components/src/navigation/OrthoPerspectiveCamera/index.ts:29")),(0,i.kt)("h2",{id:"accessors"},"Accessors"),(0,i.kt)("h3",{id:"enabled"},"enabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"enabled"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,"SimpleCamera.enabled"),(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/IFCjs/components/blob/0c38d20/src/core/SimpleCamera/index.ts#L36"},"temp/components/src/core/SimpleCamera/index.ts:36")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"enabled"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"enabled"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(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"},"enabled")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))))),(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:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,"SimpleCamera.enabled"),(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/IFCjs/components/blob/0c38d20/src/core/SimpleCamera/index.ts#L41"},"temp/components/src/core/SimpleCamera/index.ts:41")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"matchorthodistanceenabled"},"matchOrthoDistanceEnabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"matchOrthoDistanceEnabled"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Match Ortho zoom with Perspective distance when changing projection mode"),(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)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))))),(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-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/navigation/OrthoPerspectiveCamera/index.ts#L136"},"temp/components/src/navigation/OrthoPerspectiveCamera/index.ts:136")),(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-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:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#dispose"},"dispose")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/navigation/OrthoPerspectiveCamera/index.ts#L107"},"temp/components/src/navigation/OrthoPerspectiveCamera/index.ts:107")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"fit"},"fit"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"fit"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"meshes?"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"offset?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Make the camera view fit all the specified meshes."),(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)("th",{parentName:"tr",align:"left"},"Default value"),(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"},"meshes")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Mesh"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"BufferGeometry"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"NormalBufferAttributes"),">",", ",(0,i.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"Material"),"[]",">","[]"),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"undefined")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the meshes to fit. If it is not defined, it will evaluate ",(0,i.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.Components#meshes"},"Components.meshes"),".")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"offset")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"1.5")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the distance to the fit object")))),(0,i.kt)("h4",{id:"returns-4"},"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-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/navigation/OrthoPerspectiveCamera/index.ts#L197"},"temp/components/src/navigation/OrthoPerspectiveCamera/index.ts:197")),(0,i.kt)("hr",null),(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"},"projection?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"PerspectiveCamera")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,i.kt)("p",null,"Similar to ",(0,i.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,i.kt)("h4",{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)("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"},"projection?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/api/modules/openbim_components#cameraprojection"},(0,i.kt)("inlineCode",{parentName:"a"},"CameraProjection"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"The camera corresponding to the ",(0,i.kt)("a",{parentName:"td",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection")," specified. If no projection is specified, the active camera will be returned.")))),(0,i.kt)("h4",{id:"returns-5"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"PerspectiveCamera")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,i.kt)("h4",{id:"overrides-1"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#get"},"get")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/navigation/OrthoPerspectiveCamera/index.ts#L121"},"temp/components/src/navigation/OrthoPerspectiveCamera/index.ts:121")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getprojection"},"getProjection"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"getProjection"),"(): ",(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},(0,i.kt)("inlineCode",{parentName:"a"},"CameraProjection"))),(0,i.kt)("p",null,"Returns the current ",(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection"),"."),(0,i.kt)("h4",{id:"returns-6"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},(0,i.kt)("inlineCode",{parentName:"a"},"CameraProjection"))),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/navigation/OrthoPerspectiveCamera/index.ts#L131"},"temp/components/src/navigation/OrthoPerspectiveCamera/index.ts:131")),(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-7"},"Returns"),(0,i.kt)("p",null,"this is UI"),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#hasui"},"hasUI")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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-8"},"Returns"),(0,i.kt)("p",null,"this is Configurable"),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#isconfigurable"},"isConfigurable")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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-9"},"Returns"),(0,i.kt)("p",null,"this is Disposable"),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#isdisposeable"},"isDisposeable")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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-10"},"Returns"),(0,i.kt)("p",null,"this is Hideable"),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#ishideable"},"isHideable")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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-11"},"Returns"),(0,i.kt)("p",null,"this is Resizeable"),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#isresizeable"},"isResizeable")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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-12"},"Returns"),(0,i.kt)("p",null,"this is Updateable"),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#isupdateable"},"isUpdateable")),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/src/base-types/component.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"setnavigationmode"},"setNavigationMode"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"setNavigationMode"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"mode"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Sets a new ",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.NavigationMode"},"NavigationMode")," and disables the previous one."),(0,i.kt)("h4",{id:"parameters-4"},"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"},"mode")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/api/modules/openbim_components#navmodeid"},(0,i.kt)("inlineCode",{parentName:"a"},"NavModeID"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"The ",(0,i.kt)("a",{parentName:"td",href:"/api/interfaces/openbim_components.NavigationMode"},"NavigationMode")," to set.")))),(0,i.kt)("h4",{id:"returns-13"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/navigation/OrthoPerspectiveCamera/index.ts#L180"},"temp/components/src/navigation/OrthoPerspectiveCamera/index.ts:180")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"setprojection"},"setProjection"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"setProjection"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"projection"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Sets the current ",(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection"),". This triggers the event\n",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.OrthoPerspectiveCamera#projectionchanged"},"projectionChanged"),"."),(0,i.kt)("h4",{id:"parameters-5"},"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"},"projection")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/api/modules/openbim_components#cameraprojection"},(0,i.kt)("inlineCode",{parentName:"a"},"CameraProjection"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"The new ",(0,i.kt)("a",{parentName:"td",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection")," to set.")))),(0,i.kt)("h4",{id:"returns-14"},"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-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/navigation/OrthoPerspectiveCamera/index.ts#L157"},"temp/components/src/navigation/OrthoPerspectiveCamera/index.ts:157")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"toggleprojection"},"toggleProjection"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"toggleProjection"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Changes the current ",(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection")," from Ortographic to Perspective\nand Viceversa."),(0,i.kt)("h4",{id:"returns-15"},"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-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/navigation/OrthoPerspectiveCamera/index.ts#L144"},"temp/components/src/navigation/OrthoPerspectiveCamera/index.ts:144")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"toggleuserinput"},"toggleUserInput"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"toggleUserInput"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"active"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Allows or prevents all user input."),(0,i.kt)("h4",{id:"parameters-6"},"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"},"active")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean")),(0,i.kt)("td",{parentName:"tr",align:"left"},"whether to enable or disable user inputs.")))),(0,i.kt)("h4",{id:"returns-16"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/navigation/OrthoPerspectiveCamera/index.ts#L167"},"temp/components/src/navigation/OrthoPerspectiveCamera/index.ts:167")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"update"},"update"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"update"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"_delta"),"): ",(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.Updateable#update"},"Updateable.update")),(0,i.kt)("h4",{id:"parameters-7"},"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"},"_delta")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))))),(0,i.kt)("h4",{id:"returns-17"},"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:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#update"},"update")),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleCamera/index.ts#L81"},"temp/components/src/core/SimpleCamera/index.ts:81")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"updateaspect"},"updateAspect"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"updateAspect"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Updates the aspect of the camera to match the size of the\n",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Components#renderer"},"Components.renderer"),"."),(0,i.kt)("h4",{id:"returns-18"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera#updateaspect"},"updateAspect")),(0,i.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleCamera/index.ts#L93"},"temp/components/src/core/SimpleCamera/index.ts:93")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/8d23124b.356e7dd5.js b/build/assets/js/8d23124b.356e7dd5.js deleted file mode 100644 index 49cc6b0df..000000000 --- a/build/assets/js/8d23124b.356e7dd5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5742],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>k});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 l(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 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",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,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),m=s(n),c=a,k=m["".concat(o,".").concat(c)]||m[c]||u[c]||r;return n?i.createElement(k,l(l({ref:t},d),{},{components:n})):i.createElement(k,l({ref:t},d))}));function k(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,l=new Array(r);l[0]=c;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[m]="string"==typeof e?e:a,l[1]=p;for(var s=2;s{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>u,frontMatter:()=>r,metadata:()=>p,toc:()=>s});var i=n(7462),a=(n(7294),n(3905));const r={id:"openbim_components.ScreenCuller",title:"Class: ScreenCuller",sidebar_label:"ScreenCuller",custom_edit_url:null},l=void 0,p={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:"PostproductionRenderer",permalink:"/api/classes/openbim_components.PostproductionRenderer"},next:{title:"Simple2DScene",permalink:"/api/classes/openbim_components.Simple2DScene"}},o={},s=[{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:"needsUpdate",id:"needsupdate",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"onViewUpdated",id:"onviewupdated",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"renderDebugFrame",id:"renderdebugframe",level:3},{value:"Defined in",id:"defined-in-3",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-4",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-5",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-6",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-7",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-8",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-9",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-10",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-11",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-12",level:4},{value:"updateVisibility",id:"updatevisibility",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}],d={toc:s},m="wrapper";function u(e){let{components:t,...n}=e;return(0,a.kt)(m,(0,i.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"),".ScreenCuller"),(0,a.kt)("p",null,"A tool to handle big scenes efficiently by automatically hiding the objects\nthat are not visible to the camera."),(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"},"Map"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"THREE.InstancedMesh"),">",">"),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"ScreenCuller"))))),(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/ifcjs/components/blob/e46138a/src/core/ScreenCuller/index.ts#L25"},"src/core/ScreenCuller/index.ts:25")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"needsupdate"},"needsUpdate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"needsUpdate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"false")),(0,a.kt)("p",null,"Needs to check whether there are objects that need to be hidden or shown.\nYou can bind this to the camera movement, to a certain interval, etc."),(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/ifcjs/components/blob/e46138a/src/core/ScreenCuller/index.ts#L31"},"src/core/ScreenCuller/index.ts:31")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"onviewupdated"},"onViewUpdated"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"onViewUpdated"),": ",(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,"Fires after hiding the objects that were not visible to the camera."),(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/ifcjs/components/blob/e46138a/src/core/ScreenCuller/index.ts#L22"},"src/core/ScreenCuller/index.ts:22")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"renderdebugframe"},"renderDebugFrame"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"renderDebugFrame"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"false")),(0,a.kt)("p",null,"Render the internal scene used to determine the object visibility. Used\nfor debugging purposes."),(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/ifcjs/components/blob/e46138a/src/core/ScreenCuller/index.ts#L37"},"src/core/ScreenCuller/index.ts:37")),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"add"},"add"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"add"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"mesh"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"Adds a new mesh to be processed and managed by the culler."),(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"},"mesh")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Mesh"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"BufferGeometry"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"NormalBufferAttributes"),">",", ",(0,a.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"Material"),"[]",">"," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"InstancedMesh"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"BufferGeometry"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"NormalBufferAttributes"),">",", ",(0,a.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"Material"),"[]",">")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Mesh"))),(0,a.kt)("p",null,"the mesh or instanced mesh to add."),(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/ifcjs/components/blob/e46138a/src/core/ScreenCuller/index.ts#L146"},"src/core/ScreenCuller/index.ts:146")),(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/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,a.kt)("h4",{id:"returns-1"},"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"},"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-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/ScreenCuller/index.ts#L112"},"src/core/ScreenCuller/index.ts:112")),(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"},"Map"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"InstancedMesh"),"<",(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)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get"),"."),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Map"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"InstancedMesh"),"<",(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)("p",null,"the map of internal meshes used to determine visibility."),(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-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/ScreenCuller/index.ts#L107"},"src/core/ScreenCuller/index.ts:107")),(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-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"updatevisibility"},"updateVisibility"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"updateVisibility"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"force?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("p",null,"The function that the culler uses to reprocess the scene. Generally it's\nbetter to call needsUpdate, but you can also call this to force it."),(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)("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"},"force?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean")),(0,a.kt)("td",{parentName:"tr",align:"left"},"if true, it will refresh the scene even if needsUpdate is not true.")))),(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:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/ScreenCuller/index.ts#L213"},"src/core/ScreenCuller/index.ts:213")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/8d23124b.b580c870.js b/build/assets/js/8d23124b.b580c870.js new file mode 100644 index 000000000..7e7cf72ed --- /dev/null +++ b/build/assets/js/8d23124b.b580c870.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5742],{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 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",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,r=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),m=s(t),u=a,k=m["".concat(o,".").concat(u)]||m[u]||c[u]||r;return t?i.createElement(k,l(l({ref:n},d),{},{components:t})):i.createElement(k,l({ref:n},d))}));function k(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var r=t.length,l=new Array(r);l[0]=u;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:()=>o,contentTitle:()=>l,default:()=>c,frontMatter:()=>r,metadata:()=>p,toc:()=>s});var i=t(7462),a=(t(7294),t(3905));const r={id:"openbim_components.ScreenCuller",title:"Class: ScreenCuller",sidebar_label:"ScreenCuller",custom_edit_url:null},l=void 0,p={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:"PostproductionRenderer",permalink:"/api/classes/openbim_components.PostproductionRenderer"},next:{title:"Simple2DScene",permalink:"/api/classes/openbim_components.Simple2DScene"}},o={},s=[{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:"needsUpdate",id:"needsupdate",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:"onViewUpdated",id:"onviewupdated",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"renderDebugFrame",id:"renderdebugframe",level:3},{value:"Defined in",id:"defined-in-4",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-5",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-6",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-7",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-8",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-9",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-10",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-11",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-12",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-13",level:4},{value:"updateVisibility",id:"updatevisibility",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-14",level:4}],d={toc:s},m="wrapper";function c(e){let{components:n,...t}=e;return(0,a.kt)(m,(0,i.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"),".ScreenCuller"),(0,a.kt)("p",null,"A tool to handle big scenes efficiently by automatically hiding the objects\nthat are not visible to the camera."),(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"},"Map"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"THREE.InstancedMesh"),">",">"),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"ScreenCuller"))))),(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)("inlineCode",{parentName:"li"},"ScreenCullerConfig"),">")),(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/IFCjs/components/blob/0c38d20/src/core/ScreenCuller/index.ts#L38"},"temp/components/src/core/ScreenCuller/index.ts:38")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"needsupdate"},"needsUpdate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"needsUpdate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"false")),(0,a.kt)("p",null,"Needs to check whether there are objects that need to be hidden or shown.\nYou can bind this to the camera movement, to a certain interval, etc."),(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/IFCjs/components/blob/0c38d20/src/core/ScreenCuller/index.ts#L44"},"temp/components/src/core/ScreenCuller/index.ts:44")),(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-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/ScreenCuller/index.ts#L32"},"temp/components/src/core/ScreenCuller/index.ts:32")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"onviewupdated"},"onViewUpdated"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"onViewUpdated"),": ",(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,"Fires after hiding the objects that were not visible to the camera."),(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/IFCjs/components/blob/0c38d20/src/core/ScreenCuller/index.ts#L35"},"temp/components/src/core/ScreenCuller/index.ts:35")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"renderdebugframe"},"renderDebugFrame"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"renderDebugFrame"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"false")),(0,a.kt)("p",null,"Render the internal scene used to determine the object visibility. Used\nfor debugging purposes."),(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/IFCjs/components/blob/0c38d20/src/core/ScreenCuller/index.ts#L50"},"temp/components/src/core/ScreenCuller/index.ts:50")),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"add"},"add"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"add"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"mesh"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"Adds a new mesh to be processed and managed by the culler."),(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"},"mesh")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Mesh"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"BufferGeometry"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"NormalBufferAttributes"),">",", ",(0,a.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"Material"),"[]",">"," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"InstancedMesh"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"BufferGeometry"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"NormalBufferAttributes"),">",", ",(0,a.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"Material"),"[]",">")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Mesh"))),(0,a.kt)("p",null,"the mesh or instanced mesh to add."),(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/IFCjs/components/blob/0c38d20/src/core/ScreenCuller/index.ts#L169"},"temp/components/src/core/ScreenCuller/index.ts:169")),(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/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,a.kt)("h4",{id:"returns-1"},"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-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/ScreenCuller/index.ts#L132"},"temp/components/src/core/ScreenCuller/index.ts:132")),(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"},"Map"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"InstancedMesh"),"<",(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)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get"),"."),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Map"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"InstancedMesh"),"<",(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)("p",null,"the map of internal meshes used to determine visibility."),(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-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/ScreenCuller/index.ts#L127"},"temp/components/src/core/ScreenCuller/index.ts:127")),(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-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/src/base-types/component.ts:45")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"updatevisibility"},"updateVisibility"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"updateVisibility"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"force?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,a.kt)("p",null,"The function that the culler uses to reprocess the scene. Generally it's\nbetter to call needsUpdate, but you can also call this to force it."),(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)("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"},"force?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean")),(0,a.kt)("td",{parentName:"tr",align:"left"},"if true, it will refresh the scene even if needsUpdate is not true.")))),(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:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/ScreenCuller/index.ts#L251"},"temp/components/src/core/ScreenCuller/index.ts:251")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/963ae1bc.1bd66bca.js b/build/assets/js/963ae1bc.1bd66bca.js deleted file mode 100644 index 3238a647b..000000000 --- a/build/assets/js/963ae1bc.1bd66bca.js +++ /dev/null @@ -1 +0,0 @@ -"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 o=a.createContext({}),l=function(e){var t=a.useContext(o),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(o.Provider,{value:t},e.children)},c="mdxType",d={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,o=e.parentName,m=s(e,["components","mdxType","originalType","parentName"]),c=l(n),u=i,k=c["".concat(o,".").concat(u)]||c[u]||d[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 s={};for(var o in t)hasOwnProperty.call(t,o)&&(s[o]=t[o]);s.originalType=e,s[c]="string"==typeof e?e:i,r[1]=s;for(var l=2;l{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>r,default:()=>d,frontMatter:()=>p,metadata:()=>s,toc:()=>l});var a=n(7462),i=(n(7294),n(3905));const p={id:"openbim_components.Component",title:"Class: Component",sidebar_label:"Component",custom_edit_url:null},r=void 0,s={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"}},o={},l=[{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}],m={toc:l},c="wrapper";function d(e){let{components:t,...n}=e;return(0,i.kt)(c,(0,a.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"),".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.LocalCacher"},(0,i.kt)("inlineCode",{parentName:"a"},"LocalCacher"))),(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.FragmentIfcLoader"},(0,i.kt)("inlineCode",{parentName:"a"},"FragmentIfcLoader"))),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L24"},"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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L30"},"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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L62"},"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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L57"},"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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L35"},"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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L52"},"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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L40"},"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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/963ae1bc.aa581692.js b/build/assets/js/963ae1bc.aa581692.js new file mode 100644 index 000000000..42abd74bd --- /dev/null +++ b/build/assets/js/963ae1bc.aa581692.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 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 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 r(e){for(var t=1;t=0||(p[n]=e[n]);return p}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(p[n]=e[n])}return p}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)},c="mdxType",d={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,p=e.mdxType,i=e.originalType,s=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),c=l(n),u=p,k=c["".concat(s,".").concat(u)]||c[u]||d[u]||i;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,p=t&&t.mdxType;if("string"==typeof e||p){var i=n.length,r=new Array(i);r[0]=u;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[c]="string"==typeof e?e:p,r[1]=o;for(var l=2;l{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>r,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>l});var a=n(7462),p=(n(7294),n(3905));const i={id:"openbim_components.Component",title:"Class: Component",sidebar_label:"Component",custom_edit_url:null},r=void 0,o={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"}},s={},l=[{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}],m={toc:l},c="wrapper";function d(e){let{components:t,...n}=e;return(0,p.kt)(c,(0,a.Z)({},m,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.LocalCacher"},(0,p.kt)("inlineCode",{parentName:"a"},"LocalCacher"))),(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.FragmentIfcLoader"},(0,p.kt)("inlineCode",{parentName:"a"},"FragmentIfcLoader"))),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L24"},"temp/components/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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L30"},"temp/components/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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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-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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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-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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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-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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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-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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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-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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/src/base-types/component.ts:45")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/969ec0f0.d76af01e.js b/build/assets/js/969ec0f0.e8b86dab.js similarity index 64% rename from build/assets/js/969ec0f0.d76af01e.js rename to build/assets/js/969ec0f0.e8b86dab.js index 9436e1a18..37c543cb1 100644 --- a/build/assets/js/969ec0f0.d76af01e.js +++ b/build/assets/js/969ec0f0.e8b86dab.js @@ -1 +1 @@ -"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 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)}},u=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),u=r,k=m["".concat(o,".").concat(u)]||m[u]||c[u]||l;return n?a.createElement(k,i(i({ref:t},d),{},{components:n})):a.createElement(k,i({ref:t},d))}));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 s=2;s{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>c,frontMatter:()=>l,metadata:()=>p,toc:()=>s});var a=n(7462),r=(n(7294),n(3905));const l={id:"openbim_components.Event",title:"Class: Event",sidebar_label:"Event",custom_edit_url:null},i=void 0,p={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"}},o={},s=[{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}],d={toc:s},m="wrapper";function c(e){let{components:t,...n}=e;return(0,r.kt)(m,(0,a.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Event"),(0,r.kt)("p",null,"Simple event handler by\n",(0,r.kt)("a",{parentName:"p",href:"https://gist.github.com/JasonKleban/50cee44960c225ac1993c922563aa540"},"Jason Kleban"),".\nKeep in mind that:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"If you want to remove it later, you might want to declare the callback as\nan object."),(0,r.kt)("li",{parentName:"ul"},"If you want to maintain the reference to ",(0,r.kt)("inlineCode",{parentName:"li"},"this"),", you will need to declare\nthe callback as an arrow function.")),(0,r.kt)("h2",{id:"type-parameters"},"Type 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)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))))),(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"},"handler"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Add a callback to this event instance."),(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"},"handler")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")," extends ",(0,r.kt)("inlineCode",{parentName:"td"},"void")," ? () => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")," : (",(0,r.kt)("inlineCode",{parentName:"td"},"data"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"T"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the callback to be added to this event.")))),(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"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L18"},"src/base-types/base-types.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"remove"},"remove"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"remove"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"handler"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Removes a callback from this event instance."),(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"},"handler")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")," extends ",(0,r.kt)("inlineCode",{parentName:"td"},"void")," ? () => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")," : (",(0,r.kt)("inlineCode",{parentName:"td"},"data"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"T"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the callback to be removed from this event.")))),(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-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L26"},"src/base-types/base-types.ts:26")),(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,"Gets rid of all the suscribed events."),(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-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L39"},"src/base-types/base-types.ts:39")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"trigger"},"trigger"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"trigger"),"(",(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,"Triggers all the callbacks assigned to this event."),(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"},"data?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))))),(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:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L31"},"src/base-types/base-types.ts:31")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"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 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)}},u=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),u=r,k=m["".concat(o,".").concat(u)]||m[u]||c[u]||l;return n?a.createElement(k,i(i({ref:t},d),{},{components:n})):a.createElement(k,i({ref:t},d))}));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 s=2;s{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>c,frontMatter:()=>l,metadata:()=>p,toc:()=>s});var a=n(7462),r=(n(7294),n(3905));const l={id:"openbim_components.Event",title:"Class: Event",sidebar_label:"Event",custom_edit_url:null},i=void 0,p={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"}},o={},s=[{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}],d={toc:s},m="wrapper";function c(e){let{components:t,...n}=e;return(0,r.kt)(m,(0,a.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Event"),(0,r.kt)("p",null,"Simple event handler by\n",(0,r.kt)("a",{parentName:"p",href:"https://gist.github.com/JasonKleban/50cee44960c225ac1993c922563aa540"},"Jason Kleban"),".\nKeep in mind that:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"If you want to remove it later, you might want to declare the callback as\nan object."),(0,r.kt)("li",{parentName:"ul"},"If you want to maintain the reference to ",(0,r.kt)("inlineCode",{parentName:"li"},"this"),", you will need to declare\nthe callback as an arrow function.")),(0,r.kt)("h2",{id:"type-parameters"},"Type 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)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))))),(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"},"handler"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Add a callback to this event instance."),(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"},"handler")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")," extends ",(0,r.kt)("inlineCode",{parentName:"td"},"void")," ? () => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")," : (",(0,r.kt)("inlineCode",{parentName:"td"},"data"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"T"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the callback to be added to this event.")))),(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"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L19"},"temp/components/src/base-types/base-types.ts:19")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"remove"},"remove"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"remove"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"handler"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Removes a callback from this event instance."),(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"},"handler")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")," extends ",(0,r.kt)("inlineCode",{parentName:"td"},"void")," ? () => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")," : (",(0,r.kt)("inlineCode",{parentName:"td"},"data"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"T"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the callback to be removed from this event.")))),(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-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L27"},"temp/components/src/base-types/base-types.ts:27")),(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,"Gets rid of all the suscribed events."),(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-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L40"},"temp/components/src/base-types/base-types.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"trigger"},"trigger"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"trigger"),"(",(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,"Triggers all the callbacks assigned to this event."),(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"},"data?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))))),(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:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L32"},"temp/components/src/base-types/base-types.ts:32")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/9ba2e06a.18ca9813.js b/build/assets/js/9ba2e06a.18ca9813.js new file mode 100644 index 000000000..c0c8ba257 --- /dev/null +++ b/build/assets/js/9ba2e06a.18ca9813.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4073],{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 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 r(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var l=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):r(r({},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)}},u=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,l=e.originalType,o=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),d=s(n),u=i,f=d["".concat(o,".").concat(u)]||d[u]||k[u]||l;return n?a.createElement(f,r(r({ref:t},m),{},{components:n})):a.createElement(f,r({ref:t},m))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var l=n.length,r=new Array(l);r[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:i,r[1]=p;for(var s=2;s{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>r,default:()=>k,frontMatter:()=>l,metadata:()=>p,toc:()=>s});var a=n(7462),i=(n(7294),n(3905));const l={id:"openbim_components.FragmentPlans",title:"Class: FragmentPlans",sidebar_label:"FragmentPlans",custom_edit_url:null},r=void 0,p={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"}},o={},s=[{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}],m={toc:s},d="wrapper";function k(e){let{components:t,...n}=e;return(0,i.kt)(d,(0,a.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"),".FragmentPlans"),(0,i.kt)("p",null,"Helper to control the camera and easily define and navigate 2D floor plans."),(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)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"PlanView"),"[]",">"),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"FragmentPlans"))))),(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)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},(0,i.kt)("inlineCode",{parentName:"a"},"UI")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"currentplan"},"currentPlan"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"currentPlan"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"PlanView")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"null")),(0,i.kt)("p",null,"The floorplan that is currently selected."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/fragments/FragmentPlans/index.ts#L44"},"temp/components/src/fragments/FragmentPlans/index.ts:44")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"defaultcameraoffset"},"defaultCameraOffset"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"defaultCameraOffset"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"30")),(0,i.kt)("p",null,"The offset of the 2D camera to the floor plan elevation."),(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/IFCjs/components/blob/0c38d20/src/fragments/FragmentPlans/index.ts#L50"},"temp/components/src/fragments/FragmentPlans/index.ts:50")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"defaultsectionoffset"},"defaultSectionOffset"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"defaultSectionOffset"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"1.5")),(0,i.kt)("p",null,"The offset from the clipping planes to their respective floor plan elevation."),(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/IFCjs/components/blob/0c38d20/src/fragments/FragmentPlans/index.ts#L47"},"temp/components/src/fragments/FragmentPlans/index.ts:47")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"enabled"},"enabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"enabled"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"false")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(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/IFCjs/components/blob/0c38d20/src/fragments/FragmentPlans/index.ts#L41"},"temp/components/src/fragments/FragmentPlans/index.ts:41")),(0,i.kt)("hr",null),(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"},"string"),">"),(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-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/fragments/FragmentPlans/index.ts#L34"},"temp/components/src/fragments/FragmentPlans/index.ts:34")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"storeys"},"storeys"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"storeys"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"[]")),(0,i.kt)("p",null,"The created floor plans."),(0,i.kt)("h4",{id:"index-signature"},"Index signature"),(0,i.kt)("p",null,"\u25aa ","[modelID: ",(0,i.kt)("inlineCode",{parentName:"p"},"number"),"]",": ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),"[]"),(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/IFCjs/components/blob/0c38d20/src/fragments/FragmentPlans/index.ts#L53"},"temp/components/src/fragments/FragmentPlans/index.ts:53")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"uielement"},"uiElement"),(0,i.kt)("p",null,"\u2022 ",(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"},"commandsMenu"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"CommandsMenu"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"PlanView"),">"," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"defaultText"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"SimpleUIComponent"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"HTMLParagraphElement"),">"," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"exitButton"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Button")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"floatingWindow"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"FloatingWindow")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"main"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Button")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"planList"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"SimpleUIComponent"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"HTMLElement"),">"," }",">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI#uielement"},"UI.uiElement")),(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.UI"},"UI"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI#uielement"},"uiElement")),(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/IFCjs/components/blob/0c38d20/src/fragments/FragmentPlans/index.ts#L58"},"temp/components/src/fragments/FragmentPlans/index.ts:58")),(0,i.kt)("h2",{id:"methods"},"Methods"),(0,i.kt)("h3",{id:"create"},"create"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"create"),"(",(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,"Creates a new floor plan in the navigator."),(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"},"config")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"PlanView")),(0,i.kt)("td",{parentName:"tr",align:"left"},"Necessary data to initialize the floor plan.")))),(0,i.kt)("h4",{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-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/fragments/FragmentPlans/index.ts#L155"},"temp/components/src/fragments/FragmentPlans/index.ts:155")),(0,i.kt)("hr",null),(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-2"},"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-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/fragments/FragmentPlans/index.ts#L99"},"temp/components/src/fragments/FragmentPlans/index.ts:99")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"exitplanview"},"exitPlanView"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"exitPlanView"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"animate?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Deactivate navigator and go back to the previous view."),(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"},"Default value"),(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"},"animate")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"false")),(0,i.kt)("td",{parentName:"tr",align:"left"},"Whether to animate the camera transition.")))),(0,i.kt)("h4",{id:"returns-2"},"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-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/fragments/FragmentPlans/index.ts#L199"},"temp/components/src/fragments/FragmentPlans/index.ts:199")),(0,i.kt)("hr",null),(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"},"PlanView"),"[]"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,i.kt)("h4",{id:"returns-3"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"PlanView"),"[]"),(0,i.kt)("h4",{id:"overrides-1"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/fragments/FragmentPlans/index.ts#L94"},"temp/components/src/fragments/FragmentPlans/index.ts:94")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"goto"},"goTo"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"goTo"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"animate?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Make the navigator go to the specified floor plan."),(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)("th",{parentName:"tr",align:"left"},"Default value"),(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"},"id")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"undefined")),(0,i.kt)("td",{parentName:"tr",align:"left"},"Floor plan to go to.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"animate")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"false")),(0,i.kt)("td",{parentName:"tr",align:"left"},"Whether to animate the camera transition.")))),(0,i.kt)("h4",{id:"returns-4"},"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-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/fragments/FragmentPlans/index.ts#L174"},"temp/components/src/fragments/FragmentPlans/index.ts:174")),(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-5"},"Returns"),(0,i.kt)("p",null,"this is UI"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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-6"},"Returns"),(0,i.kt)("p",null,"this is Configurable"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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-7"},"Returns"),(0,i.kt)("p",null,"this is Disposable"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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-8"},"Returns"),(0,i.kt)("p",null,"this is Hideable"),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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-9"},"Returns"),(0,i.kt)("p",null,"this is Resizeable"),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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-10"},"Returns"),(0,i.kt)("p",null,"this is Updateable"),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/src/base-types/component.ts:45")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/9ba2e06a.c6268bc8.js b/build/assets/js/9ba2e06a.c6268bc8.js deleted file mode 100644 index 9e3443944..000000000 --- a/build/assets/js/9ba2e06a.c6268bc8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4073],{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 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 r(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var l=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):r(r({},t),e)),n},m=function(e){var t=o(e.components);return a.createElement(s.Provider,{value:t},e.children)},d="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,l=e.originalType,s=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),d=o(n),u=i,f=d["".concat(s,".").concat(u)]||d[u]||k[u]||l;return n?a.createElement(f,r(r({ref:t},m),{},{components:n})):a.createElement(f,r({ref:t},m))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var l=n.length,r=new Array(l);r[0]=u;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[d]="string"==typeof e?e:i,r[1]=p;for(var o=2;o{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>r,default:()=>k,frontMatter:()=>l,metadata:()=>p,toc:()=>o});var a=n(7462),i=(n(7294),n(3905));const l={id:"openbim_components.FragmentPlans",title:"Class: FragmentPlans",sidebar_label:"FragmentPlans",custom_edit_url:null},r=void 0,p={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"}},s={},o=[{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:"storeys",id:"storeys",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"uiElement",id:"uielement",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-5",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-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:"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-8",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-9",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-10",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-11",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-12",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-13",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-14",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-15",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-16",level:4}],m={toc:o},d="wrapper";function k(e){let{components:t,...n}=e;return(0,i.kt)(d,(0,a.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"),".FragmentPlans"),(0,i.kt)("p",null,"Helper to control the camera and easily define and navigate 2D floor plans."),(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)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"PlanView"),"[]",">"),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"FragmentPlans"))))),(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)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},(0,i.kt)("inlineCode",{parentName:"a"},"UI")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"currentplan"},"currentPlan"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"currentPlan"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"PlanView")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"null")),(0,i.kt)("p",null,"The floorplan that is currently selected."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/fragments/FragmentPlans/index.ts#L41"},"src/fragments/FragmentPlans/index.ts:41")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"defaultcameraoffset"},"defaultCameraOffset"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"defaultCameraOffset"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"30")),(0,i.kt)("p",null,"The offset of the 2D camera to the floor plan elevation."),(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/ifcjs/components/blob/e46138a/src/fragments/FragmentPlans/index.ts#L47"},"src/fragments/FragmentPlans/index.ts:47")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"defaultsectionoffset"},"defaultSectionOffset"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"defaultSectionOffset"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"1.5")),(0,i.kt)("p",null,"The offset from the clipping planes to their respective floor plan elevation."),(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/ifcjs/components/blob/e46138a/src/fragments/FragmentPlans/index.ts#L44"},"src/fragments/FragmentPlans/index.ts:44")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"enabled"},"enabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"enabled"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"false")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(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/ifcjs/components/blob/e46138a/src/fragments/FragmentPlans/index.ts#L38"},"src/fragments/FragmentPlans/index.ts:38")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"storeys"},"storeys"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"storeys"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"[]")),(0,i.kt)("p",null,"The created floor plans."),(0,i.kt)("h4",{id:"index-signature"},"Index signature"),(0,i.kt)("p",null,"\u25aa ","[modelID: ",(0,i.kt)("inlineCode",{parentName:"p"},"number"),"]",": ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),"[]"),(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/ifcjs/components/blob/e46138a/src/fragments/FragmentPlans/index.ts#L50"},"src/fragments/FragmentPlans/index.ts:50")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"uielement"},"uiElement"),(0,i.kt)("p",null,"\u2022 ",(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"},"commandsMenu"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"CommandsMenu"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"PlanView"),">"," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"defaultText"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"SimpleUIComponent"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"HTMLParagraphElement"),">"," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"exitButton"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Button")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"floatingWindow"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"FloatingWindow")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"main"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Button")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"planList"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"SimpleUIComponent"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"HTMLElement"),">"," }",">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI#uielement"},"UI.uiElement")),(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.UI"},"UI"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI#uielement"},"uiElement")),(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/ifcjs/components/blob/e46138a/src/fragments/FragmentPlans/index.ts#L55"},"src/fragments/FragmentPlans/index.ts:55")),(0,i.kt)("h2",{id:"methods"},"Methods"),(0,i.kt)("h3",{id:"create"},"create"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"create"),"(",(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,"Creates a new floor plan in the navigator."),(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"},"config")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"PlanView")),(0,i.kt)("td",{parentName:"tr",align:"left"},"Necessary data to initialize the floor plan.")))),(0,i.kt)("h4",{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-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/fragments/FragmentPlans/index.ts#L150"},"src/fragments/FragmentPlans/index.ts:150")),(0,i.kt)("hr",null),(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-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/fragments/FragmentPlans/index.ts#L96"},"src/fragments/FragmentPlans/index.ts:96")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"exitplanview"},"exitPlanView"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"exitPlanView"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"animate?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Deactivate navigator and go back to the previous view."),(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"},"Default value"),(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"},"animate")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"false")),(0,i.kt)("td",{parentName:"tr",align:"left"},"Whether to animate the camera transition.")))),(0,i.kt)("h4",{id:"returns-2"},"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-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/fragments/FragmentPlans/index.ts#L194"},"src/fragments/FragmentPlans/index.ts:194")),(0,i.kt)("hr",null),(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"},"PlanView"),"[]"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,i.kt)("h4",{id:"returns-3"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"PlanView"),"[]"),(0,i.kt)("h4",{id:"overrides-1"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/fragments/FragmentPlans/index.ts#L91"},"src/fragments/FragmentPlans/index.ts:91")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"goto"},"goTo"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"goTo"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"animate?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Make the navigator go to the specified floor plan."),(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)("th",{parentName:"tr",align:"left"},"Default value"),(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"},"id")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"undefined")),(0,i.kt)("td",{parentName:"tr",align:"left"},"Floor plan to go to.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"animate")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"false")),(0,i.kt)("td",{parentName:"tr",align:"left"},"Whether to animate the camera transition.")))),(0,i.kt)("h4",{id:"returns-4"},"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-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/fragments/FragmentPlans/index.ts#L169"},"src/fragments/FragmentPlans/index.ts:169")),(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-5"},"Returns"),(0,i.kt)("p",null,"this is UI"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L62"},"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-6"},"Returns"),(0,i.kt)("p",null,"this is Configurable"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L57"},"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-7"},"Returns"),(0,i.kt)("p",null,"this is Disposable"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L35"},"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-8"},"Returns"),(0,i.kt)("p",null,"this is Hideable"),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L52"},"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-9"},"Returns"),(0,i.kt)("p",null,"this is Resizeable"),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L40"},"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-10"},"Returns"),(0,i.kt)("p",null,"this is Updateable"),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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/9edcb13d.be4f8828.js b/build/assets/js/9edcb13d.be4f8828.js deleted file mode 100644 index c4210417a..000000000 --- a/build/assets/js/9edcb13d.be4f8828.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6599],{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 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 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",u={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,m=r(e,["components","mdxType","originalType","parentName"]),d=l(t),c=i,b=d["".concat(s,".").concat(c)]||d[c]||u[c]||p;return t?a.createElement(b,o(o({ref:n},m),{},{components:t})):a.createElement(b,o({ref:n},m))}));function b(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var p=t.length,o=new Array(p);o[0]=c;var r={};for(var s in n)hasOwnProperty.call(n,s)&&(r[s]=n[s]);r.originalType=e,r[d]="string"==typeof e?e:i,o[1]=r;for(var l=2;l{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>o,default:()=>u,frontMatter:()=>p,metadata:()=>r,toc:()=>l});var a=t(7462),i=(t(7294),t(3905));const p={id:"openbim_components.CubeMap",title:"Class: CubeMap",sidebar_label:"CubeMap",custom_edit_url:null},o=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"}},s={},l=[{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:"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-4",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-5",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-6",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-7",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-8",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-9",level:4}],m={toc:l},d="wrapper";function u(e){let{components:n,...t}=e;return(0,i.kt)(d,(0,a.Z)({},m,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".CubeMap"),(0,i.kt)("p",null,"A simple navigation cube to zoom the scene to its basic views (top, bottom,\nleft, right, back and front)."),(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)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"HTMLDivElement"),">"),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"CubeMap"))))),(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.Updateable"},(0,i.kt)("inlineCode",{parentName:"a"},"Updateable"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Hideable"},(0,i.kt)("inlineCode",{parentName:"a"},"Hideable"))),(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:"enabled"},"enabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"enabled"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"true")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/navigation/CubeMap/index.ts#L37"},"src/navigation/CubeMap/index.ts:37")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"offset"},"offset"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"offset"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"1")),(0,i.kt)("p",null,"The minimum zoom distance to the scene."),(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/ifcjs/components/blob/e46138a/src/navigation/CubeMap/index.ts#L46"},"src/navigation/CubeMap/index.ts:46")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.CubeMap"},(0,i.kt)("inlineCode",{parentName:"a"},"CubeMap")),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"Updateable.onAfterUpdate")),(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.Updateable"},"Updateable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"onAfterUpdate")),(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/ifcjs/components/blob/e46138a/src/navigation/CubeMap/index.ts#L40"},"src/navigation/CubeMap/index.ts:40")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.CubeMap"},(0,i.kt)("inlineCode",{parentName:"a"},"CubeMap")),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"Updateable.onBeforeUpdate")),(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.Updateable"},"Updateable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"onBeforeUpdate")),(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/ifcjs/components/blob/e46138a/src/navigation/CubeMap/index.ts#L43"},"src/navigation/CubeMap/index.ts:43")),(0,i.kt)("h2",{id:"methods"},"Methods"),(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"},"Returns"),(0,i.kt)("p",null,"this is UI"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L62"},"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-1"},"Returns"),(0,i.kt)("p",null,"this is Configurable"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L57"},"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-2"},"Returns"),(0,i.kt)("p",null,"this is Disposable"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L35"},"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-3"},"Returns"),(0,i.kt)("p",null,"this is Hideable"),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L52"},"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-4"},"Returns"),(0,i.kt)("p",null,"this is Resizeable"),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L40"},"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-5"},"Returns"),(0,i.kt)("p",null,"this is Updateable"),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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/9edcb13d.fa60f167.js b/build/assets/js/9edcb13d.fa60f167.js new file mode 100644 index 000000000..fdb6fabb1 --- /dev/null +++ b/build/assets/js/9edcb13d.fa60f167.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6599],{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 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",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=s(e,["components","mdxType","originalType","parentName"]),d=r(t),u=i,b=d["".concat(l,".").concat(u)]||d[u]||c[u]||p;return t?a.createElement(b,o(o({ref:n},m),{},{components:t})):a.createElement(b,o({ref:n},m))}));function b(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var p=t.length,o=new Array(p);o[0]=u;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:()=>l,contentTitle:()=>o,default:()=>c,frontMatter:()=>p,metadata:()=>s,toc:()=>r});var a=t(7462),i=(t(7294),t(3905));const p={id:"openbim_components.CubeMap",title:"Class: CubeMap",sidebar_label:"CubeMap",custom_edit_url:null},o=void 0,s={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"}},l={},r=[{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}],m={toc:r},d="wrapper";function c(e){let{components:n,...t}=e;return(0,i.kt)(d,(0,a.Z)({},m,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".CubeMap"),(0,i.kt)("p",null,"A simple navigation cube to zoom the scene to its basic views (top, bottom,\nleft, right, back and front)."),(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)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"HTMLDivElement"),">"),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"CubeMap"))))),(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.Updateable"},(0,i.kt)("inlineCode",{parentName:"a"},"Updateable"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Hideable"},(0,i.kt)("inlineCode",{parentName:"a"},"Hideable"))),(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:"enabled"},"enabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"enabled"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"true")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/navigation/CubeMap/index.ts#L40"},"temp/components/src/navigation/CubeMap/index.ts:40")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"offset"},"offset"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"offset"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"1")),(0,i.kt)("p",null,"The minimum zoom distance to the scene."),(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/IFCjs/components/blob/0c38d20/src/navigation/CubeMap/index.ts#L49"},"temp/components/src/navigation/CubeMap/index.ts:49")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.CubeMap"},(0,i.kt)("inlineCode",{parentName:"a"},"CubeMap")),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"Updateable.onAfterUpdate")),(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.Updateable"},"Updateable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"onAfterUpdate")),(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/IFCjs/components/blob/0c38d20/src/navigation/CubeMap/index.ts#L43"},"temp/components/src/navigation/CubeMap/index.ts:43")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.CubeMap"},(0,i.kt)("inlineCode",{parentName:"a"},"CubeMap")),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"Updateable.onBeforeUpdate")),(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.Updateable"},"Updateable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"onBeforeUpdate")),(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/IFCjs/components/blob/0c38d20/src/navigation/CubeMap/index.ts#L46"},"temp/components/src/navigation/CubeMap/index.ts:46")),(0,i.kt)("hr",null),(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"},"string"),">"),(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-2"},"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-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/navigation/CubeMap/index.ts#L37"},"temp/components/src/navigation/CubeMap/index.ts:37")),(0,i.kt)("h2",{id:"methods"},"Methods"),(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"},"Returns"),(0,i.kt)("p",null,"this is UI"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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-1"},"Returns"),(0,i.kt)("p",null,"this is Configurable"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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-2"},"Returns"),(0,i.kt)("p",null,"this is Disposable"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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-3"},"Returns"),(0,i.kt)("p",null,"this is Hideable"),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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-4"},"Returns"),(0,i.kt)("p",null,"this is Resizeable"),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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-5"},"Returns"),(0,i.kt)("p",null,"this is Updateable"),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/src/base-types/component.ts:45")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/a1cfb745.5cddca9b.js b/build/assets/js/a7434565.8a3a8041.js similarity index 62% rename from build/assets/js/a1cfb745.5cddca9b.js rename to build/assets/js/a7434565.8a3a8041.js index c016dc0e6..ec70f6228 100644 --- a/build/assets/js/a1cfb745.5cddca9b.js +++ b/build/assets/js/a7434565.8a3a8041.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6796],{5745:s=>{s.exports=JSON.parse('{"name":"docusaurus-plugin-content-pages","id":"default"}')}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7645],{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/a94c8b81.020319a8.js b/build/assets/js/a94c8b81.7c6bf0a2.js similarity index 88% rename from build/assets/js/a94c8b81.020319a8.js rename to build/assets/js/a94c8b81.7c6bf0a2.js index 4d69fa1f9..656c76cb9 100644 --- a/build/assets/js/a94c8b81.020319a8.js +++ b/build/assets/js/a94c8b81.7c6bf0a2.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 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 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 p(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}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",f={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,o=e.mdxType,a=e.originalType,l=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),m=s(n),d=o,u=m["".concat(l,".").concat(d)]||m[d]||f[d]||a;return n?r.createElement(u,p(p({ref:t},c),{},{components:n})):r.createElement(u,p({ref:t},c))}));function u(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=n.length,p=new Array(a);p[0]=d;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[m]="string"==typeof e?e:o,p[1]=i;for(var s=2;s{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>f,frontMatter:()=>a,metadata:()=>i,toc:()=>s});var r=n(7462),o=(n(7294),n(3905));const a={id:"openbim_components.IfcJsonExporter",title:"Class: IfcJsonExporter",sidebar_label:"IfcJsonExporter",custom_edit_url:null},p=void 0,i={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:"LengthMeasurement",permalink:"/api/classes/openbim_components.LengthMeasurement"}},l={},s=[{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}],c={toc:s},m="wrapper";function f(e){let{components:t,...n}=e;return(0,o.kt)(m,(0,r.Z)({},c,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"},"Promise"),"<",(0,o.kt)("inlineCode",{parentName:"p"},"void"),">"),(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)("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)("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)("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)("p",null,(0,o.kt)("strong",{parentName:"p"},(0,o.kt)("inlineCode",{parentName:"strong"},"Web Ifc"))),(0,o.kt)("p",null,"The instance of ","[web-ifc][https://github.com/ifcjs/web-ifc]","(",(0,o.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/web-ifc"},"https://github.com/ifcjs/web-ifc"),") to use."),(0,o.kt)("p",null,(0,o.kt)("strong",{parentName:"p"},(0,o.kt)("inlineCode",{parentName:"strong"},"Model ID"))),(0,o.kt)("p",null,"ID of the IFC model whose properties to extract."),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/ifc/IfcJsonExporter/index.ts#L21"},"src/ifc/IfcJsonExporter/index.ts:21")))}f.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 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 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 p(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}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)}},f=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),m=s(n),f=o,u=m["".concat(l,".").concat(f)]||m[f]||d[f]||a;return n?r.createElement(u,p(p({ref:t},c),{},{components:n})):r.createElement(u,p({ref:t},c))}));function u(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=n.length,p=new Array(a);p[0]=f;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[m]="string"==typeof e?e:o,p[1]=i;for(var s=2;s{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>d,frontMatter:()=>a,metadata:()=>i,toc:()=>s});var r=n(7462),o=(n(7294),n(3905));const a={id:"openbim_components.IfcJsonExporter",title:"Class: IfcJsonExporter",sidebar_label:"IfcJsonExporter",custom_edit_url:null},p=void 0,i={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:"LengthMeasurement",permalink:"/api/classes/openbim_components.LengthMeasurement"}},l={},s=[{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}],c={toc:s},m="wrapper";function d(e){let{components:t,...n}=e;return(0,o.kt)(m,(0,r.Z)({},c,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"},"Promise"),"<",(0,o.kt)("inlineCode",{parentName:"p"},"void"),">"),(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)("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)("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)("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)("p",null,(0,o.kt)("strong",{parentName:"p"},(0,o.kt)("inlineCode",{parentName:"strong"},"Web Ifc"))),(0,o.kt)("p",null,"The instance of ","[web-ifc][https://github.com/ifcjs/web-ifc]","(",(0,o.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/web-ifc"},"https://github.com/ifcjs/web-ifc"),") to use."),(0,o.kt)("p",null,(0,o.kt)("strong",{parentName:"p"},(0,o.kt)("inlineCode",{parentName:"strong"},"Model ID"))),(0,o.kt)("p",null,"ID of the IFC model whose properties to extract."),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/ifc/IfcJsonExporter/index.ts#L21"},"temp/components/src/ifc/IfcJsonExporter/index.ts:21")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/ab682f67.18e71643.js b/build/assets/js/ab682f67.18e71643.js new file mode 100644 index 000000000..703bd4a21 --- /dev/null +++ b/build/assets/js/ab682f67.18e71643.js @@ -0,0 +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 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 a=o.createContext({}),l=function(e){var t=o.useContext(a),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(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=p(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,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 p={};for(var a in t)hasOwnProperty.call(t,a)&&(p[a]=t[a]);p.originalType=e,p[c]="string"==typeof e?e:s,r[1]=p;for(var l=2;l{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>r,default:()=>d,frontMatter:()=>i,metadata:()=>p,toc:()=>l});var o=n(7462),s=(n(7294),n(3905));const i={id:"openbim_components.Mouse",title:"Class: Mouse",sidebar_label:"Mouse",custom_edit_url:null},r=void 0,p={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"}},a={},l=[{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}],m={toc:l},c="wrapper";function d(e){let{components:t,...n}=e;return(0,s.kt)(c,(0,o.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Mouse"),(0,s.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,s.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,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/IFCjs/components/blob/0c38d20/src/base-types/mouse.ts#L15"},"temp/components/src/base-types/mouse.ts:15")),(0,s.kt)("h2",{id:"accessors"},"Accessors"),(0,s.kt)("h3",{id:"position"},"position"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"position"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,s.kt)("p",null,"The real position of the mouse of the Three.js canvas."),(0,s.kt)("h4",{id:"returns"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"Vector2")),(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/IFCjs/components/blob/0c38d20/src/base-types/mouse.ts#L24"},"temp/components/src/base-types/mouse.ts:24")),(0,s.kt)("h2",{id:"methods"},"Methods"),(0,s.kt)("h3",{id:"dispose"},"dispose"),(0,s.kt)("p",null,"\u25b8 ",(0,s.kt)("strong",{parentName:"p"},"dispose"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,s.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(0,s.kt)("h4",{id:"returns-1"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,s.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,s.kt)("h4",{id:"implementation-of-1"},"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#dispose"},"dispose")),(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/IFCjs/components/blob/0c38d20/src/base-types/mouse.ts#L34"},"temp/components/src/base-types/mouse.ts:34")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/ab682f67.da1a14fc.js b/build/assets/js/ab682f67.da1a14fc.js deleted file mode 100644 index ebc5c0fb4..000000000 --- a/build/assets/js/ab682f67.da1a14fc.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1349],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>f});var o=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 s(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 i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=o.createContext({}),l=function(e){var t=o.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},c=function(e){var t=l(e.components);return o.createElement(p.Provider,{value:t},e.children)},m="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},d=o.forwardRef((function(e,t){var n=e.components,r=e.mdxType,s=e.originalType,p=e.parentName,c=a(e,["components","mdxType","originalType","parentName"]),m=l(n),d=r,f=m["".concat(p,".").concat(d)]||m[d]||u[d]||s;return n?o.createElement(f,i(i({ref:t},c),{},{components:n})):o.createElement(f,i({ref:t},c))}));function f(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var s=n.length,i=new Array(s);i[0]=d;var a={};for(var p in t)hasOwnProperty.call(t,p)&&(a[p]=t[p]);a.originalType=e,a[m]="string"==typeof e?e:r,i[1]=a;for(var l=2;l{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>u,frontMatter:()=>s,metadata:()=>a,toc:()=>l});var o=n(7462),r=(n(7294),n(3905));const s={id:"openbim_components.Mouse",title:"Class: Mouse",sidebar_label:"Mouse",custom_edit_url:null},i=void 0,a={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"}},p={},l=[{value:"Implements",id:"implements",level:2},{value:"Accessors",id:"accessors",level:2},{value:"position",id:"position",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",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",level:4},{value:"Defined in",id:"defined-in-1",level:4}],c={toc:l},m="wrapper";function u(e){let{components:t,...n}=e;return(0,r.kt)(m,(0,o.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"),".Mouse"),(0,r.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,r.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,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:"accessors"},"Accessors"),(0,r.kt)("h3",{id:"position"},"position"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"position"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,r.kt)("p",null,"The real position of the mouse of the Three.js canvas."),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/mouse.ts#L21"},"src/base-types/mouse.ts:21")),(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-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"},"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-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/mouse.ts#L31"},"src/base-types/mouse.ts:31")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/addcbcd0.01501fb0.js b/build/assets/js/addcbcd0.01501fb0.js new file mode 100644 index 000000000..f7ddb20f7 --- /dev/null +++ b/build/assets/js/addcbcd0.01501fb0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6934],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,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 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",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,d=l(e,["components","mdxType","originalType","parentName"]),m=o(t),u=i,k=m["".concat(s,".").concat(u)]||m[u]||c[u]||p;return t?a.createElement(k,r(r({ref:n},d),{},{components:t})):a.createElement(k,r({ref:n},d))}));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 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:()=>s,contentTitle:()=>r,default:()=>c,frontMatter:()=>p,metadata:()=>l,toc:()=>o});var a=t(7462),i=(t(7294),t(3905));const p={id:"openbim_components.BaseRenderer",title:"Class: BaseRenderer",sidebar_label:"BaseRenderer",custom_edit_url:null},r=void 0,l={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"}},s={},o=[{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}],d={toc:o},m="wrapper";function c(e){let{components:n,...t}=e;return(0,i.kt)(m,(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"),".BaseRenderer"),(0,i.kt)("p",null,"A base component for other components whose main mission is to render a\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/scenes/Scene"},"scene"),"."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"No Inherit Doc"))),(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)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"THREE.WebGLRenderer"),">"),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"BaseRenderer"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleRenderer"))))),(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.Resizeable"},(0,i.kt)("inlineCode",{parentName:"a"},"Resizeable")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"clippingplanes"},"clippingPlanes"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"clippingPlanes"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Plane"),"[] = ",(0,i.kt)("inlineCode",{parentName:"p"},"[]")),(0,i.kt)("p",null,"The list of ",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer.clippingPlanes"},"clipping planes")," used by this\ninstance of the renderer."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/base-renderer.ts#L33"},"temp/components/src/base-types/base-renderer.ts:33")),(0,i.kt)("hr",null),(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:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L24"},"temp/components/src/base-types/component.ts:24")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onclippingplanesupdated"},"onClippingPlanesUpdated"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onClippingPlanesUpdated"),": ",(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"},"unknown"),">"),(0,i.kt)("p",null,"Event that fires when there has been a change to the list of clipping\nplanes used by the active renderer."),(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/IFCjs/components/blob/0c38d20/src/base-types/base-renderer.ts#L27"},"temp/components/src/base-types/base-renderer.ts:27")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onresize"},"onResize"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(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"},"any"),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#onresize"},"Resizeable.onResize")),(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.Resizeable"},"Resizeable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#onresize"},"onResize")),(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/IFCjs/components/blob/0c38d20/src/base-types/base-renderer.ts#L21"},"temp/components/src/base-types/base-renderer.ts:21")),(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"},"WebGLRenderer")),(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"},"WebGLRenderer")),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L30"},"temp/components/src/base-types/component.ts:30")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getsize"},"getSize"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"getSize"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#getsize"},"Resizeable.getSize"),"."),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Vector2")),(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.Resizeable"},"Resizeable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#getsize"},"getSize")),(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/IFCjs/components/blob/0c38d20/src/base-types/base-renderer.ts#L15"},"temp/components/src/base-types/base-renderer.ts:15")),(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-2"},"Returns"),(0,i.kt)("p",null,"this is UI"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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-3"},"Returns"),(0,i.kt)("p",null,"this is Configurable"),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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-4"},"Returns"),(0,i.kt)("p",null,"this is Disposable"),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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-5"},"Returns"),(0,i.kt)("p",null,"this is Hideable"),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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-6"},"Returns"),(0,i.kt)("p",null,"this is Resizeable"),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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-7"},"Returns"),(0,i.kt)("p",null,"this is Updateable"),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/src/base-types/component.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"resize"},"resize"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"resize"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#resize"},"Resizeable.resize"),"."),(0,i.kt)("h4",{id:"returns-8"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#resize"},"resize")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/base-renderer.ts#L18"},"temp/components/src/base-types/base-renderer.ts:18")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"toggleplane"},"togglePlane"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"togglePlane"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"active"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"plane"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"isLocal?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Adds or removes a\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer.clippingPlanes"},"clipping plane"),"\nto the renderer."),(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)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"active")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"plane")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Plane"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"isLocal?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,i.kt)("h4",{id:"returns-9"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/base-renderer.ts#L48"},"temp/components/src/base-types/base-renderer.ts:48")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"updateclippingplanes"},"updateClippingPlanes"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"updateClippingPlanes"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Forces the update of the clipping planes and all components that depend\non them that are subscribed to ",(0,i.kt)("inlineCode",{parentName:"p"},"onClippingPlanesUpdated"),"."),(0,i.kt)("h4",{id:"returns-10"},"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-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/base-renderer.ts#L39"},"temp/components/src/base-types/base-renderer.ts:39")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/addcbcd0.3d8c63c6.js b/build/assets/js/addcbcd0.3d8c63c6.js deleted file mode 100644 index 67b7fbfbb..000000000 --- a/build/assets/js/addcbcd0.3d8c63c6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6934],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,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 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,k=m["".concat(s,".").concat(u)]||m[u]||c[u]||r;return t?a.createElement(k,p(p({ref:n},d),{},{components:t})):a.createElement(k,p({ref:n},d))}));function k(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:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>r,metadata:()=>l,toc:()=>o});var a=t(7462),i=(t(7294),t(3905));const r={id:"openbim_components.BaseRenderer",title:"Class: BaseRenderer",sidebar_label:"BaseRenderer",custom_edit_url:null},p=void 0,l={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"}},s={},o=[{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}],d={toc:o},m="wrapper";function c(e){let{components:n,...t}=e;return(0,i.kt)(m,(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"),".BaseRenderer"),(0,i.kt)("p",null,"A base component for other components whose main mission is to render a\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/scenes/Scene"},"scene"),"."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"No Inherit Doc"))),(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)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"THREE.WebGLRenderer"),">"),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"BaseRenderer"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleRenderer"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleRenderer"))))),(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.Resizeable"},(0,i.kt)("inlineCode",{parentName:"a"},"Resizeable")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"clippingplanes"},"clippingPlanes"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"clippingPlanes"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Plane"),"[] = ",(0,i.kt)("inlineCode",{parentName:"p"},"[]")),(0,i.kt)("p",null,"The list of ",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer.clippingPlanes"},"clipping planes")," used by this\ninstance of the renderer."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/base-renderer.ts#L33"},"src/base-types/base-renderer.ts:33")),(0,i.kt)("hr",null),(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:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L24"},"src/base-types/component.ts:24")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onclippingplanesupdated"},"onClippingPlanesUpdated"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onClippingPlanesUpdated"),": ",(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"},"unknown"),">"),(0,i.kt)("p",null,"Event that fires when there has been a change to the list of clipping\nplanes used by the active renderer."),(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/ifcjs/components/blob/e46138a/src/base-types/base-renderer.ts#L27"},"src/base-types/base-renderer.ts:27")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onresize"},"onResize"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(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"},"any"),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#onresize"},"Resizeable.onResize")),(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.Resizeable"},"Resizeable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#onresize"},"onResize")),(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/ifcjs/components/blob/e46138a/src/base-types/base-renderer.ts#L21"},"src/base-types/base-renderer.ts:21")),(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"},"WebGLRenderer")),(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"},"WebGLRenderer")),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L30"},"src/base-types/component.ts:30")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getsize"},"getSize"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"getSize"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#getsize"},"Resizeable.getSize"),"."),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Vector2")),(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.Resizeable"},"Resizeable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#getsize"},"getSize")),(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/ifcjs/components/blob/e46138a/src/base-types/base-renderer.ts#L15"},"src/base-types/base-renderer.ts:15")),(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-2"},"Returns"),(0,i.kt)("p",null,"this is UI"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L62"},"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-3"},"Returns"),(0,i.kt)("p",null,"this is Configurable"),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L57"},"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-4"},"Returns"),(0,i.kt)("p",null,"this is Disposable"),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L35"},"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-5"},"Returns"),(0,i.kt)("p",null,"this is Hideable"),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L52"},"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-6"},"Returns"),(0,i.kt)("p",null,"this is Resizeable"),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L40"},"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-7"},"Returns"),(0,i.kt)("p",null,"this is Updateable"),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"resize"},"resize"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"resize"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#resize"},"Resizeable.resize"),"."),(0,i.kt)("h4",{id:"returns-8"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Resizeable#resize"},"resize")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/base-renderer.ts#L18"},"src/base-types/base-renderer.ts:18")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"toggleplane"},"togglePlane"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"togglePlane"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"active"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"plane"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"isLocal?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Adds or removes a\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer.clippingPlanes"},"clipping plane"),"\nto the renderer."),(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)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"active")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"plane")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Plane"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"isLocal?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,i.kt)("h4",{id:"returns-9"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/base-renderer.ts#L48"},"src/base-types/base-renderer.ts:48")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"updateclippingplanes"},"updateClippingPlanes"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"updateClippingPlanes"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Forces the update of the clipping planes and all components that depend\non them that are subscribed to ",(0,i.kt)("inlineCode",{parentName:"p"},"onClippingPlanesUpdated"),"."),(0,i.kt)("h4",{id:"returns-10"},"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-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/base-renderer.ts#L39"},"src/base-types/base-renderer.ts:39")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/afcc017a.76726ddb.js b/build/assets/js/afcc017a.c8fb8baf.js similarity index 66% rename from build/assets/js/afcc017a.76726ddb.js rename to build/assets/js/afcc017a.c8fb8baf.js index 66bd9d891..58cc22e29 100644 --- a/build/assets/js/afcc017a.76726ddb.js +++ b/build/assets/js/afcc017a.c8fb8baf.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:()=>p,contentTitle:()=>a,default:()=>m,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var r=n(7462),o=(n(7294),n(3905));const i={id:"openbim_components.Progress",title:"Interface: Progress",sidebar_label:"Progress",custom_edit_url:null},a=void 0,s={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"}},p={},l=[{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}],c={toc:l},u="wrapper";function m(e){let{components:t,...n}=e;return(0,o.kt)(u,(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Progress"),(0,o.kt)("p",null,"Basic type to describe the progress of any kind of process."),(0,o.kt)("h2",{id:"properties"},"Properties"),(0,o.kt)("h3",{id:"current"},"current"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"current"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("p",null,"The amount of things that have been done already."),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L120"},"src/base-types/base-types.ts:120")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"total"},"total"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"total"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("p",null,"The total amount of things to be done by the process."),(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/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L123"},"src/base-types/base-types.ts:123")))}m.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:()=>f});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 s(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):s(s({},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)}},d=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,p=e.parentName,c=a(e,["components","mdxType","originalType","parentName"]),u=l(n),d=o,f=u["".concat(p,".").concat(d)]||u[d]||m[d]||i;return n?r.createElement(f,s(s({ref:t},c),{},{components:n})):r.createElement(f,s({ref:t},c))}));function f(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,s=new Array(i);s[0]=d;var a={};for(var p in t)hasOwnProperty.call(t,p)&&(a[p]=t[p]);a.originalType=e,a[u]="string"==typeof e?e:o,s[1]=a;for(var l=2;l{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>m,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var r=n(7462),o=(n(7294),n(3905));const i={id:"openbim_components.Progress",title:"Interface: Progress",sidebar_label:"Progress",custom_edit_url:null},s=void 0,a={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"}},p={},l=[{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}],c={toc:l},u="wrapper";function m(e){let{components:t,...n}=e;return(0,o.kt)(u,(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".Progress"),(0,o.kt)("p",null,"Basic type to describe the progress of any kind of process."),(0,o.kt)("h2",{id:"properties"},"Properties"),(0,o.kt)("h3",{id:"current"},"current"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"current"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("p",null,"The amount of things that have been done already."),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L124"},"temp/components/src/base-types/base-types.ts:124")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"total"},"total"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"total"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("p",null,"The total amount of things to be done by the process."),(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/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L127"},"temp/components/src/base-types/base-types.ts:127")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/b82b585f.88041d93.js b/build/assets/js/b82b585f.88041d93.js deleted file mode 100644 index b786fec5e..000000000 --- a/build/assets/js/b82b585f.88041d93.js +++ /dev/null @@ -1 +0,0 @@ -"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 o=a.createContext({}),s=function(e){var t=a.useContext(o),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(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,i=e.mdxType,p=e.originalType,o=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),d=s(n),u=i,k=d["".concat(o,".").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 l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l[d]="string"==typeof e?e:i,r[1]=l;for(var s=2;s{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>r,default:()=>c,frontMatter:()=>p,metadata:()=>l,toc:()=>s});var a=n(7462),i=(n(7294),n(3905));const p={id:"openbim_components.SimpleCamera",title:"Class: SimpleCamera",sidebar_label:"SimpleCamera",custom_edit_url:null},r=void 0,l={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"}},o={},s=[{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:"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:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-6",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-7",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-8",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-9",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-10",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-11",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-12",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-13",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-3",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"updateAspect",id:"updateaspect",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-15",level:4}],m={toc:s},d="wrapper";function c(e){let{components:t,...n}=e;return(0,i.kt)(d,(0,a.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"),".SimpleCamera"),(0,i.kt)("p",null,"A basic camera that uses\n",(0,i.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,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)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"THREE.PerspectiveCamera")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"THREE.OrthographicCamera"),">"),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"SimpleCamera"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.OrthoPerspectiveCamera"},(0,i.kt)("inlineCode",{parentName:"a"},"OrthoPerspectiveCamera"))))),(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.Updateable"},(0,i.kt)("inlineCode",{parentName:"a"},"Updateable"))),(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:"activecamera"},"activeCamera"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"activeCamera"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"PerspectiveCamera")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,i.kt)("p",null,"The camera that is being used now according to the current ",(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection"),"."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleCamera/index.ts#L45"},"src/core/SimpleCamera/index.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"controls"},"controls"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"controls"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"CameraControls")),(0,i.kt)("p",null,"The object that controls the camera. An instance of\n",(0,i.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,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleCamera/index.ts#L30"},"src/core/SimpleCamera/index.ts:30")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleCamera")),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"Updateable.onAfterUpdate")),(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.Updateable"},"Updateable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"onAfterUpdate")),(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/ifcjs/components/blob/e46138a/src/core/SimpleCamera/index.ts#L20"},"src/core/SimpleCamera/index.ts:20")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleCamera")),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"Updateable.onBeforeUpdate")),(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.Updateable"},"Updateable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"onBeforeUpdate")),(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/ifcjs/components/blob/e46138a/src/core/SimpleCamera/index.ts#L17"},"src/core/SimpleCamera/index.ts:17")),(0,i.kt)("h2",{id:"accessors"},"Accessors"),(0,i.kt)("h3",{id:"enabled"},"enabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"enabled"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,"Component.enabled"),(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/ifcjs/components/blob/e46138a/src/core/SimpleCamera/index.ts#L33"},"src/core/SimpleCamera/index.ts:33")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"enabled"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"enabled"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(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"},"enabled")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))))),(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:"overrides-1"},"Overrides"),(0,i.kt)("p",null,"Component.enabled"),(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/ifcjs/components/blob/e46138a/src/core/SimpleCamera/index.ts#L38"},"src/core/SimpleCamera/index.ts:38")),(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-2"},"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-2"},"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-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleCamera/index.ts#L65"},"src/core/SimpleCamera/index.ts:65")),(0,i.kt)("hr",null),(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"},"PerspectiveCamera")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,i.kt)("h4",{id:"returns-3"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"PerspectiveCamera")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,i.kt)("h4",{id:"overrides-2"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(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/ifcjs/components/blob/e46138a/src/core/SimpleCamera/index.ts#L60"},"src/core/SimpleCamera/index.ts:60")),(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-4"},"Returns"),(0,i.kt)("p",null,"this is UI"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L62"},"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-5"},"Returns"),(0,i.kt)("p",null,"this is Configurable"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L57"},"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-6"},"Returns"),(0,i.kt)("p",null,"this is Disposable"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L35"},"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-7"},"Returns"),(0,i.kt)("p",null,"this is Hideable"),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L52"},"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-8"},"Returns"),(0,i.kt)("p",null,"this is Resizeable"),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L40"},"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-9"},"Returns"),(0,i.kt)("p",null,"this is Updateable"),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"update"},"update"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"update"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"_delta"),"): ",(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.Updateable#update"},"Updateable.update")),(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)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"_delta")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))))),(0,i.kt)("h4",{id:"returns-10"},"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-3"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"update")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleCamera/index.ts#L76"},"src/core/SimpleCamera/index.ts:76")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"updateaspect"},"updateAspect"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"updateAspect"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Updates the aspect of the camera to match the size of the\n",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Components#renderer"},"Components.renderer"),"."),(0,i.kt)("h4",{id:"returns-11"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleCamera/index.ts#L88"},"src/core/SimpleCamera/index.ts:88")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/b82b585f.bbbd56a2.js b/build/assets/js/b82b585f.bbbd56a2.js new file mode 100644 index 000000000..659b092c9 --- /dev/null +++ b/build/assets/js/b82b585f.bbbd56a2.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:()=>l,contentTitle:()=>r,default:()=>c,frontMatter:()=>p,metadata:()=>o,toc:()=>s});var a=n(7462),i=(n(7294),n(3905));const p={id:"openbim_components.SimpleCamera",title:"Class: SimpleCamera",sidebar_label:"SimpleCamera",custom_edit_url:null},r=void 0,o={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"}},l={},s=[{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}],m={toc:s},d="wrapper";function c(e){let{components:t,...n}=e;return(0,i.kt)(d,(0,a.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"),".SimpleCamera"),(0,i.kt)("p",null,"A basic camera that uses\n",(0,i.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,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)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"THREE.PerspectiveCamera")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"THREE.OrthographicCamera"),">"),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"SimpleCamera"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.OrthoPerspectiveCamera"},(0,i.kt)("inlineCode",{parentName:"a"},"OrthoPerspectiveCamera"))))),(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.Updateable"},(0,i.kt)("inlineCode",{parentName:"a"},"Updateable"))),(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:"activecamera"},"activeCamera"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"activeCamera"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"PerspectiveCamera")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,i.kt)("p",null,"The camera that is being used now according to the current ",(0,i.kt)("a",{parentName:"p",href:"/api/modules/openbim_components#cameraprojection"},"CameraProjection"),"."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleCamera/index.ts#L48"},"temp/components/src/core/SimpleCamera/index.ts:48")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"controls"},"controls"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"controls"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"CameraControls")),(0,i.kt)("p",null,"The object that controls the camera. An instance of\n",(0,i.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,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleCamera/index.ts#L33"},"temp/components/src/core/SimpleCamera/index.ts:33")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleCamera")),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"Updateable.onAfterUpdate")),(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.Updateable"},"Updateable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"onAfterUpdate")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleCamera/index.ts#L20"},"temp/components/src/core/SimpleCamera/index.ts:20")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleCamera"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleCamera")),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"Updateable.onBeforeUpdate")),(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.Updateable"},"Updateable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"onBeforeUpdate")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleCamera/index.ts#L17"},"temp/components/src/core/SimpleCamera/index.ts:17")),(0,i.kt)("hr",null),(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"},"string"),">"),(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-2"},"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-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleCamera/index.ts#L25"},"temp/components/src/core/SimpleCamera/index.ts:25")),(0,i.kt)("h2",{id:"accessors"},"Accessors"),(0,i.kt)("h3",{id:"enabled"},"enabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"enabled"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,"Component.enabled"),(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/IFCjs/components/blob/0c38d20/src/core/SimpleCamera/index.ts#L36"},"temp/components/src/core/SimpleCamera/index.ts:36")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"enabled"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"enabled"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(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"},"enabled")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))))),(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:"overrides-1"},"Overrides"),(0,i.kt)("p",null,"Component.enabled"),(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/IFCjs/components/blob/0c38d20/src/core/SimpleCamera/index.ts#L41"},"temp/components/src/core/SimpleCamera/index.ts:41")),(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-2"},"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-3"},"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-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleCamera/index.ts#L68"},"temp/components/src/core/SimpleCamera/index.ts:68")),(0,i.kt)("hr",null),(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"},"PerspectiveCamera")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,i.kt)("h4",{id:"returns-3"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"PerspectiveCamera")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"OrthographicCamera")),(0,i.kt)("h4",{id:"overrides-2"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleCamera/index.ts#L63"},"temp/components/src/core/SimpleCamera/index.ts:63")),(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-4"},"Returns"),(0,i.kt)("p",null,"this is UI"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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-5"},"Returns"),(0,i.kt)("p",null,"this is Configurable"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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-6"},"Returns"),(0,i.kt)("p",null,"this is Disposable"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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-7"},"Returns"),(0,i.kt)("p",null,"this is Hideable"),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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-8"},"Returns"),(0,i.kt)("p",null,"this is Resizeable"),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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-9"},"Returns"),(0,i.kt)("p",null,"this is Updateable"),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/src/base-types/component.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"update"},"update"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"update"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"_delta"),"): ",(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.Updateable#update"},"Updateable.update")),(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)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"_delta")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))))),(0,i.kt)("h4",{id:"returns-10"},"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-4"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"update")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleCamera/index.ts#L81"},"temp/components/src/core/SimpleCamera/index.ts:81")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"updateaspect"},"updateAspect"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"updateAspect"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Updates the aspect of the camera to match the size of the\n",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Components#renderer"},"Components.renderer"),"."),(0,i.kt)("h4",{id:"returns-11"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleCamera/index.ts#L93"},"temp/components/src/core/SimpleCamera/index.ts:93")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/b82c8867.3387986f.js b/build/assets/js/b82c8867.3387986f.js deleted file mode 100644 index 2e6e068b2..000000000 --- a/build/assets/js/b82c8867.3387986f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5972],{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 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},m=function(e){var t=s(e.components);return a.createElement(o.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,o=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),d=s(n),k=i,f=d["".concat(o,".").concat(k)]||d[k]||u[k]||r;return n?a.createElement(f,l(l({ref:t},m),{},{components:n})):a.createElement(f,l({ref:t},m))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,l=new Array(r);l[0]=k;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[d]="string"==typeof e?e:i,l[1]=p;for(var s=2;s{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>u,frontMatter:()=>r,metadata:()=>p,toc:()=>s});var a=n(7462),i=(n(7294),n(3905));const r={id:"openbim_components.LengthMeasurement",title:"Class: LengthMeasurement",sidebar_label:"LengthMeasurement",custom_edit_url:null},l=void 0,p={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:"IfcJsonExporter",permalink:"/api/classes/openbim_components.IfcJsonExporter"},next:{title:"LocalCacher",permalink:"/api/classes/openbim_components.LocalCacher"}},o={},s=[{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:"previewElement",id:"previewelement",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"snapDistance",id:"snapdistance",level:3},{value:"Defined in",id:"defined-in-9",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-10",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-11",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-12",level:4},{value:"visible",id:"visible",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Implementation of",id:"implementation-of-8",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Implementation of",id:"implementation-of-9",level:4},{value:"Defined in",id:"defined-in-14",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-10",level:4},{value:"Defined in",id:"defined-in-15",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-11",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"delete",id:"delete",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Implementation of",id:"implementation-of-12",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"deleteAll",id:"deleteall",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Implementation of",id:"implementation-of-13",level:4},{value:"Defined in",id:"defined-in-19",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-20",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-21",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-22",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-23",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-24",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-25",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-26",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-14",level:4},{value:"Defined in",id:"defined-in-27",level:4}],m={toc:s},d="wrapper";function u(e){let{components:t,...n}=e;return(0,i.kt)(d,(0,a.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"),".LengthMeasurement"),(0,i.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,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)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"SimpleDimensionLine"),"[]",">"),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"LengthMeasurement"))))),(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.Createable"},(0,i.kt)("inlineCode",{parentName:"a"},"Createable"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Hideable"},(0,i.kt)("inlineCode",{parentName:"a"},"Hideable"))),(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)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Updateable"},(0,i.kt)("inlineCode",{parentName:"a"},"Updateable"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},(0,i.kt)("inlineCode",{parentName:"a"},"UI")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(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"},"SimpleDimensionLine"),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onaftercancel"},"Createable.onAfterCancel")),(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.Createable"},"Createable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onaftercancel"},"onAfterCancel")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/measurement/LengthMeasurement/index.ts#L51"},"src/measurement/LengthMeasurement/index.ts:51")),(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"},"SimpleDimensionLine"),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onaftercreate"},"Createable.onAfterCreate")),(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.Createable"},"Createable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onaftercreate"},"onAfterCreate")),(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/ifcjs/components/blob/e46138a/src/measurement/LengthMeasurement/index.ts#L36"},"src/measurement/LengthMeasurement/index.ts:36")),(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)("a",{parentName:"p",href:"/api/classes/openbim_components.LengthMeasurement"},(0,i.kt)("inlineCode",{parentName:"a"},"LengthMeasurement")),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onafterdelete"},"Createable.onAfterDelete")),(0,i.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onafterdelete"},"onAfterDelete")),(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/ifcjs/components/blob/e46138a/src/measurement/LengthMeasurement/index.ts#L42"},"src/measurement/LengthMeasurement/index.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.LengthMeasurement"},(0,i.kt)("inlineCode",{parentName:"a"},"LengthMeasurement")),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"Updateable.onAfterUpdate")),(0,i.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"onAfterUpdate")),(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/ifcjs/components/blob/e46138a/src/measurement/LengthMeasurement/index.ts#L33"},"src/measurement/LengthMeasurement/index.ts:33")),(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)("a",{parentName:"p",href:"/api/classes/openbim_components.LengthMeasurement"},(0,i.kt)("inlineCode",{parentName:"a"},"LengthMeasurement")),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onbeforecancel"},"Createable.onBeforeCancel")),(0,i.kt)("h4",{id:"implementation-of-4"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onbeforecancel"},"onBeforeCancel")),(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/ifcjs/components/blob/e46138a/src/measurement/LengthMeasurement/index.ts#L48"},"src/measurement/LengthMeasurement/index.ts:48")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onbeforecreate"},"onBeforeCreate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onBeforeCreate"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.LengthMeasurement"},(0,i.kt)("inlineCode",{parentName:"a"},"LengthMeasurement")),">"),(0,i.kt)("p",null,"Createable.onBeforeCreate"),(0,i.kt)("h4",{id:"implementation-of-5"},"Implementation of"),(0,i.kt)("p",null,"Createable.onBeforeCreate"),(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/ifcjs/components/blob/e46138a/src/measurement/LengthMeasurement/index.ts#L39"},"src/measurement/LengthMeasurement/index.ts:39")),(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"},"SimpleDimensionLine"),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onbeforedelete"},"Createable.onBeforeDelete")),(0,i.kt)("h4",{id:"implementation-of-6"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onbeforedelete"},"onBeforeDelete")),(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/ifcjs/components/blob/e46138a/src/measurement/LengthMeasurement/index.ts#L45"},"src/measurement/LengthMeasurement/index.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.LengthMeasurement"},(0,i.kt)("inlineCode",{parentName:"a"},"LengthMeasurement")),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"Updateable.onBeforeUpdate")),(0,i.kt)("h4",{id:"implementation-of-7"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"onBeforeUpdate")),(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/ifcjs/components/blob/e46138a/src/measurement/LengthMeasurement/index.ts#L30"},"src/measurement/LengthMeasurement/index.ts:30")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"previewelement"},"previewElement"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"previewElement"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"HTMLElement")),(0,i.kt)("p",null,"The ",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#examples/en/renderers/CSS2DRenderer"},"symbol"),"\nthat is displayed where the dimension will be drawn."),(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/ifcjs/components/blob/e46138a/src/measurement/LengthMeasurement/index.ts#L60"},"src/measurement/LengthMeasurement/index.ts:60")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"snapdistance"},"snapDistance"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"snapDistance"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"0.25")),(0,i.kt)("p",null,"The minimum distance to force the dimension cursor to a vertex."),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/measurement/LengthMeasurement/index.ts#L56"},"src/measurement/LengthMeasurement/index.ts:56")),(0,i.kt)("h2",{id:"accessors"},"Accessors"),(0,i.kt)("h3",{id:"color"},"color"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"color"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"color"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"The ",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/math/Color"},"Color"),"\nof the geometry of the dimensions."),(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"},"color")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Color"))))),(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-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/measurement/LengthMeasurement/index.ts#L119"},"src/measurement/LengthMeasurement/index.ts:119")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"enabled"},"enabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"enabled"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,"Component.enabled"),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/measurement/LengthMeasurement/index.ts#L84"},"src/measurement/LengthMeasurement/index.ts:84")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"enabled"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(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)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))))),(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:"overrides-1"},"Overrides"),(0,i.kt)("p",null,"Component.enabled"),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/measurement/LengthMeasurement/index.ts#L89"},"src/measurement/LengthMeasurement/index.ts:89")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"visible"},"visible"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"visible"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,i.kt)("h4",{id:"returns-3"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"implementation-of-8"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"visible")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/measurement/LengthMeasurement/index.ts#L100"},"src/measurement/LengthMeasurement/index.ts:100")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"visible"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(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"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,i.kt)("h4",{id:"returns-4"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"implementation-of-9"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"visible")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/measurement/LengthMeasurement/index.ts#L105"},"src/measurement/LengthMeasurement/index.ts:105")),(0,i.kt)("h2",{id:"methods"},"Methods"),(0,i.kt)("h3",{id:"cancelcreation"},"cancelCreation"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"cancelCreation"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Cancels the drawing of the current dimension."),(0,i.kt)("h4",{id:"returns-5"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"implementation-of-10"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#cancelcreation"},"cancelCreation")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/measurement/LengthMeasurement/index.ts#L240"},"src/measurement/LengthMeasurement/index.ts:240")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"create"},"create"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"create"),"(",(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,"Starts or finishes drawing a new dimension line."),(0,i.kt)("h4",{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)("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"},"data?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any")),(0,i.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,i.kt)("h4",{id:"returns-6"},"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-11"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#create"},"create")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/measurement/LengthMeasurement/index.ts#L202"},"src/measurement/LengthMeasurement/index.ts:202")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"delete"},"delete"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"delete"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Deletes the dimension that the user is hovering over with the mouse or touch event."),(0,i.kt)("h4",{id:"returns-7"},"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-12"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#delete"},"delete")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/measurement/LengthMeasurement/index.ts#L214"},"src/measurement/LengthMeasurement/index.ts:214")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"deleteall"},"deleteAll"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"deleteAll"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Deletes all the dimensions that have been previously created."),(0,i.kt)("h4",{id:"returns-8"},"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-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/measurement/LengthMeasurement/index.ts#L231"},"src/measurement/LengthMeasurement/index.ts:231")),(0,i.kt)("hr",null),(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-9"},"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-13"},"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-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/measurement/LengthMeasurement/index.ts#L162"},"src/measurement/LengthMeasurement/index.ts:162")),(0,i.kt)("hr",null),(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"},"SimpleDimensionLine"),"[]"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,i.kt)("h4",{id:"returns-10"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"SimpleDimensionLine"),"[]"),(0,i.kt)("h4",{id:"overrides-2"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/measurement/LengthMeasurement/index.ts#L157"},"src/measurement/LengthMeasurement/index.ts:157")),(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-11"},"Returns"),(0,i.kt)("p",null,"this is UI"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L62"},"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-12"},"Returns"),(0,i.kt)("p",null,"this is Configurable"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L57"},"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-13"},"Returns"),(0,i.kt)("p",null,"this is Disposable"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L35"},"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-14"},"Returns"),(0,i.kt)("p",null,"this is Hideable"),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L52"},"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-15"},"Returns"),(0,i.kt)("p",null,"this is Resizeable"),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,i.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L40"},"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-16"},"Returns"),(0,i.kt)("p",null,"this is Updateable"),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,i.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"update"},"update"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"update"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"_delta"),"): ",(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.Updateable#update"},"Updateable.update")),(0,i.kt)("h4",{id:"parameters-4"},"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"},"_delta")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))))),(0,i.kt)("h4",{id:"returns-17"},"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-14"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"update")),(0,i.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/measurement/LengthMeasurement/index.ts#L186"},"src/measurement/LengthMeasurement/index.ts:186")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/b82c8867.67bfe9b2.js b/build/assets/js/b82c8867.67bfe9b2.js new file mode 100644 index 000000000..67bf3a964 --- /dev/null +++ b/build/assets/js/b82c8867.67bfe9b2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5972],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>c});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 o=a.createContext({}),s=function(e){var t=a.useContext(o),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(o.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,p=e.originalType,o=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),d=s(n),k=i,c=d["".concat(o,".").concat(k)]||d[k]||u[k]||p;return n?a.createElement(c,r(r({ref:t},m),{},{components:n})):a.createElement(c,r({ref:t},m))}));function c(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var p=n.length,r=new Array(p);r[0]=k;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,r[1]=l;for(var s=2;s{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>r,default:()=>u,frontMatter:()=>p,metadata:()=>l,toc:()=>s});var a=n(7462),i=(n(7294),n(3905));const p={id:"openbim_components.LengthMeasurement",title:"Class: LengthMeasurement",sidebar_label:"LengthMeasurement",custom_edit_url:null},r=void 0,l={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:"IfcJsonExporter",permalink:"/api/classes/openbim_components.IfcJsonExporter"},next:{title:"LocalCacher",permalink:"/api/classes/openbim_components.LocalCacher"}},o={},s=[{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}],m={toc:s},d="wrapper";function u(e){let{components:t,...n}=e;return(0,i.kt)(d,(0,a.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"),".LengthMeasurement"),(0,i.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,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)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"SimpleDimensionLine"),"[]",">"),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"LengthMeasurement"))))),(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.Createable"},(0,i.kt)("inlineCode",{parentName:"a"},"Createable"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Hideable"},(0,i.kt)("inlineCode",{parentName:"a"},"Hideable"))),(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)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Updateable"},(0,i.kt)("inlineCode",{parentName:"a"},"Updateable"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},(0,i.kt)("inlineCode",{parentName:"a"},"UI")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(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"},"SimpleDimensionLine"),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onaftercancel"},"Createable.onAfterCancel")),(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.Createable"},"Createable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onaftercancel"},"onAfterCancel")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/index.ts#L54"},"temp/components/src/measurement/LengthMeasurement/index.ts:54")),(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"},"SimpleDimensionLine"),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onaftercreate"},"Createable.onAfterCreate")),(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.Createable"},"Createable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onaftercreate"},"onAfterCreate")),(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/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/index.ts#L39"},"temp/components/src/measurement/LengthMeasurement/index.ts:39")),(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)("a",{parentName:"p",href:"/api/classes/openbim_components.LengthMeasurement"},(0,i.kt)("inlineCode",{parentName:"a"},"LengthMeasurement")),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onafterdelete"},"Createable.onAfterDelete")),(0,i.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onafterdelete"},"onAfterDelete")),(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/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/index.ts#L45"},"temp/components/src/measurement/LengthMeasurement/index.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onafterupdate"},"onAfterUpdate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onAfterUpdate"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.LengthMeasurement"},(0,i.kt)("inlineCode",{parentName:"a"},"LengthMeasurement")),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"Updateable.onAfterUpdate")),(0,i.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onafterupdate"},"onAfterUpdate")),(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/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/index.ts#L36"},"temp/components/src/measurement/LengthMeasurement/index.ts:36")),(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)("a",{parentName:"p",href:"/api/classes/openbim_components.LengthMeasurement"},(0,i.kt)("inlineCode",{parentName:"a"},"LengthMeasurement")),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onbeforecancel"},"Createable.onBeforeCancel")),(0,i.kt)("h4",{id:"implementation-of-4"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onbeforecancel"},"onBeforeCancel")),(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/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/index.ts#L51"},"temp/components/src/measurement/LengthMeasurement/index.ts:51")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onbeforecreate"},"onBeforeCreate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onBeforeCreate"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.LengthMeasurement"},(0,i.kt)("inlineCode",{parentName:"a"},"LengthMeasurement")),">"),(0,i.kt)("p",null,"Createable.onBeforeCreate"),(0,i.kt)("h4",{id:"implementation-of-5"},"Implementation of"),(0,i.kt)("p",null,"Createable.onBeforeCreate"),(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/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/index.ts#L42"},"temp/components/src/measurement/LengthMeasurement/index.ts:42")),(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"},"SimpleDimensionLine"),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onbeforedelete"},"Createable.onBeforeDelete")),(0,i.kt)("h4",{id:"implementation-of-6"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onbeforedelete"},"onBeforeDelete")),(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/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/index.ts#L48"},"temp/components/src/measurement/LengthMeasurement/index.ts:48")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onbeforeupdate"},"onBeforeUpdate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onBeforeUpdate"),": ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event")),"<",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.LengthMeasurement"},(0,i.kt)("inlineCode",{parentName:"a"},"LengthMeasurement")),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"Updateable.onBeforeUpdate")),(0,i.kt)("h4",{id:"implementation-of-7"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#onbeforeupdate"},"onBeforeUpdate")),(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/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/index.ts#L33"},"temp/components/src/measurement/LengthMeasurement/index.ts:33")),(0,i.kt)("hr",null),(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"},"string"),">"),(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-8"},"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-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/index.ts#L30"},"temp/components/src/measurement/LengthMeasurement/index.ts:30")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"previewelement"},"previewElement"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"previewElement"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"HTMLElement")),(0,i.kt)("p",null,"The ",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#examples/en/renderers/CSS2DRenderer"},"symbol"),"\nthat is displayed where the dimension will be drawn."),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/index.ts#L63"},"temp/components/src/measurement/LengthMeasurement/index.ts:63")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"snapdistance"},"snapDistance"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"snapDistance"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"0.25")),(0,i.kt)("p",null,"The minimum distance to force the dimension cursor to a vertex."),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/index.ts#L59"},"temp/components/src/measurement/LengthMeasurement/index.ts:59")),(0,i.kt)("h2",{id:"accessors"},"Accessors"),(0,i.kt)("h3",{id:"color"},"color"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"color"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"color"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"The ",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/math/Color"},"Color"),"\nof the geometry of the dimensions."),(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"},"color")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Color"))))),(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-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/index.ts#L122"},"temp/components/src/measurement/LengthMeasurement/index.ts:122")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"enabled"},"enabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"enabled"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,"Component.enabled"),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/index.ts#L87"},"temp/components/src/measurement/LengthMeasurement/index.ts:87")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"enabled"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(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)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))))),(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:"overrides-1"},"Overrides"),(0,i.kt)("p",null,"Component.enabled"),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/index.ts#L92"},"temp/components/src/measurement/LengthMeasurement/index.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"visible"},"visible"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"visible"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,i.kt)("h4",{id:"returns-3"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"implementation-of-9"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"visible")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/index.ts#L103"},"temp/components/src/measurement/LengthMeasurement/index.ts:103")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"visible"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(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"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,i.kt)("h4",{id:"returns-4"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"implementation-of-10"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"visible")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/index.ts#L108"},"temp/components/src/measurement/LengthMeasurement/index.ts:108")),(0,i.kt)("h2",{id:"methods"},"Methods"),(0,i.kt)("h3",{id:"cancelcreation"},"cancelCreation"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"cancelCreation"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Cancels the drawing of the current dimension."),(0,i.kt)("h4",{id:"returns-5"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"implementation-of-11"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#cancelcreation"},"cancelCreation")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/index.ts#L254"},"temp/components/src/measurement/LengthMeasurement/index.ts:254")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"create"},"create"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"create"),"(",(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,"Starts or finishes drawing a new dimension line."),(0,i.kt)("h4",{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)("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"},"data?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any")),(0,i.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,i.kt)("h4",{id:"returns-6"},"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-12"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#create"},"create")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/index.ts#L207"},"temp/components/src/measurement/LengthMeasurement/index.ts:207")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"delete"},"delete"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"delete"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Deletes the dimension that the user is hovering over with the mouse or touch event."),(0,i.kt)("h4",{id:"returns-7"},"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-13"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#delete"},"delete")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/index.ts#L219"},"temp/components/src/measurement/LengthMeasurement/index.ts:219")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"deleteall"},"deleteAll"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"deleteAll"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Deletes all the dimensions that have been previously created."),(0,i.kt)("h4",{id:"returns-8"},"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-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/index.ts#L245"},"temp/components/src/measurement/LengthMeasurement/index.ts:245")),(0,i.kt)("hr",null),(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-9"},"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-14"},"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-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/index.ts#L165"},"temp/components/src/measurement/LengthMeasurement/index.ts:165")),(0,i.kt)("hr",null),(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"},"SimpleDimensionLine"),"[]"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,i.kt)("h4",{id:"returns-10"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"SimpleDimensionLine"),"[]"),(0,i.kt)("h4",{id:"overrides-2"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/index.ts#L160"},"temp/components/src/measurement/LengthMeasurement/index.ts:160")),(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-11"},"Returns"),(0,i.kt)("p",null,"this is UI"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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-12"},"Returns"),(0,i.kt)("p",null,"this is Configurable"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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-13"},"Returns"),(0,i.kt)("p",null,"this is Disposable"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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-14"},"Returns"),(0,i.kt)("p",null,"this is Hideable"),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,i.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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-15"},"Returns"),(0,i.kt)("p",null,"this is Resizeable"),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,i.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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-16"},"Returns"),(0,i.kt)("p",null,"this is Updateable"),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,i.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/src/base-types/component.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"update"},"update"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"update"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"_delta"),"): ",(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.Updateable#update"},"Updateable.update")),(0,i.kt)("h4",{id:"parameters-4"},"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"},"_delta")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))))),(0,i.kt)("h4",{id:"returns-17"},"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-15"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Updateable#update"},"update")),(0,i.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/index.ts#L191"},"temp/components/src/measurement/LengthMeasurement/index.ts:191")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/ba12a54e.2e518cab.js b/build/assets/js/ba12a54e.77b997a7.js similarity index 66% rename from build/assets/js/ba12a54e.2e518cab.js rename to build/assets/js/ba12a54e.77b997a7.js index bd22ef2c1..23c17a5ce 100644 --- a/build/assets/js/ba12a54e.2e518cab.js +++ b/build/assets/js/ba12a54e.77b997a7.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 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 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)},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=p(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,o(o({ref:t},c),{},{components:n})):r.createElement(b,o({ref:t},c))}));function b(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=u;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p[d]="string"==typeof e?e:a,o[1]=p;for(var s=2;s{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>m,frontMatter:()=>i,metadata:()=>p,toc:()=>s});var r=n(7462),a=(n(7294),n(3905));const i={id:"openbim_components.Resizeable",title:"Interface: Resizeable",sidebar_label:"Resizeable",custom_edit_url:null},o=void 0,p={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"}},l={},s=[{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}],c={toc:s},d="wrapper";function m(e){let{components:t,...n}=e;return(0,a.kt)(d,(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"),".Resizeable"),(0,a.kt)("p",null,"Whether this component can be resized. The meaning of this can vary depending\non the component: resizing a\n",(0,a.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,a.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/objects/Mesh"},"Mesh")," would change its scale."),(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.BaseRenderer"},(0,a.kt)("inlineCode",{parentName:"a"},"BaseRenderer"))),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Simple2DScene"},(0,a.kt)("inlineCode",{parentName:"a"},"Simple2DScene"))),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleRenderer"},(0,a.kt)("inlineCode",{parentName:"a"},"SimpleRenderer")))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"getsize"},"getSize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"getSize"),": () => ",(0,a.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (): ",(0,a.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,a.kt)("p",null,"Gets the current size of this component (e.g. the resolution of a\n",(0,a.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer"},"Renderer"),"\ncomponent."),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L99"},"src/base-types/base-types.ts:99")),(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,"Event that fires when the component has been resized."),(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/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L92"},"src/base-types/base-types.ts:92")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"resize"},"resize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"resize"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"size?"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Vector2"),") => ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"size?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"Sets size of this component (e.g. the resolution of a\n",(0,a.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer"},"Renderer"),"\ncomponent."),(0,a.kt)("h5",{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)("h5",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(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/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L89"},"src/base-types/base-types.ts:89")))}m.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 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 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,a=e.mdxType,i=e.originalType,l=e.parentName,c=p(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,o(o({ref:t},c),{},{components:n})):r.createElement(b,o({ref:t},c))}));function b(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);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:a,o[1]=p;for(var s=2;s{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>p,toc:()=>s});var r=n(7462),a=(n(7294),n(3905));const i={id:"openbim_components.Resizeable",title:"Interface: Resizeable",sidebar_label:"Resizeable",custom_edit_url:null},o=void 0,p={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"}},l={},s=[{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}],c={toc:s},m="wrapper";function d(e){let{components:t,...n}=e;return(0,a.kt)(m,(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"),".Resizeable"),(0,a.kt)("p",null,"Whether this component can be resized. The meaning of this can vary depending\non the component: resizing a\n",(0,a.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,a.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/objects/Mesh"},"Mesh")," would change its scale."),(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.BaseRenderer"},(0,a.kt)("inlineCode",{parentName:"a"},"BaseRenderer"))),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Simple2DScene"},(0,a.kt)("inlineCode",{parentName:"a"},"Simple2DScene"))),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleRenderer"},(0,a.kt)("inlineCode",{parentName:"a"},"SimpleRenderer")))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"getsize"},"getSize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"getSize"),": () => ",(0,a.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (): ",(0,a.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,a.kt)("p",null,"Gets the current size of this component (e.g. the resolution of a\n",(0,a.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer"},"Renderer"),"\ncomponent."),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Vector2")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L103"},"temp/components/src/base-types/base-types.ts:103")),(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,"Event that fires when the component has been resized."),(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/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L96"},"temp/components/src/base-types/base-types.ts:96")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"resize"},"resize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"resize"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"size?"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Vector2"),") => ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"size?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"Sets size of this component (e.g. the resolution of a\n",(0,a.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/renderers/WebGLRenderer"},"Renderer"),"\ncomponent."),(0,a.kt)("h5",{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)("h5",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(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/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L93"},"temp/components/src/base-types/base-types.ts:93")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/bc6e2bb0.0acc1ef6.js b/build/assets/js/bc6e2bb0.0acc1ef6.js new file mode 100644 index 000000000..16e1a5893 --- /dev/null +++ b/build/assets/js/bc6e2bb0.0acc1ef6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9799],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>k});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 r(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):r(r({},t),e)),n},m=function(e){var t=s(e.components);return i.createElement(o.Provider,{value:t},e.children)},d="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,p=e.originalType,o=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),d=s(n),u=a,k=d["".concat(o,".").concat(u)]||d[u]||c[u]||p;return n?i.createElement(k,r(r({ref:t},m),{},{components:n})):i.createElement(k,r({ref:t},m))}));function k(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var p=n.length,r=new Array(p);r[0]=u;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l[d]="string"==typeof e?e:a,r[1]=l;for(var s=2;s{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>r,default:()=>c,frontMatter:()=>p,metadata:()=>l,toc:()=>s});var i=n(7462),a=(n(7294),n(3905));const p={id:"openbim_components.SimpleGrid",title:"Class: SimpleGrid",sidebar_label:"SimpleGrid",custom_edit_url:null},r=void 0,l={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"}},o={},s=[{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}],m={toc:s},d="wrapper";function c(e){let{components:t,...n}=e;return(0,a.kt)(d,(0,i.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"),".SimpleGrid"),(0,a.kt)("p",null,"An infinite grid. Created by\n",(0,a.kt)("a",{parentName:"p",href:"https://github.com/Fyrestar/THREE.InfiniteGridHelper"},"fyrestar"),"\nand translated to typescript by\n",(0,a.kt)("a",{parentName:"p",href:"https://github.com/dkaraush/THREE.InfiniteGridHelper/blob/master/InfiniteGridHelper.ts"},"dkaraush"),"."),(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.Mesh"),">"),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"SimpleGrid"))))),(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.Hideable"},(0,a.kt)("inlineCode",{parentName:"a"},"Hideable"))),(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/IFCjs/components/blob/0c38d20/src/core/SimpleGrid/index.ts#L24"},"temp/components/src/core/SimpleGrid/index.ts:24")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleGrid/index.ts#L21"},"temp/components/src/core/SimpleGrid/index.ts:21")),(0,a.kt)("h2",{id:"accessors"},"Accessors"),(0,a.kt)("h3",{id:"fade"},"fade"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"fade"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"Whether the grid should fade away with distance. Recommended to be true for\nperspective cameras and false for orthographic cameras."),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleGrid/index.ts#L50"},"temp/components/src/core/SimpleGrid/index.ts:50")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"fade"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"active"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"Whether the grid should fade away with distance. Recommended to be true for\nperspective cameras and false for orthographic cameras."),(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"},"active")),(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:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleGrid/index.ts#L58"},"temp/components/src/core/SimpleGrid/index.ts:58")),(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"},"ShaderMaterial")),(0,a.kt)("p",null,"The material of the grid."),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"ShaderMaterial")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleGrid/index.ts#L42"},"temp/components/src/core/SimpleGrid/index.ts:42")),(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-3"},"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-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleGrid/index.ts#L27"},"temp/components/src/core/SimpleGrid/index.ts:27")),(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"},"visible"),"): ",(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-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"},"visible")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(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:"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-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleGrid/index.ts#L32"},"temp/components/src/core/SimpleGrid/index.ts:32")),(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-5"},"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-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleGrid/index.ts#L189"},"temp/components/src/core/SimpleGrid/index.ts:189")),(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"},"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)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,a.kt)("h4",{id:"returns-6"},"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)("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-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleGrid/index.ts#L184"},"temp/components/src/core/SimpleGrid/index.ts:184")),(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-7"},"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-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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-8"},"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-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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-9"},"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-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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-10"},"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-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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-11"},"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-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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-12"},"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-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/src/base-types/component.ts:45")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/bc6e2bb0.1e9a2f6a.js b/build/assets/js/bc6e2bb0.1e9a2f6a.js deleted file mode 100644 index de31320c6..000000000 --- a/build/assets/js/bc6e2bb0.1e9a2f6a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9799],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>k});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 l(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({}),o=function(e){var t=i.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},d=function(e){var t=o(e.components);return i.createElement(s.Provider,{value:t},e.children)},m="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,d=p(e,["components","mdxType","originalType","parentName"]),m=o(n),c=a,k=m["".concat(s,".").concat(c)]||m[c]||u[c]||r;return n?i.createElement(k,l(l({ref:t},d),{},{components:n})):i.createElement(k,l({ref:t},d))}));function k(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,l=new Array(r);l[0]=c;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[m]="string"==typeof e?e:a,l[1]=p;for(var o=2;o{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>u,frontMatter:()=>r,metadata:()=>p,toc:()=>o});var i=n(7462),a=(n(7294),n(3905));const r={id:"openbim_components.SimpleGrid",title:"Class: SimpleGrid",sidebar_label:"SimpleGrid",custom_edit_url:null},l=void 0,p={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"}},s={},o=[{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:"Accessors",id:"accessors",level:2},{value:"fade",id:"fade",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"material",id:"material",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"visible",id:"visible",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-5",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-2",level:4},{value:"Defined in",id:"defined-in-6",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-7",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-8",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-9",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-10",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-11",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-12",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-13",level:4}],d={toc:o},m="wrapper";function u(e){let{components:t,...n}=e;return(0,a.kt)(m,(0,i.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"),".SimpleGrid"),(0,a.kt)("p",null,"An infinite grid. Created by\n",(0,a.kt)("a",{parentName:"p",href:"https://github.com/Fyrestar/THREE.InfiniteGridHelper"},"fyrestar"),"\nand translated to typescript by\n",(0,a.kt)("a",{parentName:"p",href:"https://github.com/dkaraush/THREE.InfiniteGridHelper/blob/master/InfiniteGridHelper.ts"},"dkaraush"),"."),(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.Mesh"),">"),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"SimpleGrid"))))),(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.Hideable"},(0,a.kt)("inlineCode",{parentName:"a"},"Hideable"))),(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/ifcjs/components/blob/e46138a/src/core/SimpleGrid/index.ts#L21"},"src/core/SimpleGrid/index.ts:21")),(0,a.kt)("h2",{id:"accessors"},"Accessors"),(0,a.kt)("h3",{id:"fade"},"fade"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"fade"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"Whether the grid should fade away with distance. Recommended to be true for\nperspective cameras and false for orthographic cameras."),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(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/ifcjs/components/blob/e46138a/src/core/SimpleGrid/index.ts#L47"},"src/core/SimpleGrid/index.ts:47")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"fade"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"active"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"Whether the grid should fade away with distance. Recommended to be true for\nperspective cameras and false for orthographic cameras."),(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"},"active")),(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:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleGrid/index.ts#L55"},"src/core/SimpleGrid/index.ts:55")),(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"},"ShaderMaterial")),(0,a.kt)("p",null,"The material of the grid."),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"ShaderMaterial")),(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/ifcjs/components/blob/e46138a/src/core/SimpleGrid/index.ts#L39"},"src/core/SimpleGrid/index.ts:39")),(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-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(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.Hideable"},"Hideable"),".",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"visible")),(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/ifcjs/components/blob/e46138a/src/core/SimpleGrid/index.ts#L24"},"src/core/SimpleGrid/index.ts:24")),(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"},"visible"),"): ",(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-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"},"visible")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(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:"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-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleGrid/index.ts#L29"},"src/core/SimpleGrid/index.ts:29")),(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-5"},"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-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleGrid/index.ts#L186"},"src/core/SimpleGrid/index.ts:186")),(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"},"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)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,a.kt)("h4",{id:"returns-6"},"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)("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-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleGrid/index.ts#L181"},"src/core/SimpleGrid/index.ts:181")),(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-7"},"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-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-8"},"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-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-9"},"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-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-10"},"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-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-11"},"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-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-12"},"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-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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/bfa94da9.056b9725.js b/build/assets/js/bfa94da9.056b9725.js new file mode 100644 index 000000000..6d25661e1 --- /dev/null +++ b/build/assets/js/bfa94da9.056b9725.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5261],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,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 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)}},c=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),c=i,u=m["".concat(o,".").concat(c)]||m[c]||k[c]||r;return n?a.createElement(u,l(l({ref:t},d),{},{components:n})):a.createElement(u,l({ref:t},d))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,l=new Array(r);l[0]=c;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:()=>o,contentTitle:()=>l,default:()=>k,frontMatter:()=>r,metadata:()=>p,toc:()=>s});var a=n(7462),i=(n(7294),n(3905));const r={id:"openbim_components.MaterialManager",title:"Class: MaterialManager",sidebar_label:"MaterialManager",custom_edit_url:null},l=void 0,p={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:"MapboxWindow",permalink:"/api/classes/openbim_components.MapboxWindow"},next:{title:"Mouse",permalink:"/api/classes/openbim_components.Mouse"}},o={},s=[{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:"resetBackgroundColor",id:"resetbackgroundcolor",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"set",id:"set",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"setBackgroundColor",id:"setbackgroundcolor",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}],d={toc:s},m="wrapper";function k(e){let{components:t,...n}=e;return(0,i.kt)(m,(0,a.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"),".MaterialManager"),(0,i.kt)("p",null,"A tool to easily handle the materials of massive amounts of\nobjects and scene background easily."),(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)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"[]",">"),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"MaterialManager"))))),(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:"enabled"},"enabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"enabled"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"true")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/MaterialManager/index.ts#L17"},"temp/components/src/core/MaterialManager/index.ts:17")),(0,i.kt)("hr",null),(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"},"string"),">"),(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-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/MaterialManager/index.ts#L22"},"temp/components/src/core/MaterialManager/index.ts:22")),(0,i.kt)("h2",{id:"methods"},"Methods"),(0,i.kt)("h3",{id:"addmaterial"},"addMaterial"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"addMaterial"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"material"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Creates a new material style."),(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"},"id")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the identifier of the style to create.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"material")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Material")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the material of the style.")))),(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-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/MaterialManager/index.ts#L125"},"temp/components/src/core/MaterialManager/index.ts:125")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"addmeshes"},"addMeshes"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"addMeshes"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"meshes"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Assign meshes to a certain style."),(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"},"id")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the identifier of the style.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"meshes")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Mesh"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"BufferGeometry"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"NormalBufferAttributes"),">",", ",(0,i.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"Material"),"[]",">","[]"),(0,i.kt)("td",{parentName:"tr",align:"left"},"the meshes to assign to the style.")))),(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-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/MaterialManager/index.ts#L137"},"temp/components/src/core/MaterialManager/index.ts:137")),(0,i.kt)("hr",null),(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-2"},"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-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/MaterialManager/index.ts#L83"},"temp/components/src/core/MaterialManager/index.ts:83")),(0,i.kt)("hr",null),(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"},"string"),"[]"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get"),"."),(0,i.kt)("h4",{id:"returns-3"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,i.kt)("p",null,"list of created materials."),(0,i.kt)("h4",{id:"overrides-1"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(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/IFCjs/components/blob/0c38d20/src/core/MaterialManager/index.ts#L47"},"temp/components/src/core/MaterialManager/index.ts:47")),(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-4"},"Returns"),(0,i.kt)("p",null,"this is UI"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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-5"},"Returns"),(0,i.kt)("p",null,"this is Configurable"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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-6"},"Returns"),(0,i.kt)("p",null,"this is Disposable"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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-7"},"Returns"),(0,i.kt)("p",null,"this is Hideable"),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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-8"},"Returns"),(0,i.kt)("p",null,"this is Resizeable"),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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-9"},"Returns"),(0,i.kt)("p",null,"this is Updateable"),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/src/base-types/component.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"resetbackgroundcolor"},"resetBackgroundColor"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"resetBackgroundColor"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Resets the scene background to the color that was being used\nbefore applying the material manager."),(0,i.kt)("h4",{id:"returns-10"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/MaterialManager/index.ts#L113"},"temp/components/src/core/MaterialManager/index.ts:113")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"set"},"set"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"set"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"active"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"ids?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Turns the specified material styles on or off."),(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)("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"},"active")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean")),(0,i.kt)("td",{parentName:"tr",align:"left"},"whether to turn it on or off.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"ids")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,i.kt)("td",{parentName:"tr",align:"left"},"the ids of the style to turn on or off.")))),(0,i.kt)("h4",{id:"returns-11"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/MaterialManager/index.ts#L57"},"temp/components/src/core/MaterialManager/index.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"setbackgroundcolor"},"setBackgroundColor"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"setBackgroundColor"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"color"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Sets the color of the background of the scene."),(0,i.kt)("h4",{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"},"color")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Color"))))),(0,i.kt)("h4",{id:"returns-12"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/MaterialManager/index.ts#L99"},"temp/components/src/core/MaterialManager/index.ts:99")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/bfa94da9.ca4e8e29.js b/build/assets/js/bfa94da9.ca4e8e29.js deleted file mode 100644 index b1754b5a7..000000000 --- a/build/assets/js/bfa94da9.ca4e8e29.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5261],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>c});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,c=m["".concat(o,".").concat(u)]||m[u]||k[u]||r;return n?a.createElement(c,l(l({ref:t},d),{},{components:n})):a.createElement(c,l({ref:t},d))}));function c(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:()=>o,contentTitle:()=>l,default:()=>k,frontMatter:()=>r,metadata:()=>p,toc:()=>s});var a=n(7462),i=(n(7294),n(3905));const r={id:"openbim_components.MaterialManager",title:"Class: MaterialManager",sidebar_label:"MaterialManager",custom_edit_url:null},l=void 0,p={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:"MapboxWindow",permalink:"/api/classes/openbim_components.MapboxWindow"},next:{title:"Mouse",permalink:"/api/classes/openbim_components.Mouse"}},o={},s=[{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:"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-1",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-2",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-3",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-4",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-5",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-6",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-7",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-8",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-9",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-10",level:4},{value:"resetBackgroundColor",id:"resetbackgroundcolor",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"set",id:"set",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"setBackgroundColor",id:"setbackgroundcolor",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-13",level:4}],d={toc:s},m="wrapper";function k(e){let{components:t,...n}=e;return(0,i.kt)(m,(0,a.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"),".MaterialManager"),(0,i.kt)("p",null,"A tool to easily handle the materials of massive amounts of\nobjects and scene background easily."),(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)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"[]",">"),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"MaterialManager"))))),(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:"enabled"},"enabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"enabled"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"true")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"enabled")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/MaterialManager/index.ts#L17"},"src/core/MaterialManager/index.ts:17")),(0,i.kt)("h2",{id:"methods"},"Methods"),(0,i.kt)("h3",{id:"addmaterial"},"addMaterial"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"addMaterial"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"material"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Creates a new material style."),(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"},"id")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the identifier of the style to create.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"material")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Material")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the material of the style.")))),(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-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/MaterialManager/index.ts#L120"},"src/core/MaterialManager/index.ts:120")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"addmeshes"},"addMeshes"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"addMeshes"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"meshes"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Assign meshes to a certain style."),(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"},"id")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the identifier of the style.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"meshes")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Mesh"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"BufferGeometry"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"NormalBufferAttributes"),">",", ",(0,i.kt)("inlineCode",{parentName:"td"},"Material")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"Material"),"[]",">","[]"),(0,i.kt)("td",{parentName:"tr",align:"left"},"the meshes to assign to the style.")))),(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-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/MaterialManager/index.ts#L132"},"src/core/MaterialManager/index.ts:132")),(0,i.kt)("hr",null),(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-2"},"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"},"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-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/MaterialManager/index.ts#L80"},"src/core/MaterialManager/index.ts:80")),(0,i.kt)("hr",null),(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"},"string"),"[]"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get"),"."),(0,i.kt)("h4",{id:"returns-3"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,i.kt)("p",null,"list of created materials."),(0,i.kt)("h4",{id:"overrides-1"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(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/ifcjs/components/blob/e46138a/src/core/MaterialManager/index.ts#L44"},"src/core/MaterialManager/index.ts:44")),(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-4"},"Returns"),(0,i.kt)("p",null,"this is UI"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L62"},"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-5"},"Returns"),(0,i.kt)("p",null,"this is Configurable"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L57"},"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-6"},"Returns"),(0,i.kt)("p",null,"this is Disposable"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L35"},"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-7"},"Returns"),(0,i.kt)("p",null,"this is Hideable"),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L52"},"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-8"},"Returns"),(0,i.kt)("p",null,"this is Resizeable"),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L40"},"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-9"},"Returns"),(0,i.kt)("p",null,"this is Updateable"),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"resetbackgroundcolor"},"resetBackgroundColor"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"resetBackgroundColor"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Resets the scene background to the color that was being used\nbefore applying the material manager."),(0,i.kt)("h4",{id:"returns-10"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/MaterialManager/index.ts#L108"},"src/core/MaterialManager/index.ts:108")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"set"},"set"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"set"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"active"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"ids?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Turns the specified material styles on or off."),(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)("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"},"active")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean")),(0,i.kt)("td",{parentName:"tr",align:"left"},"whether to turn it on or off.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"ids")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,i.kt)("td",{parentName:"tr",align:"left"},"the ids of the style to turn on or off.")))),(0,i.kt)("h4",{id:"returns-11"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/MaterialManager/index.ts#L54"},"src/core/MaterialManager/index.ts:54")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"setbackgroundcolor"},"setBackgroundColor"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"setBackgroundColor"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"color"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Sets the color of the background of the scene."),(0,i.kt)("h4",{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"},"color")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Color"))))),(0,i.kt)("h4",{id:"returns-12"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/MaterialManager/index.ts#L94"},"src/core/MaterialManager/index.ts:94")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/c45a2468.3e9708e2.js b/build/assets/js/c45a2468.67288189.js similarity index 62% rename from build/assets/js/c45a2468.3e9708e2.js rename to build/assets/js/c45a2468.67288189.js index 7d22b3a3b..f13636fbc 100644 --- a/build/assets/js/c45a2468.3e9708e2.js +++ b/build/assets/js/c45a2468.67288189.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[930],{3905:(e,a,n)=>{n.d(a,{Zo:()=>m,kt:()=>f});var t=n(7294);function i(e,a,n){return a in e?Object.defineProperty(e,a,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[a]=n,e}function r(e,a){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var t=Object.getOwnPropertySymbols(e);a&&(t=t.filter((function(a){return Object.getOwnPropertyDescriptor(e,a).enumerable}))),n.push.apply(n,t)}return n}function p(e){for(var a=1;a=0||(i[n]=e[n]);return i}(e,a);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(t=0;t=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=t.createContext({}),o=function(e){var a=t.useContext(s),n=a;return e&&(n="function"==typeof e?e(a):p(p({},a),e)),n},m=function(e){var a=o(e.components);return t.createElement(s.Provider,{value:a},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var a=e.children;return t.createElement(t.Fragment,{},a)}},d=t.forwardRef((function(e,a){var n=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),c=o(n),d=i,f=c["".concat(s,".").concat(d)]||c[d]||u[d]||r;return n?t.createElement(f,p(p({ref:a},m),{},{components:n})):t.createElement(f,p({ref:a},m))}));function f(e,a){var n=arguments,i=a&&a.mdxType;if("string"==typeof e||i){var r=n.length,p=new Array(r);p[0]=d;var l={};for(var s in a)hasOwnProperty.call(a,s)&&(l[s]=a[s]);l.originalType=e,l[c]="string"==typeof e?e:i,p[1]=l;for(var o=2;o{n.r(a),n.d(a,{assets:()=>s,contentTitle:()=>p,default:()=>u,frontMatter:()=>r,metadata:()=>l,toc:()=>o});var t=n(7462),i=(n(7294),n(3905));const r={id:"openbim_components",title:"Module: openbim-components",sidebar_label:"openbim-components",sidebar_position:0,custom_edit_url:null},p=void 0,l={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"}},s={},o=[{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}],m={toc:o},c="wrapper";function u(e){let{components:a,...n}=e;return(0,i.kt)(c,(0,t.Z)({},m,n,{components:a,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/openbim_components.BaseRenderer"},"BaseRenderer")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.CloudStorage"},"CloudStorage")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Component"},"Component")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Components"},"Components")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.CubeMap"},"CubeMap")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Disposer"},"Disposer")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.EdgesClipper"},"EdgesClipper")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.EdgesPlane"},"EdgesPlane")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Event"},"Event")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentBoundingBox"},"FragmentBoundingBox")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentIfcLoader"},"FragmentIfcLoader")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentManager"},"FragmentManager")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentPlans"},"FragmentPlans")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.IfcJsonExporter"},"IfcJsonExporter")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.LengthMeasurement"},"LengthMeasurement")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.LocalCacher"},"LocalCacher")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.MapboxWindow"},"MapboxWindow")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.MaterialManager"},"MaterialManager")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Mouse"},"Mouse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.OrthoPerspectiveCamera"},"OrthoPerspectiveCamera")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.PostproductionRenderer"},"PostproductionRenderer")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.ScreenCuller"},"ScreenCuller")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Simple2DScene"},"Simple2DScene")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleGrid"},"SimpleGrid")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleRaycaster"},"SimpleRaycaster")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleScene"},"SimpleScene")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.ToolComponent"},"ToolComponent")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.UIElement"},"UIElement")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.UIManager"},"UIManager"))),(0,i.kt)("h2",{id:"interfaces"},"Interfaces"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Configurable"},"Configurable")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Createable"},"Createable")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},"Disposable")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.FragmentIdMap"},"FragmentIdMap")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Hideable"},"Hideable")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.NavigationMode"},"NavigationMode")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Progress"},"Progress")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},"UI")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"))),(0,i.kt)("h2",{id:"type-aliases"},"Type Aliases"),(0,i.kt)("h3",{id:"cameraprojection"},"CameraProjection"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"CameraProjection"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"Perspective"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"Orthographic"')),(0,i.kt)("p",null,"The projection system of the camera."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/navigation/OrthoPerspectiveCamera/src/types.ts#L7"},"src/navigation/OrthoPerspectiveCamera/src/types.ts:7")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"navmodeid"},"NavModeID"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"NavModeID"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"Orbit"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"FirstPerson"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"Plan"')),(0,i.kt)("p",null,"The extensible list of supported navigation modes."),(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/ifcjs/components/blob/e46138a/src/navigation/OrthoPerspectiveCamera/src/types.ts#L12"},"src/navigation/OrthoPerspectiveCamera/src/types.ts:12")),(0,i.kt)("h2",{id:"variables"},"Variables"),(0,i.kt)("h3",{id:"dimensionlabelclassname"},"DimensionLabelClassName"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"DimensionLabelClassName"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"text-white text-sm bg-ifcjs-100 rounded-md px-3 py-1"')),(0,i.kt)("p",null,"The name of the CSS class that styles the dimension label."),(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/ifcjs/components/blob/e46138a/src/measurement/LengthMeasurement/src/types.ts#L4"},"src/measurement/LengthMeasurement/src/types.ts:4")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"dimensionpreviewclassname"},"DimensionPreviewClassName"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"DimensionPreviewClassName"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"bg-ifcjs-100 rounded-full w-[8px] h-[8px]"')),(0,i.kt)("p",null,"The name of the CSS class that styles the dimension label."),(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/ifcjs/components/blob/e46138a/src/measurement/LengthMeasurement/src/types.ts#L8"},"src/measurement/LengthMeasurement/src/types.ts:8")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"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:()=>o,contentTitle:()=>p,default:()=>u,frontMatter:()=>r,metadata:()=>l,toc:()=>s});var t=a(7462),i=(a(7294),a(3905));const r={id:"openbim_components",title:"Module: openbim-components",sidebar_label:"openbim-components",sidebar_position:0,custom_edit_url:null},p=void 0,l={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"}},o={},s=[{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}],m={toc:s},c="wrapper";function u(e){let{components:n,...a}=e;return(0,i.kt)(c,(0,t.Z)({},m,a,{components:n,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/openbim_components.BaseRenderer"},"BaseRenderer")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.CloudStorage"},"CloudStorage")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Component"},"Component")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Components"},"Components")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.CubeMap"},"CubeMap")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Disposer"},"Disposer")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.EdgesClipper"},"EdgesClipper")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.EdgesPlane"},"EdgesPlane")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Event"},"Event")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentBoundingBox"},"FragmentBoundingBox")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentIfcLoader"},"FragmentIfcLoader")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentManager"},"FragmentManager")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.FragmentPlans"},"FragmentPlans")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.IfcJsonExporter"},"IfcJsonExporter")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.LengthMeasurement"},"LengthMeasurement")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.LocalCacher"},"LocalCacher")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.MapboxWindow"},"MapboxWindow")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.MaterialManager"},"MaterialManager")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Mouse"},"Mouse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.OrthoPerspectiveCamera"},"OrthoPerspectiveCamera")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.PostproductionRenderer"},"PostproductionRenderer")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.ScreenCuller"},"ScreenCuller")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.Simple2DScene"},"Simple2DScene")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleCamera"},"SimpleCamera")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleClipper"},"SimpleClipper")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleGrid"},"SimpleGrid")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleRaycaster"},"SimpleRaycaster")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleRenderer"},"SimpleRenderer")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleScene"},"SimpleScene")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.ToolComponent"},"ToolComponent")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.UIElement"},"UIElement")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.UIManager"},"UIManager"))),(0,i.kt)("h2",{id:"interfaces"},"Interfaces"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Configurable"},"Configurable")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Createable"},"Createable")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Disposable"},"Disposable")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.FragmentIdMap"},"FragmentIdMap")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Hideable"},"Hideable")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.NavigationMode"},"NavigationMode")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Progress"},"Progress")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Resizeable"},"Resizeable")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},"UI")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Updateable"},"Updateable"))),(0,i.kt)("h2",{id:"type-aliases"},"Type Aliases"),(0,i.kt)("h3",{id:"cameraprojection"},"CameraProjection"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"CameraProjection"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"Perspective"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"Orthographic"')),(0,i.kt)("p",null,"The projection system of the camera."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/navigation/OrthoPerspectiveCamera/src/types.ts#L7"},"temp/components/src/navigation/OrthoPerspectiveCamera/src/types.ts:7")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"navmodeid"},"NavModeID"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"NavModeID"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"Orbit"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"FirstPerson"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"Plan"')),(0,i.kt)("p",null,"The extensible list of supported navigation modes."),(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/IFCjs/components/blob/0c38d20/src/navigation/OrthoPerspectiveCamera/src/types.ts#L12"},"temp/components/src/navigation/OrthoPerspectiveCamera/src/types.ts:12")),(0,i.kt)("h2",{id:"variables"},"Variables"),(0,i.kt)("h3",{id:"dimensionlabelclassname"},"DimensionLabelClassName"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"DimensionLabelClassName"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"text-white text-sm bg-ifcjs-100 rounded-md px-3 py-1"')),(0,i.kt)("p",null,"The name of the CSS class that styles the dimension label."),(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/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/src/types.ts#L4"},"temp/components/src/measurement/LengthMeasurement/src/types.ts:4")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"dimensionpreviewclassname"},"DimensionPreviewClassName"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"DimensionPreviewClassName"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"bg-ifcjs-100 rounded-full w-[8px] h-[8px]"')),(0,i.kt)("p",null,"The name of the CSS class that styles the dimension label."),(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/IFCjs/components/blob/0c38d20/src/measurement/LengthMeasurement/src/types.ts#L8"},"temp/components/src/measurement/LengthMeasurement/src/types.ts:8")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/c5b82270.72eac3ae.js b/build/assets/js/c5b82270.72eac3ae.js deleted file mode 100644 index 6df0e1255..000000000 --- a/build/assets/js/c5b82270.72eac3ae.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2121],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>k});var i=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 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 s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=i.createContext({}),l=function(e){var t=i.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},m=function(e){var t=l(e.components);return i.createElement(p.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,r=e.mdxType,a=e.originalType,p=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),d=l(n),c=r,k=d["".concat(p,".").concat(c)]||d[c]||u[c]||a;return n?i.createElement(k,s(s({ref:t},m),{},{components:n})):i.createElement(k,s({ref:t},m))}));function k(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=n.length,s=new Array(a);s[0]=c;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[d]="string"==typeof e?e:r,s[1]=o;for(var l=2;l{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>u,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var i=n(7462),r=(n(7294),n(3905));const a={id:"openbim_components.Disposer",title:"Class: Disposer",sidebar_label:"Disposer",custom_edit_url:null},s=void 0,o={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"}},p={},l=[{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}],m={toc:l},d="wrapper";function u(e){let{components:t,...n}=e;return(0,r.kt)(d,(0,i.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"),".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/ifcjs/components/blob/e46138a/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"},"Event"),">"),(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/ifcjs/components/blob/e46138a/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/ifcjs/components/blob/e46138a/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/ifcjs/components/blob/e46138a/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/ifcjs/components/blob/e46138a/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/ifcjs/components/blob/e46138a/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/ifcjs/components/blob/e46138a/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/ifcjs/components/blob/e46138a/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/ifcjs/components/blob/e46138a/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/ifcjs/components/blob/e46138a/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/c5b82270.d83902b7.js b/build/assets/js/c5b82270.d83902b7.js new file mode 100644 index 000000000..da0a8fa0b --- /dev/null +++ b/build/assets/js/c5b82270.d83902b7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2121],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>k});var i=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 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 o(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=i.createContext({}),l=function(e){var t=i.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},m=function(e){var t=l(e.components);return i.createElement(p.Provider,{value:t},e.children)},d="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,r=e.mdxType,a=e.originalType,p=e.parentName,m=s(e,["components","mdxType","originalType","parentName"]),d=l(n),u=r,k=d["".concat(p,".").concat(u)]||d[u]||c[u]||a;return n?i.createElement(k,o(o({ref:t},m),{},{components:n})):i.createElement(k,o({ref:t},m))}));function k(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=n.length,o=new Array(a);o[0]=u;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[d]="string"==typeof e?e:r,o[1]=s;for(var l=2;l{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>c,frontMatter:()=>a,metadata:()=>s,toc:()=>l});var i=n(7462),r=(n(7294),n(3905));const a={id:"openbim_components.Disposer",title:"Class: Disposer",sidebar_label:"Disposer",custom_edit_url:null},o=void 0,s={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"}},p={},l=[{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}],m={toc:l},d="wrapper";function c(e){let{components:t,...n}=e;return(0,r.kt)(d,(0,i.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"),".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/IFCjs/components/blob/0c38d20/src/core/Disposer/index.ts#L14"},"temp/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"},"Event"),">"),(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/IFCjs/components/blob/0c38d20/src/core/Disposer/index.ts#L43"},"temp/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/IFCjs/components/blob/0c38d20/src/core/Disposer/index.ts#L64"},"temp/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/IFCjs/components/blob/0c38d20/src/core/Disposer/index.ts#L27"},"temp/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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/src/base-types/component.ts:45")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/c8ce6040.8cb11871.js b/build/assets/js/c8ce6040.6daa9d68.js similarity index 56% rename from build/assets/js/c8ce6040.8cb11871.js rename to build/assets/js/c8ce6040.6daa9d68.js index 6cef4dfb2..8440eff6b 100644 --- a/build/assets/js/c8ce6040.8cb11871.js +++ b/build/assets/js/c8ce6040.6daa9d68.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8182],{3905:(e,n,t)=>{t.d(n,{Zo:()=>s,kt:()=>d});var a=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 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 o(e){for(var n=1;n=0||(r[t]=e[t]);return r}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var l=a.createContext({}),m=function(e){var n=a.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},s=function(e){var n=m(e.components);return a.createElement(l.Provider,{value:n},e.children)},c="mdxType",u={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,r=e.mdxType,i=e.originalType,l=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),c=m(t),f=r,d=c["".concat(l,".").concat(f)]||c[f]||u[f]||i;return t?a.createElement(d,o(o({ref:n},s),{},{components:t})):a.createElement(d,o({ref:n},s))}));function d(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var i=t.length,o=new Array(i);o[0]=f;var p={};for(var l in n)hasOwnProperty.call(n,l)&&(p[l]=n[l]);p.originalType=e,p[c]="string"==typeof e?e:r,o[1]=p;for(var m=2;m{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>p,toc:()=>m});var a=t(7462),r=(t(7294),t(3905));const i={id:"openbim_components.UI",title:"Interface: UI",sidebar_label:"UI",custom_edit_url:null},o=void 0,p={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"}},l={},m=[{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}],s={toc:m},c="wrapper";function u(e){let{components:n,...t}=e;return(0,r.kt)(c,(0,a.Z)({},s,t,{components:n,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".UI"),(0,r.kt)("p",null,"Whether this component has a representation in the user\ninterface, like a button or a window."),(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.FragmentIfcLoader"},(0,r.kt)("inlineCode",{parentName:"a"},"FragmentIfcLoader"))),(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.LocalCacher"},(0,r.kt)("inlineCode",{parentName:"a"},"LocalCacher"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.OrthoPerspectiveCamera"},(0,r.kt)("inlineCode",{parentName:"a"},"OrthoPerspectiveCamera"))),(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.SimpleClipper"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleClipper")))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"uielement"},"uiElement"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"uiElement"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.UIElement"},(0,r.kt)("inlineCode",{parentName:"a"},"UIElement")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"The class containing all the menus of this component."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L190"},"src/base-types/base-types.ts:190")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8182],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,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 o(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({}),m=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=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,i=e.originalType,l=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),c=m(n),d=r,f=c["".concat(l,".").concat(d)]||c[d]||u[d]||i;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,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,o=new Array(i);o[0]=d;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p[c]="string"==typeof e?e:r,o[1]=p;for(var m=2;m{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>p,toc:()=>m});var a=n(7462),r=(n(7294),n(3905));const i={id:"openbim_components.UI",title:"Interface: UI",sidebar_label:"UI",custom_edit_url:null},o=void 0,p={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"}},l={},m=[{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}],s={toc:m},c="wrapper";function u(e){let{components:t,...n}=e;return(0,r.kt)(c,(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".UI"),(0,r.kt)("p",null,"Whether this component has a representation in the user\ninterface, like a button or a window."),(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.FragmentIfcLoader"},(0,r.kt)("inlineCode",{parentName:"a"},"FragmentIfcLoader"))),(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.LocalCacher"},(0,r.kt)("inlineCode",{parentName:"a"},"LocalCacher"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.OrthoPerspectiveCamera"},(0,r.kt)("inlineCode",{parentName:"a"},"OrthoPerspectiveCamera"))),(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.SimpleClipper"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleClipper")))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"uielement"},"uiElement"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"uiElement"),": ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.UIElement"},(0,r.kt)("inlineCode",{parentName:"a"},"UIElement")),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"[name: string]"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"SimpleUIComponent"),"; }",">"),(0,r.kt)("p",null,"The class containing all the buttons, windows, tables, etc., of this component."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L194"},"temp/components/src/base-types/base-types.ts:194")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/cce8cd0d.4d0ecb1b.js b/build/assets/js/cce8cd0d.77e069a1.js similarity index 53% rename from build/assets/js/cce8cd0d.4d0ecb1b.js rename to build/assets/js/cce8cd0d.77e069a1.js index bf6e4daeb..0dffa59dd 100644 --- a/build/assets/js/cce8cd0d.4d0ecb1b.js +++ b/build/assets/js/cce8cd0d.77e069a1.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:()=>l,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>s});var a=n(7462),r=(n(7294),n(3905));const i={id:"openbim_components.Configurable",title:"Interface: Configurable",sidebar_label:"Configurable",custom_edit_url:null},p=void 0,o={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"}},l={},s=[{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:"onSetup",id:"onsetup",level:3},{value:"Defined in",id:"defined-in-1",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-2",level:4}],m={toc:s},d="wrapper";function c(e){let{components:t,...n}=e;return(0,r.kt)(d,(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"),".Configurable"),(0,r.kt)("p",null,"Whether this component supports to be configured."),(0,r.kt)("h2",{id:"type-parameters"},"Type 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"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")))),(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.SimpleScene"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleScene")))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"config"},"config"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"config"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Required"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.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,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable#setup"},"()")," just after the tool is instantiated."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L181"},"src/base-types/base-types.ts:181")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onsetup"},"onSetup"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onSetup"),": ",(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 successfully calling ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable#setup"},"()")),(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/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L176"},"src/base-types/base-types.ts:176")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setup"},"setup"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"setup"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"config?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">",") => ",(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"},"config?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Use the provided configuration to setup the tool."),(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)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">")))),(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-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L173"},"src/base-types/base-types.ts:173")))}c.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)},c="mdxType",d={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"]),c=s(n),u=r,f=c["".concat(l,".").concat(u)]||c[u]||d[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[c]="string"==typeof e?e:r,p[1]=o;for(var s=2;s{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>s});var a=n(7462),r=(n(7294),n(3905));const i={id:"openbim_components.Configurable",title:"Interface: Configurable",sidebar_label:"Configurable",custom_edit_url:null},p=void 0,o={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"}},l={},s=[{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:"onSetup",id:"onsetup",level:3},{value:"Defined in",id:"defined-in-1",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-2",level:4}],m={toc:s},c="wrapper";function d(e){let{components:t,...n}=e;return(0,r.kt)(c,(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"),".Configurable"),(0,r.kt)("p",null,"Whether this component supports to be configured."),(0,r.kt)("h2",{id:"type-parameters"},"Type 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"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")))),(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.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.SimpleScene"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleScene")))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"config"},"config"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"config"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Required"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.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,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable#setup"},"()")," just after the tool is instantiated."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L185"},"temp/components/src/base-types/base-types.ts:185")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onsetup"},"onSetup"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"onSetup"),": ",(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 successfully calling ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Configurable#setup"},"()")),(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/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L180"},"temp/components/src/base-types/base-types.ts:180")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setup"},"setup"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"setup"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"config?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">",") => ",(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"},"config?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Use the provided configuration to setup the tool."),(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)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">")))),(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-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L177"},"temp/components/src/base-types/base-types.ts:177")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/cd51b51b.b03b1a79.js b/build/assets/js/cd51b51b.7c32444d.js similarity index 97% rename from build/assets/js/cd51b51b.b03b1a79.js rename to build/assets/js/cd51b51b.7c32444d.js index 69f6db5e1..f2cfbbecf 100644 --- a/build/assets/js/cd51b51b.b03b1a79.js +++ b/build/assets/js/cd51b51b.7c32444d.js @@ -1 +1 @@ -"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:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>p,toc:()=>s});var r=n(7462),i=(n(7294),n(3905));const a={id:"openbim_components.Hideable",title:"Interface: Hideable",sidebar_label:"Hideable",custom_edit_url:null},o=void 0,p={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"}},l={},s=[{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}],c={toc:s},m="wrapper";function d(e){let{components:t,...n}=e;return(0,i.kt)(m,(0,r.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"),".Hideable"),(0,i.kt)("p",null,"Whether the geometric representation of this component can be\nhidden or shown in the\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/scenes/Scene"},"Three.js scene"),"."),(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.CubeMap"},(0,i.kt)("inlineCode",{parentName:"a"},"CubeMap"))),(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)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleGrid"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleGrid"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimplePlane"},(0,i.kt)("inlineCode",{parentName:"a"},"SimplePlane")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"visible"},"visible"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"visible"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Whether the geometric representation of this component is\ncurrently visible or not in the\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/scenes/Scene"},"Three.js scene"),"."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/base-types.ts#L73"},"src/base-types/base-types.ts:73")))}d.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:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>p,toc:()=>s});var r=n(7462),i=(n(7294),n(3905));const a={id:"openbim_components.Hideable",title:"Interface: Hideable",sidebar_label:"Hideable",custom_edit_url:null},o=void 0,p={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"}},l={},s=[{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}],c={toc:s},m="wrapper";function d(e){let{components:t,...n}=e;return(0,i.kt)(m,(0,r.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"),".Hideable"),(0,i.kt)("p",null,"Whether the geometric representation of this component can be\nhidden or shown in the\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/scenes/Scene"},"Three.js scene"),"."),(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.CubeMap"},(0,i.kt)("inlineCode",{parentName:"a"},"CubeMap"))),(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)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimpleGrid"},(0,i.kt)("inlineCode",{parentName:"a"},"SimpleGrid"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/classes/openbim_components.SimplePlane"},(0,i.kt)("inlineCode",{parentName:"a"},"SimplePlane")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"visible"},"visible"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"visible"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Whether the geometric representation of this component is\ncurrently visible or not in the\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/scenes/Scene"},"Three.js scene"),"."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/base-types.ts#L77"},"temp/components/src/base-types/base-types.ts:77")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/cf0958e4.3898d847.js b/build/assets/js/cf0958e4.3898d847.js deleted file mode 100644 index 7c2136355..000000000 --- a/build/assets/js/cf0958e4.3898d847.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 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 p=i.createContext({}),l=function(e){var n=i.useContext(p),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(p.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,p=e.parentName,m=r(e,["components","mdxType","originalType","parentName"]),d=l(t),c=a,b=d["".concat(p,".").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 r={};for(var p in n)hasOwnProperty.call(n,p)&&(r[p]=n[p]);r.originalType=e,r[d]="string"==typeof e?e:a,s[1]=r;for(var l=2;l{t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>l});var i=t(7462),a=(t(7294),t(3905));const o={id:"openbim_components.FragmentBoundingBox",title:"Class: FragmentBoundingBox",sidebar_label:"FragmentBoundingBox",custom_edit_url:null},s=void 0,r={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:"FragmentIfcLoader",permalink:"/api/classes/openbim_components.FragmentIfcLoader"}},p={},l=[{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:"Methods",id:"methods",level:2},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Implementation of",id:"implementation-of",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:"Inherited from",id:"inherited-from",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:"Inherited from",id:"inherited-from-1",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:"Inherited from",id:"inherited-from-2",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:"Inherited from",id:"inherited-from-3",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:"Inherited from",id:"inherited-from-4",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:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4}],m={toc:l},d="wrapper";function u(e){let{components:n,...t}=e;return(0,a.kt)(d,(0,i.Z)({},m,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/ifcjs/components/blob/e46138a/src/fragments/FragmentBoundingBox/index.ts#L15"},"src/fragments/FragmentBoundingBox/index.ts:15")),(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"},"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-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/fragments/FragmentBoundingBox/index.ts#L68"},"src/fragments/FragmentBoundingBox/index.ts:68")),(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-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-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-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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/cf0958e4.ab674671.js b/build/assets/js/cf0958e4.ab674671.js new file mode 100644 index 000000000..65eb741eb --- /dev/null +++ b/build/assets/js/cf0958e4.ab674671.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 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 s(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):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,o=e.mdxType,a=e.originalType,r=e.parentName,m=p(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,s(s({ref:n},m),{},{components:t})):i.createElement(b,s({ref:n},m))}));function b(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var a=t.length,s=new Array(a);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:o,s[1]=p;for(var l=2;l{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>s,default:()=>u,frontMatter:()=>a,metadata:()=>p,toc:()=>l});var i=t(7462),o=(t(7294),t(3905));const a={id:"openbim_components.FragmentBoundingBox",title:"Class: FragmentBoundingBox",sidebar_label:"FragmentBoundingBox",custom_edit_url:null},s=void 0,p={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:"FragmentIfcLoader",permalink:"/api/classes/openbim_components.FragmentIfcLoader"}},r={},l=[{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}],m={toc:l},d="wrapper";function u(e){let{components:n,...t}=e;return(0,o.kt)(d,(0,i.Z)({},m,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/IFCjs/components/blob/0c38d20/src/fragments/FragmentBoundingBox/index.ts#L17"},"temp/components/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/IFCjs/components/blob/0c38d20/src/fragments/FragmentBoundingBox/index.ts#L20"},"temp/components/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/IFCjs/components/blob/0c38d20/src/fragments/FragmentBoundingBox/index.ts#L73"},"temp/components/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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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-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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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-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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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-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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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-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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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-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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/src/base-types/component.ts:45")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/e0514c78.760999ee.js b/build/assets/js/e0514c78.760999ee.js deleted file mode 100644 index 75c1c37d0..000000000 --- a/build/assets/js/e0514c78.760999ee.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 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 s(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 p=i.createContext({}),l=function(e){var n=i.useContext(p),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(p.Provider,{value:n},e.children)},c="mdxType",d={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,r=e.originalType,p=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),c=l(t),u=a,b=c["".concat(p,".").concat(u)]||c[u]||d[u]||r;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 r=t.length,s=new Array(r);s[0]=u;var o={};for(var p in n)hasOwnProperty.call(n,p)&&(o[p]=n[p]);o.originalType=e,o[c]="string"==typeof e?e:a,s[1]=o;for(var l=2;l{t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var i=t(7462),a=(t(7294),t(3905));const r={id:"openbim_components.UIManager",title:"Class: UIManager",sidebar_label:"UIManager",custom_edit_url:null},s=void 0,o={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"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{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",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-1",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-2",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-3",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-4",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-5",level:4}],m={toc:l},c="wrapper";function d(e){let{components:n,...t}=e;return(0,a.kt)(c,(0,i.Z)({},m,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".UIManager"),(0,a.kt)("p",null,"A component that handles all UI components."),(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"},"Toolbar"),"[]",">"),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"UIManager"))))),(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:"methods"},"Methods"),(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"},"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"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-1"},"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-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-2"},"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-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-3"},"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-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-4"},"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-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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-5"},"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-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L45"},"src/base-types/component.ts:45")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/e0514c78.db5b45be.js b/build/assets/js/e0514c78.db5b45be.js new file mode 100644 index 000000000..2c215fe02 --- /dev/null +++ b/build/assets/js/e0514c78.db5b45be.js @@ -0,0 +1 @@ +"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 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 o(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):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,s=e.originalType,r=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),d=l(t),u=a,b=d["".concat(r,".").concat(u)]||d[u]||c[u]||s;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 s=t.length,o=new Array(s);o[0]=u;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,o[1]=p;for(var l=2;l{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>c,frontMatter:()=>s,metadata:()=>p,toc:()=>l});var i=t(7462),a=(t(7294),t(3905));const s={id:"openbim_components.UIManager",title:"Class: UIManager",sidebar_label:"UIManager",custom_edit_url:null},o=void 0,p={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"}},r={},l=[{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}],m={toc:l},d="wrapper";function c(e){let{components:n,...t}=e;return(0,a.kt)(d,(0,i.Z)({},m,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".UIManager"),(0,a.kt)("p",null,"A component that handles all UI components."),(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"},"Toolbar"),"[]",">"),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"UIManager"))))),(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:"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"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/ui/UIManager/index.ts#L30"},"temp/components/src/ui/UIManager/index.ts:30")),(0,a.kt)("h2",{id:"methods"},"Methods"),(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"},"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-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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-1"},"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-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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-2"},"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-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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-3"},"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-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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-4"},"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-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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-5"},"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-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/src/base-types/component.ts:45")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/ec8bc08e.19e4afa1.js b/build/assets/js/ec8bc08e.557313a0.js similarity index 57% rename from build/assets/js/ec8bc08e.19e4afa1.js rename to build/assets/js/ec8bc08e.557313a0.js index 7655fc5fc..2d5fd8c07 100644 --- a/build/assets/js/ec8bc08e.19e4afa1.js +++ b/build/assets/js/ec8bc08e.557313a0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[901],{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 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 o(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 p=a.createContext({}),d=function(e){var t=a.useContext(p),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(p.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,p=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),m=d(n),u=r,k=m["".concat(p,".").concat(u)]||m[u]||c[u]||i;return n?a.createElement(k,o(o({ref:t},s),{},{components:n})):a.createElement(k,o({ref:t},s))}));function k(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,o=new Array(i);o[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:r,o[1]=l;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var a=n(7462),r=(n(7294),n(3905));const i={id:"openbim_components.MapboxWindow",title:"Class: MapboxWindow",sidebar_label:"MapboxWindow",custom_edit_url:null},o=void 0,l={unversionedId:"api/classes/openbim_components.MapboxWindow",id:"api/classes/openbim_components.MapboxWindow",title:"Class: MapboxWindow",description:"openbim-components.MapboxWindow",source:"@site/docs/api/classes/openbim_components.MapboxWindow.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.MapboxWindow",permalink:"/api/classes/openbim_components.MapboxWindow",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.MapboxWindow",title:"Class: MapboxWindow",sidebar_label:"MapboxWindow",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"LocalCacher",permalink:"/api/classes/openbim_components.LocalCacher"},next:{title:"MaterialManager",permalink:"/api/classes/openbim_components.MaterialManager"}},p={},d=[{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods",level:2},{value:"add",id:"add",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:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"remove",id:"remove",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},{value:"removeAll",id:"removeall",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4}],s={toc:d},m="wrapper";function c(e){let{components:t,...n}=e;return(0,r.kt)(m,(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".MapboxWindow"),(0,r.kt)("p",null,"The main element to create a mapbox-IFC.js application."),(0,r.kt)("h2",{id:"constructors"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new MapboxWindow"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.MapboxWindow"},(0,r.kt)("inlineCode",{parentName:"a"},"MapboxWindow"))),(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"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"MapboxParameters"))))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.MapboxWindow"},(0,r.kt)("inlineCode",{parentName:"a"},"MapboxWindow"))),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/integrations/mapbox/index.ts#L27"},"src/integrations/mapbox/index.ts:27")),(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"},"buildings"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fitToScreen?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Add a new set of buildings to the GIS scene."),(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"},"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"},"buildings")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"MapboxBuilding"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The array of MapboxBuilding to add.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fitToScreen")),(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 center the camera to see all buildings.")))),(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-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/integrations/mapbox/index.ts#L44"},"src/integrations/mapbox/index.ts:44")),(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,"Disposes all the data of the map. This needs to be called if the\ncomponent that contains the map is deleted: otherwise, a memory leak\nwill be created."),(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:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/integrations/mapbox/index.ts#L107"},"src/integrations/mapbox/index.ts:107")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"remove"},"remove"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"remove"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Removes a building from the map."),(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 MapboxBuilding to remove.")))),(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-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/integrations/mapbox/index.ts#L81"},"src/integrations/mapbox/index.ts:81")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removeall"},"removeAll"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeAll"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Removes all buildings from the map."),(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:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/integrations/mapbox/index.ts#L96"},"src/integrations/mapbox/index.ts:96")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[901],{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 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 o(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 p=a.createContext({}),d=function(e){var t=a.useContext(p),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(p.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,p=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),m=d(n),u=r,k=m["".concat(p,".").concat(u)]||m[u]||c[u]||i;return n?a.createElement(k,o(o({ref:t},s),{},{components:n})):a.createElement(k,o({ref:t},s))}));function k(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,o=new Array(i);o[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:r,o[1]=l;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var a=n(7462),r=(n(7294),n(3905));const i={id:"openbim_components.MapboxWindow",title:"Class: MapboxWindow",sidebar_label:"MapboxWindow",custom_edit_url:null},o=void 0,l={unversionedId:"api/classes/openbim_components.MapboxWindow",id:"api/classes/openbim_components.MapboxWindow",title:"Class: MapboxWindow",description:"openbim-components.MapboxWindow",source:"@site/docs/api/classes/openbim_components.MapboxWindow.md",sourceDirName:"api/classes",slug:"/api/classes/openbim_components.MapboxWindow",permalink:"/api/classes/openbim_components.MapboxWindow",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"openbim_components.MapboxWindow",title:"Class: MapboxWindow",sidebar_label:"MapboxWindow",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"LocalCacher",permalink:"/api/classes/openbim_components.LocalCacher"},next:{title:"MaterialManager",permalink:"/api/classes/openbim_components.MaterialManager"}},p={},d=[{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods",level:2},{value:"add",id:"add",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:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"remove",id:"remove",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},{value:"removeAll",id:"removeall",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4}],s={toc:d},m="wrapper";function c(e){let{components:t,...n}=e;return(0,r.kt)(m,(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/modules/openbim_components"},"openbim-components"),".MapboxWindow"),(0,r.kt)("p",null,"The main element to create a mapbox-IFC.js application."),(0,r.kt)("h2",{id:"constructors"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new MapboxWindow"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.MapboxWindow"},(0,r.kt)("inlineCode",{parentName:"a"},"MapboxWindow"))),(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"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"MapboxParameters"))))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.MapboxWindow"},(0,r.kt)("inlineCode",{parentName:"a"},"MapboxWindow"))),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/integrations/mapbox/index.ts#L27"},"temp/components/src/integrations/mapbox/index.ts:27")),(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"},"buildings"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fitToScreen?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Add a new set of buildings to the GIS scene."),(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"},"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"},"buildings")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"MapboxBuilding"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The array of MapboxBuilding to add.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fitToScreen")),(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 center the camera to see all buildings.")))),(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-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/integrations/mapbox/index.ts#L44"},"temp/components/src/integrations/mapbox/index.ts:44")),(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,"Disposes all the data of the map. This needs to be called if the\ncomponent that contains the map is deleted: otherwise, a memory leak\nwill be created."),(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:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/integrations/mapbox/index.ts#L107"},"temp/components/src/integrations/mapbox/index.ts:107")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"remove"},"remove"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"remove"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Removes a building from the map."),(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 MapboxBuilding to remove.")))),(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-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/integrations/mapbox/index.ts#L81"},"temp/components/src/integrations/mapbox/index.ts:81")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removeall"},"removeAll"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeAll"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Removes all buildings from the map."),(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:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/integrations/mapbox/index.ts#L96"},"temp/components/src/integrations/mapbox/index.ts:96")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/ece573d0.f661f870.js b/build/assets/js/ece573d0.74adc61a.js similarity index 60% rename from build/assets/js/ece573d0.f661f870.js rename to build/assets/js/ece573d0.74adc61a.js index 3241e07d0..fadf9716b 100644 --- a/build/assets/js/ece573d0.f661f870.js +++ b/build/assets/js/ece573d0.74adc61a.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:()=>o,contentTitle:()=>i,default:()=>c,frontMatter:()=>l,metadata:()=>p,toc:()=>s});var a=n(7462),r=(n(7294),n(3905));const l={id:"openbim_components.UIElement",title:"Class: UIElement",sidebar_label:"UIElement",custom_edit_url:null},i=void 0,p={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"}},o={},s=[{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}],m={toc:s},d="wrapper";function c(e){let{components:t,...n}=e;return(0,r.kt)(d,(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"),".UIElement"),(0,r.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,r.kt)("h2",{id:"type-parameters"},"Type 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"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Object"))))),(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,"Release all the memory used by this instance deleting all the UI components\ninside."),(0,r.kt)("h4",{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/ifcjs/components/blob/e46138a/src/base-types/ui-element.ts#L37"},"src/base-types/ui-element.ts:37")),(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"},"U"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"name"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"U")),(0,r.kt)("p",null,"Gets the UI Component with the given name. If it doesn't exist, it will\nthrow an error."),(0,r.kt)("h4",{id:"type-parameters-1"},"Type 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"},"U")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SimpleUIComponent"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"HTMLElement"),">")))),(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"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},"keyof ",(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the identifier of the UI component.")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"U")),(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/ifcjs/components/blob/e46138a/src/base-types/ui-element.ts#L17"},"src/base-types/ui-element.ts:17")),(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"},"data"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Sets all the UI components of this instance."),(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"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"all the UI components sorted by name in an object.")))),(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-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/ui-element.ts#L29"},"src/base-types/ui-element.ts:29")))}c.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:()=>o,contentTitle:()=>i,default:()=>c,frontMatter:()=>l,metadata:()=>p,toc:()=>s});var a=n(7462),r=(n(7294),n(3905));const l={id:"openbim_components.UIElement",title:"Class: UIElement",sidebar_label:"UIElement",custom_edit_url:null},i=void 0,p={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"}},o={},s=[{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}],m={toc:s},d="wrapper";function c(e){let{components:t,...n}=e;return(0,r.kt)(d,(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"),".UIElement"),(0,r.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,r.kt)("h2",{id:"type-parameters"},"Type 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"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Object"))))),(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,"Release all the memory used by this instance deleting all the UI components\ninside."),(0,r.kt)("h4",{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/IFCjs/components/blob/0c38d20/src/base-types/ui-element.ts#L37"},"temp/components/src/base-types/ui-element.ts:37")),(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"},"U"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"name"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"U")),(0,r.kt)("p",null,"Gets the UI Component with the given name. If it doesn't exist, it will\nthrow an error."),(0,r.kt)("h4",{id:"type-parameters-1"},"Type 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"},"U")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SimpleUIComponent"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"HTMLElement"),">")))),(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"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},"keyof ",(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the identifier of the UI component.")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"U")),(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/IFCjs/components/blob/0c38d20/src/base-types/ui-element.ts#L17"},"temp/components/src/base-types/ui-element.ts:17")),(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"},"data"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Sets all the UI components of this instance."),(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"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"all the UI components sorted by name in an object.")))),(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-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/ui-element.ts#L29"},"temp/components/src/base-types/ui-element.ts:29")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/f7fb8d22.038dc247.js b/build/assets/js/f7fb8d22.038dc247.js new file mode 100644 index 000000000..bdfe28465 --- /dev/null +++ b/build/assets/js/f7fb8d22.038dc247.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6632],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>c});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 l(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 a(e){for(var t=1;t=0||(p[n]=e[n]);return p}(e,t);if(Object.getOwnPropertySymbols){var l=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):a(a({},t),e)),n},d=function(e){var t=s(e.components);return i.createElement(o.Provider,{value:t},e.children)},m="mdxType",k={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,p=e.mdxType,l=e.originalType,o=e.parentName,d=r(e,["components","mdxType","originalType","parentName"]),m=s(n),h=p,c=m["".concat(o,".").concat(h)]||m[h]||k[h]||l;return n?i.createElement(c,a(a({ref:t},d),{},{components:n})):i.createElement(c,a({ref:t},d))}));function c(e,t){var n=arguments,p=t&&t.mdxType;if("string"==typeof e||p){var l=n.length,a=new Array(l);a[0]=h;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,a[1]=r;for(var s=2;s{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>a,default:()=>k,frontMatter:()=>l,metadata:()=>r,toc:()=>s});var i=n(7462),p=(n(7294),n(3905));const l={id:"openbim_components.EdgesClipper",title:"Class: EdgesClipper",sidebar_label:"EdgesClipper",custom_edit_url:null},a=void 0,r={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"}},o={},s=[{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}],d={toc:s},m="wrapper";function k(e){let{components:t,...n}=e;return(0,p.kt)(m,(0,i.Z)({},d,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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L35"},"temp/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)("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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L38"},"temp/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:"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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L44"},"temp/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:"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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L41"},"temp/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:"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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L73"},"temp/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:"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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L60"},"temp/components/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/IFCjs/components/blob/0c38d20/src/navigation/EdgesClipper/index.ts#L14"},"temp/components/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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L67"},"temp/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:"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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L52"},"temp/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:"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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L88"},"temp/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:"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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L93"},"temp/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:"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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L118"},"temp/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:"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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L123"},"temp/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:"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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L131"},"temp/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:"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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L136"},"temp/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:"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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L105"},"temp/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:"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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L110"},"temp/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:"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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L184"},"temp/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)("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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L200"},"temp/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)("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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L215"},"temp/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:"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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L227"},"temp/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/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/IFCjs/components/blob/0c38d20/src/navigation/EdgesClipper/index.ts#L26"},"temp/components/src/navigation/EdgesClipper/index.ts:26")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L158"},"temp/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-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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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-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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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-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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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-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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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-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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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-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/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/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/IFCjs/components/blob/0c38d20/src/navigation/EdgesClipper/index.ts#L34"},"temp/components/src/navigation/EdgesClipper/index.ts:34")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/f7fb8d22.bbd42848.js b/build/assets/js/f7fb8d22.bbd42848.js deleted file mode 100644 index 357f1a23f..000000000 --- a/build/assets/js/f7fb8d22.bbd42848.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 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 l(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 l=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):p(p({},t),e)),n},d=function(e){var t=s(e.components);return i.createElement(o.Provider,{value:t},e.children)},m="mdxType",k={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,l=e.originalType,o=e.parentName,d=r(e,["components","mdxType","originalType","parentName"]),m=s(n),h=a,f=m["".concat(o,".").concat(h)]||m[h]||k[h]||l;return n?i.createElement(f,p(p({ref:t},d),{},{components:n})):i.createElement(f,p({ref:t},d))}));function f(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=n.length,p=new Array(l);p[0]=h;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,p[1]=r;for(var s=2;s{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>k,frontMatter:()=>l,metadata:()=>r,toc:()=>s});var i=n(7462),a=(n(7294),n(3905));const l={id:"openbim_components.EdgesClipper",title:"Class: EdgesClipper",sidebar_label:"EdgesClipper",custom_edit_url:null},p=void 0,r={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"}},o={},s=[{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:"orthogonalY",id:"orthogonaly",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"styles",id:"styles",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"toleranceOrthogonalY",id:"toleranceorthogonaly",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"uiElement",id:"uielement",level:3},{value:"Inherited from",id:"inherited-from-6",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:"Inherited from",id:"inherited-from-7",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:"Inherited from",id:"inherited-from-8",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:"Inherited from",id:"inherited-from-9",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:"Inherited from",id:"inherited-from-10",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:"Inherited from",id:"inherited-from-11",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:"Inherited from",id:"inherited-from-12",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:"Inherited from",id:"inherited-from-13",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:"Inherited from",id:"inherited-from-14",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:"Inherited from",id:"inherited-from-15",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:"Inherited from",id:"inherited-from-16",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:"Inherited from",id:"inherited-from-17",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:"Inherited from",id:"inherited-from-18",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:"Overrides",id:"overrides",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:"Inherited from",id:"inherited-from-19",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-20",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-21",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-22",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-23",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-24",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-25",level:4},{value:"Defined in",id:"defined-in-27",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-28",level:4}],d={toc:s},m="wrapper";function k(e){let{components:t,...n}=e;return(0,a.kt)(m,(0,i.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"),".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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L35"},"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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L38"},"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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L44"},"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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L41"},"src/core/SimpleClipper/index.ts:41")),(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-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#orthogonaly"},"orthogonalY")),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L60"},"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-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/navigation/EdgesClipper/index.ts#L14"},"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-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#toleranceorthogonaly"},"toleranceOrthogonalY")),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L67"},"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-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#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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L52"},"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-7"},"Inherited from"),(0,a.kt)("p",null,"SimpleClipper.enabled"),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L85"},"src/core/SimpleClipper/index.ts:85")),(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-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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L90"},"src/core/SimpleClipper/index.ts:90")),(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-9"},"Inherited from"),(0,a.kt)("p",null,"SimpleClipper.material"),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L115"},"src/core/SimpleClipper/index.ts:115")),(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-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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L120"},"src/core/SimpleClipper/index.ts:120")),(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-11"},"Inherited from"),(0,a.kt)("p",null,"SimpleClipper.size"),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L128"},"src/core/SimpleClipper/index.ts:128")),(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-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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L133"},"src/core/SimpleClipper/index.ts:133")),(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-13"},"Inherited from"),(0,a.kt)("p",null,"SimpleClipper.visible"),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L102"},"src/core/SimpleClipper/index.ts:102")),(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-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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L107"},"src/core/SimpleClipper/index.ts:107")),(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-15"},"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-16"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L179"},"src/core/SimpleClipper/index.ts:179")),(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-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#createfromnormalandcoplanarpoint"},"createFromNormalAndCoplanarPoint")),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L195"},"src/core/SimpleClipper/index.ts:195")),(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-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#delete"},"delete")),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L210"},"src/core/SimpleClipper/index.ts:210")),(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-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#deleteall"},"deleteAll")),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L222"},"src/core/SimpleClipper/index.ts:222")),(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-20"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/navigation/EdgesClipper/index.ts#L26"},"src/navigation/EdgesClipper/index.ts:26")),(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-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#get"},"get")),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L155"},"src/core/SimpleClipper/index.ts:155")),(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-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#hasui"},"hasUI")),(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/ifcjs/components/blob/e46138a/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-15"},"Returns"),(0,a.kt)("p",null,"this is Configurable"),(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#isconfigurable"},"isConfigurable")),(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/ifcjs/components/blob/e46138a/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-16"},"Returns"),(0,a.kt)("p",null,"this is Disposable"),(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#isdisposeable"},"isDisposeable")),(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/ifcjs/components/blob/e46138a/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-17"},"Returns"),(0,a.kt)("p",null,"this is Hideable"),(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#ishideable"},"isHideable")),(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/ifcjs/components/blob/e46138a/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-18"},"Returns"),(0,a.kt)("p",null,"this is Resizeable"),(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#isresizeable"},"isResizeable")),(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/ifcjs/components/blob/e46138a/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-19"},"Returns"),(0,a.kt)("p",null,"this is Updateable"),(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#isupdateable"},"isUpdateable")),(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/ifcjs/components/blob/e46138a/src/base-types/component.ts#L45"},"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-28"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/navigation/EdgesClipper/index.ts#L34"},"src/navigation/EdgesClipper/index.ts:34")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/fa613aa0.1073a588.js b/build/assets/js/fa613aa0.1073a588.js new file mode 100644 index 000000000..b4c35377e --- /dev/null +++ b/build/assets/js/fa613aa0.1073a588.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3060],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,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},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,u=d["".concat(o,".").concat(c)]||d[c]||k[c]||p;return n?i.createElement(u,l(l({ref:t},m),{},{components:n})):i.createElement(u,l({ref:t},m))}));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]=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:()=>o,contentTitle:()=>l,default:()=>k,frontMatter:()=>p,metadata:()=>r,toc:()=>s});var i=n(7462),a=(n(7294),n(3905));const p={id:"openbim_components.SimpleClipper",title:"Class: SimpleClipper",sidebar_label:"SimpleClipper",custom_edit_url:null},l=void 0,r={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"}},o={},s=[{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}],m={toc:s},d="wrapper";function k(e){let{components:t,...n}=e;return(0,a.kt)(d,(0,i.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"),".SimpleClipper"),(0,a.kt)("p",null,"A lightweight component to easily create and handle\n",(0,a.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/materials/Material.clippingPlanes"},"clipping planes"),"."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Param"))),(0,a.kt)("p",null,"the instance of ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Components"},"Components")," used."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Param"))),(0,a.kt)("p",null,"the type of plane to be used by the clipper.\nE.g. ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),"."),(0,a.kt)("h2",{id:"type-parameters"},"Type 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"},"T")),(0,a.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,a.kt)("a",{parentName:"td",href:"/api/classes/openbim_components.SimplePlane"},(0,a.kt)("inlineCode",{parentName:"a"},"SimplePlane")))))),(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"},"T"),"[]",">"),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"SimpleClipper"))),(0,a.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.EdgesClipper"},(0,a.kt)("inlineCode",{parentName:"a"},"EdgesClipper"))))),(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.Createable"},(0,a.kt)("inlineCode",{parentName:"a"},"Createable"))),(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)("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)("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)("inlineCode",{parentName:"p"},"T"),">"),(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:"implementation-of"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L35"},"temp/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)("inlineCode",{parentName:"p"},"T"),">"),(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:"implementation-of-1"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L38"},"temp/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:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L44"},"temp/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:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L41"},"temp/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:"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-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L73"},"temp/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:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L60"},"temp/components/src/core/SimpleClipper/index.ts:60")),(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.SimpleClipper#orthogonaly"},"orthogonalY"),"\nhas to be ",(0,a.kt)("inlineCode",{parentName:"p"},"true")," for this to apply."),(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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L67"},"temp/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:"implementation-of-3"},"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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L52"},"temp/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:"overrides"},"Overrides"),(0,a.kt)("p",null,"Component.enabled"),(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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L88"},"temp/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:"overrides-1"},"Overrides"),(0,a.kt)("p",null,"Component.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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L93"},"temp/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:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L118"},"temp/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:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L123"},"temp/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:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L131"},"temp/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:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L136"},"temp/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:"implementation-of-4"},"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-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L105"},"temp/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:"implementation-of-5"},"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-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L110"},"temp/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:"implementation-of-6"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#create"},"create")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L184"},"temp/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)("inlineCode",{parentName:"p"},"T")),(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)("inlineCode",{parentName:"p"},"T")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L200"},"temp/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)("inlineCode",{parentName:"td"},"T")),(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:"implementation-of-7"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,a.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#delete"},"delete")),(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/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L215"},"temp/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:"defined-in-19"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L227"},"temp/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/interfaces/openbim_components.Disposable#dispose"},"Disposable.dispose")),(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:"implementation-of-8"},"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-20"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L163"},"temp/components/src/core/SimpleClipper/index.ts:163")),(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"},"T"),"[]"),(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)("inlineCode",{parentName:"p"},"T"),"[]"),(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-21"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/core/SimpleClipper/index.ts#L158"},"temp/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"},"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-22"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L62"},"temp/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-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-23"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L57"},"temp/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-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-24"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L35"},"temp/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-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-25"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L52"},"temp/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-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-26"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L40"},"temp/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-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-27"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/IFCjs/components/blob/0c38d20/src/base-types/component.ts#L45"},"temp/components/src/base-types/component.ts:45")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/build/assets/js/fa613aa0.74c5e628.js b/build/assets/js/fa613aa0.74c5e628.js deleted file mode 100644 index cecc6806b..000000000 --- a/build/assets/js/fa613aa0.74c5e628.js +++ /dev/null @@ -1 +0,0 @@ -"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 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 p(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var l=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",k={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,i=e.mdxType,l=e.originalType,o=e.parentName,m=r(e,["components","mdxType","originalType","parentName"]),d=s(n),c=i,u=d["".concat(o,".").concat(c)]||d[c]||k[c]||l;return n?a.createElement(u,p(p({ref:t},m),{},{components:n})):a.createElement(u,p({ref:t},m))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var l=n.length,p=new Array(l);p[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:i,p[1]=r;for(var s=2;s{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>k,frontMatter:()=>l,metadata:()=>r,toc:()=>s});var a=n(7462),i=(n(7294),n(3905));const l={id:"openbim_components.SimpleClipper",title:"Class: SimpleClipper",sidebar_label:"SimpleClipper",custom_edit_url:null},p=void 0,r={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"}},o={},s=[{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:"orthogonalY",id:"orthogonaly",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"toleranceOrthogonalY",id:"toleranceorthogonaly",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"uiElement",id:"uielement",level:3},{value:"Implementation of",id:"implementation-of-2",level:4},{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:"Overrides",id:"overrides",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:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"material",id:"material",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"visible",id:"visible",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Implementation of",id:"implementation-of-4",level:4},{value:"Defined in",id:"defined-in-14",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-5",level:4},{value:"Defined in",id:"defined-in-15",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-16",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-6",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"deleteAll",id:"deleteall",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Implementation of",id:"implementation-of-7",level:4},{value:"Defined in",id:"defined-in-19",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-20",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-21",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-22",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-23",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-24",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-25",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-26",level:4}],m={toc:s},d="wrapper";function k(e){let{components:t,...n}=e;return(0,i.kt)(d,(0,a.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"),".SimpleClipper"),(0,i.kt)("p",null,"A lightweight component to easily create and handle\n",(0,i.kt)("a",{parentName:"p",href:"https://threejs.org/docs/#api/en/materials/Material.clippingPlanes"},"clipping planes"),"."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Param"))),(0,i.kt)("p",null,"the instance of ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Components"},"Components")," used."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Param"))),(0,i.kt)("p",null,"the type of plane to be used by the clipper.\nE.g. ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimplePlane"},"SimplePlane"),"."),(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)("a",{parentName:"td",href:"/api/classes/openbim_components.SimplePlane"},(0,i.kt)("inlineCode",{parentName:"a"},"SimplePlane")))))),(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)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},(0,i.kt)("inlineCode",{parentName:"a"},"Component")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"SimpleClipper"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.EdgesClipper"},(0,i.kt)("inlineCode",{parentName:"a"},"EdgesClipper"))))),(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.Createable"},(0,i.kt)("inlineCode",{parentName:"a"},"Createable"))),(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)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.Hideable"},(0,i.kt)("inlineCode",{parentName:"a"},"Hideable"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/api/interfaces/openbim_components.UI"},(0,i.kt)("inlineCode",{parentName:"a"},"UI")))),(0,i.kt)("h2",{id:"properties"},"Properties"),(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"},"T"),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onaftercreate"},"Createable.onAfterCreate")),(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.Createable"},"Createable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onaftercreate"},"onAfterCreate")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L35"},"src/core/SimpleClipper/index.ts:35")),(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"},"T"),">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onafterdelete"},"Createable.onAfterDelete")),(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.Createable"},"Createable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#onafterdelete"},"onAfterDelete")),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L38"},"src/core/SimpleClipper/index.ts:38")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onafterdrag"},"onAfterDrag"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onAfterDrag"),": ",(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"},"void"),">"),(0,i.kt)("p",null,"Event that fires when the user stops dragging a clipping plane."),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L44"},"src/core/SimpleClipper/index.ts:44")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"onbeforedrag"},"onBeforeDrag"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"onBeforeDrag"),": ",(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"},"void"),">"),(0,i.kt)("p",null,"Event that fires when the user starts dragging a clipping plane."),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L41"},"src/core/SimpleClipper/index.ts:41")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"orthogonaly"},"orthogonalY"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"orthogonalY"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"false")),(0,i.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,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L60"},"src/core/SimpleClipper/index.ts:60")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"toleranceorthogonaly"},"toleranceOrthogonalY"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"toleranceOrthogonalY"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"0.7")),(0,i.kt)("p",null,"The tolerance that determines whether a horizontallish clipping plane\nwill be forced to be orthogonal to the Y direction. ",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.SimpleClipper#orthogonaly"},"orthogonalY"),"\nhas to be ",(0,i.kt)("inlineCode",{parentName:"p"},"true")," for this to apply."),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L67"},"src/core/SimpleClipper/index.ts:67")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"uielement"},"uiElement"),(0,i.kt)("p",null,"\u2022 ",(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"},"main"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Button")," }",">"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI#uielement"},"UI.uiElement")),(0,i.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI"},"UI"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.UI#uielement"},"uiElement")),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L52"},"src/core/SimpleClipper/index.ts:52")),(0,i.kt)("h2",{id:"accessors"},"Accessors"),(0,i.kt)("h3",{id:"enabled"},"enabled"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"enabled"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,"Component.enabled"),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L85"},"src/core/SimpleClipper/index.ts:85")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"enabled"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"state"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#enabled"},"Component.enabled")),(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"},"state")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))))),(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:"overrides-1"},"Overrides"),(0,i.kt)("p",null,"Component.enabled"),(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/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L90"},"src/core/SimpleClipper/index.ts:90")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"material"},"material"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"material"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Material")),(0,i.kt)("p",null,"The material of the clipping plane representation."),(0,i.kt)("h4",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Material")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L115"},"src/core/SimpleClipper/index.ts:115")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"material"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"material"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"The material of the clipping plane representation."),(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)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"material")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Material"))))),(0,i.kt)("h4",{id:"returns-3"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L120"},"src/core/SimpleClipper/index.ts:120")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"size"},"size"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"size"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The size of the geometric representation of the clippings planes."),(0,i.kt)("h4",{id:"returns-4"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L128"},"src/core/SimpleClipper/index.ts:128")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"size"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"size"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"The size of the geometric representation of the clippings planes."),(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"},"size")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))))),(0,i.kt)("h4",{id:"returns-5"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L133"},"src/core/SimpleClipper/index.ts:133")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"visible"},"visible"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"visible"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,i.kt)("h4",{id:"returns-6"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"visible")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L102"},"src/core/SimpleClipper/index.ts:102")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"visible"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"state"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"Hideable.visible")),(0,i.kt)("h4",{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"},"state")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,i.kt)("h4",{id:"returns-7"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"implementation-of-4"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable"},"Hideable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Hideable#visible"},"visible")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L107"},"src/core/SimpleClipper/index.ts:107")),(0,i.kt)("h2",{id:"methods"},"Methods"),(0,i.kt)("h3",{id:"create"},"create"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"create"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#create"},"Createable.create")),(0,i.kt)("h4",{id:"returns-8"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"implementation-of-5"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#create"},"create")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L179"},"src/core/SimpleClipper/index.ts:179")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"createfromnormalandcoplanarpoint"},"createFromNormalAndCoplanarPoint"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"createFromNormalAndCoplanarPoint"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"normal"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"point"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"T")),(0,i.kt)("p",null,"Creates a plane in a certain place and with a certain orientation,\nwithout the need of the mouse."),(0,i.kt)("h4",{id:"parameters-4"},"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"},"normal")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Vector3")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the orientation of the clipping plane.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"point")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Vector3")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the position of the clipping plane.")))),(0,i.kt)("h4",{id:"returns-9"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"T")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L195"},"src/core/SimpleClipper/index.ts:195")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"delete"},"delete"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"delete"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"plane?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#delete"},"Createable.delete")),(0,i.kt)("h4",{id:"parameters-5"},"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"},"plane?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T")),(0,i.kt)("td",{parentName:"tr",align:"left"},"the plane to delete. If undefined, the the first plane found under the cursor will be deleted.")))),(0,i.kt)("h4",{id:"returns-10"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"implementation-of-6"},"Implementation of"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable"},"Createable"),".",(0,i.kt)("a",{parentName:"p",href:"/api/interfaces/openbim_components.Createable#delete"},"delete")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L210"},"src/core/SimpleClipper/index.ts:210")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"deleteall"},"deleteAll"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"deleteAll"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Deletes all the existing clipping planes."),(0,i.kt)("h4",{id:"returns-11"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L222"},"src/core/SimpleClipper/index.ts:222")),(0,i.kt)("hr",null),(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-12"},"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-7"},"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-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L160"},"src/core/SimpleClipper/index.ts:160")),(0,i.kt)("hr",null),(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"},"T"),"[]"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"Component.get")),(0,i.kt)("h4",{id:"returns-13"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"T"),"[]"),(0,i.kt)("h4",{id:"overrides-2"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#get"},"get")),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/core/SimpleClipper/index.ts#L155"},"src/core/SimpleClipper/index.ts:155")),(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-14"},"Returns"),(0,i.kt)("p",null,"this is UI"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#hasui"},"hasUI")),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L62"},"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-15"},"Returns"),(0,i.kt)("p",null,"this is Configurable"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isconfigurable"},"isConfigurable")),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L57"},"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-16"},"Returns"),(0,i.kt)("p",null,"this is Disposable"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isdisposeable"},"isDisposeable")),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L35"},"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-17"},"Returns"),(0,i.kt)("p",null,"this is Hideable"),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#ishideable"},"isHideable")),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L52"},"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-18"},"Returns"),(0,i.kt)("p",null,"this is Resizeable"),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isresizeable"},"isResizeable")),(0,i.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/src/base-types/component.ts#L40"},"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-19"},"Returns"),(0,i.kt)("p",null,"this is Updateable"),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component"},"Component"),".",(0,i.kt)("a",{parentName:"p",href:"/api/classes/openbim_components.Component#isupdateable"},"isUpdateable")),(0,i.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/ifcjs/components/blob/e46138a/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/main.468cc623.js b/build/assets/js/main.468cc623.js deleted file mode 100644 index c54201ad0..000000000 --- a/build/assets/js/main.468cc623.js +++ /dev/null @@ -1,2 +0,0 @@ -/*! For license information please see main.468cc623.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":[()=>n.e(7524).then(n.bind(n,3192)),"@site/docs/Tutorials/FragmentTree.mdx",3192],"0b4ea834":[()=>n.e(3877).then(n.bind(n,2510)),"@site/docs/api/interfaces/openbim_components.Updateable.md",2510],"0e384e19":[()=>n.e(9671).then(n.bind(n,9881)),"@site/docs/intro.md",9881],"10f5d381":[()=>n.e(2981).then(n.bind(n,1746)),"@site/docs/api/interfaces/openbim_components.Createable.md",1746],"1202d222":[()=>n.e(1461).then(n.bind(n,9545)),"@site/docs/api/classes/openbim_components.FragmentManager.md",9545],"1590d350":[()=>n.e(5914).then(n.bind(n,4745)),"@site/docs/Tutorials/FragmentCacher.mdx",4745],17896441:[()=>Promise.all([n.e(532),n.e(9455),n.e(7918)]).then(n.bind(n,903)),"@theme/DocItem",903],"18ed70ed":[()=>n.e(5229).then(n.bind(n,9857)),"@site/docs/api/classes/openbim_components.SimplePlane.md",9857],"18f6f55e":[()=>n.e(3116).then(n.bind(n,4631)),"@site/docs/api/classes/openbim_components.EdgesPlane.md",4631],"1be78505":[()=>Promise.all([n.e(532),n.e(9514)]).then(n.bind(n,9963)),"@theme/DocPage",9963],"1f391b9e":[()=>Promise.all([n.e(532),n.e(9455),n.e(3085)]).then(n.bind(n,4247)),"@theme/MDXPage",4247],"23f030fe":[()=>n.e(1569).then(n.bind(n,8995)),"@site/docs/api/classes/openbim_components.ToolComponent.md",8995],"24ba3c39":[()=>n.e(9922).then(n.bind(n,1797)),"@site/docs/Tutorials/FragmentPlans.mdx",1797],"25b18b72":[()=>n.e(7150).then(n.bind(n,285)),"@site/docs/Tutorials/FragmentHighlighter.mdx",285],"27f44bf8":[()=>n.e(2853).then(n.t.bind(n,3769,19)),"/Users/albertomunoz/Documents/personal/ifcjs/docs/.docusaurus/docusaurus-plugin-content-docs/default/plugin-route-context-module-100.json",3769],"2b6dbb63":[()=>n.e(5361).then(n.bind(n,6625)),"@site/docs/Tutorials/LengthMeasurement.mdx",6625],"2fcf8701":[()=>n.e(8561).then(n.bind(n,343)),"@site/docs/api/classes/openbim_components.LocalCacher.md",343],"31eca0ce":[()=>n.e(6827).then(n.bind(n,2647)),"@site/docs/Tutorials/FragmentIfcLoader.mdx",2647],"32cf703e":[()=>n.e(3053).then(n.bind(n,7967)),"@site/docs/Tutorials/IfcPropertiesManager.mdx",7967],"3303a5a5":[()=>n.e(6692).then(n.bind(n,1603)),"@site/docs/api/classes/openbim_components.SimpleRaycaster.md",1603],"338df764":[()=>n.e(9111).then(n.bind(n,6492)),"@site/docs/Tutorials/ScreenCuller.mdx",6492],"34e61bbc":[()=>n.e(6258).then(n.bind(n,3595)),"@site/docs/Tutorials/FragmentManager.mdx",3595],"393be207":[()=>n.e(7414).then(n.bind(n,9286)),"@site/src/pages/markdown-page.md",9286],"399dfa47":[()=>n.e(7260).then(n.bind(n,8185)),"@site/docs/Tutorials/FragmentExploder.mdx",8185],"3c3e2ba6":[()=>n.e(273).then(n.bind(n,8168)),"@site/docs/Tutorials/MiniMap.mdx",8168],"4f2f3afd":[()=>n.e(3554).then(n.bind(n,2689)),"@site/docs/api/interfaces/openbim_components.Disposable.md",2689],"5094df0e":[()=>n.e(7621).then(n.bind(n,3263)),"@site/docs/components/tutorial-paths.md",3263],"51e85c26":[()=>n.e(4345).then(n.bind(n,5563)),"@site/docs/api/classes/openbim_components.Components.md",5563],"5434cfcf":[()=>n.e(527).then(n.bind(n,484)),"@site/docs/Tutorials/ToolsComponent.mdx",484],"55483fbd":[()=>n.e(5241).then(n.bind(n,2502)),"@site/docs/api/classes/openbim_components.Simple2DScene.md",2502],"567fda46":[()=>n.e(347).then(n.bind(n,3091)),"@site/docs/Tutorials/UIManager.mdx",3091],59791038:[()=>n.e(2218).then(n.bind(n,6658)),"@site/docs/api/classes/openbim_components.CloudStorage.md",6658],"5c34dd2a":[()=>n.e(5531).then(n.bind(n,6744)),"@site/docs/api/classes/openbim_components.PostproductionRenderer.md",6744],"5e8c322a":[()=>n.e(7597).then(n.bind(n,7926)),"@site/docs/api/index.md",7926],"5e9f5e1a":[()=>Promise.resolve().then(n.bind(n,6809)),"@generated/docusaurus.config",6809],"5f173d68":[()=>n.e(8440).then(n.bind(n,6580)),"@site/docs/api/classes/openbim_components.SimpleScene.md",6580],"63603fbd":[()=>n.e(9763).then(n.bind(n,9257)),"@site/docs/components/contributing.md",9257],"6488a50e":[()=>n.e(3355).then(n.bind(n,9815)),"@site/docs/Tutorials/AngleMeasurement.mdx",9815],"6713fb58":[()=>n.e(9280).then(n.bind(n,4317)),"@site/docs/api/interfaces/openbim_components.NavigationMode.md",4317],"746f2b6a":[()=>n.e(884).then(n.bind(n,1376)),"@site/docs/api/classes/openbim_components.SimpleRenderer.md",1376],"76e29409":[()=>n.e(7523).then(n.bind(n,8673)),"@site/docs/api/classes/openbim_components.FragmentIfcLoader.md",8673],"7cf9e350":[()=>n.e(1510).then(n.bind(n,6321)),"@site/docs/api/classes/openbim_components.OrthoPerspectiveCamera.md",6321],"82c425bb":[()=>n.e(8604).then(n.bind(n,3106)),"@site/docs/components/getting-started.md",3106],"83488e61":[()=>n.e(6420).then(n.bind(n,6789)),"@site/docs/Tutorials/SimpleClipper.mdx",6789],"84d6d046":[()=>n.e(7735).then(n.bind(n,2388)),"@site/docs/Tutorials/SimpleRaycaster.mdx",2388],"8d23124b":[()=>n.e(5742).then(n.bind(n,9773)),"@site/docs/api/classes/openbim_components.ScreenCuller.md",9773],"9049477b":[()=>n.e(8449).then(n.bind(n,7745)),"@site/docs/Tutorials/IfcPropertiesFinder.mdx",7745],"92d7e00e":[()=>n.e(1835).then(n.bind(n,362)),"@site/docs/Tutorials/FragmentClipStyler.mdx",362],"935f2afb":[()=>n.e(53).then(n.t.bind(n,1109,19)),"~docs/default/version-current-metadata-prop-751.json",1109],"963ae1bc":[()=>n.e(5470).then(n.bind(n,381)),"@site/docs/api/classes/openbim_components.Component.md",381],"969ec0f0":[()=>n.e(8044).then(n.bind(n,1052)),"@site/docs/api/classes/openbim_components.Event.md",1052],"9a5f9594":[()=>n.e(1361).then(n.bind(n,3652)),"@site/docs/Tutorials/IfcPropertiesProcessor.mdx",3652],"9ba2e06a":[()=>n.e(4073).then(n.bind(n,7736)),"@site/docs/api/classes/openbim_components.FragmentPlans.md",7736],"9d7eea47":[()=>n.e(3941).then(n.bind(n,1344)),"@site/docs/components/creating-components.md",1344],"9edcb13d":[()=>n.e(6599).then(n.bind(n,3867)),"@site/docs/api/classes/openbim_components.CubeMap.md",3867],a04d5955:[()=>n.e(1441).then(n.bind(n,3277)),"@site/docs/Tutorials/OrthoPerspectiveCamera.mdx",3277],a1cfb745:[()=>n.e(6796).then(n.t.bind(n,5745,19)),"/Users/albertomunoz/Documents/personal/ifcjs/docs/.docusaurus/docusaurus-plugin-content-pages/default/plugin-route-context-module-100.json",5745],a62869d9:[()=>n.e(3492).then(n.bind(n,806)),"@site/docs/Tutorials/ShadowDropper.mdx",806],a94c8b81:[()=>n.e(3010).then(n.bind(n,931)),"@site/docs/api/classes/openbim_components.IfcJsonExporter.md",931],aad57e98:[()=>n.e(7944).then(n.bind(n,9673)),"@site/docs/api/modules/bim_fragment.md",9673],ab682f67:[()=>n.e(1349).then(n.bind(n,6240)),"@site/docs/api/classes/openbim_components.Mouse.md",6240],addcbcd0:[()=>n.e(6934).then(n.bind(n,9804)),"@site/docs/api/classes/openbim_components.BaseRenderer.md",9804],afcc017a:[()=>n.e(5825).then(n.bind(n,5430)),"@site/docs/api/interfaces/openbim_components.Progress.md",5430],b013f614:[()=>n.e(4829).then(n.bind(n,756)),"@site/docs/api/classes/bim_fragment.Serializer.md",756],b67f8c3e:[()=>n.e(1613).then(n.bind(n,5210)),"@site/docs/Tutorials/SimpleScene.mdx",5210],b82b585f:[()=>n.e(215).then(n.bind(n,9273)),"@site/docs/api/classes/openbim_components.SimpleCamera.md",9273],b82c8867:[()=>n.e(5972).then(n.bind(n,5164)),"@site/docs/api/classes/openbim_components.LengthMeasurement.md",5164],ba12a54e:[()=>n.e(4175).then(n.bind(n,9469)),"@site/docs/api/interfaces/openbim_components.Resizeable.md",9469],bc6e2bb0:[()=>n.e(9799).then(n.bind(n,9308)),"@site/docs/api/classes/openbim_components.SimpleGrid.md",9308],beba2f4c:[()=>n.e(3372).then(n.bind(n,6082)),"@site/docs/Tutorials/EdgesClipper.mdx",6082],bfa94da9:[()=>n.e(5261).then(n.bind(n,2889)),"@site/docs/api/classes/openbim_components.MaterialManager.md",2889],c45a2468:[()=>n.e(930).then(n.bind(n,5666)),"@site/docs/api/modules/openbim_components.md",5666],c4f5d8e4:[()=>n.e(4195).then(n.bind(n,2841)),"@site/src/pages/index.js",2841],c542e6fd:[()=>n.e(8566).then(n.bind(n,7774)),"@site/docs/Tutorials/FragmentBoundingBox.mdx",7774],c5b82270:[()=>n.e(2121).then(n.bind(n,3401)),"@site/docs/api/classes/openbim_components.Disposer.md",3401],c8ce6040:[()=>n.e(8182).then(n.bind(n,642)),"@site/docs/api/interfaces/openbim_components.UI.md",642],ca8c1512:[()=>n.e(7458).then(n.bind(n,2706)),"@site/docs/Tutorials/AreaMeasurement.mdx",2706],cce8cd0d:[()=>n.e(984).then(n.bind(n,1175)),"@site/docs/api/interfaces/openbim_components.Configurable.md",1175],cd51b51b:[()=>n.e(6993).then(n.bind(n,9808)),"@site/docs/api/interfaces/openbim_components.Hideable.md",9808],cf0958e4:[()=>n.e(6630).then(n.bind(n,2069)),"@site/docs/api/classes/openbim_components.FragmentBoundingBox.md",2069],dae2beb5:[()=>n.e(2021).then(n.bind(n,4818)),"@site/docs/Tutorials/MaterialManager.mdx",4818],dccbb392:[()=>n.e(617).then(n.bind(n,8004)),"@site/docs/Tutorials/PostproductionRenderer.mdx",8004],e0514c78:[()=>n.e(2388).then(n.bind(n,5060)),"@site/docs/api/classes/openbim_components.UIManager.md",5060],e33e0127:[()=>n.e(5018).then(n.bind(n,5907)),"@site/docs/Tutorials/Simple2DScene.mdx",5907],e3702cd4:[()=>n.e(2232).then(n.bind(n,186)),"@site/docs/components/clean-components-guide.md",186],e62aa4fb:[()=>n.e(2463).then(n.bind(n,5415)),"@site/docs/api/interfaces/openbim_components.FragmentIdMap.md",5415],ec8bc08e:[()=>n.e(901).then(n.bind(n,5810)),"@site/docs/api/classes/openbim_components.MapboxWindow.md",5810],ece573d0:[()=>n.e(9881).then(n.bind(n,2243)),"@site/docs/api/classes/openbim_components.UIElement.md",2243],f6aebfbf:[()=>n.e(7306).then(n.bind(n,4440)),"@site/docs/api/modules.md",4440],f73cc3ee:[()=>n.e(7115).then(n.bind(n,6943)),"@site/docs/Tutorials/FragmentHider.mdx",6943],f7fb8d22:[()=>n.e(6632).then(n.bind(n,1142)),"@site/docs/api/classes/openbim_components.EdgesClipper.md",1142],fa613aa0:[()=>n.e(3060).then(n.bind(n,6450)),"@site/docs/api/classes/openbim_components.SimpleClipper.md",6450],fe22553b:[()=>n.e(7553).then(n.bind(n,7872)),"@site/docs/that-open-platform/getting-started.mdx",7872]};function c(e){let{error:t,retry:n,pastDelay:a}=e;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 u=n(9670),d=n(226);function p(e,t){if("*"===e)return i()({loading:c,loader:()=>n.e(4972).then(n.bind(n,4972)),modules:["@theme/NotFound"],webpack:()=>[4972],render(e,t){const n=e.default;return r.createElement(d.z,{value:{plugin:{name:"native",id:"default"}}},r.createElement(n,t))}});const o=l[`${e}-${t}`],p={},f=[],m=[],h=(0,u.Z)(o);return Object.entries(h).forEach((e=>{let[t,n]=e;const r=s[n];r&&(p[t]=r[0],f.push(r[1]),m.push(r[2]))})),i().Map({loading:c,loader:p,modules:f,webpack:()=>m,render(t,n){const i=JSON.parse(JSON.stringify(o));Object.entries(t).forEach((t=>{let[n,r]=t;const 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((e=>"default"!==e)).forEach((e=>{a[e]=r[e]}));let o=i;const l=n.split(".");l.slice(0,-1).forEach((e=>{o=o[e]})),o[l[l.length-1]]=a}));const l=i.__comp;delete i.__comp;const s=i.__context;return delete i.__context,r.createElement(d.z,{value:s},r.createElement(l,(0,a.Z)({},i,n)))}})}const f=[{path:"/markdown-page",component:p("/markdown-page","67c"),exact:!0},{path:"/",component:p("/","2b4"),exact:!0},{path:"/",component:p("/","753"),routes:[{path:"/api/",component:p("/api/","093"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/bim_fragment.Serializer",component:p("/api/classes/bim_fragment.Serializer","48d"),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.FragmentIfcLoader",component:p("/api/classes/openbim_components.FragmentIfcLoader","740"),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.LengthMeasurement",component:p("/api/classes/openbim_components.LengthMeasurement","d9c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.LocalCacher",component:p("/api/classes/openbim_components.LocalCacher","252"),exact:!0,sidebar:"tutorialSidebar"},{path:"/api/classes/openbim_components.MapboxWindow",component:p("/api/classes/openbim_components.MapboxWindow","41d"),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.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/FragmentCacher",component:p("/Tutorials/FragmentCacher","2d6"),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/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);const a=r.createContext(!1);function o(e){let{children:t}=e;const[n,o]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{o(!0)}),[]),r.createElement(a.Provider,{value:n},t)}},6287:(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 c=n(723),u=n(6550),d=n(8790);const p={layoutBackgroundParent:"layoutBackgroundParent_KYvk",layoutBackground:"layoutBackground_yBpP",accentGradient:"accentGradient_M8wD","accent-movement":"accent-movement_yUrQ",mainGradient:"mainGradient_chAs","main-movement":"main-movement_AB3j"};function f(){return r.createElement("div",{width:"100%",height:"100%",className:p.accentGradient})}function m(){return r.createElement("div",{width:"100%",height:"100%",className:p.mainGradient})}const h={container:"container_ZB_1",nav:"nav_vnZ4",nav_end:"nav_end_X4Ju"},g=()=>r.createElement("svg",{width:"144",height:"48",fill:"none",xmlns:"http://www.w3.org/2000/svg"},r.createElement("g",{"clip-path":"url(#a)",fill:"#BCF124"},r.createElement("path",{d:"M50.743 23.582V10.086h-4.101V8.58h9.756v1.512h-4.062v13.496l-1.593-.006ZM58.15 23.582V8.58h1.494v6.305l-.34-.08a3.382 3.382 0 0 1 1.305-1.652 3.696 3.696 0 0 1 2.1-.604 4.001 4.001 0 0 1 2.041.523c.597.343 1.092.84 1.434 1.441a4.07 4.07 0 0 1 .525 2.06v7.009h-1.49v-6.427a3.58 3.58 0 0 0-.359-1.671 2.601 2.601 0 0 0-.986-1.057 2.735 2.735 0 0 0-1.424-.373 2.786 2.786 0 0 0-1.433.373 2.625 2.625 0 0 0-1.005 1.067 3.483 3.483 0 0 0-.368 1.66v6.428H58.15ZM72.647 23.823a4.043 4.043 0 0 1-1.812-.393 3.133 3.133 0 0 1-1.255-1.078 2.757 2.757 0 0 1-.459-1.571 3.322 3.322 0 0 1 .36-1.54 3.086 3.086 0 0 1 1.115-1.18 5.182 5.182 0 0 1 1.93-.683l4.177-.706v1.37l-3.82.647c-.77.135-1.325.383-1.663.744a1.828 1.828 0 0 0-.508 1.288 1.586 1.586 0 0 0 .568 1.228c.41.35.935.529 1.47.504a3.746 3.746 0 0 0 1.91-.472 3.374 3.374 0 0 0 1.274-1.28 3.558 3.558 0 0 0 .459-1.793v-2.739a1.99 1.99 0 0 0-.697-1.571c-.464-.404-1.068-.605-1.812-.605a2.998 2.998 0 0 0-1.665.463c-.499.315-.896.77-1.143 1.31l-1.353-.743c.218-.483.541-.91.945-1.249a5.13 5.13 0 0 1 1.484-.892 4.643 4.643 0 0 1 1.732-.331 4.52 4.52 0 0 1 2.084.454c.579.287 1.068.73 1.414 1.28.34.567.513 1.221.497 1.884v7.413H76.39v-2.156l.219.222c-.204.426-.5.802-.866 1.098-.41.34-.875.605-1.374.785-.552.2-1.135.298-1.722.292ZM84.832 23.702c-.955 0-1.69-.282-2.204-.846-.514-.563-.775-1.37-.782-2.417v-6.144h-1.972v-1.51h.503a1.351 1.351 0 0 0 1.075-.447c.27-.315.412-.72.399-1.137v-.907h1.493v2.498h2.351v1.51h-2.351v6.145c-.007.326.047.65.158.957.106.274.299.504.549.654.319.177.68.26 1.044.242.106 0 .233-.007.38-.02.147-.014.271-.027.377-.04v1.35a3.827 3.827 0 0 1-.538.09c-.202.012-.363.022-.482.022ZM98.64 23.823a8.183 8.183 0 0 1-3.107-.583 7.556 7.556 0 0 1-3.48-2.838 7.69 7.69 0 0 1-1.278-4.334c-.01-1.05.19-2.092.588-3.062.38-.924.942-1.76 1.651-2.458a7.666 7.666 0 0 1 2.499-1.635 8.652 8.652 0 0 1 6.251 0c.931.374 1.78.93 2.499 1.635a7.435 7.435 0 0 1 1.653 2.458c.397.97.597 2.012.588 3.062a7.684 7.684 0 0 1-1.279 4.334 7.551 7.551 0 0 1-3.48 2.838 8.181 8.181 0 0 1-3.105.583Zm0-2.825a4.713 4.713 0 0 0 3.405-1.381 4.486 4.486 0 0 0 1.015-1.56 5.366 5.366 0 0 0 .359-1.995 5.283 5.283 0 0 0-.359-1.981 4.632 4.632 0 0 0-1.015-1.561 4.513 4.513 0 0 0-1.522-1.017 5.203 5.203 0 0 0-3.764 0 4.51 4.51 0 0 0-1.524 1.017 4.66 4.66 0 0 0-1.016 1.56 5.292 5.292 0 0 0-.358 1.985 5.361 5.361 0 0 0 .358 1.994 4.516 4.516 0 0 0 1.016 1.561c.438.437.955.782 1.524 1.018.597.247 1.236.371 1.881.366v-.006ZM108.478 27.865V12.584h2.792v2.091l-.26-.605a3.587 3.587 0 0 1 1.469-1.278 4.77 4.77 0 0 1 2.121-.454 5.287 5.287 0 0 1 2.808.766 5.622 5.622 0 0 1 1.991 2.065c.496.887.75 1.892.735 2.91a5.871 5.871 0 0 1-.726 2.901 5.539 5.539 0 0 1-1.982 2.082 5.358 5.358 0 0 1-2.847.764 5.098 5.098 0 0 1-2.057-.412 3.616 3.616 0 0 1-1.523-1.219l.478-.624v6.297l-2.999-.003Zm5.731-6.761a2.802 2.802 0 0 0 1.469-.382c.424-.255.769-.625.995-1.068.246-.485.37-1.025.359-1.571a3.265 3.265 0 0 0-.359-1.561 2.718 2.718 0 0 0-.995-1.068 2.745 2.745 0 0 0-1.469-.394 2.676 2.676 0 0 0-1.424.384 2.6 2.6 0 0 0-.976 1.067 3.722 3.722 0 0 0 0 3.143c.219.442.558.812.976 1.068.431.259.925.391 1.427.382h-.003ZM127.109 23.823c-1.155 0-2.157-.258-3.007-.774a5.326 5.326 0 0 1-1.97-2.082 6.046 6.046 0 0 1-.698-2.9 5.869 5.869 0 0 1 .727-2.941 5.478 5.478 0 0 1 1.96-2.035 5.295 5.295 0 0 1 2.793-.744 5.947 5.947 0 0 1 2.291.414 4.72 4.72 0 0 1 1.682 1.158 5.138 5.138 0 0 1 1.045 1.723 6.1 6.1 0 0 1 .359 2.124c0 .216-.011.427-.03.635a2.26 2.26 0 0 1-.11.534h-8.143v-2.223h6.452l-1.414 1.048a2.863 2.863 0 0 0-.019-1.541 2.07 2.07 0 0 0-.767-1.068 2.25 2.25 0 0 0-1.345-.392 2.288 2.288 0 0 0-1.333.383 2.28 2.28 0 0 0-.836 1.127 4.447 4.447 0 0 0-.219 1.814 3.357 3.357 0 0 0 .219 1.635c.184.454.504.838.915 1.099a3.047 3.047 0 0 0 2.857.07c.371-.209.676-.518.882-.892l2.39 1.147a3.65 3.65 0 0 1-1.007 1.413 4.926 4.926 0 0 1-1.617.936 6.092 6.092 0 0 1-2.057.332ZM134.044 23.582V12.58h2.792v2.175l-.159-.483c.22-.62.655-1.14 1.225-1.46a3.979 3.979 0 0 1 1.981-.474 4.327 4.327 0 0 1 2.16.523 3.71 3.71 0 0 1 1.444 1.462c.357.67.535 1.424.518 2.185v7.071h-2.986v-6.424a2.323 2.323 0 0 0-.25-1.108 1.842 1.842 0 0 0-.697-.725 2.2 2.2 0 0 0-2.081 0c-.299.169-.544.42-.707.725a2.322 2.322 0 0 0-.248 1.108v6.427h-2.992ZM54.88 43.125a7.427 7.427 0 0 1-2.957-.585 7.274 7.274 0 0 1-2.38-1.635 7.519 7.519 0 0 1-1.582-2.457 8.172 8.172 0 0 1-.569-3.082 8.382 8.382 0 0 1 .558-3.093 7.227 7.227 0 0 1 1.562-2.446 7.13 7.13 0 0 1 2.39-1.623 7.583 7.583 0 0 1 2.977-.575 7.363 7.363 0 0 1 2.899.544 6.683 6.683 0 0 1 2.179 1.451 5.25 5.25 0 0 1 1.274 2.015l-2.728 1.329a3.75 3.75 0 0 0-1.403-1.86 3.682 3.682 0 0 0-2.22-.659 4.272 4.272 0 0 0-2.31.624 4.223 4.223 0 0 0-1.544 1.724c-.38.8-.567 1.68-.546 2.569-.02.89.168 1.773.546 2.578a4.192 4.192 0 0 0 1.543 1.732 4.259 4.259 0 0 0 2.31.624 3.682 3.682 0 0 0 2.22-.658 3.75 3.75 0 0 0 1.404-1.86l2.728 1.33c-.264.766-.7 1.46-1.274 2.026a6.703 6.703 0 0 1-2.18 1.45 7.365 7.365 0 0 1-2.898.537ZM68.179 43.125a5.883 5.883 0 0 1-2.94-.744 5.688 5.688 0 0 1-2.111-2.045 5.942 5.942 0 0 1 0-5.911 5.719 5.719 0 0 1 2.112-2.037 6.15 6.15 0 0 1 5.863 0 5.745 5.745 0 0 1 2.102 2.035 5.942 5.942 0 0 1 0 5.911 5.715 5.715 0 0 1-2.102 2.046 5.825 5.825 0 0 1-2.924.745Zm0-2.72c.501.012.995-.12 1.424-.383.41-.26.74-.629.955-1.067a3.42 3.42 0 0 0 .35-1.572 3.36 3.36 0 0 0-.35-1.56 2.738 2.738 0 0 0-.955-1.068 2.569 2.569 0 0 0-1.424-.393 2.613 2.613 0 0 0-1.433.393c-.411.261-.745.63-.967 1.067-.24.484-.36 1.02-.348 1.561-.01.545.109 1.084.348 1.572.217.44.552.81.967 1.067.433.261.93.394 1.433.384ZM75.747 42.884V31.882h2.792v2.676l-.294-.446c.159-.845.544-1.47 1.154-1.873a3.892 3.892 0 0 1 2.191-.604 4.146 4.146 0 0 1 2.38.695 2.977 2.977 0 0 1 1.284 1.864l-.857.08c.358-.899.87-1.564 1.534-1.995a4.189 4.189 0 0 1 2.33-.644 4.077 4.077 0 0 1 2.08.524c.6.344 1.092.849 1.424 1.46a4.45 4.45 0 0 1 .515 2.194v7.07h-2.992v-6.426a2.475 2.475 0 0 0-.23-1.108 1.754 1.754 0 0 0-.648-.725 2.083 2.083 0 0 0-2.02 0 1.734 1.734 0 0 0-.657.725c-.161.346-.24.725-.23 1.108v6.427h-2.986v-6.427a2.475 2.475 0 0 0-.229-1.108 1.76 1.76 0 0 0-.647-.725 2.086 2.086 0 0 0-2.022 0 1.734 1.734 0 0 0-.656.725c-.161.346-.24.725-.23 1.108v6.427h-2.986ZM94.245 47.173v-15.29h2.792v2.097l-.258-.605a3.592 3.592 0 0 1 1.47-1.279 4.749 4.749 0 0 1 2.12-.446 5.274 5.274 0 0 1 2.808.766 5.627 5.627 0 0 1 1.991 2.065c.496.887.75 1.89.735 2.91a5.877 5.877 0 0 1-.727 2.901 5.522 5.522 0 0 1-1.981 2.082 5.346 5.346 0 0 1-2.847.765 5.103 5.103 0 0 1-2.057-.413 3.6 3.6 0 0 1-1.523-1.218l.478-.624v6.304l-3-.015Zm5.731-6.768a2.798 2.798 0 0 0 1.47-.383c.425-.254.77-.624.996-1.068a3.344 3.344 0 0 0 .359-1.571 3.289 3.289 0 0 0-.359-1.561c-.23-.44-.575-.81-.996-1.068a2.749 2.749 0 0 0-1.47-.392c-.5-.008-.993.124-1.424.382a2.607 2.607 0 0 0-.975 1.069 3.712 3.712 0 0 0 0 3.141c.218.443.556.813.975 1.068.432.26.927.393 1.429.383h-.005ZM111.011 43.124a4.962 4.962 0 0 1-2.031-.382 2.927 2.927 0 0 1-1.314-1.098 3.082 3.082 0 0 1-.458-1.695 3.183 3.183 0 0 1 .419-1.636c.313-.51.757-.923 1.284-1.198a6.442 6.442 0 0 1 2.16-.685l3.325-.544v2.216l-2.793.503a2.06 2.06 0 0 0-.975.413 1.05 1.05 0 0 0-.34.836.932.932 0 0 0 .379.786c.273.195.602.295.936.283.452.009.898-.102 1.294-.323.363-.206.663-.51.867-.877.206-.372.313-.792.308-1.218v-2.868a1.337 1.337 0 0 0-.488-1.048c-.326-.282-.767-.423-1.322-.423a2.319 2.319 0 0 0-1.405.446 2.543 2.543 0 0 0-.882 1.167l-2.389-1.148a3.918 3.918 0 0 1 1.017-1.59 4.803 4.803 0 0 1 1.672-1.028 6.046 6.046 0 0 1 2.129-.363 5.576 5.576 0 0 1 2.431.504 3.933 3.933 0 0 1 1.642 1.399c.397.619.602 1.344.587 2.081v7.252h-2.792V41.11l.678-.12c-.29.45-.646.854-1.056 1.198a3.91 3.91 0 0 1-1.294.704 5.164 5.164 0 0 1-1.589.232ZM119.256 42.884V31.882h2.792v2.177l-.16-.483c.22-.621.655-1.14 1.224-1.462a4.001 4.001 0 0 1 1.982-.473 4.315 4.315 0 0 1 2.161.524 3.71 3.71 0 0 1 1.443 1.46c.356.671.534 1.425.517 2.187v7.07h-2.988v-6.425a2.323 2.323 0 0 0-.248-1.108 1.832 1.832 0 0 0-.698-.725c-.319-.18-.68-.27-1.045-.262a2.054 2.054 0 0 0-1.028.262c-.3.168-.545.42-.707.725a2.311 2.311 0 0 0-.249 1.108v6.427h-2.996ZM132.676 47.356c-.311 0-.62-.027-.926-.082a2.649 2.649 0 0 1-.786-.262v-2.476c.216.06.435.106.657.14.23.039.463.059.696.06.588 0 1.002-.148 1.255-.422.255-.288.463-.614.617-.968l.735-1.712-.039 2.518-4.78-12.268h3.207l3.166 8.722h-1.195l3.165-8.722h3.21l-4.66 12.027a6.74 6.74 0 0 1-1.075 1.913 4.266 4.266 0 0 1-1.444 1.148 4.138 4.138 0 0 1-1.803.384ZM8.41 19.331H0A19.469 19.469 0 0 1 5.603 5.673 19.02 19.02 0 0 1 19.104.004v8.509a10.65 10.65 0 0 0-7.556 3.174A10.9 10.9 0 0 0 8.41 19.33ZM19.11 47.171a19.02 19.02 0 0 1-13.502-5.668A19.469 19.469 0 0 1 .005 27.844h8.41c0 2.14.628 4.233 1.803 6.013a10.726 10.726 0 0 0 4.802 3.986 10.584 10.584 0 0 0 6.18.616 10.661 10.661 0 0 0 5.479-2.962 10.863 10.863 0 0 0 2.928-5.541c.412-2.1.2-4.276-.61-6.254a10.798 10.798 0 0 0-3.94-4.857 10.611 10.611 0 0 0-5.943-1.824V8.508c5.068 0 9.928 2.037 13.512 5.662a19.446 19.446 0 0 1 5.596 13.67 19.446 19.446 0 0 1-5.596 13.67 18.998 18.998 0 0 1-13.512 5.661h-.005Z"})),r.createElement("defs",null,r.createElement("clipPath",{id:"a"},r.createElement("path",{fill:"#fff",d:"M0 0h144v47.356H0z"})))),b=()=>r.createElement("div",{className:h.root},r.createElement("div",{className:h.container},r.createElement("a",{href:"https://thatopen.com/"},r.createElement(g,null)),r.createElement("nav",{className:h.nav},r.createElement("a",{href:"https://platform.thatopen.com/",target:"blank"},"Platform"),r.createElement("a",{href:"https://people.thatopen.com/",target:"blank"},"People")),r.createElement("div",{className:h.nav_end},r.createElement(g,null))));function v(e){let{children:t}=e;return r.createElement("div",null,r.createElement("div",{className:p.layoutBackgroundParent},r.createElement("div",{className:p.layoutBackground}),r.createElement(f,null),r.createElement(m,null)),r.createElement("div",{style:{display:"flex",flexDirection:"column",gap:"24px"}},r.createElement(b,null),t))}function y(e){let{children:t}=e;return r.createElement(v,null,t)}var w=n(7462),k=n(5742),S=n(2263),E=n(4996),_=n(6668),x=n(1944),T=n(4711),C=n(9727),L=n(3320),P=n(8780),A=n(197);function R(){const{i18n:{defaultLocale:e,localeConfigs:t}}=(0,S.Z)(),n=(0,T.l)();return r.createElement(k.Z,null,Object.entries(t).map((e=>{let[t,{htmlLang:a}]=e;return r.createElement("link",{key:t,rel:"alternate",href:n.createUrl({locale:t,fullyQualified:!0}),hrefLang:a})})),r.createElement("link",{rel:"alternate",href:n.createUrl({locale:e,fullyQualified:!0}),hrefLang:"x-default"}))}function N(e){let{permalink:t}=e;const{siteConfig:{url:n}}=(0,S.Z)(),a=function(){const{siteConfig:{url:e,baseUrl:t,trailingSlash:n}}=(0,S.Z)(),{pathname:r}=(0,u.TH)();return e+(0,P.applyTrailingSlash)((0,E.Z)(r),{trailingSlash:n,baseUrl:t})}(),o=t?`${n}${t}`:a;return r.createElement(k.Z,null,r.createElement("meta",{property:"og:url",content:o}),r.createElement("link",{rel:"canonical",href:o}))}function O(){const{i18n:{currentLocale:e}}=(0,S.Z)(),{metadata:t,image:n}=(0,_.L)();return r.createElement(r.Fragment,null,r.createElement(k.Z,null,r.createElement("meta",{name:"twitter:card",content:"summary_large_image"}),r.createElement("body",{className:C.h})),n&&r.createElement(x.d,{image:n}),r.createElement(N,null),r.createElement(R,null),r.createElement(A.Z,{tag:L.HX,locale:e}),r.createElement(k.Z,null,t.map(((e,t)=>r.createElement("meta",(0,w.Z)({key:t},e))))))}const M=new Map;function I(e){if(M.has(e.pathname))return{...e,pathname:M.get(e.pathname)};if((0,d.f)(c.Z,e.pathname).some((e=>{let{route:t}=e;return!0===t.exact})))return M.set(e.pathname,e.pathname),e;const t=e.pathname.trim().replace(/(?:\/index)?\.html$/,"")||"/";return M.set(e.pathname,t),{...e,pathname:t}}var D=n(8934),F=n(8940);function B(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),r=1;r{const r=t.default?.[e]??t[e];return r?.(...n)}));return()=>a.forEach((e=>e?.()))}const j=function(e){let{children:t,location:n,previousLocation:a}=e;return(0,r.useLayoutEffect)((()=>{a!==n&&(!function(e){let{location:t,previousLocation:n}=e;if(!n)return;const r=t.pathname===n.pathname,a=t.hash===n.hash,o=t.search===n.search;if(r&&a&&!o)return;const{hash:i}=t;if(i){const e=decodeURIComponent(i.substring(1)),t=document.getElementById(e);t?.scrollIntoView()}else window.scrollTo(0,0)}({location:n,previousLocation:a}),B("onRouteDidUpdate",{previousLocation:a,location:n}))}),[a,n]),t};function U(e){const t=Array.from(new Set([e,decodeURI(e)])).map((e=>(0,d.f)(c.Z,e))).flat();return Promise.all(t.map((e=>e.route.component.preload?.())))}class z extends r.Component{previousLocation;routeUpdateCleanupCb;constructor(e){super(e),this.previousLocation=null,this.routeUpdateCleanupCb=l.Z.canUseDOM?B("onRouteUpdate",{previousLocation:null,location:this.props.location}):()=>{},this.state={nextRouteHasLoaded:!0}}shouldComponentUpdate(e,t){if(e.location===this.props.location)return t.nextRouteHasLoaded;const n=e.location;return this.previousLocation=this.props.location,this.setState({nextRouteHasLoaded:!1}),this.routeUpdateCleanupCb=B("onRouteUpdate",{previousLocation:this.previousLocation,location:n}),U(n.pathname).then((()=>{this.routeUpdateCleanupCb(),this.setState({nextRouteHasLoaded:!0})})).catch((e=>{console.warn(e),window.location.reload()})),!1}render(){const{children:e,location:t}=this.props;return r.createElement(j,{previousLocation:this.previousLocation,location:t},r.createElement(u.AW,{location:t,render:()=>e}))}}const $=z,H="__docusaurus-base-url-issue-banner-container",Z="__docusaurus-base-url-issue-banner",G="__docusaurus-base-url-issue-banner-suggestion-container",q="__DOCUSAURUS_INSERT_BASEURL_BANNER";function V(e){return`\nwindow['${q}'] = true;\n\ndocument.addEventListener('DOMContentLoaded', maybeInsertBanner);\n\nfunction maybeInsertBanner() {\n var shouldInsert = window['${q}'];\n shouldInsert && insertBanner();\n}\n\nfunction insertBanner() {\n var bannerContainer = document.getElementById('${H}');\n if (!bannerContainer) {\n return;\n }\n var bannerHtml = ${JSON.stringify(function(e){return`\n
\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(/{window[q]=!1}),[]),r.createElement(r.Fragment,null,!l.Z.canUseDOM&&r.createElement(k.Z,null,r.createElement("script",null,V(e))),r.createElement("div",{id:H}))}function Y(){const{siteConfig:{baseUrl:e,baseUrlIssueBanner:t}}=(0,S.Z)(),{pathname:n}=(0,u.TH)();return t&&n===e?r.createElement(W,null):null}function K(){const{siteConfig:{favicon:e,title:t,noIndex:n},i18n:{currentLocale:a,localeConfigs:o}}=(0,S.Z)(),i=(0,E.Z)(e),{htmlLang:l,direction:s}=o[a];return r.createElement(k.Z,null,r.createElement("html",{lang:l,dir:s}),r.createElement("title",null,t),r.createElement("meta",{property:"og:title",content:t}),r.createElement("meta",{name:"viewport",content:"width=device-width, initial-scale=1.0"}),n&&r.createElement("meta",{name:"robots",content:"noindex, nofollow"}),e&&r.createElement("link",{rel:"icon",href:i}))}var Q=n(4763),X=n(2389);function J(){const e=(0,X.Z)();return r.createElement(k.Z,null,r.createElement("html",{"data-has-hydrated":e}))}function ee(){const e=(0,d.H)(c.Z),t=(0,u.TH)();return r.createElement(Q.Z,null,r.createElement(F.M,null,r.createElement(D.t,null,r.createElement(y,null,r.createElement(K,null),r.createElement(O,null),r.createElement(Y,null),r.createElement($,{location:I(t)},e)),r.createElement(J,null))))}var te=n(6887);const ne=function(e){try{return document.createElement("link").relList.supports(e)}catch{return!1}}("prefetch")?function(e){return new Promise(((t,n)=>{if("undefined"==typeof document)return void n();const r=document.createElement("link");r.setAttribute("rel","prefetch"),r.setAttribute("href",e),r.onload=()=>t(),r.onerror=()=>n();const a=document.getElementsByTagName("head")[0]??document.getElementsByName("script")[0]?.parentNode;a?.appendChild(r)}))}:function(e){return new Promise(((t,n)=>{const r=new XMLHttpRequest;r.open("GET",e,!0),r.withCredentials=!0,r.onload=()=>{200===r.status?t():n()},r.send(null)}))};var re=n(9670);const ae=new Set,oe=new Set,ie=()=>navigator.connection?.effectiveType.includes("2g")||navigator.connection?.saveData,le={prefetch(e){if(!(e=>!ie()&&!oe.has(e)&&!ae.has(e))(e))return!1;ae.add(e);const t=(0,d.f)(c.Z,e).flatMap((e=>{return t=e.route.path,Object.entries(te).filter((e=>{let[n]=e;return n.replace(/-[^-]+$/,"")===t})).flatMap((e=>{let[,t]=e;return Object.values((0,re.Z)(t))}));var t}));return Promise.all(t.map((e=>{const t=n.gca(e);return t&&!t.includes("undefined")?ne(t).catch((()=>{})):Promise.resolve()})))},preload:e=>!!(e=>!ie()&&!oe.has(e))(e)&&(oe.add(e),U(e))},se=Object.freeze(le);if(l.Z.canUseDOM){window.docusaurus=se;const e=a.hydrate;U(window.location.pathname).then((()=>{e(r.createElement(i.B6,null,r.createElement(o.VK,null,r.createElement(ee,null))),document.getElementById("__docusaurus"))}))}},8940:(e,t,n)=>{"use strict";n.d(t,{_:()=>u,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/bim_fragment.Serializer","path":"/api/classes/bim_fragment.Serializer","sidebar":"tutorialSidebar"},{"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.FragmentIfcLoader","path":"/api/classes/openbim_components.FragmentIfcLoader","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.LengthMeasurement","path":"/api/classes/openbim_components.LengthMeasurement","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.LocalCacher","path":"/api/classes/openbim_components.LocalCacher","sidebar":"tutorialSidebar"},{"id":"api/classes/openbim_components.MapboxWindow","path":"/api/classes/openbim_components.MapboxWindow","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.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/FragmentCacher","path":"/Tutorials/FragmentCacher","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/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"}}}'),c={siteConfig:a.default,siteMetadata:s,globalData:o,i18n:i,codeTranslations:l},u=r.createContext(c);function d(e){let{children:t}=e;return r.createElement(u.Provider,{value:c},t)}},4763:(e,t,n)=>{"use strict";n.d(t,{Z:()=>p});var r=n(7294),a=n(412),o=n(5742),i=n(8780),l=n(7961);function s(e){let{error:t,tryAgain:n}=e;return r.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"}},r.createElement("h1",{style:{fontSize:"3rem"}},"This page crashed"),r.createElement("button",{type:"button",onClick:n,style:{margin:"1rem 0",fontSize:"2rem",cursor:"pointer",borderRadius:20,padding:"1rem"}},"Try again"),r.createElement(c,{error:t}))}function c(e){let{error:t}=e;const n=(0,i.getErrorCausalChain)(t).map((e=>e.message)).join("\n\nCause:\n");return r.createElement("p",{style:{whiteSpace:"pre-wrap"}},n)}function u(e){let{error:t,tryAgain:n}=e;return r.createElement(p,{fallback:()=>r.createElement(s,{error:t,tryAgain:n})},r.createElement(o.Z,null,r.createElement("title",null,"Page Error")),r.createElement(l.Z,null,r.createElement(s,{error:t,tryAgain:n})))}const d=e=>r.createElement(u,e);class p extends r.Component{constructor(e){super(e),this.state={error:null}}componentDidCatch(e){a.Z.canUseDOM&&this.setState({error:e})}render(){const{children:e}=this.props,{error:t}=this.state;if(t){const e={error:t,tryAgain:()=>this.setState({error:null})};return(this.props.fallback??d)(e)}return e??null}}},412:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const r="undefined"!=typeof window&&"document"in window&&"createElement"in window.document,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:()=>f});var r=n(7462),a=n(7294),o=n(3727),i=n(8780),l=n(2263),s=n(3919),c=n(412);const u=a.createContext({collectLink:()=>{}});var d=n(4996);function p(e,t){let{isNavLink:n,to:p,href:f,activeClassName:m,isActive:h,"data-noBrokenLinkCheck":g,autoAddBaseUrl:b=!0,...v}=e;const{siteConfig:{trailingSlash:y,baseUrl:w}}=(0,l.Z)(),{withBaseUrl:k}=(0,d.C)(),S=(0,a.useContext)(u),E=(0,a.useRef)(null);(0,a.useImperativeHandle)(t,(()=>E.current));const _=p||f;const x=(0,s.Z)(_),T=_?.replace("pathname://","");let C=void 0!==T?(L=T,b&&(e=>e.startsWith("/"))(L)?k(L):L):void 0;var L;C&&x&&(C=(0,i.applyTrailingSlash)(C,{trailingSlash:y,baseUrl:w}));const P=(0,a.useRef)(!1),A=n?o.OL:o.rU,R=c.Z.canUseIntersectionObserver,N=(0,a.useRef)(),O=()=>{P.current||null==C||(window.docusaurus.preload(C),P.current=!0)};(0,a.useEffect)((()=>(!R&&x&&null!=C&&window.docusaurus.prefetch(C),()=>{R&&N.current&&N.current.disconnect()})),[N,C,R,x]);const M=C?.startsWith("#")??!1,I=!C||!x||M;return I||g||S.collectLink(C),I?a.createElement("a",(0,r.Z)({ref:E,href:C},_&&!x&&{target:"_blank",rel:"noopener noreferrer"},v)):a.createElement(A,(0,r.Z)({},v,{onMouseEnter:O,onTouchStart:O,innerRef:e=>{E.current=e,R&&e&&x&&(N.current=new window.IntersectionObserver((t=>{t.forEach((t=>{e===t.target&&(t.isIntersecting||t.intersectionRatio>0)&&(N.current.unobserve(e),N.current.disconnect(),null!=C&&window.docusaurus.prefetch(C))}))})),N.current.observe(e))},to:C},n&&{isActive:h,activeClassName:m}))}const f=a.forwardRef(p)},1875:(e,t,n)=>{"use strict";n.d(t,{Z:()=>r});const r=()=>null},5999:(e,t,n)=>{"use strict";n.d(t,{Z:()=>s,I:()=>l});var r=n(7294);function a(e,t){const n=e.split(/(\{\w+\})/).map(((e,n)=>{if(n%2==1){const n=t?.[e.slice(1,-1)];if(void 0!==n)return n}return e}));return n.some((e=>(0,r.isValidElement)(e)))?n.map(((e,t)=>(0,r.isValidElement)(e)?r.cloneElement(e,{key:t}):e)).filter((e=>""!==e)):n.join("")}var o=n(7529);function i(e){let{id:t,message:n}=e;if(void 0===t&&void 0===n)throw new Error("Docusaurus translation declarations must have at least a translation id or a default translation message");return o[t??n]??n??t}function l(e,t){let{message:n,id:r}=e;return a(i({message:n,id:r}),t)}function s(e){let{children:t,id:n,values:o}=e;if(t&&"string"!=typeof t)throw console.warn("Illegal children",t),new Error("The Docusaurus component only accept simple string values");const 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});const 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(){const{siteConfig:{baseUrl:e,url:t}}=(0,a.Z)(),n=(0,r.useCallback)(((n,r)=>function(e,t,n,r){let{forcePrependBaseUrl:a=!1,absolute:i=!1}=void 0===r?{}:r;if(!n||n.startsWith("#")||(0,o.b)(n))return n;if(a)return t+n.replace(/^\//,"");if(n===t.replace(/\/$/,""))return t;const l=n.startsWith(t)?n:t+n.replace(/^\//,"");return i?e+l:l}(t,e,n,r)),[t,e]);return{withBaseUrl:n}}function l(e,t){void 0===t&&(t={});const{withBaseUrl:n}=i();return n(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});const r=e=>"object"==typeof e&&!!e&&Object.keys(e).length>0;function a(e){const t={};return function e(n,a){Object.entries(n).forEach((n=>{let[o,i]=n;const 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);const a=r.createContext(null);function o(e){let{children:t,value:n}=e;const o=r.useContext(a),i=(0,r.useMemo)((()=>function(e){let{parent:t,value:n}=e;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}const r={...t.data,...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:()=>u,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={});const n=function(){const{globalData:e}=(0,a.Z)();return e}()[e];if(!n&&t.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin.`);return n}const l=e=>e.versions.find((e=>e.isLast));function s(e,t){const n=function(e,t){const n=l(e);return[...e.versions.filter((e=>e!==n)),n].find((e=>!!(0,r.LX)(t,{path:e.path,exact:!1,strict:!1})))}(e,t),a=n?.docs.find((e=>!!(0,r.LX)(t,{path:e.path,exact:!0,strict:!1})));return{activeVersion:n,activeDoc:a,alternateDocVersions:a?function(t){const n={};return e.versions.forEach((e=>{e.docs.forEach((r=>{r.id===t&&(n[e.name]=r)}))})),n}(a.id):{}}}const c={},u=()=>i("docusaurus-plugin-content-docs")??c,d=e=>function(e,t,n){void 0===t&&(t=o.m),void 0===n&&(n={});const r=i(e),a=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){void 0===e&&(e={});const t=u(),{pathname:n}=(0,r.TH)();return function(e,t,n){void 0===n&&(n={});const a=Object.entries(e).sort(((e,t)=>t[1].path.localeCompare(e[1].path))).find((e=>{let[,n]=e;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((e=>e.path)).join(", ")}`);return o}(t,n,e)}function f(e){return d(e).versions}function m(e){const t=d(e);return l(t)}function h(e){const t=d(e),{pathname:n}=(0,r.TH)();return s(t,n)}function g(e){const t=d(e),{pathname:n}=(0,r.TH)();return function(e,t){const n=l(e);return{latestDocSuggestion:s(e,t).alternateDocVersions[n.name],latestVersionSuggestion:n}}(t,n)}},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(e){let{location:t,previousLocation:n}=e;if(n&&t.pathname!==n.pathname){const e=window.setTimeout((()=>{a().start()}),200);return()=>window.clearTimeout(e)}},onRouteDidUpdate(){a().done()}}},3310:(e,t,n)=>{"use strict";n.r(t);var r=n(7410),a=n(6809);!function(e){const{themeConfig:{prism:t}}=a.default,{additionalLanguages:r}=t;globalThis.Prism=e,r.forEach((e=>{n(6726)(`./prism-${e}`)})),delete globalThis.Prism}(r.Z)},9471:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294);const a={iconExternalLink:"iconExternalLink_nPIU"};function o(e){let{width:t=13.5,height:n=13.5}=e;return r.createElement("svg",{width:t,height:n,"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:()=>dt});var r=n(7294),a=n(6010),o=n(4763),i=n(1944),l=n(7462),s=n(6550),c=n(5999),u=n(5936);const d="__docusaurus_skipToContent_fallback";function p(e){e.setAttribute("tabindex","-1"),e.focus(),e.removeAttribute("tabindex")}function f(){const e=(0,r.useRef)(null),{action:t}=(0,s.k6)(),n=(0,r.useCallback)((e=>{e.preventDefault();const t=document.querySelector("main:first-of-type")??document.getElementById(d);t&&p(t)}),[]);return(0,u.S)((n=>{let{location:r}=n;e.current&&!r.hash&&"PUSH"===t&&p(e.current)})),{containerRef:e,onClick:n}}const m=(0,c.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){const t=e.children??m,{containerRef:n,onClick:a}=f();return r.createElement("div",{ref:n,role:"region","aria-label":m},r.createElement("a",(0,l.Z)({},e,{href:`#${d}`,onClick:a}),t))}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),k=n(9689);function S(e){let{width:t=21,height:n=21,color:a="currentColor",strokeWidth:o=1.2,className:i,...s}=e;return r.createElement("svg",(0,l.Z)({viewBox:"0 0 15 15",width:t,height:n},s),r.createElement("g",{stroke:a,strokeWidth:o},r.createElement("path",{d:"M.75.75l13.5 13.5M14.25.75L.75 14.25"})))}const E={closeButton:"closeButton_CVFx"};function _(e){return r.createElement("button",(0,l.Z)({type:"button","aria-label":(0,c.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",E.closeButton,e.className)}),r.createElement(S,{width:14,height:14,strokeWidth:3.1}))}const x={content:"content_knG7"};function T(e){const{announcementBar:t}=(0,w.L)(),{content:n}=t;return r.createElement("div",(0,l.Z)({},e,{className:(0,a.Z)(x.content,e.className),dangerouslySetInnerHTML:{__html:n}}))}const C={announcementBar:"announcementBar_mb4j",announcementBarPlaceholder:"announcementBarPlaceholder_vyr4",announcementBarClose:"announcementBarClose_gvF7",announcementBarContent:"announcementBarContent_xLdY"};function L(){const{announcementBar:e}=(0,w.L)(),{isActive:t,close:n}=(0,k.nT)();if(!t)return null;const{backgroundColor:a,textColor:o,isCloseable:i}=e;return r.createElement("div",{className:C.announcementBar,style:{backgroundColor:a,color:o},role:"banner"},i&&r.createElement("div",{className:C.announcementBarPlaceholder}),r.createElement(T,{className:C.announcementBarContent}),i&&r.createElement(_,{onClick:n,className:C.announcementBarClose}))}var P=n(2961),A=n(2466);var R=n(902),N=n(3102);const O=r.createContext(null);function M(e){let{children:t}=e;const n=function(){const e=(0,P.e)(),t=(0,N.HY)(),[n,a]=(0,r.useState)(!1),o=null!==t.component,i=(0,R.D9)(o);return(0,r.useEffect)((()=>{o&&!i&&a(!0)}),[o,i]),(0,r.useEffect)((()=>{o?e.shown||a(!0):a(!1)}),[e.shown,o]),(0,r.useMemo)((()=>[n,a]),[n])}();return r.createElement(O.Provider,{value:n},t)}function I(e){if(e.component){const t=e.component;return r.createElement(t,e.props)}}function D(){const e=(0,r.useContext)(O);if(!e)throw new R.i6("NavbarSecondaryMenuDisplayProvider");const[t,n]=e,a=(0,r.useCallback)((()=>n(!1)),[n]),o=(0,N.HY)();return(0,r.useMemo)((()=>({shown:t,hide:a,content:I(o)})),[a,o,t])}function F(e){let{header:t,primaryMenu:n,secondaryMenu:o}=e;const{shown:i}=D();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 B=n(2949),j=n(2389);function U(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 H(e){let{className:t,buttonClassName:n,value:o,onChange:i}=e;const l=(0,j.Z)(),s=(0,c.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,c.I)({message:"dark mode",id:"theme.colorToggle.ariaLabel.mode.dark",description:"The name for the dark color mode"}):(0,c.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:()=>i("dark"===o?"light":"dark"),disabled:!l,title:s,"aria-label":s,"aria-live":"polite"},r.createElement(U,{className:(0,a.Z)($.toggleIcon,$.lightToggleIcon)}),r.createElement(z,{className:(0,a.Z)($.toggleIcon,$.darkToggleIcon)})))}const Z=r.memo(H),G={darkNavbarColorModeToggle:"darkNavbarColorModeToggle_X3D1"};function q(e){let{className:t}=e;const n=(0,w.L)().navbar.style,a=(0,w.L)().colorMode.disableSwitch,{colorMode:o,setColorMode:i}=(0,B.I)();return a?null:r.createElement(Z,{className:t,buttonClassName:"dark"===n?G.darkNavbarColorModeToggle:void 0,value:o,onChange:i})}var V=n(1327);function W(){return r.createElement(V.Z,{className:"navbar__brand",imageClassName:"navbar__logo",titleClassName:"navbar__title text--truncate"})}function Y(){const e=(0,P.e)();return r.createElement("button",{type:"button","aria-label":(0,c.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:()=>e.toggle()},r.createElement(S,{color:"var(--ifm-color-emphasis-600)"}))}function K(){return r.createElement("div",{className:"navbar-sidebar__brand"},r.createElement(W,null),r.createElement(q,{className:"margin-right--md"}),r.createElement(Y,null))}var Q=n(9960),X=n(4996),J=n(3919);function ee(e,t){return void 0!==e&&void 0!==t&&new RegExp(e,"gi").test(t)}var te=n(9471);function ne(e){let{activeBasePath:t,activeBaseRegex:n,to:a,href:o,label:i,html:s,isDropdownLink:c,prependBaseUrlToHref:u,...d}=e;const p=(0,X.Z)(a),f=(0,X.Z)(t),m=(0,X.Z)(o,{forcePrependBaseUrl:!0}),h=i&&o&&!(0,J.Z)(o),g=s?{dangerouslySetInnerHTML:{__html:s}}:{children:r.createElement(r.Fragment,null,i,h&&r.createElement(te.Z,c&&{width:12,height:12}))};return o?r.createElement(Q.Z,(0,l.Z)({href:u?m:o},d,g)):r.createElement(Q.Z,(0,l.Z)({to:p,isNavLink:!0},(t||n)&&{isActive:(e,t)=>n?ee(n,t.pathname):t.pathname.startsWith(f)},d,g))}function re(e){let{className:t,isDropdownItem:n=!1,...o}=e;const i=r.createElement(ne,(0,l.Z)({className:(0,a.Z)(n?"dropdown__link":"navbar__item navbar__link",t),isDropdownLink:n},o));return n?r.createElement("li",null,i):i}function ae(e){let{className:t,isDropdownItem:n,...o}=e;return r.createElement("li",{className:"menu__list-item"},r.createElement(ne,(0,l.Z)({className:(0,a.Z)("menu__link",t)},o)))}function oe(e){let{mobile:t=!1,position:n,...a}=e;const o=t?ae:re;return r.createElement(o,(0,l.Z)({},a,{activeClassName:a.activeClassName??(t?"menu__link--active":"navbar__link--active")}))}var ie=n(6043),le=n(8596),se=n(2263);function ce(e,t){return e.some((e=>function(e,t){return!!(0,le.Mg)(e.to,t)||!!ee(e.activeBaseRegex,t)||!(!e.activeBasePath||!t.startsWith(e.activeBasePath))}(e,t)))}function ue(e){let{items:t,position:n,className:o,onClick:i,...s}=e;const c=(0,r.useRef)(null),[u,d]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{const e=e=>{c.current&&!c.current.contains(e.target)&&d(!1)};return document.addEventListener("mousedown",e),document.addEventListener("touchstart",e),document.addEventListener("focusin",e),()=>{document.removeEventListener("mousedown",e),document.removeEventListener("touchstart",e),document.removeEventListener("focusin",e)}}),[c]),r.createElement("div",{ref:c,className:(0,a.Z)("navbar__item","dropdown","dropdown--hoverable",{"dropdown--right":"right"===n,"dropdown--show":u})},r.createElement(ne,(0,l.Z)({"aria-haspopup":"true","aria-expanded":u,role:"button",href:s.to?void 0:"#",className:(0,a.Z)("navbar__link",o)},s,{onClick:s.to?void 0:e=>e.preventDefault(),onKeyDown:e=>{"Enter"===e.key&&(e.preventDefault(),d(!u))}}),s.children??s.label),r.createElement("ul",{className:"dropdown__menu"},t.map(((e,t)=>r.createElement(_e,(0,l.Z)({isDropdownItem:!0,activeClassName:"dropdown__link--active"},e,{key:t}))))))}function de(e){let{items:t,className:n,position:o,onClick:i,...c}=e;const u=function(){const{siteConfig:{baseUrl:e}}=(0,se.Z)(),{pathname:t}=(0,s.TH)();return t.replace(e,"/")}(),d=ce(t,u),{collapsed:p,toggleCollapsed:f,setCollapsed:m}=(0,ie.u)({initialState:()=>!d});return(0,r.useEffect)((()=>{d&&m(!d)}),[u,d,m]),r.createElement("li",{className:(0,a.Z)("menu__list-item",{"menu__list-item--collapsed":p})},r.createElement(ne,(0,l.Z)({role:"button",className:(0,a.Z)("menu__link menu__link--sublist menu__link--sublist-caret",n)},c,{onClick:e=>{e.preventDefault(),f()}}),c.children??c.label),r.createElement(ie.z,{lazy:!0,as:"ul",className:"menu__list",collapsed:p},t.map(((e,t)=>r.createElement(_e,(0,l.Z)({mobile:!0,isDropdownItem:!0,onClick:i,activeClassName:"menu__link--active"},e,{key:t}))))))}function pe(e){let{mobile:t=!1,...n}=e;const a=t?de:ue;return r.createElement(a,n)}var fe=n(4711);function me(e){let{width:t=20,height:n=20,...a}=e;return r.createElement("svg",(0,l.Z)({viewBox:"0 0 24 24",width:t,height:n,"aria-hidden":!0},a),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 he="iconLanguage_nlXk";var ge=n(1875);const be={searchBox:"searchBox_ZlJk"};function ve(e){let{children:t,className:n}=e;return r.createElement("div",{className:(0,a.Z)(n,be.searchBox)},t)}var ye=n(143),we=n(2802);var ke=n(373);const Se=e=>e.docs.find((t=>t.id===e.mainDocId));const Ee={default:oe,localeDropdown:function(e){let{mobile:t,dropdownItemsBefore:n,dropdownItemsAfter:a,...o}=e;const{i18n:{currentLocale:i,locales:u,localeConfigs:d}}=(0,se.Z)(),p=(0,fe.l)(),{search:f,hash:m}=(0,s.TH)(),h=[...n,...u.map((e=>{const n=`${`pathname://${p.createUrl({locale:e,fullyQualified:!1})}`}${f}${m}`;return{label:d[e].label,lang:d[e].htmlLang,to:n,target:"_self",autoAddBaseUrl:!1,className:e===i?t?"menu__link--active":"dropdown__link--active":""}})),...a],g=t?(0,c.I)({message:"Languages",id:"theme.navbar.mobileLanguageDropdown.label",description:"The label for the mobile language switcher dropdown"}):d[i].label;return r.createElement(pe,(0,l.Z)({},o,{mobile:t,label:r.createElement(r.Fragment,null,r.createElement(me,{className:he}),g),items:h}))},search:function(e){let{mobile:t,className:n}=e;return t?null:r.createElement(ve,{className:n},r.createElement(ge.Z,null))},dropdown:pe,html:function(e){let{value:t,className:n,mobile:o=!1,isDropdownItem:i=!1}=e;const l=i?"li":"div";return r.createElement(l,{className:(0,a.Z)({navbar__item:!o&&!i,"menu__list-item":o},n),dangerouslySetInnerHTML:{__html:t}})},doc:function(e){let{docId:t,label:n,docsPluginId:a,...o}=e;const{activeDoc:i}=(0,ye.Iw)(a),s=(0,we.vY)(t,a);return null===s?null:r.createElement(oe,(0,l.Z)({exact:!0},o,{isActive:()=>i?.path===s.path||!!i?.sidebar&&i.sidebar===s.sidebar,label:n??s.id,to:s.path}))},docSidebar:function(e){let{sidebarId:t,label:n,docsPluginId:a,...o}=e;const{activeDoc:i}=(0,ye.Iw)(a),s=(0,we.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(oe,(0,l.Z)({exact:!0},o,{isActive:()=>i?.sidebar===t,label:n??s.label,to:s.path}))},docsVersion:function(e){let{label:t,to:n,docsPluginId:a,...o}=e;const i=(0,we.lO)(a)[0],s=t??i.label,c=n??(e=>e.docs.find((t=>t.id===e.mainDocId)))(i).path;return r.createElement(oe,(0,l.Z)({},o,{label:s,to:c}))},docsVersionDropdown:function(e){let{mobile:t,docsPluginId:n,dropdownActiveClassDisabled:a,dropdownItemsBefore:o,dropdownItemsAfter:i,...u}=e;const{search:d,hash:p}=(0,s.TH)(),f=(0,ye.Iw)(n),m=(0,ye.gB)(n),{savePreferredVersionName:h}=(0,ke.J)(n),g=[...o,...m.map((e=>{const t=f.alternateDocVersions[e.name]??Se(e);return{label:e.label,to:`${t.path}${d}${p}`,isActive:()=>e===f.activeVersion,onClick:()=>h(e.name)}})),...i],b=(0,we.lO)(n)[0],v=t&&g.length>1?(0,c.I)({id:"theme.navbar.mobileVersionsDropdown.label",message:"Versions",description:"The label for the navbar versions dropdown on mobile view"}):b.label,y=t&&g.length>1?void 0:Se(b).path;return g.length<=1?r.createElement(oe,(0,l.Z)({},u,{mobile:t,label:v,to:y,isActive:a?()=>!1:void 0})):r.createElement(pe,(0,l.Z)({},u,{mobile:t,label:v,to:y,items:g,isActive:a?()=>!1:void 0}))}};function _e(e){let{type:t,...n}=e;const a=function(e,t){return e&&"default"!==e?e:"items"in t?"dropdown":"default"}(t,n),o=Ee[a];if(!o)throw new Error(`No NavbarItem component found for type "${t}".`);return r.createElement(o,n)}function xe(){const e=(0,P.e)(),t=(0,w.L)().navbar.items;return r.createElement("ul",{className:"menu__list"},t.map(((t,n)=>r.createElement(_e,(0,l.Z)({mobile:!0},t,{onClick:()=>e.toggle(),key:n})))))}function Te(e){return r.createElement("button",(0,l.Z)({},e,{type:"button",className:"clean-btn navbar-sidebar__back"}),r.createElement(c.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 Ce(){const e=0===(0,w.L)().navbar.items.length,t=D();return r.createElement(r.Fragment,null,!e&&r.createElement(Te,{onClick:()=>t.hide()}),t.content)}function Le(){const e=(0,P.e)();var t;return void 0===(t=e.shown)&&(t=!0),(0,r.useEffect)((()=>(document.body.style.overflow=t?"hidden":"visible",()=>{document.body.style.overflow="visible"})),[t]),e.shouldRender?r.createElement(F,{header:r.createElement(K,null),primaryMenu:r.createElement(xe,null),secondaryMenu:r.createElement(Ce,null)}):null}const Pe={navbarHideable:"navbarHideable_m1mJ",navbarHidden:"navbarHidden_jGov"};function Ae(e){return r.createElement("div",(0,l.Z)({role:"presentation"},e,{className:(0,a.Z)("navbar-sidebar__backdrop",e.className)}))}function Re(e){let{children:t}=e;const{navbar:{hideOnScroll:n,style:o}}=(0,w.L)(),i=(0,P.e)(),{navbarRef:l,isNavbarVisible:s}=function(e){const[t,n]=(0,r.useState)(e),a=(0,r.useRef)(!1),o=(0,r.useRef)(0),i=(0,r.useCallback)((e=>{null!==e&&(o.current=e.getBoundingClientRect().height)}),[]);return(0,A.RF)(((t,r)=>{let{scrollY:i}=t;if(!e)return;if(i=l?n(!1):i+c{if(!e)return;const r=t.location.hash;if(r?document.getElementById(r.substring(1)):void 0)return a.current=!0,void n(!1);n(!0)})),{navbarRef:i,isNavbarVisible:t}}(n);return r.createElement("nav",{ref:l,"aria-label":(0,c.I)({id:"theme.NavBar.navAriaLabel",message:"Main",description:"The ARIA label for the main navigation"}),className:(0,a.Z)("navbar","navbar--fixed-top",n&&[Pe.navbarHideable,!s&&Pe.navbarHidden],{"navbar--dark":"dark"===o,"navbar--primary":"primary"===o,"navbar-sidebar--show":i.shown})},t,r.createElement(Ae,{onClick:i.toggle}),r.createElement(Le,null))}var Ne=n(8780);const Oe={errorBoundaryError:"errorBoundaryError_a6uf"};function Me(e){return r.createElement("button",(0,l.Z)({type:"button"},e),r.createElement(c.Z,{id:"theme.ErrorPageContent.tryAgain",description:"The label of the button to try again rendering when the React error boundary captures an error"},"Try again"))}function Ie(e){let{error:t}=e;const n=(0,Ne.getErrorCausalChain)(t).map((e=>e.message)).join("\n\nCause:\n");return r.createElement("p",{className:Oe.errorBoundaryError},n)}class De extends r.Component{componentDidCatch(e,t){throw this.props.onError(e,t)}render(){return this.props.children}}const Fe="right";function Be(e){let{width:t=30,height:n=30,className:a,...o}=e;return r.createElement("svg",(0,l.Z)({className:a,width:t,height:n,viewBox:"0 0 30 30","aria-hidden":"true"},o),r.createElement("path",{stroke:"currentColor",strokeLinecap:"round",strokeMiterlimit:"10",strokeWidth:"2",d:"M4 7h22M4 15h22M4 23h22"}))}function je(){const{toggle:e,shown:t}=(0,P.e)();return r.createElement("button",{onClick:e,"aria-label":(0,c.I)({id:"theme.docs.sidebar.toggleSidebarButtonAriaLabel",message:"Toggle navigation bar",description:"The ARIA label for hamburger menu button of mobile navigation"}),"aria-expanded":t,className:"navbar__toggle clean-btn",type:"button"},r.createElement(Be,null))}const Ue={colorModeToggle:"colorModeToggle_DEke"};function ze(e){let{items:t}=e;return r.createElement(r.Fragment,null,t.map(((e,t)=>r.createElement(De,{key:t,onError:t=>new Error(`A theme navbar item failed to render.\nPlease double-check the following navbar item (themeConfig.navbar.items) of your Docusaurus config:\n${JSON.stringify(e,null,2)}`,{cause:t})},r.createElement(_e,e)))))}function $e(e){let{left:t,right:n}=e;return r.createElement("div",{className:"navbar__inner"},r.createElement("div",{className:"navbar__items"},t),r.createElement("div",{className:"navbar__items navbar__items--right"},n))}function He(){const e=(0,P.e)(),t=(0,w.L)().navbar.items,[n,a]=function(e){function t(e){return"left"===(e.position??Fe)}return[e.filter(t),e.filter((e=>!t(e)))]}(t),o=t.find((e=>"search"===e.type));return r.createElement($e,{left:r.createElement(r.Fragment,null,!e.disabled&&r.createElement(je,null),r.createElement(W,null),r.createElement(ze,{items:n})),right:r.createElement(r.Fragment,null,r.createElement(ze,{items:a}),r.createElement(q,{className:Ue.colorModeToggle}),!o&&r.createElement(ve,null,r.createElement(ge.Z,null)))})}function Ze(){return r.createElement(Re,null,r.createElement(He,null))}function Ge(e){let{item:t}=e;const{to:n,href:a,label:o,prependBaseUrlToHref:i,...s}=t,c=(0,X.Z)(n),u=(0,X.Z)(a,{forcePrependBaseUrl:!0});return r.createElement(Q.Z,(0,l.Z)({className:"footer__link-item"},a?{href:i?u:a}:{to:c},s),o,a&&!(0,J.Z)(a)&&r.createElement(te.Z,null))}function qe(e){let{item:t}=e;return t.html?r.createElement("li",{className:"footer__item",dangerouslySetInnerHTML:{__html:t.html}}):r.createElement("li",{key:t.href??t.to,className:"footer__item"},r.createElement(Ge,{item:t}))}function Ve(e){let{column:t}=e;return r.createElement("div",{className:"col footer__col"},r.createElement("div",{className:"footer__title"},t.title),r.createElement("ul",{className:"footer__items clean-list"},t.items.map(((e,t)=>r.createElement(qe,{key:t,item:e})))))}function We(e){let{columns:t}=e;return r.createElement("div",{className:"row footer__links"},t.map(((e,t)=>r.createElement(Ve,{key:t,column:e}))))}function Ye(){return r.createElement("span",{className:"footer__link-separator"},"\xb7")}function Ke(e){let{item:t}=e;return t.html?r.createElement("span",{className:"footer__link-item",dangerouslySetInnerHTML:{__html:t.html}}):r.createElement(Ge,{item:t})}function Qe(e){let{links:t}=e;return r.createElement("div",{className:"footer__links text--center"},r.createElement("div",{className:"footer__links"},t.map(((e,n)=>r.createElement(r.Fragment,{key:n},r.createElement(Ke,{item:e}),t.length!==n+1&&r.createElement(Ye,null))))))}function Xe(e){let{links:t}=e;return function(e){return"title"in e[0]}(t)?r.createElement(We,{columns:t}):r.createElement(Qe,{links:t})}var Je=n(941);const et={footerLogoLink:"footerLogoLink_BH7S"};function tt(e){let{logo:t}=e;const{withBaseUrl:n}=(0,X.C)(),o={light:n(t.src),dark:n(t.srcDark??t.src)};return r.createElement(Je.Z,{className:(0,a.Z)("footer__logo",t.className),alt:t.alt,sources:o,width:t.width,height:t.height,style:t.style})}function nt(e){let{logo:t}=e;return t.href?r.createElement(Q.Z,{href:t.href,className:et.footerLogoLink,target:t.target},r.createElement(tt,{logo:t})):r.createElement(tt,{logo:t})}function rt(e){let{copyright:t}=e;return r.createElement("div",{className:"footer__copyright",dangerouslySetInnerHTML:{__html:t}})}function at(e){let{style:t,links:n,logo:o,copyright:i}=e;return r.createElement("footer",{className:(0,a.Z)("footer",{"footer--dark":"dark"===t})},r.createElement("div",{className:"container container-fluid"},n,(o||i)&&r.createElement("div",{className:"footer__bottom text--center"},o&&r.createElement("div",{className:"margin-bottom--sm"},o),i)))}function ot(){const{footer:e}=(0,w.L)();if(!e)return null;const{copyright:t,links:n,logo:a,style:o}=e;return r.createElement(at,{style:o,links:n&&n.length>0&&r.createElement(Xe,{links:n}),logo:a&&r.createElement(nt,{logo:a}),copyright:t&&r.createElement(rt,{copyright:t})})}const it=r.memo(ot),lt=(0,R.Qc)([B.S,k.pl,A.OC,ke.L5,i.VC,function(e){let{children:t}=e;return r.createElement(N.n2,null,r.createElement(P.M,null,r.createElement(M,null,t)))}]);function st(e){let{children:t}=e;return r.createElement(lt,null,t)}function ct(e){let{error:t,tryAgain:n}=e;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(c.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(Me,{onClick:n,className:"button button--primary shadow--lw"})),r.createElement("hr",null),r.createElement("div",{className:"margin-vert--md"},r.createElement(Ie,{error:t})))))}const ut={mainWrapper:"mainWrapper_z2l0"};function dt(e){const{children:t,noFooter:n,wrapperClassName:l,title:s,description:c}=e;return(0,b.t)(),r.createElement(st,null,r.createElement(i.d,{title:s,description:c}),r.createElement(y,null),r.createElement(L,null),r.createElement(Ze,null),r.createElement("div",{id:d,className:(0,a.Z)(g.k.wrapper.main,ut.mainWrapper,l)},r.createElement(o.Z,{fallback:e=>r.createElement(ct,e)},t)),!n&&r.createElement(it,null))}},1327:(e,t,n)=>{"use strict";n.d(t,{Z:()=>d});var r=n(7462),a=n(7294),o=n(9960),i=n(4996),l=n(2263),s=n(6668),c=n(941);function u(e){let{logo:t,alt:n,imageClassName:r}=e;const o={light:(0,i.Z)(t.src),dark:(0,i.Z)(t.srcDark||t.src)},l=a.createElement(c.Z,{className:t.className,sources:o,height:t.height,width:t.width,alt:n,style:t.style});return r?a.createElement("div",{className:r},l):l}function d(e){const{siteConfig:{title:t}}=(0,l.Z)(),{navbar:{title:n,logo:c}}=(0,s.L)(),{imageClassName:d,titleClassName:p,...f}=e,m=(0,i.Z)(c?.href||"/"),h=n?"":t,g=c?.alt??h;return a.createElement(o.Z,(0,r.Z)({to:m},f,c?.target&&{target:c.target}),c&&a.createElement(u,{logo:c,alt:g,imageClassName:d}),null!=n&&a.createElement("b",{className:p},n))}},197:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294),a=n(5742);function o(e){let{locale:t,version:n,tag:o}=e;const 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:()=>c});var r=n(7462),a=n(7294),o=n(6010),i=n(2389),l=n(2949);const s={themedImage:"themedImage_ToTc","themedImage--light":"themedImage--light_HNdA","themedImage--dark":"themedImage--dark_i4oU"};function c(e){const t=(0,i.Z)(),{colorMode:n}=(0,l.I)(),{sources:c,className:u,alt:d,...p}=e,f=t?"dark"===n?["dark"]:["light"]:["light","dark"];return a.createElement(a.Fragment,null,f.map((e=>a.createElement("img",(0,r.Z)({key:e,src:c[e],alt:d,className:(0,o.Z)(s.themedImage,s[`themedImage--${e}`],u)},p)))))}},6043:(e,t,n)=>{"use strict";n.d(t,{u:()=>s,z:()=>g});var r=n(7462),a=n(7294),o=n(412),i=n(1442);const l="ease-in-out";function s(e){let{initialState:t}=e;const[n,r]=(0,a.useState)(t??!1),o=(0,a.useCallback)((()=>{r((e=>!e))}),[]);return{collapsed:n,setCollapsed:r,toggleCollapsed:o}}const c={display:"none",overflow:"hidden",height:"0px"},u={display:"block",overflow:"visible",height:"auto"};function d(e,t){const n=t?c:u;e.style.display=n.display,e.style.overflow=n.overflow,e.style.height=n.height}function p(e){let{collapsibleRef:t,collapsed:n,animation:r}=e;const o=(0,a.useRef)(!1);(0,a.useEffect)((()=>{const e=t.current;function a(){const t=e.scrollHeight,n=r?.duration??function(e){if((0,i.n)())return 1;const t=e/36;return Math.round(10*(4+15*t**.25+t/5))}(t);return{transition:`height ${n}ms ${r?.easing??l}`,height:`${t}px`}}function s(){const t=a();e.style.transition=t.transition,e.style.height=t.height}if(!o.current)return d(e,n),void(o.current=!0);return e.style.willChange="height",function(){const t=requestAnimationFrame((()=>{n?(s(),requestAnimationFrame((()=>{e.style.height=c.height,e.style.overflow=c.overflow}))):(e.style.display="block",requestAnimationFrame((()=>{s()})))}));return()=>cancelAnimationFrame(t)}()}),[t,n,r])}function f(e){if(!o.Z.canUseDOM)return e?c:u}function m(e){let{as:t="div",collapsed:n,children:r,animation:o,onCollapseTransitionEnd:i,className:l,disableSSRStyle:s}=e;const c=(0,a.useRef)(null);return p({collapsibleRef:c,collapsed:n,animation:o}),a.createElement(t,{ref:c,style:s?void 0:f(n),onTransitionEnd:e=>{"height"===e.propertyName&&(d(c.current,n),i?.(n))},className:l},r)}function h(e){let{collapsed:t,...n}=e;const[o,i]=(0,a.useState)(!t),[l,s]=(0,a.useState)(t);return(0,a.useLayoutEffect)((()=>{t||i(!0)}),[t]),(0,a.useLayoutEffect)((()=>{o&&s(t)}),[o,t]),o?a.createElement(m,(0,r.Z)({},n,{collapsed:l})):null}function g(e){let{lazy:t,...n}=e;const r=t?h:m;return a.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(902),l=n(6668);const s=(0,o.WA)("docusaurus.announcement.dismiss"),c=(0,o.WA)("docusaurus.announcement.id"),u=()=>"true"===s.get(),d=e=>s.set(String(e)),p=r.createContext(null);function f(e){let{children:t}=e;const n=function(){const{announcementBar:e}=(0,l.L)(),t=(0,a.Z)(),[n,o]=(0,r.useState)((()=>!!t&&u()));(0,r.useEffect)((()=>{o(u())}),[]);const i=(0,r.useCallback)((()=>{d(!0),o(!0)}),[]);return(0,r.useEffect)((()=>{if(!e)return;const{id:t}=e;let n=c.get();"annoucement-bar"===n&&(n="announcement-bar");const r=t!==n;c.set(t),r&&d(!1),!r&&u()||o(!1)}),[e]),(0,r.useMemo)((()=>({isActive:!!e&&!n,close:i})),[e,n,i])}();return r.createElement(p.Provider,{value:n},t)}function m(){const 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(902),i=n(12),l=n(6668);const s=r.createContext(void 0),c="theme",u=(0,i.WA)(c),d={light:"light",dark:"dark"},p=e=>e===d.dark?d.dark:d.light,f=e=>a.Z.canUseDOM?p(document.documentElement.getAttribute("data-theme")):p(e),m=e=>{u.set(p(e))};function h(e){let{children:t}=e;const n=function(){const{colorMode:{defaultMode:e,disableSwitch:t,respectPrefersColorScheme:n}}=(0,l.L)(),[a,o]=(0,r.useState)(f(e));(0,r.useEffect)((()=>{t&&u.del()}),[t]);const i=(0,r.useCallback)((function(t,r){void 0===r&&(r={});const{persist:a=!0}=r;t?(o(t),a&&m(t)):(o(n?window.matchMedia("(prefers-color-scheme: dark)").matches?d.dark:d.light:e),u.del())}),[n,e]);(0,r.useEffect)((()=>{document.documentElement.setAttribute("data-theme",p(a))}),[a]),(0,r.useEffect)((()=>{if(t)return;const e=e=>{if(e.key!==c)return;const t=u.get();null!==t&&i(p(t))};return window.addEventListener("storage",e),()=>window.removeEventListener("storage",e)}),[t,i]);const s=(0,r.useRef)(!1);return(0,r.useEffect)((()=>{if(t&&!n)return;const e=window.matchMedia("(prefers-color-scheme: dark)"),r=()=>{window.matchMedia("print").matches||s.current?s.current=window.matchMedia("print").matches:i(null)};return e.addListener(r),()=>e.removeListener(r)}),[i,t,n]),(0,r.useMemo)((()=>({colorMode:a,setColorMode:i,get isDarkTheme(){return a===d.dark},setLightTheme(){i(d.light)},setDarkTheme(){i(d.dark)}})),[a,i])}();return r.createElement(s.Provider,{value:n},t)}function g(){const 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(2802),s=n(902),c=n(12);const u=e=>`docs-preferred-version-${e}`,d={save:(e,t,n)=>{(0,c.WA)(u(e),{persistence:t}).set(n)},read:(e,t)=>(0,c.WA)(u(e),{persistence:t}).get(),clear:(e,t)=>{(0,c.WA)(u(e),{persistence:t}).del()}},p=e=>Object.fromEntries(e.map((e=>[e,{preferredVersionName:null}])));const f=r.createContext(null);function m(){const e=(0,a._r)(),t=(0,i.L)().docs.versionPersistence,n=(0,r.useMemo)((()=>Object.keys(e)),[e]),[o,l]=(0,r.useState)((()=>p(n)));(0,r.useEffect)((()=>{l(function(e){let{pluginIds:t,versionPersistence:n,allDocsData:r}=e;function a(e){const t=d.read(e,n);return r[e].versions.some((e=>e.name===t))?{preferredVersionName:t}:(d.clear(e,n),{preferredVersionName:null})}return Object.fromEntries(t.map((e=>[e,a(e)])))}({allDocsData:e,versionPersistence:t,pluginIds:n}))}),[e,t,n]);return[o,(0,r.useMemo)((()=>({savePreferredVersion:function(e,n){d.save(e,t,n),l((t=>({...t,[e]:{preferredVersionName:n}})))}})),[t])]}function h(e){let{children:t}=e;const n=m();return r.createElement(f.Provider,{value:n},t)}function g(e){let{children:t}=e;return l.cE?r.createElement(h,null,t):r.createElement(r.Fragment,null,t)}function b(){const e=(0,r.useContext)(f);if(!e)throw new s.i6("DocsPreferredVersionContextProvider");return e}function v(e){void 0===e&&(e=o.m);const t=(0,a.zh)(e),[n,i]=b(),{preferredVersionName:l}=n[e];return{preferredVersion:t.versions.find((e=>e.name===l))??null,savePreferredVersionName:(0,r.useCallback)((t=>{i.savePreferredVersion(e,t)}),[i,e])}}},1116:(e,t,n)=>{"use strict";n.d(t,{V:()=>s,b:()=>l});var r=n(7294),a=n(902);const o=Symbol("EmptyContext"),i=r.createContext(o);function l(e){let{children:t,name:n,items:a}=e;const o=(0,r.useMemo)((()=>n&&a?{name:n,items:a}:null),[n,a]);return r.createElement(i.Provider,{value:o},t)}function s(){const 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(902));function s(e){!function(e){const t=(0,i.k6)(),n=(0,l.zX)(e);(0,r.useEffect)((()=>t.block(((e,t)=>n(e,t)))),[t,n])}(((t,n)=>{if("POP"===n)return e(t,n)}))}var c=n(6668);const u=r.createContext(void 0);function d(){const e=function(){const e=(0,a.HY)(),{items:t}=(0,c.L)().navbar;return 0===t.length&&!e.component}(),t=(0,o.i)(),n=!e&&"mobile"===t,[i,l]=(0,r.useState)(!1);s((()=>{if(i)return l(!1),!1}));const u=(0,r.useCallback)((()=>{l((e=>!e))}),[]);return(0,r.useEffect)((()=>{"desktop"===t&&l(!1)}),[t]),(0,r.useMemo)((()=>({disabled:e,shouldRender:n,toggle:u,shown:i})),[e,n,u,i])}function p(e){let{children:t}=e;const n=d();return r.createElement(u.Provider,{value:n},t)}function f(){const e=r.useContext(u);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(902);const o=r.createContext(null);function i(e){let{children:t}=e;const n=(0,r.useState)({component:null,props:null});return r.createElement(o.Provider,{value:n},t)}function l(){const e=(0,r.useContext)(o);if(!e)throw new a.i6("NavbarSecondaryMenuContentProvider");return e[0]}function s(e){let{component:t,props:n}=e;const i=(0,r.useContext)(o);if(!i)throw new a.i6("NavbarSecondaryMenuContentProvider");const[,l]=i,s=(0,a.Ql)(n);return(0,r.useEffect)((()=>{l({component:t,props:s})}),[l,t,s]),(0,r.useEffect)((()=>()=>l({component:null,props:null})),[l]),null}},9727:(e,t,n)=>{"use strict";n.d(t,{h:()=>a,t:()=>o});var r=n(7294);const a="navigation-with-keyboard";function o(){(0,r.useEffect)((()=>{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),()=>{document.body.classList.remove(a),document.removeEventListener("keydown",e),document.removeEventListener("mousedown",e)}}),[])}},7524:(e,t,n)=>{"use strict";n.d(t,{i:()=>c});var r=n(7294),a=n(412);const o={desktop:"desktop",mobile:"mobile",ssr:"ssr"},i=996;function l(){return a.Z.canUseDOM?window.innerWidth>i?o.desktop:o.mobile:o.ssr}const s=!1;function c(){const[e,t]=(0,r.useState)((()=>s?"ssr":l()));return(0,r.useEffect)((()=>{function e(){t(l())}const n=s?window.setTimeout(e,1e3):void 0;return window.addEventListener("resize",e),()=>{window.removeEventListener("resize",e),clearTimeout(n)}}),[]),e}},5281:(e,t,n)=>{"use strict";n.d(t,{k:()=>r});const 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:e=>`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:e=>`theme-doc-sidebar-item-category-level-${e}`,docSidebarItemLinkLevel:e=>`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})},2802:(e,t,n)=>{"use strict";n.d(t,{Wl:()=>p,_F:()=>h,cE:()=>d,hI:()=>k,lO:()=>v,vY:()=>w,oz:()=>y,s1:()=>b});var r=n(7294),a=n(6550),o=n(8790),i=n(143),l=n(373),s=n(1116);function c(e){return Array.from(new Set(e))}var u=n(8596);const d=!!i._r;function p(e){if(e.href)return e.href;for(const t of e.items){if("link"===t.type)return t.href;if("category"===t.type){const e=p(t);if(e)return e}}}const f=(e,t)=>void 0!==e&&(0,u.Mg)(e,t),m=(e,t)=>e.some((e=>h(e,t)));function h(e,t){return"link"===e.type?f(e.href,t):"category"===e.type&&(f(e.href,t)||m(e.items,t))}function g(e){let{sidebarItems:t,pathname:n,onlyCategories:r=!1}=e;const a=[];return function e(t){for(const o of t)if("category"===o.type&&((0,u.Mg)(o.href,n)||e(o.items))||"link"===o.type&&(0,u.Mg)(o.href,n)){return r&&"category"!==o.type||a.unshift(o),!0}return!1}(t),a}function b(){const e=(0,s.V)(),{pathname:t}=(0,a.TH)(),n=(0,i.gA)()?.pluginData.breadcrumbs;return!1!==n&&e?g({sidebarItems:e.items,pathname:t}):null}function v(e){const{activeVersion:t}=(0,i.Iw)(e),{preferredVersion:n}=(0,l.J)(e),a=(0,i.yW)(e);return(0,r.useMemo)((()=>c([t,n,a].filter(Boolean))),[t,n,a])}function y(e,t){const n=v(t);return(0,r.useMemo)((()=>{const t=n.flatMap((e=>e.sidebars?Object.entries(e.sidebars):[])),r=t.find((t=>t[0]===e));if(!r)throw new Error(`Can't find any sidebar with id "${e}" in version${n.length>1?"s":""} ${n.map((e=>e.name)).join(", ")}".\nAvailable sidebar ids are:\n- ${t.map((e=>e[0])).join("\n- ")}`);return r[1]}),[e,n])}function w(e,t){const n=v(t);return(0,r.useMemo)((()=>{const t=n.flatMap((e=>e.docs)),r=t.find((t=>t.id===e));if(!r){if(n.flatMap((e=>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((e=>e.name)).join(", ")}".\nAvailable doc ids are:\n- ${c(t.map((e=>e.id))).join("\n- ")}`)}return r}),[e,n])}function k(e){let{route:t,versionMetadata:n}=e;const r=(0,a.TH)(),i=t.routes,l=i.find((e=>(0,a.LX)(r.pathname,e)));if(!l)return null;const s=l.sidebar,c=s?n.docsSidebars[s]:void 0;return{docElement:(0,o.H)(i),sidebarName:s,sidebarItems:c}}},1944:(e,t,n)=>{"use strict";n.d(t,{FG:()=>p,d:()=>u,VC:()=>f});var r=n(7294),a=n(6010),o=n(5742),i=n(226);function l(){const e=r.useContext(i._);if(!e)throw new Error("Unexpected: no Docusaurus route context found");return e}var s=n(4996),c=n(2263);function u(e){let{title:t,description:n,keywords:a,image:i,children:l}=e;const u=function(e){const{siteConfig:t}=(0,c.Z)(),{title:n,titleDelimiter:r}=t;return e?.trim().length?`${e.trim()} ${r} ${n}`:n}(t),{withBaseUrl:d}=(0,s.C)(),p=i?d(i,{absolute:!0}):void 0;return r.createElement(o.Z,null,t&&r.createElement("title",null,u),t&&r.createElement("meta",{property:"og:title",content:u}),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)}const d=r.createContext(void 0);function p(e){let{className:t,children:n}=e;const 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){let{children:t}=e;const n=l(),o=`plugin-${n.plugin.name.replace(/docusaurus-(?:plugin|theme)-(?:content-)?/gi,"")}`;const i=`plugin-id-${n.plugin.id}`;return r.createElement(p,{className:(0,a.Z)(o,i)},t)}},902:(e,t,n)=>{"use strict";n.d(t,{D9:()=>i,Qc:()=>c,Ql:()=>s,i6:()=>l,zX:()=>o});var r=n(7294);const a=n(412).Z.canUseDOM?r.useLayoutEffect:r.useEffect;function o(e){const t=(0,r.useRef)(e);return a((()=>{t.current=e}),[e]),(0,r.useCallback)((function(){return t.current(...arguments)}),[])}function i(e){const t=(0,r.useRef)();return a((()=>{t.current=e})),t.current}class l extends Error{constructor(e,t){super(),this.name="ReactContextError",this.message=`Hook ${this.stack?.split("\n")[1]?.match(/at (?:\w+\.)?(?\w+)/)?.groups.name??""} is called outside the <${e}>. ${t??""}`}}function s(e){const t=Object.entries(e);return t.sort(((e,t)=>e[0].localeCompare(t[0]))),(0,r.useMemo)((()=>e),t.flat())}function c(e){return t=>{let{children:n}=t;return r.createElement(r.Fragment,null,e.reduceRight(((e,t)=>r.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){const n=e=>(!e||e.endsWith("/")?e:`${e}/`)?.toLowerCase();return n(e)===n(t)}function l(){const{baseUrl:e}=(0,o.Z)().siteConfig;return(0,r.useMemo)((()=>function(e){let{baseUrl:t,routes:n}=e;function r(e){return e.path===t&&!0===e.exact}function a(e){return e.path===t&&!e.exact}return function e(t){if(0===t.length)return;return t.find(r)||e(t.filter(a).flatMap((e=>e.routes??[])))}(n)}({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(902);const l=r.createContext(void 0);function s(e){let{children:t}=e;const n=function(){const e=(0,r.useRef)(!0);return(0,r.useMemo)((()=>({scrollEventsEnabledRef:e,enableScrollEvents:()=>{e.current=!0},disableScrollEvents:()=>{e.current=!1}})),[])}();return r.createElement(l.Provider,{value:n},t)}function c(){const e=(0,r.useContext)(l);if(null==e)throw new i.i6("ScrollControllerProvider");return e}const u=()=>a.Z.canUseDOM?{scrollX:window.pageXOffset,scrollY:window.pageYOffset}:null;function d(e,t){void 0===t&&(t=[]);const{scrollEventsEnabledRef:n}=c(),a=(0,r.useRef)(u()),o=(0,i.zX)(e);(0,r.useEffect)((()=>{const e=()=>{if(!n.current)return;const e=u();o(e,a.current),a.current=e},t={passive:!0};return e(),window.addEventListener("scroll",e,t),()=>window.removeEventListener("scroll",e,t)}),[o,n,...t])}function p(){const e=(0,r.useRef)(null),t=(0,o.Z)()&&"smooth"===getComputedStyle(document.documentElement).scrollBehavior;return{startScroll:n=>{e.current=t?function(e){return window.scrollTo({top:e,behavior:"smooth"}),()=>{}}(n):function(e){let t=null;const n=document.documentElement.scrollTop>e;return function r(){const a=document.documentElement.scrollTop;(n&&a>e||!n&&at&&cancelAnimationFrame(t)}(n)},cancelScroll:()=>e.current?.()}}},3320:(e,t,n)=>{"use strict";n.d(t,{HX:()=>r,os:()=>a});n(2263);const 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);const r="localStorage";function a(e){let{key:t,oldValue:n,newValue:r,storage:a}=e;if(n===r)return;const 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}let i=!1;const l={get:()=>null,set:()=>{},del:()=>{},listen:()=>()=>{}};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);const n=o(t?.persistence);return null===n?l:{get:()=>{try{return n.getItem(e)}catch(t){return console.error(`Docusaurus storage error, can't get key=${e}`,t),null}},set:t=>{try{const r=n.getItem(e);n.setItem(e,t),a({key:e,oldValue:r,newValue:t,storage:n})}catch(r){console.error(`Docusaurus storage error, can't set ${e}=${t}`,r)}},del:()=>{try{const t=n.getItem(e);n.removeItem(e),a({key:e,oldValue:t,newValue:null,storage:n})}catch(t){console.error(`Docusaurus storage error, can't delete key=${e}`,t)}},listen:t=>{try{const r=r=>{r.storageArea===n&&r.key===e&&t(r)};return window.addEventListener("storage",r),()=>window.removeEventListener("storage",r)}catch(r){return console.error(`Docusaurus storage error, can't listen for changes of key=${e}`,r),()=>{}}}}}},4711:(e,t,n)=>{"use strict";n.d(t,{l:()=>i});var r=n(2263),a=n(6550),o=n(8780);function i(){const{siteConfig:{baseUrl:e,url:t,trailingSlash:n},i18n:{defaultLocale:i,currentLocale:l}}=(0,r.Z)(),{pathname:s}=(0,a.TH)(),c=(0,o.applyTrailingSlash)(s,{trailingSlash:n,baseUrl:e}),u=l===i?e:e.replace(`/${l}/`,"/"),d=c.replace(e,"");return{createUrl:function(e){let{locale:n,fullyQualified:r}=e;return`${r?t:""}${function(e){return e===i?`${u}`:`${u}${e}/`}(n)}${d}`}}}},5936:(e,t,n)=>{"use strict";n.d(t,{S:()=>i});var r=n(7294),a=n(6550),o=n(902);function i(e){const t=(0,a.TH)(),n=(0,o.D9)(t),i=(0,o.zX)(e);(0,r.useEffect)((()=>{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){const{trailingSlash:n,baseUrl:r}=t;if(e.startsWith("#"))return e;if(void 0===n)return e;const[a]=e.split(/[#?]/),o="/"===a||a===r?a:(i=a,n?function(e){return e.endsWith("/")?e:`${e}/`}(i):function(e){return e.endsWith("/")?e.slice(0,-1):e}(i));var i;return e.replace(a,o)}},4143:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=void 0,t.getErrorCausalChain=function e(t){return t.cause?[t,...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_:()=>P,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(!c)for(;d--;d)i.unshift("..");!c||""===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 c=n(8776);function u(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);u.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 c=Object.defineProperty,u=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=u(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 c=[n,r,a,o,i,l],u=0;(s=new Error(t.replace(/%s/g,(function(){return c[u++]})))).name="Invariant Violation"}throw s.framesToPop=1,s}}},5826:e=>{e.exports=Array.isArray||function(e){return"[object Array]"==Object.prototype.toString.call(e)}},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),c=o.querySelector(r.barSelector),u=r.speed,d=r.easing;return o.offsetWidth,l((function(t){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),s(c,i(e,u,d)),1===e?(s(o,{transition:"none",opacity:1}),o.offsetWidth,setTimeout((function(){s(o,{transition:"all "+u+"ms linear",opacity:0}),setTimeout((function(){n.remove(),t()}),u)}),u)):setTimeout(t,u)})),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");u(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),c=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),c!=document.body&&u(c,"nprogress-custom-parent"),c.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 c(e,t){return("string"==typeof e?e:p(e)).indexOf(" "+t+" ")>=0}function u(e,t){var n=p(e),r=n+t;c(n,t)||(e.className=r.substring(1))}function d(e,t){var n,r=p(e);c(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+=S.value.length,S=S.next){var _=S.value;if(t.length>e.length)return;if(!(_ instanceof a)){var x,T=1;if(v){if(!(x=o(k,E,e,b))||x.index>=e.length)break;var C=x.index,L=x.index+x[0].length,P=E;for(P+=S.value.length;C>=P;)P+=(S=S.next).value.length;if(E=P-=S.value.length,S.value instanceof a)continue;for(var A=S;A!==t.tail&&(Pd.reach&&(d.reach=M);var I=S.prev;if(N&&(I=s(t,I,N),E+=N.length),c(t,I,T),S=s(t,I,new a(p,g?r.tokenize(R,g):R,y,R)),O&&s(t,S,O),T>1){var D={cause:p+","+m,reach:M};i(e,t,n,S.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 c(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(c,"variable-input")}}}}function u(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 c(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 u(t,n,r){var a=e.tokenize(t,{interpolation:{pattern:RegExp(o),lookbehind:!0}}),i=0,u={},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 u[n]=a,n})).join(""),n,r),p=Object.keys(u);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=c(u[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 c=l[s];if("string"==typeof c||c.content&&"string"==typeof c.content){var u=o[a],d=n.tokenStack[u],p="string"==typeof c?c:c.content,f=t(r,u),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 c?l.splice.apply(l,[s,1].concat(v)):c.content=v}}else c.content&&i(c.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 c(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,c),t(s.optional,c),t(s.modify,c)}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),c=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(c),l=(l||[]).map(c);var u=n(i),d=n(l);i.forEach((function e(n){var r=s[n];t(r&&r.require,(function(t){t in d||(u[t]=!0,e(t))}))}));for(var p,f=r(s),m=u;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 u))for(var v in f(b))if(v in u){p[b]=!0;break}for(var y in m=p)u[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 c(e){if(e in l)return l[e];s[e]=!0;var a,u=[];for(var d in t(e))d in n&&u.push(d);if(0===u.length)a=r(e);else{var p=i(u.map((function(e){var t=c(e);return delete s[e],t})));o?a=o(p,(function(){return r(e)})):r(e)}return l[e]=a}for(var u in n)c(u);var d=[];for(var p in s)d.push(l[p]);return i(d)}(f,u,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