Skip to main content

Editor.Components.Physics.Cylinder

Class

Cylindrical physics shape with configurable axis, length, and radius.

Index

Example

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

// Create a scene object with a cylinder collider
const obj = scene.createSceneObject('PhysicsObject');
obj.name = 'CylinderColliderObject';
const collider = obj.addComponent('ColliderComponent');

// Create a cylinder shape and configure it
const cylinder = Editor.Shape.createCylinderShape(scene);
cylinder.radius = 0.75;
cylinder.length = 2.5;
cylinder.axis = Editor.Axis.Z;
collider.shape = cylinder;

console.log(`Created cylinder collider on: ${obj.name}`);
console.log(` radius: ${cylinder.radius}, length: ${cylinder.length}, axis: Z`);

Extends

Properties

axis

axis: Axis

The axis along which the cylinder is oriented.


id

readonly id: Uuid

The unique id of the entity.

Inherited from

Shape.id


length

length: number

The height of the cylinder along its axis.


meta

readonly meta: Meta

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

Inherited from

Shape.meta


radius

radius: number

The radius of the cylinder's circular cross-section.


type

readonly type: string

The entity's type.

Inherited from

Shape.type

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

Shape.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

Shape.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

Shape.getOwnedEntities


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

Shape.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Shape.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

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

Shape.isSame