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

#include <CSpotLight.h>

Inheritance diagram for OvCore::ECS::Components::CSpotLight:
OvCore::ECS::Components::CLight OvCore::ECS::Components::AComponent OvCore::API::IInspectorItem OvCore::API::ISerializable

Public Member Functions

 CSpotLight (ECS::Actor &p_owner)
 
std::string GetName () override
 
float GetConstant () const
 
float GetLinear () const
 
float GetQuadratic () const
 
float GetCutoff () const
 
float GetOuterCutoff () const
 
void SetConstant (float p_constant)
 
void SetLinear (float p_linear)
 
void SetQuadratic (float p_quadratic)
 
void SetCutoff (float p_cutoff)
 
void SetOuterCutoff (float p_outerCutoff)
 
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::CLight
 CLight (ECS::Actor &p_owner)
 
const OvRendering::Entities::LightGetData () const
 
const OvMaths::FVector3GetColor () const
 
float GetIntensity () const
 
void SetColor (const OvMaths::FVector3 &p_color)
 
void SetIntensity (float p_intensity)
 
- 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
 
- Protected Attributes inherited from OvCore::ECS::Components::CLight
OvRendering::Entities::Light m_data
 

Detailed Description

A light that is localized, has attenuation and has a direction

Constructor & Destructor Documentation

◆ CSpotLight()

OvCore::ECS::Components::CSpotLight::CSpotLight ( 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.

Member Function Documentation

◆ GetConstant()

float OvCore::ECS::Components::CSpotLight::GetConstant ( ) const

Returns the light constant

◆ GetCutoff()

float OvCore::ECS::Components::CSpotLight::GetCutoff ( ) const

Returns the light cutoff

◆ GetLinear()

float OvCore::ECS::Components::CSpotLight::GetLinear ( ) const

Returns the light linear

◆ GetName()

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

Returns the name of the component

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

◆ GetOuterCutoff()

float OvCore::ECS::Components::CSpotLight::GetOuterCutoff ( ) const

Returns the light outercutoff

◆ GetQuadratic()

float OvCore::ECS::Components::CSpotLight::GetQuadratic ( ) const

Returns the light quadratic

◆ OnDeserialize()

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

Deserialize the component

Parameters
p_doc
p_node

Reimplemented from OvCore::ECS::Components::CLight.

◆ OnInspector()

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

Defines how the component should be drawn in the inspector

Parameters
p_root

Reimplemented from OvCore::ECS::Components::CLight.

◆ OnSerialize()

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

Serialize the component

Parameters
p_doc
p_node

Reimplemented from OvCore::ECS::Components::CLight.

◆ SetConstant()

void OvCore::ECS::Components::CSpotLight::SetConstant ( float  p_constant)

Defines the light constant

Parameters
p_constant

◆ SetCutoff()

void OvCore::ECS::Components::CSpotLight::SetCutoff ( float  p_cutoff)

Defines the light cutoff

Parameters
p_cutoff

◆ SetLinear()

void OvCore::ECS::Components::CSpotLight::SetLinear ( float  p_linear)

Defines the light linear

Parameters
p_linear

◆ SetOuterCutoff()

void OvCore::ECS::Components::CSpotLight::SetOuterCutoff ( float  p_outerCutoff)

Defines the light outercutoff

Parameters
p_cutoff

◆ SetQuadratic()

void OvCore::ECS::Components::CSpotLight::SetQuadratic ( float  p_quadratic)

Defines the light quadratic

Parameters
p_quadratic

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