HBhvConditionONLCLICK Class Reference

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

#include <HBhvSensor.h>

Public Member Functions

 HBhvConditionONLCLICK (const char *target, const char *hevent, bool invert, HBhvSensor *sensor)
 
virtual int OnLButtonDown (HEventInfo &hevent)
 
virtual void Serialize (HUtilityXMLGenerator *xmlgen)
 
- Public Member Functions inherited from HBhvConditionMouse
 HBhvConditionMouse (const char *target, const char *hevent, bool invert, HBhvSensor *sensor)
 
bool IsClicked (HC_KEY target, float x, float y)
 
virtual void Register ()
 
virtual void UnRegister ()
 
- Public Member Functions inherited from HBhvCondition
virtual void Evaluate (bool &and_flag, bool &or_flag)
 
virtual HBhvSensorGetSensor ()
 
 HBhvCondition (const char *target, const char *hevent, bool invert, HBhvSensor *sensor)
 
virtual void Serialize (HUtilityXMLGenerator *xmlgen, HUtilityXMLTag *xmlt)
 
virtual void SetTarget (const char *target)
 

Additional Inherited Members

- Static Public Member Functions inherited from HBhvCondition
static void * XMLCallback (HUtilityXMLTag *xt, bool open, void *m_pExtraData)
 
- Protected Attributes inherited from HBhvCondition
bool m_bConditionMet
 
bool m_bInvert
 
char m_Event [256]
 
HBhvSensorm_pSensor
 
HBhvTargetObjectm_pTarget
 
char m_Value [256]
 

Detailed Description

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

Constructor & Destructor Documentation

◆ HBhvConditionONLCLICK()

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

Constructs a HBhvConditionONLCLICK object.

Parameters
targetThe descriptor of the target object. You can use HBhvTargetObject::CreateTargetString() to generate this string.
heventThe event type.
invertPass 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.
sensorA pointer to the HBhvSensor object that this condition belongs to.

Member Function Documentation

◆ OnLButtonDown()

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.

◆ Serialize()

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: