Vulkan Schnee 0.0.1
High-performance rendering engine
Loading...
Searching...
No Matches
Engine::Entities::Rat Class Reference

Test actor that owns a scene component. More...

#include <Rat.h>

Inheritance diagram for Engine::Entities::Rat:
Collaboration diagram for Engine::Entities::Rat:

Public Member Functions

 Rat (const SpawnContext &context)
 ~Rat () override
Public Member Functions inherited from Engine::Entities::Actor
 Actor (const SpawnContext &context)
 ~Actor () override=default
template<typename T, typename... Args>
requires detail::ConstructibleWithActorContext<T, Args...>
T * addComponent (Args &&... args)
 Adds a component using this actor's scene, ECS entity and scene node where supported.
virtual void beginPlay ()
 Gets executed when the actor is spawned into the world.
void tick (double deltaTime) override
 Executed every frame.
virtual void endPlay ()
 Gets executed when an actor is getting removed from the scene.
virtual std::string getActorName () const
void destroyActor ()
 Queues this actor for destruction after the current tick finishes.
void destroyActorImmediate ()
 Destroys this actor immediately. Prefer destroyActor() during gameplay/tick code.
glm::vec3 getActorLocation () const
 Gets the actors location in the world.
glm::vec3 getActorRotation () const
 Gets the actors rotation in the world.
glm::quat getActorRotationQuat () const
 Gets the actors world rotation.
glm::vec3 getActorScale () const
 Scales the actor to world scale.
void setActorLocation (glm::vec3 newLocation) const
 Set the new world location for this actor.
void setActorRotation (glm::vec3 newRotation) const
 Sets the world rotation.
void rotateActor (glm::vec3 deltaRotation) const
 Applies an incremental rotation to the actor using quaternion multiplication. Use this instead of getActorRotation() + setActorRotation() for continuous rotation to avoid euler angle instability/jiggling.
void setActorScale (glm::vec3 newScale) const
 sets the world scale for this actor
glm::vec3 getForwardVector () const
 Gets the forward world vector.
glm::vec3 getRightVector () const
 Gets the right.
glm::vec3 getUpVector () const
 Gets the up world vector.
glm::mat4 getWorldTransform () const
 Gets the model matrix.
virtual bool drawImGui () const
 Allows drawing custom Imgui panels for the editor.
ScenegetOwningScene () const
 Get the pointer to the scene this entity is a part of.
EngineKerngetEngine () const
 Gets the engine this actor belongs to.
Core::PhysicsEnginegetPhysicsEngine () const
 Gets the physics engine through this actor's owning engine.
std::shared_ptr< SceneNodegetSceneNode () const
 Getter for the scene graph node for this object.
Public Member Functions inherited from Engine::Entities::Entity
 Entity ()
 ~Entity () override
void enableTick (bool enable)
 Enables or disables ticking for this entity.
void setTickPriority (int32_t priority)
int32_t getTickPriority () const
void tick (double deltaTime) override
 Executes every frame if tick is enabled.
template<typename T, typename... Args>
requires std::is_base_of_v<Components::Logic, T> && std::is_constructible_v<T, Args...>
T * addComponent (Args &&... args)
 Adds a component to the entity. Checks for uniqueness if the component defines 'static constexpr bool IsUnique = true;'.
template<typename T>
requires std::is_base_of_v<Components::Logic, T>
T * getComponent () const
 Returns the first component of type T found.
template<typename T>
requires std::is_base_of_v<Components::Logic, T>
std::vector< T * > getComponents () const
 Returns all components of type T.
void removeComponent (Components::Logic *component)
 Removes a specific component instance.
template<typename T>
requires std::is_base_of_v<Components::Logic, T>
bool removeFirstComponent ()
 Removes the first component of type T found.
template<typename T>
requires std::is_base_of_v<Components::Logic, T>
bool hasComponent () const
 Checks if a component of type T exists.
const std::vector< std::unique_ptr< Components::Logic > > & getAllComponents () const
 Gets all components on this entity.
bool canTick () const
 Tells you if the entity can execute its tick function.
bool canEverTick () const
 Tells if this entity can ever tick.
entt::entity getEcsEntity () const
 Gets the ECS entity handle for this Entity.
Public Member Functions inherited from Engine::Core::ITickable
virtual ~ITickable ()=default
virtual void preTick ()
 Function which executes immediately before the execution of ITickable::preTick()
virtual void postTick ()
 Function which executes immediately after the execution of ITickable::postTick()

Private Attributes

Components::MeshratMesh_ = nullptr

Additional Inherited Members

Protected Member Functions inherited from Engine::Entities::Entity
uuids::uuid getUUID () const
 Getter for the UUID of this entity.
std::string getUuidString () const
 Getter for the UUID of this entity as a string.
Protected Attributes inherited from Engine::Entities::Actor
std::optional< std::shared_ptr< SceneNode > > sceneNode
Protected Attributes inherited from Engine::Entities::Entity
std::vector< std::unique_ptr< Components::Logic > > components_
 List of all logical components.
entt::entity data_ = entt::null
bool allowTicking_ = false
int32_t tickPriority_ = 0

Detailed Description

Test actor that owns a scene component.

Definition at line 13 of file Rat.h.

Constructor & Destructor Documentation

◆ Rat()

Engine::Entities::Rat::Rat ( const SpawnContext & context)
explicit

◆ ~Rat()

Engine::Entities::Rat::~Rat ( )
override

Member Data Documentation

◆ ratMesh_

Components::Mesh* Engine::Entities::Rat::ratMesh_ = nullptr
private

Definition at line 19 of file Rat.h.


The documentation for this class was generated from the following file:
  • /home/magerbeton/Documents/gl3-vulkan/Engine/include/Engine/Entity/Rat.h