i6engine  1.0
i6e::api::AnimatedDirectionalLightComponent Class Reference

Tells the engine that this GameObject is emitting light. For creating a AnimatedDirectionalLightComponent, these keys are possible:

Name Required Type Description Public
directionDuration no int duration of one direction interpolation cycle yes
directionKey_<timePoint> no Vec3 direction at timePoint encoded in name (timePoint between 0 and 1) yes
More...

#include <D:/Projekte/i6engine/libs/i6engine-modules/include/i6engine/api/components/AnimatedDirectionalLightComponent.h>

Public Member Functions

 AnimatedDirectionalLightComponent (const int64_t id, const attributeMap &params)
 Constructor sets ID and component. More...
 
 ~AnimatedDirectionalLightComponent ()
 
attributeMap synchronize () const override
 synchronizes the Components state More...
 
std::string getTemplateName () const override
 returns the name this template was registered with More...
 
- Public Member Functions inherited from i6e::api::AnimatedLuminousAppearanceComponent
 AnimatedLuminousAppearanceComponent (const int64_t id, const attributeMap &params)
 Constructor sets ID and component. More...
 
virtual ~AnimatedLuminousAppearanceComponent ()
 
attributeMap synchronize () const override
 synchronizes the Components state More...
 
std::string getTemplateName () const override
 returns the name this template was registered with More...
 
- Public Member Functions inherited from i6e::api::LuminousAppearanceComponent
 LuminousAppearanceComponent (const int64_t id, const attributeMap &params)
 Constructor sets ID and component. More...
 
virtual ~LuminousAppearanceComponent ()
 
void setLightType (const LightType lightType)
 Sets light type. More...
 
LightType getLightType () const
 Gets component's light type. More...
 
void setDiffuseColor (const Vec3 &diffuseColor)
 Sets diffuse colour. More...
 
Vec3 getDiffuseColor () const
 Gets diffuse colour. More...
 
void setSpecularColor (const Vec3 &specular)
 Sets specular colour. More...
 
Vec3 getSpecularColor () const
 Gets specular colour. More...
 
void setAttenuation (const Vec4 &attenuation)
 Sets attenuation. More...
 
Vec4 getAttenuation () const
 Gets attenuation. More...
 
void setDirection (const Vec3 &direction)
 Sets direction. More...
 
Vec3 getDirection () const
 Gets direction. More...
 
void setSpotLightInnerRange (double angle)
 sets inner spot light angle More...
 
void setSpotLightOuterRange (double angle)
 sets outer spot light angle More...
 
- Public Member Functions inherited from i6e::api::Component
 Component ()
 Constructor for Component. More...
 
 Component (const int64_t id, const attributeMap &params)
 Constructor for Component. More...
 
virtual ~Component ()
 Destructor of Component. Must be implemented in derived class. More...
 
void setOwnerGO (const WeakGOPtr &objGo)
 Sets the GameObject that owns this Component. More...
 
GOPtr getOwnerGO ()
 Get the GameObject that owns this Component. More...
 
uint32_t getComponentID () const
 Returns the component identification string. More...
 
uint32_t getFamilyID () const
 Returns the family identification string. More...
 
std::string getIdentifier () const
 Returns the family identification string. More...
 
void setDie () const
 component will be deleted soon More...
 
int64_t getID () const
 returns the id of the component More...
 
virtual void News (const GameMessage::Ptr &msg)
 Receives messages for this component override this function, if you expect messages. More...
 
void setSync (bool b)
 sets whether this object has to be synchronized or not More...
 
bool getSync () const
 
void enableTicking (bool allowTicking) const
 triggers doEnableTicking threadsafe More...
 
void setSelf (const WeakComPtr &self)
 sets weak_ptr on self for registration of ticker More...
 
std::vector< ComPtrgetSubComponents () const
 returns all SubComponents attached to this Component More...
 

Additional Inherited Members

- Public Types inherited from i6e::api::LuminousAppearanceComponent
enum  LightType { LightType::POINT, LightType::DIRECTIONAL, LightType::SPOT }
 type of the light emitted More...
 
- Static Public Member Functions inherited from i6e::api::Component
template<typename T >
static ComPtr createC (const int64_t id, const attributeMap &params)
 
- Protected Member Functions inherited from i6e::api::AnimatedLuminousAppearanceComponent
template<typename T >
interpolate (uint64_t duration, const std::map< double, T > &values) const
 used to interpolate between two following values depending on current time More...
 
- Protected Member Functions inherited from i6e::api::Component
void addTicker ()
 adds this component to ticklist More...
 
void removeTicker ()
 removes this component from ticklist More...
 
void doEnableTicking (bool allowTicking)
 sets ticking status for this Component per default all Components are allowed to tick and calling addTicker will start ticking, but in some cases, e.g. for level editor, ticking has to be disabled and just a few components are allowed to tick More...
 
- Protected Attributes inherited from i6e::api::LuminousAppearanceComponent
LightType _lightType
 
Vec3 _diffuseColor
 
Vec3 _specularColor
 
Vec4 _attenuation
 
Vec3 _direction
 
Vec3 _position
 
double _spotlightRangeInner
 
double _spotlightRangeOuter
 
- Protected Attributes inherited from i6e::api::Component
int64_t _objOwnerID
 ID of the GameObject that owns this Component. More...
 
WeakGOPtr _objOwnerGO
 Owning GameObject. More...
 
uint32_t _objComponentID
 Component ID of the Component. More...
 
uint32_t _objFamilyID
 Family ID of the Component. More...
 
std::vector< ComPtr_subComps
 vector containing the other componetns of the same type if this is the dispatcher component More...
 
std::string _identifier
 identifies the subcomponent More...
 
int64_t _id
 id of this component More...
 
bool _sync
 
WeakComPtr _self
 a weak_ptr on the own shared_ptr More...
 
bool _tickingAllowed
 status if this object is allowed to tick or not More...
 
bool _wantsToTick
 stores if a Component which isn't allowed to tick want to tick, so it can start ticking when ticking will be allowed More...
 
bool _isTicking
 stores whether this Component is actually ticking More...
 

Detailed Description

Tells the engine that this GameObject is emitting light. For creating a AnimatedDirectionalLightComponent, these keys are possible:

Name Required Type Description Public
directionDuration no int duration of one direction interpolation cycle yes
directionKey_<timePoint> no Vec3 direction at timePoint encoded in name (timePoint between 0 and 1) yes

Definition at line 42 of file AnimatedDirectionalLightComponent.h.

Constructor & Destructor Documentation

i6e::api::AnimatedDirectionalLightComponent::AnimatedDirectionalLightComponent ( const int64_t  id,
const attributeMap params 
)

Constructor sets ID and component.

i6e::api::AnimatedDirectionalLightComponent::~AnimatedDirectionalLightComponent ( )

Member Function Documentation

std::string i6e::api::AnimatedDirectionalLightComponent::getTemplateName ( ) const
inlineoverridevirtual

returns the name this template was registered with

Reimplemented from i6e::api::LuminousAppearanceComponent.

Definition at line 56 of file AnimatedDirectionalLightComponent.h.

attributeMap i6e::api::AnimatedDirectionalLightComponent::synchronize ( ) const
overridevirtual

synchronizes the Components state

Reimplemented from i6e::api::LuminousAppearanceComponent.


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