Public API Reference

iPcHover Struct Reference

Hover stabiliser property class. More...

#include <propclass/hover.h>

List of all members.

Public Member Functions
virtual float	GetHeight ()=0
	Get's the last calculated height for object.
virtual void	HoverOff ()=0
	Turn hovering off, until HoverOn () is called.
virtual void	HoverOn ()=0
	Turn hovering on (on by default).
virtual void	SetAngularBeamOffset (float abo)=0
	The offsets to the sides of the objects, to test height to calculate angular orientation with respect to the ground.
virtual void	SetAngularCorrectionStrength (float mul)=0
	How strongly does the object align itself with the terrain? Higher values means that an object going down a hill will snap to the slope.
virtual void	SetAngularCutoffHeight (float ach)=0
	Height at which to perform the angular correction.
virtual void	SetFactors (float p, float i, float d)=0
	Set the various PID factors to affect hovering behaviour.
virtual void	SetHeightBeamCutoff (float chm)=0
	The height for hit beams.
virtual void	SetHoverHeight (float height)=0
	Set the height at which the object should hover.

---

Detailed Description

Hover stabiliser property class.

Definition at line 34 of file hover.h.

---

Member Function Documentation

virtual float iPcHover::GetHeight

(

)

[pure virtual]

Get's the last calculated height for object.

virtual void iPcHover::HoverOff

(

)

[pure virtual]

Turn hovering off, until HoverOn () is called.

virtual void iPcHover::HoverOn

(

)

[pure virtual]

Turn hovering on (on by default).

virtual void iPcHover::SetAngularBeamOffset

(

float

abo

)

[pure virtual]

The offsets to the sides of the objects, to test height to calculate angular orientation with respect to the ground.

Smaller is more accurate, but too small and the roll angles will differ in bigger steps (the height beams resolution won't be accurate enough)

virtual void iPcHover::SetAngularCorrectionStrength

(

float

mul

)

[pure virtual]

How strongly does the object align itself with the terrain? Higher values means that an object going down a hill will snap to the slope.

Smaller values and it will slowly align

virtual void iPcHover::SetAngularCutoffHeight

(

float

ach

)

[pure virtual]

Height at which to perform the angular correction.

virtual void iPcHover::SetFactors	(	float	p,
		float	i,
		float	d
	)			[pure virtual]

Set the various PID factors to affect hovering behaviour.

virtual void iPcHover::SetHeightBeamCutoff

(

float

chm

)

[pure virtual]

The height for hit beams.

Above this height, all height tests return infinity

virtual void iPcHover::SetHoverHeight

(

float

height

)

[pure virtual]

Set the height at which the object should hover.

---

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

• propclass/hover.h

---