クラス

概要

こちらでは negl 内で使用されているクラスを参照できます。各クラスは negl 内部でインスタンス化され、オブジェクトとして利用者に提供されます。（その為、クラスを利用者の方でインスタンス化して記述することはありません。）

インスタンス化されたオブジェクトは negl オブジェクト、または negl モジュールからインポートして使用することができます。

以降、クラスごとに詳細な仕様について記載していますが、ほとんどのケースでは詳細な仕様を理解する必要はありません。

次に、良く使用する機能について紹介しますので、その部分だけざっと目を通してください。それ以外の機能については不明点が出たタイミングで調べてみてください。

Hook negl 内部の全てのイベントの登録、削除に使用します。メッシュをクリックした際のイベントやマウスホバーのイベント、スクロールイベント、レンダリング毎に発火するイベント、ページトランジションのイベント、画面リサイズのイベントなど様々なイベントの発火に応じて処理を実装したい場合はHookオブジェクトを使用してください。
Ob negl でエフェクト（three.js のメッシュ）を作成する場合は Ob クラスを継承して作成します。作成されたエフェクトは World オブジェクトによって管理されます。エフェクト一覧で紹介されているエフェクトなどを実際に動かしながら、理解するのがおススメです。また、エフェクトを実際に作成する場合は応用編 (opens in a new tab)も参考にしてください。
World three.js や WebGL 制御を行うクラスです。three.js のシーン、カメラ、レンダラー、メッシュ（negl でのエフェクト）等を保持しています。

それ以外のクラスに関しては必要に応じて使うことになるため、ざっと目を通してみてください。