Interface IVector3PropertyItem`Beta`

A property item which supports Vector3 properties

interface IVector3PropertyItem {
    enable: boolean;
    id: string;
    paneId: string;
    typeName: PropertyItemType;
    value: Readonly<Vector3>;
    visible: boolean;
    setTitle(title: LocalizedString): void;
    setTooltip(tooltip: LocalizedString): void;
    updateAxisLimits(
        limits: { max?: Partial<Vector3>; min?: Partial<Vector3> },
    ): void;
}

Hierarchy (View Summary)

IPropertyItemBase
- IVector3PropertyItem

Index

Properties

enable id paneId typeName value visible

Methods

setTitle setTooltip updateAxisLimits

Properties

`Beta`enable

enable: boolean

Remarks

If the item is enabled in the UI.

`Readonly` `Beta`id

id: string

Remarks

Unique ID for the property item.

`Readonly` `Beta`paneId

paneId: string

Remarks

The parent pane id.

`Readonly` `Beta`typeName

typeName: PropertyItemType

Remarks

The type name of the target property.

`Readonly` `Beta`value

value: Readonly<Vector3>

Remarks

Current value of the property item.

`Beta`visible

visible: boolean

Remarks

If the item should be visible in the UI.

Methods

setTitle

setTitle(title: LocalizedString): void
Beta
Parameters
- title: LocalizedString
  New button title.
Returns void
Remarks
Updates title of the button.

setTooltip

setTooltip(tooltip: LocalizedString): void
Beta
Parameters
- tooltip: LocalizedString
  New button tooltip.
Returns void
Remarks
Updates tooltip description of the button.

updateAxisLimits

updateAxisLimits(
limits: { max?: Partial<Vector3>; min?: Partial<Vector3> },
): void
Beta
Parameters
- limits: { max?: Partial<Vector3>; min?: Partial<Vector3> }
Returns void
Remarks
Updates Vector3 limits and clamps the current value.