npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

aframe-image-portal

v0.0.1

Published

aframe-image-portal lets you generate and display portal effects in AR a-frame scene.

Downloads

42

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

brianpeirisbrianpeiris

Keywords

aframewebxrarportal

Readme

aframe-image-portal

The image-portal component allows you to create "portal" effects in AR scenes, where an image can be displayed on the inside of a sphere, with a hole in it which you can enter through. The portal effect is achieved by making the outside of the sphere invisible.

The image-portal component only takes care of displaying the portal, you can use the generator tool to create portals and download them as GLB (glTF) files.

Visit the examples on a device that supports WebXR to see the effect in AR.

API

| Property | Description | Default Value | | -------- | ----------- | ------------- | | src | Asset or url for the portal GLB model. | null | | autoReparent | Optional. Automatically reparent the occlusion mesh to the scene and ensure that it is the last object. See the "How it works" section for more information. | false | | renderOrder | Optional. Render order to use on the occlusion mesh, when sortObjects is enabled on the renderer, and autoReparent is false. See the "How it works" section for more information. | 1 | | debug | Optional. Render the occlusion mesh as a wireframe so that you can see it for troubleshooting. | false |

Usage

<head>
  <script src="https://aframe.io/releases/1.2.0/aframe.min.js"></script>
  <script src="https://unpkg.com/aframe-image-portal@latest"></script>
</head>

<body>
  <a-scene>
    <a-assets>
      <a-asset-item id="portal" src="portal.glb"></a-asset-item>
    </a-assets>
    <a-entity image-portal="src: #portal"></a-entity>
  </a-scene>
</body>

How it works

The image-portal effect works by using an occlusion mesh which does not write to the color buffer. Additionally, if you have other objects in the scene, they need to be rendered in the correct order, so that the occluder actually occludes the image and other objects correctly.

By default, the image-portal does not attempt to change rendering order. It uses the rendering order defined by the order you have added objects to the scene. This works fine if the only thing you have in the scene is the image-portal.

If you have other objects in the scene and you want image-portal to render correctly with those objects, you have two options. Either enable the sortObjects property on your renderer, or enable the autoReparent property on the image-portal. If you chose to enable sortObjects, you can further control the ordering by using the renderOrder property on the image-portal.