HBhvConditionMouse Class Reference
The HBhvConditionMouse class is the base class for all mouse related conditions. More...
#include <HBhvSensor.h>
Public Member Functions | |
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 () |
![]() | |
virtual void | Evaluate (bool &and_flag, bool &or_flag) |
virtual HBhvSensor * | GetSensor () |
HBhvCondition (const char *target, const char *hevent, bool invert, HBhvSensor *sensor) | |
virtual void | Serialize (HUtilityXMLGenerator *xmlgen, HUtilityXMLTag *xmlt) |
virtual void | Serialize (HUtilityXMLGenerator *xmlgen) |
virtual void | SetTarget (const char *target) |
Additional Inherited Members | |
![]() | |
static void * | XMLCallback (HUtilityXMLTag *xt, bool open, void *m_pExtraData) |
![]() | |
bool | m_bConditionMet |
bool | m_bInvert |
char | m_Event [256] |
HBhvSensor * | m_pSensor |
HBhvTargetObject * | m_pTarget |
char | m_Value [256] |
Detailed Description
The HBhvConditionMouse class is the base class for all mouse related conditions.
Constructor & Destructor Documentation
◆ HBhvConditionMouse()
HBhvConditionMouse::HBhvConditionMouse | ( | const char * | target, |
const char * | hevent, | ||
bool | invert, | ||
HBhvSensor * | sensor | ||
) |
Constructs an HBhvConditionMouse 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
◆ IsClicked()
bool HBhvConditionMouse::IsClicked | ( | HC_KEY | target, |
float | x, | ||
float | y | ||
) |
Determines if the given target object was selected.
- Parameters
-
target The key of the target object. x The mouse x coordinate in window space. y The mouse y coordinate in window space.
- Returns
- True if the given target was selected by the mouse or false if otherwise.
◆ Register()
|
virtual |
Registers the condition with event manager for mouse events.
Reimplemented from HBhvCondition.
◆ UnRegister()
|
virtual |
Unregisters the condition so that it no longer gets mouse events.
Reimplemented from HBhvCondition.
Reimplemented in HBhvConditionONMOUSELEAVE, and HBhvConditionONMOUSEENTER.
The documentation for this class was generated from the following file: