Skip to main content

Editor.Components.ManipulateComponent

Class

Enables drag, rotate, and scale interactions on a scene object.

Index

Example

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

const obj = scene.createSceneObject('Manipulable');
const mc = obj.addComponent('ManipulateComponent') as Editor.Components.ManipulateComponent;

mc.drag = true;
mc.rotate = true;
mc.scale = true;
mc.minScale = 0.5;
mc.maxScale = 3.0;
mc.minDistance = 10;
mc.maxDistance = 200;
console.log(`Manipulate: drag=${mc.drag}, rotate=${mc.rotate}, scale=${mc.scale}`);
console.log(` scale: [${mc.minScale}, ${mc.maxScale}], distance: [${mc.minDistance}, ${mc.maxDistance}]`);

Extends

Properties

drag

drag: boolean

Whether dragging is enabled.


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


maxDistance

maxDistance: number

Maximum distance objects can be dragged.


maxScale

maxScale: number

Maximum allowed scale factor.


meta

readonly meta: Meta

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

Inherited from

Component.meta


minDistance

minDistance: number

Minimum distance objects can be dragged.


minScale

minScale: number

Minimum allowed scale factor.


name

name: string

Name of the component.

Inherited from

Component.name


rotate

rotate: boolean

Whether rotation is enabled.


scale

scale: boolean

Whether scaling is enabled.


sceneObject

readonly sceneObject: SceneObject

Scene object this component is attached to.

Inherited from

Component.sceneObject


type

readonly type: string

The entity's type.

Inherited from

Component.type

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