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

@polygonjs/react-three-fiber

v1.5.27

Published

React Three Fiber component for Polygonjs, the WebGL design & animation tool

Downloads

14

Readme

React Three Fiber Component for Polygonjs

This is a react three fiber component to easily import WebGL scenes created with the node-based editor Polygonjs.

Polygonjs allows you to create complex and procedural scenes with a visual editor, and you can import them with react three fiber, and benefit from its reactive states. You can then update the 3D scene from anything in your react three fiber setup.

Live Demo >>

Install

yarn add @polygonjs/react-three-fiber

or

npm install @polygonjs/react-three-fiber

How to use

The only 2 required properties to give to the component are:

  • loadFunction, which is the function that loads your 3D scene. That function is autogenerated by polygonjs visual editor.
  • sceneName, which is a string to set the scene name (which is used to find the loading image, if used)
<PolygonjsScene sceneName={"scene_01"} loadFunction={loadScene_scene_01} />

Once you've saved a scene, you will have a .js file created with a path like ./src/polygonjs/scenes/<sceneName>/autogenerated/loadScene.js inside your project, which exports a function called loadScene_<sceneName>.

So assuming you have already created a scene called scene_01 in your project, the file will be ./src/polygonjs/scenes/scene_01/autogenerated/loadScene.js and the exported function will be called loadScene_scene_01.

With that in mind, a minimal render function to load a scene will look like this:

import {loadScene_scene_01} from 'src/polygonjs/scenes/scene_01/autogenerated/loadScene';

render (
	<Canvas>
		<PolygonjsScene
			sceneName={"scene_01"}
			loadFunction={loadScene_scene_01} />;
	</Canvas>
)
;

Access the Polygonjs scene

You can update any node of the Polygonjs scene by passing props the <PolygonjsScene/> component.

The name of the prop must match the path of the parameter, which you can get by right-clicking on the parameter label.

And the path is path-to-node--paramname. So you should replace the forward slashes (/) by a dash (-), and have 2 dashes (--) separating the node path and the param name.

So the param /geo1/text1/text (meaning the param test of the node text1 which itself is inside the node geo1) is accessed by the prop geo1-text1--text.

In JSX, you can therefore set it like this:

<PolygonjsScene
	sceneName={"scene_01"}
	loadFunction={loadScene_scene_01}
	geo1-text1--text={'my new string'}
/>;

And you can also access parameter components (for vector or color parameters) by adding the name of the component. For instance, the x component of the translate param is accessed via geo1--t-x.