소스 검색

Typodoc fixes

Borut 6 년 전
부모
커밋
62c22004e0
4개의 변경된 파일7개의 추가작업 그리고 1개의 파일을 삭제
  1. 1 0
      src/Physics/Plugins/ammoJSPlugin.ts
  2. 1 0
      src/Physics/Plugins/cannonJSPlugin.ts
  3. 1 0
      src/Physics/Plugins/oimoJSPlugin.ts
  4. 4 1
      src/Physics/physicsRaycastResult.ts

+ 1 - 0
src/Physics/Plugins/ammoJSPlugin.ts

@@ -795,6 +795,7 @@ export class AmmoJSPlugin implements IPhysicsEnginePlugin {
     /**
      * @param from when should the ray start?
      * @param to when should the ray end?
+     * @returns the raycast result
      */
     public raycast(from: Vector3, to: Vector3): PhysicsRaycastResult {
         this._tmpAmmoVectorRCA = new this.bjsAMMO.btVector3(from.x, from.y, from.z);

+ 1 - 0
src/Physics/Plugins/cannonJSPlugin.ts

@@ -683,6 +683,7 @@ export class CannonJSPlugin implements IPhysicsEnginePlugin {
     /**
      * @param from when should the ray start?
      * @param to when should the ray end?
+     * @returns the raycast result
      */
     public raycast(from: Vector3, to: Vector3): PhysicsRaycastResult {
         this._cannonRaycastResult.reset();

+ 1 - 0
src/Physics/Plugins/oimoJSPlugin.ts

@@ -481,6 +481,7 @@ export class OimoJSPlugin implements IPhysicsEnginePlugin {
     /**
      * @param from when should the ray start?
      * @param to when should the ray end?
+     * @returns the raycast result
      */
     public raycast(from: Vector3, to: Vector3): PhysicsRaycastResult {
         Logger.Warn("raycast is not currently supported by the Oimo physics plugin");

+ 4 - 1
src/Physics/physicsRaycastResult.ts

@@ -57,6 +57,7 @@ export class PhysicsRaycastResult {
     }
 
     /**
+     * Sets the hit data (normal & point in world space)
      * @param hitNormalWorld
      * @param hitPointWorld
      */
@@ -67,6 +68,7 @@ export class PhysicsRaycastResult {
     }
 
     /**
+     * Sets the distance from the start point to the hit point
      * @param distance
      */
     public setHitDistance(distance: number) {
@@ -74,13 +76,14 @@ export class PhysicsRaycastResult {
     }
 
     /**
-     * Calculates the distance
+     * Calculates the distance manually
      */
     public calculateHitDistance() {
         this._hitDistance = Vector3.Distance(this._rayFromWorld, this._hitPointWorld);
     }
 
     /**
+     * Resets all the values to default
      * @param from The from point on world space
      * @param to The to point on world space
      */