Interface IVector2PropertyItem

A property item which supports Vector2 properties

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

Hierarchy (View Summary)

IPropertyItemBase
- IVector2PropertyItem

Index

Properties

enable id paneId typeName value visible

Methods

setTitle setTooltip updateAxisLimits

Properties

enable

enable: boolean

Remarks

If the item is enabled in the UI.

`Readonly`id

id: string

Remarks

Unique ID for the property item.

`Readonly`paneId

paneId: string

Remarks

The parent pane id.

`Readonly`typeName

typeName: PropertyItemType

Remarks

The type name of the target property.

`Readonly`value

value: Readonly<Vector2>

Remarks

Current value of the property item.

visible

visible: boolean

Remarks

If the item should be visible in the UI.

Methods

setTitle

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

setTooltip

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

updateAxisLimits

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