#include <ToolHook.h>

Inheritance diagram for APDYNAMICART::ToolHook:

Public Member Functions
	ToolHook ()

virtual void	activate ()

virtual void	deactivate ()
	Deactivate tool. More...

virtual void	turnOn ()
	"Start" tool More...

virtual void	turnOff ()
	"Stop" tool More...

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

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

float	getRopeRadius () const

std::string	createMenuStructure ()

void	guiItemClicked (const char *itemID)

void	menuSliderChanged (const char *sliderID, float sliderPos)

Public Member Functions inherited from APDYNAMICART::DATool
	DATool (const char *abilityName)

	~DATool ()

void	createCursor (EnvironmentObject *parent, string fileName)
	Create new EO, load geometry from given file and attach it to parent EnvironmentObject. More...

EnvironmentObject *	getCursor ()

DAToolType	getType ()

osg::Vec3 *	getSize ()

bool	isActive ()

void	setSize (osg::Vec3 p_size)
	set size of tool and optional its visual cursor, too More...

void	setPoA (osg::ref_ptr< PoA > newPoa)
	Set reference pointer to PoA to work with. 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...

Public Member Functions inherited from vreckoUtils::Observable
void	addObserver (Observer *observer)

void	removeObserver (Observer *observer)

void	notifyObservers (void *userData=NULL)

Protected Member Functions
PoA *	getSelectedPoA ()

osg::Vec3	getCursorPosition ()

void	initMenu ()

	DECLARE_REQUEST_OUTPUT (SensorTransformation, MessageInt, MessageSensorTransformation)

	DECLARE_REQUEST_OUTPUT (SelectedObjectID, MessageInt, MessageObjectID)

	DECLARE_INPUT (GUIItemClicked, MessageString)

	DECLARE_INPUT (CreateMenuStructure, MessageInt)

	DECLARE_INPUT (HidingMenu, MessageBool)

	DECLARE_OUTPUT (MenuStructure, MessageString)

Protected Attributes
osg::Vec3	_DAAposition

osg::Quat	_DAAOrientation

osg::Vec3	_DAAScale

HoopPtr	_poa

osg::Vec3	_hookPosition

float	_ropeRadius

APGUI::Menu *	_menuAbility

APGUI::GUI_Controller *	_guiController

osg::Vec3	_axis

Protected Attributes inherited from APDYNAMICART::DATool
DAToolType	toolType
	Type of tool. More...

DAEnvironment *	_daEnvironment
	DAEnvironment. More...

EnvironmentObject *	_daArea
	owner of this ability More...

bool	active
	Is active right now? More...

osg::ref_ptr< PoA >	_poa
	actual _poa More...

osg::ref_ptr< EnvironmentObject >	_cursor
	visual cursor of tool More...

osg::Vec3 *	size
	Size (area of influence) of tool. More...

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

Protected Attributes inherited from vreckoUtils::Observable
std::vector< Observer * >	_observers

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

APDYNAMICART::ToolHook::ToolHook ( )

Member Function Documentation

void APDYNAMICART::ToolHook::activate ( )

virtual

Inherited virtual methods

Implements APDYNAMICART::DATool.

std::string APDYNAMICART::ToolHook::createMenuStructure ( void )

Menu methods

void APDYNAMICART::ToolHook::deactivate ( )

virtual

Deactivate tool.

Implements APDYNAMICART::DATool.

APDYNAMICART::ToolHook::DECLARE_INPUT	(	GUIItemClicked	,
		MessageString
	)

protected

Menu inputs/outputs

APDYNAMICART::ToolHook::DECLARE_INPUT	(	CreateMenuStructure	,
		MessageInt
	)

protected

APDYNAMICART::ToolHook::DECLARE_INPUT	(	HidingMenu	,
		MessageBool
	)

protected

APDYNAMICART::ToolHook::DECLARE_OUTPUT	(	MenuStructure	,
		MessageString
	)

protected

APDYNAMICART::ToolHook::DECLARE_REQUEST_OUTPUT	(	SensorTransformation	,
		MessageInt	,
		MessageSensorTransformation
	)

protected

Debug and test purposes Message and request declarations

APDYNAMICART::ToolHook::DECLARE_REQUEST_OUTPUT	(	SelectedObjectID	,
		MessageInt	,
		MessageObjectID
	)

protected

osg::Vec3 APDYNAMICART::ToolHook::getCursorPosition ( )

protected

float APDYNAMICART::ToolHook::getRopeRadius ( ) const

inline

Getters

PoA * APDYNAMICART::ToolHook::getSelectedPoA ( )

protected

Helper methods

void APDYNAMICART::ToolHook::guiItemClicked ( const char * itemID )

bool APDYNAMICART::ToolHook::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 APDYNAMICART::ToolHook::initMenu ( )

protected

void APDYNAMICART::ToolHook::menuSliderChanged	(	const char *	sliderID,
		float	sliderPos
	)

void APDYNAMICART::ToolHook::turnOff ( )

virtual

"Stop" tool

Implements APDYNAMICART::DATool.

void APDYNAMICART::ToolHook::turnOn ( )

virtual

"Start" tool

Implements APDYNAMICART::DATool.

void APDYNAMICART::ToolHook::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

osg::Vec3 APDYNAMICART::ToolHook::_axis

protected

osg::Quat APDYNAMICART::ToolHook::_DAAOrientation

protected

osg::Vec3 APDYNAMICART::ToolHook::_DAAposition

protected

osg::Vec3 APDYNAMICART::ToolHook::_DAAScale

protected

APGUI::GUI_Controller* APDYNAMICART::ToolHook::_guiController

protected

osg::Vec3 APDYNAMICART::ToolHook::_hookPosition

protected

APGUI::Menu* APDYNAMICART::ToolHook::_menuAbility

protected

HoopPtr APDYNAMICART::ToolHook::_poa

protected

float APDYNAMICART::ToolHook::_ropeRadius

protected

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation