HomeWeb Components API Reference - v0.17.0
    Preparing search index...

    Class RenderComponentElement

    The RenderComponentElement interface provides properties and methods for manipulating <pc-render> elements. The RenderComponentElement interface also inherits the properties and methods of the HTMLElement interface.

    This element renders one of the engine's built-in primitives, selected with type (defaulting to box). It does not cover the engine's asset render type, since there is no way to supply a render asset here — use pc-model for glTF content instead.

    Engine component: RenderComponent (render).

    Hierarchy (View Summary)

    Index
    • get closestApp(): AppElement | null

      The nearest ancestor <pc-app> element, or null if this element has no <pc-app> ancestor. The search starts at the parent, so an element never resolves to itself.

      Returns AppElement | null

      The closest app element, or null.

    • get closestEntity(): EntityBaseElement | null

      The nearest ancestor element that fronts an entity — <pc-entity>, <pc-model> or <pc-node> — or null if this element has no such ancestor. The search starts at the parent, so an element never resolves to itself.

      Returns EntityBaseElement | null

      The closest entity-fronting element, or null.

    • get enabled(): boolean

      Gets the enabled state of the component.

      Returns boolean

      The enabled state of the component.

    • set enabled(value: boolean): void

      Sets the enabled state of the component.

      Parameters

      • value: boolean

        The enabled state of the component.

      Returns void

    • get material(): string

      Gets the id of the material asset used by the render component.

      Returns string

      The id of the material asset.

    • set material(value: string): void

      Sets the material of the render component.

      Parameters

      • value: string

        The id of the material asset to use.

      Returns void

    • get receiveShadows(): boolean

      Gets the receive shadows flag of the render component.

      Returns boolean

      The receive shadows flag.

    • set receiveShadows(value: boolean): void

      Sets the receive shadows flag of the render component.

      Parameters

      • value: boolean

        The receive shadows flag.

      Returns void

    • get type(): "box" | "capsule" | "cone" | "cylinder" | "sphere" | "plane"

      Gets the type of the render component.

      Returns "box" | "capsule" | "cone" | "cylinder" | "sphere" | "plane"

      The type.

    • set type(
          value: "box" | "capsule" | "cone" | "cylinder" | "sphere" | "plane",
      ): void

      Sets the type of the render component.

      Parameters

      • value: "box" | "capsule" | "cone" | "cylinder" | "sphere" | "plane"

        The type.

      Returns void

    • Called when the element is fully initialized and ready. Subclasses should call this when they're ready. Resolves the ready promise and dispatches a bubbling, composed ready event. Signals at most once per readiness cycle: a repeat call before _resetReady has re-armed the promise does nothing.

      Returns void

    • Returns the ready promise to its pending state. Subclasses should call this when the resource their readiness announced is torn down (typically from disconnectedCallback), so that a later re-initialization can signal readiness again. Does nothing while the promise is still pending — an in-flight waiter carries over to the next readiness cycle rather than being stranded on a promise nothing will ever resolve.

      Returns void

    • Returns the data the component is created with. Overridden by subclasses to supply the initial values of their cached properties.

      Returns {
          castShadows: boolean;
          material: StandardMaterial | null | undefined;
          receiveShadows: boolean;
          type: "box" | "capsule" | "cone" | "cylinder" | "sphere" | "plane";
      }

      The initial component data.

    • Returns a promise that resolves with this element when it's ready. This is the low-level primitive underlying whenReady, which is the recommended way to wait for elements.

      Readiness tracks the element's current lifecycle: once a ready element is torn down (for example by removing it from the document), this returns a fresh promise that resolves when the element is next ready. A promise obtained earlier stays resolved — call this again after re-inserting an element rather than reusing a promise from before its removal.

      Returns Promise<RenderComponentElement>

      A promise that resolves with this element when it's ready.