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.

Hierarchy (View Summary)

ComponentElement
- RenderComponentElement

Index

Accessors

castShadows component enabled material receiveShadows type

Methods

_onReady ready

Accessors

castShadows

get castShadows(): boolean
Gets the cast shadows flag of the render component.

Returns boolean
The cast shadows flag.
- Defined in submodules/web-components/src/components/render-component.ts:78
set castShadows(value: boolean): void
Sets the cast shadows flag of the render component.
Parameters
- value: boolean
  The cast shadows flag.
Returns void
- Defined in submodules/web-components/src/components/render-component.ts:67

component

get component(): RenderComponent
Gets the render component.

Returns RenderComponent
The render component.
Overrides ComponentElement.component
- Defined in submodules/web-components/src/components/render-component.ts:40

enabled

get enabled(): boolean
Gets the enabled state of the component.

Returns boolean
The enabled state of the component.
Inherited from ComponentElement.enabled
- Defined in submodules/web-components/src/components/component.ts:80
set enabled(value: boolean): void
Sets the enabled state of the component.
Parameters
- value: boolean
  The enabled state of the component.
Returns void
Inherited from ComponentElement.enabled
- Defined in submodules/web-components/src/components/component.ts:69

material

get material(): string
Gets the id of the material asset used by the render component.

Returns string
The id of the material asset.
- Defined in submodules/web-components/src/components/render-component.ts:97
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
- Defined in submodules/web-components/src/components/render-component.ts:86

receiveShadows

get receiveShadows(): boolean
Gets the receive shadows flag of the render component.

Returns boolean
The receive shadows flag.
- Defined in submodules/web-components/src/components/render-component.ts:116
set receiveShadows(value: boolean): void
Sets the receive shadows flag of the render component.
Parameters
- value: boolean
  The receive shadows flag.
Returns void
- Defined in submodules/web-components/src/components/render-component.ts:105

type

get type(): | "asset"
| "box"
| "plane"
| "sphere"
| "capsule"
| "cylinder"
| "cone"
Gets the type of the render component.

Returns "asset" | "box" | "plane" | "sphere" | "capsule" | "cylinder" | "cone"
The type.
- Defined in submodules/web-components/src/components/render-component.ts:59
set type(
    value:
        | "asset"
        | "box"
        | "plane"
        | "sphere"
        | "capsule"
        | "cylinder"
        | "cone",
): void
Sets the type of the render component.
Parameters
- value: "asset" | "box" | "plane" | "sphere" | "capsule" | "cylinder" | "cone"
  The type.
Returns void
- Defined in submodules/web-components/src/components/render-component.ts:48

Methods

`Protected`_onReady

_onReady(): void
Called when the element is fully initialized and ready. Subclasses should call this when they're ready.

Returns void
Inherited from ComponentElement._onReady
- Defined in submodules/web-components/src/async-element.ts:32

ready

ready(): Promise<RenderComponentElement>
Returns a promise that resolves with this element when it's ready.

Returns Promise<RenderComponentElement>
A promise that resolves with this element when it's ready.
Inherited from ComponentElement.ready
- Defined in submodules/web-components/src/async-element.ts:41

Class RenderComponentElement

Hierarchy (View Summary)

Index

Accessors

Methods

Accessors

castShadows

Returns boolean

Parameters

Returns void

component

Returns RenderComponent

enabled

Returns boolean

Parameters

Returns void

material

Returns string

Parameters

Returns void

receiveShadows

Returns boolean

Parameters

Returns void

type

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

Parameters

Returns void

Methods

`Protected`_onReady

Returns void

ready

Returns Promise<RenderComponentElement>

Settings

On This Page

Class RenderComponentElement

Hierarchy (View Summary)

Index

Accessors

Methods

Accessors

castShadows

Returns boolean

Parameters

Returns void

component

Returns RenderComponent

enabled

Returns boolean

Parameters

Returns void

material

Returns string

Parameters

Returns void

receiveShadows

Returns boolean

Parameters

Returns void

type

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

Parameters

Returns void

Methods

Protected_onReady

Returns void

ready

Returns Promise<RenderComponentElement>

Settings

On This Page

`Protected`_onReady