Skip to main content

Editor.Components.DropshadowSettings

Class

Drop shadow settings for text rendering.

Index

Example

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

// Create a Text component and configure its drop shadow
const obj = scene.createSceneObject('ShadowText');
const text = obj.addComponent('Text') as Editor.Components.Text;
text.text = 'Drop Shadow';

const shadow = text.dropshadowSettings;
shadow.enabled = true;
shadow.offset = new vec2(2, -2);
console.log(`Dropshadow: enabled=${shadow.enabled}, offset=(${shadow.offset.x}, ${shadow.offset.y})`);

Extends

Properties

enabled

enabled: boolean

Whether the drop shadow effect is active.


fill

fill: TextFill

Color and transparency of the drop shadow.


id

readonly id: Uuid

The unique id of the entity.

Inherited from

EntityStructure.id


meta

readonly meta: Meta

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

Inherited from

EntityStructure.meta


offset

offset: vec2

Horizontal and vertical offset of the shadow from the text.


type

readonly type: string

The entity's type.

Inherited from

EntityStructure.type

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

EntityStructure.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

EntityStructure.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

EntityStructure.getOwnedEntities


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

EntityStructure.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

EntityStructure.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

EntityStructure.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

EntityStructure.isSame