#include <CableEditor.h>

Inheritance diagram for AP_CableEditor::CableEditor:

Public Member Functions
	CableEditor ()

virtual	~CableEditor ()

virtual void	update (void)

bool	isCable (unsigned int pEoID)

osg::ref_ptr< osg::Vec3Array >	createCircle (unsigned int steps)

Public Member Functions inherited from vrecko::ControllableAbility
	ControllableAbility (const char *abilityName)

virtual	~ControllableAbility ()

virtual bool	isActive ()
	It shouldn't be necessary to override this function. 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 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...

Protected Member Functions
void	Init ()

void	preInit ()

virtual bool	initialize (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *parameters=NULL)

virtual void	fillDefaultInfo ()

virtual bool	activate ()

virtual void	deactivate ()

virtual void	menuItemClicked (const char *itemID)

virtual void	menuSliderChanged (const char *sliderID, float sliderPos)

virtual void	processButtonRelease (CABUTTONEVENT *eventData)

bool	makeMenu ()

Cable *	getCableAbility (unsigned int EoId, bool notify=false)

EnvironmentObject *	createEoAbility (bool addToWorld=true)

void	loadShapes ()

void	loadCables ()

void	saveCable (std::ofstream &outputFile, Cable *cable)

void	writeInfo (std::ofstream &outputFile)

virtual int	processNotification (BaseClass sender, unsigned long notificationType, void notificationData)

Protected Member Functions inherited from vrecko::ControllableAbility
virtual void	createInterface ()

virtual void	destroyInterface ()

virtual void	processButtonPress (CABUTTONEVENT *eventData)

virtual CAINFO *	createInfo ()

bool	requestPointerLoc (bool bCancelIfNotActive=true)

bool	requestPointerLocRaw (bool bCancelIfNotActive=true)

bool	requestSelectionID (bool bCancelIfNotActive=true)

bool	requestSelectionPath (bool bCancelIfNotActive=true)

bool	isMenuCreated ()

bool	isMenuVisible ()

virtual bool	createMenu (const char *menuString, bool bForceCreate=true)

virtual void	destroyMenu ()

virtual bool	showMenu ()

virtual bool	hideMenu ()

virtual void	processMenuButtonPress (CABUTTONEVENT *eventData)

virtual void	processMenuButtonRelease (CABUTTONEVENT *eventData)

	DECLARE_INPUT (ButtonStateChange, MessageCAButtonEvent)

	DECLARE_INPUT (Menu_Clicked, MessageString)

	DECLARE_REQUEST_INPUT (ActivePointerID, MessageInt, MessageInt)

	DECLARE_REQUEST_INPUT (GetInfo, MessageVoid, MessageCAINFO)

	DECLARE_REQUEST_OUTPUT (PointerPos, MessageInt, MessageVec3)

	DECLARE_REQUEST_OUTPUT (PointerRot, MessageInt, MessageQuat)

	DECLARE_REQUEST_OUTPUT (PointerPosRaw, MessageInt, MessageVec3)

	DECLARE_REQUEST_OUTPUT (PointerRotRaw, MessageInt, MessageQuat)

	DECLARE_REQUEST_OUTPUT (SelectionID, MessageInt, MessageObjectID)

	DECLARE_REQUEST_OUTPUT (SelectionPath, MessageInt, MessageNodeList)

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
unsigned int	cableID

unsigned int	selectedCableId

bool	isSelectedCable

bool	isAddingPointState

bool	isDeletingSphereState

bool	isInsertBetweenState

unsigned int	insertIndex

osg::Vec3f	newPoint

Cable *	selectedCablePtr

float	selectedCableBaseRadius

EnvironmentObject *	sphereBetweenPoints

std::string	cablesFile

std::string	shapesFile

std::string	objFileDest

std::vector< osg::ref_ptr < osg::Vec3Array > >	loadedShapes

std::vector< osg::ref_ptr < osg::Vec3Array > >	predefinedShapes

std::list< EnvironmentObject * >	cablePointers

Protected Attributes inherited from vrecko::ControllableAbility
EnvironmentObject *	owner
	The owner object. More...

int	activePointerID
	Active pointer ID or 0 if not active. More...

int	lastEventButtonID
	ID of a button that was received in the last button press/release event. More...

osg::Vec3	actPointerPos

osg::Vec3	actPointerPosRaw

osg::Quat	actPointerRot

osg::Quat	actPointerRotRaw

unsigned long	actSelectedObjectID

std::vector< osg::Node * > *	actSelectedPath

int	actPosInPath

CAINFO	defaultInfo

Ability *	menu

bool	bMenuVisible

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

AP_CableEditor::CableEditor::CableEditor ( )

AP_CableEditor::CableEditor::~CableEditor ( )

virtual

Member Function Documentation

bool AP_CableEditor::CableEditor::activate ( )

protectedvirtual

Called when the ability is about to be activated. Returns true if the ability is activated or false otherwise (so the activation will be cancelled). CAN/SHOULD be overriden to activate the ability properly, but should call the ancestor method and return "false" if the ancestor returned false too.

Reimplemented from vrecko::ControllableAbility.

osg::ref_ptr< osg::Vec3Array > AP_CableEditor::CableEditor::createCircle ( unsigned int steps )

EnvironmentObject * AP_CableEditor::CableEditor::createEoAbility ( bool addToWorld = true )

protected

void AP_CableEditor::CableEditor::deactivate ( )

protectedvirtual

Called when the ability is about to be deactivated. CAN be overridden to unlock used objects etc., but should call the ancestor method. You may wan to call isActive() in the overriden method to check whether the ability is really being deactivated.

Reimplemented from vrecko::ControllableAbility.

void AP_CableEditor::CableEditor::fillDefaultInfo ( )

protectedvirtual

MUST be overridden. The overridden method have to fill in the [defaultInfo]. The structure is already filled by zeroes and the size is set correctly, so you need to only change what is necessary. The [defaultInfo] is used as a base information that will be used in createInfo() method. The createInfo() may adjust some of the parameters and you can adjust it even further by overriding createInfo().

Implements vrecko::ControllableAbility.

Cable * AP_CableEditor::CableEditor::getCableAbility	(	unsigned int	EoId,
		bool	notify = `false`
	)

protected

void AP_CableEditor::CableEditor::Init ( )

protected

bool AP_CableEditor::CableEditor::initialize ( XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * parameters = NULL )

protectedvirtual

Called as the first initialization method COULD be overridden, but it HAS TO CALL the method from the ancestor class. But BETTER SOLUTION is to override the createInterface() and destroyInterface() functions instead.

Reimplemented from vrecko::ControllableAbility.

bool AP_CableEditor::CableEditor::isCable ( unsigned int pEoID )

void AP_CableEditor::CableEditor::loadCables ( )

protected

void AP_CableEditor::CableEditor::loadShapes ( )

protected

bool AP_CableEditor::CableEditor::makeMenu ( )

protected

void AP_CableEditor::CableEditor::menuItemClicked ( const char * itemID )

protectedvirtual

This method should be overridden for the menu to work. The [itemID] could be NULL in case the user hasn't clicked on any item. (It is expected that the menu will disappear.) If [itemID] is a valid pointer, it will contain the name (not caption) of the item clicked.

Reimplemented from vrecko::ControllableAbility.

void AP_CableEditor::CableEditor::menuSliderChanged	(	const char *	sliderID,
		float	sliderPos
	)

protectedvirtual

You should override this method if there is any slider in your menu.

Reimplemented from vrecko::ControllableAbility.

void AP_CableEditor::CableEditor::preInit ( )

protected

void AP_CableEditor::CableEditor::processButtonRelease ( CABUTTONEVENT * eventData )

protectedvirtual

This function must be able to handle also cases when [eventData] == NULL (which means the "standard button" has been released). SHOULD be overridden if any button functionality is required. If the menu is visible, this method won't be executed.

Reimplemented from vrecko::ControllableAbility.

int AP_CableEditor::CableEditor::processNotification	(	BaseClass *	sender,
		unsigned long	notificationType,
		void *	notificationData
	)

protectedvirtual

Processes any notification. If you ever override this method, you MUST call the overridden one (this one).

Reimplemented from vrecko::ControllableAbility.

void AP_CableEditor::CableEditor::saveCable	(	std::ofstream &	outputFile,
		Cable *	cable
	)

protected

void AP_CableEditor::CableEditor::update ( void )

virtual

Called by the VRECKO scheduler at the specified frequency. CAN be overridden, but it HAS TO CALL the method from the ancestor class. (For future updates)

Reimplemented from vrecko::ControllableAbility.

void AP_CableEditor::CableEditor::writeInfo ( std::ofstream & outputFile )

protected

Member Data Documentation

unsigned int AP_CableEditor::CableEditor::cableID

protected

std::list<EnvironmentObject *> AP_CableEditor::CableEditor::cablePointers

protected

std::string AP_CableEditor::CableEditor::cablesFile

protected

unsigned int AP_CableEditor::CableEditor::insertIndex

protected

bool AP_CableEditor::CableEditor::isAddingPointState

protected

bool AP_CableEditor::CableEditor::isDeletingSphereState

protected

bool AP_CableEditor::CableEditor::isInsertBetweenState

protected

bool AP_CableEditor::CableEditor::isSelectedCable

protected

std::vector<osg::ref_ptr<osg::Vec3Array> > AP_CableEditor::CableEditor::loadedShapes

protected

osg::Vec3f AP_CableEditor::CableEditor::newPoint

protected

std::string AP_CableEditor::CableEditor::objFileDest

protected

std::vector<osg::ref_ptr<osg::Vec3Array> > AP_CableEditor::CableEditor::predefinedShapes

protected

float AP_CableEditor::CableEditor::selectedCableBaseRadius

protected

unsigned int AP_CableEditor::CableEditor::selectedCableId

protected

Cable* AP_CableEditor::CableEditor::selectedCablePtr

protected

std::string AP_CableEditor::CableEditor::shapesFile

protected

EnvironmentObject* AP_CableEditor::CableEditor::sphereBetweenPoints

protected

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation