InteractionHighlightSelectionActionEvent Class Reference

#include <InteractionEvents.h>

Inherits Event.

Collaboration diagram for InteractionHighlightSelectionActionEvent:

[legend]

List of all members.

Public Types
typedef EventFactory < InteractionHighlightSelectionActionEvent >	Factory
Public Member Functions
	InteractionHighlightSelectionActionEvent ()
	InteractionHighlightSelectionActionEvent (std::vector< PICKEDENTITY > *highlightEntities, std::vector< PICKEDENTITY > *unhighlightEntities, std::string modelType, std::string modelUrl)
virtual	~InteractionHighlightSelectionActionEvent ()
virtual void	encode (NetMessage *message)
virtual void	decode (NetMessage *message)
virtual void	execute ()
Protected Member Functions
void	highlightEntity (Entity *entity, SceneGraphInterface *sgIF, ModelInterface *model, HighlightSelectionActionModel *selectionModel)
void	highlightEntity (unsigned typeBasedId, SceneGraphInterface *sgIF, ModelInterface *model, HighlightSelectionActionModel *selectionModel)
void	unhighlightEntity (Entity *entity, SceneGraphInterface *sgIF, HighlightSelectionActionModel *selectionModel)
Protected Attributes
unsigned	userId
	ID of the user sending this event.
std::string	modelType
	File-type of the Model that should be displayed.
std::string	modelUrl
	URL to the Model that should be displayed.
std::vector< unsigned >	highlightEntityIds
	List of all Entities which should be highlighted.
std::vector< unsigned >	unhighlightEntityIds
	List of all Entities which should be unhighlighted.

---

Member Typedef Documentation

typedef EventFactory<InteractionHighlightSelectionActionEvent> InteractionHighlightSelectionActionEvent::Factory

---

Constructor & Destructor Documentation

InteractionHighlightSelectionActionEvent::InteractionHighlightSelectionActionEvent

(

)

Empty constructor.

InteractionHighlightSelectionActionEvent::InteractionHighlightSelectionActionEvent	(	std::vector< PICKEDENTITY > *	highlightEntities,
		std::vector< PICKEDENTITY > *	unhighlightEntities,
		std::string	modelType,
		std::string	modelUrl
	)

Constructor

InteractionHighlightSelectionActionEvent::~InteractionHighlightSelectionActionEvent

(

)

[virtual]

Empty destructor.

---

Member Function Documentation

void InteractionHighlightSelectionActionEvent::decode

(

NetMessage *

message

)

[virtual]

Reimplemented from Event.

void InteractionHighlightSelectionActionEvent::encode

(

NetMessage *

message

)

[virtual]

Todo:

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

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

Reimplemented from Event.

void InteractionHighlightSelectionActionEvent::execute

(

)

[virtual]

Process the Event.

Todo:

write more precise description

Implements Event.

void InteractionHighlightSelectionActionEvent::highlightEntity	(	unsigned	typeBasedId,
		SceneGraphInterface *	sgIF,
		ModelInterface *	model,
		HighlightSelectionActionModel *	selectionModel
	)			[protected]

void InteractionHighlightSelectionActionEvent::highlightEntity	(	Entity *	entity,
		SceneGraphInterface *	sgIF,
		ModelInterface *	model,
		HighlightSelectionActionModel *	selectionModel
	)			[protected]

Displays a clone of the passed model for highlighting the passed Entity.

void InteractionHighlightSelectionActionEvent::unhighlightEntity	(	Entity *	entity,
		SceneGraphInterface *	sgIF,
		HighlightSelectionActionModel *	selectionModel
	)			[protected]

Removes the highlight-model for the passed Entity if existing.

---

Member Data Documentation

std::vector<unsigned> InteractionHighlightSelectionActionEvent::highlightEntityIds [protected]

List of all Entities which should be highlighted.

std::string InteractionHighlightSelectionActionEvent::modelType [protected]

File-type of the Model that should be displayed.

std::string InteractionHighlightSelectionActionEvent::modelUrl [protected]

URL to the Model that should be displayed.

std::vector<unsigned> InteractionHighlightSelectionActionEvent::unhighlightEntityIds [protected]

List of all Entities which should be unhighlighted.

unsigned InteractionHighlightSelectionActionEvent::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