Editor.Components.Physics.Shape
ClassBase class for physics shapes attached to entities.
Index
Properties
Methods
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
readonlyid:Uuid
The unique id of the entity.
Inherited from
meta
readonlymeta:Meta
Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.
Inherited from
type
readonlytype:string
The entity's type.
Inherited from
Methods
getDirectlyReferencedEntities()
getDirectlyReferencedEntities():
Entity[]
A list of entities which this entity has a reference to.
Returns
Entity[]
Inherited from
EntityStructure.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
EntityStructure.getOwnedEntities
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