Skip to content

Fix getElementBoundingBox/radius for engineRequestModel custom models (#4925) #5003

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
QueryOfficial wants to merge 3 commits into
base: master
Choose a base branch
from
+192 −0
Open

Fix getElementBoundingBox/radius for engineRequestModel custom models (#4925) #5003

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8a0f93a
Add collision model management and bounds updating in CModelInfoSA
QueryOfficial Jul 4, 2026
ef19a46
Merge branch 'master' into fix/custom-model-element-bounds
QueryOfficial Jul 5, 2026
64b949c
Refactor CModelInfoSA.cpp for improved readability
QueryOfficial Jul 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
188 changes: 188 additions & 0 deletions Client/game_sa/CModelInfoSA.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,13 +90,136 @@ static void CColAccel_addCacheCol(int idx, const CColModelSAInterface* colModel)
function(idx, colModel);
}

namespace
{
CColModelSAInterface* CreateOwnedColModelCopy(CColModelSAInterface* pSource)
{
if (!pSource)
return nullptr;

CColModelSAInterface* pOwned = new CColModelSAInterface();
const DWORD dwThis = reinterpret_cast<DWORD>(pOwned);
const DWORD dwFunc = FUNC_CColModel_Constructor;
// clang-format off
__asm
{
mov ecx, dwThis
call dwFunc
}
// clang-format on

// Copy only the bounding data from the parent. Collision geometry must not be shared
// because custom model bounds are updated independently after DFF replacement.
pOwned->m_bounds = pSource->m_bounds;
pOwned->m_sphere = pSource->m_sphere;
pOwned->m_data = nullptr;
return pOwned;
}

void DestroyColModelInterface(CColModelSAInterface* pColModel)
{
if (!pColModel)
return;

const DWORD dwThis = reinterpret_cast<DWORD>(pColModel);
const DWORD dwFunc = FUNC_CColModel_Destructor;
// clang-format off
__asm
{
mov ecx, dwThis
call dwFunc
}
// clang-format on
delete pColModel;
}

struct SBoundsAccum
{
bool bValid = false;
CVector vecMin;
CVector vecMax;
};

void IncludeSphereInBounds(SBoundsAccum& accum, const CVector& vecCenter, float fRadius)
{
if (fRadius <= 0.0f)
return;

const CVector vecSphereMin = vecCenter - CVector(fRadius, fRadius, fRadius);
const CVector vecSphereMax = vecCenter + CVector(fRadius, fRadius, fRadius);

if (!accum.bValid)
{
accum.vecMin = vecSphereMin;
accum.vecMax = vecSphereMax;
accum.bValid = true;
return;
}

accum.vecMin.fX = std::min(accum.vecMin.fX, vecSphereMin.fX);
accum.vecMin.fY = std::min(accum.vecMin.fY, vecSphereMin.fY);
accum.vecMin.fZ = std::min(accum.vecMin.fZ, vecSphereMin.fZ);
accum.vecMax.fX = std::max(accum.vecMax.fX, vecSphereMax.fX);
accum.vecMax.fY = std::max(accum.vecMax.fY, vecSphereMax.fY);
accum.vecMax.fZ = std::max(accum.vecMax.fZ, vecSphereMax.fZ);
}

float GetMatrixMaxScale(const CMatrix& matrix)
{
const CVector vecScale = matrix.GetScale();
return std::max({vecScale.fX, vecScale.fY, vecScale.fZ});
}

bool AccumulateAtomicBounds(RpAtomic* pAtomic, void* pData)
{
if (!pAtomic || !pAtomic->geometry)
return true;

RwSphere* pSphere = RpAtomicGetBoundingSphere(pAtomic);
if (!pSphere || pSphere->radius <= 0.0f)
return true;

CMatrix matrixLTM;
RwFrame* pFrame = RpAtomicGetFrame(pAtomic);
if (pFrame)
pGame->GetRenderWare()->RwMatrixToCMatrix(pFrame->ltm, matrixLTM);

const CVector vecCenter = matrixLTM.TransformVector(CVector(pSphere->position.x, pSphere->position.y, pSphere->position.z));
const float fRadius = pSphere->radius * GetMatrixMaxScale(matrixLTM);

IncludeSphereInBounds(*static_cast<SBoundsAccum*>(pData), vecCenter, fRadius);
return true;
}

bool AccumulateRwObjectBounds(RwObject* pRwObject, SBoundsAccum& accum)
{
if (!pRwObject)
return false;

if (pRwObject->type == RP_TYPE_CLUMP)
{
RpClumpForAllAtomics(reinterpret_cast<RpClump*>(pRwObject), AccumulateAtomicBounds, &accum);
return accum.bValid;
}

if (pRwObject->type == RP_TYPE_ATOMIC)
{
AccumulateAtomicBounds(reinterpret_cast<RpAtomic*>(pRwObject), &accum);
return accum.bValid;
}

return false;
}
} // namespace

CModelInfoSA::CModelInfoSA()
{
m_pInterface = NULL;
m_dwModelID = 0xFFFFFFFF;
m_dwReferences = 0;
m_dwPendingInterfaceRef = 0;
m_pOriginalColModelInterface = NULL;
m_pOwnedColModel = NULL;
m_pCustomClump = NULL;
m_pCustomColModel = NULL;
}
Expand Down Expand Up @@ -1578,6 +1701,9 @@ bool CModelInfoSA::SetCustomModel(RpClump* pClump)
}

m_pCustomClump = success ? pClump : nullptr;
if (success)
UpdateBoundsFromRwObject();

return success;
}

Expand Down Expand Up @@ -1849,6 +1975,56 @@ void CModelInfoSA::CopyStreamingInfoFromModel(ushort usBaseModelID)
pTargetModelStreamingInfo->sizeInBlocks = pBaseModelStreamingInfo->sizeInBlocks;
}

void CModelInfoSA::CloneParentColModel(CBaseModelInfoSAInterface* pInterface)
{
if (!pInterface || !pInterface->pColModel)
return;

DestroyOwnedColModel();

m_pOwnedColModel = CreateOwnedColModelCopy(pInterface->pColModel);
pInterface->pColModel = m_pOwnedColModel;
}

void CModelInfoSA::DestroyOwnedColModel()
{
if (!m_pOwnedColModel)
return;

CBaseModelInfoSAInterface* pInterface = ppModelInfo[m_dwModelID];
if (pInterface && pInterface->pColModel == m_pOwnedColModel)
pInterface->pColModel = nullptr;

DestroyColModelInterface(m_pOwnedColModel);
m_pOwnedColModel = nullptr;
}

void CModelInfoSA::UpdateBoundsFromRwObject()
{
// Custom collision data is authoritative when supplied by script.
if (m_pCustomColModel)
return;

CBaseModelInfoSAInterface* pInterface = GetInterface();
if (!pInterface || !pInterface->pColModel || !pInterface->pRwObject)
return;

SBoundsAccum accum;
if (!AccumulateRwObjectBounds(pInterface->pRwObject, accum))
return;

CColModelSAInterface* pColModel = pInterface->pColModel;
const CVector vecCenter = (accum.vecMin + accum.vecMax) * 0.5f;
const CVector vecHalfSize = (accum.vecMax - accum.vecMin) * 0.5f;

pColModel->m_bounds.m_vecMin = accum.vecMin;
pColModel->m_bounds.m_vecMax = accum.vecMax;
pColModel->m_sphere.m_center = vecCenter;
pColModel->m_sphere.m_radius = vecHalfSize.Length();

CColAccel_addCacheCol(static_cast<int>(m_dwModelID), pColModel);
}

void CModelInfoSA::MakePedModel(const char* szTexture)
{
// Create a new CPedModelInfo
Expand Down Expand Up @@ -1876,6 +2052,8 @@ void CModelInfoSA::MakeObjectModel(ushort usBaseID)

ppModelInfo[m_dwModelID] = m_pInterface;

CloneParentColModel(m_pInterface);

m_dwParentID = usBaseID;
CopyStreamingInfoFromModel(usBaseID);
}
Expand All @@ -1894,6 +2072,8 @@ void CModelInfoSA::MakeObjectDamageableModel(std::uint16_t baseModel)

ppModelInfo[m_dwModelID] = m_pInterface;

CloneParentColModel(m_pInterface);

m_dwParentID = baseModel;
CopyStreamingInfoFromModel(baseModel);
}
Expand All @@ -1912,6 +2092,8 @@ void CModelInfoSA::MakeTimedObjectModel(ushort usBaseID)

ppModelInfo[m_dwModelID] = m_pInterface;

CloneParentColModel(m_pInterface);

m_dwParentID = usBaseID;
CopyStreamingInfoFromModel(usBaseID);
}
Expand All @@ -1928,6 +2110,8 @@ void CModelInfoSA::MakeClumpModel(ushort usBaseID)

ppModelInfo[m_dwModelID] = pNewInterface;

CloneParentColModel(pNewInterface);

m_dwParentID = usBaseID;
CopyStreamingInfoFromModel(usBaseID);
}
Expand All @@ -1946,6 +2130,8 @@ void CModelInfoSA::MakeVehicleAutomobile(ushort usBaseID)

ppModelInfo[m_dwModelID] = m_pInterface;

CloneParentColModel(m_pInterface);

m_dwParentID = usBaseID;
CopyStreamingInfoFromModel(usBaseID);
}
Expand All @@ -1954,6 +2140,8 @@ void CModelInfoSA::DeallocateModel(void)
{
Remove();

DestroyOwnedColModel();

// Clean up stored defaults so stale entries don't leak to a model that reuses this ID.
// Without this, a freed model ID could retain alpha transparency / flag overrides
// that get incorrectly restored later, causing wrong draw-order or z-buffer behavior.
Expand Down
4 changes: 4 additions & 0 deletions Client/game_sa/CModelInfoSA.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,7 @@ class CModelInfoSA : public CModelInfo
DWORD m_dwReferences;
DWORD m_dwPendingInterfaceRef;
CColModel* m_pCustomColModel;
CColModelSAInterface* m_pOwnedColModel;
CColModelSAInterface* m_pOriginalColModelInterface;
std::uint16_t m_originalFlags = 0;
RpClump* m_pCustomClump;
Expand Down Expand Up @@ -499,6 +500,9 @@ class CModelInfoSA : public CModelInfo

private:
void CopyStreamingInfoFromModel(ushort usCopyFromModelID);
void CloneParentColModel(CBaseModelInfoSAInterface* pInterface);
void DestroyOwnedColModel();
void UpdateBoundsFromRwObject();
void RwSetSupportedUpgrades(RwFrame* parent, DWORD dwModel);
void SetModelSpecialType(eModelSpecialType eType, bool bState);
};
Loading