Editor.Components.PinToMeshComponent
ClassComponent that pins a SceneObject to a point on a mesh surface.
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('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
hasPrefabChanges
readonlyhasPrefabChanges: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
id
readonlyid:Uuid
The unique id of the entity.
Inherited from
isPrefabInstanceRoot
readonlyisPrefabInstanceRoot:boolean
Whether this entity is the root of a prefab instance.
Inherited from
Component.isPrefabInstanceRoot
meta
readonlymeta:Meta
Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.
Inherited from
name
name:
string
Name of the component.
Inherited from
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
readonlysceneObject:SceneObject
Scene object this component is attached to.
Inherited from
target
target:
BaseMeshVisual
The mesh visual to pin the object to.
type
readonlytype:string
The entity's type.
Inherited from
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()
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
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
Inherited from
Component.getPrefabInstanceRoot
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