Skip to main content

App - World Simulation & Physics

Physics world, contacts, mechanisms, assemblies, primitives, and joints.

Subsystem Metrics​

  • Total Documented Functions: 2042
  • Functions Exercised in Tests: 67
  • Platform-Divergent Implementations: 33
  • Component Source Files: 158

Source Files​

View all 158 source files in this subsystem
Source FilePath
Body.hApp/include/v8kernel/Body.h
BulletShapeConnectors.hApp/include/v8kernel/BulletShapeConnectors.h
BuoyancyConnector.hApp/include/v8kernel/BuoyancyConnector.h
Cofm.hApp/include/v8kernel/Cofm.h
Connector.hApp/include/v8kernel/Connector.h
Constants.hApp/include/v8kernel/Constants.h
ContactConnector.hApp/include/v8kernel/ContactConnector.h
IStage.hApp/include/v8kernel/IStage.h
Kernel.hApp/include/v8kernel/Kernel.h
KernelData.hApp/include/v8kernel/KernelData.h
KernelIndex.hApp/include/v8kernel/KernelIndex.h
Link.hApp/include/v8kernel/Link.h
Pair.hApp/include/v8kernel/Pair.h
Point.hApp/include/v8kernel/Point.h
PolyConnectors.hApp/include/v8kernel/PolyConnectors.h
SimBody.hApp/include/v8kernel/SimBody.h
Assembly.hApp/include/v8world/Assembly.h
AssemblyStage.hApp/include/v8world/AssemblyStage.h
Ball.hApp/include/v8world/Ball.h
BasicSpatialHashPrimitive.hApp/include/v8world/BasicSpatialHashPrimitive.h
Block.hApp/include/v8world/Block.h
BlockCorners.hApp/include/v8world/BlockCorners.h
BlockMesh.hApp/include/v8world/BlockMesh.h
BulletGeometryPoolObjects.hApp/include/v8world/BulletGeometryPoolObjects.h
Buoyancy.hApp/include/v8world/Buoyancy.h
CellContact.hApp/include/v8world/CellContact.h
Clump.hApp/include/v8world/Clump.h
Contact.hApp/include/v8world/Contact.h
ContactManager.hApp/include/v8world/ContactManager.h
CornerWedgeMesh.hApp/include/v8world/CornerWedgeMesh.h
DistributedPhysics.hApp/include/v8world/DistributedPhysics.h
Edge.hApp/include/v8world/Edge.h
EdgeBuffer.hApp/include/v8world/EdgeBuffer.h
Enum.hApp/include/v8world/Enum.h
Geometry.hApp/include/v8world/Geometry.h
GeometryPool.hApp/include/v8world/GeometryPool.h
GlueJoint.hApp/include/v8world/GlueJoint.h
HumanoidStage.hApp/include/v8world/HumanoidStage.h
IMoving.hApp/include/v8world/IMoving.h
IPipelined.hApp/include/v8world/IPipelined.h
IWorldStage.hApp/include/v8world/IWorldStage.h
Joint.hApp/include/v8world/Joint.h
KDTree.hApp/include/v8world/KDTree.h
KernelJoint.hApp/include/v8world/KernelJoint.h
Mechanism.hApp/include/v8world/Mechanism.h
MegaClusterMesh.hApp/include/v8world/MegaClusterMesh.h
Mesh.hApp/include/v8world/Mesh.h
Motor6DJoint.hApp/include/v8world/Motor6DJoint.h
MotorJoint.hApp/include/v8world/MotorJoint.h
MovingAssemblyStage.hApp/include/v8world/MovingAssemblyStage.h
ParallelRampMesh.hApp/include/v8world/ParallelRampMesh.h
Poly.hApp/include/v8world/Poly.h
PolyCellContact.hApp/include/v8world/PolyCellContact.h
PolyContact.hApp/include/v8world/PolyContact.h
PolyPolyContact.hApp/include/v8world/PolyPolyContact.h
Primitive.hApp/include/v8world/Primitive.h
PrismMesh.hApp/include/v8world/PrismMesh.h
PyramidMesh.hApp/include/v8world/PyramidMesh.h
RightAngleRampMesh.hApp/include/v8world/RightAngleRampMesh.h
RigidJoint.hApp/include/v8world/RigidJoint.h
RotateJoint.hApp/include/v8world/RotateJoint.h
SendPhysics.hApp/include/v8world/SendPhysics.h
SimJob.hApp/include/v8world/SimJob.h
SimulateStage.hApp/include/v8world/SimulateStage.h
SleepStage.hApp/include/v8world/SleepStage.h
SmoothClusterGeometry.hApp/include/v8world/SmoothClusterGeometry.h
SnapJoint.hApp/include/v8world/SnapJoint.h
SpatialFilter.hApp/include/v8world/SpatialFilter.h
SpatialHashMultiRes.hApp/include/v8world/SpatialHashMultiRes.h
SurfaceData.hApp/include/v8world/SurfaceData.h
Tolerance.hApp/include/v8world/Tolerance.h
TreeStage.hApp/include/v8world/TreeStage.h
TriangleMesh.hApp/include/v8world/TriangleMesh.h
WedgeMesh.hApp/include/v8world/WedgeMesh.h
WeldJoint.hApp/include/v8world/WeldJoint.h
World.hApp/include/v8world/World.h
Body.cppApp/v8kernel/Body.cpp
BulletShapeConnectors.cppApp/v8kernel/BulletShapeConnectors.cpp
BuoyancyConnector.cppApp/v8kernel/BuoyancyConnector.cpp
Cofm.cppApp/v8kernel/Cofm.cpp
Connector.cppApp/v8kernel/Connector.cpp
Constants.cppApp/v8kernel/Constants.cpp
ContactConnector.cppApp/v8kernel/ContactConnector.cpp
Kernel.cppApp/v8kernel/Kernel.cpp
Link.cppApp/v8kernel/Link.cpp
Pair.cppApp/v8kernel/Pair.cpp
Point.cppApp/v8kernel/Point.cpp
PolyConnectors.cppApp/v8kernel/PolyConnectors.cpp
SimBody.cppApp/v8kernel/SimBody.cpp
Assembly.cppApp/v8world/Assembly.cpp
AssemblyHistory.cppApp/v8world/AssemblyHistory.cpp
AssemblyStage.cppApp/v8world/AssemblyStage.cpp
Ball.cppApp/v8world/Ball.cpp
BallCellContact.cppApp/v8world/BallCellContact.cpp
BallPolyContact.cppApp/v8world/BallPolyContact.cpp
Block.cppApp/v8world/Block.cpp
BulletContact.cppApp/v8world/BulletContact.cpp
BulletShapeCellContact.cppApp/v8world/BulletShapeCellContact.cpp
BulletShapeContact.cppApp/v8world/BulletShapeContact.cpp
Buoyancy.cppApp/v8world/Buoyancy.cpp
CellContact.cppApp/v8world/CellContact.cpp
CleanStage.cppApp/v8world/CleanStage.cpp
Clump.cppApp/v8world/Clump.cpp
Contact.cppApp/v8world/Contact.cpp
ContactManager.cppApp/v8world/ContactManager.cpp
ContactStage.cppApp/v8world/ContactStage.cpp
CornerWedgePoly.cppApp/v8world/CornerWedgePoly.cpp
Cylinder.cppApp/v8world/Cylinder.cpp
Edge.cppApp/v8world/Edge.cpp
EdgeBuffer.cppApp/v8world/EdgeBuffer.cpp
EdgeStage.cppApp/v8world/EdgeStage.cpp
GlueJoint.cppApp/v8world/GlueJoint.cpp
GroundStage.cppApp/v8world/GroundStage.cpp
HumanoidStage.cppApp/v8world/HumanoidStage.cpp
IMoving.cppApp/v8world/IMoving.cpp
IPipelined.cppApp/v8world/IPipelined.cpp
IWorldStage.cppApp/v8world/IWorldStage.cpp
Joint.cppApp/v8world/Joint.cpp
JointBuilder.cppApp/v8world/JointBuilder.cpp
JointStage.cppApp/v8world/JointStage.cpp
KDTree.cppApp/v8world/KDTree.cpp
KernelJoint.cppApp/v8world/KernelJoint.cpp
MaterialProperties.cppApp/v8world/MaterialProperties.cpp
MechToAssemblyStage.cppApp/v8world/MechToAssemblyStage.cpp
Mechanism.cppApp/v8world/Mechanism.cpp
MegaClusterPoly.cppApp/v8world/MegaClusterPoly.cpp
Mesh.cppApp/v8world/Mesh.cpp
Motor6DJoint.cppApp/v8world/Motor6DJoint.cpp
MotorJoint.cppApp/v8world/MotorJoint.cpp
MovingAssemblyStage.cppApp/v8world/MovingAssemblyStage.cpp
MovingStage.cppApp/v8world/MovingStage.cpp
MutilJoint.cppApp/v8world/MutilJoint.cpp
ParallelRampPoly.cppApp/v8world/ParallelRampPoly.cpp
Poly.cppApp/v8world/Poly.cpp
PolyCellContact.cppApp/v8world/PolyCellContact.cpp
PolyContact.cppApp/v8world/PolyContact.cpp
PolyPolyContact.cppApp/v8world/PolyPolyContact.cpp
Primitive.cppApp/v8world/Primitive.cpp
PrismPoly.cppApp/v8world/PrismPoly.cpp
PyramidPoly.cppApp/v8world/PyramidPoly.cpp
RightAngleRampPoly.cppApp/v8world/RightAngleRampPoly.cpp
RigidJoint.cppApp/v8world/RigidJoint.cpp
RotateJoint.cppApp/v8world/RotateJoint.cpp
SendPhysics.cppApp/v8world/SendPhysics.cpp
SimJob.cppApp/v8world/SimJob.cpp
SimulateStage.cppApp/v8world/SimulateStage.cpp
SleepStage.cppApp/v8world/SleepStage.cpp
SmoothClusterGeometry.cppApp/v8world/SmoothClusterGeometry.cpp
SnapJoint.cppApp/v8world/SnapJoint.cpp
SpatialFilter.cppApp/v8world/SpatialFilter.cpp
SpatialHashMultiRes.cppApp/v8world/SpatialHashMultiRes.cpp
StepJointsStage.cppApp/v8world/StepJointsStage.cpp
TerrainPartition.cppApp/v8world/TerrainPartition.cpp
TreeStage.cppApp/v8world/TreeStage.cpp
TriangleMesh.cppApp/v8world/TriangleMesh.cpp
WedgePoly.cppApp/v8world/WedgePoly.cpp
WeldJoint.cppApp/v8world/WeldJoint.cpp
World.cppApp/v8world/World.cpp

Function Reference​

1. getLeafBodyIndex​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

int& getLeafBodyIndex();
PropertyValue
Return Typeint&
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:74
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getLeafBodyIndex within App - World Simulation & Physics.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getLeafBodyIndex.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


2. getCofm​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

Cofm* getCofm();
PropertyValue
Return TypeCofm*
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:84
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getCofm within App - World Simulation & Physics.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getCofm.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


3. getSimBody​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

SimBody* getSimBody();
PropertyValue
Return TypeSimBody*
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:87
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getSimBody within App - World Simulation & Physics.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getSimBody.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


4. getConstSimBody​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

SimBody* getConstSimBody() const;
PropertyValue
Return TypeSimBody*
Modifiersconst const
Source LocationApp/include/v8kernel/Body.h:88
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getConstSimBody within App - World Simulation & Physics.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getConstSimBody.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


5. getMeInParent​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

CoordinateFrame& getMeInParent() const;
PropertyValue
Return TypeCoordinateFrame&
Modifiersconst
Source LocationApp/include/v8kernel/Body.h:108
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getMeInParent within App - World Simulation & Physics. Coordinates interactions with RBXASSERT, getParent, getLink, getChildInParent.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Engine invariant assertion check (RBXASSERT).
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: RBXASSERT, getParent, getLink, getChildInParent.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getMeInParent.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


6. getConstMeInParent​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

CoordinateFrame& getConstMeInParent() const;
PropertyValue
Return TypeCoordinateFrame&
Modifiersconst const
Source LocationApp/include/v8kernel/Body.h:113
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getConstMeInParent within App - World Simulation & Physics. Coordinates interactions with RBXASSERT, getConstParent, getConstLink, linked.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Engine invariant assertion check (RBXASSERT).
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: RBXASSERT, getConstParent, getConstLink, linked.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getConstMeInParent.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


7. pvIsUpToDate​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

bool pvIsUpToDate() const;
PropertyValue
Return Typebool
Modifiersconst
Source LocationApp/include/v8kernel/Body.h:120
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes pvIsUpToDate within App - World Simulation & Physics. Coordinates interactions with getConstParent, getRoot, getStateIndexNoUpdate.

  • Control Flow & Execution: Conditional branching, Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: getConstParent, getRoot, getStateIndexNoUpdate.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on pvIsUpToDate.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


8. calcRoot​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

Body* calcRoot();
PropertyValue
Return TypeBody*
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:137
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes calcRoot within App - World Simulation & Physics. Coordinates interactions with getParent.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: getParent.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on calcRoot.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


9. calcRootConst​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

Body* calcRootConst() const;
PropertyValue
Return TypeBody*
Modifiersconst const
Source LocationApp/include/v8kernel/Body.h:139
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes calcRootConst within App - World Simulation & Physics. Coordinates interactions with getConstParent.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: getConstParent.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on calcRootConst.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


10. getRootSimBody​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

SimBody* getRootSimBody();
PropertyValue
Return TypeSimBody*
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:158
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getRootSimBody within App - World Simulation & Physics. Coordinates interactions with getRoot, getSimBody.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: getRoot, getSimBody.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getRootSimBody.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


11. getConstRootSimBody​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

SimBody* getConstRootSimBody() const;
PropertyValue
Return TypeSimBody*
Modifiersconst const
Source LocationApp/include/v8kernel/Body.h:160
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getConstRootSimBody within App - World Simulation & Physics. Coordinates interactions with getRoot, getConstSimBody.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: getRoot, getConstSimBody.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getConstRootSimBody.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


12. getUID​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

boost::uint64_t getUID() const;
PropertyValue
Return Typeboost::uint64_t
Modifiersconst
Source LocationApp/include/v8kernel/Body.h:163
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getUID within App - World Simulation & Physics.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getUID.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


13. setGuidIndex​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void setGuidIndex(int _guidIndex);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:166
SubsystemApp - World Simulation & Physics

How it Works Internally​

Used only by the solver inspector to id the objects between different clients

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on setGuidIndex.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


14. getGuidIndex​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

int getGuidIndex() const;
PropertyValue
Return Typeint
Modifiersconst
Source LocationApp/include/v8kernel/Body.h:167
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getGuidIndex within App - World Simulation & Physics.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getGuidIndex.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


15. cofmIsClean​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

bool cofmIsClean();
PropertyValue
Return Typebool
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:171
SubsystemApp - World Simulation & Physics

How it Works Internally​

From Cofm, SimBody

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: getCofm, getIsDirty.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on cofmIsClean.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


16. makeStateDirty​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void makeStateDirty();
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:178
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes makeStateDirty within App - World Simulation & Physics. Coordinates interactions with getRoot, advanceStateIndex.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: getRoot, advanceStateIndex.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on makeStateDirty.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


17. getStateIndex​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

int getStateIndex();
PropertyValue
Return Typeint
Modifiersunsigned
Source LocationApp/include/v8kernel/Body.h:182
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getStateIndex within App - World Simulation & Physics. Coordinates interactions with updatePV.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: updatePV.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getStateIndex.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


18. getStateIndexNoUpdate​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

int getStateIndexNoUpdate() const;
PropertyValue
Return Typeint
Modifiersunsigned const
Source LocationApp/include/v8kernel/Body.h:187
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getStateIndexNoUpdate within App - World Simulation & Physics.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getStateIndexNoUpdate.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


19. getChild​

Status: 🧪 Tested  |  🌐 Cross-Platform Uniform

Body* getChild(int i);
PropertyValue
Return TypeBody*
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:194
SubsystemApp - World Simulation & Physics

How it Works Internally​

Base vs. Branch

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

This function is exercised in 3 test case(s):

  • Instance::SetParentNull (App.UnitTest/Instance.cpp:251)
    • Usage Pattern: Direct Call
    • Callsite Snippet: RBX::Instance* child = parent->getChild(0);
  • ChatTests::ReportAbuse (App.UnitTest/ChatTests.cpp:353)
    • Usage Pattern: Direct Call
    • Assertions Checked: BOOST_CHECK(event->Wait(RBX::Time::Interval::from_seconds(10)))
    • Callsite Snippet: Player* player = boost::polymorphic_downcast<Player*>(players->getChild(0));
  • NetworkSecurity::SecurePlayerReplication (App.UnitTest/NetworkSecurity.cpp:186)
    • Usage Pattern: Direct Call
    • Assertions Checked: BOOST_REQUIRE(player), BOOST_REQUIRE(players)
    • Callsite Snippet: RBX::Network::Player* player = Instance::fastDynamicCast<RBX::Network::Player>(players->getChild(0));

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


20. getConstChild​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

Body* getConstChild(int i) const;
PropertyValue
Return TypeBody*
Modifiersconst const
Source LocationApp/include/v8kernel/Body.h:196
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getConstChild within App - World Simulation & Physics.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getConstChild.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


21. getParent​

Status: 🧪 Tested  |  🌐 Cross-Platform Uniform

Body* getParent();
PropertyValue
Return TypeBody*
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:197
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getParent within App - World Simulation & Physics.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

This function is exercised in 8 test case(s):

  • Instance::Parenting (App.UnitTest/Instance.cpp:193)
    • Usage Pattern: Direct Assertion
    • Assertions Checked: BOOST_CHECK(checkAncestor->getParent() != NULL)
    • Callsite Snippet: BOOST_CHECK(checkAncestor->getParent() != NULL);
  • Instance::ReparentingLock (App.UnitTest/Instance.cpp:213)
    • Usage Pattern: Direct Assertion
    • Assertions Checked: BOOST_CHECK(child->getParent() == parent.get())
    • Callsite Snippet: BOOST_CHECK(child->getParent() == parent.get());
  • Instance::WaitForChildOutsideOfDataModel (App.UnitTest/Instance.cpp:525)
    • Usage Pattern: Direct Assertion
    • Assertions Checked: BOOST_REQUIRE(part->getParent() == NULL)
    • Callsite Snippet: BOOST_REQUIRE(part->getParent() == NULL);
  • SettingsTest::SelectionDoesNotNukeSettings (App.UnitTest/SettingsTest.cpp:191)
    • Usage Pattern: Direct Assertion
    • Assertions Checked: BOOST_CHECK(sel->getParent() == settings.get())
    • Callsite Snippet: BOOST_CHECK(sel->getParent() == settings.get());

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


22. getConstParent​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

Body* getConstParent() const;
PropertyValue
Return TypeBody*
Modifiersconst const
Source LocationApp/include/v8kernel/Body.h:199
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getConstParent within App - World Simulation & Physics.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getConstParent.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

Link* getLink();
PropertyValue
Return TypeLink*
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:200
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getLink within App - World Simulation & Physics.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getLink.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

Link* getConstLink() const;
PropertyValue
Return TypeLink*
Modifiersconst const
Source LocationApp/include/v8kernel/Body.h:202
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getConstLink within App - World Simulation & Physics.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getConstLink.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


25. getRoot​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

Body* getRoot() const;
PropertyValue
Return TypeBody*
Modifiersconst const
Source LocationApp/include/v8kernel/Body.h:203
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getRoot within App - World Simulation & Physics. Coordinates interactions with RBXASSERT_SLOW, calcRootConst.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: RBXASSERT_SLOW, calcRootConst.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getRoot.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


26. getRoot​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

Body* getRoot();
PropertyValue
Return TypeBody*
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:208
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getRoot within App - World Simulation & Physics. Coordinates interactions with RBXASSERT_SLOW, calcRootConst.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: RBXASSERT_SLOW, calcRootConst.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getRoot.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


27. getCofmOffset​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

Vector3& getCofmOffset() const;
PropertyValue
Return TypeVector3&
Modifiersconst
Source LocationApp/include/v8kernel/Body.h:213
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getCofmOffset within App - World Simulation & Physics.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getCofmOffset.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


28. getMeInAncestor​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

CoordinateFrame getMeInAncestor(const Body* ancestor) const;
PropertyValue
Return TypeCoordinateFrame
Modifiersconst
Source LocationApp/include/v8kernel/Body.h:221
SubsystemApp - World Simulation & Physics

How it Works Internally​

Only works on bodies in same clump - otherwise not const for the link and will assert

  • Control Flow & Execution: Conditional branching, Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: CoordinateFrame, getConstParent, getConstMeInParent.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getMeInAncestor.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


29. getMass​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

float getMass() const;
PropertyValue
Return Typefloat
Modifiersinline const
Source LocationApp/include/v8kernel/Body.h:232
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getMass within App - World Simulation & Physics.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getMass.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


30. getIBody​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

Matrix3 getIBody() const;
PropertyValue
Return TypeMatrix3
Modifiersinline const
Source LocationApp/include/v8kernel/Body.h:234
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getIBody within App - World Simulation & Physics.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getIBody.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


31. getIBodyV3​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

Vector3 getIBodyV3() const;
PropertyValue
Return TypeVector3
Modifiersinline const
Source LocationApp/include/v8kernel/Body.h:235
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getIBodyV3 within App - World Simulation & Physics. Coordinates interactions with toDiagonal, getIBody.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: toDiagonal, getIBody.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getIBodyV3.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


32. getMoment​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

Matrix3 getMoment() const;
PropertyValue
Return TypeMatrix3
Modifiersinline const
Source LocationApp/include/v8kernel/Body.h:237
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getMoment within App - World Simulation & Physics. Coordinates interactions with getIBody.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: getIBody.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getMoment.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


33. getPrincipalMoment​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

Vector3 getPrincipalMoment() const;
PropertyValue
Return TypeVector3
Modifiersinline const
Source LocationApp/include/v8kernel/Body.h:238
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getPrincipalMoment within App - World Simulation & Physics. Coordinates interactions with getIBodyV3.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: getIBodyV3.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getPrincipalMoment.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


34. getIWorld​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

Matrix3 getIWorld();
PropertyValue
Return TypeMatrix3
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:239
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getIWorld within App - World Simulation & Physics. Coordinates interactions with momentToWorldSpace, getIBody, getCoordinateFrame.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: momentToWorldSpace, getIBody, getCoordinateFrame.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getIWorld.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


35. getBranchMass​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

float getBranchMass();
PropertyValue
Return Typefloat
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:243
SubsystemApp - World Simulation & Physics

How it Works Internally​

Branch refers to everything below me....

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: getCofm, getMass.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getBranchMass.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


36. getBranchIBody​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

Matrix3 getBranchIBody();
PropertyValue
Return TypeMatrix3
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:244
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getBranchIBody within App - World Simulation & Physics. Coordinates interactions with getCofm, getMoment.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: getCofm, getMoment.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getBranchIBody.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


37. getBranchIBodyV3​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

Vector3 getBranchIBodyV3();
PropertyValue
Return TypeVector3
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:245
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getBranchIBodyV3 within App - World Simulation & Physics. Coordinates interactions with toDiagonal, getBranchIBody.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: toDiagonal, getBranchIBody.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getBranchIBodyV3.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


38. getBranchIWorld​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

Matrix3 getBranchIWorld();
PropertyValue
Return TypeMatrix3
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:246
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getBranchIWorld within App - World Simulation & Physics. Coordinates interactions with momentToWorldSpace, getBranchIBody, getCoordinateFrame.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: momentToWorldSpace, getBranchIBody, getCoordinateFrame.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getBranchIWorld.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


39. getPvFast​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

PV& getPvFast() const;
PropertyValue
Return TypePV&
Modifiersconst const
Source LocationApp/include/v8kernel/Body.h:252
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getPvFast within App - World Simulation & Physics. Coordinates interactions with RBXASSERT_FISHING, pvIsUpToDate.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: RBXASSERT_FISHING, pvIsUpToDate.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getPvFast.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


40. getPvUnsafe​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

PV& getPvUnsafe() const;
PropertyValue
Return TypePV&
Modifiersconst
Source LocationApp/include/v8kernel/Body.h:259
SubsystemApp - World Simulation & Physics

How it Works Internally​

Current Job should hold the Data Model write lock or somehow have locked the Body::mutex.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: updatePV.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getPvUnsafe.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


41. getPV_Spin_Lock​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

PV& getPV_Spin_Lock() const;
PropertyValue
Return TypePV&
Modifiersconst
Source LocationApp/include/v8kernel/Body.h:263
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getPV_Spin_Lock within App - World Simulation & Physics. Coordinates interactions with lock, updatePV.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Spinlock synchronization via RBX::spin_mutex; RAII mutex lock acquisition (scoped_lock).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: lock, updatePV.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getPV_Spin_Lock.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


42. getPvSafe​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

PV& getPvSafe() const;
PropertyValue
Return TypePV&
Modifiersconst const
Source LocationApp/include/v8kernel/Body.h:269
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getPvSafe within App - World Simulation & Physics. Coordinates interactions with getPV_Spin_Lock.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: getPV_Spin_Lock.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getPvSafe.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


43. getPosFast​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

Vector3& getPosFast() const;
PropertyValue
Return TypeVector3&
Modifiersconst const
Source LocationApp/include/v8kernel/Body.h:274
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getPosFast within App - World Simulation & Physics. Coordinates interactions with RBXASSERT_FISHING, pvIsUpToDate.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: RBXASSERT_FISHING, pvIsUpToDate.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getPosFast.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


44. getPos​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

Vector3& getPos() const;
PropertyValue
Return TypeVector3&
Modifiersconst
Source LocationApp/include/v8kernel/Body.h:279
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getPos within App - World Simulation & Physics. Coordinates interactions with updatePV.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: updatePV.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getPos.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


45. getCoordinateFrameFast​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

CoordinateFrame& getCoordinateFrameFast() const;
PropertyValue
Return TypeCoordinateFrame&
Modifiersconst const
Source LocationApp/include/v8kernel/Body.h:284
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getCoordinateFrameFast within App - World Simulation & Physics. Coordinates interactions with RBXASSERT_FISHING, pvIsUpToDate.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: RBXASSERT_FISHING, pvIsUpToDate.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getCoordinateFrameFast.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


46. getCoordinateFrame​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

CoordinateFrame& getCoordinateFrame() const;
PropertyValue
Return TypeCoordinateFrame&
Modifiersconst
Source LocationApp/include/v8kernel/Body.h:289
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getCoordinateFrame within App - World Simulation & Physics. Coordinates interactions with updatePV.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: updatePV.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getCoordinateFrame.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


47. getVelocity​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

Velocity& getVelocity() const;
PropertyValue
Return TypeVelocity&
Modifiersconst
Source LocationApp/include/v8kernel/Body.h:294
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getVelocity within App - World Simulation & Physics. Coordinates interactions with updatePV.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: updatePV.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getVelocity.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


48. getCanThrottle​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

bool getCanThrottle() const;
PropertyValue
Return Typebool
Modifiersconst
Source LocationApp/include/v8kernel/Body.h:299
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getCanThrottle within App - World Simulation & Physics.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getCanThrottle.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


49. accumulateImpulseAtBranchCofm​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void accumulateImpulseAtBranchCofm(const Vector3& impulse);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:303
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes accumulateImpulseAtBranchCofm within App - World Simulation & Physics. Coordinates interactions with getRootSimBody.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: getRootSimBody.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on accumulateImpulseAtBranchCofm.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


50. accumulateLinearImpulse​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void accumulateLinearImpulse(const Vector3& impulse, const Vector3& worldPos);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:309
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes accumulateLinearImpulse within App - World Simulation & Physics. Coordinates interactions with getRootSimBody, accumulateImpulse.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: getRootSimBody, accumulateImpulse.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on accumulateLinearImpulse.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


51. accumulateRotationalImpulse​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void accumulateRotationalImpulse(const Vector3& impulse);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:315
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes accumulateRotationalImpulse within App - World Simulation & Physics. Coordinates interactions with getRootSimBody.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: getRootSimBody.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on accumulateRotationalImpulse.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


52. accumulateForceAtBranchCofm​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void accumulateForceAtBranchCofm(const Vector3& force);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:321
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes accumulateForceAtBranchCofm within App - World Simulation & Physics. Coordinates interactions with RBXASSERT, getRoot, getRootSimBody, accumulateForceCofm.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Engine invariant assertion check (RBXASSERT).
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: RBXASSERT, getRoot, getRootSimBody, accumulateForceCofm.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on accumulateForceAtBranchCofm.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


53. accumulateForce​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void accumulateForce(const Vector3& force, const Vector3& worldPos);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:328
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes accumulateForce within App - World Simulation & Physics. Coordinates interactions with getRootSimBody.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: getRootSimBody.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on accumulateForce.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


54. accumulateTorque​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void accumulateTorque(const Vector3& torque);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:334
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes accumulateTorque within App - World Simulation & Physics. Coordinates interactions with getRootSimBody.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: getRootSimBody.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on accumulateTorque.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


55. resetForceAccumulators​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void resetForceAccumulators();
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:340
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes resetForceAccumulators within App - World Simulation & Physics. Coordinates interactions with getRootSimBody.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: getRootSimBody.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on resetForceAccumulators.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


56. resetImpulseAccumulators​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void resetImpulseAccumulators();
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:346
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes resetImpulseAccumulators within App - World Simulation & Physics. Coordinates interactions with getRootSimBody.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: getRootSimBody.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on resetImpulseAccumulators.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


57. getBranchForce​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

Vector3& getBranchForce() const;
PropertyValue
Return TypeVector3&
Modifiersconst const
Source LocationApp/include/v8kernel/Body.h:352
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getBranchForce within App - World Simulation & Physics. Coordinates interactions with RBXASSERT, getRoot, getConstRootSimBody, getForce.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Engine invariant assertion check (RBXASSERT).
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: RBXASSERT, getRoot, getConstRootSimBody, getForce, zero.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getBranchForce.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


58. getBranchTorque​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

Vector3& getBranchTorque() const;
PropertyValue
Return TypeVector3&
Modifiersconst const
Source LocationApp/include/v8kernel/Body.h:358
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getBranchTorque within App - World Simulation & Physics. Coordinates interactions with RBXASSERT, getRoot, getConstRootSimBody, getTorque.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Engine invariant assertion check (RBXASSERT).
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: RBXASSERT, getRoot, getConstRootSimBody, getTorque, zero.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getBranchTorque.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


59. getBranchVelocity​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

Velocity& getBranchVelocity() const;
PropertyValue
Return TypeVelocity&
Modifiersconst
Source LocationApp/include/v8kernel/Body.h:364
SubsystemApp - World Simulation & Physics

How it Works Internally​

Executes getBranchVelocity within App - World Simulation & Physics. Coordinates interactions with RBXASSERT, getRoot, getRootSimBody, getPV.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Engine invariant assertion check (RBXASSERT).
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: RBXASSERT, getRoot, getRootSimBody, getPV, zero.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getBranchVelocity.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


60. setParent​

Status: 🧪 Tested  |  🌐 Cross-Platform Uniform

void setParent(Body* parent);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationApp/include/v8kernel/Body.h:374
SubsystemApp - World Simulation & Physics

How it Works Internally​

setting properties

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: setIndexedTreeParent.

How it is Used in Tests​

This function is exercised in 88 test case(s):

  • Instance::Parenting (App.UnitTest/Instance.cpp:193)
    • Usage Pattern: Direct Assertion
    • Assertions Checked: BOOST_CHECK_THROW(instance->setParent2(dm.dataModel), std::exception), BOOST_CHECK_THROW(checkAncestor->setParent2(dm.dataModel), std::exception), BOOST_CHECK_THROW(checkAncestor->setParent2(instance), std::exception)
    • Callsite Snippet: checkAncestor->setParent2(instance);
  • Instance::ReparentingLock (App.UnitTest/Instance.cpp:213)
    • Usage Pattern: Direct Call
    • Assertions Checked: BOOST_CHECK(!parent->getIsParentLocked()), BOOST_CHECK(parent->getIsParentLocked())
    • Callsite Snippet: child->setParent(NULL);
  • Instance::SetParentNull (App.UnitTest/Instance.cpp:251)
    • Usage Pattern: Direct Call
    • Callsite Snippet: child->setParent(parent.get());
  • Instance::WaitForChildReturnsImmediatelyIfChildPresent (App.UnitTest/Instance.cpp:264)
    • Usage Pattern: Direct Call
    • Assertions Checked: BOOST_CHECK_EQUAL(part->getName(), "Renamed")
    • Callsite Snippet: script->setParent(dm->getWorkspace());

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


Additional Functions

There are 1982 additional internal and inline functions in this subsystem. All functions are indexed and cross-referenced in the Complete Function Catalog.