Skip to content

Commit 32a996e

Browse files
stephengoldstephengold
committed
javadoc in 25 files
1 parent 79c9f4f commit 32a996e

25 files changed

+124
-123
lines changed

‎src/main/java/com/github/stephengold/joltjni/Body.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -529,7 +529,7 @@ public boolean getAllowSleeping() {
529529
}
530530

531531
/**
532-
* Return the body's angular velocity. The body is unaffected.
532+
* Copy the body's angular velocity. The body is unaffected.
533533
*
534534
* @return a new velocity vector (radians per second in system coordinates)
535535
*/
@@ -669,7 +669,7 @@ public BodyId getId() {
669669
}
670670

671671
/**
672-
* Return the body's linear velocity. The body is unaffected.
672+
* Copy the body's linear velocity. The body is unaffected.
673673
*
674674
* @return a new velocity vector (meters per second in system coordinates)
675675
*/
@@ -750,7 +750,7 @@ public float getRestitution() {
750750
}
751751

752752
/**
753-
* Return the body's orientation. The body is unaffected.
753+
* Copy the body's orientation. The body is unaffected.
754754
*
755755
* @return a new rotation quaternion (relative to the system axes)
756756
*/

‎src/main/java/com/github/stephengold/joltjni/BodyCreationSettings.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
Copyright (c) 2024 Stephen Gold
2+
Copyright (c) 2024-2025 Stephen Gold
33
44
Permission is hereby granted, free of charge, to any person obtaining a copy
55
of this software and associated documentation files (the "Software"), to deal
@@ -779,7 +779,7 @@ public EOverrideMassProperties getOverrideMassProperties() {
779779
}
780780

781781
/**
782-
* Return the (initial) location. The settings are unaffected. (native
782+
* Copy the (initial) location. The settings are unaffected. (native
783783
* attribute: mPosition)
784784
*
785785
* @return a new location vector (in physics-system coordinates, all

‎src/main/java/com/github/stephengold/joltjni/BodyInterface.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
Copyright (c) 2024 Stephen Gold
2+
Copyright (c) 2024-2025 Stephen Gold
33
44
Permission is hereby granted, free of charge, to any person obtaining a copy
55
of this software and associated documentation files (the "Software"), to deal
@@ -510,7 +510,7 @@ public float getRestitution(ConstBodyId bodyId) {
510510
}
511511

512512
/**
513-
* Return the orientation of the specified body.
513+
* Copy the orientation of the specified body.
514514
*
515515
* @param bodyId the ID of the body (not null, unaffected)
516516
* @return a new rotation quaternion

‎src/main/java/com/github/stephengold/joltjni/Character.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -527,7 +527,7 @@ public BodyId getBodyId() {
527527
}
528528

529529
/**
530-
* Return the location of the rigid body's center of mass using the locking
530+
* Copy the location of the rigid body's center of mass using the locking
531531
* body interface. The character is unaffected.
532532
*
533533
* @return a new location vector (in system coordinates)
@@ -539,7 +539,7 @@ public RVec3 getCenterOfMassPosition() {
539539
}
540540

541541
/**
542-
* Return the location of the rigid body's center of mass. The character is
542+
* Copy the location of the rigid body's center of mass. The character is
543543
* unaffected.
544544
*
545545
* @param lockBodies {@code true} → use the locking body interface,

‎src/main/java/com/github/stephengold/joltjni/CharacterBase.java‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
Copyright (c) 2024 Stephen Gold
2+
Copyright (c) 2024-2025 Stephen Gold
33
44
Permission is hereby granted, free of charge, to any person obtaining a copy
55
of this software and associated documentation files (the "Software"), to deal
@@ -109,10 +109,9 @@ public float getCosMaxSlopeAngle() {
109109
}
110110

111111
/**
112-
* Return the body ID of the supporting surface. The character is
113-
* unaffected.
112+
* Copy the body ID of the supporting surface. The character is unaffected.
114113
*
115-
* @return a new ID
114+
* @return a new object
116115
*/
117116
@Override
118117
public BodyId getGroundBodyId() {
@@ -145,7 +144,7 @@ public ConstPhysicsMaterial getGroundMaterial() {
145144
}
146145

147146
/**
148-
* Return the normal direction at the point of contact with the supporting
147+
* Copy the normal direction at the point of contact with the supporting
149148
* surface. The character is unaffected.
150149
*
151150
* @return a new direction vector (in system coordinates)
@@ -162,7 +161,7 @@ public Vec3 getGroundNormal() {
162161
}
163162

164163
/**
165-
* Return the location of the point of contact with the supporting surface.
164+
* Copy the location of the point of contact with the supporting surface.
166165
* The character is unaffected.
167166
*
168167
* @return a new location vector (in system coordinates)
@@ -197,7 +196,7 @@ public EGroundState getGroundState() {
197196
* Identify the face on the supporting surface where contact is occurring.
198197
* The character is unaffected.
199198
*
200-
* @return a new ID
199+
* @return a new object
201200
*/
202201
@Override
203202
public SubShapeId getGroundSubShapeId() {
@@ -223,8 +222,8 @@ public long getGroundUserData() {
223222
}
224223

225224
/**
226-
* Return the world-space velocity of the supporting surface. The character
227-
* is unaffected.
225+
* Copy the world-space velocity of the supporting surface. The character is
226+
* unaffected.
228227
*
229228
* @return a new velocity vector (meters per second in system coordinates)
230229
*/
@@ -255,7 +254,7 @@ public ConstShape getShape() {
255254
}
256255

257256
/**
258-
* Return the character's "up" direction. The character is unaffected.
257+
* Copy the character's "up" direction. The character is unaffected.
259258
*
260259
* @return a new direction vector
261260
*/

‎src/main/java/com/github/stephengold/joltjni/CharacterBaseSettings.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
Copyright (c) 2024 Stephen Gold
2+
Copyright (c) 2024-2025 Stephen Gold
33
44
Permission is hereby granted, free of charge, to any person obtaining a copy
55
of this software and associated documentation files (the "Software"), to deal
@@ -193,8 +193,8 @@ public Plane getSupportingVolume() {
193193
}
194194

195195
/**
196-
* Return the character's "up" direction. The settings are unaffected.
197-
* (native attribute: mUp)
196+
* Copy the character's "up" direction. The settings are unaffected. (native
197+
* attribute: mUp)
198198
*
199199
* @return a new direction vector (in system coordinates)
200200
*/

‎src/main/java/com/github/stephengold/joltjni/CharacterRef.java‎

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ public BodyId getBodyId() {
245245
}
246246

247247
/**
248-
* Return the location of the rigid body's center of mass using the locking
248+
* Copy the location of the rigid body's center of mass using the locking
249249
* body interface. The character is unaffected.
250250
*
251251
* @return a new location vector (in system coordinates)
@@ -257,7 +257,7 @@ public RVec3 getCenterOfMassPosition() {
257257
}
258258

259259
/**
260-
* Return the location of the rigid body's center of mass. The character is
260+
* Copy the location of the rigid body's center of mass. The character is
261261
* unaffected.
262262
*
263263
* @param lockBodies {@code true} → use the locking body interface,
@@ -291,10 +291,9 @@ public float getCosMaxSlopeAngle() {
291291
}
292292

293293
/**
294-
* Return the body ID of the supporting surface. The character is
295-
* unaffected.
294+
* Copy the body ID of the supporting surface. The character is unaffected.
296295
*
297-
* @return a new ID
296+
* @return a new object
298297
*/
299298
@Override
300299
public BodyId getGroundBodyId() {
@@ -327,7 +326,7 @@ public ConstPhysicsMaterial getGroundMaterial() {
327326
}
328327

329328
/**
330-
* Return the normal direction at the point of contact with the supporting
329+
* Copy the normal direction at the point of contact with the supporting
331330
* surface. The character is unaffected.
332331
*
333332
* @return a new direction vector (in system coordinates)
@@ -344,7 +343,7 @@ public Vec3 getGroundNormal() {
344343
}
345344

346345
/**
347-
* Return the location of the point of contact with the supporting surface.
346+
* Copy the location of the point of contact with the supporting surface.
348347
* The character is unaffected.
349348
*
350349
* @return a new location vector (in system coordinates)
@@ -379,7 +378,7 @@ public EGroundState getGroundState() {
379378
* Identify the face on the supporting surface where contact is occurring.
380379
* The character is unaffected.
381380
*
382-
* @return a new ID
381+
* @return a new object
383382
*/
384383
@Override
385384
public SubShapeId getGroundSubShapeId() {
@@ -405,8 +404,8 @@ public long getGroundUserData() {
405404
}
406405

407406
/**
408-
* Return the world-space velocity of the supporting surface. The character
409-
* is unaffected.
407+
* Copy the world-space velocity of the supporting surface. The character is
408+
* unaffected.
410409
*
411410
* @return a new velocity vector (meters per second in system coordinates)
412411
*/
@@ -595,7 +594,7 @@ public ConstShape getShape() {
595594
}
596595

597596
/**
598-
* Return the character's "up" direction. The character is unaffected.
597+
* Copy the character's "up" direction. The character is unaffected.
599598
*
600599
* @return a new direction vector
601600
*/

‎src/main/java/com/github/stephengold/joltjni/CharacterVirtual.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -541,7 +541,7 @@ public CharacterId getId() {
541541
}
542542

543543
/**
544-
* Return the linear velocity of the character. The character is unaffected.
544+
* Copy the linear velocity of the character. The character is unaffected.
545545
*
546546
* @return a new velocity vector (meters per second in system coordinates)
547547
*/

‎src/main/java/com/github/stephengold/joltjni/CharacterVirtualRef.java‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -370,10 +370,9 @@ public boolean getEnhancedInternalEdgeRemoval() {
370370
}
371371

372372
/**
373-
* Return the body ID of the supporting surface. The character is
374-
* unaffected.
373+
* Copy the body ID of the supporting surface. The character is unaffected.
375374
*
376-
* @return a new ID
375+
* @return a new object
377376
*/
378377
@Override
379378
public BodyId getGroundBodyId() {
@@ -406,7 +405,7 @@ public ConstPhysicsMaterial getGroundMaterial() {
406405
}
407406

408407
/**
409-
* Return the normal direction at the point of contact with the supporting
408+
* Copy the normal direction at the point of contact with the supporting
410409
* surface. The character is unaffected.
411410
*
412411
* @return a new direction vector (in system coordinates)
@@ -423,7 +422,7 @@ public Vec3 getGroundNormal() {
423422
}
424423

425424
/**
426-
* Return the location of the point of contact with the supporting surface.
425+
* Copy the location of the point of contact with the supporting surface.
427426
* The character is unaffected.
428427
*
429428
* @return a new location vector (in system coordinates)
@@ -458,7 +457,7 @@ public EGroundState getGroundState() {
458457
* Identify the face on the supporting surface where contact is occurring.
459458
* The character is unaffected.
460459
*
461-
* @return a new ID
460+
* @return a new object
462461
*/
463462
@Override
464463
public SubShapeId getGroundSubShapeId() {
@@ -484,8 +483,8 @@ public long getGroundUserData() {
484483
}
485484

486485
/**
487-
* Return the world-space velocity of the supporting surface. The character
488-
* is unaffected.
486+
* Copy the world-space velocity of the supporting surface. The character is
487+
* unaffected.
489488
*
490489
* @return a new velocity vector (meters per second in system coordinates)
491490
*/
@@ -544,7 +543,7 @@ public BodyId getInnerBodyId() {
544543
}
545544

546545
/**
547-
* Return the linear velocity of the character. The character is unaffected.
546+
* Copy the linear velocity of the character. The character is unaffected.
548547
*
549548
* @return a new velocity vector (meters per second in system coordinates)
550549
*/
@@ -693,7 +692,7 @@ public Vec3 getShapeOffset() {
693692
}
694693

695694
/**
696-
* Return the character's "up" direction. The character is unaffected.
695+
* Copy the character's "up" direction. The character is unaffected.
697696
*
698697
* @return a new direction vector
699698
*/

‎src/main/java/com/github/stephengold/joltjni/CollideShapeResult.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
Copyright (c) 2024 Stephen Gold
2+
Copyright (c) 2024-2025 Stephen Gold
33
44
Permission is hereby granted, free of charge, to any person obtaining a copy
55
of this software and associated documentation files (the "Software"), to deal
@@ -144,7 +144,7 @@ public float getPenetrationDepth() {
144144
* Identify the face on shape 1 where the collision occurred. The object is
145145
* unaffected. (native attribute: mSubShapeID1)
146146
*
147-
* @return a new ID
147+
* @return a new object
148148
*/
149149
@Override
150150
public SubShapeId getSubShapeId1() {

0 commit comments

Comments
 (0)