Class WidgetComponentRenderPrimitive

Hierarchy (View Summary)

WidgetComponentBase
- WidgetComponentRenderPrimitive

Index

Constructors

Properties

componentType location lockToSurface name offset primitiveType valid visible widget

Methods

delete setPrimitive

Constructors

`Private`constructor

new WidgetComponentRenderPrimitive(): WidgetComponentRenderPrimitive
Returns WidgetComponentRenderPrimitive
Overrides WidgetComponentBase.constructor

Properties

`Readonly`componentType

componentType: WidgetComponentType

Throws

This property can throw when used.

InvalidWidgetComponentError

World Ready

This property can't be read in early-execution mode.

`Readonly`location

location: Vector3

Throws

This property can throw when used.

InvalidWidgetComponentError

World Ready

This property can't be read in early-execution mode.

lockToSurface

lockToSurface: boolean

Remarks

Write Privilege

This property can't be edited in read-only mode.

World Ready

This property can't be read in early-execution mode.

`Readonly`name

name: string

Throws

This property can throw when used.

InvalidWidgetComponentError

World Ready

This property can't be read in early-execution mode.

offset

offset: Vector3

Remarks

Write Privilege

This property can't be edited in read-only mode.

World Ready

This property can't be read in early-execution mode.

`Readonly`primitiveType

primitiveType: PrimitiveType

Throws

This property can throw when used.

InvalidWidgetComponentError

InvalidWidgetError

World Ready

This property can't be read in early-execution mode.

`Readonly`valid

valid: boolean

visible

visible: boolean

`Readonly`widget

widget: Widget

Throws

This property can throw when used.

InvalidWidgetComponentError

World Ready

This property can't be read in early-execution mode.

Methods

delete

delete(): void
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

InvalidWidgetComponentError

World Ready
This function can't be called in early-execution mode.

Inherited from WidgetComponentBase.delete

setPrimitive

setPrimitive(
    primitive:
        | WidgetComponentRenderPrimitiveTypeAxialSphere
        | WidgetComponentRenderPrimitiveTypeBox
        | WidgetComponentRenderPrimitiveTypeDisc
        | WidgetComponentRenderPrimitiveTypeLine,
): void
Parameters
- primitive:
      | WidgetComponentRenderPrimitiveTypeAxialSphere
      | WidgetComponentRenderPrimitiveTypeBox
      | WidgetComponentRenderPrimitiveTypeDisc
      | WidgetComponentRenderPrimitiveTypeLine
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

InvalidWidgetComponentError

InvalidWidgetError

World Ready
This function can't be called in early-execution mode.