HImageRegion Class Reference

The HImageRegion class represents selectable regions inside an image panel. More...

#include <HObjects.h>

Public Member Functions

int GetID ()
 
char const * GetName ()
 
 HImageRegion (int identifier, char const *const name)
 
bool IsSelected (float x, float y, HC_KEY region_image_key, int width, int height)
 

Detailed Description

The HImageRegion class represents selectable regions inside an image panel.

Constructor & Destructor Documentation

◆ HImageRegion()

HImageRegion::HImageRegion ( int  identifier,
char const *const  name 
)

Constructs an HImageRegion object.

Parameters
identifierNumeric identifier of image region
nameName of image region

Member Function Documentation

◆ GetID()

int HImageRegion::GetID ( )
inline

This method returns the identifier of the image region

Returns
Identifier of image region

◆ GetName()

char const* HImageRegion::GetName ( )
inline

This method returns the name of the image region

Returns
Name of image region

◆ IsSelected()

bool HImageRegion::IsSelected ( float  x,
float  y,
HC_KEY  region_image_key,
int  width,
int  height 
)

This method determines if a region is selected given an x/y position and the associated region iage

Parameters
xMouse X Coordinate
yMouse Y Coordinate
region_image_keyHOOPS Key to image defining image panel regions
widthWidth of Image Panel
heightHeight of Image Panel
Returns
True: Mouse is inside of region

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