Editor Scripting API
    Preparing search index...

    Class PinToMeshComponent

    Component that pins a SceneObject to a point on a mesh surface.

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

        const obj = scene.createSceneObject('PinnedObj');
        const pin = obj.addComponent('PinToMeshComponent') as Editor.Components.PinToMeshComponent;

        pin.pinUV = new vec2(0.5, 0.5);
        pin.offsetPosition = new vec3(0, 0.1, 0);
        pin.offsetRotation = new vec3(0, 0, 0);
        console.log(`PinToMeshComponent: pinUV=${pin.pinUV}, offsetPosition=${pin.offsetPosition}`);

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    enabled id meta name offsetPosition offsetRotation orientation pinUV sceneObject target type useVertexNormal

    Methods

    getDirectlyReferencedEntities getMeta getOwnedEntities getTypeName getTypeName isOfType isSame

    Constructors

    Properties

    enabled: boolean

    Whether the component is active.

    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.

    offsetPosition: vec3

    Position offset applied to the pinned object relative to the mesh surface.

    offsetRotation: vec3

    Rotation offset applied to the pinned object.

    orientation: Editor.Components.PinToMesh.Orientation

    How the pinned object's orientation aligns to the mesh surface.

    pinUV: vec2

    UV coordinates on the mesh where the object is pinned.

    sceneObject: SceneObject

    Scene object this component is attached to.

    target: BaseMeshVisual

    The mesh visual to pin the object to.

    type: string

    The entity's type.

    useVertexNormal: boolean

    Whether to use vertex normals for surface orientation calculation.

    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