HBhvConditionONMOUSEENTER Class Reference

The HBhvConditionONMOUSEENTER class evaluates if the mouse pointer has entered the bounding box of the target object. More...

#include <HBhvSensor.h>

Public Member Functions

 HBhvConditionONMOUSEENTER (const char *target, const char *hevent, bool invert, HBhvSensor *sensor)
 
virtual int OnMouseMove (HEventInfo &hevent)
 
virtual void Serialize (HUtilityXMLGenerator *xmlgen)
 
void UnRegister ()
 
- 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 ()
 
- 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)
 

Protected Attributes

HC_KEY m_OldKey
 
- Protected Attributes inherited from HBhvCondition
bool m_bConditionMet
 
bool m_bInvert
 
char m_Event [256]
 
HBhvSensorm_pSensor
 
HBhvTargetObjectm_pTarget
 
char m_Value [256]
 

Additional Inherited Members

- Static Public Member Functions inherited from HBhvCondition
static void * XMLCallback (HUtilityXMLTag *xt, bool open, void *m_pExtraData)
 

Detailed Description

The HBhvConditionONMOUSEENTER class evaluates if the mouse pointer has entered the bounding box of the target object.

Constructor & Destructor Documentation

◆ HBhvConditionONMOUSEENTER()

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

Constructs an HBhvConditionONMOUSEENTER 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

◆ OnMouseMove()

virtual int HBhvConditionONMOUSEENTER::OnMouseMove ( HEventInfo hevent)
virtual

Called by the event manager if the mouse pointer position has changed. This method checks to see if the mouse has entered the bounding box of the target object. If the condition was met, then the conditions of the associated sensor are evaluated.

◆ Serialize()

virtual void HBhvConditionONMOUSEENTER::Serialize ( HUtilityXMLGenerator *  xmlgen)
virtual

Writes XML data to a buffer.

Reimplemented from HBhvCondition.

◆ UnRegister()

void HBhvConditionONMOUSEENTER::UnRegister ( )
virtual

Unregisters the condition so that it no longer gets mouse events.

Reimplemented from HBhvConditionMouse.

Member Data Documentation

◆ m_OldKey

HC_KEY HBhvConditionONMOUSEENTER::m_OldKey
protected

For internal use only.


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