InteractionHomerManipulationActionEvent Class Reference

#include <InteractionEvents.h>

Inherits Event.

Inherited by InteractionBeginHomerManipulationActionEvent, and InteractionEndHomerManipulationActionEvent.

Collaboration diagram for InteractionHomerManipulationActionEvent:

[legend]

List of all members.

Public Types
typedef EventFactory < InteractionHomerManipulationActionEvent >	Factory
Public Member Functions
	InteractionHomerManipulationActionEvent ()
	InteractionHomerManipulationActionEvent (std::vector< PICKEDENTITY > *manipulatingEntities, bool beginManipulation)
virtual	~InteractionHomerManipulationActionEvent ()
virtual void	encode (NetMessage *message)
virtual void	decode (NetMessage *message)
virtual void	execute ()=0
Protected Attributes
bool	beginManipulation
	boolean value indicating if the manipulation should be started or ended
unsigned	userId
	ID of the user sending this event.
std::vector< unsigned >	manipulatingEntityIds
	List of all Entities which should be highlighted.

---

Member Typedef Documentation

typedef EventFactory<InteractionHomerManipulationActionEvent> InteractionHomerManipulationActionEvent::Factory

Reimplemented in InteractionBeginHomerManipulationActionEvent, and InteractionEndHomerManipulationActionEvent.

---

Constructor & Destructor Documentation

InteractionHomerManipulationActionEvent::InteractionHomerManipulationActionEvent

(

)

Empty constructor.

InteractionHomerManipulationActionEvent::InteractionHomerManipulationActionEvent	(	std::vector< PICKEDENTITY > *	manipulatingEntities,
		bool	beginManipulation
	)

Constructor ... .

InteractionHomerManipulationActionEvent::~InteractionHomerManipulationActionEvent

(

)

[virtual]

Empty destructor.

---

Member Function Documentation

void InteractionHomerManipulationActionEvent::decode

(

NetMessage *

message

)

[virtual]

Reimplemented from Event.

void InteractionHomerManipulationActionEvent::encode

(

NetMessage *

message

)

[virtual]

Todo:

should Event::decode() and Event::encode() be protected?

describe Event::decode() and Event::encode()

Reimplemented from Event.

virtual void InteractionHomerManipulationActionEvent::execute

(

)

[pure virtual]

Process the Event.

Todo:

write more precise description

Implements Event.

Implemented in InteractionBeginHomerManipulationActionEvent, and InteractionEndHomerManipulationActionEvent.

---

Member Data Documentation

bool InteractionHomerManipulationActionEvent::beginManipulation [protected]

boolean value indicating if the manipulation should be started or ended

std::vector<unsigned> InteractionHomerManipulationActionEvent::manipulatingEntityIds [protected]

List of all Entities which should be highlighted.

unsigned InteractionHomerManipulationActionEvent::userId [protected]

ID of the user sending this event.

---

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

• src/inVRs/Modules/Interaction/InteractionEvents.h
• src/inVRs/Modules/Interaction/InteractionEvents.cpp