#include <EditorController.h>

Inheritance diagram for APEditorController::EditorController:

Classes
class	ECPOINTERBUTTONINFO

class	ECPOINTERINFO

Public Member Functions
	EditorController ()

	~EditorController ()

virtual bool	initialize (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *parameters=NULL)
	Core initialization. More...

virtual void	update ()
	This method is called periodically in case this instance is registered in Scheduler. More...

Public Member Functions inherited from vrecko::Ability
virtual	~Ability ()
	copy constructor More...

const std::string &	getName () const
	Returns the ability name. More...

void	setPluginName (const char *pName)
	Sets the plugin name. More...

const std::string &	getPluginName (void) const
	Returns the plugin name. More...

const std::string &	getID (void) const
	Returns ability the identification string. More...

void	setID (const char *pID)
	(Internal usage, most people should not need to use it.) Sets the ability ID. More...

virtual void	clean (void)

void	setOwner (BaseClass *owner)
	(Internal usage, most people should not need to use it.) Sets ability owner. *l This method is called automatically in World::createAbility(), so one would (almost?) never want to use it directly. More...

BaseClass *	getOwner (void)
	Returns the ability owner. More...

virtual ParameterVector *	getParameterVector (void)
	Return vector of the parameter description. More...

bool	isUpdated (void)
	Set update flag. More...

virtual const std::string &	getSenderString (void)
	Returns the identification string of sender. More...

Public Member Functions inherited from vrecko::BaseClass
	BaseClass (const char *startingSenderString)
	The main constructor. More...

	BaseClass (BaseClass &bc)
	Copy constructor. Probably not really used. More...

virtual	~BaseClass ()
	Destructor. More...

virtual bool	initializeFromString (const char *xmlString)
	Helper method that allows to initialize ability from a XML-formatted string. More...

virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *	saveXMLParameters (XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *)
	Save current setting into a XML node. More...

bool	inputPresent (const std::string &name)
	Returns true if input pin (not request inputpin ) with given name is present. More...

bool	outputPresent (const std::string &name)
	Returns true if output pin (not request output pin) with given name is present. More...

void	addInputPin (InputPinBase *pin)
	Adds an input pin. More...

void	removeInputPin (InputPinBase *pin)
	Removes an input pin. More...

void	addOutputPin (OutputPinBase *pin)
	Adds an output pin. More...

void	removeOutputPin (OutputPinBase *pin)
	Removes and output pin. More...

void	addRequestInputPin (RequestInputPinBase *pin)
	Adds a request input pin. More...

void	removeRequestInputPin (RequestInputPinBase *pin)
	Removes a request input pin. More...

void	addRequestOutputPin (RequestOutputPinBase *pin)
	Adds a request output pin. More...

void	removeRequestOutputPin (RequestOutputPinBase *pin)
	Removes a request output pin. More...

bool	addNotification (BaseClass *receiver, unsigned long notificationTypes)
	Registers an observer that will be notified if a specific change occurs. More...

bool	removeNotification (BaseClass *receiver, unsigned long notificationTypes=NOTIFICATION_ALL)
	Unregisters a previously registered observer. More...

virtual void	processEvent (const std::string &input_name, VreckoMessage *pMessage)
	Internal method for processing the events. More...

virtual VreckoMessage *	processRequest (const std::string &request_input_name, VreckoMessage *pMessage)
	Internal method for processing the requests. More...

void	reportError (const std::string &error)
	Print error message. More...

void	setPriority (long int pr)
	Sets the priority. (Possible problems - read the full description for more info) More...

long int	getPriority (void) const
	Returns current object priority. More...

void	setAttribute (const std::string &attr_name, int attr_value)
	Sets an attribute value. More...

int	getAttribute (const std::string &attr_name)
	Returns attribute value. More...

int	getAttribute (const char *attr_name)
	Returns attribute value. More...

void	deleteAttribute (const std::string &attr_name)
	Delete an attribute. More...

void	setSceneFile (const std::string &sceneFileName)
	Set the name of the file this component was in (and possibly will be saved to). More...

const std::string &	getSceneFile () const
	Get the name of the file this component was in. More...

virtual void	preInitialize (void)
	OBSOLETE METHOD, kept for backwards compatibility. More...

virtual void	postInitialize (void)
	OBSOLETE METHOD, kept for backwards compatibility. More...

virtual bool	loadXMLParameters (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *)
	OBSOLETE METHOD, kept for backwards compatibility. More...

virtual bool	loadXMLParameters (const char *xmlString)
	OBSOLETE METHOD, kept for backwards compatibility. More...

InputPinBase *	getInputPin (const char *strName)
	Returns pointer to an input pin with specified name. More...

OutputPinBase *	getOutputPin (const char *strName)
	Returns pointer to an output pin with specified name. More...

RequestInputPinBase *	getRequestInputPin (const char *strName)
	Returns pointer to an request input pin with specified name. More...

RequestOutputPinBase *	getRequestOutputPin (const char *strName)
	Returns pointer to an input pin with specified name. More...

Static Public Attributes
static const int	maxPointers = 2

static const int	maxButtonsPerPointer = 4

Protected Member Functions
bool	createAbilityMapper ()

void	removeAbilityMapper ()

void	setAbilityMapping (AbilityMapper::MAPPING *newMapping)

AbilityMapper::MessageMapping *	compileAbilityMapping ()

void	setNewSelection (unsigned long newSelection)

void	pointerPosUpdate (int pointerID, const osg::Vec3 &newPos, bool bRaw=false)

void	pointerRotUpdate (int pointerID, const osg::Quat &newRot, bool bRaw=false)

void	pointerBtnUpdate (int poinerID, int buttonID, bool newState)

void	sendPointerBtnToRelevantOutputs (int pointerID, int buttonID)

void	pointerSelUpdate (int pointerID, unsigned long newSelection)

void	sendPointerSelectionEvent (int pointerID, unsigned long newSelection)

void	abilityActivationTest ()

void	selectionVisibilityUpdate ()

virtual int	processNotification (BaseClass sender, unsigned long notificationType, void notificationData)
	Process an incoming notification. More...

	DECLARE_INPUT (Pointer1Pos, MessageVec3)

	DECLARE_INPUT (Pointer1Rot, MessageQuat)

	DECLARE_INPUT (Pointer1PosRaw, MessageVec3)

	DECLARE_INPUT (Pointer1RotRaw, MessageQuat)

	DECLARE_INPUT (Pointer1Btn1, MessageBool)

	DECLARE_INPUT (Pointer1Btn2, MessageBool)

	DECLARE_INPUT (Pointer1Btn3, MessageBool)

	DECLARE_INPUT (Pointer1Btn4, MessageBool)

	DECLARE_INPUT (Pointer2Pos, MessageVec3)

	DECLARE_INPUT (Pointer2Rot, MessageQuat)

	DECLARE_INPUT (Pointer2PosRaw, MessageVec3)

	DECLARE_INPUT (Pointer2RotRaw, MessageQuat)

	DECLARE_INPUT (Pointer2Btn1, MessageBool)

	DECLARE_INPUT (Pointer2Btn2, MessageBool)

	DECLARE_INPUT (Pointer2Btn3, MessageBool)

	DECLARE_INPUT (Pointer2Btn4, MessageBool)

	DECLARE_OUTPUT (SelectionID, MessageObjectID)

	DECLARE_OUTPUT (Pointer1Selection, MessageObjectID)

	DECLARE_OUTPUT (Pointer1Visible, MessageBool)

	DECLARE_OUTPUT (Pointer2Selection, MessageObjectID)

	DECLARE_OUTPUT (Pointer2Visible, MessageBool)

	DECLARE_INPUT (AbilityMapping, AbilityMapper::MessageMapping)

	DECLARE_OUTPUT (AbilityMapping, AbilityMapper::MessageMapping)

	DECLARE_REQUEST_INPUT (AbilityMapping, MessageVoid, AbilityMapper::MessageMapping)

	DECLARE_REQUEST_OUTPUT (SelectionByPointerPos_Path, MessageVec3, MessageNodeList)

	DECLARE_REQUEST_INPUT (SelectionID, MessageInt, MessageObjectID)

	DECLARE_REQUEST_INPUT (SelectionPath, MessageInt, MessageNodeList)

	DECLARE_REQUEST_INPUT (PointerPos, MessageInt, MessageVec3)

	DECLARE_REQUEST_INPUT (PointerRot, MessageInt, MessageQuat)

	DECLARE_REQUEST_INPUT (PointerPosRaw, MessageInt, MessageVec3)

	DECLARE_REQUEST_INPUT (PointerRotRaw, MessageInt, MessageQuat)

Protected Member Functions inherited from vrecko::Ability
	Ability (const char *theAbilityName)

Protected Member Functions inherited from vrecko::BaseClass
bool	sendNotifications (unsigned long notificationType, void *notificationData)

IOPinBase *	findPinInList (const char strName, PinList pinList)
	Internal method to find a given pin in a given list. More...

Protected Attributes
EnvironmentObject *	owner

std::string	activeAbilityName

int	activeAbilityPointerID

int	activeAbilityButtonID

osg::Vec3	actViewPosition

ECPOINTERINFO	pointers [maxPointers+1]

Ability *	abilityMapper

unsigned long	actSelection

Protected Attributes inherited from vrecko::Ability
BaseClass *	pOwner
	Pointer to the owner of this ability. (Almost?) always an EnvironmentObject class. More...

std::vector< std::string >	parameterString

bool	updated
	Update flag. It is used for save. More...

Protected Attributes inherited from vrecko::BaseClass
AttributeMap	attribute

MTReadWriteLock	attributeLock

std::string	senderString

MTLock	notificationsLock

std::vector < NOTIFICATION_DESCRIPTION >	notifications

long int	priority

const std::string *	sceneFile

PinList	inputPinsList

PinList	outputPinsList

PinList	requestInputPinsList

PinList	requestOutputPinsList

Additional Inherited Members
Public Types inherited from vrecko::Ability
typedef std::vector < ParameterStruct >	ParameterVector
	Vector of the description of parameters. More...

Protected Types inherited from vrecko::BaseClass
typedef std::map< std::string, int >	AttributeMap
	Attributes. More...

typedef std::vector < osg::ref_ptr< IOPinBase > >	PinList

Constructor & Destructor Documentation

APEditorController::EditorController::EditorController ( )

APEditorController::EditorController::~EditorController ( )

Member Function Documentation

void APEditorController::EditorController::abilityActivationTest ( )

protected

AbilityMapper::MessageMapping * APEditorController::EditorController::compileAbilityMapping ( )

protected

bool APEditorController::EditorController::createAbilityMapper ( )

protected

APEditorController::EditorController::DECLARE_INPUT	(	Pointer1Pos	,
		MessageVec3
	)

protected

APEditorController::EditorController::DECLARE_INPUT	(	Pointer1Rot	,
		MessageQuat
	)

protected

APEditorController::EditorController::DECLARE_INPUT	(	Pointer1PosRaw	,
		MessageVec3
	)

protected

APEditorController::EditorController::DECLARE_INPUT	(	Pointer1RotRaw	,
		MessageQuat
	)

protected

APEditorController::EditorController::DECLARE_INPUT	(	Pointer1Btn1	,
		MessageBool
	)

protected

APEditorController::EditorController::DECLARE_INPUT	(	Pointer1Btn2	,
		MessageBool
	)

protected

APEditorController::EditorController::DECLARE_INPUT	(	Pointer1Btn3	,
		MessageBool
	)

protected

APEditorController::EditorController::DECLARE_INPUT	(	Pointer1Btn4	,
		MessageBool
	)

protected

APEditorController::EditorController::DECLARE_INPUT	(	Pointer2Pos	,
		MessageVec3
	)

protected

APEditorController::EditorController::DECLARE_INPUT	(	Pointer2Rot	,
		MessageQuat
	)

protected

APEditorController::EditorController::DECLARE_INPUT	(	Pointer2PosRaw	,
		MessageVec3
	)

protected

APEditorController::EditorController::DECLARE_INPUT	(	Pointer2RotRaw	,
		MessageQuat
	)

protected

APEditorController::EditorController::DECLARE_INPUT	(	Pointer2Btn1	,
		MessageBool
	)

protected

APEditorController::EditorController::DECLARE_INPUT	(	Pointer2Btn2	,
		MessageBool
	)

protected

APEditorController::EditorController::DECLARE_INPUT	(	Pointer2Btn3	,
		MessageBool
	)

protected

APEditorController::EditorController::DECLARE_INPUT	(	Pointer2Btn4	,
		MessageBool
	)

protected

APEditorController::EditorController::DECLARE_INPUT	(	AbilityMapping	,
		AbilityMapper::MessageMapping
	)

protected

APEditorController::EditorController::DECLARE_OUTPUT	(	SelectionID	,
		MessageObjectID
	)

protected

APEditorController::EditorController::DECLARE_OUTPUT	(	Pointer1Selection	,
		MessageObjectID
	)

protected

APEditorController::EditorController::DECLARE_OUTPUT	(	Pointer1Visible	,
		MessageBool
	)

protected

APEditorController::EditorController::DECLARE_OUTPUT	(	Pointer2Selection	,
		MessageObjectID
	)

protected

APEditorController::EditorController::DECLARE_OUTPUT	(	Pointer2Visible	,
		MessageBool
	)

protected

APEditorController::EditorController::DECLARE_OUTPUT	(	AbilityMapping	,
		AbilityMapper::MessageMapping
	)

protected

APEditorController::EditorController::DECLARE_REQUEST_INPUT	(	AbilityMapping	,
		MessageVoid	,
		AbilityMapper::MessageMapping
	)

protected

APEditorController::EditorController::DECLARE_REQUEST_INPUT	(	SelectionID	,
		MessageInt	,
		MessageObjectID
	)

protected

APEditorController::EditorController::DECLARE_REQUEST_INPUT	(	SelectionPath	,
		MessageInt	,
		MessageNodeList
	)

protected

APEditorController::EditorController::DECLARE_REQUEST_INPUT	(	PointerPos	,
		MessageInt	,
		MessageVec3
	)

protected

APEditorController::EditorController::DECLARE_REQUEST_INPUT	(	PointerRot	,
		MessageInt	,
		MessageQuat
	)

protected

APEditorController::EditorController::DECLARE_REQUEST_INPUT	(	PointerPosRaw	,
		MessageInt	,
		MessageVec3
	)

protected

APEditorController::EditorController::DECLARE_REQUEST_INPUT	(	PointerRotRaw	,
		MessageInt	,
		MessageQuat
	)

protected

APEditorController::EditorController::DECLARE_REQUEST_OUTPUT	(	SelectionByPointerPos_Path	,
		MessageVec3	,
		MessageNodeList
	)

protected

bool APEditorController::EditorController::initialize ( XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * parameters = NULL )

virtual

Core initialization.

It is important to place the initializing code here, because especially in the case of Abilities, this is the point when the ID and owner is known and we can react accordingly. (This information is unknown in the constructor.)

You will probably want to override this method. This method supersedes the original preInitialize() / loadXMLParameters() / postInitialize() methods, which are now obsolete, but for the sake of compatibility they are called from the initialize() if the method is not overridden. You can override it and forget about pre/postInitialize() or loadParameters() - it's now an old solution.

Parameters

parameters (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *) Pointer to a XML DOM node, might be NULL if no parameters were specified. The ability should initialize to default values in that case.

Returns: (bool) Returns true on success.

Reimplemented from vrecko::BaseClass.

void APEditorController::EditorController::pointerBtnUpdate	(	int	poinerID,
		int	buttonID,
		bool	newState
	)

protected

void APEditorController::EditorController::pointerPosUpdate	(	int	pointerID,
		const osg::Vec3 &	newPos,
		bool	bRaw = `false`
	)

protected

void APEditorController::EditorController::pointerRotUpdate	(	int	pointerID,
		const osg::Quat &	newRot,
		bool	bRaw = `false`
	)

protected

void APEditorController::EditorController::pointerSelUpdate	(	int	pointerID,
		unsigned long	newSelection
	)

protected

int APEditorController::EditorController::processNotification	(	BaseClass *	sender,
		unsigned long	notificationType,
		void *	notificationData
	)

protectedvirtual

Process an incoming notification.

Override this method to react to a registered notification (see addNotification() method).

Parameters

sender	(BaseClass *) The sender of the notification
notificationType	(unsigned long) Type of the notification, only ONE bit will be set
notificationData	(void *) Appropriate notification data, dependent on the notificationType.

Returns: (int) Should return 0, other values are reserved for future use.

Reimplemented from vrecko::BaseClass.

void APEditorController::EditorController::removeAbilityMapper ( )

protected

void APEditorController::EditorController::selectionVisibilityUpdate ( )

protected

void APEditorController::EditorController::sendPointerBtnToRelevantOutputs	(	int	pointerID,
		int	buttonID
	)

protected

void APEditorController::EditorController::sendPointerSelectionEvent	(	int	pointerID,
		unsigned long	newSelection
	)

protected

void APEditorController::EditorController::setAbilityMapping ( AbilityMapper::MAPPING * newMapping )

protected

void APEditorController::EditorController::setNewSelection ( unsigned long newSelection )

protected

void APEditorController::EditorController::update ( void )

virtual

This method is called periodically in case this instance is registered in Scheduler.

The method is called periodically at specified frequency or every frame. Use the Scheduler::addEntity() method to register your class and set the frequency.

Reimplemented from vrecko::BaseClass.

Member Data Documentation

Ability* APEditorController::EditorController::abilityMapper

protected

int APEditorController::EditorController::activeAbilityButtonID

protected

std::string APEditorController::EditorController::activeAbilityName

protected

int APEditorController::EditorController::activeAbilityPointerID

protected

unsigned long APEditorController::EditorController::actSelection

protected

osg::Vec3 APEditorController::EditorController::actViewPosition

protected

const int APEditorController::EditorController::maxButtonsPerPointer = 4

static

const int APEditorController::EditorController::maxPointers = 2

static

EnvironmentObject* APEditorController::EditorController::owner

protected

ECPOINTERINFO APEditorController::EditorController::pointers[maxPointers+1]

protected

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

C:/Documents/School/OSG/VRECKO/include/vreckoAP/EditorController/EditorController.h
C:/Documents/School/OSG/VRECKO/src/vreckoAP/EditorController/EditorController.cpp

Classes

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation