Skip to main content

Editor.Components.LiquifyVisual

Class

Visual component applying liquify distortion to face mesh geometry.

Index

Example

const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const scene = model.project.scene;

const obj = scene.createSceneObject('Liquify');
const lv = obj.addComponent('LiquifyVisual') as Editor.Components.LiquifyVisual;

lv.intensity = 0.5;
lv.radius = 0.3;
console.log(`LiquifyVisual: intensity=${lv.intensity}, radius=${lv.radius}`);

Extends

Properties

enabled

enabled: boolean

Whether the component is active.

Inherited from

BaseMeshVisual.enabled


hasPrefabChanges

readonly hasPrefabChanges: boolean

Whether this entity differs from its counterpart in the prefab or was added to the prefab instance. Always false outside prefab instances.

Inherited from

BaseMeshVisual.hasPrefabChanges


horizontalAlignment

horizontalAlignment: Horizontal

Horizontal alignment of the mesh visual.

Inherited from

BaseMeshVisual.horizontalAlignment


id

readonly id: Uuid

The unique id of the entity.

Inherited from

BaseMeshVisual.id


intensity

intensity: number

Strength of the liquify deformation effect.


isPrefabInstanceRoot

readonly isPrefabInstanceRoot: boolean

Whether this entity is the root of a prefab instance.

Inherited from

BaseMeshVisual.isPrefabInstanceRoot


meshShadowMode

meshShadowMode: MeshShadowMode

Shadow rendering mode for the mesh.

Inherited from

BaseMeshVisual.meshShadowMode


meta

readonly meta: Meta

Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

Inherited from

BaseMeshVisual.meta


name

name: string

Name of the component.

Inherited from

BaseMeshVisual.name


radius

radius: number

Size of the liquify brush area.


renderOrder

renderOrder: number

Determines the order in which this visual component is rendered relative to others.

Inherited from

BaseMeshVisual.renderOrder


sceneObject

readonly sceneObject: SceneObject

Scene object this component is attached to.

Inherited from

BaseMeshVisual.sceneObject


shadowColor

shadowColor: vec4

Color of the mesh shadow.

Inherited from

BaseMeshVisual.shadowColor


shadowDensity

shadowDensity: number

Opacity of the mesh shadow.

Inherited from

BaseMeshVisual.shadowDensity


stretchMode

stretchMode: StretchMode

How the mesh stretches to fit its container.

Inherited from

BaseMeshVisual.stretchMode


type

readonly type: string

The entity's type.

Inherited from

BaseMeshVisual.type


verticalAlignment

verticalAlignment: Vertical

Vertical alignment of the mesh visual.

Inherited from

BaseMeshVisual.verticalAlignment

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

A list of entities which this entity has a reference to.

Returns

Entity[]

Inherited from

BaseMeshVisual.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

BaseMeshVisual.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

A list of entities which has a reference to this entity.

Returns

Entity[]

Inherited from

BaseMeshVisual.getOwnedEntities


getPrefabInstanceRoot()

getPrefabInstanceRoot(): Prefabable

Returns the nearest prefab instance root that contains this entity, starting with the entity itself, or null if it is not part of a prefab instance.

Returns

Prefabable

Inherited from

BaseMeshVisual.getPrefabInstanceRoot


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

BaseMeshVisual.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

BaseMeshVisual.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

BaseMeshVisual.isOfType


isSame()

isSame(other): boolean

Returns true if this object refers to the same instance as the given object.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

BaseMeshVisual.isSame