vrecko
virtual reality framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
APDYNAMICART::Ctrl_Attractor Class Reference

#include <Ctrl_Attractor.h>

Inheritance diagram for APDYNAMICART::Ctrl_Attractor:
APDYNAMICART::Controller vrecko::Ability vrecko::BaseClass

Public Member Functions

 Ctrl_Attractor ()
 
void activateTool ()
 
void clear ()
 clear controller - called before new scene is created or loaded More...
 
void createMenuStructure (osg::ref_ptr< vreckoUtils::MenuBase > parentMenu) const
 Creates structure of menu items for this Controller. More...
 
void createColorSubMenu (std::ostringstream &menuSS, Attractor *att) const
 
ref_ptr_PoA createPoA ()
 
void deactivateTool ()
 Called by Dynamic Art Environment (DAEnvironment) when user release "useTool" button. More...
 
void debugKeyPressed ()
 Called by Dynamic Art Environment (DAEnvironment) when user release "Debug Purpose" Key (F11 by default) More...
 
void initialize (DAEnvironment *p_dae, XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *parameters=NULL)
 
void load (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *parametersNode, XERCES_CPP_NAMESPACE_QUALIFIER DOMNodeList *poaNodeList)
 Load controller parameters and all PoAs from XML nodes. More...
 
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...
 
void update ()
 Scheduled for per-frame updates. More...
 
void guiItemClicked (const char *itemID)
 Called when user click on some item of GUI - icon, slider, menu item, ... More...
 
void guiSliderChanged (const char *sliderID, float sliderPos)
 Called when user moves with some GUI slider (menu sliders counts as well) More...
 
void switchGUIVisibility ()
 
void turnOn ()
 Called when Dynamic Art Environment (DAEnvironment) context is switched to this controller. More...
 
void turnOff ()
 Called when Dynamic Art Environment (DAEnvironment) context is switched to another controller. More...
 
- 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 removePoA (PoA *toRemove)
 Remove single PoA. More...
 
virtual DAToolType getNextToolType ()
 set pointer to Dynamic Art Environment ability More...
 
virtual void switchTools (DAToolType newType)
 switching between tools More...
 
std::vector< ref_ptr_PoA > * getPoAs ()
 
virtual void setColour (osg::Vec4 newColour)
 
- 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...
 
BaseClassgetOwner (void)
 Returns the ability owner. More...
 
virtual ParameterVectorgetParameterVector (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 VreckoMessageprocessRequest (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...
 
InputPinBasegetInputPin (const char *strName)
 Returns pointer to an input pin with specified name. More...
 
OutputPinBasegetOutputPin (const char *strName)
 Returns pointer to an output pin with specified name. More...
 
RequestInputPinBasegetRequestInputPin (const char *strName)
 Returns pointer to an request input pin with specified name. More...
 
RequestOutputPinBasegetRequestOutputPin (const char *strName)
 Returns pointer to an input pin with specified name. More...
 

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
 
- Protected Member Functions inherited from APDYNAMICART::Controller
void initTools ()
 Init available tools (filled in _tools) More...
 
- 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...
 

Detailed Description

Controller class for attractor management

Author
Martin Bezdeka, Jiri Chmelik
Date
Id:
Ctrl_Attractor.h 436 2012-10-12 08:57:42Z xchmeli1

Constructor & Destructor Documentation

APDYNAMICART::Ctrl_Attractor::Ctrl_Attractor ( )

Constructor

Member Function Documentation

void APDYNAMICART::Ctrl_Attractor::activateTool ( )
virtual

Inherited methods from Controller

Implements APDYNAMICART::Controller.

void APDYNAMICART::Ctrl_Attractor::clear ( void  )
virtual

clear controller - called before new scene is created or loaded

Implements APDYNAMICART::Controller.

void APDYNAMICART::Ctrl_Attractor::createColorSubMenu ( std::ostringstream &  menuSS,
Attractor att 
) const
void APDYNAMICART::Ctrl_Attractor::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.

ref_ptr_PoA APDYNAMICART::Ctrl_Attractor::createPoA ( )
void APDYNAMICART::Ctrl_Attractor::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.

void APDYNAMICART::Ctrl_Attractor::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_Attractor::guiItemClicked ( const char *  itemID)
virtual

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

Parameters
itemIDcontains 'name' of menu item.

Implements APDYNAMICART::Controller.

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

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

Parameters
sliderIDcontains 'name' of menu item
valuecontains current value of slider

Implements APDYNAMICART::Controller.

void APDYNAMICART::Ctrl_Attractor::initialize ( DAEnvironment p_dae,
XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  parameters = NULL 
)
virtual
void APDYNAMICART::Ctrl_Attractor::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_Attractor::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.

void APDYNAMICART::Ctrl_Attractor::switchGUIVisibility ( )
inlinevirtual
void APDYNAMICART::Ctrl_Attractor::turnOff ( )
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_Attractor::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_Attractor::update ( )
virtual

Scheduled for per-frame updates.

Implements APDYNAMICART::Controller.


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