Shkyera Engine
Easy to use, game engine for Python
shkyera::Entity Class Reference

A class representing an entity in a 3D world with position, orientation, and scale. More...

#include <Entity.hpp>

Inheritance diagram for shkyera::Entity:
[legend]

Public Member Functions

 Entity ()
 Default constructor for an entity with identity position, orientation, and scale. More...
 
 Entity (glm::vec3 position)
 Constructor for an entity with the specified position and identity orientation and scale. More...
 
 Entity (glm::vec3 position, glm::vec3 orientation)
 Constructor for an entity with the specified position and orientation, and identity scale. More...
 
 ~Entity ()=default
 Destructor for the Entity class. More...
 
glm::vec3 & getPosition ()
 Get the position of the entity. More...
 
glm::vec3 & getOrientation ()
 Get the orientation of the entity. More...
 
glm::vec3 & getScale ()
 Get the scale of the entity. More...
 

Private Attributes

glm::vec3 _position
 The position of the entity. More...
 
glm::vec3 _orientation
 The orientation of the entity. More...
 
glm::vec3 _scale
 The scale of the entity. More...
 

Detailed Description

A class representing an entity in a 3D world with position, orientation, and scale.

Constructor & Destructor Documentation

◆ Entity() [1/3]

shkyera::Entity::Entity ( )

Default constructor for an entity with identity position, orientation, and scale.

◆ Entity() [2/3]

shkyera::Entity::Entity ( glm::vec3  position)

Constructor for an entity with the specified position and identity orientation and scale.

Parameters
positionThe initial position of the entity.

◆ Entity() [3/3]

shkyera::Entity::Entity ( glm::vec3  position,
glm::vec3  orientation 
)

Constructor for an entity with the specified position and orientation, and identity scale.

Parameters
positionThe initial position of the entity.
orientationThe initial orientation of the entity.

◆ ~Entity()

shkyera::Entity::~Entity ( )
default

Destructor for the Entity class.

Member Function Documentation

◆ getOrientation()

glm::vec3 & shkyera::Entity::getOrientation ( )

Get the orientation of the entity.

Returns
A reference to the orientation vector.

◆ getPosition()

glm::vec3 & shkyera::Entity::getPosition ( )

Get the position of the entity.

Returns
A reference to the position vector.

◆ getScale()

glm::vec3 & shkyera::Entity::getScale ( )

Get the scale of the entity.

Returns
A reference to the scale vector.

Member Data Documentation

◆ _orientation

glm::vec3 shkyera::Entity::_orientation
private

The orientation of the entity.

◆ _position

glm::vec3 shkyera::Entity::_position
private

The position of the entity.

◆ _scale

glm::vec3 shkyera::Entity::_scale
private

The scale of the entity.


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