GBE::GPositionalInfluence Class Reference

An influence with additional position information. More...

#include <GPositionalInfluence.h>

Inheritance diagram for GBE::GPositionalInfluence:

[legend]Collaboration diagram for GBE::GPositionalInfluence:

[legend]List of all members.

Public Member Functions
	GPositionalInfluence (const GCS::GElementID &source, const GCS::GEnergy &energy, const GCS::GVector3 &position, const GCS::GVector3 &rotation, double radius, const GCS::GElementID &parent)
virtual	~GPositionalInfluence ()
const GCS::GVector3 &	position () const
const GCS::GVector3 &	rotation () const
const double	radius () const
const GCS::GElementID &	parent () const
Protected Attributes
const GCS::GVector3	Position
const GCS::GVector3	Rotation
const double	Radius
const GCS::GElementID	Parent

---

Detailed Description

An influence with additional position information.

This type of influence has a position and radius attribute added so agents can react according to the influence sender's position and size.

---

Constructor & Destructor Documentation

GBE::GPositionalInfluence::GPositionalInfluence (  const GCS::GElementID &  source, const GCS::GEnergy &  energy, const GCS::GVector3 &  position, const GCS::GVector3 &  rotation, double  radius, const GCS::GElementID &  parent )

Constructor.

GBE::GPositionalInfluence::~GPositionalInfluence (   )  [virtual]

Destructor.

---

Member Function Documentation

const GElementID & GBE::GPositionalInfluence::parent (   )  const

Returns: the parent ID of the influence source.

const GVector3 & GBE::GPositionalInfluence::position (   )  const

Returns: the position of the influence source.

const double GBE::GPositionalInfluence::radius (   )  const

Returns: the radius of the influence source.

const GVector3 & GBE::GPositionalInfluence::rotation (   )  const

Returns: the rotation of the influence source.

---

Member Data Documentation

const GCS::GElementID GBE::GPositionalInfluence::Parent [protected]

Since the position is relative to the parent element, it could be of interest to know the parent.

const GCS::GVector3 GBE::GPositionalInfluence::Position [protected]

The additional position information. This should be set to the position of the source element when creating the influence.

const double GBE::GPositionalInfluence::Radius [protected]

The additional radius information so the receiver knows about size of the source element.

const GCS::GVector3 GBE::GPositionalInfluence::Rotation [protected]

The additional rotation information. This should be set to the rotation of the source element when creating the influence.

---

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

• GPositionalInfluence.h
• GPositionalInfluence.cpp

---