OctreeSceneComponent

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

Hierarchy

  • OctreeSceneComponent

Index

Constructors

constructor

Find examples in Playground
  • Creates a new instance of the component for the given scene

    Parameters

    • scene: Scene

      Defines the scene to register the component in

    Returns OctreeSceneComponent

Properties

checksIsEnabled

Find examples in Playground
checksIsEnabled: boolean

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

name

Find examples in Playground
name: string

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

scene

Find examples in Playground
scene: Scene

The scene the component belongs to.

Methods

dispose

Find examples in Playground
  • dispose(): void
  • Disposes the component and the associated ressources.

    Returns void

getActiveMeshCandidates

Find examples in Playground

getActiveSubMeshCandidates

Find examples in Playground
  • 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

Find examples in Playground
  • 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

Find examples in Playground
  • 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

Find examples in Playground
  • rebuild(): void
  • Rebuilds the elements related to this component in case of context lost for instance.

    Returns void

register

Find examples in Playground
  • register(): void
  • Registers the component in a given scene

    Returns void

Generated using TypeDoc