Class EnvironmentScene

Hierarchy

  • Scene
    • EnvironmentScene

Constructors

constructor

Properties

hideFlags raycastAllowed raycastPreference? worldPosition worldQuaternion worldRotation worldScale

Accessors

guid worldForward worldRight worldUp

Methods

addComponent contains createAreaLightMaterial destroy getComponent getComponentInChildren getComponentInParent getComponents getComponentsInChildren getComponentsInParent getOrAddComponent removeComponent

Constructors

constructor

Properties

hideFlags

hideFlags: HideFlags

Allows to control e.g. if an object should be exported

raycastAllowed

raycastAllowed: boolean

If false the object will be ignored for raycasting (e.g. pointer events). Default is true.

Default

true

OptionalraycastPreference

raycastPreference?: "lod" | "bounds" | "full"

Set a raycast preference for the object:

  • lod will use the raycast mesh lod if available (default). This is usually a simplified mesh for raycasting.
  • bounds will use the bounding box of the object for raycasting. This is very fast but not very accurate.
  • full will use the full mesh for raycasting. This is the most accurate but also the slowest option.

NOTE: Needle Engine's Raycast system will use Mesh BVH by default - so event 'full' is usually faster than default three.js raycasting.

worldPosition

worldPosition: Vector3

Get or set the world position of the Object3D.
Added by Needle Engine.

worldQuaternion

worldQuaternion: Quaternion

Get or set the world quaternion of the Object3D.
Added by Needle Engine.

worldRotation

worldRotation: Vector3

Get or set the world rotation of the Object3D.
Added by Needle Engine.

worldScale

worldScale: Vector3

Get or set the world scale of the Object3D.
Added by Needle Engine.

Accessors

guid

  • get guid(): undefined | string

    Returns undefined | string

  • set guid(value: undefined | string): void

    Parameters

    • value: undefined | string

    Returns void

worldForward

  • get worldForward(): Vector3

    Get the world forward vector of the Object3D.
    Added by Needle Engine.

    Returns Vector3

  • set worldForward(v: Vector3): void

    Parameters

    Returns void

worldRight

  • get worldRight(): Vector3

    Get the world right vector of the Object3D.
    Added by Needle Engine.

    Returns Vector3

worldUp

  • get worldUp(): Vector3

    Get the world up vector of the Object3D.
    Added by Needle Engine.

    Returns Vector3

Methods

addComponent

  • addComponent<T extends IComponent>(
        comp: T | ConstructorConcrete<T>,
        init?: Partial<
            NoInternalNeedleEngineState<
                FilterStartingWith<FilterTypes<T, undefined | null | Function>, "_">,
            >,
        >,
    ): T

    Add a Needle Engine component to the Object3D.

    Type Parameters

    Parameters

    • comp: T | ConstructorConcrete<T>

      The component instance or constructor to add.

    • Optionalinit: Partial<
          NoInternalNeedleEngineState<
              FilterStartingWith<FilterTypes<T, undefined | null | Function>, "_">,
          >,
      >

      Optional initialization data for the component.

    Returns T

    The added component instance.

    Example: Directly pass in constructor and properties:

    const obj = new Object3D();
    obj.addComponent(MyComponent, { myProperty: 42 });

    Example: Create a component instance, assign properties and then add it:

    const obj = new Object3D();
    const comp = new MyComponent();
    comp.myProperty = 42;
    obj.addComponent(comp);

contains

  • contains(object: undefined | null | Object3D<Object3DEventMap>): boolean

    Check if the given object is contained in the hierarchy of this object or if it's the same object.

    Parameters

    • object: undefined | null | Object3D<Object3DEventMap>

      The object to check.

    Returns boolean

    True if the object is contained in the hierarchy, false otherwise.

createAreaLightMaterial

  • createAreaLightMaterial(intensity: number): MeshBasicMaterial

    Parameters

    • intensity: number

    Returns MeshBasicMaterial

destroy

  • destroy(): void

    Destroys the Object3D and all its Needle Engine components.

    Returns void

getComponent

  • getComponent<T extends IComponent>(type: Constructor<T>): null | T

    Get a Needle Engine component from the Object3D.

    Type Parameters

    Parameters

    • type: Constructor<T>

    Returns null | T

    The component instance or null if not found.

getComponentInChildren

  • getComponentInChildren<T extends IComponent>(type: Constructor<T>): null | T

    Get a Needle Engine component from the Object3D or its children. This will search on the current Object and all its children.

    Type Parameters

    Parameters

    • type: Constructor<T>

    Returns null | T

    The component instance or null if not found.

getComponentInParent

  • getComponentInParent<T extends IComponent>(type: Constructor<T>): null | T

    Get a Needle Engine component from the Object3D or its parents. This will search on the current Object and all its parents.

    Type Parameters

    Parameters

    • type: Constructor<T>

    Returns null | T

    The component instance or null if not found.

getComponents

  • getComponents<T extends IComponent>(type: Constructor<T>, arr?: []): T[]

    Get all components of a specific type from the Object3D.

    Type Parameters

    Parameters

    • type: Constructor<T>
    • Optionalarr: []

      Optional array to fill with the found components.

    Returns T[]

    An array of components.

getComponentsInChildren

  • getComponentsInChildren<T extends IComponent>(
        type: Constructor<T>,
        arr?: [],
    ): T[]

    Get all components of a specific type from the Object3D or its children. This will search on the current Object and all its children.

    Type Parameters

    Parameters

    • type: Constructor<T>
    • Optionalarr: []

      Optional array to fill with the found components.

    Returns T[]

    An array of components.

getComponentsInParent

  • getComponentsInParent<T extends IComponent>(type: Constructor<T>, arr?: []): T[]

    Get all Needle Engine components of a specific type from the Object3D or its parents. This will search on the current Object and all its parents.

    Type Parameters

    Parameters

    • type: Constructor<T>
    • Optionalarr: []

      Optional array to fill with the found components.

    Returns T[]

    An array of components.

getOrAddComponent

  • getOrAddComponent<T extends IComponent>(
        typeName: ConstructorConcrete<T>,
        init?: Partial<
            NoInternalNeedleEngineState<
                FilterStartingWith<FilterTypes<T, undefined | null | Function>, "_">,
            >,
        >,
    ): T

    Get or add a Needle Engine component to the Object3D. If the component already exists, it will be returned. Otherwise, a new component will be added.

    Type Parameters

    Parameters

    • typeName: ConstructorConcrete<T>

      The component constructor to get or add.

    • Optionalinit: Partial<
          NoInternalNeedleEngineState<
              FilterStartingWith<FilterTypes<T, undefined | null | Function>, "_">,
          >,
      >

      Optional initialization data for the component.

    Returns T

    The component instance.

removeComponent

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods