HPL3/Amnesia: Rebirth/Scripting/cCamera

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Fields

cCamera has no public fields.

Functions

Return Type	Function And Description
void	AddPitch(float afAngle)
void	AddRoll(float afAngle)
void	AddYaw(float afAngle)
void	AttachEntity(iEntity3D@ aEntity)
void	ClearAttachedEntities()
float	GetAspect()
cNode3D	GetAttachmentNode()
cFrustum	GetExtendedFrustum()
float	GetFarClipPlane()
cVector3f	GetForward()
float	GetFOV()
cFrustum	GetFrustum()
bool	GetInifintiveFarPlane()
cMatrixf	GetMatrix()
cMatrixf	GetMoveMatrix()
eCameraMoveMode	GetMoveMode()
float	GetNearClipPlane()
cVector2f	GetOrthoViewSize()
float	GetPitch()
float	GetPitchMaxLimit()
float	GetPitchMinLimit()
cVector3f	GetPosition()
cMatrixf	GetProjectionMatrix()
eProjectionType	GetProjectionType()
cVector3f	GetRight()
float	GetRoll()
eCameraRotateMode	GetRotateMode()
cMatrixf	GetRotationMatrix()
cVector3f	GetUp()
cVector3f	GetVelocity()
cMatrixf	GetViewMatrix()
float	GetYaw()
float	GetYawMaxLimit()
float	GetYawMinLimit()
void	MoveForward(float afDist)
void	MoveRight(float afDist)
void	MoveUp(float afDist)
void	RemoveEntity(iEntity3D@ aEntity)
void	ResetRotation()
void	SetAspect(float afSpect)
void	SetFarClipPlane(float afX)
void	SetForward(const cVector3f &in avX)
void	SetFOV(float afAngle)
void	SetInifintiveFarPlane(bool abX)
void	SetMoveMode(eCameraMoveMode aMode)
void	SetNearClipPlane(float afX)
void	SetOrthoViewSize(const cVector2f &in avSize)
void	SetPitch(float afAngle)
void	SetPitchLimits(float afMin, float afMax)
void	SetPosition(const cVector3f &in avPos)
void	SetProjectionType(eProjectionType aType)
void	SetRight(const cVector3f &in avX)
void	SetRoll(float afAngle)
void	SetRotateMode(eCameraRotateMode aMode)
void	SetRotationMatrix(const cMatrixf &in a_mtxRot)
void	SetUp(const cVector3f &in avX)
void	SetVelocity(const cVector3f &in avVel)
void	SetYaw(float afAngle)
void	SetYawLimits(float afMin, float afMax)
void	UnProject(cVector3f &out avPosition, cVector3f &out apDirection, const cVector2f &in avScreenPos, const cVector2f &in avVirtualScreenSize)

Details

AddPitch

void AddPitch(float afAngle)

Parameters

• afAngle (float) —

Returns:

• void

AddRoll

void AddRoll(float afAngle)

Parameters

• afAngle (float) —

Returns:

• void

AddYaw

void AddYaw(float afAngle)

Parameters

• afAngle (float) —

Returns:

• void

AttachEntity

void AttachEntity(iEntity3D@ aEntity)

Parameters

• aEntity (iEntity3D@) —

Returns:

• void

ClearAttachedEntities

void ClearAttachedEntities()

Returns:

• void

GetAspect

float GetAspect()

Returns:

• float—

GetAttachmentNode

cNode3D@ GetAttachmentNode()

Returns:

• cNode3D@—

GetExtendedFrustum

cFrustum@+ GetExtendedFrustum()

Returns:

• cFrustum@+—

GetFarClipPlane

float GetFarClipPlane()

Returns:

• float—

GetForward

cVector3f GetForward()

Returns:

• cVector3f—

GetFOV

float GetFOV()

Returns:

• float—

GetFrustum

cFrustum@+ GetFrustum()

Returns:

• cFrustum@+—

GetInifintiveFarPlane

bool GetInifintiveFarPlane()

Returns:

• bool—

GetMatrix

const cMatrixf& GetMatrix()

Returns:

• const cMatrixf&—

GetMoveMatrix

const cMatrixf& GetMoveMatrix()

Returns:

• const cMatrixf&—

GetMoveMode

eCameraMoveMode GetMoveMode()

Returns:

• eCameraMoveMode—

GetNearClipPlane

float GetNearClipPlane()

Returns:

• float—

GetOrthoViewSize

const cVector2f& GetOrthoViewSize()

Returns:

• const cVector2f&—

GetPitch

float GetPitch()

Returns:

• float—

GetPitchMaxLimit

float GetPitchMaxLimit()

Returns:

• float—

GetPitchMinLimit

float GetPitchMinLimit()

Returns:

• float—

GetPosition

const cVector3f& GetPosition()

Returns:

• const cVector3f&—

GetProjectionMatrix

const cMatrixf& GetProjectionMatrix()

Returns:

• const cMatrixf&—

GetProjectionType

eProjectionType GetProjectionType()

Returns:

• eProjectionType—

GetRight

cVector3f GetRight()

Returns:

• cVector3f—

GetRoll

float GetRoll()

Returns:

• float—

GetRotateMode

eCameraRotateMode GetRotateMode()

Returns:

• eCameraRotateMode—

GetRotationMatrix

const cMatrixf& GetRotationMatrix()

Returns:

• const cMatrixf&—

GetUp

cVector3f GetUp()

Returns:

• cVector3f—

GetVelocity

const cVector3f& GetVelocity()

Returns:

• const cVector3f&—

GetViewMatrix

const cMatrixf& GetViewMatrix()

Returns:

• const cMatrixf&—

GetYaw

float GetYaw()

Returns:

• float—

GetYawMaxLimit

float GetYawMaxLimit()

Returns:

• float—

GetYawMinLimit

float GetYawMinLimit()

Returns:

• float—

MoveForward

void MoveForward(float afDist)

Parameters

• afDist (float) —

Returns:

• void

MoveRight

void MoveRight(float afDist)

Parameters

• afDist (float) —

Returns:

• void

MoveUp

void MoveUp(float afDist)

Parameters

• afDist (float) —

Returns:

• void

RemoveEntity

void RemoveEntity(iEntity3D@ aEntity)

Parameters

• aEntity (iEntity3D@) —

Returns:

• void

ResetRotation

void ResetRotation()

Returns:

• void

SetAspect

void SetAspect(float afSpect)

Parameters

• afSpect (float) —

Returns:

• void

SetFarClipPlane

void SetFarClipPlane(float afX)

Parameters

• afX (float) —

Returns:

• void

SetForward

void SetForward(const cVector3f &in avX)

Parameters

• avX (cVector3f) —

Returns:

• void

SetFOV

void SetFOV(float afAngle)

Parameters

• afAngle (float) —

Returns:

• void

SetInifintiveFarPlane

void SetInifintiveFarPlane(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetMoveMode

void SetMoveMode(eCameraMoveMode aMode)

Parameters

• aMode (eCameraMoveMode) —

Returns:

• void

SetNearClipPlane

void SetNearClipPlane(float afX)

Parameters

• afX (float) —

Returns:

• void

SetOrthoViewSize

void SetOrthoViewSize(const cVector2f &in avSize)

Parameters

• avSize (cVector2f) —

Returns:

• void

SetPitch

void SetPitch(float afAngle)

Parameters

• afAngle (float) —

Returns:

• void

SetPitchLimits

void SetPitchLimits(float afMin,
                    float afMax)

Parameters

• afMin (float) —
• afMax (float) —

Returns:

• void

SetPosition

void SetPosition(const cVector3f &in avPos)

Parameters

• avPos (cVector3f) —

Returns:

• void

SetProjectionType

void SetProjectionType(eProjectionType aType)

Parameters

• aType (eProjectionType) —

Returns:

• void

SetRight

void SetRight(const cVector3f &in avX)

Parameters

• avX (cVector3f) —

Returns:

• void

SetRoll

void SetRoll(float afAngle)

Parameters

• afAngle (float) —

Returns:

• void

SetRotateMode

void SetRotateMode(eCameraRotateMode aMode)

Parameters

• aMode (eCameraRotateMode) —

Returns:

• void

SetRotationMatrix

void SetRotationMatrix(const cMatrixf &in a_mtxRot)

Parameters

• a_mtxRot (cMatrixf) —

Returns:

• void

SetUp

void SetUp(const cVector3f &in avX)

Parameters

• avX (cVector3f) —

Returns:

• void

SetVelocity

void SetVelocity(const cVector3f &in avVel)

Parameters

• avVel (cVector3f) —

Returns:

• void

SetYaw

void SetYaw(float afAngle)

Parameters

• afAngle (float) —

Returns:

• void

SetYawLimits

void SetYawLimits(float afMin,
                  float afMax)

Parameters

• afMin (float) —
• afMax (float) —

Returns:

• void

UnProject

void UnProject(cVector3f &out avPosition,
               cVector3f &out apDirection,
               const cVector2f &in avScreenPos,
               const cVector2f &in avVirtualScreenSize)

Parameters

• avPosition (cVector3f) —
• apDirection (cVector3f) —
• avScreenPos (cVector2f) —
• avVirtualScreenSize (cVector2f) —

Returns:

• void

References

• HPL3/Amnesia: Rebirth/Scripting/Scripting Api ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxPlayer ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cViewport ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/iCharacterBody ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cScene ‎ (← links)

See all references...