i6engine  1.0
i6e::api::MovingCameraComponent Class Reference

Attaches a moving camera to an object. This camera will follow the object in a more sophisticated way. More...

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

Public Member Functions

 MovingCameraComponent (const int64_t id, const attributeMap &params)
 
 ~MovingCameraComponent ()
 
std::string getTemplateName () const override
 returns the name this template was registered with More...
 
- Public Member Functions inherited from i6e::api::CameraComponent
 CameraComponent (const int64_t id, const attributeMap &params)
 Constructor with attribute map. More...
 
virtual ~CameraComponent ()
 Destructor. More...
 
void setPosition (const Vec3 &relativePosition)
 Sets position of the camera Sets position of the component relative to its parent GameObject. More...
 
void setLookAt (const Vec3 &lookAt)
 Sets lookAt position of the camera Sets position of the component. Just like in the Init() function, this point should be in absolute world coordinates, but the viewing vector will update itself on moving the GameObject. More...
 
void setNearClip (const int32_t n)
 Sets nearClipDistance of the camera Sets nearClipDistance of the camera. Objects closer to the camera than this distance will not be rendered. More...
 
void setAspectRatio (const double ratio)
 Sets aspect Ratio Sets aspect Ratio. This ratio specifies the ratio between width and height of the camera. More...
 
void setFOVy (const double fov)
 Sets the vertical Field of View This parameter specifies the opening angle of the viewing frustrum along the y-axis. More...
 
void setFrustumExtends (const double left, const double right, const double top, const double bottom)
 Sets the extends of the Frustum. More...
 
void setViewportDimension (const double left, const double top, const double width, const double height)
 sets the dimensions for the viewport used to display this camera all values are relative and between 0 and 1 e.g. to use only the upper right quarter of the render window, use values (0.5, 0, 0.5, 0.5) More...
 
void setViewportBackground (const double red, const double green, const double blue, const double alpha)
 sets the backgroundcolor of the viewport More...
 
Vec3 getPosition () const
 returns the relative position of the camera on the GameObject More...
 
Vec3 getLookAt () const
 returns the position of the lookAt in world space! More...
 
attributeMap synchronize () const override
 synchronizes the Components state More...
 
std::vector< componentOptionsgetComponentOptions () override
 returns a vector containing all options of the Component being readable and writeable in the editor More...
 
void enableCompositor (const std::string &compositor, bool enabled)
 enables or disables a compositor More...
 
virtual std::pair< AddStrategy, int64_t > howToAdd (const ComPtr &comp) const override
 asks, how to handle a new component with the same type 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

- 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::CameraComponent
void sendCameraUpdateMessage ()
 Sends message to MessagingController. More...
 
void sendViewportUpdateMessage ()
 sends an update message containing the new viewport values More...
 
void sendFrustumUpdateMessage ()
 Sends a message to update the frustum extends. 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::CameraComponent
Vec3 _position
 Position of the camera. More...
 
Vec3 _lookAt
 Point the Camera looks at. More...
 
int32_t _nearClip
 nearClippingDistance More...
 
double _aspect
 
int _zOrder
 
bool _viewport
 
double _left
 
double _top
 
double _width
 
double _height
 
double _red
 
double _green
 
double _blue
 
double _alpha
 
double _fov
 
double _frustumLeft
 
double _frustumRight
 
double _frustumTop
 
double _frustumBottom
 
- 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

Attaches a moving camera to an object. This camera will follow the object in a more sophisticated way.

Definition at line 38 of file MovingCameraComponent.h.

Constructor & Destructor Documentation

i6e::api::MovingCameraComponent::MovingCameraComponent ( const int64_t  id,
const attributeMap params 
)
i6e::api::MovingCameraComponent::~MovingCameraComponent ( )

Member Function Documentation

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

returns the name this template was registered with

Reimplemented from i6e::api::CameraComponent.

Definition at line 43 of file MovingCameraComponent.h.


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