Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HBhvConditionONLCLICK Class Reference

The HBhvConditionONLCLICK class evaluates if the given target was selected when the left mouse button was pressed. More...

#include <HBhvSensor.h>

Inheritance diagram for HBhvConditionONLCLICK:

HBhvConditionMouse HBhvCondition

List of all members.

Public Member Functions

 HBhvConditionONLCLICK (const char *target, const char *hevent, bool invert, HBhvSensor *sensor)
virtual int OnLButtonDown (HEventInfo &hevent)
virtual void Serialize (HUtilityXMLGenerator *xmlgen)


Detailed Description

The HBhvConditionONLCLICK class evaluates if the given target was selected when the left mouse button was pressed.

Constructor & Destructor Documentation

HBhvConditionONLCLICK::HBhvConditionONLCLICK ( const char *  target,
const char *  hevent,
bool  invert,
HBhvSensor sensor 
)

Constructs a HBhvConditionONLCLICK object.

Parameters:
target The descriptor of the target object. You can use HBhvTargetObject::CreateTargetString() to generate this string.
hevent The event type.
invert Pass true to invert the condition. In other words, this condition will return true if the condition evaluates to false and false if the condition evaluates to true.
sensor A pointer to the HBhvSensor object that this condition belongs to.


Member Function Documentation

virtual int HBhvConditionONLCLICK::OnLButtonDown ( HEventInfo hevent  )  [virtual]

Called by the event manager if the left mouse button has been pressed. This method checks to see if the condition was met by the mouse click event as well as all the conditions associated with this conditions sensor.

Returns:
An HLISTENER_CONSUME_EVENT if conditions of the associated sensor were met or HLISTENER_PASS_EVENT if they were not.

virtual void HBhvConditionONLCLICK::Serialize ( HUtilityXMLGenerator *  xmlgen  )  [virtual]

Writes XML data to a buffer.

Reimplemented from HBhvCondition.


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