CommonComponentTable<T>

References
public abstract class CommonComponentTable<T> : ICommonComponentTable<T>, IList<T>, IReadOnlyList<T>
Provides a base table type that encompasses all document tables, both in RhinoDoc and File3dm.
Type parameters:
TA model component. where ModelComponent

Properties

ComponentType

#
public abstract ModelComponentType ComponentType { get; }
Returns the actual component type of a table.
Implements: ComponentType

Count

#
public virtual int Count { get; }
Returns the count of all items, including deleted ones.
Explicit

ICollection<T>.IsReadOnly

#
bool ICollection<T>.IsReadOnly

Indexers

Explicit

IList<T>.this[]

#
T IList<T>.this[int index]
Parameters:
index (int)
Explicit

IReadOnlyList<T>.this[]

#
T IReadOnlyList<T>.this[int index]
Parameters:
index (int)

Methods

Clear

#
public void Clear()
Marks all items as deleted.

Delete

#
public abstract bool Delete(T item)
Deletes an item. Items that are deleted are still keeping their space, but the 'IsDeleted' flag is checked.
Parameters:
item (T)An item to delete.
Returns: True if an items could be deleted (e.g., it was not locked).

FindId

#
public virtual T FindId(Guid id)
Uses the guid to find a model component. Deleted objects cannot be found by id. The guid is the value that is stored in the .Id property. In a single document, no two active objects have the same guid. If an object is replaced with a new object, then the guid persists. For example, if the _Move command moves an object, then the moved object inherits its guid from the starting object. If the Copy command copies an object, then the copy gets a new guid. This guid persists through file saving/opening operations. This function will not find grip objects.
Parameters:
id (Guid)ID of model component to search for.
Returns: Reference to the rhino object with the objectId or null if no such object could be found.
Implements: FindId

GetEnumerator

#
public virtual IEnumerator<T> GetEnumerator()
Returns the enumerator that yields all items.
Explicit

ICommonComponentTable<T>.FindNameHash

#
T ICommonComponentTable<T>.FindNameHash(NameHash nameHash)
Uses the hash of the name to find a model component. Deleted objects have no name.
Parameters:
nameHash (NameHash)NameHash of model component to search for.
Returns: Reference to the rhino object or null if no such object could be found.
Implements: FindNameHash
Explicit

ICollection<T>.Add

#
void ICollection<T>.Add(T item)
Parameters:
item (T)
Explicit

ICollection<T>.Contains

#
bool ICollection<T>.Contains(T item)
Parameters:
item (T)
Explicit

ICollection<T>.CopyTo

#
void ICollection<T>.CopyTo(T[] array, int arrayIndex)
Parameters:
array (T[])
arrayIndex (int)
Explicit

ICollection<T>.Remove

#
bool ICollection<T>.Remove(T item)
Parameters:
item (T)
Explicit

IList<T>.IndexOf

#
int IList<T>.IndexOf(T item)
Parameters:
item (T)
Explicit

IList<T>.Insert

#
void IList<T>.Insert(int index, T item)
Parameters:
index (int)
item (T)
Explicit

IList<T>.RemoveAt

#
void IList<T>.RemoveAt(int index)
Parameters:
index (int)
Explicit

IEnumerable.GetEnumerator

#
IEnumerator IEnumerable.GetEnumerator()