@onirix/node-inspector
Advanced tools
Onirix Node Inspector allows you to highlight specific parts of your 3D models and link useful and readable information to the users of your experiences.
OnirixNodeInspector is a JavaScript library designed to interact with the Onirix Embed SDK. It provides functionality to load, inspect, and highlight nodes in a 3D scene, display associated data sheets for selected nodes, and manage interactions with nodes in the scene.
To learn more about this module visit our documentation.
You can install the library via npm:
npm install @onirix/node-inspector
Alternatively, include the dependency in the HTML tag:
<head>
<script src="https://cdn.jsdelivr.net/npm/@onirix/node-inspector@1.0.3/+esm"></script>
</head>
Or use it as an ES module:
import OnirixNodeInspector from "https://cdn.jsdelivr.net/npm/@onirix/node-inspector@1.0.3/+esm";
To initialize the OnirixNodeInspector module, create a new instance of the class and pass the Onirix EmbedSDK instance.
import OnirixEmbedSDK from "https://cdn.jsdelivr.net/npm/@onirix/embed-sdk@1.17.1/+esm";
import OnirixNodeInspector from "https://cdn.jsdelivr.net/npm/@onirix/node-inspector@1.0.3/+esm";
const embedSdk = new OnirixEmbedSDK();
embedSdk.connect();
const nodeInspector = new OnirixNodeInspector(embedSdk);
const nodeInspector = new OnirixNodeInspector(embedSdk, {
enableHighlight: true,
highlightParams: { type: "box", border: { enable: true } },
showNodeData: true,
onlyWithDatasheets: false,
});
Onirix Node Inspector offers you several options to adapt its use to your needs. You can configure the operation through a second parameter in the module builder. These are the available options:
embedSdk (required): Instance of the Onirix Embed SDK.params (optional): Configuration parameters for the inspector:
enableHighlight (default: true): Whether to enable node highlighting.dataStructure(default: ox-node-inspector): Name of the datasheet data structure.highlightParams (default: {type: "box", border: {enable: false}}): Parameters for node highlighting.showNodeData (default: true): Whether to show node data in the UI panel when a node is selected.onlyWithDatasheets (default: false): Whether to only include nodes with associated datasheets.onNodeSelected (default: null): Callback function to execute when a node is selected.import OnirixEmbedSDK from "https://cdn.jsdelivr.net/npm/@onirix/embed-sdk@1.17.1/+esm";
import OnirixNodeInspector from "https://cdn.jsdelivr.net/npm/@onirix/node-inspector@1.0.3/+esm";
const embedSdk = new OnirixEmbedSDK();
embedSdk.connect();
const params = {
'highlightParams': {
'color': '#F00'
},
'dataStructure': 'my-structure',
'onlyWithDatasheets': true
}
const nodeInspector = new OnirixNodeInspector(embedSdk, params);
setHighlightingParams(enable, params)Configures the highlighting parameters for nodes. More information about the highlighting options in the EmbedSDK documentation.
enable (boolean): Whether to enable node highlighting.params (object): Highlighting parameters, such as type and border settings.nodeInspector.setHighlightingParams(true, { type: "box", border: { enable: true } });
import OnirixEmbedSDK from "https://cdn.jsdelivr.net/npm/@onirix/embed-sdk@1.17.1/+esm";
import OnirixNodeInspector from "https://cdn.jsdelivr.net/npm/@onirix/node-inspector@1.0.3/+esm";
const embedSdk = new OnirixEmbedSDK();
embedSdk.connect();
const nodeInspector = new OnirixNodeInspector(embedSdk);
// Configure highlighting
nodeInspector.setHighlightingParams(true, { type: "box", border: { enable: true } });
👤 Onirix
FAQs
Onirix Node Inspector allows you to highlight specific parts of your 3D models and link useful and readable information to the users of your experiences.
We found that @onirix/node-inspector demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket CEO Feross Aboukhadijeh discusses the recent npm supply chain attacks on PodRocket, covering novel attack vectors and how developers can protect themselves.
Security News
Maintainers back GitHub’s npm security overhaul but raise concerns about CI/CD workflows, enterprise support, and token management.
Product
Socket Firewall is a free tool that blocks malicious packages at install time, giving developers proactive protection against rising supply chain attacks.