AlPickable

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 );

static statusCode        pick( AlPickable**, size_t numPickables ); 
static statusCode        unpick( AlPickable**, size_t numPickables ); 

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. In addition, there are optional calls to pick and unpick an array of AlPickable pointers.

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 )

static statusCode AlPickable::pick( AlPickable**, size_t numPickables );

Description

Picks the object.

Return Codes

sSuccess - the object was picked

sFailure - the object could not be picked

statusCode AlPickable::unpick( void )

static statusCode AlPickable::unpick( AlPickable**, size_t numPickables );

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.