メインコンテンツまでスキップ

API

PlayCanvas Reactは、3Dアプリケーションを構築するための宣言的なコンポーネントベースのAPIを提供します。APIはコアコンポーネント、エンジンコンポーネント、フックで構成されています。

コア

  • <Application/> - PlayCanvas Engineを初期化し、レンダリングコンテキストを提供するルートコンポーネント
  • <Entity/> - 位置、回転、スケールを持つシーングラフの基本的な構成要素
  • <Gltf/> - GLB/GLTFシーンの読み込みとインスタンス化
  • <Modify.*> - インポートしたGLB内のEntityとComponentを宣言的に変更

コンポーネント

コンポーネントはEntityに動作を追加します。<Entity/>内にネストして、対応するPlayCanvas Componentをアタッチします。

  • <Anim/> - ステートベースのアニメーション
  • <Align/> - 整列ヘルパー
  • <Camera/> - カメラとビューポート
  • <Collision/> - 物理コリジョン形状
  • <Environment/> - シーン環境とスカイボックス
  • <GSplat/> - Gaussian Splatレンダリング
  • <Light/> - ディレクショナル、ポイント、スポットライト
  • <Render/> - メッシュレンダリング(プリミティブとアセット)
  • <Rigidbody/> - 物理リジッドボディ
  • <Script/> - カスタムスクリプトコンポーネント

フック

PlayCanvas Engineのライフサイクルと統合するためのReactフックです。使用パターンとベストプラクティスについては、フックの概要を参照してください。

  • useApp - PlayCanvas Applicationインスタンスへのアクセス
  • useParent - コンテキストから親Entityを取得
  • useAsset - あらゆる種類のPlayCanvas Assetの読み込み
  • useAppEvent - Applicationイベントの購読
  • useMaterial - マテリアルの作成と管理
  • usePhysics - 物理コンテキストと状態へのアクセス