Interface IVector3TimelinePropertyItem

A property item which supports Vector3 Timeline properties

interface IVector3TimelinePropertyItem {
    enable: boolean;
    id: string;
    paneId: string;
    typeName: PropertyItemType;
    visible: boolean;
    addNode(data: IVector3TimelinePropertyItemEntry): void;
    getData(): IVector3TimelinePropertyItemEntry[];
    getTime(): number;
    removeNode(data: IVector3TimelinePropertyItemEntry): void;
    setBounds(bounds: { maxValue: number; minValue: number }): void;
    setPrecision(precision: number): void;
    setTime(time: number): void;
    setTitle(title: LocalizedString): void;
    updateNode(data: IVector3TimelinePropertyItemEntry): void;
}

Hierarchy (View Summary)

IPropertyItemBase
- IVector3TimelinePropertyItem

Index

Properties

enable id paneId typeName visible

Methods

addNode getData getTime removeNode setBounds setPrecision setTime setTitle updateNode

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.

visible

visible: boolean

Remarks

If the item should be visible in the UI.

Methods

addNode

addNode(data: IVector3TimelinePropertyItemEntry): void
Parameters
- data: IVector3TimelinePropertyItemEntry
  New vector3 node.
Returns void
Remarks
Update vector3 timeline entry

getData

getData(): IVector3TimelinePropertyItemEntry[]
Returns IVector3TimelinePropertyItemEntry[]
Remarks
Get the list of nodes in the property item.

getTime

getTime(): number
Returns number
Remarks
Get time current time value on the slider.

removeNode

removeNode(data: IVector3TimelinePropertyItemEntry): void
Parameters
- data: IVector3TimelinePropertyItemEntry
  Node to be removed.
Returns void
Remarks
Remove vector3 node

setBounds

setBounds(bounds: { maxValue: number; minValue: number }): void
Parameters
- bounds: { maxValue: number; minValue: number }
Returns void
Remarks
Updates data entries value bounds.

setPrecision

setPrecision(precision: number): void
Parameters
- precision: number
Returns void
Remarks
Set custom decimal precision for the calculations

setTime

setTime(time: number): void
Parameters
- time: number
  The new time value.
Returns void
Remarks
Set time line slider value to a new value

setTitle

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

updateNode

updateNode(data: IVector3TimelinePropertyItemEntry): void
Parameters
- data: IVector3TimelinePropertyItemEntry
  Node to be updated.
Returns void
Remarks
Update node value