Class EnvironmentScene

hideFlags

worldPosition

worldQuaternion

worldRotation

worldScale

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

  • v: Vector3

  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

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

  • T extends IComponent

  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 });
  Copy

  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);
  Copy

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

  • T extends IComponent

  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

  • T extends IComponent

  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

  • T extends IComponent

  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

  • T extends IComponent

  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

  • T extends IComponent

  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

  • T extends IComponent

  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

  • T extends IComponent

  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

• removeComponent(inst: IComponent): IComponent

  Remove a Needle Engine component from the Object3D.

  Parameters

  • inst: IComponent

  Returns IComponent