#include <Ctrl_PolyhedraSculptures.h>

Inheritance diagram for APDYNAMICART::Ctrl_PolyhedraSculptures:

Public Member Functions
virtual void	activateTool ()

virtual void	clear ()
	clear controller - called before new scene is created or loaded More...

virtual void	createMenuStructure (osg::ref_ptr< vreckoUtils::MenuBase > parentMenu) const
	Creates structure of menu items for this Controller. More...

void	CreatePoA (const string &polyhedronName)

virtual void	deactivateTool ()
	Called by Dynamic Art Environment (DAEnvironment) when user release "useTool" button. More...

virtual void	debugKeyPressed ()
	Called by Dynamic Art Environment (DAEnvironment) when user release "Debug Purpose" Key (F11 by default) More...

virtual void	guiItemClicked (const char *itemID)
	Called when user click on some item of GUI - icon, slider, menu item, ... More...

virtual void	guiSliderChanged (const char *sliderID, float sliderPos)
	Called when user moves with some GUI slider (menu sliders counts as well) More...

virtual void	initialize (DAEnvironment p_dae, XERCES_CPP_NAMESPACE_QUALIFIER DOMNode parameters=NULL)

virtual void	load (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode parametersNode, XERCES_CPP_NAMESPACE_QUALIFIER DOMNodeList poaNodeList)
	Load controller parameters and all PoAs from XML nodes. More...

virtual void	save (XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument Document, XERCES_CPP_NAMESPACE_QUALIFIER DOMNode controllerNode)
	save controller settings (if there are some) and all PoAs to XML node More...

virtual void	switchTools (DAToolType newType)
	switching between tools More...

virtual void	setColour (osg::Vec4 newColour)

virtual void	switchGUIVisibility ()

virtual void	turnOn ()
	Called when Dynamic Art Environment (DAEnvironment) context is switched to this controller. More...

virtual void	turnOff (void)
	Called when Dynamic Art Environment (DAEnvironment) context is switched to another controller. More...

virtual void	update ()
	Scheduled for per-frame updates. More...

	Ctrl_PolyhedraSculptures ()

	~Ctrl_PolyhedraSculptures ()

Public Member Functions inherited from APDYNAMICART::Controller
	Controller (const char controllerID, const char description, PoAType type)

	~Controller ()

void	clearAllPoAs ()

const char *	getDescription (void) const

const PoAType	getType (void) const
	Returns type of this controller. More...

const char *	getPoAsName (void) const
	Return name of ... More...

float	getDaareaScale () const
	scale of dynamic art area More...

bool	isEmpty ()

void	preInitialize ()

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

void	removePoA (PoA *toRemove)
	Remove single PoA. More...

virtual DAToolType	getNextToolType ()
	set pointer to Dynamic Art Environment ability More...

std::vector< ref_ptr_PoA > *	getPoAs ()

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	initialize (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *parameters=NULL)
	Core initialization. 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 (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...

Protected Member Functions
MenuPtr	createNewPolyhedraMenu () const

Protected Member Functions inherited from APDYNAMICART::Controller
void	initTools ()
	Init available tools (filled in _tools) More...

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)

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

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

Protected Attributes
bool	isThereaSculpture

osg::ref_ptr< PolyhedraSculpture >	_sculpture

Protected Attributes inherited from APDYNAMICART::Controller
const char *	_description
	users friendly name of controller / context... such as "Free-hand Painting". Appears in menus. More...

const PoAType	_type
	Type of this controller - type of contained PoAs. More...

const char *	_poasName

EnvironmentObject *	_artArea
	Art Area = owner of this ability. More...

DAEnvironment *	_daEnvironment
	pointer to DA environment More...

std::vector< ref_ptr_PoA > *	_poas
	vector containing all PoAs of this controller More...

DATool *	_actualTool
	pointer to actual tool More...

DATools	_tools
	Available tools. 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

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

Static Public Member Functions inherited from APDYNAMICART::Controller
static const PoAType	getType (std::string type)

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::Ctrl_PolyhedraSculptures::Ctrl_PolyhedraSculptures ( )

Constructor & Destructor

APDYNAMICART::Ctrl_PolyhedraSculptures::~Ctrl_PolyhedraSculptures ( )

Member Function Documentation

void APDYNAMICART::Ctrl_PolyhedraSculptures::activateTool ( )

virtual

Inherited virtual methods - Controller

Implements APDYNAMICART::Controller.

void APDYNAMICART::Ctrl_PolyhedraSculptures::clear ( void )

virtual

clear controller - called before new scene is created or loaded

Implements APDYNAMICART::Controller.

void APDYNAMICART::Ctrl_PolyhedraSculptures::createMenuStructure ( osg::ref_ptr< vreckoUtils::MenuBase > parentMenu ) const

virtual

Creates structure of menu items for this Controller.

Returns: xml description of menu items as string

Implements APDYNAMICART::Controller.

MenuPtr APDYNAMICART::Ctrl_PolyhedraSculptures::createNewPolyhedraMenu ( ) const

protected

Helper methods

void APDYNAMICART::Ctrl_PolyhedraSculptures::CreatePoA ( const string & polyhedronName )

void APDYNAMICART::Ctrl_PolyhedraSculptures::deactivateTool ( )

virtual

Called by Dynamic Art Environment (DAEnvironment) when user release "useTool" button.

do whatever is necessary before deactivation of tool deactivate current tool (or multiple tools)

Implements APDYNAMICART::Controller.

virtual void APDYNAMICART::Ctrl_PolyhedraSculptures::debugKeyPressed ( )

inlinevirtual

Called by Dynamic Art Environment (DAEnvironment) when user release "Debug Purpose" Key (F11 by default)

do whatever helps you...

Implements APDYNAMICART::Controller.

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

virtual

Called when user click on some item of GUI - icon, slider, menu item, ...

Parameters

itemID contains 'name' of menu item.

Implements APDYNAMICART::Controller.

void APDYNAMICART::Ctrl_PolyhedraSculptures::guiSliderChanged	(	const char *	sliderID,
		float	sliderPos
	)

virtual

Called when user moves with some GUI slider (menu sliders counts as well)

Parameters

sliderID	contains 'name' of menu item
value	contains current value of slider

Implements APDYNAMICART::Controller.

void APDYNAMICART::Ctrl_PolyhedraSculptures::initialize	(	DAEnvironment *	p_dae,
		XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *	parameters = `NULL`
	)

virtual

Implements APDYNAMICART::Controller.

void APDYNAMICART::Ctrl_PolyhedraSculptures::load	(	XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *	parametersNode,
		XERCES_CPP_NAMESPACE_QUALIFIER DOMNodeList *	poaNodeList
	)

virtual

Load controller parameters and all PoAs from XML nodes.

Implements APDYNAMICART::Controller.

void APDYNAMICART::Ctrl_PolyhedraSculptures::save	(	XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *	Document,
		XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *	controllerNode
	)

virtual

save controller settings (if there are some) and all PoAs to XML node

Implements APDYNAMICART::Controller.

virtual void APDYNAMICART::Ctrl_PolyhedraSculptures::setColour ( osg::Vec4 newColour )

inlinevirtual

Reimplemented from APDYNAMICART::Controller.

virtual void APDYNAMICART::Ctrl_PolyhedraSculptures::switchGUIVisibility ( )

inlinevirtual

Implements APDYNAMICART::Controller.

void APDYNAMICART::Ctrl_PolyhedraSculptures::switchTools ( DAToolType newType )

virtual

switching between tools

_actualTool->turnOff()
switch tools - do whatever is necessary
_actualTool->turnOn()

Reimplemented from APDYNAMICART::Controller.

void APDYNAMICART::Ctrl_PolyhedraSculptures::turnOff ( void )

virtual

Called when Dynamic Art Environment (DAEnvironment) context is switched to another controller.

do whatever is necessary when this controller stops (pause)

Implements APDYNAMICART::Controller.

void APDYNAMICART::Ctrl_PolyhedraSculptures::turnOn ( )

virtual

Called when Dynamic Art Environment (DAEnvironment) context is switched to this controller.

do whatever is necessary when this controller starts

Implements APDYNAMICART::Controller.

void APDYNAMICART::Ctrl_PolyhedraSculptures::update ( )

virtual

Scheduled for per-frame updates.

Implements APDYNAMICART::Controller.

Member Data Documentation

osg::ref_ptr<PolyhedraSculpture> APDYNAMICART::Ctrl_PolyhedraSculptures::_sculpture

protected

bool APDYNAMICART::Ctrl_PolyhedraSculptures::isThereaSculpture

protected

Helper methods

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation