HomeWeb Components API Reference - v0.10.1
    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.

    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(): EntityElement | null

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

      Returns EntityElement | null

      The closest entity 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.

      Returns void