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

#include <Wiimote.h>

Inheritance diagram for vreckoDP_base::Wiimote:
vrecko::Device vrecko::BaseClass

Public Member Functions

 Wiimote ()
 
 ~Wiimote ()
 
virtual int openDevice (void)
 Opens device and performs the initialization routines. More...
 
int closeDevice (void)
 Closes device. More...
 
void update (void)
 Updates the device - scan device and send required outputs. More...
 
virtual bool initialize (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *pParametersNode=NULL)
 Core initialization. More...
 
XERCES_CPP_NAMESPACE_QUALIFIER
DOMNode * 
saveXMLParameters (XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *)
 Save current setting into a XML node. More...
 
void handle_event (int currentWiimoteID, struct wiimote_t *wm)
 Callback that handles an event. More...
 
void handle_read (struct wiimote_t *wm, byte *data, unsigned short len)
 Callback that handles a read event. More...
 
void handle_ctrl_status (struct wiimote_t *wm)
 Callback that handles a controller status event. More...
 
void handle_disconnect (wiimote *wm)
 Callback that handles a disconnection event. More...
 
void test (struct wiimote_t *wm, byte *data, unsigned short len)
 
- Public Member Functions inherited from vrecko::Device
 Device (const char *startingDeviceName, const char *pname="")
 
virtual ~Device ()
 
int getID (void)
 Returns the ID of the device. More...
 
void setID (int new_id)
 Sets ID of the device. More...
 
const std::string & getDeviceType (void)
 Returns the type of the device. More...
 
void setPortName (const char *pname)
 Sets the port name for the device. More...
 
const char * getPortName (void)
 Returns port name of the device. More...
 
virtual int calibrateDevice (void)
 Device calibration. More...
 
virtual const std::string getCalibrationString (void)
 Returns the description of the calibration process. 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...
 
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...
 
virtual const std::string & getSenderString (void)
 Returns the sender (or receiver) identification string. 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...
 
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

 DECLARE_INPUT (Vibration, vrecko::MessageBool)
 
 DECLARE_OUTPUT (Button, vrecko::MessageString)
 
 DECLARE_OUTPUT (Orientation, vrecko::MessageVec3)
 

Protected Attributes

bool main_wiimote
 
unsigned int wiimoteID
 
bool vibration
 
- Protected Attributes inherited from vrecko::Device
int id
 device ID More...
 
std::string device_type
 device type More...
 
std::string port_name
 name of the port 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
 

Static Protected Attributes

static bool is_initialized = false
 
static bool disabled = false
 
static bool check_failed = true
 
static wiimote ** pWiimote = NULL
 

Additional Inherited Members

- Public Types inherited from vrecko::BaseClass
enum  NotificationTypes {
  NOTIFICATION_DELETE_CLASS = 1, NOTIFICATION_EO_REGISTERING = 2, NOTIFICATION_EO_UNREGISTERING = 4, NOTIFICATION_PROGRAM_TERMINATION = 8,
  NOTIFICATION_ALL = 0xFFFFFFFF
}
 
- 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

Wiimote::Wiimote ( )
Wiimote::~Wiimote ( )

Member Function Documentation

int Wiimote::closeDevice ( void  )
virtual

Closes device.

Implements vrecko::Device.

vreckoDP_base::Wiimote::DECLARE_INPUT ( Vibration  ,
vrecko::MessageBool   
)
protected
vreckoDP_base::Wiimote::DECLARE_OUTPUT ( Button  ,
vrecko::MessageString   
)
protected
vreckoDP_base::Wiimote::DECLARE_OUTPUT ( Orientation  ,
vrecko::MessageVec3   
)
protected
void Wiimote::handle_ctrl_status ( struct wiimote_t *  wm)

Callback that handles a controller status event.

Parameters
wmPointer to a wiimote_t structure.
attachmentIs there an attachment? (1 for yes, 0 for no)
speakerIs the speaker enabled? (1 for yes, 0 for no)
irIs the IR support enabled? (1 for yes, 0 for no)
ledWhat LEDs are lit.
battery_levelBattery level, between 0.0 (0%) and 1.0 (100%).

This occurs when either the controller status changed or the controller status was requested explicitly by wiiuse_status().

One reason the status can change is if the nunchuk was inserted or removed from the expansion port.

void Wiimote::handle_disconnect ( wiimote *  wm)

Callback that handles a disconnection event.

Parameters
wmPointer to a wiimote_t structure.

This can happen if the POWER button is pressed, or if the connection is interrupted.

void Wiimote::handle_event ( int  currentWiimoteID,
struct wiimote_t *  wm 
)

Callback that handles an event.

Parameters
wmPointer to a wiimote_t structure.

This function is called automatically by the wiiuse library when an event occurs on the specified wiimote.

void Wiimote::handle_read ( struct wiimote_t *  wm,
byte data,
unsigned short  len 
)

Callback that handles a read event.

Parameters
wmPointer to a wiimote_t structure.
dataPointer to the filled data block.
lenLength in bytes of the data block.

This function is called automatically by the wiiuse library when the wiimote has returned the full data requested by a previous call to wiiuse_read_data().

You can read data on the wiimote, such as Mii data, if you know the offset address and the length.

The data pointer was specified on the call to wiiuse_read_data(). At the time of this function being called, it is not safe to deallocate this buffer.

bool Wiimote::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.

int Wiimote::openDevice ( void  )
virtual

Opens device and performs the initialization routines.

Implements vrecko::Device.

XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * Wiimote::saveXMLParameters ( XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *  )
virtual

Save current setting into a XML node.

Warning
Currently not supported. It is safe to leave it without overriding.
Parameters
*(XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument)
Returns
(XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *)

Reimplemented from vrecko::BaseClass.

void Wiimote::test ( struct wiimote_t *  wm,
byte data,
unsigned short  len 
)
void Wiimote::update ( void  )
virtual

Updates the device - scan device and send required outputs.

Implements vrecko::Device.

Member Data Documentation

bool Wiimote::check_failed = true
staticprotected
bool Wiimote::disabled = false
staticprotected
bool Wiimote::is_initialized = false
staticprotected
bool vreckoDP_base::Wiimote::main_wiimote
protected
wiimote ** Wiimote::pWiimote = NULL
staticprotected
bool vreckoDP_base::Wiimote::vibration
protected
unsigned int vreckoDP_base::Wiimote::wiimoteID
protected

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