Skip to main content

Editor.Components.Physics.Shape

Class

Base class for physics shapes attached to entities.

Index

Example

// Shape is the base class for all physics collider shapes.
// Create shapes via Editor.Shape factory methods, then assign to a ColliderComponent.
const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const scene = model.project.scene;

const obj = scene.createSceneObject('PhysicsObject');
obj.name = 'ShapeDemo';
const collider = obj.addComponent('ColliderComponent');

// Create different shapes and swap them on the same collider
const box = Editor.Shape.createBoxShape(scene);
box.size = new vec3(1, 1, 1);
collider.shape = box;
console.log(`Shape assigned: ${collider.shape.getTypeName()}`);

const sphere = Editor.Shape.createSphereShape(scene);
sphere.radius = 0.5;
collider.shape = sphere;
console.log(`Swapped to: ${collider.shape.getTypeName()}`);

Extends

Extended by

Properties

id

readonly id: Uuid

The unique id of the entity.

Inherited from

EntityStructure.id


meta

readonly meta: Meta

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

Inherited from

EntityStructure.meta


type

readonly type: string

The entity's type.

Inherited from

EntityStructure.type

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

EntityStructure.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

EntityStructure.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

EntityStructure.getOwnedEntities


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

EntityStructure.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

EntityStructure.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

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

EntityStructure.isSame