Overload  1.1
Game engine with editor
Public Member Functions | List of all members
OvCore::ECS::Components::CCamera Class Reference

#include <CCamera.h>

Inheritance diagram for OvCore::ECS::Components::CCamera:
OvCore::ECS::Components::AComponent OvCore::API::IInspectorItem OvCore::API::ISerializable

Public Member Functions

 CCamera (ECS::Actor &p_owner)
 
 ~CCamera ()
 
std::string GetName () override
 
void SetFov (float p_value)
 
void SetNear (float p_value)
 
void SetFar (float p_value)
 
void SetClearColor (const OvMaths::FVector3 &p_clearColor)
 
void SetFrustumGeometryCulling (bool p_enable)
 
void SetFrustumLightCulling (bool p_enable)
 
float GetFov () const
 
float GetNear () const
 
float GetFar () const
 
const OvMaths::FVector3GetClearColor () const
 
bool HasFrustumGeometryCulling () const
 
bool HasFrustumLightCulling () const
 
OvRendering::LowRenderer::CameraGetCamera ()
 
virtual void OnSerialize (tinyxml2::XMLDocument &p_doc, tinyxml2::XMLNode *p_node) override
 
virtual void OnDeserialize (tinyxml2::XMLDocument &p_doc, tinyxml2::XMLNode *p_node) override
 
virtual void OnInspector (OvUI::Internal::WidgetContainer &p_root) override
 
- Public Member Functions inherited from OvCore::ECS::Components::AComponent
 AComponent (ECS::Actor &p_owner)
 
virtual ~AComponent ()
 
virtual void OnAwake ()
 
virtual void OnStart ()
 
virtual void OnEnable ()
 
virtual void OnDisable ()
 
virtual void OnDestroy ()
 
virtual void OnUpdate (float p_deltaTime)
 
virtual void OnFixedUpdate (float p_deltaTime)
 
virtual void OnLateUpdate (float p_deltaTime)
 
virtual void OnCollisionEnter (Components::CPhysicalObject &p_otherObject)
 
virtual void OnCollisionStay (Components::CPhysicalObject &p_otherObject)
 
virtual void OnCollisionExit (Components::CPhysicalObject &p_otherObject)
 
virtual void OnTriggerEnter (Components::CPhysicalObject &p_otherObject)
 
virtual void OnTriggerStay (Components::CPhysicalObject &p_otherObject)
 
virtual void OnTriggerExit (Components::CPhysicalObject &p_otherObject)
 

Additional Inherited Members

- Public Attributes inherited from OvCore::ECS::Components::AComponent
ECS::Actorowner
 

Detailed Description

Represents a camera entity. Its position will determine its view matrix

Constructor & Destructor Documentation

◆ CCamera()

OvCore::ECS::Components::CCamera::CCamera ( ECS::Actor p_owner)

Constructor

Parameters
p_owner@project: Overload
Author
: Overload Tech. @restrictions: This software may not be resold, redistributed or otherwise conveyed to a third party.

◆ ~CCamera()

OvCore::ECS::Components::CCamera::~CCamera ( )

Destructor

Member Function Documentation

◆ GetCamera()

OvRendering::LowRenderer::Camera & OvCore::ECS::Components::CCamera::GetCamera ( )

Returns the OvRendering camera instance attached to this component

◆ GetClearColor()

const OvMaths::FVector3 & OvCore::ECS::Components::CCamera::GetClearColor ( ) const

Returns the clear color of the camera

◆ GetFar()

float OvCore::ECS::Components::CCamera::GetFar ( ) const

Returns the far of the camera

◆ GetFov()

float OvCore::ECS::Components::CCamera::GetFov ( ) const

Returns the fov of the camera

◆ GetName()

std::string OvCore::ECS::Components::CCamera::GetName ( )
overridevirtual

Returns the name of the component

Implements OvCore::ECS::Components::AComponent.

◆ GetNear()

float OvCore::ECS::Components::CCamera::GetNear ( ) const

Returns the near of the camera

◆ HasFrustumGeometryCulling()

bool OvCore::ECS::Components::CCamera::HasFrustumGeometryCulling ( ) const

Returns true if the frustum geometry culling is enabled

◆ HasFrustumLightCulling()

bool OvCore::ECS::Components::CCamera::HasFrustumLightCulling ( ) const

Returns true if the frustum light culling is enabled

◆ OnDeserialize()

void OvCore::ECS::Components::CCamera::OnDeserialize ( tinyxml2::XMLDocument &  p_doc,
tinyxml2::XMLNode *  p_node 
)
overridevirtual

Deserialize the component

Parameters
p_doc
p_node

Implements OvCore::API::ISerializable.

◆ OnInspector()

void OvCore::ECS::Components::CCamera::OnInspector ( OvUI::Internal::WidgetContainer p_root)
overridevirtual

Defines how the component should be drawn in the inspector

Parameters
p_root

Implements OvCore::API::IInspectorItem.

◆ OnSerialize()

void OvCore::ECS::Components::CCamera::OnSerialize ( tinyxml2::XMLDocument &  p_doc,
tinyxml2::XMLNode *  p_node 
)
overridevirtual

Serialize the component

Parameters
p_doc
p_node

Implements OvCore::API::ISerializable.

◆ SetClearColor()

void OvCore::ECS::Components::CCamera::SetClearColor ( const OvMaths::FVector3 p_clearColor)

Sets the clear color of the camera to the given value

Parameters
p_value

◆ SetFar()

void OvCore::ECS::Components::CCamera::SetFar ( float  p_value)

Sets the far of the camera to the given value

Parameters
p_value

◆ SetFov()

void OvCore::ECS::Components::CCamera::SetFov ( float  p_value)

Sets the fov of the camera to the given value

Parameters
p_value

◆ SetFrustumGeometryCulling()

void OvCore::ECS::Components::CCamera::SetFrustumGeometryCulling ( bool  p_enable)

Defines if the camera should apply frustum geometry culling in rendering

Parameters
p_enable

◆ SetFrustumLightCulling()

void OvCore::ECS::Components::CCamera::SetFrustumLightCulling ( bool  p_enable)

Defines if the camera should apply frustum light culling in rendering

Parameters
p_enable

◆ SetNear()

void OvCore::ECS::Components::CCamera::SetNear ( float  p_value)

Sets the near of the camera to the given value

Parameters
p_value

The documentation for this class was generated from the following files: