class HT_Selector_Item
The HT_Selector_Item
is the object that the user gets back when drawing to the HT_Selector.
The user can obtain the key, sequence number, key count (number of keys)
and distance associated with the object. The selected items are stored
in class HT_Selector_List.
The selection process now allows multiple keys to be assigned to an object
so that a combined selection renderer can make use of a number of selection
options, such as nearest, window or perpendicular.
For a further description of the selection process, see
chapter 7, "The Selection Renderer,"
and the Sprite sample
application code.
See Also
HT_Selector, HT_Selector_List
Access Methods
distance
The distance associated
with the item.
key
Retrieves one of the keys
associated with a selection.
key_count
The number of keys associated
with the selection.
keys
Returns a pointer to the
array of keys.
sequence
The order of the selected
objects in the selector list.
Constructor / Destructor
HT_Selector_Item::distance
Purpose
The distance associated
with the item.
Synopsis
float distance (void) const
Details
The distance between the selection area and the
drawables.
HT_Selector_Item::HT_Selector_Item
Purpose
Constructs an HT_Selector_Item
object.
Synopsis
HT_Selector_Item (void) :
m_keys (null),
m_count (0),
m_sequence (0),
m_distance (0.0f)
HT_Selector_Item::~HT_Selector_Item
Purpose
Destructor.
Synopsis
HT_Selector_Item::~HT_Selector_Item ()
HT_Selector_Item::key
Purpose
Retrieves one of the keys
associated with a selection.
Synopsis
HT_Key key (int index=0) const
Details
The default key is the first one.
HT_Selector_Item::key_count
Purpose
The number of keys associated
with the selection.
Synopsis
int key_count (void) const
HT_Selector_Item::keys
Purpose
Returns a pointer to the
array of keys.
Synopsis
HT_Key const * keys (void) const
HT_Selector_Item::sequence
Purpose
The order of the selected
objects in the selector list.
Synopsis
int sequence (void) const
Details
A count of how many draw_... calls made
since begin_picture was issued..