Editor.Components.TextFill
ClassConfigures fill properties for text rendering.
Index
Properties
Methods
Example
const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const scene = model.project.scene;
const obj = scene.createSceneObject('TextFillObj');
const text = obj.addComponent('Text') as Editor.Components.Text;
text.text = 'Filled Text';
const fill = text.textFill;
fill.mode = Editor.Components.TextFillMode.Solid;
fill.color = new vec4(0, 0.5, 1, 1);
console.log(`TextFill: mode=${fill.mode}, color=${fill.color}`);
Extends
Properties
color
color:
vec4
RGBA color applied to the text.
id
readonlyid:Uuid
The unique id of the entity.
Inherited from
meta
readonlymeta:Meta
Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.
Inherited from
mode
mode:
TextFillMode
Determines whether to use solid color or texture fill.
texture
texture:
Texture
Texture used when mode is set to texture fill.
textureStretch
textureStretch:
StretchMode
Controls how the texture scales to fit the text bounds.
tileCount
tileCount:
number
Number of times the texture tiles across the text.
tileZone
tileZone:
TextFillTileZone
Defines the region of the texture to use for tiling.
type
readonlytype:string
The entity's type.
Inherited from
Methods
getDirectlyReferencedEntities()
getDirectlyReferencedEntities():
Entity[]
A list of entities which this entity has a reference to.
Returns
Entity[]
Inherited from
EntityStructure.getDirectlyReferencedEntities
getMeta()
staticgetMeta():Meta
Returns metadata about this type.
Returns
Overrides
getOwnedEntities()
getOwnedEntities():
Entity[]
A list of entities which has a reference to this entity.
Returns
Entity[]
Inherited from
EntityStructure.getOwnedEntities
getTypeName()
staticgetTypeName():string
Returns the type name of this class.
Returns
string
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object is of the specified type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object refers to the same instance as the given object.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean