alias_api.AlSetMember

class alias_api.AlSetMember

Bases: AlObject

Basic Interface to the members of Alias set structures.

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 performed using the calls provided within this class.

The following classes can be grouped into sets: AlDagNode, AlPerspectiveCamera, AlCurveCV, AlPolysetVertex and AlSurfaceCV. These classes use multiple inheritance which include the AlSettable class. Use the add_to_set() method of class AlSettable to add the object to a set.

copy_wrapper(self: alias_api.AlSetMember) → alias_api.AlObject

Return an exact duplicate of this AlSetMember object.

next_set_member(self: alias_api.AlSetMember) → alias_api.AlSetMember

Return the next AlSetMember. Return None if there is no next set member.

object(self: alias_api.AlSetMember) → alias_api.AlObject

Return the object that this set member references.

prev_set_member(self: alias_api.AlSetMember) → alias_api.AlSetMember

Return the previous AlSetMember. Return None if there is no next set member.

remove_from_set(self: alias_api.AlSetMember, set: alias_api.AlSet) → int

Remove this member from the set.

Parameters

set (AlSet) – The set to remove this from

Returns

The status code of the result: Success - If the object was removed successfully InvalidArgument - The set was invalid ObjectNotAMember - If the object was not found in this set InvalidObject - The set is invalid

Return type

int(AlStatusCode)

set(self: alias_api.AlSetMember) → alias_api.AlSet

Return the set that this set member belongs to.

type(self: alias_api.AlSetMember) → alias_api.AlObjectType

Return the AlSetMember type identifier.