API
クラス
Negl

negl機能一覧 / Exports / Negl

Class: Negl

neglのコンポーネント（world、scrollerなど）へのアクセスを提供します。

取得方法

import { negl } from "negl";
// or
window.negl

前提条件 neglへのアクセスはsetup、startの実行後に行なってください。

import { setup } from "negl";
(async () => {
  const { start } = await setup();
  const negl = await start();
  // 以下、start実行後 `negl` 内のコンポーネントにアクセス可能
  // アクセス例）
  // 1. neglのプロパティから`mouse`コンポーネントにアクセス
  console.log(negl.mouse.getClipPos());
})();
 
// 2. start() 実行後は静的インポートでも `negl` 内のコンポーネントにアクセス可能です。
// import { mouse } from "negl";

Table of contents

Properties

Methods

Properties

INode

• INode: typeof INode = INode

INodeオブジェクトへのアクセスを提供します。

config

• config: Config

Configオブジェクトへのアクセスを提供します。

gui

• Optional gui: Gui

Guiオブジェクトへのアクセスを提供します。 start関数の実行後にアクセス可能です。

hook

• hook: Hook = hook

Hookオブジェクトへのアクセスを提供します。

loader

• Optional loader: Loader

Loaderオブジェクトへのアクセスを提供します。 start関数の実行後にアクセス可能です。

meshUI

• Optional meshUI: MeshUI

MeshUIオブジェクトへのアクセスを提供します。 start関数の実行後にアクセス可能です。

mouse

• Optional mouse: Mouse

Mouseオブジェクトへのアクセスを提供します。 start関数の実行後にアクセス可能です。

negl

• negl: Negl

自オブジェクト（Neglオブジェクト）を返します。以下のような書き方が可能です。

const { negl } = negl;

scroller

• Optional scroller: Scroller

Scrollerオブジェクトへのアクセスを提供します。 start関数の実行後にアクセス可能です。

transition

• Optional transition: Transition

Transitionオブジェクトへのアクセスを提供します。 start関数の実行後にアクセス可能です。

utils

• utils: Record<string, any>

utilsオブジェクトへのアクセスを提供します。

viewport

• Optional viewport: Viewport

Viewportオブジェクトへのアクセスを提供します。 start関数の実行後にアクセス可能です。

world

• Optional world: World

Worldオブジェクトへのアクセスを提供します。 start関数の実行後にアクセス可能です。

Methods

renderStart

▸ renderStart(): void

WebGLのレンダリングを開始します。three.js のシーンのレンダリングを開始したいタイミングで実行してください。

Returns

void

MouseOb