Class AvatarModel

Represents an avatar model with head and hands references. Used for representing characters in 3D space.

Index

Constructors

Properties

head leftHand rigthHand root

Accessors

Constructors

constructor

new AvatarModel(
    root: Object3D,
    head: Object3D,
    leftHand: null | Object3D<Object3DEventMap>,
    rigthHand: null | Object3D<Object3DEventMap>,
): AvatarModel
Creates a new avatar model.
Parameters
- root: Object3D
  The root object of the avatar
- head: Object3D
  The head object of the avatar
- leftHand: null | Object3D<Object3DEventMap>
  The left hand object of the avatar
- rigthHand: null | Object3D<Object3DEventMap>
  The right hand object of the avatar
Returns AvatarModel

Properties

head

The head object of the avatar model

leftHand

leftHand: null | Object3D<Object3DEventMap>

The left hand object of the avatar model, if available

rigthHand

rigthHand: null | Object3D<Object3DEventMap>

The right hand object of the avatar model, if available

root

The root object of the avatar model

Accessors

isValid

get isValid(): boolean
Checks if the avatar model has a valid configuration. An avatar is considered valid if it has a head.

Returns boolean
Whether the avatar has a valid setup