BaseItem | CoSpaces API

BaseItem is the base class for all 3D Scene content.

Every BaseItem provides methods and properties that allow you to

Edit Color
Edit BaseItem.thought and BaseItem.speech
Edit Transform for positioning and rotation
Edit BaseItem.physics properties

Hierarchy

BaseItem

Index

Constructors

constructor

new BaseItem(): BaseItem

Returns BaseItem

Properties

active

active: boolean

Defines this item's active state.

If false, this item

Is not visible
Ignores (physics-) collisions
Ignores tracing, e.g. from RayCast and Input
Does not use physics

Readonly animated

animated: boolean

Returns true if this item has animation tracks.

Readonly center

center: Vector3

Returns the center point of this item.

returns: center of this item in world space.

Readonly children

children: ItemCollection

Returns all first-level hierarchy children of this item.

Note: This does not return a complete children Transform hierarchy.

See BaseItem.parent

color

color: Color

Defines color of this item.

To change opacity, use BaseItem.opacity.

Readonly id

id: string

The unique id of this item.

If several items share the same name, this item can still be found by its id.

See Scene.getItem

See BaseItem.name

Readonly input

input: { onButtonDown: any; onButtonUp: any; onClick: any; onHover: any; setCollisionDrag: any; setItemDrag: any }

Type declaration

onButtonDown:function
- onButtonDown(handler: (() => void)): void
- - Defined in api.ts:1105
  Triggers whenever the main input is pressed down inside of this item.
  
  Calling this function on an existing handler overwrites the handler.
  
  Parameters
  - handler: (() => void)
    
    function to call on press down. Pass null to remove the handler.
    - - (): void
      - Returns void
  Returns void
onButtonUp:function
- onButtonUp(handler: (() => void)): void
- - Defined in api.ts:1114
  Triggers whenever the main input is released inside of this item.
  
  Calling this function on an existing handler overwrites the handler.
  
  Parameters
  - handler: (() => void)
    
    function to call on release. Pass null to remove the handler.
    - - (): void
      - Returns void
  Returns void
onClick:function
- onClick(handler: (() => void)): void
- - Defined in api.ts:1123
  Triggers whenever the main input is pressed and released inside of this item.
  
  Calling this function on an existing click handler overwrites the handler.
  
  Parameters
  - handler: (() => void)
    
    function to call after click. Pass null to remove the handler.
    - - (): void
      - Returns void
  Returns void
onHover:function
- onHover(handler: ((t: boolean) => void)): void
- - Defined in api.ts:1132
  Triggers whenever the item is hovered.
  
  Calling this function on existing hover handler overwrites the handler.
  
  Parameters
  - handler: ((t: boolean) => void)
    
    method to call on hover event. Uses boolean property to determine start and end of hover event. Pass null to remove the handler.
    - - (t: boolean): void
      - Parameters
        t: boolean
        Returns void
  Returns void
setCollisionDrag:function
- setCollisionDrag(): void
- setCollisionDrag(callback: (() => void)): void
- - Defined in api.ts:1138
  Creates a drag interaction on this item to another item, allowing this item to be moved on the surface of other items.
  
  Returns void
- - Defined in api.ts:1146
  Creates a drag interaction on this item to another item, allowing this item to be moved on the surface of other items.
  
  Parameters
  - callback: (() => void)
    
    function to call when the drag interaction ends
    - - (): void
      - Returns void
  Returns void
setItemDrag:function
- setItemDrag(target: BaseItem): void
- setItemDrag(target: BaseItem, callback: (() => void)): void
- - Defined in api.ts:1153
  Creates a drag interaction which causes this item to be draggable on the target.
  
  Parameters
  - target: BaseItem
    
    item to use as drag surface.
  Returns void
- - Defined in api.ts:1162
  Creates a drag interaction which causes this item to be draggable on the target.
  
  Parameters
  - target: BaseItem
    
    item to use as drag surface.
  - callback: (() => void)
    
    function to call when the drag interaction ends.
    - - (): void
      - Returns void
  Returns void

name

name: string

Name of this item displayed in their name tag and in the item hierarchy.

See Scene.getItem

See BaseItem.id

nameVisible

nameVisible: boolean

Toggles visibility of the item name tag.

See BaseItem.name

opacity

opacity: number

Normalized opacity of this item.

Note: Items with opacity below 0.3 ignore inputs, e.g. from BaseItem.input.

Readonly parent

parent: BaseItem

Returns the parent of this item.

See BaseItem.add

See BaseItem.removeFromParent

Readonly physics

physics: { angularVelocity: Vector3; angularVelocityLocal: Vector3; enabled: boolean; force: Vector3; friction: number; group: { velocityLocal: Vector3 }; mass: number; position: Vector3; restitution: number; softness: number; static: boolean; velocity: Vector3; velocityLocal: Vector3; addToCollisionFilter: any; applyForce: any; applyImpulse: any; applyImpulseLocal: any; onCollisionEnter: any; onCollisionExit: any; removeFromCollisionFilter: any; restrictMovementAxis: any; restrictRotationAxis: any; shiftPosition: any; shiftPositionLocal: any }

Type declaration

angularVelocity: Vector3

Returns world space angularVelocity of this item.

returns
angular velocity in world space.
angularVelocityLocal: Vector3

Returns local space angularVelocity of this item.

returns
angular velocity in world space.

See BaseItem.parent
enabled: boolean

Toggles this item to be simulated with physics.

returns
physics simulation state.
force: Vector3

Defines directional force that is applied on this item each frame.

returns
item force in world space.
friction: number
Defines the friction of this item during movement
- Value of 0 resembles ice
- Value of 1 resembles a surface with high friction, e.g. car tyre.
returns
item friction.
Readonly group: { velocityLocal: Vector3 }
- velocityLocal: Vector3
  
  Returns the world space velocity of the group's center of mass.
  
  returns
  velocity in world space.
mass: number

Defines the mass of this item. Items with higher mass more easily push away items with lower mass.

returns
item mass.
position: Vector3

Returns the world space position of the center of mass for this item.

returns
center of mass.
restitution: number
Defines this item's restitution (bounciness).
- Restitution of 0 does not cause item to bounce
- Restitution of 1 causes item to bounce at no loss of energy
returns
item restitution.
softness: number

Defines the velocity threshold at which this item is allowed to be repulsed by collisions.

High values make this item feel soft, low values make it feel solid.

returns
item softness.
static: boolean

Defines static state of this item. Static items have indefinite mass and can not be moved by physics forces.

returns
static state.
velocity: Vector3

Returns the world space velocity of the item's center of mass.

returns
velocity in world space.
velocityLocal: Vector3

Returns the local space velocity of the item's center of mass.

returns
velocity in local space.

See BaseItem.parent
addToCollisionFilter:function
- addToCollisionFilter(item: BaseItem): void
- - Defined in api.ts:1461
  Adds collision filter to target item to ignore collisions, even when this item shares the same collision layer.
  
  Parameters
  - item: BaseItem
    
    item to add to collision filter
  Returns void
applyForce:function
- applyForce(force: Vector3): void
- - Defined in api.ts:1495
  Applies constant directional force to this item each frame.
  
  Parameters
  - force: Vector3
    
    world space force to apply.
  Returns void
applyImpulse:function
- applyImpulse(origin: Vector3, impulse: Vector3): void
- - Defined in api.ts:1479
  Pushes this item with the defined impulse for this frame.
  
  Parameters
  - origin: Vector3
    
    origin of the impulse in world space.
  - impulse: Vector3
    
    direction & force of the impulse.
  Returns void
applyImpulseLocal:function
- applyImpulseLocal(localOrigin: Vector3, impulse: Vector3): void
- - Defined in api.ts:1488
  Pushes this item with the defined impulse relative to its forward direction for this frame.
  
  Parameters
  - localOrigin: Vector3
    
    origin of the impulse relative to item forward direction.
  - impulse: Vector3
    
    direction & force of the impulse.
  Returns void
onCollisionEnter:function
- onCollisionEnter(handler: ((t: BaseItem) => void)): void
- - Defined in api.ts:1511
  Handles the start of a physics collision between this item and another item.
  
  To remove the handler, pass null for handler.
  
  Parameters
  - handler: ((t: BaseItem) => void)
    
    passes BaseItem which this item collides against.
    - - (t: BaseItem): void
      - Parameters
        t: BaseItem
        Returns void
  Returns void
onCollisionExit:function
- onCollisionExit(handler: ((t: BaseItem) => void)): void
- - Defined in api.ts:1520
  Handles the end of a physics collision between this item and another item.
  
  To remove the handler, pass null for handler.
  
  Parameters
  - handler: ((t: BaseItem) => void)
    
    passes item which this item collided against.
    - - (t: BaseItem): void
      - Parameters
        t: BaseItem
        Returns void
  Returns void
removeFromCollisionFilter:function
- removeFromCollisionFilter(item: BaseItem): void
- - Defined in api.ts:1468
  Removes collision filter from the target item.
  
  Parameters
  - item: BaseItem
    
    item to remove from collision filter
  Returns void
restrictMovementAxis:function
- restrictMovementAxis(axes: { x?: boolean; y?: boolean; z?: boolean }): void
- - Defined in api.ts:1428
  Restricts this item's movement on the defined axes.
  
  Parameters
  - axes: { x?: boolean; y?: boolean; z?: boolean }
    
    axes to restrict movement on.
    - Optional Readonly x?: boolean
    - Optional Readonly y?: boolean
    - Optional Readonly z?: boolean
  Returns void
restrictRotationAxis:function
- restrictRotationAxis(axes: { x?: boolean; y?: boolean; z?: boolean }): void
- - Defined in api.ts:1441
  Restricts this item's rotation to the defined rotation axes
  
  Parameters
  - axes: { x?: boolean; y?: boolean; z?: boolean }
    
    axes to restrict movement one.
    - Optional Readonly x?: boolean
    - Optional Readonly y?: boolean
    - Optional Readonly z?: boolean
  Returns void
shiftPosition:function
- shiftPosition(shift: Vector3): void
- - Defined in api.ts:1333
  Moves this item by an offset from its current position.
  
  Parameters
  - shift: Vector3
    
    offset from current position in world space.
  Returns void
shiftPositionLocal:function
- shiftPositionLocal(offset: Vector3): void
- - Defined in api.ts:1347
  Moves this item by an offset relative to its forward direction.
  
  Parameters
  - offset: Vector3
    
    offset relative to forward direction.
  Returns void

Readonly relativeTransform

relativeTransform: Transform

The relative Transform of this item in local space.

The local space is determined by this item's BaseItem.parent.

See BaseItem.transform

speech

speech: string | number

Defines the text in the speech-bubble of this item.

thought

thought: string | number

Defines the text in the thought-bubble of this item.

Readonly transform

transform: Transform

The Transform of this item in world space.

See BaseItem.relativeTransform

Readonly transition

transition: { moveBy: any; moveOnPath: any; moveTo: any; rotateLocal: any; stop: any }

Type declaration

moveBy:function
- moveBy(target: Vector3, duration: number): Tweener
- moveBy(target: Vector3, duration: number, callback: (() => void)): Tweener
- - Defined in api.ts:1199
  Moves this item from its current position by local offset vector.
  
  Parameters
  - target: Vector3
    
    relative offset to apply.
  - duration: number
    
    time in seconds.
  Returns Tweener
  created Tweener.
- - Defined in api.ts:1212
  Moves this item from its current position by local offset vector.
  
  Parameters
  - target: Vector3
    
    relative offset to apply.
  - duration: number
    
    time in seconds.
  - callback: (() => void)
    
    function to call when the target is reached.
    - - (): void
      - Returns void
  Returns Tweener
  created Tweener.
moveOnPath:function
- moveOnPath(options: { endPoint?: number; path: PathItem; repeat?: boolean; reverse?: boolean; speed?: number; startPoint?: number; time?: number; turnWithPath?: boolean; callback?: any }): Tweener
- - Defined in api.ts:1236
  Moves this item on a PathItem.
  Example
```
//moves an item indefinitely on a PathItem
const myItem = Scene.getItem("myItem")
const myPath = Scene.getItem("myPath") as PathItem

myItem.transition.moveOnPath({
    path: myPath,
    speed: 1.5,
    turnWithPath: true,
    repeat: true
})
```
  Parameters
  - options: { endPoint?: number; path: PathItem; repeat?: boolean; reverse?: boolean; speed?: number; startPoint?: number; time?: number; turnWithPath?: boolean; callback?: any }
    
    path movement options.
    - Optional Readonly endPoint?: number
    - Readonly path: PathItem
    - Optional Readonly repeat?: boolean
    - Optional Readonly reverse?: boolean
    - Optional Readonly speed?: number
    - Optional Readonly startPoint?: number
    - Optional Readonly time?: number
    - Optional Readonly turnWithPath?: boolean
      
      For closed paths
    - callback?:function
      - callback(): void
      - Defined in api.ts:1256
        Returns void
  Returns Tweener
  created Tweener.
moveTo:function
- moveTo(target: Vector3, duration: number): Tweener
- moveTo(target: Vector3, duration: number, callback: (() => void)): Tweener
- - Defined in api.ts:1175
  Moves this item to the target point over duration.
  
  Parameters
  - target: Vector3
    
    point in world space.
  - duration: number
    
    time in seconds.
  Returns Tweener
  created Tweener.
- - Defined in api.ts:1188
  Moves this item to the target point over duration.
  
  Parameters
  - target: Vector3
    
    point in world space.
  - duration: number
    
    time in seconds.
  - callback: (() => void)
    
    function to call when the target is reached.
    - - (): void
      - Returns void
  Returns Tweener
  created Tweener.
rotateLocal:function
- rotateLocal(axis: Vector3, angleInRadians: number, duration: number): Tweener
- rotateLocal(axis: Vector3, angleInRadians: number, duration: number, callback: (() => void)): Tweener
- rotateLocal(offset: Vector3, axis: Vector3, angleInRadians: number, duration: number): Tweener
- rotateLocal(offset: Vector3, axis: Vector3, angleInRadians: number, duration: number, callback: (() => void)): Tweener
- - Defined in api.ts:1270
  Rotates this item by angleInRadians towards axis direction over duration.
  
  Parameters
  - axis: Vector3
    
    vector defining the local rotation axis.
  - angleInRadians: number
    
    rotation in radians.
  - duration: number
    
    time in seconds.
  Returns Tweener
  created Tweener
- - Defined in api.ts:1285
  Rotates this item by angleInRadians towards axis direction over duration.
  
  Parameters
  - axis: Vector3
    
    vector defining the local rotation axis.
  - angleInRadians: number
    
    rotation in radians.
  - duration: number
    
    time in seconds.
  - callback: (() => void)
    
    function to call when the Tweener ends.
    - - (): void
      - Returns void
  Returns Tweener
  created Tweener
- - Defined in api.ts:1300
  Rotates this item by angleInRadians around an offset towards axis direction over duration.
  
  Parameters
  - offset: Vector3
    
    offset relative to current position.
  - axis: Vector3
    
    vector defining the local rotation axis.
  - angleInRadians: number
    
    rotation in radians.
  - duration: number
    
    time in seconds.
  Returns Tweener
  created Tweener
- - Defined in api.ts:1317
  Rotates this item by angleInRadians around an offset towards axis direction over duration.
  
  Parameters
  - offset: Vector3
    
    offset relative to current position.
  - axis: Vector3
    
    vector defining the local rotation axis.
  - angleInRadians: number
    
    rotation in radians.
  - duration: number
    
    time in seconds.
  - callback: (() => void)
    
    function to call when the Tweener ends.
    - - (): void
      - Returns void
  Returns Tweener
  created Tweener
stop:function
- stop(): void
- - Defined in api.ts:1324
  Stops all Tweener on this item.
  
  See Tweener
  
  Returns void

visible

visible: boolean

deprecated: replaced with BaseItem.active ()}

Methods

add

add(obj: BaseItem): void

- Defined in api.ts:968
Adds a child to this item.

Children inherit BaseItem.transform settings from their parent.

Parameters
- obj: BaseItem
  
  item to add to the list of children.
  
  See BaseItem.parent
  
  See BaseItem.children
Returns void

copy

copy(): BaseItem

- Defined in api.ts:1004
Creates a copy of this item.

All properties except those made with BaseItem.setProperty are copied.

Returns BaseItem

delete

delete(): void

- Defined in api.ts:910
Irreversibly removes this item from the Scene.

Note: This method does not update previously existing item references.

Returns void

deleteChildren

deleteChildren(): void

- Defined in api.ts:975
Deletes all children of this item.

See BaseItem.removeFromParent

Returns void

getProperty

getProperty(key: string): string

- Defined in api.ts:1027
Gets a custom property from this object. Returns null if the property can not be found.

Parameters
- key: string
  
  name of property to search.
Returns string

getSlot

getSlot(name: string): Slot

- Defined in api.ts:1070
Returns Slot by name.

Parameters
- name: string
  
  name of slot to find.
Returns Slot

onCollisionEnter

onCollisionEnter(handler: ((t: BaseItem) => void)): void

- Defined in api.ts:926
Handles the start of a collision between this item and another item.

To remove the handler, pass null for handler.

Parameters
- handler: ((t: BaseItem) => void)
  
  passes BaseItem which this item collides against.
  - - (t: BaseItem): void
    - Parameters
      - t: BaseItem
      Returns void
Returns void

onCollisionExit

onCollisionExit(handler: ((t: BaseItem) => void)): void

- Defined in api.ts:935
Handles the end of a collision between this item and another item.

Calling this function on an existing collision handler overwrites the handler.

Parameters
- handler: ((t: BaseItem) => void)
  
  passes item which this item collided against.
  - - (t: BaseItem): void
    - Parameters
      - t: BaseItem
      Returns void
Returns void

onPropertyChanged

onPropertyChanged(id: string, handler: ((t: string) => void)): void

- Defined in api.ts:1036
Handles property value changes in this object.

Parameters
- id: string
  
  property to listen to.
- handler: ((t: string) => void)
  
  function that's called when property value is changed.
  - - (t: string): void
    - Parameters
      - t: string
      Returns void
Returns void

removeFromParent

removeFromParent(): void

- Defined in api.ts:947
Removes this item from its parent-item, disconnecting all inherited Transform settings.

See BaseItem.parent

See BaseItem.add

See BaseItem.deleteChildren

Returns void

setProperty

setProperty(key: string, value: any): void

- Defined in api.ts:1020
Sets a custom property to this object.

Properties are saved as strings.

Parameters
- key: string
  
  property name.
- value: any
  
  property value.
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BaseItem

Properties

active

Readonly animated

Readonly center

Readonly children

color

Readonly id

Readonly input

Type declaration

onButtonDown:function

Parameters

handler: (() => void)

Returns void

Returns void

onButtonUp:function

Parameters

handler: (() => void)

Returns void

Returns void

onClick:function

Parameters

handler: (() => void)

Returns void

Returns void

onHover:function

Parameters

handler: ((t: boolean) => void)

Parameters

t: boolean

Returns void

Returns void

setCollisionDrag:function

Returns void

Parameters

callback: (() => void)

Returns void

Returns void

setItemDrag:function

Parameters

target: BaseItem

Returns void

Parameters

target: BaseItem

callback: (() => void)

Returns void

Returns void

name

nameVisible

opacity

Readonly parent

Readonly physics

Type declaration

angularVelocity: Vector3

angularVelocityLocal: Vector3

enabled: boolean

force: Vector3

friction: number

Readonly group: { velocityLocal: Vector3 }

velocityLocal: Vector3

mass: number

position: Vector3

restitution: number

softness: number

static: boolean

velocity: Vector3

velocityLocal: Vector3

addToCollisionFilter:function

Parameters

item: BaseItem

Returns void

applyForce:function

Parameters