HPL3/Amnesia: Rebirth/Scripting/cFrustum

From Frictional Wiki
Jump to navigation Jump to search

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.

Functions

Return Type Function And Description
bool CheckAABBNearPlaneIntersection(const cVector3f &in avMin, const cVector3f &in avMax)
bool CheckBVNearPlaneIntersection(cBoundingVolume@+ aBV)
bool CheckFrustumNearPlaneIntersection(cFrustum@+ aFrustum)
bool CheckLineIntersection(const cVector3f &in avStart, const cVector3f &in avEnd, cVector3f &in avIntersection)
bool CheckPyramidNearPlaneIntersection(cFrustum@+ aFrustum)
bool CheckSphereNearPlaneIntersection(const cVector3f &in avCenter, float afRadius)
eCollision CollideAABB(const cVector3f &in avMin, const cVector3f &in avMax, int alMaxPlanes)
eCollision CollideBoundingVolume(cBoundingVolume@+ apBV)
eCollision CollideFrustum(cFrustum@+ apFrustum)
eCollision CollideFustrumSphere(const cVector3f &in avCenter, float afRadius)
bool CollidePoint(const cVector3f &in avPoint)
eCollision CollideSphere(const cVector3f &in avCenter, float afRadius, int alMaxPlanes)
float GetAspect()
cBoundingVolume GetBoundingVolume()
float GetFarPlane()
cVector3f GetForward()
float GetFOV()
bool GetInfFarPlane()
bool GetInvertsCullMode()
float GetNearPlane()
cVector3f GetOrigin()
cBoundingVolume GetOriginBV()
cVector2f GetOrthoViewSize()
cPlanef GetPlane(eFrustumPlane aType)
cMatrixf GetProjectionMatrix()
eProjectionType GetProjectionType()
cVector3f GetVertex(int alIdx)
cMatrixf GetViewMatrix()
void SetInvertsCullMode(bool abX)
void SetupOrthoProj(const cMatrixf &in a_mtxProj, const cMatrixf &in a_mtxView, float afFarPlane, float afNearPlane, const cVector2f &in avViewSize, const cVector3f &in avOrigin)
void SetupPerspectiveProj(const cMatrixf &in a_mtxProj, const cMatrixf &in a_mtxView, float afFarPlane, float afNearPlane, float afFOV, float afAspect, const cVector3f &in avOrigin)

Details

CheckAABBNearPlaneIntersection

bool CheckAABBNearPlaneIntersection(const cVector3f &in avMin,
                                    const cVector3f &in avMax)


Parameters

Returns:

  • bool

CheckBVNearPlaneIntersection

bool CheckBVNearPlaneIntersection(cBoundingVolume@+ aBV)


Parameters

Returns:

  • bool

CheckFrustumNearPlaneIntersection

bool CheckFrustumNearPlaneIntersection(cFrustum@+ aFrustum)


Parameters

Returns:

  • bool

CheckLineIntersection

bool CheckLineIntersection(const cVector3f &in avStart,
                           const cVector3f &in avEnd,
                           cVector3f &in avIntersection)


Parameters

Returns:

  • bool

CheckPyramidNearPlaneIntersection

bool CheckPyramidNearPlaneIntersection(cFrustum@+ aFrustum)


Parameters

Returns:

  • bool

CheckSphereNearPlaneIntersection

bool CheckSphereNearPlaneIntersection(const cVector3f &in avCenter,
                                      float afRadius)


Parameters

  • avCenter (cVector3f) —
  • afRadius (float) —

Returns:

  • bool

CollideAABB

eCollision CollideAABB(const cVector3f &in avMin,
                       const cVector3f &in avMax,
                       int alMaxPlanes)


Parameters

Returns:

  • eCollision

CollideBoundingVolume

eCollision CollideBoundingVolume(cBoundingVolume@+ apBV)


Parameters

Returns:

  • eCollision

CollideFrustum

eCollision CollideFrustum(cFrustum@+ apFrustum)


Parameters

Returns:

  • eCollision

CollideFustrumSphere

eCollision CollideFustrumSphere(const cVector3f &in avCenter,
                                float afRadius)


Parameters

  • avCenter (cVector3f) —
  • afRadius (float) —

Returns:

  • eCollision

CollidePoint

bool CollidePoint(const cVector3f &in avPoint)


Parameters

Returns:

  • bool

CollideSphere

eCollision CollideSphere(const cVector3f &in avCenter,
                         float afRadius,
                         int alMaxPlanes)


Parameters

  • avCenter (cVector3f) —
  • afRadius (float) —
  • alMaxPlanes (int) —

Returns:

  • eCollision

GetAspect

float GetAspect()

Returns:

  • float

GetBoundingVolume

const cBoundingVolume@+ GetBoundingVolume()

Returns:

  • const cBoundingVolume@+

GetFarPlane

float GetFarPlane()

Returns:

  • float

GetForward

cVector3f GetForward()

Returns:

  • cVector3f

GetFOV

float GetFOV()

Returns:

  • float

GetInfFarPlane

bool GetInfFarPlane()

Returns:

  • bool

GetInvertsCullMode

bool GetInvertsCullMode()

Returns:

  • bool

GetNearPlane

float GetNearPlane()

Returns:

  • float

GetOrigin

const cVector3f& GetOrigin()

Returns:

  • const cVector3f&

GetOriginBV

cBoundingVolume@+ GetOriginBV()

Returns:

  • cBoundingVolume@+

GetOrthoViewSize

const cVector2f& GetOrthoViewSize()

Returns:

  • const cVector2f&

GetPlane

const cPlanef& GetPlane(eFrustumPlane aType)


Parameters

Returns:

  • const cPlanef&

GetProjectionMatrix

const cMatrixf& GetProjectionMatrix()

Returns:

  • const cMatrixf&

GetProjectionType

eProjectionType GetProjectionType()

Returns:

  • eProjectionType

GetVertex

const cVector3f& GetVertex(int alIdx)


Parameters

  • alIdx (int) —

Returns:

  • const cVector3f&

GetViewMatrix

const cMatrixf& GetViewMatrix()

Returns:

  • const cMatrixf&

SetInvertsCullMode

void SetInvertsCullMode(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetupOrthoProj

void SetupOrthoProj(const cMatrixf &in a_mtxProj,
                    const cMatrixf &in a_mtxView,
                    float afFarPlane,
                    float afNearPlane,
                    const cVector2f &in avViewSize,
                    const cVector3f &in avOrigin)


Parameters

Returns:

  • void

SetupPerspectiveProj

void SetupPerspectiveProj(const cMatrixf &in a_mtxProj,
                          const cMatrixf &in a_mtxView,
                          float afFarPlane,
                          float afNearPlane,
                          float afFOV,
                          float afAspect,
                          const cVector3f &in avOrigin)


Parameters

  • a_mtxProj (cMatrixf) —
  • a_mtxView (cMatrixf) —
  • afFarPlane (float) —
  • afNearPlane (float) —
  • afFOV (float) —
  • afAspect (float) —
  • avOrigin (cVector3f) —

Returns:

  • void

References

See all references...