c4d.BaseSelect - a selection class

This class is used to keep track of point and polygon selections. Each method will raise an exception when a host object is established, but not alive anymore.

class c4d.BaseSelect

• BaseSelect.FlushAll()

• BaseSelect.GetCount()
• BaseSelect.GetSegments()

• BaseSelect.Select()
• BaseSelect.SelectAll()
• BaseSelect.Deselect()
• BaseSelect.DeselectAll()

• BaseSelect.Toggle()
• BaseSelect.ToggleAll()

• BaseSelect.CopyTo()
• BaseSelect.Merge()
• BaseSelect.DeselectFrom()
• BaseSelect.GetClone()

• BaseSelect.GetDirty()

• BaseSelect.GetAll()
• BaseSelect.SetAll()
• BaseSelect.HostAlive()

Methods

BaseSelect.GetCount()

Get the number of selected elements.

Return type:int Returns:The number of selected elements.

BaseSelect.GetSegments()

Get the number of segments that contain elements. For example: the selections 0..4, 6..7, 9..12 would be three segments. This method would return 3 and GetCount would return 11.

Return type:int Returns:The number of selected segments.

BaseSelect.Select(num)

Selects an element.

Parameter:num (int) – The element index to select. Return type:bool Returns:True if the element was already selected.

BaseSelect.FlushAll()

Remove all elements and free all resources. The state will be like its just allocated.

BaseSelect.SelectAll(min, max)

Selects all elements from in the given range.

Note

All previous selections are cleared.

Parameters:

• min (int) – The first element of the select.
• max (int) – The last element in the range to select.

Return type:

bool

Returns:

Success of selecting the elements.

BaseSelect.Deselect()

Deselects an element.

Parameter:num (int) – The element index to deselect. Return type:bool Returns:True if the element was already deselected.

BaseSelect.DeselectAll()

Deselect all elements.

Return type:bool Returns:Success of deselecting all elements.

BaseSelect.Toggle(num)

Toggles the selection state of an element.

Parameter:num (int) – The index of the element to toggle. Return type:bool Returns:Success of changing the selection state of the element.

BaseSelect.ToggleAll(min, max)

Toggle the selection state of all elements in the given range.

Parameters:

• min (int) – The first element to toggle.
• max (int) – The last element to toggle in the range.

Return type:

bool

Returns:

Success of changing the selection state.

BaseSelect.Merge(src)

Selects all elements that are selected in src.

Parameter:src (BaseSelect) – The source selection object. Return type:bool Returns:True if successful, otherwise False.

BaseSelect.DeselectFrom(src)

Deselects all elements that are selected in src.

Parameter:src (BaseSelect) – The source selection object. Return type:bool Returns:True if successful, otherwise False.

BaseSelect.GetClone(dest)

Make a duplicate of this selection object with its elements.

Return type:BaseSelect Returns:The cloned BaseSelect or None if failed.

BaseSelect.GetDirty()

Returns the dirty counter of the selection. This counter is increased every time a function is called that changes the selection.

Return type:int Returns:Dirty counter.

BaseSelect.CopyTo(dest)

Copy the selection elements in this selection object to another BaseSelect.

Parameter:dest (BaseSelect) – The destination selections object. Return type:bool Returns:Success of copying the selection elements.

BaseSelect.SetAll(states)

Set all selected elements in a list.

Parameter:states (iteratable object with int members) – The id elements. Return type:bool Returns:Success or fail.

BaseSelect.GetAll()

Returns all selected elements in a list.

Return type:list of int Returns:The list

BaseSelect.HostAlive()

Returns if the host object is still alive.

Return type:int Returns:Returns 2 if the BaseSelect instance has no host object. Returns 1 if the host object is alive if set and returns 0 if the object is not alive.