Class Html3D

HTML 要素を 3D 空間内の特定位置に表示するためのオブジェクトです。 CSS2DRenderer を使って、3D オブジェクトに追従する HTML ラベルやアイコンを表示できます。

Example

const label = document.createElement('div');
label.textContent = 'Hello!';
label.style.color = 'white';

const html3d = new Html3D(label);
scene.add(html3d);

Hierarchy (View Summary)

ObjectA3
- Html3D

Index

Constructors

constructor

new Html3D(element: HTMLElement): Html3D
Parameters
- element: HTMLElement
Returns Html3D
Overrides ObjectA3.constructor
- Defined in src/three/Html3D.ts:20

Properties

autoDirection

autoDirection: boolean = false

自動向き調整機能のON、OFF。デフォルトOFF。

children

children: ObjectA3[] = []

子オブジェクトの配列。ObjectA3.add() で追加されたオブジェクトが格納されます。

`Optional`clickListener

clickListener?: (o: ObjectA3) => void

setClickListener() で登録されたクリックリスナー関数。

object3D

object3D: Object3D

Three.js の内部オブジェクト（THREE.Object3D）です。通常は直接操作しません。

`Optional`parent

parent?: ObjectA3

親オブジェクト。ObjectA3.add() で追加された場合に設定されます。

`Optional`rotationOrder

rotationOrder?: RotationOrder

このオブジェクト固有の回転順番。undefined のとき ObjectA3.defaultRotationOrder が使われます。

`Optional`scene

scene?: Scene

このオブジェクトが追加されている Scene。追加前は undefined。

`Optional`upVector

upVector?: Vec3

このオブジェクト固有の上方向ベクトル。undefined のとき ObjectA3.defaultUpVector が使われます。

`Static`defaultRotationOrder

defaultRotationOrder: RotationOrder = "ZXY"

全 ObjectA3 に共通して使われるデフォルトの回転順番。初期値は "ZXY"。

`Static`defaultUpVector

defaultUpVector: Vec3 = ...

全 ObjectA3 に共通して使われるデフォルトの上方向ベクトル。初期値は (0, 1, 0)。

Methods

add

add(obj: ObjectA3): void
このオブジェクトに子オブジェクトを追加します。追加したオブジェクトはこのオブジェクトの座標系に従って動きます。
Parameters
- obj: ObjectA3
  追加する子オブジェクト
Returns void
Inherited from ObjectA3.add
- Defined in src/core/ObjectA3.ts:271

addForce

addForce(v: Vec3): void
このオブジェクトに力を加えます。物理演算系のモードでのみ有効です。
Parameters
- v: Vec3
  加える力
Returns void
Inherited from ObjectA3.addForce
- Defined in src/core/ObjectA3.ts:1255
addForce(x: number, y: number, z: number): void
このオブジェクトに力を加えます。物理演算系のモードでのみ有効です。
Parameters
- x: number
  x 成分
- y: number
  y 成分
- z: number
  z 成分
Returns void
Inherited from ObjectA3.addForce
- Defined in src/core/ObjectA3.ts:1263

addForceAtPoint

addForceAtPoint(f: Vec3, p: Vec3): void
力点を指定してこのオブジェクトに力を加えます。力点はワールド座標で指定します。物理演算系のモードでのみ有効です。
Parameters
- f: Vec3
  力（または力の x 成分）
- p: Vec3
  力点（または力の y 成分）
Returns void
Inherited from ObjectA3.addForceAtPoint
- Defined in src/core/ObjectA3.ts:1279
addForceAtPoint(
    fx: number,
    fy: number,
    fz: number,
    px: number,
    py: number,
    pz: number,
): void
力点を指定してこのオブジェクトに力を加えます。力点はワールド座標で指定します。物理演算系のモードでのみ有効です。
Parameters
- fx: number
- fy: number
- fz: number
- px: number
- py: number
- pz: number
Returns void
Inherited from ObjectA3.addForceAtPoint
- Defined in src/core/ObjectA3.ts:1280

addOneselfToPhysics

addOneselfToPhysics(world: PhysicsWorld): void
Parameters
- world: PhysicsWorld
Returns void
Inherited from ObjectA3.addOneselfToPhysics
- Defined in src/core/ObjectA3.ts:1407

addTorque

addTorque(v: Vec3): void
このオブジェクトにトルク（回転力）を加えます。物理演算系のモードでのみ有効です。
Parameters
- v: Vec3
  加えるトルク
Returns void
Inherited from ObjectA3.addTorque
- Defined in src/core/ObjectA3.ts:1314
addTorque(x: number, y: number, z: number): void
このオブジェクトにトルク（回転力）を加えます。物理演算系のモードでのみ有効です。
Parameters
- x: number
  x 成分
- y: number
  y 成分
- z: number
  z 成分
Returns void
Inherited from ObjectA3.addTorque
- Defined in src/core/ObjectA3.ts:1322

applyImpulse

applyImpulse(v: Vec3): void
このオブジェクトにインパルス（瞬間的な力）を加えます。物理演算系のモードでのみ有効です。
Parameters
- v: Vec3
  加えるインパルス
Returns void
Inherited from ObjectA3.applyImpulse
- Defined in src/core/ObjectA3.ts:1337
applyImpulse(x: number, y: number, z: number): void
このオブジェクトにインパルス（瞬間的な力）を加えます。物理演算系のモードでのみ有効です。
Parameters
- x: number
  x 成分
- y: number
  y 成分
- z: number
  z 成分
Returns void
Inherited from ObjectA3.applyImpulse
- Defined in src/core/ObjectA3.ts:1345

applyImpulseAtPoint

applyImpulseAtPoint(i: Vec3, p: Vec3): void
力点を指定してこのオブジェクトにインパルスを加えます。力点はワールド座標で指定します。物理演算系のモードでのみ有効です。
Parameters
- i: Vec3
  インパルス（または x 成分）
- p: Vec3
  力点（または y 成分）
Returns void
Inherited from ObjectA3.applyImpulseAtPoint
- Defined in src/core/ObjectA3.ts:1361
applyImpulseAtPoint(
    ix: number,
    iy: number,
    iz: number,
    px: number,
    py: number,
    pz: number,
): void
力点を指定してこのオブジェクトにインパルスを加えます。力点はワールド座標で指定します。物理演算系のモードでのみ有効です。
Parameters
- ix: number
- iy: number
- iz: number
- px: number
- py: number
- pz: number
Returns void
Inherited from ObjectA3.applyImpulseAtPoint
- Defined in src/core/ObjectA3.ts:1362

applyTorqueImpulse

applyTorqueImpulse(v: Vec3): void
このオブジェクトにトルクインパルス（瞬間的なトルク）を加えます。物理演算系のモードでのみ有効です。
Parameters
- v: Vec3
  加えるトルクインパルス
Returns void
Inherited from ObjectA3.applyTorqueImpulse
- Defined in src/core/ObjectA3.ts:1389
applyTorqueImpulse(x: number, y: number, z: number): void
このオブジェクトにトルクインパルス（瞬間的なトルク）を加えます。物理演算系のモードでのみ有効です。
Parameters
- x: number
  x 成分
- y: number
  y 成分
- z: number
  z 成分
Returns void
Inherited from ObjectA3.applyTorqueImpulse
- Defined in src/core/ObjectA3.ts:1397

clicked

clicked(): Promise<void>
Returns Promise<void>
Inherited from ObjectA3.clicked
- Defined in src/core/ObjectA3.ts:327

getAngularVelocity

getAngularVelocity(v?: Vec3): Vec3
このオブジェクトの角速度を返します（単位：ラジアン/秒）。物理演算系のモードでのみ有効な値が返ります。
Parameters
- Optionalv: Vec3
  値を書き込む Vec3（省略時は新しい Vec3 を返します）
Returns Vec3
角速度
Inherited from ObjectA3.getAngularVelocity
- Defined in src/core/ObjectA3.ts:1239

getLinearVelocity

getLinearVelocity(v?: Vec3): Vec3
このオブジェクトの線速度を返します。物理演算系のモードでのみ有効な値が返ります。
Parameters
- Optionalv: Vec3
  値を書き込む Vec3（省略時は新しい Vec3 を返します）
Returns Vec3
線速度
Inherited from ObjectA3.getLinearVelocity
- Defined in src/core/ObjectA3.ts:1207

getPosition

getPosition(out?: Vec3): Vec3
このオブジェクトの現在の位置を返します。
Parameters
- Optionalout: Vec3
  値を書き込む Vec3（省略時は新しい Vec3 を返します）
Returns Vec3
現在の位置
Inherited from ObjectA3.getPosition
- Defined in src/core/ObjectA3.ts:402

getQuat

getQuat(out?: Quat): Quat
このオブジェクトの現在の回転をクォータニオンで返します。
Parameters
- Optionalout: Quat
  値を書き込む Quat（省略時は新しい Quat を返します）
Returns Quat
現在の回転（クォータニオン）
Inherited from ObjectA3.getQuat
- Defined in src/core/ObjectA3.ts:455

getScale

getScale(out?: Vec3): Vec3
このオブジェクトの現在の拡大率を返します。
Parameters
- Optionalout: Vec3
  値を書き込む Vec3（省略時は新しい Vec3 を返します）
Returns Vec3
現在の拡大率（x, y, z 各軸）
Inherited from ObjectA3.getScale
- Defined in src/core/ObjectA3.ts:507

getTransformer

getTransformer(): Transformer
このオブジェクトに現在設定されている Transformer を返します。

Returns Transformer
現在の Transformer
Inherited from ObjectA3.getTransformer
- Defined in src/core/ObjectA3.ts:195

getUnitVecX

getUnitVecX(out?: Vec3): Vec3
このオブジェクトのローカル X 軸方向の単位ベクトルを返します。
Parameters
- Optionalout: Vec3
  値を書き込む Vec3（省略時は新しい Vec3 を返します）
Returns Vec3
ローカル X 軸の単位ベクトル（ワールド座標）
Inherited from ObjectA3.getUnitVecX
- Defined in src/core/ObjectA3.ts:672

getUnitVecY

getUnitVecY(out?: Vec3): Vec3
このオブジェクトのローカル Y 軸方向の単位ベクトルを返します。
Parameters
- Optionalout: Vec3
  値を書き込む Vec3（省略時は新しい Vec3 を返します）
Returns Vec3
ローカル Y 軸の単位ベクトル（ワールド座標）
Inherited from ObjectA3.getUnitVecY
- Defined in src/core/ObjectA3.ts:681

getUnitVecZ

getUnitVecZ(out?: Vec3): Vec3
このオブジェクトのローカル Z 軸方向の単位ベクトルを返します。
Parameters
- Optionalout: Vec3
  値を書き込む Vec3（省略時は新しい Vec3 を返します）
Returns Vec3
ローカル Z 軸の単位ベクトル（ワールド座標）
Inherited from ObjectA3.getUnitVecZ
- Defined in src/core/ObjectA3.ts:690

handleCollision

handleCollision(
    obj: ObjectA3,
    started: boolean,
    myPartNo: number,
    yourPartNo: number,
): void
物理エンジンにより衝突が検知されたときに呼び出されるコールバックメソッドです。衝突イベントを受け取るには、サブクラスでオーバーライドしてください。また、PhysicsMotionOptions.collisionDetection を true に設定する必要があります。
Parameters
- obj: ObjectA3
  衝突相手の ObjectA3
- started: boolean
  衝突開始のとき true、衝突終了のとき false
- myPartNo: number
  このオブジェクトの、ぶつかったパーツのコライダー番号
- yourPartNo: number
  相手オブジェクトの、ぶつかったパーツのコライダー番号
Returns void
Inherited from ObjectA3.handleCollision
- Defined in src/core/ObjectA3.ts:323

initObject

initObject(element: HTMLElement): CSS2DObject
このオブジェクトの Three.js メッシュなどを生成して返すメソッドです。サブクラスでオーバーライドして、独自の形状を返してください。非同期処理が必要な場合はとりあえず a3jsLoading.clone() を返しておき、読み込み完了後に差し替えてください。
Parameters
- element: HTMLElement
Returns CSS2DObject
Three.js の Object3D（メッシュ・グループ等）
Overrides ObjectA3.initObject
- Defined in src/three/Html3D.ts:31

initTransformer

initTransformer(_data?: any): Transformer
コンストラクタから呼び出され、デフォルトで使用される Transformer を返すメソッドです。サブクラスでオーバーライドすることでデフォルトの動作モードを変更できます。
Parameters
- Optional_data: any
  コンストラクタから渡された情報
Returns Transformer
このオブジェクトで使用する Transformer
Inherited from ObjectA3.initTransformer
- Defined in src/core/ObjectA3.ts:176

isGrounded

isGrounded(): boolean
このオブジェクトが地面に接地しているかどうかを返します。 "KinematicCharacter" や "DynamicCharacter" モードでは他のオブジェクトとの衝突を考慮した正確な判定を行います。それ以外のモードでは、Y 座標が 0 以下のとき接地していると判定します。

Returns boolean
接地しているとき true
Inherited from ObjectA3.isGrounded
- Defined in src/core/ObjectA3.ts:1422

lookAt

lookAt(x: number, y: number, z: number): void
このオブジェクトを、指定した位置・オブジェクトの方向に向けます。 "Smooth" モードの場合はなめらかに補間されます。すぐに反映させたい場合は lookAtNow() を使ってください。
Parameters
- x: number
  向く先の x 座標（または Vec3 / ObjectA3）
- y: number
  向く先の y 座標
- z: number
  向く先の z 座標
Returns void
Remarks
物理演算系のモードでは機能しません。
Inherited from ObjectA3.lookAt
- Defined in src/core/ObjectA3.ts:626
lookAt(v: Vec3): void
このオブジェクトを、指定した位置・オブジェクトの方向に向けます。 "Smooth" モードの場合はなめらかに補間されます。すぐに反映させたい場合は lookAtNow() を使ってください。
Parameters
- v: Vec3
Returns void
Remarks
物理演算系のモードでは機能しません。
Inherited from ObjectA3.lookAt
- Defined in src/core/ObjectA3.ts:627
lookAt(o: ObjectA3): void
このオブジェクトを、指定した位置・オブジェクトの方向に向けます。 "Smooth" モードの場合はなめらかに補間されます。すぐに反映させたい場合は lookAtNow() を使ってください。
Parameters
- o: ObjectA3
Returns void
Remarks
物理演算系のモードでは機能しません。
Inherited from ObjectA3.lookAt
- Defined in src/core/ObjectA3.ts:628

lookAtNow

lookAtNow(x: number, y: number, z: number): void
このオブジェクトを、指定した位置・オブジェクトの方向に即座に向けます。 "Smooth" モードのなめらかな補間を無視してすぐに反映します。物理演算系のモードでも強制的に反映されます。
Parameters
- x: number
  向く先の x 座標（または Vec3 / ObjectA3）
- y: number
  向く先の y 座標
- z: number
  向く先の z 座標
Returns void
Inherited from ObjectA3.lookAtNow
- Defined in src/core/ObjectA3.ts:651
lookAtNow(v: Vec3): void
このオブジェクトを、指定した位置・オブジェクトの方向に即座に向けます。 "Smooth" モードのなめらかな補間を無視してすぐに反映します。物理演算系のモードでも強制的に反映されます。
Parameters
- v: Vec3
Returns void
Inherited from ObjectA3.lookAtNow
- Defined in src/core/ObjectA3.ts:652
lookAtNow(o: ObjectA3): void
このオブジェクトを、指定した位置・オブジェクトの方向に即座に向けます。 "Smooth" モードのなめらかな補間を無視してすぐに反映します。物理演算系のモードでも強制的に反映されます。
Parameters
- o: ObjectA3
Returns void
Inherited from ObjectA3.lookAtNow
- Defined in src/core/ObjectA3.ts:653

moveBackward

moveBackward(b: number): void
このオブジェクトをローカル Z 軸の負方向（後方）へ移動します。 "Smooth" モードの場合はなめらかに補間されます。
Parameters
- b: number
  移動距離
Returns void
Inherited from ObjectA3.moveBackward
- Defined in src/core/ObjectA3.ts:977

moveBackwardNow

moveBackwardNow(b: number): void
このオブジェクトをローカル Z 軸の負方向（後方）へ即座に移動します。
Parameters
- b: number
  移動距離
Returns void
Inherited from ObjectA3.moveBackwardNow
- Defined in src/core/ObjectA3.ts:987

moveDown

moveDown(d: number): void
このオブジェクトをローカル Y 軸の負方向（下方向）へ移動します。 "Smooth" モードの場合はなめらかに補間されます。
Parameters
- d: number
  移動距離
Returns void
Inherited from ObjectA3.moveDown
- Defined in src/core/ObjectA3.ts:1061

moveDownNow

moveDownNow(d: number): void
このオブジェクトをローカル Y 軸の負方向（下方向）へ即座に移動します。
Parameters
- d: number
  移動距離
Returns void
Inherited from ObjectA3.moveDownNow
- Defined in src/core/ObjectA3.ts:1071

moveForward

moveForward(f: number): void
このオブジェクトをローカル Z 軸の正方向（前方）へ移動します。 "Smooth" モードの場合はなめらかに補間されます。
Parameters
- f: number
  移動距離
Returns void
Inherited from ObjectA3.moveForward
- Defined in src/core/ObjectA3.ts:956

moveForwardNow

moveForwardNow(f: number): void
このオブジェクトをローカル Z 軸の正方向（前方）へ即座に移動します。
Parameters
- f: number
  移動距離
Returns void
Inherited from ObjectA3.moveForwardNow
- Defined in src/core/ObjectA3.ts:966

moveLeft

moveLeft(l: number): void
このオブジェクトをローカル X 軸の正方向（左方向）へ移動します。 "Smooth" モードの場合はなめらかに補間されます。
Parameters
- l: number
  移動距離
Returns void
Inherited from ObjectA3.moveLeft
- Defined in src/core/ObjectA3.ts:1019

moveLeftNow

moveLeftNow(l: number): void
このオブジェクトをローカル X 軸の正方向（左方向）へ即座に移動します。
Parameters
- l: number
  移動距離
Returns void
Inherited from ObjectA3.moveLeftNow
- Defined in src/core/ObjectA3.ts:1029

moveRight

moveRight(r: number): void
このオブジェクトをローカル X 軸の負方向（右方向）へ移動します。 "Smooth" モードの場合はなめらかに補間されます。
Parameters
- r: number
  移動距離
Returns void
Inherited from ObjectA3.moveRight
- Defined in src/core/ObjectA3.ts:998

moveRightNow

moveRightNow(r: number): void
このオブジェクトをローカル X 軸の負方向（右方向）へ即座に移動します。
Parameters
- r: number
  移動距離
Returns void
Inherited from ObjectA3.moveRightNow
- Defined in src/core/ObjectA3.ts:1008

moveUp

moveUp(u: number): void
このオブジェクトをローカル Y 軸の正方向（上方向）へ移動します。 "Smooth" モードの場合はなめらかに補間されます。
Parameters
- u: number
  移動距離
Returns void
Inherited from ObjectA3.moveUp
- Defined in src/core/ObjectA3.ts:1040

moveUpNow

moveUpNow(u: number): void
このオブジェクトをローカル Y 軸の正方向（上方向）へ即座に移動します。
Parameters
- u: number
  移動距離
Returns void
Inherited from ObjectA3.moveUpNow
- Defined in src/core/ObjectA3.ts:1050

mulQuat

mulQuat(q: Quat): void
このオブジェクトの回転に、指定したクォータニオンを右から掛け合わせます。 "Smooth" モードの場合はなめらかに補間されます。
Parameters
- q: Quat
  掛け合わせるクォータニオン
Returns void
Remarks
物理演算系のモードでは機能しません。
Inherited from ObjectA3.mulQuat
- Defined in src/core/ObjectA3.ts:764
mulQuat(x: number, y: number, z: number, w: number): void
このオブジェクトの回転に、指定したクォータニオンを右から掛け合わせます。 "Smooth" モードの場合はなめらかに補間されます。
Parameters
- x: number
  x 成分
- y: number
  y 成分
- z: number
  z 成分
- w: number
  w 成分
Returns void
Remarks
物理演算系のモードでは機能しません。
Inherited from ObjectA3.mulQuat
- Defined in src/core/ObjectA3.ts:777

mulQuatNow

mulQuatNow(q: Quat): void
このオブジェクトの回転に、指定したクォータニオンを即座に右から掛け合わせます。 "Smooth" モードのなめらかな補間を無視してすぐに反映します。物理演算系のモードでも強制的に反映されます。
Parameters
- q: Quat
  掛け合わせるクォータニオン
Returns void
Inherited from ObjectA3.mulQuatNow
- Defined in src/core/ObjectA3.ts:794
mulQuatNow(x: number, y: number, z: number, w: number): void
このオブジェクトの回転に、指定したクォータニオンを即座に右から掛け合わせます。 "Smooth" モードのなめらかな補間を無視してすぐに反映します。物理演算系のモードでも強制的に反映されます。
Parameters
- x: number
  x 成分
- y: number
  y 成分
- z: number
  z 成分
- w: number
  w 成分
Returns void
Inherited from ObjectA3.mulQuatNow
- Defined in src/core/ObjectA3.ts:805

mulRotation

mulRotation(v: Vec3): void
このオブジェクトの現在の回転に、オイラー角（度数法）で回転を追加します。単位はラジアンではなくデグリーです（360 で 1 回転）。 "Smooth" モードの場合はなめらかに補間されます。
Parameters
- v: Vec3
  各軸の追加回転量（度）を表すベクトル
Returns void
Remarks
物理演算系のモードでは機能しません。
Inherited from ObjectA3.mulRotation
- Defined in src/core/ObjectA3.ts:825
mulRotation(x: number, y: number, z: number): void
このオブジェクトの現在の回転に、オイラー角（度数法）で回転を追加します。単位はラジアンではなくデグリーです（360 で 1 回転）。 "Smooth" モードの場合はなめらかに補間されます。
Parameters
- x: number
  x 軸の追加回転量（度）
- y: number
  y 軸の追加回転量（度）
- z: number
  z 軸の追加回転量（度）
Returns void
Remarks
物理演算系のモードでは機能しません。
Inherited from ObjectA3.mulRotation
- Defined in src/core/ObjectA3.ts:838

mulRotationNow

mulRotationNow(v: Vec3): void
このオブジェクトの現在の回転に、オイラー角（度数法）で回転を即座に追加します。単位はラジアンではなくデグリーです（360 で 1 回転）。 "Smooth" モードのなめらかな補間を無視してすぐに反映します。物理演算系のモードでも強制的に反映されます。
Parameters
- v: Vec3
  各軸の追加回転量（度）を表すベクトル
Returns void
Inherited from ObjectA3.mulRotationNow
- Defined in src/core/ObjectA3.ts:860
mulRotationNow(x: number, y: number, z: number): void
このオブジェクトの現在の回転に、オイラー角（度数法）で回転を即座に追加します。単位はラジアンではなくデグリーです（360 で 1 回転）。 "Smooth" モードのなめらかな補間を無視してすぐに反映します。物理演算系のモードでも強制的に反映されます。
Parameters
- x: number
  x 軸の追加回転量（度）
- y: number
  y 軸の追加回転量（度）
- z: number
  z 軸の追加回転量（度）
Returns void
Inherited from ObjectA3.mulRotationNow
- Defined in src/core/ObjectA3.ts:871

mulScaleNow

mulScaleNow(v: Vec3): void
このオブジェクトの現在の拡大率に、指定した値を即座に乗算します。 "Smooth" モードのなめらかな補間を無視してすぐに反映します。
Parameters
- v: Vec3
  各軸の乗数を表すベクトル
Returns void
Remarks
"SimplePhysics"・"KinematicCharacter"・"DynamicCharacter" など物理演算系のモードでは、このメソッドは機能しません。物理モードでの拡大率の変更はサポートされていません。
Inherited from ObjectA3.mulScaleNow
- Defined in src/core/ObjectA3.ts:927
mulScaleNow(x: number, y: number, z: number): void
このオブジェクトの現在の拡大率に、指定した値を即座に乗算します。 "Smooth" モードのなめらかな補間を無視してすぐに反映します。
Parameters
- x: number
  x 軸の乗数
- y: number
  y 軸の乗数
- z: number
  z 軸の乗数
Returns void
Remarks
"SimplePhysics"・"KinematicCharacter"・"DynamicCharacter" など物理演算系のモードでは、このメソッドは機能しません。物理モードでの拡大率の変更はサポートされていません。
Inherited from ObjectA3.mulScaleNow
- Defined in src/core/ObjectA3.ts:941

remove

remove(obj: ObjectA3): void
このオブジェクトから子オブジェクトを取り除きます。
Parameters
- obj: ObjectA3
  取り除く子オブジェクト
Returns void
Inherited from ObjectA3.remove
- Defined in src/core/ObjectA3.ts:284

removeOneselfFromPhysics

removeOneselfFromPhysics(world: PhysicsWorld): void
Parameters
- world: PhysicsWorld
Returns void
Inherited from ObjectA3.removeOneselfFromPhysics
- Defined in src/core/ObjectA3.ts:1411

resetForce

resetForce(): void
このオブジェクトに加えられている力をリセットします。物理演算系のモードでのみ有効です。

Returns void
Inherited from ObjectA3.resetForce
- Defined in src/core/ObjectA3.ts:1247

resetTorque

resetTorque(): void
このオブジェクトに加えられているトルクをリセットします。物理演算系のモードでのみ有効です。

Returns void
Inherited from ObjectA3.resetTorque
- Defined in src/core/ObjectA3.ts:1306

rollLeft

rollLeft(l: number): void
このオブジェクトを左方向にロール回転させます（Z 軸回りに反時計回り）。 "Smooth" モードの場合はなめらかに補間されます。
Parameters
- l: number
  回転量（度）
Returns void
Inherited from ObjectA3.rollLeft
- Defined in src/core/ObjectA3.ts:1167

rollLeftNow

rollLeftNow(l: number): void
このオブジェクトを左方向に即座にロール回転させます（Z 軸回りに反時計回り）。
Parameters
- l: number
  回転量（度）
Returns void
Inherited from ObjectA3.rollLeftNow
- Defined in src/core/ObjectA3.ts:1175

rollRight

rollRight(r: number): void
このオブジェクトを右方向にロール回転させます（Z 軸回りに時計回り）。 "Smooth" モードの場合はなめらかに補間されます。
Parameters
- r: number
  回転量（度）
Returns void
Inherited from ObjectA3.rollRight
- Defined in src/core/ObjectA3.ts:1150

rollRightNow

rollRightNow(r: number): void
このオブジェクトを右方向に即座にロール回転させます（Z 軸回りに時計回り）。
Parameters
- r: number
  回転量（度）
Returns void
Inherited from ObjectA3.rollRightNow
- Defined in src/core/ObjectA3.ts:1158

scaleBy

scaleBy(v: Vec3): void
このオブジェクトの現在の拡大率に、指定した値を乗算します。 "Smooth" モードの場合はなめらかに補間されます。
Parameters
- v: Vec3
  各軸の乗数を表すベクトル
Returns void
Remarks
物理演算系のモードでは機能しません（mulScaleNow() も同様）。
Inherited from ObjectA3.scaleBy
- Defined in src/core/ObjectA3.ts:894
scaleBy(x: number, y: number, z: number): void
このオブジェクトの現在の拡大率に、指定した値を乗算します。 "Smooth" モードの場合はなめらかに補間されます。
Parameters
- x: number
  x 軸の乗数
- y: number
  y 軸の乗数
- z: number
  z 軸の乗数
Returns void
Remarks
物理演算系のモードでは機能しません（mulScaleNow() も同様）。
Inherited from ObjectA3.scaleBy
- Defined in src/core/ObjectA3.ts:906

setAngularVelocity

setAngularVelocity(v: Vec3): void
このオブジェクトの角速度を設定します（単位：ラジアン/秒）。物理演算系のモードでのみ有効です。
Parameters
- v: Vec3
  設定する角速度
Returns void
Inherited from ObjectA3.setAngularVelocity
- Defined in src/core/ObjectA3.ts:1216
setAngularVelocity(x: number, y: number, z: number): void
このオブジェクトの角速度を設定します（単位：ラジアン/秒）。物理演算系のモードでのみ有効です。
Parameters
- x: number
  x 成分
- y: number
  y 成分
- z: number
  z 成分
Returns void
Inherited from ObjectA3.setAngularVelocity
- Defined in src/core/ObjectA3.ts:1224

setCastShadow

setCastShadow(value: boolean): void
このオブジェクトが影を落すかどうかを設定します。
Parameters
- value: boolean
  trueの時は影を落す。falseの時は影を落さない。
Returns void
Inherited from ObjectA3.setCastShadow
- Defined in src/core/ObjectA3.ts:336

setClickListener

setClickListener(func: (o: ObjectA3) => void): void
このオブジェクトがクリックされたときに呼ばれる関数を登録します。登録できるリスナーは1つだけです。2回目の呼び出しで上書きされます。
Parameters
- func: (o: ObjectA3) => void
  クリック時に呼ばれる関数。引数にクリックされた ObjectA3 が渡されます。
Returns void
Inherited from ObjectA3.setClickListener
- Defined in src/core/ObjectA3.ts:310

setLightShadow

setLightShadow(value: boolean, options: Partial<SetLightShadowOptions>): void
このオブジェクトの中に含まれるLightが影を作るかどうかを設定します。
Parameters
- value: boolean
  trueの時は作る。falseの時は作らない。
- options: Partial<SetLightShadowOptions>
  影を作るために必要なカメラやシャドウマップの解像度の情報。
Returns void
Inherited from ObjectA3.setLightShadow
- Defined in src/core/ObjectA3.ts:361

setLinearVelocity

setLinearVelocity(v: Vec3): void
このオブジェクトの線速度を設定します。物理演算系のモードでのみ有効です。
Parameters
- v: Vec3
  設定する線速度
Returns void
Inherited from ObjectA3.setLinearVelocity
- Defined in src/core/ObjectA3.ts:1184
setLinearVelocity(x: number, y: number, z: number): void
このオブジェクトの線速度を設定します。物理演算系のモードでのみ有効です。
Parameters
- x: number
  x 成分
- y: number
  y 成分
- z: number
  z 成分
Returns void
Inherited from ObjectA3.setLinearVelocity
- Defined in src/core/ObjectA3.ts:1192

setMode

setMode(mode: TransformMode, options?: any): void

このオブジェクトの制御モード（TransformMode）を設定します。モードに応じた Transformer が自動的に適用されます。

モード	使用される Transformer
`"Default"`	`DefaultTransformer`
`"Smooth"`	`SmoothTransformer`
`"Follow"`	`FollowTransformer`
`"Billboard"`	`BillboardTransformer`
`"SmoothBillboard"`	`SmoothBillboardTransformer`
`"SimplePhysics"`	`RapierTransformer`
`"KinematicCharacter"`	`KinematicCharacterTransformer`
`"DynamicCharacter"`	`DynamicCharacterTransformer`

options の詳細は各 Transformer クラスのオプション型を参照してください。

Parameters

mode: TransformMode
設定するモード
Optionaloptions: any
モードによっては追加のオプションが必要です

Returns void

setPosition

setPosition(x: number, y: number, z: number): void
このオブジェクトの目標位置を設定します。 "Smooth" モードの場合はなめらかに補間されます。すぐに移動させたい場合は setPositionNow() を使ってください。
Parameters
- x: number
  x 座標（または Vec3）
- y: number
  y 座標
- z: number
  z 座標
Returns void
Remarks
"SimplePhysics"・"KinematicCharacter"・"DynamicCharacter" など物理演算系のモードでは、このメソッドは機能しません。物理モードで位置を強制変更するには setPositionNow() を使ってください。
Inherited from ObjectA3.setPosition
- Defined in src/core/ObjectA3.ts:420
setPosition(v: Vec3): void
このオブジェクトの目標位置を設定します。 "Smooth" モードの場合はなめらかに補間されます。すぐに移動させたい場合は setPositionNow() を使ってください。
Parameters
- v: Vec3
Returns void
Remarks
"SimplePhysics"・"KinematicCharacter"・"DynamicCharacter" など物理演算系のモードでは、このメソッドは機能しません。物理モードで位置を強制変更するには setPositionNow() を使ってください。
Inherited from ObjectA3.setPosition
- Defined in src/core/ObjectA3.ts:421

setPositionNow

setPositionNow(x: number, y: number, z: number): void
このオブジェクトの位置を即座に設定します。 "Smooth" モードのなめらかな補間を無視してすぐに移動します。物理演算系のモードでも位置を強制的に変更します。
Parameters
- x: number
  x 座標（または Vec3）
- y: number
  y 座標
- z: number
  z 座標
Returns void
Inherited from ObjectA3.setPositionNow
- Defined in src/core/ObjectA3.ts:439
setPositionNow(v: Vec3): void
このオブジェクトの位置を即座に設定します。 "Smooth" モードのなめらかな補間を無視してすぐに移動します。物理演算系のモードでも位置を強制的に変更します。
Parameters
- v: Vec3
Returns void
Inherited from ObjectA3.setPositionNow
- Defined in src/core/ObjectA3.ts:440

setQuat

setQuat(x: number, y: number, z: number, w: number): void
このオブジェクトの目標回転をクォータニオンで設定します。 "Smooth" モードの場合はなめらかに補間されます。すぐに反映させたい場合は setQuatNow() を使ってください。
Parameters
- x: number
  x 成分（または Quat）
- y: number
  y 成分
- z: number
  z 成分
- w: number
  w 成分
Returns void
Remarks
物理演算系のモードでは機能しません。物理モードで回転を強制変更するには setQuatNow() を使ってください。
Inherited from ObjectA3.setQuat
- Defined in src/core/ObjectA3.ts:472
setQuat(q: Quat): void
このオブジェクトの目標回転をクォータニオンで設定します。 "Smooth" モードの場合はなめらかに補間されます。すぐに反映させたい場合は setQuatNow() を使ってください。
Parameters
- q: Quat
Returns void
Remarks
物理演算系のモードでは機能しません。物理モードで回転を強制変更するには setQuatNow() を使ってください。
Inherited from ObjectA3.setQuat
- Defined in src/core/ObjectA3.ts:473

setQuatNow

setQuatNow(x: number, y: number, z: number, w: number): void
このオブジェクトの回転をクォータニオンで即座に設定します。物理演算系のモードでも強制的に反映されます。
Parameters
- x: number
  x 成分（または Quat）
- y: number
  y 成分
- z: number
  z 成分
- w: number
  w 成分
Returns void
Inherited from ObjectA3.setQuatNow
- Defined in src/core/ObjectA3.ts:491
setQuatNow(q: Quat): void
このオブジェクトの回転をクォータニオンで即座に設定します。物理演算系のモードでも強制的に反映されます。
Parameters
- q: Quat
Returns void
Inherited from ObjectA3.setQuatNow
- Defined in src/core/ObjectA3.ts:492

setReceiveShadow

setReceiveShadow(value: boolean): void
このオブジェクトが影を描画するかどうかを設定します。
Parameters
- value: boolean
  trueの時は描画する。falseの時は描画しない。
Returns void
Inherited from ObjectA3.setReceiveShadow
- Defined in src/core/ObjectA3.ts:348

setRotation

setRotation(x: number, y: number, z: number): void
このオブジェクトの目標回転をオイラー角（度数法）で設定します。単位はラジアンではなくデグリーです（360 で 1 回転）。 "Smooth" モードの場合はなめらかに補間されます。すぐに反映させたい場合は setRotationNow() を使ってください。

回転の適用順は rotationOrder プロパティ（未設定時は ObjectA3.defaultRotationOrder）に従います。
Parameters
- x: number
  x 軸の回転量（度）（または Vec3）
- y: number
  y 軸の回転量（度）
- z: number
  z 軸の回転量（度）
Returns void
Remarks
物理演算系のモードでは機能しません。物理モードで回転を強制変更するには setRotationNow() を使ってください。
Inherited from ObjectA3.setRotation
- Defined in src/core/ObjectA3.ts:576
setRotation(v: Vec3): void
このオブジェクトの目標回転をオイラー角（度数法）で設定します。単位はラジアンではなくデグリーです（360 で 1 回転）。 "Smooth" モードの場合はなめらかに補間されます。すぐに反映させたい場合は setRotationNow() を使ってください。

回転の適用順は rotationOrder プロパティ（未設定時は ObjectA3.defaultRotationOrder）に従います。
Parameters
- v: Vec3
Returns void
Remarks
物理演算系のモードでは機能しません。物理モードで回転を強制変更するには setRotationNow() を使ってください。
Inherited from ObjectA3.setRotation
- Defined in src/core/ObjectA3.ts:577

setRotationNow

setRotationNow(x: number, y: number, z: number): void
このオブジェクトの回転をオイラー角（度数法）で即座に設定します。単位はラジアンではなくデグリーです（360 で 1 回転）。 "Smooth" モードのなめらかな補間を無視してすぐに反映します。物理演算系のモードでも強制的に反映されます。

回転の適用順は rotationOrder プロパティ（未設定時は ObjectA3.defaultRotationOrder）に従います。
Parameters
- x: number
  x 軸の回転量（度）（または Vec3）
- y: number
  y 軸の回転量（度）
- z: number
  z 軸の回転量（度）
Returns void
Inherited from ObjectA3.setRotationNow
- Defined in src/core/ObjectA3.ts:601
setRotationNow(v: Vec3): void
このオブジェクトの回転をオイラー角（度数法）で即座に設定します。単位はラジアンではなくデグリーです（360 で 1 回転）。 "Smooth" モードのなめらかな補間を無視してすぐに反映します。物理演算系のモードでも強制的に反映されます。

回転の適用順は rotationOrder プロパティ（未設定時は ObjectA3.defaultRotationOrder）に従います。
Parameters
- v: Vec3
Returns void
Inherited from ObjectA3.setRotationNow
- Defined in src/core/ObjectA3.ts:602

setScale

setScale(x: number, y: number, z: number): void
このオブジェクトの目標拡大率を設定します。 "Smooth" モードの場合はなめらかに補間されます。すぐに反映させたい場合は setScaleNow() を使ってください。
Parameters
- x: number
  x 軸の拡大率（または Vec3）
- y: number
  y 軸の拡大率
- z: number
  z 軸の拡大率
Returns void
Remarks
"SimplePhysics"・"KinematicCharacter"・"DynamicCharacter" など物理演算系のモードでは、このメソッドは機能しません（setScaleNow() も同様）。物理モードでの拡大率の変更はサポートされていません。
Inherited from ObjectA3.setScale
- Defined in src/core/ObjectA3.ts:525
setScale(v: Vec3): void
このオブジェクトの目標拡大率を設定します。 "Smooth" モードの場合はなめらかに補間されます。すぐに反映させたい場合は setScaleNow() を使ってください。
Parameters
- v: Vec3
Returns void
Remarks
"SimplePhysics"・"KinematicCharacter"・"DynamicCharacter" など物理演算系のモードでは、このメソッドは機能しません（setScaleNow() も同様）。物理モードでの拡大率の変更はサポートされていません。
Inherited from ObjectA3.setScale
- Defined in src/core/ObjectA3.ts:526

setScaleNow

setScaleNow(x: number, y: number, z: number): void
このオブジェクトの拡大率を即座に設定します。 "Smooth" モードのなめらかな補間を無視してすぐに反映します。
Parameters
- x: number
  x 軸の拡大率（または Vec3）
- y: number
  y 軸の拡大率
- z: number
  z 軸の拡大率
Returns void
Remarks
"SimplePhysics"・"KinematicCharacter"・"DynamicCharacter" など物理演算系のモードでは、このメソッドは機能しません。物理モードでの拡大率の変更はサポートされていません。
Inherited from ObjectA3.setScaleNow
- Defined in src/core/ObjectA3.ts:549
setScaleNow(v: Vec3): void
このオブジェクトの拡大率を即座に設定します。 "Smooth" モードのなめらかな補間を無視してすぐに反映します。
Parameters
- v: Vec3
Returns void
Remarks
"SimplePhysics"・"KinematicCharacter"・"DynamicCharacter" など物理演算系のモードでは、このメソッドは機能しません。物理モードでの拡大率の変更はサポートされていません。
Inherited from ObjectA3.setScaleNow
- Defined in src/core/ObjectA3.ts:550

setSpeechBubble

setSpeechBubble(message: string): void
このオブジェクトに吹き出しを表示します。
Parameters
- message: string
  吹き出しに表示するメッセージ
Returns void
Remarks
現在未実装です。
Inherited from ObjectA3.setSpeechBubble
- Defined in src/core/ObjectA3.ts:298

setTransformer

setTransformer(transformer: Transformer): void
このオブジェクトに使用する Transformer を変更します。現在の位置・回転・拡大率を引き継いで新しい Transformer に切り替えます。
Parameters
- transformer: Transformer
  新しい Transformer
Returns void
Inherited from ObjectA3.setTransformer
- Defined in src/core/ObjectA3.ts:185

translate

translate(v: Vec3): void
このオブジェクトの位置を、指定した量だけ移動します（ワールド座標）。現在位置に加算されます。 "Smooth" モードの場合はなめらかに補間されます。
Parameters
- v: Vec3
  移動の方向を表すベクトル（Vec3）
Returns void
Remarks
物理演算系のモードでは機能しません。
Inherited from ObjectA3.translate
- Defined in src/core/ObjectA3.ts:705
translate(x: number, y: number, z: number): void
このオブジェクトの位置を、指定した量だけ移動します（ワールド座標）。現在位置に加算されます。 "Smooth" モードの場合はなめらかに補間されます。
Parameters
- x: number
  x 方向の移動量
- y: number
  y 方向の移動量
- z: number
  z 方向の移動量
Returns void
Remarks
物理演算系のモードでは機能しません。
Inherited from ObjectA3.translate
- Defined in src/core/ObjectA3.ts:718

translateNow

translateNow(v: Vec3): void
このオブジェクトの位置を、指定した量だけ即座に移動します（ワールド座標）。 "Smooth" モードのなめらかな補間を無視してすぐに反映します。物理演算系のモードでも強制的に反映されます。
Parameters
- v: Vec3
  移動量を表すベクトル
Returns void
Inherited from ObjectA3.translateNow
- Defined in src/core/ObjectA3.ts:735
translateNow(x: number, y: number, z: number): void
このオブジェクトの位置を、指定した量だけ即座に移動します（ワールド座標）。 "Smooth" モードのなめらかな補間を無視してすぐに反映します。物理演算系のモードでも強制的に反映されます。
Parameters
- x: number
  x 方向の移動量
- y: number
  y 方向の移動量
- z: number
  z 方向の移動量
Returns void
Inherited from ObjectA3.translateNow
- Defined in src/core/ObjectA3.ts:745

turnDown

turnDown(d: number): void
このオブジェクトを下向きに回転させます（X 軸回りに俯角方向）。 "Smooth" モードの場合はなめらかに補間されます。
Parameters
- d: number
  回転量（度）
Returns void
Inherited from ObjectA3.turnDown
- Defined in src/core/ObjectA3.ts:1099

turnDownNow

turnDownNow(d: number): void
このオブジェクトを下向きに即座に回転させます（X 軸回りに俯角方向）。
Parameters
- d: number
  回転量（度）
Returns void
Inherited from ObjectA3.turnDownNow
- Defined in src/core/ObjectA3.ts:1107

turnLeft

turnLeft(l: number): void
このオブジェクトを左向きに回転させます（Y 軸回りに左旋回）。 "Smooth" モードの場合はなめらかに補間されます。
Parameters
- l: number
  回転量（度）
Returns void
Inherited from ObjectA3.turnLeft
- Defined in src/core/ObjectA3.ts:1133

turnLeftNow

turnLeftNow(l: number): void
このオブジェクトを左向きに即座に回転させます（Y 軸回りに左旋回）。
Parameters
- l: number
  回転量（度）
Returns void
Inherited from ObjectA3.turnLeftNow
- Defined in src/core/ObjectA3.ts:1141

turnRight

turnRight(r: number): void
このオブジェクトを右向きに回転させます（Y 軸回りに右旋回）。 "Smooth" モードの場合はなめらかに補間されます。
Parameters
- r: number
  回転量（度）
Returns void
Inherited from ObjectA3.turnRight
- Defined in src/core/ObjectA3.ts:1116

turnRightNow

turnRightNow(r: number): void
このオブジェクトを右向きに即座に回転させます（Y 軸回りに右旋回）。
Parameters
- r: number
  回転量（度）
Returns void
Inherited from ObjectA3.turnRightNow
- Defined in src/core/ObjectA3.ts:1124

turnUp

turnUp(u: number): void
このオブジェクトを上向きに回転させます（X 軸回りに仰角方向）。 "Smooth" モードの場合はなめらかに補間されます。
Parameters
- u: number
  回転量（度）
Returns void
Inherited from ObjectA3.turnUp
- Defined in src/core/ObjectA3.ts:1082

turnUpNow

turnUpNow(u: number): void
このオブジェクトを上向きに即座に回転させます（X 軸回りに仰角方向）。
Parameters
- u: number
  回転量（度）
Returns void
Inherited from ObjectA3.turnUpNow
- Defined in src/core/ObjectA3.ts:1090

update

update(dt: number): void
Parameters
- dt: number
Returns void
Inherited from ObjectA3.update
- Defined in src/core/ObjectA3.ts:239

Class Html3D

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Html3D

Properties

autoDirection

children

OptionalclickListener

object3D

Optionalparent

OptionalrotationOrder

Optionalscene

OptionalupVector

StaticdefaultRotationOrder

StaticdefaultUpVector

Methods

add

Parameters

Returns void

addForce

Parameters

Returns void

Parameters

Returns void

addForceAtPoint

Parameters

Returns void

Parameters

Returns void

addOneselfToPhysics

Parameters

Returns void

addTorque

Parameters

Returns void

Parameters

Returns void

applyImpulse

Parameters

Returns void

Parameters

Returns void

applyImpulseAtPoint

Parameters

Returns void

Parameters

Returns void

applyTorqueImpulse

Parameters

Returns void

Parameters

Returns void

clicked

Returns Promise<void>

getAngularVelocity

Parameters

Returns Vec3

getLinearVelocity

Parameters

Returns Vec3

getPosition

Parameters

Returns Vec3

getQuat

Parameters

Returns Quat

getScale

Parameters

Returns Vec3

getTransformer

Returns Transformer

getUnitVecX

Parameters

`Optional`clickListener

`Optional`parent

`Optional`rotationOrder

`Optional`scene

`Optional`upVector

`Static`defaultRotationOrder

`Static`defaultUpVector