Basic Interface to the members of Alias set structures.
Synopsis
#include <AlSetMember.h> class AlSetMember : public AlObject
virtual ~AlSetMember(); virtual AlObject* copyWrapper() const; virtual AlObjectType type() const; AlSetMember* nextSetMember() const; AlSetMember* prevSetMember() const; statusCode nextSetMemberD(); statusCode prevSetMemberD(); AlObject* object() const; AlSet* set() const; statusCode removeFromSet( AlSet *set );
Description
This class provides utility functions for set operations. The first AlSetMember of a set can be retrieved from the AlSet.
Then iteration through the sets can be done using the calls provided within this class.
The following classes can be grouped into sets: AlDagNode, AlPerspectiveCamera, AlCurveCV and AlSurfaceCV. These classes use
multiple inheritance, which includes the AlSettable class. Use the addToSet() method of class AlSettable to add the object
to a set.
AlSetMember::~AlSetMember()
Description
Deletes an AlSetMember wrapper object.
AlObject *AlSetMember::copyWrapper() const
Description
Returns an exact duplicate of this AlSetMember wrapper.
AlObjectType AlSetMember::type() const
Description
Returns the class identifier ’kSetMemberType’.
AlSetMember* AlSetMember::nextSetMember() const
Description
Returns a pointer to the next AlSetMember. Otherwise, returns NULL if there is no next set member.
AlSetMember* AlSetMember::prevSetMember() const
Description
Returns a pointer to the previous AlSetMember. Otherwise, returns NULL if there is no previous set member.
statusCode AlSetMember::nextSetMemberD()
Description
Destructively points this wrapper to next set member. If there is no such member, the object pointer is unaltered.
Return Codes
sSuccess - the wrapper points to the next set member
sFailure - there is no next set member
sInvalidObject - the set member is invalid
statusCode AlSetMember::prevSetMemberD()
Description
Destructively points this wrapper to the previous set member. If there is no such member, the object pointer is unaltered.
Return Codes
sSuccess - the wrapper points to the previous set member
sFailure - there is no previous set member
sInvalidObject - the set member is invalid
AlObject *AlSetMember::object() const
Description
Returns the object that this set member references.
AlSet* AlSetMember::set() const
Description
Returns the set that this set member belongs to.
statusCode AlSetMember::removeFromSet( AlSet *set )
Description
Removes this member from the set.
Arguments
< set - the set to remove this from
Return Codes
sSuccess - the object was removed successfully
sInvalidArgument - the set was invalid
sObjectNotAMember - the object was not found in this set
sInvalidObject - the set is invalid
