Interface FaceStretchVisual`Beta`

The same entity as in Lens Scripting.

See

"Lens Scripting".Built-In.FaceStretchVisual.

interface FaceStretchVisual {
    enabled: boolean;
    faceIndex: number;
    id: Uuid;
    name: string;
    renderOrder: number;
    sceneObject: Editor.Model.SceneObject;
    type: string;
    addFeature(name: string): void;
    clearFeatures(): void;
    getDirectlyReferencedEntities(): Entity[];
    getFeatureNames(): string[];
    getFeaturePoints(name: string): StretchPoint[];
    getFeatureWeight(name: string): number;
    getOwnedEntities(): Entity[];
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
    remapReferences(referenceMapping: object): void;
    removeFeature(name: string): void;
    setFeatureWeight(name: string, weight: number): void;
    updateFeaturePoints(name: string, points: StretchPoint[]): void;
}

Hierarchy (view full)

Editor.Components.Visual
- FaceStretchVisual

Properties

`Beta`enabled

enabled: boolean

`Beta`faceIndex

faceIndex: number

`Readonly` `Beta`id

id: Uuid

The unique id of the entity.

`Beta`name

name: string

`Beta`renderOrder

renderOrder: number

`Readonly` `Beta`sceneObject

sceneObject: Editor.Model.SceneObject

`Readonly` `Beta`type

type: string

The entity's type.

Methods

addFeature

addFeature(name): void
Beta
Parameters
- name: string
Returns void

clearFeatures

clearFeatures(): void
Beta
Returns void

getDirectlyReferencedEntities

getDirectlyReferencedEntities(): Entity[]
Beta
A list of entities which this entity has a reference to.

Returns Entity[]
Inherited from Visual.getDirectlyReferencedEntities

getFeatureNames

getFeatureNames(): string[]
Beta
Returns string[]

getFeaturePoints

getFeaturePoints(name): StretchPoint[]
Beta
Parameters
- name: string
Returns StretchPoint[]

getFeatureWeight

getFeatureWeight(name): number
Beta
Parameters
- name: string
Returns number

getOwnedEntities

getOwnedEntities(): Entity[]
Beta
A list of entities which has a reference to this entity.

Returns Entity[]
Inherited from Visual.getOwnedEntities

getTypeName

getTypeName(): string
Beta
Returns string
Inherited from Visual.getTypeName

isOfType

isOfType(type): boolean
Beta
Parameters
- type: string
Returns boolean
Inherited from Visual.isOfType

isSame

isSame(other): boolean
Beta
Parameters
- other: ScriptObject
Returns boolean
Inherited from Visual.isSame

remapReferences

remapReferences(referenceMapping): void
Beta
Swap this entity for another one based on a JSON of the current entity id and the target entity id.
Parameters
- referenceMapping: object
Returns void
Inherited from Visual.remapReferences

removeFeature

removeFeature(name): void
Beta
Parameters
- name: string
Returns void

setFeatureWeight

setFeatureWeight(name, weight): void
Beta
Parameters
- name: string
- weight: number
Returns void

updateFeaturePoints

updateFeaturePoints(name, points): void
Beta
Parameters
- name: string
- points: StretchPoint[]
Returns void