JoltPhysicsDocs/5.0.0/_cast_result_8h_source.html

// Jolt Physics Library (https://github.com/jrouwe/JoltPhysics)

// SPDX-FileCopyrightText: 2021 Jorrit Rouwe

// SPDX-License-Identifier: MIT


#pragma once


#include <Jolt/Physics/Body/BodyID.h>

#include <Jolt/Physics/Collision/Shape/SubShapeID.h>


JPH_NAMESPACE_BEGIN


class BroadPhaseCastResult

{

public:

    JPH_OVERRIDE_NEW_DELETE


    inline float    GetEarlyOutFraction() const         { return mFraction; }


    inline void     Reset()                             { mBodyID = BodyID(); mFraction = 1.0f + FLT_EPSILON; }


    BodyID          mBodyID;

    float           mFraction = 1.0f + FLT_EPSILON;

};


class RayCastResult : public BroadPhaseCastResult

{

public:

    JPH_OVERRIDE_NEW_DELETE


    SubShapeID      mSubShapeID2;

};


JPH_NAMESPACE_END

BodyID.h

JPH_NAMESPACE_END
#define JPH_NAMESPACE_END
Definition: Core.h:367

JPH_NAMESPACE_BEGIN
#define JPH_NAMESPACE_BEGIN
Definition: Core.h:361

JPH_OVERRIDE_NEW_DELETE
#define JPH_OVERRIDE_NEW_DELETE
Macro to override the new and delete functions.
Definition: Memory.h:29

SubShapeID.h

BodyID
ID of a body. This is a way of reasoning about bodies in a multithreaded simulation while avoiding ra...
Definition: BodyID.h:13

BroadPhaseCastResult
Structure that holds a ray cast or other object cast hit.
Definition: CastResult.h:14

BroadPhaseCastResult::GetEarlyOutFraction
JPH_OVERRIDE_NEW_DELETE float GetEarlyOutFraction() const
Function required by the CollisionCollector. A smaller fraction is considered to be a 'better hit'....
Definition: CastResult.h:19

BroadPhaseCastResult::mFraction
float mFraction
Hit fraction of the ray/object [0, 1], HitPoint = Start + mFraction * (End - Start)
Definition: CastResult.h:25

BroadPhaseCastResult::Reset
void Reset()
Reset this result so it can be reused for a new cast.
Definition: CastResult.h:22

BroadPhaseCastResult::mBodyID
BodyID mBodyID
Body that was hit.
Definition: CastResult.h:24

RayCastResult
Specialization of cast result against a shape.
Definition: CastResult.h:30

RayCastResult::mSubShapeID2
JPH_OVERRIDE_NEW_DELETE SubShapeID mSubShapeID2
Sub shape ID of shape that we collided against.
Definition: CastResult.h:34

SubShapeID
A sub shape id contains a path to an element (usually a triangle or other primitive type) of a compou...
Definition: SubShapeID.h:23