Wonderland Engine integration for the lazy-widgets Typescript UI library.
A reboot of the @rafern/canvas-ui-wl library.
Before you follow these instructions: These instructions don't apply to the example project. The example project should run out-of-the-box, and following these might break it.
lazy-widgets
NPM package: npm install --save-dev lazy-widgets
npm install --save lazy-widgets-wle
--save
instead of --save-dev
, otherwise it will not work, since Wonderland Engine libraries can't be devDependencies
if they are meant to be used in the editorlazy-widgets
and lazy-widgets-wle
in your codeNote that there is no API in Wonderland Engine to get information about a
pipeline or shader. This means that there is no way for this library to know
which field should be set for a material's texture (is it diffuseTexture
or
flatTexture
, or another field name?). Because of this, this library tries to
guess which field should be set by looking at the name of the shader. The
following names are supported at the moment:
Flat Opaque Textured
Phong Opaque Textured
Physical Opaque Textured
Flat Transparent Textured
Phong Transparent Textured
Physical Transparent Textured
Phong Normalmapped
Phong Lightmapped
If a custom pipeline is used, the texture uniform name can also be set with the
textureUniformName
WLRoot property.
Documentation can be generated locally with the command npm run docs
. Output
will be in a new docs
folder. The documentation is also served on
Github Pages.
Documentation for lazy-widgets
is available in the
lazy-widgets Github Pages.
An example project can be found in the example-project
folder, which is also
served on
Github Pages.
A component which disables a component of 2 given objects if the keyboard and/or
mouse are in use in a UI root is also provided. The component is named
lazy-widgets-input-guard
.
Special thanks to Playko (website, github) where this project started and is currently being developed at, and to the Wonderland Engine developers (website).
This project is licensed under the MIT license (see the LICENSE file)
This project uses the following open-source projects:
Generated using TypeDoc