Inheritance diagram for Cogs::Core::FPSNavigationComponent:

Public Member Functions
void	initialize (Cogs::Core::Context *context)

void	update ()

Public Member Functions inherited from Cogs::ComponentModel::Component
class Entity *	getContainer () const
	Get the container currently owning this component instance.

void	setContainer (class Entity *container)
	Set the container owning this component instance.

template<typename ComponentType >
ComponentType *	getComponent () const

COGSFOUNDATION_API Component *	getComponent (const Reflection::Name &name) const

COGSFOUNDATION_API Component *	getComponent (const Reflection::TypeId &id) const

template<typename ComponentType >
ComponentHandle	getComponentHandle () const

COGSFOUNDATION_API ComponentHandle	getComponentHandle (const Reflection::Name &name) const

COGSFOUNDATION_API ComponentHandle	getComponentHandle (const Reflection::TypeId &id) const

void	setActive ()
	Sets the component to the ComponentFlags::Active state.

bool	isActive () const
	Gets if the component is currently set to the ComponentFlags::Active state.

void	setChanged ()
	Sets the component to the ComponentFlags::Changed state with carry.

void	setChangedTransient ()
	Sets the component to the ComponentFlags::Changed state without carry.

void	setFieldChanged (const Reflection::FieldId fieldId)
	Sets the component to the ComponentFlags::Changed state without carry.

template<typename ClassType , typename FieldType >
void	setFieldChanged (FieldType ClassType::*field)
	Sets a flag indicating that the given field has changed.

void	setFieldChangedTransient (const Reflection::FieldId fieldId)
	Sets the component to the ComponentFlags::Changed state without carry.

bool	hasChanged () const

bool	hasAnyfieldChanged () const
	Gets if any fields have been changed.

bool	hasFieldChanged (const Reflection::FieldId fieldId) const
	Gets if the field with the given id on this component instance has changed.

template<typename ClassType , typename FieldType >
bool	hasFieldChanged (FieldType ClassType::*field) const
	Gets if the given field has changed.

void	resetCarryChanged ()
	Reset the CarryChanged flag. Called at start of redraw. See ComponentFlags::CarryChanged.

void	resetChanged ()
	Resets the changed state of the component, respecting any carry state set.

template<typename ClassType , typename FieldType >
Reflection::FieldId	getFieldId (FieldType ClassType::*field) const
	Gets field ID of the given field.

void	resetFieldsChanged ()
	Resets the state of all changed field flags.

void	resetFieldChanged (const Reflection::FieldId fieldId)
	Resets the changed state of the given fieldId.

template<typename ClassType , typename FieldType >
void	resetFieldChanged (FieldType ClassType::*field)
	Resets the changed state of the given field.

constexpr void	setFlags (const uint32_t flags)
	Override all flags of the Component, setting the given flags.

constexpr void	setFlag (const uint32_t flag)
	Set the given flags. Does not override the currently set flags.

constexpr void	unsetFlag (const uint32_t flag)
	Unset the given flag. Does not remove the status of other than the given flags.

constexpr bool	isSet (const uint32_t flag) const
	Checks if the given flag is set. Requires exact bit match if test of several bits.

constexpr void	setTypeId (const Reflection::TypeId typeId)
	Set the Reflection::TypeId of the component.

constexpr Reflection::TypeId	getTypeId () const
	Get the Reflection::TypeId of the component.

COGSFOUNDATION_API const Reflection::Type &	getType () const
	Get the full Reflection::Type of the component.

constexpr void	setIndex (const ComponentIndex index)
	Set the components pool index. For internal use only.

constexpr ComponentIndex	getIndex () const
	Get the components pool index. For internal use only.

constexpr void	setGeneration (uint16_t generation)
	Sets the component generation.

constexpr uint16_t	getGeneration () const
	Gets the component generation.

size_t	hash (size_t hashValue=Cogs::hash()) const
	Calculates a hash of this component's members.

Static Public Member Functions
static void	registerType ()

Static Public Member Functions inherited from Cogs::Core::DynamicComponent
static COGSCORE_DLL_API void	registerType ()
	Register the type in the type system.

template<typename T >
static Reflection::Type &	registerDerivedType ()
	Convenience method for registering the type of a derived component.

Static Public Member Functions inherited from Cogs::ComponentModel::Component
static COGSFOUNDATION_API void	registerType ()
	Register the Component type in the global type database.

static COGSFOUNDATION_API Reflection::TypeId	getComponentTypeId (const StringView &name)
	Get the type id of the component type with the given name.

Public Attributes
bool	enable = true

bool	enablePitch = false

float	maxLinearSpeed = 10.f / 3.6f

float	maxAngularSpeed = 2.f

std::string	axisForward = "Forward"

std::string	axisRight = "Right"

std::string	axisUp = "Up"

std::string	axisDown = "Down"

std::string	axisRotateUp = "RotateUp"

std::string	axisRotateRight = "RotateRight"

std::string	actionRun = "Run"

std::string	actionEnableNavigation = ""

float	pitch = 0

float	yaw = 0

Public Attributes inherited from Cogs::Core::DynamicComponent
void *	messageCallback = nullptr

void *	userData = nullptr

size_t	dynamicTypeInfoIndex = static_cast<size_t>(-1)

Private Member Functions
glm::vec3	getOffset ()

glm::vec2	getPitchYawOffset ()

Private Attributes
Context *	context = nullptr

Detailed Description

Definition at line 15 of file FPSNavigationComponent.h.

Member Function Documentation

◆ getOffset()

glm::vec3 Cogs::Core::FPSNavigationComponent::getOffset ( )

private

Definition at line 48 of file FPSNavigationComponent.cpp.

◆ getPitchYawOffset()

glm::vec2 Cogs::Core::FPSNavigationComponent::getPitchYawOffset ( )

private

Definition at line 62 of file FPSNavigationComponent.cpp.

◆ initialize()

void Cogs::Core::FPSNavigationComponent::initialize ( Cogs::Core::Context * context )

Definition at line 43 of file FPSNavigationComponent.cpp.

◆ registerType()

void Cogs::Core::FPSNavigationComponent::registerType ( )

static

Definition at line 17 of file FPSNavigationComponent.cpp.

◆ update()

void Cogs::Core::FPSNavigationComponent::update ( )

Definition at line 73 of file FPSNavigationComponent.cpp.

Member Data Documentation

◆ actionEnableNavigation

std::string Cogs::Core::FPSNavigationComponent::actionEnableNavigation = ""

Definition at line 36 of file FPSNavigationComponent.h.

◆ actionRun

std::string Cogs::Core::FPSNavigationComponent::actionRun = "Run"

Definition at line 35 of file FPSNavigationComponent.h.

◆ axisDown

std::string Cogs::Core::FPSNavigationComponent::axisDown = "Down"

Definition at line 31 of file FPSNavigationComponent.h.

◆ axisForward

std::string Cogs::Core::FPSNavigationComponent::axisForward = "Forward"

Definition at line 28 of file FPSNavigationComponent.h.

◆ axisRight

std::string Cogs::Core::FPSNavigationComponent::axisRight = "Right"

Definition at line 29 of file FPSNavigationComponent.h.

◆ axisRotateRight

std::string Cogs::Core::FPSNavigationComponent::axisRotateRight = "RotateRight"

Definition at line 33 of file FPSNavigationComponent.h.

◆ axisRotateUp

std::string Cogs::Core::FPSNavigationComponent::axisRotateUp = "RotateUp"

Definition at line 32 of file FPSNavigationComponent.h.

◆ axisUp

std::string Cogs::Core::FPSNavigationComponent::axisUp = "Up"

Definition at line 30 of file FPSNavigationComponent.h.

◆ context

Context* Cogs::Core::FPSNavigationComponent::context = nullptr

private

Definition at line 45 of file FPSNavigationComponent.h.

◆ enable

bool Cogs::Core::FPSNavigationComponent::enable = true

Definition at line 22 of file FPSNavigationComponent.h.

◆ enablePitch

bool Cogs::Core::FPSNavigationComponent::enablePitch = false

Definition at line 23 of file FPSNavigationComponent.h.

◆ maxAngularSpeed

float Cogs::Core::FPSNavigationComponent::maxAngularSpeed = 2.f

Definition at line 26 of file FPSNavigationComponent.h.

◆ maxLinearSpeed

float Cogs::Core::FPSNavigationComponent::maxLinearSpeed = 10.f / 3.6f

Definition at line 25 of file FPSNavigationComponent.h.

◆ pitch

float Cogs::Core::FPSNavigationComponent::pitch = 0

Definition at line 38 of file FPSNavigationComponent.h.

◆ yaw

float Cogs::Core::FPSNavigationComponent::yaw = 0

Definition at line 39 of file FPSNavigationComponent.h.

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

Source/Components/Behavior/FPSNavigationComponent.h
Source/Components/Behavior/FPSNavigationComponent.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ getOffset()

◆ getPitchYawOffset()

◆ initialize()

◆ registerType()

◆ update()

Member Data Documentation

◆ actionEnableNavigation

◆ actionRun

◆ axisDown

◆ axisForward

◆ axisRight

◆ axisRotateRight

◆ axisRotateUp

◆ axisUp

◆ context

◆ enable

◆ enablePitch

◆ maxAngularSpeed

◆ maxLinearSpeed

◆ pitch

◆ yaw