Math::AngularPFeedbackLoop Class Reference

#include <angularpfeedbackloop.h>

Detailed Description

A proportional feedback loop with correct angular interpolation.

Copyright

(C) 2004 RadonLabs GmbH (C) 2013-2020 Individual contributors, see AUTHORS file

Public Member Functions
	AngularPFeedbackLoop ()
	constructor
void	Reset (Timing::Time time, float stepSize, float gain, float curState)
	reset the time
void	SetGain (float g)
	set the gain
float	GetGain () const
	get the gain
void	SetGoal (float c)
	set the goal
float	GetGoal () const
	get the goal
void	SetState (float s)
	set the current state directly
float	GetState () const
	get the current state the system is in
void	Update (Timing::Time time)
	update the object, return new state
Timing::Time	GetTime () const
	get currrent time

Private Attributes
Timing::Time	time
float	stepSize
float	gain
float	goal
float	state

Constructor & Destructor Documentation

AngularPFeedbackLoop()

Math::AngularPFeedbackLoop::AngularPFeedbackLoop ( )

inline

constructor

Member Function Documentation

GetGain()

float Math::AngularPFeedbackLoop::GetGain ( ) const

inline

get the gain

GetGoal()

float Math::AngularPFeedbackLoop::GetGoal ( ) const

inline

get the goal

GetState()

float Math::AngularPFeedbackLoop::GetState ( ) const

inline

get the current state the system is in

GetTime()

Timing::Time Math::AngularPFeedbackLoop::GetTime ( ) const

inline

get currrent time

Reset()

void Math::AngularPFeedbackLoop::Reset ( Timing::Time time, float stepSize, float gain, float curState )

inline

reset the time

SetGain()

void Math::AngularPFeedbackLoop::SetGain ( float g )

inline

set the gain

SetGoal()

void Math::AngularPFeedbackLoop::SetGoal ( float c )

inline

set the goal

SetState()

void Math::AngularPFeedbackLoop::SetState ( float s )

inline

set the current state directly

Update()

void Math::AngularPFeedbackLoop::Update ( Timing::Time time )

inline

update the object, return new state

Member Data Documentation

gain

float Math::AngularPFeedbackLoop::gain

private

goal

float Math::AngularPFeedbackLoop::goal

private

state

float Math::AngularPFeedbackLoop::state

private

stepSize

float Math::AngularPFeedbackLoop::stepSize

private

time

Timing::Time Math::AngularPFeedbackLoop::time

private

---

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

• /github/workspace/code/foundation/math/angularpfeedbackloop.h