Skip to main content

Editor.Components.PinToMeshComponent

Class

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

Index

Example

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}`);

Extends

Properties

enabled

enabled: boolean

Whether the component is active.

Inherited from

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

Component.hasPrefabChanges


id

readonly id: Uuid

The unique id of the entity.

Inherited from

Component.id


isPrefabInstanceRoot

readonly isPrefabInstanceRoot: boolean

Whether this entity is the root of a prefab instance.

Inherited from

Component.isPrefabInstanceRoot


meta

readonly meta: Meta

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

Inherited from

Component.meta


name

name: string

Name of the component.

Inherited from

Component.name


offsetPosition

offsetPosition: vec3

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


offsetRotation

offsetRotation: vec3

Rotation offset applied to the pinned object.


orientation

orientation: Orientation

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


pinUV

pinUV: vec2

UV coordinates on the mesh where the object is pinned.


sceneObject

readonly sceneObject: SceneObject

Scene object this component is attached to.

Inherited from

Component.sceneObject


target

target: BaseMeshVisual

The mesh visual to pin the object to.


type

readonly type: string

The entity's type.

Inherited from

Component.type


useVertexNormal

useVertexNormal: boolean

Whether to use vertex normals for surface orientation calculation.

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

Component.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

Component.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

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

Component.getPrefabInstanceRoot


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

Component.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Component.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

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

Component.isSame