Editor Scripting API
    Preparing search index...

    Class Head

    Component that attaches a scene object to a tracked head position.

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

        const obj = scene.createSceneObject('HeadAnchor');
        const head = obj.addComponent('Head') as Editor.Components.Head;

        head.faceIndex = 0;
        head.attachmentPoint = Editor.Components.HeadAttachmentPointType.HeadCenter;
        console.log(`Head: face=${head.faceIndex}, attachment=HeadCenter (${head.attachmentPoint})`);

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    attachedBarycentricVertex attachmentPoint enabled faceIndex id meta name sceneObject type

    Methods

    getDirectlyReferencedEntities getMeta getOwnedEntities getTypeName getTypeName isOfType isSame

    Constructors

    Properties

    attachedBarycentricVertex: BarycentricVertex

    Barycentric vertex coordinates for the head attachment position.

    attachmentPoint: HeadAttachmentPointType

    Part of the head this component attaches to.

    enabled: boolean

    Whether the component is active.

    faceIndex: number

    Index of the face mesh this head component is attached to.

    id: Uuid

    The unique id of the entity.

    meta: Meta

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

    name: string

    Name of the component.

    sceneObject: SceneObject

    Scene object this component is attached to.

    type: string

    The entity's type.

    Methods

    • Returns the name of this object's type.

      Returns string

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods