Basic
Interface to Alias objects which can be picked.
Synopsis
#include <AlPickable.h> class AlPickable virtual statusCode pick( void ); virtual statusCode unpick( void ); virtual boolean isPicked( void );
Description
This class encapsulates
the functionality of Alias objects that have the capacity to
be picked. As expected, pickable objects can either be picked or
unpicked.
AlPickable::AlPickable()
Description
Constructs
an AlPickable wrapper object.
AlPickable::~AlPickable()
Description
AlPickable
destructor. Note that objects that are picked and then deleted from
OpenModel (through deleteObject) will be unpicked.
statusCode AlPickable::pick(
void )
Description
Picks
the object.
Return Codes
sSuccess - the object
was picked
sFailure - the object
could not be picked
statusCode AlPickable::unpick(
void )
Description
Unpicks
the object.
Return Codes
sSuccess - the object
was unpicked
sFailure - the object
could not be unpicked
boolean AlPickable::isPicked(
void )
Description
Returns
TRUE if the object is picked.