OctreeSceneComponent

Class OctreeSceneComponent

Defines the octree scene component responsible to manage any octrees in a given scene.

Hierarchy

OctreeSceneComponent

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new OctreeSceneComponent(scene?: Scene): OctreeSceneComponent

- Defined in .temp/docdirectory/doc.d.ts:14321
Creates a new instance of the component for the given scene

Parameters
- Optional scene: Scene
  
  Defines the scene to register the component in
Returns OctreeSceneComponent

Properties

Readonly checksIsEnabledSearch playground for checksIsEnabled

checksIsEnabled: true = true

Indicates if the meshes have been checked to make sure they are isEnabled()

Readonly nameSearch playground for name

name: "Octree" = "Octree"

The component name help to identify the component in the list of scene components.

sceneSearch playground for scene

scene: Scene

The scene the component belongs to.

Methods

disposeSearch playground for dispose

dispose(): void

- Defined in .temp/docdirectory/doc.d.ts:14365
Disposes the component and the associated resources.

Returns void

getActiveMeshCandidatesSearch playground for getActiveMeshCandidates

getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>

- Defined in .temp/docdirectory/doc.d.ts:14335
Return the list of active meshes

Returns ISmartArrayLike<AbstractMesh>

the list of active meshes

getActiveSubMeshCandidatesSearch playground for getActiveSubMeshCandidates

getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>

- Defined in .temp/docdirectory/doc.d.ts:14341
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

getCollidingSubMeshCandidatesSearch playground for getCollidingSubMeshCandidates

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

- Defined in .temp/docdirectory/doc.d.ts:14356
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

getIntersectingSubMeshCandidatesSearch playground for getIntersectingSubMeshCandidates

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

- Defined in .temp/docdirectory/doc.d.ts:14349
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

rebuildSearch playground for rebuild

rebuild(): void

- Defined in .temp/docdirectory/doc.d.ts:14361
Rebuilds the elements related to this component in case of context lost for instance.

Returns void

registerSearch playground for register

register(): void

- Defined in .temp/docdirectory/doc.d.ts:14330
Registers the component in a given scene

Returns void