Foundry::Katana::ViewerAPI::PickedAttrsMap Class Reference

#include <FnPickingTypes.h>

List of all members.

Public Member Functions
FnAttribute::GroupAttribute	toGroupAttribute ()
void	fromGroupAttribute (FnAttribute::GroupAttribute groupAttr)

---

Detailed Description

Maps picking IDs with an Attribute that contains information about the corresponding pickable object. This can be converted from/into a GroupAttribute that contains a string representation of the FnPickId numbers (map keys) as the child names and the Attribute objects (map values) as its children.

---

Member Function Documentation

void Foundry::Katana::ViewerAPI::PickedAttrsMap::fromGroupAttribute

(

FnAttribute::GroupAttribute

groupAttr

)

[inline]

Utility function that fills the map with entries from a GroupAttribute that contains a string representation of the FnPickId numbers (map keys) as the child names and the Attribute objects (map values) as its children.

Parameters:

groupAttr

The GroupAttribute to parse to fill this map.

References Foundry::Katana::GroupAttribute::getChildByIndex(), Foundry::Katana::GroupAttribute::getChildName(), Foundry::Katana::GroupAttribute::getNumberOfChildren(), and Foundry::Katana::Attribute::isValid().

FnAttribute::GroupAttribute Foundry::Katana::ViewerAPI::PickedAttrsMap::toGroupAttribute

(

)

[inline]

Utility function that returns a GroupAttribute that contains a string representation of the FnPickId numbers (map keys) as the child names and the Attribute objects (map values) as its children.

Returns:

A GroupAttribute that contains a string representation of this map.

References Foundry::Katana::GroupBuilder::build(), and Foundry::Katana::GroupBuilder::set().

---

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

• FnPickingTypes.h