vrecko
virtual reality framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
vrecko::ControllableAbility Class Referenceabstract

#include <ControllableAbility.h>

Inheritance diagram for vrecko::ControllableAbility:
vrecko::Ability vrecko::BaseClass AP_CableEditor::CableEditor APCameraMovement::CameraMovementEditor APCameraPath::Camera APConnectEditor::ConnectEditor APConnectEditor::Cut APConnectEditor::Optimalizer APConnectEditor::PolygonState APConnectEditor::Rotation APConnectEditor::Scale APConstrainedMovement::ConstrainedObjectMovement APEditorController::AbilityMapper APEditorQAbilities::AbilityEditor APEditorQAbilities::AnimatorEditor APEditorQAbilities::AvatarMovement APEditorQAbilities::ObjectAdd APEditorQAbilities::ObjectDelete APEditorQAbilities::ObjectMovement APEditorQAbilities::SceneSave APEditorQAbilities::SimpleObjectMovement APEditorQAbilities::UseTrigger APFFDEditor::EditorLogic APLightsEditor::Editor APRoomEdit::RoomEditor

Classes

class  MessageCAINFO
 

Public Member Functions

 ControllableAbility (const char *abilityName)
 
virtual ~ControllableAbility ()
 
virtual bool initialize (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *parameters=NULL)
 
virtual void update ()
 
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...
 
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 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 (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...
 

Protected Member Functions

virtual void createInterface ()
 
virtual void destroyInterface ()
 
virtual void processButtonPress (CABUTTONEVENT *eventData)
 
virtual void processButtonRelease (CABUTTONEVENT *eventData)
 
virtual int processNotification (BaseClass *sender, unsigned long notificationType, void *notificationData)
 
virtual bool activate ()
 
virtual void deactivate ()
 
virtual CAINFOcreateInfo ()
 
virtual void fillDefaultInfo ()=0
 
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)
 
virtual void menuItemClicked (const char *itemID)
 
virtual void menuSliderChanged (const char *sliderID, float sliderPos)
 
 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)
 
IOPinBasefindPinInList (const char *strName, PinList *pinList)
 Internal method to find a given pin in a given list. More...
 

Protected Attributes

EnvironmentObjectowner
 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
 
Abilitymenu
 
bool bMenuVisible
 
- Protected Attributes inherited from vrecko::Ability
BaseClasspOwner
 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

EDITORCONTROLLER_IMP_EXP vrecko::ControllableAbility::ControllableAbility ( const char *  abilityName)
EDITORCONTROLLER_IMP_EXP vrecko::ControllableAbility::~ControllableAbility ( )
virtual

Member Function Documentation

EDITORCONTROLLER_IMP_EXP CAINFO * vrecko::ControllableAbility::createInfo ( )
protectedvirtual
        This method creates a new instance of the CAINFO structure and copies data
        from the [defaltInfo] structure. Additionally, it may change
        some of the parameters of the new structure (especially [dwActiveFlags]).

        CAN be overridden although it is unnecessary in most cases.
        The overridden method should look like this:

        You have complete control over the structure, but some field have
        been already pre-filled: Especially size and some the [dwActiveFlags].
        The [dwActiveFlags] has been changed according to the current state of the ability
        (is Menu displayed -> prefer not to show the selections etc.)
        You can still change any of the attributes.

        CAINFO* info = ControllableAbility::createInfo();
        if (!info)
            return NULL;

Now adjust the members of the structure. Note: If adjusting for example info->dwActiveFlags for selection visibility, ... // you have to use the mask. For example, to set the visibility to _ACTPTR_FORCESHOW: info->dwActiveFlags = CAINFO_AFLAGS_SELSHOW_ACTPTR_FORCESHOW | (info->dwActiveFlags & ~CAINFO_AFLAGS_SELSHOW_ACTPTR__MASK);

        return info;

Reimplemented in APConstrainedMovement::ConstrainedObjectMovement, and APEditorQAbilities::ObjectMovement.

EDITORCONTROLLER_IMP_EXP void vrecko::ControllableAbility::createInterface ( )
protectedvirtual

Method for creating the input/outputs/requests. If overridden, it has to call the ancestor method. This is the method to override, if you need to add any other inputs/outputs etc. Then you also have to override the destroyInterface() to destroy these connections. Please see notes about destroyInterface() to use it properly (!)

Reimplemented in APEditorController::AbilityMapper.

EDITORCONTROLLER_IMP_EXP bool vrecko::ControllableAbility::createMenu ( const char *  menuString,
bool  bForceCreate = true 
)
protectedvirtual

If [bForceCreate] is "false", then the menu is NOT created if it was already created before.

EDITORCONTROLLER_IMP_EXP void vrecko::ControllableAbility::deactivate ( )
protectedvirtual
vrecko::ControllableAbility::DECLARE_INPUT ( ButtonStateChange  ,
MessageCAButtonEvent   
)
protected
vrecko::ControllableAbility::DECLARE_INPUT ( Menu_Clicked  ,
MessageString   
)
protected
vrecko::ControllableAbility::DECLARE_REQUEST_INPUT ( ActivePointerID  ,
MessageInt  ,
MessageInt   
)
protected
vrecko::ControllableAbility::DECLARE_REQUEST_INPUT ( GetInfo  ,
MessageVoid  ,
MessageCAINFO   
)
protected
vrecko::ControllableAbility::DECLARE_REQUEST_OUTPUT ( PointerPos  ,
MessageInt  ,
MessageVec3   
)
protected
vrecko::ControllableAbility::DECLARE_REQUEST_OUTPUT ( PointerRot  ,
MessageInt  ,
MessageQuat   
)
protected
vrecko::ControllableAbility::DECLARE_REQUEST_OUTPUT ( PointerPosRaw  ,
MessageInt  ,
MessageVec3   
)
protected
vrecko::ControllableAbility::DECLARE_REQUEST_OUTPUT ( PointerRotRaw  ,
MessageInt  ,
MessageQuat   
)
protected
vrecko::ControllableAbility::DECLARE_REQUEST_OUTPUT ( SelectionID  ,
MessageInt  ,
MessageObjectID   
)
protected
vrecko::ControllableAbility::DECLARE_REQUEST_OUTPUT ( SelectionPath  ,
MessageInt  ,
MessageNodeList   
)
protected
EDITORCONTROLLER_IMP_EXP void vrecko::ControllableAbility::destroyInterface ( )
protectedvirtual

Destroys the inputs/outputs/requests. If you override it, you have to:

  • call the ancestor method in you new method.
  • (!) call the destroyInterface in your destructor (this is necessary because of some virtual table problems in C++)
EDITORCONTROLLER_IMP_EXP void vrecko::ControllableAbility::destroyMenu ( )
protectedvirtual
virtual void vrecko::ControllableAbility::fillDefaultInfo ( )
protectedpure virtual
EDITORCONTROLLER_IMP_EXP bool vrecko::ControllableAbility::hideMenu ( )
protectedvirtual
EDITORCONTROLLER_IMP_EXP bool vrecko::ControllableAbility::initialize ( XERCES_CPP_NAMESPACE_QUALIFIER DOMNode parameters = NULL)
virtual

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::BaseClass.

Reimplemented in AP_CableEditor::CableEditor, APLightsEditor::Editor, APCameraPath::Camera, APRoomEdit::RoomEditor, APEditorQAbilities::ObjectMovement, and APEditorQAbilities::AbilityEditor.

EDITORCONTROLLER_IMP_EXP bool vrecko::ControllableAbility::isActive ( )
virtual

It shouldn't be necessary to override this function.

bool vrecko::ControllableAbility::isMenuCreated ( )
inlineprotected
EDITORCONTROLLER_IMP_EXP bool vrecko::ControllableAbility::isMenuVisible ( )
protected

This method may issue a request to detect the current state of the menu.

virtual void vrecko::ControllableAbility::menuItemClicked ( const char *  itemID)
inlineprotectedvirtual

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 in APCameraPath::Camera, AP_CableEditor::CableEditor, APLightsEditor::Editor, APCameraMovement::CameraMovementEditor, APEditorController::AbilityMapper, APEditorQAbilities::AbilityEditor, APConnectEditor::Cut, APFFDEditor::EditorLogic, APEditorQAbilities::AnimatorEditor, APConnectEditor::PolygonState, APEditorQAbilities::ObjectAdd, APEditorQAbilities::ObjectDelete, and APEditorQAbilities::SceneSave.

virtual void vrecko::ControllableAbility::menuSliderChanged ( const char *  sliderID,
float  sliderPos 
)
inlineprotectedvirtual

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

Reimplemented in AP_CableEditor::CableEditor, APLightsEditor::Editor, and APFFDEditor::EditorLogic.

virtual void vrecko::ControllableAbility::processButtonPress ( CABUTTONEVENT eventData)
inlineprotectedvirtual

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

Reimplemented in APRoomEdit::RoomEditor, and APConstrainedMovement::ConstrainedObjectMovement.

virtual void vrecko::ControllableAbility::processButtonRelease ( CABUTTONEVENT eventData)
inlineprotectedvirtual

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 in AP_CableEditor::CableEditor, APRoomEdit::RoomEditor, APConnectEditor::ConnectEditor, APEditorQAbilities::AbilityEditor, APConstrainedMovement::ConstrainedObjectMovement, and APConnectEditor::Optimalizer.

EDITORCONTROLLER_IMP_EXP void vrecko::ControllableAbility::processMenuButtonPress ( CABUTTONEVENT eventData)
protectedvirtual

Sending the button press to the menu ability. Descendants should not need to override this function.

EDITORCONTROLLER_IMP_EXP void vrecko::ControllableAbility::processMenuButtonRelease ( CABUTTONEVENT eventData)
protectedvirtual

Sending the button release to the menu ability. Descendants should not need to override this function.

EDITORCONTROLLER_IMP_EXP int vrecko::ControllableAbility::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::BaseClass.

Reimplemented in AP_CableEditor::CableEditor.

EDITORCONTROLLER_IMP_EXP bool vrecko::ControllableAbility::requestPointerLoc ( bool  bCancelIfNotActive = true)
protected

Requests the "real" pointer position and orientation and stores it in [actPointerPos] and [actPointerRot] member variables. Works only when CAINFO_FLAGS_POINTERLOC_REQUESTOUPUTS is specified in CAINFO::dwFlags in GetInfo() function.

EDITORCONTROLLER_IMP_EXP bool vrecko::ControllableAbility::requestPointerLocRaw ( bool  bCancelIfNotActive = true)
protected

Requests the "raw" pointer position and orientation and stores it in [actPointerPosRaw] and [actPointerRotRaw] member variables. Works only when CAINFO_FLAGS_POINTERLOC_RAW_REQUESTOUPUTS is specified in CAINFO::dwFlags in GetInfo() function.

EDITORCONTROLLER_IMP_EXP bool vrecko::ControllableAbility::requestSelectionID ( bool  bCancelIfNotActive = true)
protected

Requests the current SELECTION (ONLY) of the active pointer and stores it in [actSelectedObjectID] member variable. Returns "true" if the request finished successfully (doesn't imply that something is selected!). Works only when CAINFO_FLAGS_SELECTIONID_REQUESTOUTPUT is specified in CAINFO::dwFlags in GetInfo() function.

EDITORCONTROLLER_IMP_EXP bool vrecko::ControllableAbility::requestSelectionPath ( bool  bCancelIfNotActive = true)
protected

Requests the current SELECTION AND selection PATH of the active pointer and stores it in [actSelectedObjectID] + [actSelectedPath] + [actPosInPath] member variables. Returns "true" if the request finished successfully (doesn't imply that something is selected!). Works only when CAINFO_FLAGS_SELECTIONID_REQUESTOUTPUT is specified in CAINFO::dwFlags in GetInfo() function.

EDITORCONTROLLER_IMP_EXP bool vrecko::ControllableAbility::showMenu ( )
protectedvirtual
virtual void vrecko::ControllableAbility::update ( void  )
inlinevirtual

Member Data Documentation

int vrecko::ControllableAbility::activePointerID
protected

Active pointer ID or 0 if not active.

osg::Vec3 vrecko::ControllableAbility::actPointerPos
protected

"Real" pointer position (including view transformation) as received from [POINTERPOS_REQUEST_NAME] request output.

NOTE: You have to call requestPointerLoc() method to update this member variable (it is not updated automatically). Works only when CAINFO_FLAGS_POINTERLOC_REQUESTOUPUTS is specified in CAINFO::dwFlags in GetInfo() function.

osg::Vec3 vrecko::ControllableAbility::actPointerPosRaw
protected

"Raw" pointer position (not including the view transformation) as received from [POINTERPOS_RAW_REQUEST_NAME] request output.

NOTE: You have to call requestPointerLocRaw() method to update this member variable (it is not updated automatically).

Works only when CAINFO_FLAGS_POINTERLOC_RAW_REQUESTOUPUTS is specified in CAINFO::dwFlags in GetInfo() function.

osg::Quat vrecko::ControllableAbility::actPointerRot
protected

"Real" pointer rotation (including the view transformation) as received from [POINTERROT_REQUEST_NAME] request output.

NOTE: You have to call requestPointerLoc() method to update this member variable (it is not updated automatically).

Works only when CAINFO_FLAGS_POINTERLOC_REQUESTOUPUTS is specified in CAINFO::dwFlags in GetInfo() function.

osg::Quat vrecko::ControllableAbility::actPointerRotRaw
protected

"Raw" pointer rotation (not including the view transformation) as received from [POINTERROT_RAW_REQUEST_NAME] request output. Works only when CAINFO_FLAGS_POINTERLOC_RAW_REQUESTOUPUTS is specified in CAINFO::dwFlags in GetInfo() function.

int vrecko::ControllableAbility::actPosInPath
protected

The position of the selected object in the path. Can be -1 if not applicable. The variable is also set in requestSelectionPath() method.

unsigned long vrecko::ControllableAbility::actSelectedObjectID
protected

Selected object is received from [SELECTIONID_REQUEST_NAME] request output. This variable is updated every time requestSelectionID() or requestSelectionPath() methods are called. Works only when CAINFO_FLAGS_SELECTIONID_REQUESTOUTPUT is specified in CAINFO::dwFlags in GetInfo() method.

std::vector<osg::Node*>* vrecko::ControllableAbility::actSelectedPath
protected

Path to the selected object from the root of the scene (first in the vector). This variable is updated by requestSelectionPath() method, which requires CAINFO_FLAGS_SELECTIONID_REQUESTOUTPUT to be specified in CAINFO::dwFlags in GetInfo() method.

IMPORTANT NOTE: The final Node on the path is the real section (some Geometry etc.) and it doesn't need to be the EnvironmentObject. The usual path is something like this: Root -> ... EOs/Transforms/other Nodes ... -> selected EO -> ... something else, but no other EOs

bool vrecko::ControllableAbility::bMenuVisible
protected
CAINFO vrecko::ControllableAbility::defaultInfo
protected
int vrecko::ControllableAbility::lastEventButtonID
protected

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

Ability* vrecko::ControllableAbility::menu
protected

To get the menu selection the menuItemClicked() method should be overriden.

EnvironmentObject* vrecko::ControllableAbility::owner
protected

The owner object.


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