https://wiki.frictionalgames.com/page?action=history&feed=atom&title=HPL3%2FAmnesia%3A_Rebirth%2FScripting%2FcFrustum
HPL3/Amnesia: Rebirth/Scripting/cFrustum - Revision history
2026-05-01T15:01:11Z
Revision history for this page on the wiki
MediaWiki 1.34.2
https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/cFrustum&diff=5696&oldid=prev
Abion47: Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Fields== cFrustum has no public fields. ==Function..."
2020-11-15T21:09:22Z
<p>Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Fields== cFrustum has no public fields. ==Function..."</p>
<p><b>New page</b></p><div>{{ScriptingStub}}<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!<br />
<br />
==Fields==<br />
cFrustum has no public fields.<br />
<br />
==Functions==<br />
{{CodeDocSummaryTop|Return Type|Function And Description}}<br />
{{CodeDocSummaryItem|bool|[[#CheckAABBNearPlaneIntersection|CheckAABBNearPlaneIntersection]](const [[../cVector3f|cVector3f]] &in avMin, const [[../cVector3f|cVector3f]] &in avMax)|}}<br />
{{CodeDocSummaryItem|bool|[[#CheckBVNearPlaneIntersection|CheckBVNearPlaneIntersection]]([[../cBoundingVolume|cBoundingVolume@+]] aBV)|}}<br />
{{CodeDocSummaryItem|bool|[[#CheckFrustumNearPlaneIntersection|CheckFrustumNearPlaneIntersection]]([[../cFrustum|cFrustum@+]] aFrustum)|}}<br />
{{CodeDocSummaryItem|bool|[[#CheckLineIntersection|CheckLineIntersection]](const [[../cVector3f|cVector3f]] &in avStart, const [[../cVector3f|cVector3f]] &in avEnd, [[../cVector3f|cVector3f]] &in avIntersection)|}}<br />
{{CodeDocSummaryItem|bool|[[#CheckPyramidNearPlaneIntersection|CheckPyramidNearPlaneIntersection]]([[../cFrustum|cFrustum@+]] aFrustum)|}}<br />
{{CodeDocSummaryItem|bool|[[#CheckSphereNearPlaneIntersection|CheckSphereNearPlaneIntersection]](const [[../cVector3f|cVector3f]] &in avCenter, float afRadius)|}}<br />
{{CodeDocSummaryItem|[[../eCollision|eCollision]]|[[#CollideAABB|CollideAABB]](const [[../cVector3f|cVector3f]] &in avMin, const [[../cVector3f|cVector3f]] &in avMax, int alMaxPlanes)|}}<br />
{{CodeDocSummaryItem|[[../eCollision|eCollision]]|[[#CollideBoundingVolume|CollideBoundingVolume]]([[../cBoundingVolume|cBoundingVolume@+]] apBV)|}}<br />
{{CodeDocSummaryItem|[[../eCollision|eCollision]]|[[#CollideFrustum|CollideFrustum]]([[../cFrustum|cFrustum@+]] apFrustum)|}}<br />
{{CodeDocSummaryItem|[[../eCollision|eCollision]]|[[#CollideFustrumSphere|CollideFustrumSphere]](const [[../cVector3f|cVector3f]] &in avCenter, float afRadius)|}}<br />
{{CodeDocSummaryItem|bool|[[#CollidePoint|CollidePoint]](const [[../cVector3f|cVector3f]] &in avPoint)|}}<br />
{{CodeDocSummaryItem|[[../eCollision|eCollision]]|[[#CollideSphere|CollideSphere]](const [[../cVector3f|cVector3f]] &in avCenter, float afRadius, int alMaxPlanes)|}}<br />
{{CodeDocSummaryItem|float|[[#GetAspect|GetAspect]]()|}}<br />
{{CodeDocSummaryItem|[[../cBoundingVolume|cBoundingVolume]]|[[#GetBoundingVolume|GetBoundingVolume]]()|}}<br />
{{CodeDocSummaryItem|float|[[#GetFarPlane|GetFarPlane]]()|}}<br />
{{CodeDocSummaryItem|[[../cVector3f|cVector3f]]|[[#GetForward|GetForward]]()|}}<br />
{{CodeDocSummaryItem|float|[[#GetFOV|GetFOV]]()|}}<br />
{{CodeDocSummaryItem|bool|[[#GetInfFarPlane|GetInfFarPlane]]()|}}<br />
{{CodeDocSummaryItem|bool|[[#GetInvertsCullMode|GetInvertsCullMode]]()|}}<br />
{{CodeDocSummaryItem|float|[[#GetNearPlane|GetNearPlane]]()|}}<br />
{{CodeDocSummaryItem|[[../cVector3f|cVector3f]]|[[#GetOrigin|GetOrigin]]()|}}<br />
{{CodeDocSummaryItem|[[../cBoundingVolume|cBoundingVolume]]|[[#GetOriginBV|GetOriginBV]]()|}}<br />
{{CodeDocSummaryItem|[[../cVector2f|cVector2f]]|[[#GetOrthoViewSize|GetOrthoViewSize]]()|}}<br />
{{CodeDocSummaryItem|[[../cPlanef|cPlanef]]|[[#GetPlane|GetPlane]]([[../eFrustumPlane|eFrustumPlane]] aType)|}}<br />
{{CodeDocSummaryItem|[[../cMatrixf|cMatrixf]]|[[#GetProjectionMatrix|GetProjectionMatrix]]()|}}<br />
{{CodeDocSummaryItem|[[../eProjectionType|eProjectionType]]|[[#GetProjectionType|GetProjectionType]]()|}}<br />
{{CodeDocSummaryItem|[[../cVector3f|cVector3f]]|[[#GetVertex|GetVertex]](int alIdx)|}}<br />
{{CodeDocSummaryItem|[[../cMatrixf|cMatrixf]]|[[#GetViewMatrix|GetViewMatrix]]()|}}<br />
{{CodeDocSummaryItem|void|[[#SetInvertsCullMode|SetInvertsCullMode]](bool abX)|}}<br />
{{CodeDocSummaryItem|void|[[#SetupOrthoProj|SetupOrthoProj]](const [[../cMatrixf|cMatrixf]] &in a_mtxProj, const [[../cMatrixf|cMatrixf]] &in a_mtxView, float afFarPlane, float afNearPlane, const [[../cVector2f|cVector2f]] &in avViewSize, const [[../cVector3f|cVector3f]] &in avOrigin)|}}<br />
{{CodeDocSummaryItem|void|[[#SetupPerspectiveProj|SetupPerspectiveProj]](const [[../cMatrixf|cMatrixf]] &in a_mtxProj, const [[../cMatrixf|cMatrixf]] &in a_mtxView, float afFarPlane, float afNearPlane, float afFOV, float afAspect, const [[../cVector3f|cVector3f]] &in avOrigin)|}}<br />
{{CodeDocSummaryBottom}}<br />
<br />
==Details==<br />
{{CodeDocDetailTop|CheckAABBNearPlaneIntersection}}<br />
<syntaxhighlight lang="c++">bool CheckAABBNearPlaneIntersection(const cVector3f &in avMin,<br />
const cVector3f &in avMax)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|avMin|[[../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailParam|avMax|[[../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|CheckBVNearPlaneIntersection}}<br />
<syntaxhighlight lang="c++">bool CheckBVNearPlaneIntersection(cBoundingVolume@+ aBV)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|aBV|[[../cBoundingVolume|cBoundingVolume@+]]|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|CheckFrustumNearPlaneIntersection}}<br />
<syntaxhighlight lang="c++">bool CheckFrustumNearPlaneIntersection(cFrustum@+ aFrustum)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|aFrustum|[[../cFrustum|cFrustum@+]]|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|CheckLineIntersection}}<br />
<syntaxhighlight lang="c++">bool CheckLineIntersection(const cVector3f &in avStart,<br />
const cVector3f &in avEnd,<br />
cVector3f &in avIntersection)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|avStart|[[../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailParam|avEnd|[[../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailParam|avIntersection|[[../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|CheckPyramidNearPlaneIntersection}}<br />
<syntaxhighlight lang="c++">bool CheckPyramidNearPlaneIntersection(cFrustum@+ aFrustum)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|aFrustum|[[../cFrustum|cFrustum@+]]|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|CheckSphereNearPlaneIntersection}}<br />
<syntaxhighlight lang="c++">bool CheckSphereNearPlaneIntersection(const cVector3f &in avCenter,<br />
float afRadius)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|avCenter|[[../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailParam|afRadius|float|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|CollideAABB}}<br />
<syntaxhighlight lang="c++">eCollision CollideAABB(const cVector3f &in avMin,<br />
const cVector3f &in avMax,<br />
int alMaxPlanes)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|avMin|[[../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailParam|avMax|[[../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailParam|alMaxPlanes|int|}}<br />
{{CodeDocDetailReturn|eCollision|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|CollideBoundingVolume}}<br />
<syntaxhighlight lang="c++">eCollision CollideBoundingVolume(cBoundingVolume@+ apBV)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|apBV|[[../cBoundingVolume|cBoundingVolume@+]]|}}<br />
{{CodeDocDetailReturn|eCollision|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|CollideFrustum}}<br />
<syntaxhighlight lang="c++">eCollision CollideFrustum(cFrustum@+ apFrustum)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|apFrustum|[[../cFrustum|cFrustum@+]]|}}<br />
{{CodeDocDetailReturn|eCollision|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|CollideFustrumSphere}}<br />
<syntaxhighlight lang="c++">eCollision CollideFustrumSphere(const cVector3f &in avCenter,<br />
float afRadius)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|avCenter|[[../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailParam|afRadius|float|}}<br />
{{CodeDocDetailReturn|eCollision|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|CollidePoint}}<br />
<syntaxhighlight lang="c++">bool CollidePoint(const cVector3f &in avPoint)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|avPoint|[[../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|CollideSphere}}<br />
<syntaxhighlight lang="c++">eCollision CollideSphere(const cVector3f &in avCenter,<br />
float afRadius,<br />
int alMaxPlanes)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|avCenter|[[../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailParam|afRadius|float|}}<br />
{{CodeDocDetailParam|alMaxPlanes|int|}}<br />
{{CodeDocDetailReturn|eCollision|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetAspect}}<br />
<syntaxhighlight lang="c++">float GetAspect()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetBoundingVolume}}<br />
<syntaxhighlight lang="c++">const cBoundingVolume@+ GetBoundingVolume()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|const cBoundingVolume@+|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetFarPlane}}<br />
<syntaxhighlight lang="c++">float GetFarPlane()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetForward}}<br />
<syntaxhighlight lang="c++">cVector3f GetForward()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|cVector3f|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetFOV}}<br />
<syntaxhighlight lang="c++">float GetFOV()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetInfFarPlane}}<br />
<syntaxhighlight lang="c++">bool GetInfFarPlane()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetInvertsCullMode}}<br />
<syntaxhighlight lang="c++">bool GetInvertsCullMode()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetNearPlane}}<br />
<syntaxhighlight lang="c++">float GetNearPlane()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetOrigin}}<br />
<syntaxhighlight lang="c++">const cVector3f& GetOrigin()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|const cVector3f&|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetOriginBV}}<br />
<syntaxhighlight lang="c++">cBoundingVolume@+ GetOriginBV()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|cBoundingVolume@+|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetOrthoViewSize}}<br />
<syntaxhighlight lang="c++">const cVector2f& GetOrthoViewSize()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|const cVector2f&|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetPlane}}<br />
<syntaxhighlight lang="c++">const cPlanef& GetPlane(eFrustumPlane aType)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|aType|[[../eFrustumPlane|eFrustumPlane]]|}}<br />
{{CodeDocDetailReturn|const cPlanef&|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetProjectionMatrix}}<br />
<syntaxhighlight lang="c++">const cMatrixf& GetProjectionMatrix()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|const cMatrixf&|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetProjectionType}}<br />
<syntaxhighlight lang="c++">eProjectionType GetProjectionType()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|eProjectionType|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetVertex}}<br />
<syntaxhighlight lang="c++">const cVector3f& GetVertex(int alIdx)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|alIdx|int|}}<br />
{{CodeDocDetailReturn|const cVector3f&|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetViewMatrix}}<br />
<syntaxhighlight lang="c++">const cMatrixf& GetViewMatrix()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|const cMatrixf&|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetInvertsCullMode}}<br />
<syntaxhighlight lang="c++">void SetInvertsCullMode(bool abX)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|abX|bool|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetupOrthoProj}}<br />
<syntaxhighlight lang="c++">void SetupOrthoProj(const cMatrixf &in a_mtxProj,<br />
const cMatrixf &in a_mtxView,<br />
float afFarPlane,<br />
float afNearPlane,<br />
const cVector2f &in avViewSize,<br />
const cVector3f &in avOrigin)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|a_mtxProj|[[../cMatrixf|cMatrixf]]|}}<br />
{{CodeDocDetailParam|a_mtxView|[[../cMatrixf|cMatrixf]]|}}<br />
{{CodeDocDetailParam|afFarPlane|float|}}<br />
{{CodeDocDetailParam|afNearPlane|float|}}<br />
{{CodeDocDetailParam|avViewSize|[[../cVector2f|cVector2f]]|}}<br />
{{CodeDocDetailParam|avOrigin|[[../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetupPerspectiveProj}}<br />
<syntaxhighlight lang="c++">void SetupPerspectiveProj(const cMatrixf &in a_mtxProj,<br />
const cMatrixf &in a_mtxView,<br />
float afFarPlane,<br />
float afNearPlane,<br />
float afFOV,<br />
float afAspect,<br />
const cVector3f &in avOrigin)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|a_mtxProj|[[../cMatrixf|cMatrixf]]|}}<br />
{{CodeDocDetailParam|a_mtxView|[[../cMatrixf|cMatrixf]]|}}<br />
{{CodeDocDetailParam|afFarPlane|float|}}<br />
{{CodeDocDetailParam|afNearPlane|float|}}<br />
{{CodeDocDetailParam|afFOV|float|}}<br />
{{CodeDocDetailParam|afAspect|float|}}<br />
{{CodeDocDetailParam|avOrigin|[[../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{ReferencesSection}}<br />
<br />
{{HPL3SOMAScriptingCategories}}</div>
Abion47