Class OctreeSceneComponent

constructor

• new OctreeSceneComponent(scene?: Scene): OctreeSceneComponent

  Creates a new instance of the component for the given scene

  Parameters

  • Optionalscene: Scene

    Defines the scene to register the component in

  Returns OctreeSceneComponent

ReadonlychecksIsEnabled

Readonlyname

scene

dispose

• dispose(): void

  Disposes the component and the associated resources.

  Returns void

getActiveMeshCandidates

• getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>

  Return the list of active meshes

  Returns ISmartArrayLike<AbstractMesh>

  the list of active meshes

getActiveSubMeshCandidates

• getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>

  Return the list of active sub meshes

  Parameters

  • mesh: AbstractMesh

    The mesh to get the candidates sub meshes from

  Returns ISmartArrayLike<SubMesh>

  the list of active sub meshes

getCollidingSubMeshCandidates

• getCollidingSubMeshCandidates(
      mesh: AbstractMesh,
      collider: Collider,
  ): ISmartArrayLike<SubMesh>

  Return the list of sub meshes colliding with a collider

  Parameters

  • mesh: AbstractMesh

    defines the mesh to find the submesh for

  • collider: Collider

    defines the collider to evaluate the collision against

  Returns ISmartArrayLike<SubMesh>

  the list of colliding sub meshes

getIntersectingSubMeshCandidates

• getIntersectingSubMeshCandidates(
      mesh: AbstractMesh,
      localRay: Ray,
  ): ISmartArrayLike<SubMesh>

  Return the list of sub meshes intersecting with a given local ray

  Parameters

  • mesh: AbstractMesh

    defines the mesh to find the submesh for

  • localRay: Ray

    defines the ray in local space

  Returns ISmartArrayLike<SubMesh>

  the list of intersecting sub meshes

rebuild

• rebuild(): void

  Rebuilds the elements related to this component in case of context lost for instance.

  Returns void

register

• register(): void

  Registers the component in a given scene

  Returns void